diff --git a/Postman Format v1/R19-3 postman collection/securechangeworkflow_R19-3-GA.json b/Postman Format v1/R19-3 postman collection/securechangeworkflow_R19-3-GA.json new file mode 100644 index 0000000..8d31b93 --- /dev/null +++ b/Postman Format v1/R19-3 postman collection/securechangeworkflow_R19-3-GA.json @@ -0,0 +1 @@ +{"folders":[{"order":["2-1-1","2-1-2","2-1-3","2-1-4","2-1-5"],"collectionId":"2","name":"Access Portal","hasRequests":true,"id":"2-1"},{"order":["2-2-6","2-2-7","2-2-8","2-2-9","2-2-10","2-2-11","2-2-12","2-2-13"],"collectionId":"2","name":"Application Connections","hasRequests":true,"id":"2-2"},{"order":["2-3-14"],"collectionId":"2","name":"Application Identities","hasRequests":true,"id":"2-3"},{"order":["2-4-15","2-4-16","2-4-17","2-4-18","2-4-19","2-4-20","2-4-21","2-4-22","2-4-23","2-4-24","2-4-25","2-4-26","2-4-27","2-4-28","2-4-29"],"collectionId":"2","name":"Application Interfaces","hasRequests":true,"id":"2-4"},{"order":["2-5-30","2-5-31","2-5-32","2-5-33","2-5-34"],"collectionId":"2","name":"Application Migration","hasRequests":true,"id":"2-5"},{"order":["2-6-35","2-6-36","2-6-37","2-6-38","2-6-39","2-6-40","2-6-41","2-6-42","2-6-43","2-6-44","2-6-45","2-6-46","2-6-47","2-6-48","2-6-49","2-6-50","2-6-51","2-6-52"],"collectionId":"2","name":"Application Packs","hasRequests":true,"id":"2-6"},{"order":["2-7-53"],"collectionId":"2","name":"Application Pending Changes","hasRequests":true,"id":"2-7"},{"order":["2-8-54","2-8-55"],"collectionId":"2","name":"Application Servers (across all applications)","hasRequests":true,"id":"2-8"},{"order":["2-9-56","2-9-57","2-9-58","2-9-59","2-9-60","2-9-61","2-9-62","2-9-63"],"collectionId":"2","name":"Application Servers (by application)","hasRequests":true,"id":"2-9"},{"order":["2-10-64","2-10-65","2-10-66","2-10-67","2-10-68","2-10-69"],"collectionId":"2","name":"Application Services (global)","hasRequests":true,"id":"2-10"},{"order":["2-11-70","2-11-71","2-11-72","2-11-73","2-11-74"],"collectionId":"2","name":"Application Services (local)","hasRequests":true,"id":"2-11"},{"order":["2-12-75","2-12-76","2-12-77","2-12-78"],"collectionId":"2","name":"Application Users","hasRequests":true,"id":"2-12"},{"order":["2-13-79","2-13-80","2-13-81","2-13-82","2-13-83","2-13-84","2-13-85","2-13-86","2-13-87","2-13-88","2-13-89"],"collectionId":"2","name":"Applications","hasRequests":true,"id":"2-13"},{"order":["2-14-90","2-14-91","2-14-92"],"collectionId":"2","name":"Cloud Console","hasRequests":true,"id":"2-14"},{"order":["2-15-93","2-15-94","2-15-95","2-15-96","2-15-97","2-15-98","2-15-99"],"collectionId":"2","name":"Customers","hasRequests":true,"id":"2-15"},{"order":["2-16-100","2-16-101","2-16-102"],"collectionId":"2","name":"Domains","hasRequests":true,"id":"2-16"},{"order":["2-17-103"],"collectionId":"2","name":"Load Balancers","hasRequests":true,"id":"2-17"},{"order":["2-18-104","2-18-105","2-18-106","2-18-107"],"collectionId":"2","name":"SecureChange Devices","hasRequests":true,"id":"2-18"},{"order":["2-19-108","2-19-109","2-19-110","2-19-111","2-19-112","2-19-113"],"collectionId":"2","name":"Server Decommissioning","hasRequests":true,"id":"2-19"},{"order":["2-20-114","2-20-115"],"collectionId":"2","name":"System Configuration","hasRequests":true,"id":"2-20"},{"order":["2-21-116","2-21-117","2-21-118"],"collectionId":"2","name":"System Users","hasRequests":true,"id":"2-21"},{"order":["2-22-119","2-22-120","2-22-121","2-22-122","2-22-123","2-22-124","2-22-125","2-22-126"],"collectionId":"2","name":"Ticket Lifecycle","hasRequests":true,"id":"2-22"},{"order":["2-23-127","2-23-128","2-23-129","2-23-130","2-23-131","2-23-132","2-23-133","2-23-134","2-23-135","2-23-136","2-23-137","2-23-138","2-23-139","2-23-140","2-23-141","2-23-142","2-23-143","2-23-144","2-23-145","2-23-146","2-23-147","2-23-148","2-23-149","2-23-150","2-23-151","2-23-152"],"collectionId":"2","name":"Tickets","hasRequests":true,"id":"2-23"}],"requests":[{"headers":"Accept: application/json\n","name":"Retrieve an existing application access request by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"requestId"}],"description":"Parameters:
applicationId: The unique identifier of the application
requestId: The unique identifier of the application access request

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests/1

Response Messages:
400: The application was already deleted.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Access request with id ID was not found in application with id ID","dataMode":"params","folder":"2-1","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests/{{requestId}}","collectionId":"2","id":"2-1-1","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Update an application access request","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"requestId"}],"dataMode":"raw","description":"Use this API to approve or reject application access requests

Parameters:
applicationId: The unique identifier of the application
requestId: The unique identifier of the application access request
body: application access request

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests/1
BODY<application_access_request>
    <action>APPROVE</action>
</application_access_request>


Response Messages:
200: Application access request was updated.
400: The application was already deleted.
400: Invalid ID for access request
400: Cannot update access request with id ID
400: Action cannot be empty in request with id ID
400: Invalid action in request with id ID
400: The Server group is lock for discovery
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","folder":"2-1","rawModeData":"\n\tAPPROVE\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests/{{requestId}}","collectionId":"2","id":"2-1-2","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve existing application access requests","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests

Response Messages:
400: The application was already deleted.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.","dataMode":"params","folder":"2-1","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests","collectionId":"2","id":"2-1-3","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Update application access requests","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"dataMode":"raw","description":"Use this API to approve or reject application access requests

Parameters:
applicationId: The unique identifier of the application
body: application access requests

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests
BODY<application_access_requests>
    <application_access_request>
        <id>1</id>
        <action>APPROVE</action>
    </application_access_request>
    <application_access_request>
        <id>2</id>
        <action>REJECT</action>
    </application_access_request>
</application_access_requests>


Response Messages:
200: Application access requests were updated.
400: The application was already deleted.
400: Invalid ID for access request
400: Cannot update access request with id ID
400: Action cannot be empty in request with id ID
400: Invalid action in request with id ID
400: The Server group is lock for discovery
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","folder":"2-1","rawModeData":"\n\t\n\t\t1\n\t\tAPPROVE\n\t\n\t\n\t\t2\n\t\tREJECT\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests","collectionId":"2","id":"2-1-4","method":"PUT"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Create application access request","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: application access request

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests
BODY<application_access_request>
    <server_group_id>1</server_group_id>
    <server_ip>1.1.1.1</server_ip>
    <comment>Request to join the WebServers server group</comment>
</application_access_request>


Response Messages:
201: Application access request was submitted.
400: The application was already deleted.
400: Server id cannot be empty.
400: Hostname or IP cannot be empty.
400: The provided server does not exist in application.
400: The provided server is not allowed to access.
400: Request already created
400: Requester cannot be null
400: Group cannot be empty
400: Invalid ip
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","dataMode":"raw","folder":"2-1","rawModeData":"\n\t1\n\t1.1.1.1\n\tRequest to join the WebServers server group\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests","collectionId":"2","id":"2-1-5","method":"POST"},{"headers":"Accept: application/json\n","name":"Retrieve existing connections, with extended resources information","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the connection [optional]
start: Return results starting only from the specified index; 0-based index; default value = 0 [optional]
count: Return the specified number of results. Returns all results if no value specified [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended?name=Connection Name

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended?name=Connection Name&start=50&count=100

Response Messages:
400: Start value cannot be a negative number.
400: Count value must be greater than 0.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: Access is denied.
404: There is no application with the specified ID.
404: There are no connections with the name NAME.","dataMode":"params","folder":"2-2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_extended","collectionId":"2","id":"2-2-6","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Create a ticket to repair a connection","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"},{"value":null,"type":"text","enabled":true,"key":"connection_id"}],"description":"Parameters:
application_id: The application ID
connection_id: The connection ID
body: Ticket

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/2/repair
BODY<ticket>
    <subject>Repair connection 2</subject>
    <requester>u1</requester>
    <priority>Normal</priority>
    <workflow>
        <name>Workflow with topology</name>
    </workflow>
    <steps>
        <step>
            <name>Open request</name>
            <tasks>
                <task>
                    <fields>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_area\">
                            <name>Business Justification</name>
                            <text>I need access to ftp </text>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_field\">
                            <name>Project Number</name>
                            <text>CR124560</text>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"hyperlink\">
                            <name>Hyperlink</name>
                            <url>http://192.168.1.1/ticket</url>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"drop_down_list\">
                            <name>Change Window</name>
                            <selection>Monday</selection>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"manager\">
                            <name>manager email</name>
                            <text>manager@tufin.com</text>
                        </field>
                    </fields>
                </task>
            </tasks>
        </step>
    </steps>
    <comments/>
</ticket>


Response Messages:
201: Ticket was created.
400: The requester must be the currently logged in user.
400: Workflow was not found.
400: Workflow is not active.
400: Workflow configuration is not valid.
400: Workflow is not set.
400: You cannot enter a status for a new ticket.
400: Requester cannot open a ticket in domain.
400: Invalid ticket priority.
400: Expiration field is required.
400: Submit ticket enabled only with the first step.
400: First step can be only with one task.
400: The specified workflow does not contain an access request field in the first step.
400: You cannot use an access request field to create a ticket from SecureApp.
400: The ticket fields do not match the fields in the current step of the workflow.
400: You cannot change the value of a field because it is read-only.
401: Logged in user: NAME do not have permission to perform on behalf actions.
401: You are not a participant in the first step of this workflow.
401: Access is denied.
401: To create a ticket you must purchase a valid SecureChange license.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: Cannot create a ticket to repair this connection because the connection status is not disconnected.
403: Cannot create a ticket to repair this connection because the connection was edited but a ticket has not been created yet.
403: Cannot create a ticket to repair this connection because there are other open tickets for an application that includes this connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID.","dataMode":"raw","folder":"2-2","rawModeData":"\n\tRepair connection 2\n\tu1\n\tNormal\n\t\n\t\tWorkflow with topology\n\t\n\t\n\t\t\n\t\t\tOpen request\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tBusiness Justification\n\t\t\t\t\t\t\tI need access to ftp \n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tProject Number\n\t\t\t\t\t\t\tCR124560\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tHyperlink\n\t\t\t\t\t\t\thttp://192.168.1.1/ticket\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tChange Window\n\t\t\t\t\t\t\tMonday\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tmanager email\n\t\t\t\t\t\t\tmanager@tufin.com\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connections/{{connection_id}}/repair","collectionId":"2","id":"2-2-7","method":"POST"},{"headers":"Accept: application/json\n","name":"Retrieve existing connections","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the connection [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections?name=Connection Name

Response Messages:
401: No available licenses. Ask your SecureApp administrator for assistance.
401: Access is denied
401: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: There are no connections with the name NAME.","dataMode":"params","folder":"2-2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections","collectionId":"2","id":"2-2-8","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create connections","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: The list of the connections

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections
BODY<connections>
     <connection>
         <name>Connection A</name>
         <comment>Connection A comment</comment>
         <sources>
             <source>
                 <id>2</id>
             </source>
             <source>
                 <id>3</id>
             </source>
         </sources>
         <services>
             <service>
                 <id>1</id>
             </service>
         </services>
         <destinations>
             <destination>
                 <id>1</id>
             </destination>
         </destinations>
     </connection>
     <connection>
         <name>Connection B</name>
     </connection>
     <connection>
         <name>Connection C</name>
         <sources>
             <source>
                 <id>2</id>
             </source>
         </sources>
     </connection>
</connections>


Response Messages:
200: Connections were created.
201: Connection was created.
400: There are no items to add.
400: You cannot add to application NAME because it was decommissioned.
400: Connection name already exists.
400: Reference to service ID is invalid.
400: Reference to source/destination with ID is invalid.
400: Connection NAME contains duplicate destinations.
400: Destination cannot contain users.
400: Resource cannot contain other objects along with Any.
400: Connection NAME contains duplicate sources.
400: You cannot add external resources to interface connections.
400: You cannot have Any in both the source and destination.
400: You cannot add external resources to interface connections.
400: Source cannot contain both users and servers.
400: Connection NAME contains duplicate services.
400: Cannot contain other services along with ANY.
400: Connections can only include objects within the same customer.
401: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
401: Access is denied
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","dataMode":"raw","folder":"2-2","rawModeData":"\n\t \n\t\t Connection A\n\t\t Connection A comment\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t\t \n\t\t\t\t 3\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t \n\t \n\t\t Connection B\n\t \n\t \n\t\t Connection C\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t \n\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections","collectionId":"2","id":"2-2-9","method":"POST"},{"headers":"Content-Type: application/xml\n","name":"Update connections","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: List of connections

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections
BODY<connections>
     <connection>
         <id>1</id>
         <name>Connection A</name>
         <comment>Connection A comment</comment>
         <sources>
             <source>
                 <id>2</id>
             </source>
             <source>
                 <id>3</id>
             </source>
         </sources>
         <services>
             <service>
                 <id>1</id>
             </service>
         </services>
         <destinations>
             <destination>
                 <id>1</id>
             </destination>
         </destinations>
     </connection>
     <connection>
         <id>2</id>
         <name>Connection B</name>
     </connection>
     <connection>
         <id>3</id>
         <name>Connection C</name>
         <sources>
             <source>
                 <id>2</id>
             </source>
         </sources>
     </connection>
</connections>


Response Messages:
200: Connections were modified.
400: Reference to service ID is invalid.
400: Reference to source/destination with ID is invalid.
400: Connection name cannot be empty.
400: Connection name already exists.
400: Connection NAME contains duplicate destinations.
400: Destination cannot contain users.
400: Resource cannot contain other objects along with Any.
400: Connection NAME contains duplicate sources.
400: You cannot add external resources to interface connections.
400: You cannot have Any in both the source and destination.
400: You cannot add external resources to interface connections.
400: Source cannot contain both users and servers.
400: Connection NAME contains duplicate services.
400: Cannot contain other services along with ANY.
400: Connections can only include objects within the same customer.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permission to access application that contains the server ID
401: You do not have permissions to edit this application.
401: Access is denied
401: You cannot edit or delete an external connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID.","dataMode":"raw","folder":"2-2","rawModeData":"\n\t \n\t\t 1\n\t\t Connection A\n\t\t Connection A comment\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t\t \n\t\t\t\t 3\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t \n\t \n\t\t 2\n\t\t Connection B\n\t \n\t \n\t\t 3\n\t\t Connection C\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t \n\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections","collectionId":"2","id":"2-2-10","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve an existing connection by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"connectionId"}],"description":"Parameters:
applicationId: The unique identifier of the application
connectionId: The unique identifier of the connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/1

Response Messages:
401: No available licenses. Ask your SecureApp administrator for assistance.
401: Access is denied
401: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID.","dataMode":"params","folder":"2-2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}","collectionId":"2","id":"2-2-11","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Update a connection","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"connectionId"}],"description":"Parameters:
applicationId: The unique identifier of the application
connectionId: The unique identifier of the connection
body: Connection

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections/1
BODY <connection>
     <name>Connection A</name>
     <comment>Connection A comment</comment>
     <sources>
         <source>
             <id>2</id>
         </source>
         <source>
             <id>3</id>
         </source>
     </sources>
     <services>
         <service>
             <id>1</id>
         </service>
     </services>
     <destinations>
         <destination>
             <id>1</id>
         </destination>
     </destinations>
</connection>


Response Messages:
200: Connection was modified.
400: Reference to service ID is invalid.
400: Reference to source/destination with ID is invalid.
400: Connection name cannot be empty.
400: Connection name already exists.
400: Connection NAME contains duplicate destinations.
400: Destination cannot contain users.
400: Resource cannot contain other objects along with Any.
400: Connection NAME contains duplicate sources.
400: You cannot add external resources to interface connections.
400: You cannot have Any in both the source and destination.
400: You cannot add external resources to interface connections.
400: Source cannot contain both users and servers.
400: Connection NAME contains duplicate services.
400: Cannot contain other services along with ANY.
400: Connections can only include objects within the same customer.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permission to access application that contains the server ID
401: You do not have permissions to edit this application.
401: Access is denied
401: You cannot edit or delete an external connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID.","dataMode":"raw","folder":"2-2","rawModeData":" \n\t Connection A\n\t Connection A comment\n\t \n\t\t \n\t\t\t 2\n\t\t \n\t\t \n\t\t\t 3\n\t\t \n\t \n\t \n\t\t \n\t\t\t 1\n\t\t \n\t \n\t \n\t\t \n\t\t\t 1\n\t\t \n\t \n ","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}","collectionId":"2","id":"2-2-12","method":"PUT"},{"name":"Delete connection","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"connectionId"}],"description":"Parameters:
applicationId: The unique identifier of the application
connectionId: The unique identifier of the connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/1

Response Messages:
200: Connection was deleted.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
401: Access is denied
401: You cannot edit or delete an external connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID.","dataMode":"params","folder":"2-2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}","collectionId":"2","id":"2-2-13","method":"DELETE"},{"headers":"Accept: application/json\n","collectionId":"2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/application_identities","name":"Fetches application identities","method":"GET","id":"2-3-14","description":"Fetches the list of pre-defined application identities (like facebook) that can be used in a connection.

Parameters:
name: The name of the service [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/application_identities

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/application_identities?name=facebook

Response Messages:
404: There are no application identities with the name NAME.
401: Access is denied.","folder":"2-3"},{"headers":"Accept: application/json\n","name":"Retrieve existing interface connections","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
name: The name of the interface connection [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections?name=Connection 1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There are no connection interfaces with the name NAME.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections","collectionId":"2","id":"2-4-15","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create interface connections","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
body: The interface connections

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections
BODY<interface_connections>
    <interface_connection>
        <name>Connection 1</name>
        <sources>
            <source>
                <id>3</id>
            </source>
        </sources>
        <services>
            <service>
                <id>3</id>
            </service>
            <service>
                <id>Facebook</id>
            </service>
        </services>
        <comment>New connection</comment>
    </interface_connection>
</interface_connections>


Response Messages:
200: Interface connections were created.
201: Interface connection was created.
400: There are no items to add.
400: Cannot create interface connection without a name.
400: Connection name already exists.
400: You cannot add user to connection interface.
400: You cannot add Any to connection interface.
400: You cannot add Internet to connection interface.
400: Cannot have external servers.
400: Cannot have both sources and destinations.
400: Connection NAME contains duplicate sources.
400: Connection NAME contains duplicate services.
400: Connection NAME contains duplicate destinations.
400: Reference to source/destination with ID is invalid.
400: Reference to service ID is invalid.
401: Access is denied.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.","dataMode":"raw","folder":"2-4","rawModeData":"\n\t\n\t\tConnection 1\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\t\n\t\t\t\tFacebook\n\t\t\t\n\t\t\n\t\tNew connection\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections","collectionId":"2","id":"2-4-16","method":"POST"},{"headers":"Accept: application/json\n","name":"Retrieve an existing interface connection by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"},{"value":null,"type":"text","enabled":true,"key":"connectionInterfaceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
connectionInterfaceId: The unique identifier of the interface connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections/1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}","collectionId":"2","id":"2-4-17","method":"GET"},{"name":"Delete interface connection","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"},{"value":null,"type":"text","enabled":true,"key":"connectionInterfaceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
connectionInterfaceId: The unique identifier of the interface connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections/1

Response Messages:
200: Interface connection was deleted.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}","collectionId":"2","id":"2-4-18","method":"DELETE"},{"headers":"Content-Type: application/xml\n","name":"Update an interface connection","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"},{"value":null,"type":"text","enabled":true,"key":"connectionInterfaceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
connectionInterfaceId: The unique identifier of the interface connection
body: The interface connection

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections/1
BODY<interface_connection>
    <name>Updated name</name>
    <sources>
        <source>
            <id>19</id>
        </source>
    </sources>
    <services>
        <service>
            <id>9</id>
        </service>
    </services>
    <comment>Updated connection</comment>
</interface_connection>


Response Messages:
200: Interface connection was modified.
400: Interface connection name cannot be empty.
400: Connection name already exists.
400: You cannot add user to connection interface.
400: You cannot add Any to connection interface.
400: You cannot add Internet to connection interface.
400: Cannot have external servers.
400: Cannot have both sources and destinations.
400: Connection NAME contains duplicate sources.
400: Connection NAME contains duplicate services.
400: Connection NAME contains duplicate destinations.
400: Reference to source/destination with ID is invalid.
400: Reference to service ID is invalid.
401: Access is denied.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID.","dataMode":"raw","folder":"2-4","rawModeData":"\n\tUpdated name\n\t\n\t\t\n\t\t\t19\n\t\t\n\t\n\t\n\t\t\n\t\t\t9\n\t\t\n\t\n\tUpdated connection\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}","collectionId":"2","id":"2-4-19","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Update a connection to application","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"connectionToApplicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
connectionToApplicationId: The unique identifier of the connection to application
body: The connection to application

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications/1
BODY<connection_to_application>
    <name>Updated name</name>
    <comment>Updated connection to application</comment>
    <servers>
        <server>
            <id>4</id>
        </server>
    </servers>
</connection_to_application>


Response Messages:
200: Connection to application was modified.
400: Name cannot be empty.
400: Name already exists.
400: Reference to source/destination with ID is invalid.
400: You cannot add ANY to connection to application.
400: You cannot add user to connection to application.
400: You cannot add Internet to connection to application.
401: Access is denied
401: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection to application with ID was not found for application interface with ID.","dataMode":"raw","folder":"2-4","rawModeData":"\n\tUpdated name\n\tUpdated connection to application\n\t\n\t\t\n\t\t\t4\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications/{{connectionToApplicationId}}","collectionId":"2","id":"2-4-20","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve an existing connection to application by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"connectionToApplicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
connectionToApplicationId: The unique identifier of the connection to application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications/1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Connection to application with ID was not found for application interface with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications/{{connectionToApplicationId}}","collectionId":"2","id":"2-4-21","method":"GET"},{"name":"Delete connection to application","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"connectionToApplicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
connectionToApplicationId: The unique identifier of the connection to application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications/1

Response Messages:
200: Connection to application was deleted.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection to application with ID was not found for application interface with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications/{{connectionToApplicationId}}","collectionId":"2","id":"2-4-22","method":"DELETE"},{"headers":"Content-Type: application/xml\n","name":"Create application interface","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: The application interface

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces
BODY<application_interface>
    <name>Interface to Application 1</name>
    <comment>New application interface</comment>
</application_interface>


Response Messages:
201: Application interface was created.
400: You cannot add to application NAME because it was decommissioned.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.","dataMode":"raw","folder":"2-4","rawModeData":"\n\tInterface to Application 1\n\tNew application interface\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces","collectionId":"2","id":"2-4-23","method":"POST"},{"headers":"Accept: application/json\n","name":"Retrieve existing application interfaces","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"dataMode":"params","description":"To improve response time, set 'calculateIsPublished = false' to avoid calculating 'is_published'.

Parameters:
applicationId: The unique identifier of the application
name: The name of the application interface [optional]
calculateIsPublished: Should calculate is_published value [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces?name=Interface to Application 1

Response Messages:
400: There is no application with the specified ID.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There are no application interfaces with the name NAME.","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces","collectionId":"2","id":"2-4-24","method":"GET"},{"name":"Delete application interface","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1

Response Messages:
200: Application interface was deleted.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}","collectionId":"2","id":"2-4-25","method":"DELETE"},{"headers":"Content-Type: application/xml\n","name":"Update an application interface","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"}],"dataMode":"raw","description":"Update the application interface properties. If is_published is set to true, the application interface is published for use by other users.

Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of The application interface
body: The application interface

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1
BODY<application_interface>
    <name>updated name</name>
    <comment>Updated application interface</comment>
    <is_published>true</is_published>
</application_interface>


Response Messages:
200: Application interface was modified.
400: Application interface is not complete for publish.
400: Name cannot be empty.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.","folder":"2-4","rawModeData":"\n\tupdated name\n\tUpdated application interface\n\ttrue\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}","collectionId":"2","id":"2-4-26","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve an existing application interface by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}","collectionId":"2","id":"2-4-27","method":"GET"},{"headers":"Accept: application/json\n","name":"Retrieve existing connections to application","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the connection to application [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications?name=Connection to Application 1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications","collectionId":"2","id":"2-4-28","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create connection to application","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"dataMode":"raw","description":"Create a connection from this application to an application interface.

Parameters:
applicationId: The unique identifier of the application
body: The connection to application

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications
BODY<connection_to_application>
    <name>Connection to Application 1</name>
    <comment>New connection to application</comment>
    <application_interface_id>1</application_interface_id>
    <servers>
        <server>
            <id>3</id>
        </server>
    </servers>
</connection_to_application>


Response Messages:
201: Connection to application was created.
400: You cannot add to application NAME because it was decommissioned.
400: The selected interface cannot be used more than once in the application.
400: Name cannot be empty.
400: Cannot create from local interface.
400: ApplicationInterface didn't got published.
400: Name already exists.
400: Cannot create connection to application without servers, there should be at least one server.
400: Reference to source/destination with ID is invalid.
400: You can use only interface from the same customer.
400: You cannot add ANY to connection to application.
400: You cannot add user to connection to application.
400: You cannot add Internet to connection to application.
401: Access is denied
401: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found.","folder":"2-4","rawModeData":"\n\tConnection to Application 1\n\tNew connection to application\n\t1\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications","collectionId":"2","id":"2-4-29","method":"POST"},{"headers":"Content-Type: application/xml\n","name":"Update connection to application mappings for source and target applications","data":[{"value":null,"type":"text","enabled":true,"key":"sourceApplicationId"},{"value":null,"type":"text","enabled":true,"key":"targetApplicationId"}],"dataMode":"raw","description":"Use id=-1 for target_application_interface if new mapping is “Not Needed”.
If the source is specified and the target is empty, the mapping that is currently configured will be deleted.

Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application
body: The interface instance mapping list [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/connections_to_applications_mapping
BODY<connections_to_applications_mapping>
    <connection_to_application_mapping>
        <source_connection_to_application>
            <id>1</id>
        </source_connection_to_application>
        <target_application_interface>
            <id>4</id>
        </target_application_interface>
    </connection_to_application_mapping>
    <connection_to_application_mapping>
        <source_connection_to_application>
            <id>2</id>
        </source_connection_to_application>
        <target_application_interface>
            <id>-1</id>
        </target_application_interface>
    </connection_to_application_mapping>
    <connection_to_application_mapping>
        <source_connection_to_application>
            <id>3</id>
        </source_connection_to_application>
    </connection_to_application_mapping>
</connections_to_applications_mapping>


Response Messages:
200: Connection to application mappings were modified.
400: Source interface instance cannot be empty.
400: Source interface instance object is not valid
400: Target application interface is not valid
400: Connection to application with ID: ID was not found.
400: Interface with ID: ID was not found.
400: Cannot remove mapping of instance with ID because it has never been mapped.
400: Cannot migrate application to itself.
400: Cannot map instance to interface with ID ID because the interface exists in target application.
400: Cannot map to duplicate application interfaces
400: Application interface didn't got published
400: Connection to application with id: ID must used by source application
400: You cannot map connection to application ID, because it is contained in a connection to application pack.
400: Application interface ID must be in the same customer as the target application.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","folder":"2-5","rawModeData":"\n\t\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n\t\n\t\t\n\t\t\t2\n\t\t\n\t\t\n\t\t\t-1\n\t\t\n\t\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/connections_to_applications_mapping","collectionId":"2","id":"2-5-30","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve connection to application mappings for source and target applications","data":[{"value":null,"type":"text","enabled":true,"key":"sourceApplicationId"},{"value":null,"type":"text","enabled":true,"key":"targetApplicationId"}],"description":"Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/connections_to_applications_mapping

Response Messages:
400: Cannot get mappings between application to itself.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.","dataMode":"params","folder":"2-5","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/connections_to_applications_mapping","collectionId":"2","id":"2-5-31","method":"GET"},{"name":"Copy application servers and connections to another application.","data":[{"value":null,"type":"text","enabled":true,"key":"sourceApplicationId"},{"value":null,"type":"text","enabled":true,"key":"targetApplicationId"}],"dataMode":"params","description":"This API can be used to:
1. Create applications based on a blueprint (template).
2. Copy applications between environments (dev, test, prod).
3. Migrate applications between data-centers.

Before migrating make sure to map servers and connections to applications (if any exist).\nThis migration uses the configuration specified in the other API calls.

Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2

Response Messages:
200: Application was migrated.
400: Cannot migrate a decommissioned application.
400: Cannot migrate to a decommissioned application.
400: Cannot migrate an application to itself.
400: Cannot edit target DEVICE application.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
400: The source application has no connections to migrate.
409: You cannot migrate the application because not all servers are mapped.
409: You cannot migrate the application because not all connections to application are mapped.
409: You cannot migrate the application because one of the interfaces in the original application has been changed and has not been published.","folder":"2-5","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}","collectionId":"2","id":"2-5-32","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Update server mappings for source and target applications","data":[{"value":null,"type":"text","enabled":true,"key":"sourceApplicationId"},{"value":null,"type":"text","enabled":true,"key":"targetApplicationId"}],"dataMode":"raw","description":"Use id=-1 for target_network_object if new mapping is “Not Needed”.
If the source is specified and the target is empty, the mapping that is currently configured will be deleted.

Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application
body: The server mapping list [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/servers_mapping
BODY<servers_mapping>
    <server_mapping>
        <source_network_object>
            <id>3</id>
        </source_network_object>
        <target_network_object>
            <id>4</id>
        </target_network_object>
    </server_mapping>
    <server_mapping>
        <source_network_object>
            <id>5</id>
        </source_network_object>
        <target_network_object>
            <id>-1</id>
        </target_network_object>
    </server_mapping>
    <server_mapping>
        <source_network_object>
            <id>6</id>
        </source_network_object>
    </server_mapping>
</servers_mapping>


Response Messages:
200: Server mappings were modified.
400: Source network object cannot be empty.
400: Source network object is not valid
400: Target network object is not valid
400: Source and target network objects must be internal or external both.
400: Cannot use DEVICE application resources as external network objects.
400: Source network object with ID must be used by any connection.
400: Cannot remove mapping of network object with ID because it has never been mapped.
400: Cannot migrate application to itself.
400: Cannot map to ANY network object.
400: Cannot map Internet network object.
400: Cannot map to Internet network object.
400: Target network object ID must be in the same customer as the target application.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Server with ID was not found.","folder":"2-5","rawModeData":"\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n\t\n\t\t\n\t\t\t5\n\t\t\n\t\t\n\t\t\t-1\n\t\t\n\t\n\t\n\t\t\n\t\t\t6\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/servers_mapping","collectionId":"2","id":"2-5-33","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve server mappings for source and target applications","data":[{"value":null,"type":"text","enabled":true,"key":"sourceApplicationId"},{"value":null,"type":"text","enabled":true,"key":"targetApplicationId"}],"description":"Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application
search_servers_type: Search server type [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/servers_mapping

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/servers_mapping?search_servers_type=EXTERNAL

Response Messages:
400: Search migrated servers type parameter must be either internal, external or both.
400: Cannot get mappings between application to itself.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permission to access application with ID
401: You do not have permissions to edit this application.
404: There is no application with the specified ID.","dataMode":"params","folder":"2-5","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/servers_mapping","collectionId":"2","id":"2-5-34","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Update an application pack","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"}],"dataMode":"raw","description":"Update the application pack properties. If is_published is set to true, the application pack is published for use by other users.

Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
body: Application pack

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1
BODY<application_pack>
    <name>Updated name</name>
    <comment>Updated application pack</comment>
    <owner>
        <id>4</id>
    </owner>
    <editors>
        <editor>
            <id>3</id>
        </editor>
    </editors>
    <viewers>
        <viewer>
            <id>5</id>
        </viewer>
    </viewers>
    <is_published>true</is_published>
</application_pack>


Response Messages:
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to owner ID is invalid.
400: The owner NAME does not have permission to access applications.
400: There is an editor without an ID or name.
400: The application pack owner cannot also be an editor of the application pack.
400: There is a viewer without an ID or name.
400: The application pack owner cannot also be a viewer of the application pack.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application pack.
400: Application pack NAME already exists.
400: Application pack name must contain at least 2 and no more than 160 characters.
400: Customer NAME is not imported to SecureApp.
400: Customer NAME was decommissioned.
400: Application pack with ID is not ready for publish, or has no changes from the last publish.
401: Access is denied
401: You do not have permission to access application that contains the interface ID
401: You do not have permissions to edit this application pack.
401: You do not have permissions to change the owner of application pack ID.
401: You do not have permissions to change the editors and viewers of application pack ID.
404: There are no application packs with the NAME in customer with ID.","folder":"2-6","rawModeData":"\n\tUpdated name\n\tUpdated application pack\n\t\n\t\t4\n\t\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\n\t\n\t\t\n\t\t\t5\n\t\t\n\t\n\ttrue\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}","collectionId":"2","id":"2-6-35","method":"PUT"},{"name":"Delete application pack","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1

Response Messages:
200: Application pack wes deleted.
401: You do not have permissions to delete this application pack.
400: There is no application pack with the specified ID.
400: Customer with ID doesn't own an application pack with ID.
400: Application Pack ID cannot be deleted. It is in use by applications IDs.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}","collectionId":"2","id":"2-6-36","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Retrieve an existing application pack by ID","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to retrieve

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1

Response Messages:
401: Access is denied
401: You do not have permission to access application pack with ID
404: Application pack with ID was not found for customer with ID.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}","collectionId":"2","id":"2-6-37","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Update application interfaces and tag mapping","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"}],"dataMode":"raw","description":"Add application interfaces to application pack, and map a tag to the application interface. If a tag is not specified for the interface, the tag will be set to “No Tag”.

Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
body: List of interface tag mapping to be added or modified

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/application_interfaces
BODY<application_interface_tags>
    <application_interface_tag>
        <application_interface>
            <id>1</id>
        </application_interface>
        <tag>
            <id>3</id>
        </tag>
    </application_interface_tag>
    <application_interface_tag>
        <application_interface>
            <id>2</id>
        </application_interface>
    </application_interface_tag>
</application_interface_tags>


Response Messages:
401: Access is denied
404: There are no application packs with the NAME in customer with ID.
401: You do not have permissions to edit this application pack.
401: You do not have permission to access application that contains the interface ID
400: You cannot edit APPLICATION PACK because it was decommissioned.
400: Application Interface can't be null.
400: Empty interface ID is not valid.","folder":"2-6","rawModeData":"\n\t\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t3\n\t\t\n\t\n\t\n\t\t\n\t\t\t2\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/application_interfaces","collectionId":"2","id":"2-6-38","method":"PUT"},{"name":"Remove application interfaces from application pack","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"},{"value":null,"type":"text","enabled":true,"key":"application_interface_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
application_interface_id: IDs of application interfaces to remove

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/application_interfaces?application_interface_id=1&application_interface_id=2

Response Messages:
200: Application Interface was deleted.
401: Access is denied
401: You do not have permissions to edit this application pack.
404: There are no application packs with the ID in customer with ID.
404: Application Package ID was not found.
404: Application interface ID was not found in application pack ID.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/application_interfaces","collectionId":"2","id":"2-6-39","method":"DELETE"},{"headers":"Accept: application/json\n","name":"List all application pack tags","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags

Response Messages:
401: Access is denied
404: There is no application pack with the ID.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","collectionId":"2","id":"2-6-40","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Modify tags of an application pack","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
body: Tags to modify

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags
BODY<tags>
    <tag>
        <id>1</id>
        <name>Tag 1</name>
    </tag>
    <tag>
        <id>2</id>    
        <name>Tag 2</name>
    </tag>
</tags>


Response Messages:
401: Access is denied
401: You do not have permissions to edit this application pack.
404: Customer with ID was not found.
404: There is no application pack with the ID in customer with ID.
400: Tag with NAME already exists in application pack ID.
400: Updated tag ID can't be empty
400: Updated Tag ID doesn't exist on application pack ID.","dataMode":"raw","folder":"2-6","rawModeData":"\n\t\n\t\t1\n\t\tTag 1\n\t\n\t\n\t\t2\t\n\t\tTag 2\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","collectionId":"2","id":"2-6-41","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Create new Tag under an application pack ","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack
body: List of tags

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags
BODY<tags>
    <tag>
        <name>Tag 1</name>
    </tag>
    <tag>
        <name>Tag 2</name>
    </tag>
</tags>


Response Messages:
401: Access is denied
404: There is no application pack with the ID in customer with ID.
400: You cannot edit APPLICATION PACK because it was decommissioned.
400: Tag name must contain at least 2 and no more than 160 characters.
400: Tag with NAME already exists in application pack ID.","dataMode":"raw","folder":"2-6","rawModeData":"\n\t\n\t\tTag 1\n\t\n\t\n\t\tTag 2\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","collectionId":"2","id":"2-6-42","method":"POST"},{"name":"Delete tags from application pack","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"},{"value":null,"type":"text","enabled":true,"key":"tag_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
tag_id: IDs of tags to remove

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/21/tags?tag_id=1&tag_id=2

Response Messages:
200: Tags were deleted.
401: Access is denied
401: You do not have permissions to edit this application pack.
404: There are no application packs with the ID in customer with ID.
404: Application Package ID was not found.
404: Tag ID was not found in application pack ID.
404: Tag ID is in use so can't be deleted.
404: Removed tag ID can't be empty.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","collectionId":"2","id":"2-6-43","method":"DELETE"},{"name":"Delete a connection to application pack","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"},{"value":null,"type":"text","enabled":true,"key":"connection_to_application_pack_id"}],"description":"Parameters:
application_id: The unique identifier of application
connection_to_application_pack_id: The unique identifier of the connection to application pack to delete

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs/1

Response Messages:
400: Connection to application pack with ID was not found for application with ID.
400: The connection to application pack was already deleted.
401: Access is denied.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/{{connection_to_application_pack_id}}","collectionId":"2","id":"2-6-44","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Retrieve an existing connection to application pack by ID.","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"},{"value":null,"type":"text","enabled":true,"key":"connection_to_application_pack_id"}],"description":"Parameters:
application_id: The unique identifier of application
connection_to_application_pack_id: The unique identifier of the connection to application pack

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs/1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
404: There is no connection to application pack with the specified ID.
400: Application with ID doesn't own a connection to application pack with ID.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/{{connection_to_application_pack_id}}","collectionId":"2","id":"2-6-45","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Update an application pack","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"},{"value":null,"type":"text","enabled":true,"key":"connection_to_application_pack_id"}],"description":"Parameters:
application_id: The unique identifier of application
connection_to_application_pack_id: The unique identifier of the connection to application pack to update
body: Connection to application pack

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs/1
BODY<connection_to_application_pack>
    <name>Updated name</name>
    <comment>Updated Connection to application pack</comment>
    <tags_servers>
        <tag_servers>
            <tag>
                <id>1</id>
            </tag>
            <servers>
                <server>
                    <id>3</id>
                </server>
            </servers>
        </tag_servers>
        <tag_servers>
            <tag>
                <name>Tag 1</name>
            </tag>
            <servers>
            </servers>
        </tag_servers>
    </tags_servers>
</connection_to_application_pack>


Response Messages:
400: There is no application with the specified ID.
400: There is no connection to application pack with the specified ID.
400: Application with ID doesn't own a connection to application pack with ID.
400: Name cannot be empty.
400: Name must contain at least 2 and no more than 160 characters.
400: Name already exists.
400: Tag cannot be empty.
400: Tag ID or name is required.
400: Tag with Name was not found.
400: Server ID cannot be empty.
400: Servers cannot be null.
400: You cannot add ANY to connection to application pack.
400: You cannot add user to connection to application pack.
400: You cannot add Internet to connection to application pack.
401: Access is denied.
401: You do not have permission to access application that contains the server ID
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.","dataMode":"raw","folder":"2-6","rawModeData":"\n\tUpdated name\n\tUpdated Connection to application pack\n\t\n\t\t\n\t\t\t\n\t\t\t\t1\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t3\n\t\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\tTag 1\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/{{connection_to_application_pack_id}}","collectionId":"2","id":"2-6-46","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Update application packs","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"}],"dataMode":"raw","description":"Update the application packs properties. If is_published is set to true, the application pack is published for use by other users.

Parameters:
customer_id: The unique identifier of customer
body: List of application packs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs
BODY<application_packs>
    <application_pack>
        <id>1</id>
        <name>Updated name</name>
        <comment>Updated application pack</comment>
        <owner>
            <id>4</id>
        </owner>
        <editors>
            <editor>
                <id>3</id>
            </editor>
        </editors>
        <is_published>false</is_published>
    </application_pack>
</application_packs>


Response Messages:
400: There are no application packs to edit.
400: Application pack ID cannot be empty.
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to owner ID is invalid.
400: The owner NAME does not have permission to access applications.
400: There is an editor without an ID or name.
400: The application pack owner cannot also be an editor of the application pack.
400: There is a viewer without an ID or name.
400: The application pack owner cannot also be a viewer of the application pack.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application pack.
400: Application pack NAME already exists.
400: Application pack name must contain at least 2 and no more than 160 characters.
400: Customer NAME is not imported to SecureApp.
400: Customer NAME was decommissioned.
400: Application pack with ID is not ready for publish, or has no changes from the last publish.
401: Access is denied
401: You do not have permission to access application that contains the interface ID
401: You do not have permissions to edit this application pack.
401: You do not have permissions to change the owner of application pack ID.
401: You do not have permissions to change the editors and viewers of application pack ID.
404: There are no application packs with the NAME in customer with ID.","folder":"2-6","rawModeData":"\n\t\n\t\t1\n\t\tUpdated name\n\t\tUpdated application pack\n\t\t\n\t\t\t4\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\n\t\tfalse\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/","collectionId":"2","id":"2-6-47","method":"PUT"},{"headers":"Accept: application/json\n","name":"List all application packs","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
name: The name of the application pack [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs?name=Application pack 1

Response Messages:
401: Access is denied
404: There are no application packs with the NAME in customer with ID.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/","collectionId":"2","id":"2-6-48","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create new application packs","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
body: List of application packs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs
BODY<application_packs>
    <application_pack>
        <name>Application pack 1</name>
        <comment>New application pack</comment>
        <owner>
            <id>4</id>
        </owner>
        <editors>
            <editor>
                <id>3</id>
            </editor>
        </editors>
        <viewers>
            <viewer>
                <id>5</id>
            </viewer>
        </viewers>
    </application_pack>
</application_packs>


Response Messages:
401: Access is denied
401: You do not have permission to access application that contains the interface ID
400: There are no application packs to add.
400: Application pack can be created only in meshed domain mode.
404: Customer with ID was not found.
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to owner ID is invalid.
400: There is an editor without an ID or name.
400: The application pack owner cannot also be an editor of the application pack.
400: There is a viewer without an ID or name.
400: The application pack owner cannot also be a viewer of the application pack.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application pack.
400: The owner NAME does not have permission to access applications.
400: Application pack was already saved.
400: Application pack NAME already exists.
400: Application pack name must contain at least 2 and no more than 160 characters.
400: Customer NAME is not imported to SecureApp.
400: Customer NAME was decommissioned.","dataMode":"raw","folder":"2-6","rawModeData":"\n\t\n\t\tApplication pack 1\n\t\tNew application pack\n\t\t\n\t\t\t4\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t5\n\t\t\t\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/","collectionId":"2","id":"2-6-49","method":"POST"},{"headers":"Accept: application/json\n","name":"Get tag by ID","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"},{"value":null,"type":"text","enabled":true,"key":"tag_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack
tag_id: The unique identifier of a tag

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags/1

Response Messages:
401: Access is denied
404: There is no tag with ID.
404: Customer with ID doesn't own a tag with ID.
404: Application Pack with ID doesn't own a tag with ID.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags/{{tag_id}}","collectionId":"2","id":"2-6-50","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create new connection to application packs","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"}],"description":"Parameters:
application_id: The unique identifier of application
body: List of connection to application packs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs
BODY<connection_to_application_packs>
    <connection_to_application_pack>
        <name>Connection to application pack 1</name>
        <comment>New Connection to application pack</comment>
        <application_pack>
            <id>1</id>
        </application_pack>
        <tags_servers>
            <tag_servers>
                <tag>
                    <id>1</id>
                </tag>
                <servers>
                    <server>
                        <id>3</id>
                    </server>
                </servers>
            </tag_servers>
            <tag_servers>
                <tag>
                    <name>Tag 1</name>
                </tag>
                <servers>
                    <server>
                        <id>4</id>
                    </server>
                </servers>
            </tag_servers>
        </tags_servers>
    </connection_to_application_pack>
</connection_to_application_packs>


Response Messages:
400: There are no connection to application packs to add.
400: Application pack ID cannot be empty.
400: Application with ID was not found.
400: There is no application with the specified ID.
400: There is no application pack with the specified ID.
400: Application pack with ID was decommissioned.
400: Application pack with ID was not published.
400: Connection to application pack cannot be created in the domain of the application pack.
400: The application pack cannot be used more than once in the application.
400: Name cannot be empty.
400: Name must contain at least 2 and no more than 160 characters.
400: Name already exists.
400: Tag cannot be empty.
400: Tag ID or name is missing.
400: Tag ID does not exist.
400: Server ID does not exist.
400: Tag ID is not in use in connection to application pack ID, so it cannot be updated.
400: Servers cannot be null.
400: You cannot add ANY to connection to application pack.
400: You cannot add user to connection to application pack.
400: You cannot add Internet to connection to application pack.
401: Access is denied.
401: You do not have permission to access application that contains the server ID
401: You do not have permission to access application pack with ID
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Tag with NAME was not found.","dataMode":"raw","folder":"2-6","rawModeData":"\n\t\n\t\tConnection to application pack 1\n\t\tNew Connection to application pack\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t1\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t3\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\tTag 1\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t4\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/","collectionId":"2","id":"2-6-51","method":"POST"},{"headers":"Accept: application/json\n","name":"Retrieve a list of all connection to application pack by application ID.","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"}],"description":"Parameters:
application_id: The unique identifier of application
name: The name of the connection to application pack [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs?name=Connection to application pack 1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
404: There are no connection to application pack with the NAME in application with ID.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/","collectionId":"2","id":"2-6-52","method":"GET"},{"headers":"Accept: application/json\n","name":"Retrieve existing access rules","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/87/access_requests

Response Messages:
400: The application was already deleted.
400: There are no changed connections that are ready for creating a ticket.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
400: Application with ID ID was not found.","dataMode":"params","folder":"2-7","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/access_requests","collectionId":"2","id":"2-7-53","method":"GET"},{"headers":"Accept: application/json\n","collectionId":"2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/network_objects","name":"Fetches servers","method":"GET","id":"2-8-54","description":"Parameters:
name: The name of the servers [optional]
typeOnDevice: The typeOnDevice of the servers [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects?name=server1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects?typeOnDevice=edl_ip_list

Response Messages:
400: Server with name NAME was not found.
400: Parameter typeOnDevice is not valid.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There are no servers with the name NAME
404: There are no servers with the typeOnDevice TYPEONDEVICE ","folder":"2-8"},{"headers":"Accept: application/json\n","name":"Fetches server by ID","data":[{"value":null,"type":"text","enabled":true,"key":"serverId"}],"description":"Parameters:
serverId: The ID of the server

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects/87

Response Messages:
400: Server with id ID was not found.
400: Application with ID ID was not found.
400: The application was already deleted.
401: Access is denied
401: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.","dataMode":"params","folder":"2-8","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/network_objects/{{serverId}}","collectionId":"2","id":"2-8-55","method":"GET"},{"headers":"Accept: application/json\n","name":"Retrieve existing servers","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the server [optional]
typeOnDevice: The typeOnDevice of the servers [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects?name=ServerName

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects?typeOnDevice=edl_ip_list

Response Messages:
400: The application was already deleted.
400: Parameter typeOnDevice is not valid.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: There are no servers with the name NAME.
404: There are no servers with the typeOnDevice TYPEONDEVICE ","dataMode":"params","folder":"2-9","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects","collectionId":"2","id":"2-9-56","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Update servers","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: List of servers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects
BODY<network_objects xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
     <network_object xsi:type=\"hostNetworkObjectDTO\">
         <id>1</id>
         <comment>host comment</comment>
         <name>host1</name>
         <ip>1.1.1.1</ip>
         <type>host</type>
     </network_object>
     <network_object xsi:type=\"rangeNetworkObjectDTO\">
         <id>2</id>
         <comment>range comment</comment>
         <name>range1</name>
         <first_ip>2.2.2.2</first_ip>
         <last_ip>2.2.2.22</last_ip>
         <type>range</type>
     </network_object>
     <network_object xsi:type=\"subnetNetworkObjectDTO\">
         <id>3</id>
         <comment>subnet comment</comment>
         <name>subnet1</name>
         <ip>3.3.3.3</ip>
         <netmask>255.255.255.0</netmask>
         <type>subnet</type>
     </network_object>
     <network_object xsi:type=\"networkObjectVirtualServerDTO\">
         <id>4</id>
         <comment>virtual server comment</comment>
         <uid>{e1a7722f-e92e-48f2-9087-9cb1711eb8b9}</uid>
         <device_id>12</device_id>
         <type>virtual-server</type>
     </network_object>
     <network_object xsi:type=\"vmInstanceDTO\">
         <id>5</id>
         <name>vm1</name>
         <comment>vm instance comment</comment>
         <type>vm_instance</type>
     </network_object>
     <network_object xsi:type=\"networkObjectGroupDTO\">
         <id>6</id>
         <comment>group comment</comment>
         <name>group1</name>
         <access_allowed>true</access_allowed>
         <type>group</type>
         <member>
             <id>3</id>
         </member>
        <type_on_device>edl_ip_list</type_on_device>     </network_object>
</network_objects>


Response Messages:
400: The application was already deleted.
400: You cannot update a predefined object.
400: Invalid type in server with id ID.
400: Invalid member with id ID
400: Invalid ID
400: Invalid uid
400: Invalid network object type NAME
400: Cannot update user
400: Network object is new
400: Name cannot be empty
400: Server is in discovery
400: Ip is missing
400: Mask is missing
400: Invalid ip
400: Invalid mask
400: Max ip is missing
400: Min ip is missing
400: Invalid min ip
400: Invalid max ip
400: Min ip cannot be larger than max ip
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Internet cannot be a member of a group.
400: Server with NAME already exists.
400: Invalid device ID
400: The type_on_device value is not valid
400: An EDL group can not be modified to a regular group
400: The virtual server already exists in SecureApp as resource NAME: VIRTUAL SERVER NAME VIRTUAL SERVER DEVICE NAME.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: DTO type used for server id ID is incompatible with this vendor.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Virtual server was not found in ST.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID.
503: Not connected to SecureTrack.","dataMode":"raw","folder":"2-9","rawModeData":"\n\t \n\t\t 1\n\t\t host comment\n\t\t host1\n\t\t 1.1.1.1\n\t\t host\n\t \n\t \n\t\t 2\n\t\t range comment\n\t\t range1\n\t\t 2.2.2.2\n\t\t 2.2.2.22\n\t\t range\n\t \n\t \n\t\t 3\n\t\t subnet comment\n\t\t subnet1\n\t\t 3.3.3.3\n\t\t 255.255.255.0\n\t\t subnet\n\t \n\t \n\t\t 4\n\t\t virtual server comment\n\t\t {e1a7722f-e92e-48f2-9087-9cb1711eb8b9}\n\t\t 12\n\t\t virtual-server\n\t \n\t \n\t\t 5\n\t\t vm1\n\t\t vm instance comment\n\t\t vm_instance\n\t \n\t \n\t\t 6\n\t\t group comment\n\t\t group1\n\t\t true\n\t\t group\n\t\t \n\t\t\t 3\n\t\t \n\t\tedl_ip_list\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects","collectionId":"2","id":"2-9-57","method":"PUT"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Create servers","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: List of servers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects
BODY<network_objects xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
     <network_object xsi:type=\"hostNetworkObjectDTO\">
         <comment>host comment</comment>
         <name>host1</name>
         <ip>1.1.1.1</ip>
     </network_object>
     <network_object xsi:type=\"rangeNetworkObjectDTO\">
         <comment>range comment</comment>
         <name>range1</name>
         <first_ip>2.2.2.2</first_ip>
         <last_ip>2.2.2.22</last_ip>
     </network_object>
     <network_object xsi:type=\"subnetNetworkObjectDTO\">
         <comment>subnet comment</comment>
         <name>subnet1</name>
         <ip>3.3.3.3</ip>
         <netmask>255.255.255.0</netmask>
     </network_object>
     <network_object xsi:type=\"networkObjectVirtualServerDTO\">
         <comment>virtual server comment</comment>
         <uid>{e1a7722f-e92e-48f2-9087-9cb1711eb8b9}</uid>
         <device_id>12</device_id>
     </network_object>
     <network_object xsi:type=\"networkObjectGroupDTO\">
         <comment>group comment</comment>
         <name>group1</name>
         <access_allowed>true</access_allowed>
         <member>
             <id>3</id>
         </member>
        <type_on_device>edl_ip_list</type_on_device>     </network_object>
</network_objects>


Response Messages:
400: There are no items to add.
400: The application was already deleted.
400: You cannot add to application NAME because it was decommissioned.
400: Network object was already saved
400: Name cannot be empty
400: Server with NAME already exists.
400: IP is missing
400: Mask is missing
400: Invalid IP
400: Invalid mask
400: Max IP is missing
400: Min IP is missing
400: Invalid min IP
400: Invalid max IP
400: Min IP cannot be larger than max IP
400: Invalid network object type CLASS_NAME.
400: Invalid uid
400: Invalid device ID
400: Virtual server does not exist in SecureTrack
400: The virtual server already exists in SecureApp as resource NAME: VIRTUAL SERVER NAME VIRTUAL SERVER DEVICE NAME.
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Internet cannot be a member of a group.
400: Cannot save the server because the virtual server does not exist.
400: Cannot save the server because an error occurred
400: The type_on_device value is not valid
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID.
404: Virtual server was not found in SecureTrack.
503: Not connected to SecureTrack.","dataMode":"raw","folder":"2-9","rawModeData":"\n\t \n\t\t host comment\n\t\t host1\n\t\t 1.1.1.1\n\t \n\t \n\t\t range comment\n\t\t range1\n\t\t 2.2.2.2\n \t\t 2.2.2.22\n\t \n\t \n\t\t subnet comment\n\t\t subnet1\n\t\t 3.3.3.3\n\t\t 255.255.255.0\n\t \n\t \n\t\t virtual server comment\n\t\t {e1a7722f-e92e-48f2-9087-9cb1711eb8b9}\n\t\t 12\n\t \n\t \n\t\t group comment\n\t\t group1\n\t\t true\n\t\t \n\t\t\t 3\n\t\t \n\t\tedl_ip_list\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects","collectionId":"2","id":"2-9-58","method":"POST"},{"name":"Delete server","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"serverId"}],"dataMode":"params","description":"To decommission a serer use force=true.

Parameters:
applicationId: The unique identifier of the application
serverId: The unique identifier of the server
force: Force delete [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/4

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/4?force=true

Response Messages:
400: The application was already deleted.
400: You cannot delete a predefined object.
400: Cannot delete an object that is being referenced by other objects
400: Cannot delete a predefined object.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID.","folder":"2-9","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}","collectionId":"2","id":"2-9-59","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Retrieve an existing server by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"serverId"}],"description":"Parameters:
applicationId: The unique identifier of the application
serverId: The unique identifier of the server

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/3

Response Messages:
400: The application was already deleted.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID.","dataMode":"params","folder":"2-9","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}","collectionId":"2","id":"2-9-60","method":"GET"},{"headers":"Accept: application/json\n","collectionId":"2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}/members","name":"If the identified server is a group, return a list of its members. When the media type is 'text/plain' (default), print each member on a separate line.","method":"GET","id":"2-9-61","description":"Parameters:
applicationId [optional]
serverId [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/6/members

Response Messages:
400: Server with ID is not of type group
401: Access is denied
401: You do not have permissions to view this application
403: No available licenses. Ask your SecureApp administrator for assistance
404: There is no application with the specified ID
404: Server with ID was not found","folder":"2-9"},{"name":"Move server","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"},{"value":null,"type":"text","enabled":true,"key":"server_id"},{"value":null,"type":"text","enabled":true,"key":"target_application_id"}],"description":"Parameters:
application_id: The unique identifier of the application
server_id: The unique identifier of the server
target_application_id: The unique identifier of the target application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/move_server?server_id=5&target_application_id=3

Response Messages:
400: Server ID is missing.
400: Target application ID is missing.
400: You cannot move a predefined object.
400: Server with ID is already associated to application with ID.
400: Cannot move server to a different customer.
400: The application was already deleted.
400: You cannot add to application APPLICATION_NAME because it was decommissioned.
400: Group/Server cannot be moved because there is no other application to move it to.
400: Group/Server cannot be moved because it or at least one of its group members is part of these groups: GROUPS_NAME.
400: Group/Server cannot be moved because it or at least one of its group members is locked for discovery.
400: Group/Server cannot be moved because it or at least one of its group members is used in these application interfaces: APPLICATION_INTERFACE_NAME.
400: Group/Server cannot be moved because it or at least one of its group members is used in these connections with another external resource: CONNECTION_NAME
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","dataMode":"params","folder":"2-9","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/move_server","collectionId":"2","id":"2-9-62","method":"POST"},{"collectionId":"2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}/impact_analysis_csv","name":"Export Server Impact Analysis to a CSV file.","method":"GET","id":"2-9-63","description":"Parameters:
applicationId [optional]
serverId [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/6/impact_analysis_csv

Response Messages:
400: Server with ID was not found.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
404: There is no application with the specified ID.","folder":"2-9"},{"headers":"Content-Type: application/xml\n","name":"Modify unused and non predefined global services","dataMode":"raw","description":"Parameters:
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>250</id>
        <name>icmp service updated</name>
        <comment>Updated comment</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>251</id>
        <name>ip service updated</name>
        <comment>Updated comment</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>252</id>
        <name>tcp service updated</name>
        <comment>Updated comment</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>253</id>
        <name>udp service updated</name>
        <comment>Updated comment</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <id>254</id>
        <name>Service Group 1 updated</name>
        <comment>Updated comment</comment>
        <type>group</type>
        <member>
            <id>3</id>
        </member>
        <member>
            <id>4</id>
        </member>
    </service>
</services>


Response Messages:
200: Services were modified.
400: Members IDs cannot be empty.
404: Service with ID <span style=\"font-style: italic\">ID</span> was not found.
400: Service type must be either SingleServiceDTO or ServiceMemberDTO.
400: Service is new.
400: You cannot update a predefined object.
400: Name <span style=\"font-style: italic\">NAME</span> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: Invalid protocol
400: Global Service cannot be associated with an application.
400: Cannot update a global service that is being referenced by other objects.
400: Cannot update an empty global group.
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Cannot have a local member in global group.
400: Group cannot contain itself as a member.
400: Application identity cannot be a member of a group.
401: Access is denied.","folder":"2-10","rawModeData":"\n\t\n\t\t250\n\t\ticmp service updated\n\t\tUpdated comment\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\t251\n\t\tip service updated\n\t\tUpdated comment\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\t252\n\t\ttcp service updated\n\t\tUpdated comment\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t253\n\t\tudp service updated\n\t\tUpdated comment\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t254\n\t\tService Group 1 updated\n\t\tUpdated comment\n\t\tgroup\n\t\t\n\t\t\t3\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services/","collectionId":"2","id":"2-10-64","method":"PUT"},{"name":"Delete unused and non predefined global service by name","data":[{"value":null,"type":"text","enabled":true,"key":"name"}],"description":"Parameters:
name: The name of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?name=Global service

Response Messages:
200: Service was deleted.
404: Service name has not been provided.
404: There are no services with the name NAME.
400: Cannot delete ANY.
400: Cannot delete an object that is being referenced by other objects.
400: Cannot delete a predefined object.
401: Access is denied.","dataMode":"params","folder":"2-10","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services","collectionId":"2","id":"2-10-65","method":"DELETE"},{"headers":"Accept: application/json\n","collectionId":"2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services","name":"Fetches services","method":"GET","id":"2-10-66","description":"Parameters:
globals_only: get only globals [optional]
name: The name of the service [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?name=AH

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?globals_only=true

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?globals_only=true&name=AH

Response Messages:
404: There are no services with the name NAME.
401: Access is denied.","folder":"2-10"},{"headers":"Content-Type: application/xml\n","name":"Create global services","dataMode":"raw","description":"Parameters:
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>icmp service</name>
        <comment>New service</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>ip service</name>
        <comment>IPSEC Authentication Header Protocol</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>tcp service</name>
        <comment>Discard Server Protocol (TCP)</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>udp service</name>
        <comment>Discard Server Protocol (UDP)</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <name>Service Group 1</name>
        <comment>New Service group</comment>
        <type>group</type>
        <member>
            <id>1</id>
        </member>
        <member>
            <id>2</id>
        </member>
    </service>
</services>


Response Messages:
201: Service was created.
200: Services were created.
400: There are no items to add.
400: Members IDs cannot be empty.
404: Service with ID <span style=\"font-style: italic\">ID</span> was not found.
400: Invalid service type <span style=\"font-style: italic\">TYPE</span>
400: Name <span style=\"font-style: italic\">NAME</span> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: Global Service cannot be associated with an application.
400: Cannot create an empty global group.
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Cannot have a local member in global group.
400: Application identity cannot be a member of a group.
401: Access is denied.","folder":"2-10","rawModeData":"\n\t\n\t\ticmp service\n\t\tNew service\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\tip service\n\t\tIPSEC Authentication Header Protocol\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\ttcp service\n\t\tDiscard Server Protocol (TCP)\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tudp service\n\t\tDiscard Server Protocol (UDP)\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tService Group 1\n\t\tNew Service group\n\t\tgroup\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t2\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services","collectionId":"2","id":"2-10-67","method":"POST"},{"headers":"Accept: application/json\n","name":"Fetches service by ID","data":[{"value":null,"type":"text","enabled":true,"key":"serviceId"}],"description":"Parameters:
serviceId: The ID of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services/2

Response Messages:
404: Service with ID <span style=\"font-style: italic\">ID</span> was not found.
401: Access is denied.","dataMode":"params","folder":"2-10","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services/{{serviceId}}","collectionId":"2","id":"2-10-68","method":"GET"},{"name":"Delete unused and non predefined global service","data":[{"value":null,"type":"text","enabled":true,"key":"serviceId"}],"description":"Parameters:
serviceId: The ID of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services/260

Response Messages:
200: Service was deleted.
404: Global Service with ID was not found.
400: Cannot delete an object that is being referenced by other objects.
400: You cannot delete a predefined object.
401: Access is denied.","dataMode":"params","folder":"2-10","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services/{{serviceId}}","collectionId":"2","id":"2-10-69","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Retrieve existing services","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the service [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services?name=Local service

Response Messages:
400: The application was already deleted.
401: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: There are no services with the name NAME.","dataMode":"params","folder":"2-11","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services","collectionId":"2","id":"2-11-70","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Create services","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>icmp service</name>
        <comment>New service</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>ip service</name>
        <comment>IPSEC Authentication Header Protocol</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>tcp service</name>
        <comment>Discard Server Protocol (TCP)</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>udp service</name>
        <comment>Discard Server Protocol (UDP)</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <name>Service Group 1</name>
        <comment>New Service group</comment>
        <type>group</type>
        <member>
            <id>1</id>
        </member>
        <member>
            <id>2</id>
        </member>
    </service>
</services>


Response Messages:
201: Service was created.
200: Services were created.
400: There are no items to add.
400: Members IDs cannot be empty.
400: Invalid service type <span style=\"font-style: italic\">TYPE</span>
400: Name <span style=\"font-style: italic\">NAME</span> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: Cannot create an empty global group.
400: The group contains duplicate members.
400: ANY cannot be a member of a group.
400: Cannot have members from different applications.
400: Can not have application identity in group
401: Access is denied
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Service with ID <span style=\"font-style: italic\">ID</span> was not found.
404: There is no application with the specified ID.","dataMode":"raw","folder":"2-11","rawModeData":"\n\t\n\t\ticmp service\n\t\tNew service\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\tip service\n\t\tIPSEC Authentication Header Protocol\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\ttcp service\n\t\tDiscard Server Protocol (TCP)\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tudp service\n\t\tDiscard Server Protocol (UDP)\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tService Group 1\n\t\tNew Service group\n\t\tgroup\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t2\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services","collectionId":"2","id":"2-11-71","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Update services","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>250</id>
        <name>icmp service updated</name>
        <comment>Updated comment</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>251</id>
        <name>ip service updated</name>
        <comment>Updated comment</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>252</id>
        <name>tcp service updated</name>
        <comment>Updated comment</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>253</id>
        <name>udp service updated</name>
        <comment>Updated comment</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <id>254</id>
        <name>Service Group 1 updated</name>
        <comment>Updated comment</comment>
        <type>group</type>
        <member>
            <id>3</id>
        </member>
        <member>
            <id>4</id>
        </member>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <id>255</id>
        <name>Service Group 2 updated</name>
        <comment>Updated comment</comment>
        <type>group</type>
    </service>
</services>


Response Messages:
200: Services were modified.
400: Members IDs cannot be empty.
400: Service type must be either SingleServiceDTO or ServiceMemberDTO.
400: Local service must be associated with an application.
400: Service is locked for discovery.
400: Service is new.
400: Name <span style=\"font-style: italic\">NAME</span> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: The group contains duplicate members.
400: ANY cannot be a member of a group.
400: Application identity cannot be a member of a group.
401: Access is denied
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Service with ID <span style=\"font-style: italic\">ID</span> was not found.","dataMode":"raw","folder":"2-11","rawModeData":"\n\t\n\t\t250\n\t\ticmp service updated\n\t\tUpdated comment\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\t251\n\t\tip service updated\n\t\tUpdated comment\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\t252\n\t\ttcp service updated\n\t\tUpdated comment\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t253\n\t\tudp service updated\n\t\tUpdated comment\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t254\n\t\tService Group 1 updated\n\t\tUpdated comment\n\t\tgroup\n\t\t\n\t\t\t3\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n\t\n\t\t255\n\t\tService Group 2 updated\n\t\tUpdated comment\n\t\tgroup\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services","collectionId":"2","id":"2-11-72","method":"PUT"},{"name":"Delete service","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"serviceId"}],"dataMode":"params","description":"Use force=true to delete a service with decommission.

Parameters:
applicationId: The unique identifier of the application
serviceId: The unique identifier of the service
force: Force delete [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services/250

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services/250?force=true

Response Messages:
400: The application was already deleted.
400: Cannot delete an object that is being referenced by other objects.
400: Cannot delete a predefined object.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Service with ID <span style=\"font-style: italic\">SERVICE_ID</span> was not found in application with id <span style=\"font-style: italic\">APPLICATION_ID</span>","folder":"2-11","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services/{{serviceId}}","collectionId":"2","id":"2-11-73","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Retrieve an existing service by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"serviceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
serviceId: The unique identifier of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services/250

Response Messages:
400: The application was already deleted.
401: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: Service with ID was not found.","dataMode":"params","folder":"2-11","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services/{{serviceId}}","collectionId":"2","id":"2-11-74","method":"GET"},{"headers":"Accept: application/json\n","collectionId":"2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users","name":"Fetches users","method":"GET","id":"2-12-75","description":"Parameters:
name: The name of the user [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users?name=Local user 1

Response Messages:
404: There are no users with the name NAME.
401: Access is denied.","folder":"2-12"},{"headers":"Content-Type: application/xml\n","name":"Create users","dataMode":"raw","description":"Parameters:
body: List of users

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/users
BODY<users>
    <user>
        <name>Local user 1</name>
        <comment>New local user</comment>
        <ip>8.8.8.8</ip>
    </user>
    <user>
        <name>Ldap user 1</name>
        <comment>New ldap user</comment>
    </user>
    <user xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"userObjectGroupDTO\">
        <name>User group 1</name>
        <comment>New user group</comment>
        <member>
            <id>14</id>
        </member>
        <member>
            <id>15</id>
        </member>
    </user>
</users>


Response Messages:
201: User was created.
200: Users were created.
400: There are no items to add.
400: Members IDs cannot be empty.
404: User with id <span style=\"font-style: italic\">ID</span> was not found.
400: Invalid user type <span style=\"font-style: italic\">TYPE</span>
400: Name cannot be empty.
400: User with name <span style=\"font-style: italic\">NAME</span> already exists.
400: Invalid ip
401: Access is denied.","folder":"2-12","rawModeData":"\n\t\n\t\tLocal user 1\n\t\tNew local user\n\t\t8.8.8.8\n\t\n\t\n\t\tLdap user 1\n\t\tNew ldap user\n\t\n\t\n\t\tUser group 1\n\t\tNew user group\n\t\t\n\t\t\t14\n\t\t\n\t\t\n\t\t\t15\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users","collectionId":"2","id":"2-12-76","method":"POST"},{"headers":"Accept: application/json\n","name":"Fetches user by ID","data":[{"value":null,"type":"text","enabled":true,"key":"userId"}],"description":"Parameters:
userId: The ID of the user

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users/10

Response Messages:
404: User with ID <span style=\"font-style: italic\">ID</span> was not found.
401: Access is denied.","dataMode":"params","folder":"2-12","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users/{{userId}}","collectionId":"2","id":"2-12-77","method":"GET"},{"name":"Delete unused user","data":[{"value":null,"type":"text","enabled":true,"key":"userId"}],"description":"Parameters:
userId: The ID of the user

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users/10

Response Messages:
200: User was deleted.
404: User with ID <span style=\"font-style: italic\">ID</span> was not found.
400: Cannot delete an object that is being referenced by other objects.
401: Access is denied.","dataMode":"params","folder":"2-12","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users/{{userId}}","collectionId":"2","id":"2-12-78","method":"DELETE"},{"headers":"Accept: application/json\n","collectionId":"2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/compliance_violations","name":"Retrieve security policy violations from SecureTrack","method":"GET","id":"2-13-79","description":"Parameters:
applicationId [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/compliance_violations

Response Messages:
400: No valid connections found in APPLICATION.
400: Security policy compliance check is not available because a security policy has not been defined.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
503: Cannot connect to SecureTrack.
503: Timeout occurred while waiting for response from SecureTrack.
500: An error occurred in SecureTrack when running the security compliance check.","folder":"2-13"},{"headers":"Accept: application/json\n","collectionId":"2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/","name":"List all applications","method":"GET","id":"2-13-80","description":"Parameters:
userId: Applications by user ID, if not given the default is logged in user id [optional]
name: The name of the application [optional]
app_permissions: Filter applications by the given permissions (separated with commas):\napp_owner - returns applications where the user is the owner\napp_editor - returns applications where the user has been explicitly added as an editor\napp_viewer - returns applications where the user has been explicitly added as a viewer\napp_adminonly - returns applications where the user only has editor access because user has “edit all applications” permission [note: documentation needs to explain that this list does NOT include apps listed in app_editor] [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?name=App

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?userId=1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?app_permissions=app_owner,app_editor,app_viewer

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?name=App&app_permissions=app_adminonly

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications

Response Messages:
400: Invalid app_permissions value: 'appPermissions'.
401: Access is denied
401: You can't use the parameter 'userId' because you don't have 'View all applications' permission.
404: There are no applications matching your filter.
404: User with ID 'userId' was not found.","folder":"2-13"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Create new applications","dataMode":"raw","description":"Parameters:
body: List all applications

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications
BODY<applications>
     <application>
         <name>AppName</name>
         <comment>Comment</comment>
         <owner>
             <id>3</id>
         </owner>
         <editors>
             <editor>
                 <id>4</id>
             </editor>
         </editors>
         <viewers>
             <viewer>
                 <id>5</id>
             </viewer>
         </viewers>
         <customer>
             <id>24</id>
         </customer>
     </application>
</applications>


Response Messages:
400: There are no items to add.
400: Application was already saved.
400: Application name must contain at least 2 and no more than 160 characters.
400: Owner cannot be empty.
400: The specified owner does not exist.
400: The owner NAME does not have permission to access applications.
400: There is an editor without an ID or name.
400: The application owner cannot also be an editor of the application.
400: There is a viewer without an ID or name.
400: The application owner cannot also be a viewer of the application.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application.
400: Application with NAME already exists.
400: Application owner is missing.
400: Reference to owner ID is invalid.
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to customer ID is invalid.
400: You must specify the name or ID of the customer.
400: The customer has no ID or name.
400: The specified customer does not exist.
400: There is an editor without an ID or name.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no editor with the name NAME.","folder":"2-13","rawModeData":"\n\t \n\t\t AppName\n\t\t Comment\n\t\t \n\t\t\t 3\n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 4\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 5\n\t\t\t \n\t\t \n\t\t \n\t\t\t 24\n\t\t \n\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/","collectionId":"2","id":"2-13-81","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Update applications","dataMode":"raw","description":"This API can be used to delete or decommission an application.
To decommission an application, send true in decommissioned tag.

Parameters:
body: List of applications

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications
BODY<applications>
     <application>
         <id>140</id>
         <name>App1</name>
         <decommissioned>true</decommissioned>
         <owner>
             <id>4</id>
         </owner>
     </application>
     <application>
         <id>139</id>
         <name>UpdatedAppName</name>
         <comment>Updated Comment</comment>
         <owner>
             <id>4</id>
         </owner>
         <editors>
             <editor>
                 <id>3</id>
             </editor>
         </editors>
         <viewers>
             <viewer>
                 <id>5</id>
             </viewer>
         </viewers>
     </application>
</applications>


Response Messages:
400: Application ID is missing.
400: Application ID is invalid
400: The application was already deleted.
400: You must include the owner field.
400: There is an editor without an ID or name.
400: The application owner cannot also be an editor of the application.
400: There is a viewer without an ID or name.
400: The application owner cannot also be a viewer of the application.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application.
401: Access is denied
401: You do not have permissions to change the owner of application ID.
401: You do not have permissions to change the editors and a viewer of application ID.
401: You do not have permissions to decommission this application.
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.","folder":"2-13","rawModeData":"\n\t \n\t\t 140\n\t\t App1\n\t\t true\n\t\t \n\t\t\t 4\n\t\t \n\t \n\t \n\t\t 139\n\t\t UpdatedAppName\n\t\t Updated Comment\n\t\t \n\t\t\t 4\n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 3\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 5\n\t\t\t \n\t\t \n\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/","collectionId":"2","id":"2-13-82","method":"PUT"},{"name":"Delete an application","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application to delete

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1

Response Messages:
400: The application was already deleted.
400: The resources of application NAME are used in connections for other applications.
400: You cannot delete application NAME because its application interfaces are used in other applications.
400: You cannot delete application NAME because its application interfaces are used in other application packs.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
400: Application with ID ID was not found.
400: You cannot delete application NAME because there are connection changes pending a ticket in other application.","dataMode":"params","folder":"2-13","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}","collectionId":"2","id":"2-13-83","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Retrieve an existing application by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of an application to retrieve

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1

Response Messages:
400: The application was already deleted.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: Access is denied
401: You do not have permission to access application with ID
404: There is no application with the specified ID.","dataMode":"params","folder":"2-13","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}","collectionId":"2","id":"2-13-84","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Change an application","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"dataMode":"raw","description":"This API can be used to delete or decommission an application.
To decommission an application, send true in decommissioned tag.

Parameters:
applicationId: The unique identifier of an application to change
body: Application

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/139
BODY<application>
     <id>139</id>
     <name>UpdatedAppName</name>
     <comment>UpdatedComment</comment>
     <decommissioned>false</decommissioned>
     <owner>
         <id>4</id>
     </owner>
     <editors>
         <editor>
             <id>3</id>
         </editor>
     </editors>
     <viewers>
         <viewer>
             <id>5</id>
         </viewer>
     </viewers>
</application>


Response Messages:
400: The application was already deleted.
400: Application owner is missing.
400: Owner cannot be empty.
400: Reference to owner ID is invalid.
400: There is an editor without an ID or name.
400: The application owner cannot also be an editor of the application.
400: There is a viewer without an ID or name.
400: The application owner cannot also be a viewer of the application.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application.
401: Access is denied
401: You do not have permissions to change the owner of application ID.
401: You do not have permissions to change the editors and a viewer of application ID.
401: You do not have permissions to decommission this application.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","folder":"2-13","rawModeData":"\n\t 139\n\t UpdatedAppName\n\t UpdatedComment\n\t false\n\t \n\t\t 4\n\t \n\t \n\t\t \n\t\t\t 3\n\t\t \n\t \n\t \n\t\t \n\t\t\t 5\n\t\t \n\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}","collectionId":"2","id":"2-13-85","method":"PUT"},{"name":"Export application history to PDF","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"}],"description":"Parameters:
application_id: The unique identifier of the application
start_date: States starting date to fetch history since. Date format expected: yyyy-mm-dd [optional]
end_date: Get history until this date. Date format expected: yyyy-mm-dd [optional]
count: History max rows [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?start_date=2015-07-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?start_date=2015-07-18&end_date=2015-12-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?start_date=2015-07-18&count=2

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?count=2

Response Messages:
401: Access is denied.
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
400: The date format must be: yyyy-mm-dd
400: Start date must be before End date","dataMode":"params","folder":"2-13","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/history/export_pdf","collectionId":"2","id":"2-13-86","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Move applications to another customer","dataMode":"raw","description":"Parameters:
body: List of applications and customers [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/move_applications
BODY<move_applications>
     <move_application>
         <application>
            <id>1</id>
         </application>
         <customer>
             <id>2</id>
         </customer>
     </move_application>
     <move_application>
         <application>
            <id>2</id>
         </application>
         <customer>
            <name>Default</name>
         </customer>
     </move_application>
</move_applications>


Response Messages:
200: Applications were moved successfully.
400: Multi-Customer mode is not enabled.
400: You cannot move an application pack to a different customer.
400: Reference to application is invalid.
400: APPLICATION already exists in CUSTOMER.
400: You must specify the name or ID of the customer.
400: The customer has no ID or name.
400: Reference to CUSTOMER is invalid.
400: CUSTOMER is not imported to SecureApp.
400: CUSTOMER was decommissioned.
400: You must delete virtual servers from CUSTOMER before you move APPLICATION to another customer.
400: You must remove virtual servers from the INTERFACE and publish it before you move APPLICATION to another customer.
400: You cannot move APPLICATION to CUSTOMER because the connection to application pack and the application pack cannot be in the same customer.
400: You cannot move APPLICATION to a different customer because the application interface and the application pack must be in the same customer.
400: You must remove INTERFACE from APPLICATION PACK and publish it before you can move APPLICATION to another customer.
400: CONNECTION TO APPLICATION from APPLICATION must use interface from CUSTOMER.
400: Sources in CONNECTION from APPLICATION must all be from applications in the same customer.
400: Destinations in CONNECTION in APPLICATION must all be from applications in the same customer.
400: Servers in CONNECTION from APPLICATION must all be from CUSTOMER.
400: Servers in CONNECTION TO APPLICATION from APPLICATION must be from applications in the same customer.
400: Servers in CONNECTION TO APPLICATION from APPLICATION must be from CUSTOMER.
400: Application or application pack with NAME already exists in CUSTOMER.
400: There are no applications to move.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","folder":"2-13","rawModeData":"\n\t \n\t\t \n\t\t\t1\n\t\t \n\t\t \n\t\t\t 2\n\t\t \n\t \n\t \n\t\t \n\t\t\t2\n\t\t \n\t\t \n\t\t\tDefault\n\t\t \n\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/move_applications","collectionId":"2","id":"2-13-87","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve application history","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
start_date: States starting date to fetch history since. Date format expected: yyyy-mm-dd [optional]
end_date: Get history until this date. Date format expected: yyyy-mm-dd [optional]
count: History list length [optional]
start: Offset the count starting point [optional]
type: States the history type to fetch [optional]
user: The username of the user made the changes [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start_date=2015-07-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start_date=2015-07-18&end_date=2015-12-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start_date=2015-07-18&count=1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start=0&count=1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?type=SERVER

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?user=Jack

Response Messages:
400: The date format must be: yyyy-mm-dd
400: Start date must be before End date
400: Count parameter must be a number
400: Start parameter must be a number
400: Start parameter must be less than total
400: Type parameter must be either server, server_group, connection, application, application_interface, connection_interface or connection_to_application
400: User not found
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.","dataMode":"params","folder":"2-13","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/history","collectionId":"2","id":"2-13-88","method":"GET"},{"name":"Export Impact Analysis to a CSV file.","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"}],"dataMode":"params","description":"To prevent a CSV injection attack when exporting Impact Analysis to a CSV file, if a special character ( = - + @ ) appears at the beginning of any field, a single quote (') is added before the character.

Parameters:
application_id: The unique identifier of the application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/impact_analysis_csv

Response Messages:
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
404: There is no application with the specified ID.","folder":"2-13","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/impact_analysis_csv","collectionId":"2","id":"2-13-89","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Auto associate cloud servers from SecureTrack with an application","dataMode":"raw","description":"When auto-associate is enabled, user must enter key value

Parameters:
body: Auto association rule

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers/auto_association_rule
BODY<auto_association_rule>
    <key>Application</key>
    <enabled>true</enabled>
</auto_association_rule>


Response Messages:
200: Auto association rule is saved.
400: Enabled rule requires key value.
401: Access is denied
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to search for cloud servers.","folder":"2-14","rawModeData":"\n\tApplication\n\ttrue\n\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/cloud_console/servers/auto_association_rule","collectionId":"2","id":"2-14-90","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve cloud server listing from SecureTrack","data":[{"value":null,"type":"text","enabled":true,"key":"vendor"},{"value":null,"type":"text","enabled":true,"key":"search_string"}],"description":"Parameters:
customer_id: Customer ID to be filtered by. [optional]
vendor: Vendor to be filtered by.
search_string: Search text.
start: Returning matching result starting from this element in the array (0-based). [optional]
count: Total number of matching servers to return. [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers?vendor=Amazon&search_string=WebServe

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers?vendor=Amazon&search_string=\"WebServer1\"

Response Messages:
401: Access is denied
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to search for cloud servers.
400: Illegal search string.
400: Start is bigger then possible result count.
400: Start and count cannot hold negative values.
400: Vendor query param is required.
400: Vendor should be one of the following: Amazon.
400: Search string query param is required.
400: Customer with ID does not exist in SecureApp
400: Customer with ID was decommissioned.","dataMode":"params","folder":"2-14","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/cloud_console/servers/","collectionId":"2","id":"2-14-91","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Associate cloud servers from SecureTrack with an application","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"}],"description":"Parameters:
application_id: The ID of the application
body: List of device IDs and cloud server UIDs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers?application_id=87
BODY<devices_to_uids>
    <device_to_uids>
        <device_id>9</device_id>
        <uids>
            <uid>{b503916e-4468-4dc8-981b-2ec534587352}</uid>
            <uid>{0cc947a5-276f-4a4a-9d12-df5284fce609}</uid>
        </uids>
    </device_to_uids>
</devices_to_uids>


Response Messages:
201: Servers were imported to SecureApp.
401: Access is denied
400: There is no application with the specified ID.
401: No available licenses. Ask your SecureApp administrator for assistance.
400: You do not have permissions to edit this application.
400: You cannot associate servers with this application, because the application has been decommissioned.
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to add cloud servers.
403: UID does not exist in device ID.
403: Device with ID does not exist.
403: Device with ID does not exist in DOMAIN.
403: The AWS instance with UID and device ID has already been imported to application NAME. You cannot import the same instance multiple times.","dataMode":"raw","folder":"2-14","rawModeData":"\n\t\n\t\t9\n\t\t\n\t\t\t{b503916e-4468-4dc8-981b-2ec534587352}\n\t\t\t{0cc947a5-276f-4a4a-9d12-df5284fce609}\n\t\t\n\t\n\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/cloud_console/servers/","collectionId":"2","id":"2-14-92","method":"POST"},{"headers":"Content-Type: application/xml\n","name":"import customers","dataMode":"raw","description":"Parameters:
body: Customers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/customers/import
BODY<customers>
    <customer>
        <id>2</id>
    </customer>
    <customer>
        <id>3</id>
    </customer>
</customers>


Response Messages:
400: Not available in single-customer mode.
400: ID can not be empty.
400: There are some id's that doesn't exist.
401: Access is denied
503: Not connected to SecureTrack.","folder":"2-15","rawModeData":"\n\t\n\t\t2\n\t\n\t\n\t\t3\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/import","collectionId":"2","id":"2-15-93","method":"PUT"},{"headers":"Accept: application/json\n","collectionId":"2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/","name":"List all customers","method":"GET","id":"2-15-94","description":"Parameters:
name: The name of the customer [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers?name=Customer 1

Response Messages:
400: Not available in single-customer mode.
404: There are no customers with the name NAME.","folder":"2-15"},{"headers":"Accept: application/json\n","name":"Retrieve existing applications for specific domain","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"}],"description":"Parameters:
customer_id: The ID of the customer

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/2/applications

Response Messages:
400: Not available in single-customer mode.
400: Customer with id ID was not found.
401: Access is denied","dataMode":"params","folder":"2-15","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/{{customer_id}}/applications","collectionId":"2","id":"2-15-95","method":"GET"},{"headers":"Accept: application/json\n","collectionId":"2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/imported","name":"List all imported customers","method":"GET","id":"2-15-96","description":"

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/imported

Response Messages:
400: Not available in single-customer mode.","folder":"2-15"},{"headers":"Accept: application/json\n","name":"Fetches customer by ID","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"}],"description":"Parameters:
customer_id: The ID of the customer

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/1

Response Messages:
400: Not available in single-customer mode.
400: Customer with id ID was not found.","dataMode":"params","folder":"2-15","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/{{customer_id}}","collectionId":"2","id":"2-15-97","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Update a customer","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"}],"description":"Parameters:
customer_id: The ID of the customer
body: Customers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/customers/2
BODY<customer>
    <usage_mode>NOT_IMPORTED</usage_mode>
</customer>


Response Messages:
400: Not available in single-customer mode.
400: Customer with id ID was not found.
400: Can not update Default customer.
400: This customer is already not imported.
400: USAGE_MODE is not a valid state. The valid values are: USAGE_MODES
401: Access is denied
500: This customer is not imported.
400: You cannot delete this customer because there are connection changes pending a ticket in another customer.You must decommission this customer first, and then delete it.","dataMode":"raw","folder":"2-15","rawModeData":"\n\tNOT_IMPORTED\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/{{customer_id}}","collectionId":"2","id":"2-15-98","method":"PUT"},{"headers":"Accept: application/json\n","collectionId":"2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/not_imported","name":"List all non-imported customers","method":"GET","id":"2-15-99","description":"

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/not_imported

Response Messages:
400: Not available in single-customer mode.
503: Not connected to SecureTrack.","folder":"2-15"},{"collectionId":"2","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/domains/synchronize","name":"synchronize domains","method":"PUT","id":"2-16-100","description":"Retrieves all the domains lists in ST , for use by SC. If a domain was deleted in ST, then it will be removed from SC



Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/domains/synchronize

Response Messages:
500: Multi-Domain mode is disabled in SecureChange. Unable to synchronize with SecureTrack domains","folder":"2-16"},{"headers":"Accept: application/json\n","collectionId":"2","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/domains/","name":"List all domains","method":"GET","id":"2-16-101","description":"Parameters:
name: The name of the domain [optional]

Usage Example


Response Messages:
404: There are no domains with the name NAME.","folder":"2-16"},{"headers":"Accept: application/json\n","name":"Fetches domain by ID","data":[{"value":null,"type":"text","enabled":true,"key":"domainId"}],"description":"Parameters:
domainId: The ID of the domain

Usage Example


Response Messages:
400: Domain with id ID was not found.","dataMode":"params","folder":"2-16","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/domains/{{domainId}}","collectionId":"2","id":"2-16-102","method":"GET"},{"headers":"Accept: application/json\n","name":"Fetches virtual servers from SecureTrack","data":[{"value":null,"type":"text","enabled":true,"key":"ip"}],"dataMode":"params","description":"Find virtual servers matching a given IP address.
You can search for the virtual server itself of any of its members.

Parameters:
ip: ip
domainId: The unique identifier of a domain [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/external_resources/f5_virtual_servers?ip=2.2.2.2

Response Messages:
400: Invalid IP
400: Invalid Subnet
400: There is no domain with the specified ID.
401: Access is denied
503: Not connected to SecureTrack.","folder":"2-17","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/external_resources/f5_virtual_servers","collectionId":"2","id":"2-17-103","method":"GET"},{"headers":"Accept: application/json\n","collectionId":"2","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/","name":"Returns the details of the devices that you can select as a target in SecureChange","method":"GET","id":"2-18-104","description":"Parameters:
name: device name or part of a name [optional]
show_targets: show devices as targets [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/devices?name=asa&show_targets=true

Response Messages:
404: Devices not found","folder":"2-18"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Get suggested targets for a given access request","data":[{"value":null,"type":"text","enabled":true,"key":"domain_name"},{"value":null,"type":"text","enabled":true,"key":"workflow_name"}],"dataMode":"raw","description":"Returns a list of suggested targets for a given access request, based on topology calculations.

Parameters:
body [optional]
domain_name: Domain Name
workflow_name: Workflow Name

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/suggest_target?domain_name=Default&workflow_name=AR
BODY{
    \"access_request\":{
        \"users\":{
            \"user\":[
                \"Any\"
            ]
        },
        \"sources\":{
            \"source\":[
                {
                    \"@type\":\"IP\",
                    \"ip_address\":\"10.100.1.1\",
                    \"netmask\":\"255.255.255.255\",
                    \"cidr\":32
                }
            ]
        },
        \"destinations\":{
            \"destination\":[
                {
                    \"@type\":\"IP\",
                    \"ip_address\":\"10.100.20.2\",
                    \"netmask\":\"255.255.255.255\",
                    \"cidr\":32
                }
            ]
        },
        \"services\":{
            \"service\":[
                {
                    \"@type\":\"ANY\",
                }
            ]
        },
        \"action\":\"Accept\",
    }
}
OUTPUT{
    \"multi_target\": {
        \"target\": {
            \"@type\": \"Object\",
            \"object_name\": \"Device-1\",
            \"object_type\": \"firewall\",
            \"object_details\": \"10.100.40.1\",
            \"management_id\": 250,
            \"management_name\": \"Panorama/Domain1\"
        }
    }
}


Response Messages:
200: Targets returned successfully
400: User does not have permissions to domain or domain does not exist
401: Access is denied","folder":"2-18","rawModeData":"{\n\t\"access_request\":{\n\t\t\"users\":{\n\t\t\t\"user\":[\n\t\t\t\t\"Any\"\n\t\t\t]\n\t\t},\n\t\t\"sources\":{\n\t\t\t\"source\":[\n\t\t\t\t{\n\t\t\t\t\t\"@type\":\"IP\",\n\t\t\t\t\t\"ip_address\":\"10.100.1.1\",\n\t\t\t\t\t\"netmask\":\"255.255.255.255\",\n\t\t\t\t\t\"cidr\":32\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"destinations\":{\n\t\t\t\"destination\":[\n\t\t\t\t{\n\t\t\t\t\t\"@type\":\"IP\",\n\t\t\t\t\t\"ip_address\":\"10.100.20.2\",\n\t\t\t\t\t\"netmask\":\"255.255.255.255\",\n\t\t\t\t\t\"cidr\":32\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"services\":{\n\t\t\t\"service\":[\n\t\t\t\t{\n\t\t\t\t\t\"@type\":\"ANY\",\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"action\":\"Accept\",\n\t}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/suggest_target","collectionId":"2","id":"2-18-105","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Update the whole list of excluded devices in SecureChange","dataMode":"raw","description":"Parameters:
body [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded
BODY<device_ids>
    <id>1</id>
    <id>12</id>
</device_ids>

","folder":"2-18","rawModeData":"\n\t1\n\t12\n\n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/excluded","collectionId":"2","id":"2-18-106","method":"PUT"},{"headers":"Accept: application/json\n","collectionId":"2","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/excluded","name":"Returns IDs for specified list of excluded parent management devices and child firewalls in SecureChange","method":"GET","id":"2-18-107","description":"For example on this Panorama hierarchy:
DG1 - Excluded
  DG1.1
    FW1
    FW2
    FW3

Calling this API with false value will return only DG1’s id.
Calling this API with true value will return DG1, FW1, FW2, FW3 id’s.


Parameters:
show_all: When set to true - Displays the specified devices and all their child firewalls in the hierarchy, which will be excluded implicitly.
When set to false - Displays only the devices which were explicitly excluded.
Default value is false.
[optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded
OUTPUT<device_ids>
    <id>10</id>
    <id>11</id>
</device_ids>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded?show_all=false
OUTPUT<device_ids>
    <id>10</id>
    <id>11</id>
</device_ids>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded?show_all=true
OUTPUT<device_ids>
    <id>33</id>
    <id>10</id>
    <id>11</id>
    <id>35</id>
    <id>29</id>
    <id>31</id>
</device_ids>

","folder":"2-18"},{"name":"Run server decommission designer for given task","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/multi_server_decommission_request/designer

Response Messages:
400: Server decommission designer is not defined for the requested field.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a decommission request field.
401: You do not have permission to update this task. Contact your administrator for assistance.","dataMode":"params","folder":"2-19","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/multi_server_decommission_request/designer","collectionId":"2","id":"2-19-108","method":"PUT"},{"name":"Run Impact Analysis for given task","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/multi_server_decommission_request/impact_analysis

Response Messages:
400: Impact analysis is not defined for the requested field.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a decommission request field.
401: You do not have permission to update this task. Contact your administrator for assistance.","dataMode":"params","folder":"2-19","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/multi_server_decommission_request/impact_analysis","collectionId":"2","id":"2-19-109","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get impact analysis results","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Server Decommission Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/multi_server_decommission_request/261/impact_analysis

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.","dataMode":"params","folder":"2-19","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_server_decommission_request/{{fieldId}}/impact_analysis","collectionId":"2","id":"2-19-110","method":"GET"},{"name":"Run Verifier for given task","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/multi_server_decommission_request/verifier

Response Messages:
400: Verifier is not defined for the requested field.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a decommission request field.
401: You do not have permission to update this task. Contact your administrator for assistance.","dataMode":"params","folder":"2-19","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/multi_server_decommission_request/verifier","collectionId":"2","id":"2-19-111","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get verifier results","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Server Decommission Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/multi_server_decommission_request/261/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.","dataMode":"params","folder":"2-19","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_server_decommission_request/{{fieldId}}/verifier","collectionId":"2","id":"2-19-112","method":"GET"},{"headers":"Accept: application/json\n","name":"Get server decommission designer results","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"dataMode":"params","description":"Use this API to retrieve designer results generated in R17-1 and earlier.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Server Decommission Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/multi_server_decommission_request/261/designer

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.","folder":"2-19","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_server_decommission_request/{{fieldId}}/designer","collectionId":"2","id":"2-19-113","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Modify the SecureTrack connection settings and test the connection status","dataMode":"raw","description":"Parameters:
testOnly: Test the connection status using the specified settings. The new settings are not saved. The default value is false [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/integration_with_secureTrack
BODY    <secureTrack_settings>
        <host xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"remoteHost\">
            <IP_or_hostname>192.168.11.1</IP_or_hostname>
            <user_name>admin</user_name>
        </host>
        <show_link_to_secureTrack>false</show_link_to_secureTrack>
        <check_connection_interval>30</check_connection_interval>
        <internal_IP_of_secureChange_server>192.168.2.2</internal_IP_of_secureChange_server>
    </secureTrack_settings>


Response Messages:
400: Invalid host name or IP address.
400: show_link_to_secureTrack is invalid. It must be 'true', 'false' or empty.","folder":"2-20","rawModeData":"\t\n\t\t \n\t\t\t192.168.11.1\n\t\t\tadmin\n\t\t\n\t\tfalse\n\t\t30\n\t\t192.168.2.2\n\t","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/integration_with_secureTrack/","collectionId":"2","id":"2-20-114","method":"PUT"},{"headers":"Accept: application/json\n","collectionId":"2","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/integration_with_secureTrack/","name":"Retrieve the SecureTrack connection settings and status","method":"GET","id":"2-20-115","description":"

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/integration_with_secureTrack?testOnly=false
","folder":"2-20"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Import user from LDAP","dataMode":"raw","description":"Parameters:
body: partyDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/users
BODY<user xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"user\">
    <name>x</name>
    <origin_type>LDAP</origin_type>
        <ldap_configuration>
            <id>1</id>
        </ldap_configuration>
</user>


Response Messages:
401: Access is denied.
400: Name is missing.
400: Origin is missing.
400: User {login_name} already exists, with ID (id} and name {name}.
400: User {login_name} not found in LDAP.
400: Creating a user via REST API is available only if origin is LDAP.
400: Creating a user via REST API is available only if type is User.
400: Ldap configuration with ID {id} not found.","folder":"2-21","rawModeData":"\n\tx\n\tLDAP\n\t\t\n\t\t\t1\n\t\t\n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/","collectionId":"2","id":"2-21-116","method":"POST"},{"headers":"Accept: application/json\n","collectionId":"2","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/","name":"Return the list of users","method":"GET","id":"2-21-117","description":"user_name: case insensitive, search mode: contains text
exact_name: when set to true, user_name search mode is case sensitive and exact text
email: case insentitive, search mode: exact match
Logical OR between user_name and email.

Parameters:
showIndirectRelation: Members that belong to the selected group only indirectly [optional]
user_name: The user's login name [optional]
email: The user's email [optional]
exact_name: Search user_name as exact match [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/users?email=bob@tufin.com&user_name=bob&exact_name=true
","folder":"2-21"},{"headers":"Accept: application/json\n","name":"Return the specified user","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
id: The user's ID
showIndirectRelation: Members that belong to the selected group only indirectly [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/users/5

Response Messages:
400: User or group was not found.","dataMode":"params","folder":"2-21","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/{{id}}","collectionId":"2","id":"2-21-118","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Reject a ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
id: The ID of the ticket as shown in SecureChange
handler_id: The user id, when logged in user is rejecting on behalf [optional]
body: Reject comment

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/reject?handler_id=5
BODY<reject_comment>
    <comment>rejected</comment>
</reject_comment>


Response Messages:
400: Ticket status <STATUS> is incorrect to perform this action
400: User <NAME> has no permissions to perform this action
400: Comment cannot be empty
401: User is not permitted to reject this ticket on behalf another user
401: You do not have permission to access ticket <ID>
401: On behalf user do not have permission to access ticket <ID>
401: Access is denied.
404: There is no ticket with ID <ID>.
404: There is no handler (User) with ID <ID>.","dataMode":"raw","folder":"2-22","rawModeData":"\n\trejected\n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/reject","collectionId":"2","id":"2-22-119","method":"PUT"},{"name":"Map rules to ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Maps the rules from the ticket to the relevant rules in SecureTrack.
Adds record set entries to the relevant rules metadata.
Link to history is found in the returned location header.
Applicable only for closed tickets in the following workflows: Access Request, Access Request and Modify Group, and Clone Server Policy.
Use handler_id for running on behalf of another user.
To get handler_id, use the System Users API.

Parameters:
id: The ID of the ticket as shown in SecureChange
handler_id: Run API on behalf of defined user id [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/map_rules

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/map_rules?handler_id=5

Response Messages:
201: Started asynchronous mapping of rules to ticket ID <ID>. Mapping status is displayed in ticket history.
400: Ticket's workflow type does not support this operation
401: Access is denied.
401: You do not have permission to access ticket <ID>
401: On behalf user do not have permission to access ticket <ID>
404: There is no ticket with ID <ID>.
404: There is no handler (User) with ID <ID>.
412: Ticket is not in closed status","folder":"2-22","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/map_rules","collectionId":"2","id":"2-22-120","method":"POST"},{"headers":"Content-Type: application/xml\n","name":"Reassigns the specified ticket task to the specified user.","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"assigneeId"}],"dataMode":"raw","description":"Values can only be updated for the current step.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
assigneeId: The assignee ID
body: ReassignTaskCommentDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/reassign/4
BODY<reassign_task_comment>
    <comment>Please complete the AR</comment>
</reassign_task_comment>


Response Messages:
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Task <NAME> is no longer active
404: There is no ticket with ID.
404: No entity found for query","folder":"2-22","rawModeData":"\n\tPlease complete the AR\n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/reassign/{{assigneeId}}","collectionId":"2","id":"2-22-121","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Confirm the request","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
id: Ticket ID
requester_id: The user of the ticket's requester, when logged in user is confirm on behalf [optional]
body: Confirm comment

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/confirm?requester_id=5
BODY<confirm_comment>
    <comment>confirmed</comment>
</confirm_comment>


Response Messages:
400: User is trying to confirm a ticket that belongs to another user
400: User is not permitted to confirm this ticket on behalf another user
400: The user can not confirm the ticket, because he is not in the domain of the ticket
401: Access is denied.
404: There is no ticket with ID .","dataMode":"raw","folder":"2-22","rawModeData":"\n\tconfirmed\n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/confirm","collectionId":"2","id":"2-22-122","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Change the requester of the specified ticket task to the specified user.","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"assigneeId"}],"description":"Parameters:
id: Ticket ID
assigneeId: The assignee ID
body: CommentDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/change_requester/4
BODY<comment>
    <comment>user was deleted moving tickets to Bob</comment>
</comment>


Response Messages:
400: The change requester comment must be set in order to change the requester the ticket.
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
404: There is no ticket with ID.
404: There is no requester (User) with ID.","dataMode":"raw","folder":"2-22","rawModeData":"\n\tuser was deleted moving tickets to Bob\n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/change_requester/{{assigneeId}}","collectionId":"2","id":"2-22-123","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Returns the specified ticket to the specified step","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"toStepId"}],"dataMode":"raw","description":"Values can only be updated for the current step.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
toStepId: To which step we the ticket will return
body: RedoCommentDto

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/redo/1
BODY<redo_step_comment>
    <comment>please fix source </comment>
</redo_step_comment>


Response Messages:
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Task <NAME> is no longer active
401: User has no permissions to redo ticket steps.
404: There is no ticket with ID.
404: No entity found for query","folder":"2-22","rawModeData":"\n\tplease fix source \n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/redo/{{toStepId}}","collectionId":"2","id":"2-22-124","method":"PUT"},{"headers":"Accept: application/json\n","name":"Returns the history of the specified ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
id: Ticket ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/history

Response Messages:
401: User has no permissions to view ticket history
404: You do not have permission to view this task. Contact your administrator for assistance.
404: There is no ticket with ID.","dataMode":"params","folder":"2-22","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/history","collectionId":"2","id":"2-22-125","method":"GET"},{"headers":"Accept: application/json\n","name":"Cancel a ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
id: The ID of the ticket as shown in SecureChange
requester_id: The user of the ticket's requester, when logged in user is canceling on behalf [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/cancel?requester_id=5

Response Messages:
401: Access is denied.
404: Ticket is already closed
404: Ticket ID was not found","dataMode":"params","folder":"2-22","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/cancel","collectionId":"2","id":"2-22-126","method":"PUT"},{"headers":"Accept: application/json\n","name":"Returns the details of a the fields","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"params","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
taskId: The ID number of the task as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.
404: Task with ID was not found in Stage ID in ticket ID .","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields","collectionId":"2","id":"2-23-127","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Change multiple fields within a task of a ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"raw","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both object_UID and object_name are defined, object_UID takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldListDTO
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/2/tasks/4/fields
BODY<fields>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_network_object\">
         <id>7885</id>
         <name>n_obj</name>
         <network_object type=\"Object\">
             <object_name>Host_10.1.1.1</object_name>
             <management_name>cp239</management_name>
         </network_object>
         <network_object type=\"Object\">
             <object_UID>{55908141-c341-4990-9cc6-a3fd2dfb49e1}</object_UID>
             <management_id>2</management_id>
         </network_object>
         <network_object type=\"DNS\">
             <host_name>tufin.com</host_name>
         </network_object>
     <field>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_service\">
         <id>7887</id>
         <name>service</name>
         <service type=\"PROTOCOL\">
             <protocol>TCP</protocol>
             <port>80</port>
         </service>
         <service type=\"Object\">
             <object_name>AOL</object_name>
             <management_name>cp239</management_name>
         </service>
     </field>
</fields>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields
BODY{
    \"fields\": {
        \"field\": {
            \"@xsi.type\": \"rule_modification_field\",
            \"id\": 71,
            \"name\": \"Fire Wall Rule\",
            \"read_only\": false,
            \"devices\": {
                \"device\": {
                    \"revision_id\": 4,
                    \"management_name\": \"Panorama/DG_1\",
                    \"management_id\": 4,
                    \"management_ip\": \"10.100.111.120\",
                    \"revision_number\": 1,
                    \"number_of_rules\": 1,
                    \"bindings\": {
                        \"binding\": {
                            \"binding_uid\": \"{00-FACED0-00}\",
                            \"binding\": {
                                \"@xsi.type\": \"policy__binding\",
                                \"policy_name\": \"Standard\"
                            },
                            \"rules\": {
                                \"rule\": {
                                    \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                    \"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",
                                    \"name\": \"Application test\",
                                    \"is_disabled\": false,
                                    \"ruleNumber\": 13,
                                    \"from_zone\": \"any\",
                                    \"to_zone\": \"any\",
                                    \"sourceNetworks\": {
                                        \"@xsi.type\": \"host_network_object\",
                                        \"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",
                                        \"name\": \"H_5.3.2.5\",
                                        \"display_name\": \"H_5.3.2.5\",
                                        \"class_name\": \"host_plain\",
                                        \"origin\": \"DEVICE\",
                                        \"global\": false,
                                        \"implicit\": false,
                                        \"shared\": false,
                                        \"comment\": \"comment\",
                                        \"id\": \"5df1f2a5e9023c311ae4a01a\",
                                        \"version_id\": 4,
                                        \"device_type\": \"PaloAltoNetworks\",
                                        \"ip_type\": \"IPV4\",
                                        \"referenced\": \"UNKNOWN\",
                                        \"installable_target\": false,
                                        \"ip\": \"5.3.2.5\",
                                        \"subnet_mask\": \"255.255.255.255\"
                                    },
                                    \"destinationNetworks\": {
                                        \"@xsi.type\": \"host_network_object\",
                                        \"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",
                                        \"name\": \"22.22.2.2\",
                                        \"display_name\": \"22.22.2.2\",
                                        \"class_name\": \"host_plain\",
                                        \"origin\": \"DEVICE\",
                                        \"global\": false,
                                        \"implicit\": false,
                                        \"shared\": false,
                                        \"comment\": \"\",
                                        \"id\": \"5df1f2a5e9023c311ae4a016\",
                                        \"version_id\": 4,
                                        \"device_type\": \"PaloAltoNetworks\",
                                        \"ip_type\": \"IPV4\",
                                        \"referenced\": \"UNKNOWN\",
                                        \"installable_target\": false,
                                        \"ip\": \"22.22.2.2\",
                                        \"subnet_mask\": \"255.255.255.255\"
                                    },
                                    \"destinationServices\": {
                                        \"@xsi.type\": \"transport_service\",
                                        \"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",
                                        \"name\": \"TCP82\",
                                        \"display_name\": \"TCP82\",
                                        \"class_name\": \"tcp_service\",
                                        \"origin\": \"DEVICE\",
                                        \"global\": false,
                                        \"implicit\": false,
                                        \"shared\": false,
                                        \"comment\": \"TCP82\",
                                        \"id\": \"5df1f2a5e9023c311ae4a018\",
                                        \"version_id\": 4,
                                        \"referenced\": \"UNKNOWN\",
                                        \"type_on_device\": \"\",
                                        \"negate\": false,
                                        \"match_for_any\": false,
                                        \"timeout\": 0,
                                        \"protocol\": 6,
                                        \"min_port\": 82,
                                        \"max_port\": 82
                                    },
                                    \"applications\": {
                                        \"@xsi.type\": \"single_application\",
                                        \"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",
                                        \"name\": \"web-browsing\",
                                        \"display_name\": \"web-browsing\",
                                        \"class_name\": \"application_object\",
                                        \"origin\": \"DEVICE_PREDEFINED\",
                                        \"global\": true,
                                        \"implicit\": false,
                                        \"shared\": false,
                                        \"comment\": \"\",
                                        \"service\": [
                                            {
                                                \"@xsi.type\": \"transport_service\",
                                                \"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",
                                                \"name\": \"st_implicit_app_web-browsing\",
                                                \"display_name\": \"st_implicit_app_web-browsing\",
                                                \"class_name\": \"tcp_service\",
                                                \"origin\": \"DEVICE\",
                                                \"global\": false,
                                                \"implicit\": true,
                                                \"shared\": false,
                                                \"comment\": \"\",
                                                \"id\": \"5df1f2a5e9023c311ae4a014\",
                                                \"version_id\": 4,
                                                \"referenced\": \"UNKNOWN\",
                                                \"type_on_device\": \"\",
                                                \"negate\": false,
                                                \"match_for_any\": false,
                                                \"timeout\": 0,
                                                \"protocol\": 6,
                                                \"min_port\": 80,
                                                \"max_port\": 80
                                            }
                                        ]
                                    },
                                    \"action\": \"ACCEPT\",
                                    \"additional_parameters\": \"\",
                                    \"options\": {
                                        \"option\": \"LOG_SESSION\"
                                    },
                                    \"rule_location\": \"DG_1\",
                                    \"users\": {
                                        \"user\": [
                                            {
                                                \"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",
                                                \"name\": \"Any\",
                                                \"class_name\": \"any_object\",
                                                \"displayName\": \"Any\"
                                            }
                                        ]
                                    },
                                    \"track\": {
                                        \"track_level\": \"LOG\"
                                    },
                                    \"install_ons\": \"\",
                                    \"communities\": \"\",
                                    \"times\": \"\",
                                    \"rule_metadata\": {
                                        \"permissiveness_level\": \"LOW\",
                                        \"violations\": \"\",
                                        \"last_hit\": \"No hits\",
                                        \"shadowed_status\": \"FALSE\",
                                        \"ticket_ids\": \"\",
                                        \"business_owners\": \"\",
                                        \"expirations\": \"\",
                                        \"applications\": \"\",
                                        \"last_modified\": \"Today\"
                                    }
                                }
                            }
                        }
                    }
                }
            },
            \"rule_modifications\": {
                \"rule_modification\": {
                    \"@xsi.type\": \"modify_rule_modification\",
                    \"id\": 10,
                    \"rule_key\": {
                        \"device_id\": 4,
                        \"binding_uid\": \"{00-FACED0-00}\",
                        \"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"
                    },
                    \"source_modifications\": {
                        \"id\": 20,
                        \"network_object_cell_modifications\": {
                            \"network_object_cell_modification\": [
                                {
                                    \"id\": 69,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 65,
                                        \"uid\": \"9b9062a0-228a-4543-bbd4-9fda5c76573b\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"new\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                \"id\": 65,
                                                \"name\": \"My New Host\",
                                                \"comment\": \"some comment\",
                                                \"ip\": \"192.168.0.10\",
                                                \"netmask\": \"255.255.255.255\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 68,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 64,
                                        \"uid\": \"986c68ab-b5b5-478d-9300-bc0cacc06dfe\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"new\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                \"id\": 64,
                                                \"name\": \"My New Address Ragne\",
                                                \"comment\": \"some comment\",
                                                \"min_ip\": \"192.168.0.1\",
                                                \"max_ip\": \"192.168.0.254\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 70,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 68,
                                        \"uid\": \"1073dad5-4dc9-4392-8b42-f32de2937657\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"new\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                \"id\": 68,
                                                \"name\": \"My New Network\",
                                                \"comment\": \"some comment\",
                                                \"ip\": \"192.168.0.0\",
                                                \"netmask\": \"255.255.255.0\"
                                            }
                                        ]
                                    }
                                }
                            ]
                        }
                    },
                    \"destination_modifications\": {
                        \"id\": 19,
                        \"network_object_cell_modifications\": {
                            \"network_object_cell_modification\": [
                                {
                                    \"id\": 66,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 67,
                                        \"uid\": \"e52c07fc-dffb-4c77-a656-40d1b1322e77\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"existing\",
                                            \"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                \"id\": 67,
                                                \"name\": \"Range-Test\",
                                                \"comment\": \"\",
                                                \"min_ip\": \"1.1.2.0\",
                                                \"max_ip\": \"1.1.2.55\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 67,
                                    \"action\": \"REMOVE\",
                                    \"device_network_object\": {
                                        \"id\": 66,
                                        \"uid\": \"fa681c9b-8c4f-449d-9b31-108a399902f5\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"existing\",
                                            \"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                \"id\": 66,
                                                \"name\": \"22.22.2.2\",
                                                \"comment\": \"\",
                                                \"ip\": \"22.22.2.2\",
                                                \"netmask\": \"255.255.255.255\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 65,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 70,
                                        \"uid\": \"2b8eaa1a-f4ea-4c39-b89e-361af89a308e\",
                                        \"device_id\": 2,
                                        \"status\": {
                                            \"@xsi.type\": \"existing\",
                                            \"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                \"id\": 70,
                                                \"name\": \"Net_10.108.151.0\",
                                                \"comment\": \"\",
                                                \"ip\": \"10.108.151.0\",
                                                \"netmask\": \"255.255.255.0\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 64,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 69,
                                        \"uid\": \"88efeaad-cfb4-41c4-b14c-fff104c24e52\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"existing\",
                                            \"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                \"id\": 69,
                                                \"name\": \"Host_10.10.10.10\",
                                                \"comment\": \"\",
                                                \"ip\": \"10.10.10.10\",
                                                \"netmask\": \"255.255.255.255\"
                                            }
                                        ]
                                    }
                                }
                            ]
                        }
                    }
                }
            },
            \"designer_result\": {
                \"status\": \"not run\"
            }
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket step does not exist, or is not the current step
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: The new network object (<name>): device ID (<id>) does not match the rule key device ID (<id>). The device IDs must be the same.
400: Device ID is required for a new device network object
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <name>
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <st_uid>
400: <cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty.
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (Device ID is required for an existing device network object)
400: Invalid value for field: <FIELD_NAME> (ST UID is required for an existing device network object
400: Invalid value for field: <FIELD_NAME> (Network Object with device ID <DEVICE_ID> and ST UID <ST_UID> is not available for the action specified. Check the Knowledge Center or API Implementation Notes for more information
400: Status is required for a device network object","folder":"2-23","rawModeData":"{\n\t\"fields\": {\n\t\t\"field\": {\n\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\"id\": 71,\n\t\t\t\"name\": \"Fire Wall Rule\",\n\t\t\t\"read_only\": false,\n\t\t\t\"devices\": {\n\t\t\t\t\"device\": {\n\t\t\t\t\t\"revision_id\": 4,\n\t\t\t\t\t\"management_name\": \"Panorama/DG_1\",\n\t\t\t\t\t\"management_id\": 4,\n\t\t\t\t\t\"management_ip\": \"10.100.111.120\",\n\t\t\t\t\t\"revision_number\": 1,\n\t\t\t\t\t\"number_of_rules\": 1,\n\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\"policy_name\": \"Standard\"\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"Application test\",\n\t\t\t\t\t\t\t\t\t\"is_disabled\": false,\n\t\t\t\t\t\t\t\t\t\"ruleNumber\": 13,\n\t\t\t\t\t\t\t\t\t\"from_zone\": \"any\",\n\t\t\t\t\t\t\t\t\t\"to_zone\": \"any\",\n\t\t\t\t\t\t\t\t\t\"sourceNetworks\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\"display_name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"comment\",\n\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a01a\",\n\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\t\"ip\": \"5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"destinationNetworks\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\"display_name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a016\",\n\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"destinationServices\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\"display_name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a018\",\n\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\"min_port\": 82,\n\t\t\t\t\t\t\t\t\t\t\"max_port\": 82\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"applications\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"single_application\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\"display_name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\"class_name\": \"application_object\",\n\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE_PREDEFINED\",\n\t\t\t\t\t\t\t\t\t\t\"global\": true,\n\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"service\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\"implicit\": true,\n\t\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a014\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\t\t\"min_port\": 80,\n\t\t\t\t\t\t\t\t\t\t\t\t\"max_port\": 80\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"action\": \"ACCEPT\",\n\t\t\t\t\t\t\t\t\t\"additional_parameters\": \"\",\n\t\t\t\t\t\t\t\t\t\"options\": {\n\t\t\t\t\t\t\t\t\t\t\"option\": \"LOG_SESSION\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"rule_location\": \"DG_1\",\n\t\t\t\t\t\t\t\t\t\"users\": {\n\t\t\t\t\t\t\t\t\t\t\"user\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Any\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"any_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"displayName\": \"Any\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"track\": {\n\t\t\t\t\t\t\t\t\t\t\"track_level\": \"LOG\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"install_ons\": \"\",\n\t\t\t\t\t\t\t\t\t\"communities\": \"\",\n\t\t\t\t\t\t\t\t\t\"times\": \"\",\n\t\t\t\t\t\t\t\t\t\"rule_metadata\": {\n\t\t\t\t\t\t\t\t\t\t\"permissiveness_level\": \"LOW\",\n\t\t\t\t\t\t\t\t\t\t\"violations\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"last_hit\": \"No hits\",\n\t\t\t\t\t\t\t\t\t\t\"shadowed_status\": \"FALSE\",\n\t\t\t\t\t\t\t\t\t\t\"ticket_ids\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"business_owners\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"expirations\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"applications\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"last_modified\": \"Today\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"rule_modifications\": {\n\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\"id\": 10,\n\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"\n\t\t\t\t\t},\n\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\"id\": 20,\n\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 69,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 65,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"9b9062a0-228a-4543-bbd4-9fda5c76573b\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 65,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Host\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 68,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 64,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"986c68ab-b5b5-478d-9300-bc0cacc06dfe\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 64,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Address Ragne\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"192.168.0.1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"192.168.0.254\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 70,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 68,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"1073dad5-4dc9-4392-8b42-f32de2937657\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 68,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Network\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t]\n\t\t\t\t\t\t}\n\t\t\t\t\t},\n\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\"id\": 19,\n\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 66,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 67,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"e52c07fc-dffb-4c77-a656-40d1b1322e77\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 67,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Range-Test\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"1.1.2.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"1.1.2.55\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 67,\n\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 66,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"fa681c9b-8c4f-449d-9b31-108a399902f5\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 66,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 65,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 70,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"2b8eaa1a-f4ea-4c39-b89e-361af89a308e\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 2,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 70,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Net_10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 64,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 69,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"88efeaad-cfb4-41c4-b14c-fff104c24e52\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 69,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host_10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t]\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"designer_result\": {\n\t\t\t\t\"status\": \"not run\"\n\t\t\t}\n\t\t}\n\t}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields","collectionId":"2","id":"2-23-128","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get commands for device from designer results of a specific field id","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"deviceId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
deviceId: Device ID
fieldId: Field ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/designer/device/136/commands

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: Specified field, id: <ID> , name: <NAME>, cannot contain designer result
404: Designer results were not found in the access request.
404: Device with ID <ID> was not found in Designer result.
404: Device with ID <ID> does not support Commands feature.","dataMode":"params","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/designer/device/{{deviceId}}/commands","collectionId":"2","id":"2-23-129","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Change the ticket properties","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"raw","description":"Change the ticket properties listed in the TicketPropertiesDTO.
When specifying the notification_group property you must use the ID of the group or leave the ID empty to remove the group.

Parameters:
body: ticketPropertiesDTO
id: The ID number of the ticket as shown in SecureChange

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/ticket_properties
BODY<ticket_properties>
    <notification_group>
        <id>10</id>
    </notification_group>
</ticket_properties>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/ticket_properties
BODY<ticket_properties>
    <notification_group>
        <id/>
    </notification_group>
</ticket_properties>


Response Messages:
400: Notification Group <ID> is a user and not a user group
400: Notification Group <ID> exceeds the configured maximum allowed number of users for notifications
400: <ID> (“Any User”) is not allowed as a Notification Group
400: Notification Group <ID> does not have permission of 'Group members can perform actions on requests submitted by other members'
400: Notification Group <ID> is not a member in the first step of the workflow
400: Notification Group is not enabled in this workflow
401: You do not have permission to change the Notification Group
404: There is no group with ID <ID>.
404: There is no ticket with ID <ID>.","folder":"2-23","rawModeData":"\n\t\n\t\t\n\t\n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/ticket_properties","collectionId":"2","id":"2-23-130","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Change a task of a ticket at the current step","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"raw","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both object_UID and object_name are defined, object_UID takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: ticketTaskDTO
id: Ticket ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4
BODY<task>
    <status>DONE</status>
    <fields/>
</task>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/
BODY{
    \"task\": {
        \"id\": 4,
        \"assignee_id\": 4,
        \"assignee\": \"a\",
        \"status\": \"ASSIGNED\",
        \"fields\": {
            \"field\": {
                \"@xsi.type\": \"rule_modification_field\",
                \"id\": 71,
                \"name\": \"Fire Wall Rule\",
                \"read_only\": false,
                \"devices\": {
                    \"device\": {
                        \"revision_id\": 4,
                        \"management_name\": \"Panorama/DG_1\",
                        \"management_id\": 4,
                        \"management_ip\": \"10.100.111.120\",
                        \"revision_number\": 1,
                        \"number_of_rules\": 1,
                        \"bindings\": {
                            \"binding\": {
                                \"binding_uid\": \"{00-FACED0-00}\",
                                \"binding\": {
                                    \"@xsi.type\": \"policy__binding\",
                                    \"policy_name\": \"Standard\"
                                },
                                \"rules\": {
                                    \"rule\": {
                                        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                        \"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",
                                        \"name\": \"Application test\",
                                        \"is_disabled\": false,
                                        \"ruleNumber\": 13,
                                        \"from_zone\": \"any\",
                                        \"to_zone\": \"any\",
                                        \"sourceNetworks\": {
                                            \"@xsi.type\": \"host_network_object\",
                                            \"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",
                                            \"name\": \"H_5.3.2.5\",
                                            \"display_name\": \"H_5.3.2.5\",
                                            \"class_name\": \"host_plain\",
                                            \"origin\": \"DEVICE\",
                                            \"global\": false,
                                            \"implicit\": false,
                                            \"shared\": false,
                                            \"comment\": \"comment\",
                                            \"id\": \"5df1f2a5e9023c311ae4a01a\",
                                            \"version_id\": 4,
                                            \"device_type\": \"PaloAltoNetworks\",
                                            \"ip_type\": \"IPV4\",
                                            \"referenced\": \"UNKNOWN\",
                                            \"installable_target\": false,
                                            \"ip\": \"5.3.2.5\",
                                            \"subnet_mask\": \"255.255.255.255\"
                                        },
                                        \"destinationNetworks\": {
                                            \"@xsi.type\": \"host_network_object\",
                                            \"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",
                                            \"name\": \"22.22.2.2\",
                                            \"display_name\": \"22.22.2.2\",
                                            \"class_name\": \"host_plain\",
                                            \"origin\": \"DEVICE\",
                                            \"global\": false,
                                            \"implicit\": false,
                                            \"shared\": false,
                                            \"comment\": \"\",
                                            \"id\": \"5df1f2a5e9023c311ae4a016\",
                                            \"version_id\": 4,
                                            \"device_type\": \"PaloAltoNetworks\",
                                            \"ip_type\": \"IPV4\",
                                            \"referenced\": \"UNKNOWN\",
                                            \"installable_target\": false,
                                            \"ip\": \"22.22.2.2\",
                                            \"subnet_mask\": \"255.255.255.255\"
                                        },
                                        \"destinationServices\": {
                                            \"@xsi.type\": \"transport_service\",
                                            \"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",
                                            \"name\": \"TCP82\",
                                            \"display_name\": \"TCP82\",
                                            \"class_name\": \"tcp_service\",
                                            \"origin\": \"DEVICE\",
                                            \"global\": false,
                                            \"implicit\": false,
                                            \"shared\": false,
                                            \"comment\": \"TCP82\",
                                            \"id\": \"5df1f2a5e9023c311ae4a018\",
                                            \"version_id\": 4,
                                            \"referenced\": \"UNKNOWN\",
                                            \"type_on_device\": \"\",
                                            \"negate\": false,
                                            \"match_for_any\": false,
                                            \"timeout\": 0,
                                            \"protocol\": 6,
                                            \"min_port\": 82,
                                            \"max_port\": 82
                                        },
                                        \"applications\": {
                                            \"@xsi.type\": \"single_application\",
                                            \"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",
                                            \"name\": \"web-browsing\",
                                            \"display_name\": \"web-browsing\",
                                            \"class_name\": \"application_object\",
                                            \"origin\": \"DEVICE_PREDEFINED\",
                                            \"global\": true,
                                            \"implicit\": false,
                                            \"shared\": false,
                                            \"comment\": \"\",
                                            \"service\": [
                                                {
                                                    \"@xsi.type\": \"transport_service\",
                                                    \"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",
                                                    \"name\": \"st_implicit_app_web-browsing\",
                                                    \"display_name\": \"st_implicit_app_web-browsing\",
                                                    \"class_name\": \"tcp_service\",
                                                    \"origin\": \"DEVICE\",
                                                    \"global\": false,
                                                    \"implicit\": true,
                                                    \"shared\": false,
                                                    \"comment\": \"\",
                                                    \"id\": \"5df1f2a5e9023c311ae4a014\",
                                                    \"version_id\": 4,
                                                    \"referenced\": \"UNKNOWN\",
                                                    \"type_on_device\": \"\",
                                                    \"negate\": false,
                                                    \"match_for_any\": false,
                                                    \"timeout\": 0,
                                                    \"protocol\": 6,
                                                    \"min_port\": 80,
                                                    \"max_port\": 80
                                                }
                                            ]
                                        },
                                        \"action\": \"ACCEPT\",
                                        \"additional_parameters\": \"\",
                                        \"options\": {
                                            \"option\": \"LOG_SESSION\"
                                        },
                                        \"rule_location\": \"DG_1\",
                                        \"users\": {
                                            \"user\": [
                                                {
                                                    \"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",
                                                    \"name\": \"Any\",
                                                    \"class_name\": \"any_object\",
                                                    \"displayName\": \"Any\"
                                                }
                                            ]
                                        },
                                        \"track\": {
                                            \"track_level\": \"LOG\"
                                        },
                                        \"install_ons\": \"\",
                                        \"communities\": \"\",
                                        \"times\": \"\",
                                        \"rule_metadata\": {
                                            \"permissiveness_level\": \"LOW\",
                                            \"violations\": \"\",
                                            \"last_hit\": \"No hits\",
                                            \"shadowed_status\": \"FALSE\",
                                            \"ticket_ids\": \"\",
                                            \"business_owners\": \"\",
                                            \"expirations\": \"\",
                                            \"applications\": \"\",
                                            \"last_modified\": \"Today\"
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                \"rule_modifications\": {
                    \"rule_modification\": {
                        \"@xsi.type\": \"modify_rule_modification\",
                        \"id\": 13,
                        \"rule_key\": {
                            \"device_id\": 4,
                            \"binding_uid\": \"{00-FACED0-00}\",
                            \"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"
                        },
                        \"source_modifications\": {
                            \"id\": 26,
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"id\": 89,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 88,
                                            \"uid\": \"e7e4ac52-2fe4-49f7-8071-9638817a7434\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"id\": 88,
                                                    \"name\": \"My New Host\",
                                                    \"comment\": \"some comment\",
                                                    \"ip\": \"192.168.0.10\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 91,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 89,
                                            \"uid\": \"13556e3e-1f93-4f95-939c-428a58001615\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                    \"id\": 89,
                                                    \"name\": \"My New Address Ragne\",
                                                    \"comment\": \"some comment\",
                                                    \"min_ip\": \"192.168.0.1\",
                                                    \"max_ip\": \"192.168.0.254\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 90,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 87,
                                            \"uid\": \"1ecb9679-4da4-4fc5-9382-00f5fa455295\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                    \"id\": 87,
                                                    \"name\": \"My New Network\",
                                                    \"comment\": \"some comment\",
                                                    \"ip\": \"192.168.0.0\",
                                                    \"netmask\": \"255.255.255.0\"
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        },
                        \"destination_modifications\": {
                            \"id\": 25,
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"id\": 88,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 91,
                                            \"uid\": \"50f35caf-3f13-4961-9ccd-055e1703592a\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"id\": 91,
                                                    \"name\": \"Host_10.10.10.10\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"10.10.10.10\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 85,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 90,
                                            \"uid\": \"21342c9a-3974-4bd3-b74b-b142e43ed39a\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                    \"id\": 90,
                                                    \"name\": \"Range-Test\",
                                                    \"comment\": \"\",
                                                    \"min_ip\": \"1.1.2.0\",
                                                    \"max_ip\": \"1.1.2.55\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 86,
                                        \"action\": \"REMOVE\",
                                        \"device_network_object\": {
                                            \"id\": 86,
                                            \"uid\": \"8fff4c36-da34-4945-be33-ffd5d4d444e2\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"id\": 86,
                                                    \"name\": \"22.22.2.2\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"22.22.2.2\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 87,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 85,
                                            \"uid\": \"35ec73ed-e0fa-4690-9570-00b417b63ae6\",
                                            \"device_id\": 2,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                    \"id\": 85,
                                                    \"name\": \"Net_10.108.151.0\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"10.108.151.0\",
                                                    \"netmask\": \"255.255.255.0\"
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        }
                    }
                },
                \"designer_result\": {
                    \"status\": \"not run\"
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Task status does not exist.
400: Task status is not set to ASSIGNED or DONE.
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: The new network object (<name>): device ID (<id>) does not match the rule key device ID (<id>). The device IDs must be the same.
400: Device ID is required for a new device network object
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <name>
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <st_uid>
400: <cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty.
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
403: Task can not be done because there are unlicensed devices for change automation
400: Invalid value for field: <FIELD_NAME> (Device ID is required for an existing device network object)
400: Invalid value for field: <FIELD_NAME> (ST UID is required for an existing device network object
400: Invalid value for field: <FIELD_NAME> (Network Object with device ID <DEVICE_ID> and ST UID <ST_UID> is not available for the action specified. Check the Knowledge Center or API Implementation Notes for more information
400: Status is required for a device network object","folder":"2-23","rawModeData":"{\n\t\"task\": {\n\t\t\"id\": 4,\n\t\t\"assignee_id\": 4,\n\t\t\"assignee\": \"a\",\n\t\t\"status\": \"ASSIGNED\",\n\t\t\"fields\": {\n\t\t\t\"field\": {\n\t\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\t\"id\": 71,\n\t\t\t\t\"name\": \"Fire Wall Rule\",\n\t\t\t\t\"read_only\": false,\n\t\t\t\t\"devices\": {\n\t\t\t\t\t\"device\": {\n\t\t\t\t\t\t\"revision_id\": 4,\n\t\t\t\t\t\t\"management_name\": \"Panorama/DG_1\",\n\t\t\t\t\t\t\"management_id\": 4,\n\t\t\t\t\t\t\"management_ip\": \"10.100.111.120\",\n\t\t\t\t\t\t\"revision_number\": 1,\n\t\t\t\t\t\t\"number_of_rules\": 1,\n\t\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\t\"policy_name\": \"Standard\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"Application test\",\n\t\t\t\t\t\t\t\t\t\t\"is_disabled\": false,\n\t\t\t\t\t\t\t\t\t\t\"ruleNumber\": 13,\n\t\t\t\t\t\t\t\t\t\t\"from_zone\": \"any\",\n\t\t\t\t\t\t\t\t\t\t\"to_zone\": \"any\",\n\t\t\t\t\t\t\t\t\t\t\"sourceNetworks\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"comment\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a01a\",\n\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"destinationNetworks\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a016\",\n\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"destinationServices\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a018\",\n\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\t\"min_port\": 82,\n\t\t\t\t\t\t\t\t\t\t\t\"max_port\": 82\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"applications\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"single_application\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"application_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE_PREDEFINED\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": true,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"service\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"implicit\": true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a014\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_port\": 80,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_port\": 80\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ACCEPT\",\n\t\t\t\t\t\t\t\t\t\t\"additional_parameters\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"options\": {\n\t\t\t\t\t\t\t\t\t\t\t\"option\": \"LOG_SESSION\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"rule_location\": \"DG_1\",\n\t\t\t\t\t\t\t\t\t\t\"users\": {\n\t\t\t\t\t\t\t\t\t\t\t\"user\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Any\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"any_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"displayName\": \"Any\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"track\": {\n\t\t\t\t\t\t\t\t\t\t\t\"track_level\": \"LOG\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"install_ons\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"communities\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"times\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"rule_metadata\": {\n\t\t\t\t\t\t\t\t\t\t\t\"permissiveness_level\": \"LOW\",\n\t\t\t\t\t\t\t\t\t\t\t\"violations\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"last_hit\": \"No hits\",\n\t\t\t\t\t\t\t\t\t\t\t\"shadowed_status\": \"FALSE\",\n\t\t\t\t\t\t\t\t\t\t\t\"ticket_ids\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"business_owners\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"expirations\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"applications\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"last_modified\": \"Today\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"rule_modifications\": {\n\t\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\t\"id\": 13,\n\t\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\t\"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\t\"id\": 26,\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 89,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 88,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"e7e4ac52-2fe4-49f7-8071-9638817a7434\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 88,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Host\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 91,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 89,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"13556e3e-1f93-4f95-939c-428a58001615\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 89,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Address Ragne\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"192.168.0.1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"192.168.0.254\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 90,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 87,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"1ecb9679-4da4-4fc5-9382-00f5fa455295\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 87,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Network\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\t\"id\": 25,\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 88,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 91,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"50f35caf-3f13-4961-9ccd-055e1703592a\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 91,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host_10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 85,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 90,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"21342c9a-3974-4bd3-b74b-b142e43ed39a\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 90,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Range-Test\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"1.1.2.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"1.1.2.55\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 86,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 86,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"8fff4c36-da34-4945-be33-ffd5d4d444e2\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 86,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 87,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 85,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"35ec73ed-e0fa-4690-9570-00b417b63ae6\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 2,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 85,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Net_10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"designer_result\": {\n\t\t\t\t\t\"status\": \"not run\"\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}","collectionId":"2","id":"2-23-131","method":"PUT"},{"headers":"Accept: application/json\n","name":"Returns the details of a specified field","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"dataMode":"params","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
taskId: The ID number of the task as shown in SecureChange
fieldId: The ID number of the field as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/229

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.
404: Task with ID was not found in Stage ID in ticket ID .
404: Field ID was not found in Task ID in Stage ID in ticket ID .","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}","collectionId":"2","id":"2-23-132","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Change a field within a task of a ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"dataMode":"raw","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both object_UID and object_name are defined, object_UID takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldDTO
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/2/tasks/4/fields/7742
BODY<field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multiple_selection\">
     <id>7742</id>
     <name>filter type</name>
     <selected_options>
         <selected_option>
             <value>FTP</value>
         </selected_option>
     </selected_options>
</field>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/fields/71
BODY{
    \"rule_modification_field\": {
        \"id\": 71,
        \"name\": \"Fire Wall Rule\",
        \"devices\": {
            \"device\": {
                \"revision_id\": 4,
                \"management_name\": \"Panorama/DG_1\",
                \"management_id\": 4,
                \"management_ip\": \"10.100.111.120\",
                \"revision_number\": 1,
                \"number_of_rules\": 1,
                \"bindings\": {
                    \"binding\": {
                        \"binding_uid\": \"{00-FACED0-00}\",
                        \"binding\": {
                            \"@xsi.type\": \"policy__binding\",
                            \"policy_name\": \"Standard\"
                        },
                        \"rules\": {
                            \"rule\": {
                                \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                \"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",
                                \"name\": \"Application test\",
                                \"is_disabled\": false,
                                \"ruleNumber\": 13,
                                \"from_zone\": \"any\",
                                \"to_zone\": \"any\",
                                \"sourceNetworks\": {
                                    \"@xsi.type\": \"host_network_object\",
                                    \"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",
                                    \"name\": \"H_5.3.2.5\",
                                    \"display_name\": \"H_5.3.2.5\",
                                    \"class_name\": \"host_plain\",
                                    \"origin\": \"DEVICE\",
                                    \"global\": false,
                                    \"implicit\": false,
                                    \"shared\": false,
                                    \"comment\": \"comment\",
                                    \"id\": \"5df1f2a5e9023c311ae4a01a\",
                                    \"version_id\": 4,
                                    \"device_type\": \"PaloAltoNetworks\",
                                    \"ip_type\": \"IPV4\",
                                    \"referenced\": \"UNKNOWN\",
                                    \"installable_target\": false,
                                    \"ip\": \"5.3.2.5\",
                                    \"subnet_mask\": \"255.255.255.255\"
                                },
                                \"destinationNetworks\": {
                                    \"@xsi.type\": \"host_network_object\",
                                    \"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",
                                    \"name\": \"22.22.2.2\",
                                    \"display_name\": \"22.22.2.2\",
                                    \"class_name\": \"host_plain\",
                                    \"origin\": \"DEVICE\",
                                    \"global\": false,
                                    \"implicit\": false,
                                    \"shared\": false,
                                    \"comment\": \"\",
                                    \"id\": \"5df1f2a5e9023c311ae4a016\",
                                    \"version_id\": 4,
                                    \"device_type\": \"PaloAltoNetworks\",
                                    \"ip_type\": \"IPV4\",
                                    \"referenced\": \"UNKNOWN\",
                                    \"installable_target\": false,
                                    \"ip\": \"22.22.2.2\",
                                    \"subnet_mask\": \"255.255.255.255\"
                                },
                                \"destinationServices\": {
                                    \"@xsi.type\": \"transport_service\",
                                    \"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",
                                    \"name\": \"TCP82\",
                                    \"display_name\": \"TCP82\",
                                    \"class_name\": \"tcp_service\",
                                    \"origin\": \"DEVICE\",
                                    \"global\": false,
                                    \"implicit\": false,
                                    \"shared\": false,
                                    \"comment\": \"TCP82\",
                                    \"id\": \"5df1f2a5e9023c311ae4a018\",
                                    \"version_id\": 4,
                                    \"referenced\": \"UNKNOWN\",
                                    \"type_on_device\": \"\",
                                    \"negate\": false,
                                    \"match_for_any\": false,
                                    \"timeout\": 0,
                                    \"protocol\": 6,
                                    \"min_port\": 82,
                                    \"max_port\": 82
                                },
                                \"applications\": {
                                    \"@xsi.type\": \"single_application\",
                                    \"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",
                                    \"name\": \"web-browsing\",
                                    \"display_name\": \"web-browsing\",
                                    \"class_name\": \"application_object\",
                                    \"origin\": \"DEVICE_PREDEFINED\",
                                    \"global\": true,
                                    \"implicit\": false,
                                    \"shared\": false,
                                    \"comment\": \"\",
                                    \"service\": [
                                        {
                                            \"@xsi.type\": \"transport_service\",
                                            \"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",
                                            \"name\": \"st_implicit_app_web-browsing\",
                                            \"display_name\": \"st_implicit_app_web-browsing\",
                                            \"class_name\": \"tcp_service\",
                                            \"origin\": \"DEVICE\",
                                            \"global\": false,
                                            \"implicit\": true,
                                            \"shared\": false,
                                            \"comment\": \"\",
                                            \"id\": \"5df1f2a5e9023c311ae4a014\",
                                            \"version_id\": 4,
                                            \"referenced\": \"UNKNOWN\",
                                            \"type_on_device\": \"\",
                                            \"negate\": false,
                                            \"match_for_any\": false,
                                            \"timeout\": 0,
                                            \"protocol\": 6,
                                            \"min_port\": 80,
                                            \"max_port\": 80
                                        }
                                    ]
                                },
                                \"action\": \"ACCEPT\",
                                \"additional_parameters\": \"\",
                                \"options\": {
                                    \"option\": \"LOG_SESSION\"
                                },
                                \"rule_location\": \"DG_1\",
                                \"users\": {
                                    \"user\": [
                                        {
                                            \"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",
                                            \"name\": \"Any\",
                                            \"class_name\": \"any_object\",
                                            \"displayName\": \"Any\"
                                        }
                                    ]
                                },
                                \"track\": {
                                    \"track_level\": \"LOG\"
                                },
                                \"install_ons\": \"\",
                                \"communities\": \"\",
                                \"times\": \"\",
                                \"rule_metadata\": {
                                    \"permissiveness_level\": \"LOW\",
                                    \"violations\": \"\",
                                    \"last_hit\": \"No hits\",
                                    \"shadowed_status\": \"FALSE\",
                                    \"ticket_ids\": \"\",
                                    \"business_owners\": \"\",
                                    \"expirations\": \"\",
                                    \"applications\": \"\",
                                    \"last_modified\": \"Today\"
                                }
                            }
                        }
                    }
                }
            }
        },
        \"rule_modifications\": {
            \"rule_modification\": {
                \"@xsi.type\": \"modify_rule_modification\",
                \"id\": 12,
                \"rule_key\": {
                    \"device_id\": 4,
                    \"binding_uid\": \"{00-FACED0-00}\",
                    \"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"
                },
                \"source_modifications\": {
                    \"id\": 24,
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"id\": 84,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 81,
                                    \"uid\": \"cd555580-3dd2-4830-86c6-260f9783569c\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                            \"id\": 81,
                                            \"name\": \"My New Address Ragne\",
                                            \"comment\": \"some comment\",
                                            \"min_ip\": \"192.168.0.1\",
                                            \"max_ip\": \"192.168.0.254\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 83,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 80,
                                    \"uid\": \"fb534919-e43f-42c9-a7e3-cb00f6b9aaac\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                            \"id\": 80,
                                            \"name\": \"My New Network\",
                                            \"comment\": \"some comment\",
                                            \"ip\": \"192.168.0.0\",
                                            \"netmask\": \"255.255.255.0\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 82,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 79,
                                    \"uid\": \"b76a4265-dc2d-43c7-a3f2-dfe434f6a034\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"id\": 79,
                                            \"name\": \"My New Host\",
                                            \"comment\": \"some comment\",
                                            \"ip\": \"192.168.0.10\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                \"destination_modifications\": {
                    \"id\": 23,
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"id\": 80,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 82,
                                    \"uid\": \"314933de-5b19-4d70-8712-576a0919285e\",
                                    \"device_id\": 2,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                            \"id\": 82,
                                            \"name\": \"Net_10.108.151.0\",
                                            \"comment\": \"\",
                                            \"ip\": \"10.108.151.0\",
                                            \"netmask\": \"255.255.255.0\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 81,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 78,
                                    \"uid\": \"de5a9ef7-a1f0-463c-bf64-9acacbfdb119\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"id\": 78,
                                            \"name\": \"Host_10.10.10.10\",
                                            \"comment\": \"\",
                                            \"ip\": \"10.10.10.10\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 79,
                                \"action\": \"REMOVE\",
                                \"device_network_object\": {
                                    \"id\": 83,
                                    \"uid\": \"822004d2-05bc-492b-96d5-6180b998fbc5\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"id\": 83,
                                            \"name\": \"22.22.2.2\",
                                            \"comment\": \"\",
                                            \"ip\": \"22.22.2.2\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 78,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 84,
                                    \"uid\": \"714dd5f3-976d-4880-b3cb-e45382ddb8ae\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                            \"id\": 84,
                                            \"name\": \"Range-Test\",
                                            \"comment\": \"\",
                                            \"min_ip\": \"1.1.2.0\",
                                            \"max_ip\": \"1.1.2.55\"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            }
        },
        \"designer_result\": {
            \"status\": \"not run\"
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket step does not exist, or is not the current step
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: Deleting rule recertification info is not allowed
400: Application Change field cannot be managed via this REST API
400: Rule associated with successfully updated recertification info cannot be removed
400: Rule was already updated
400: Rule does not exist
400: The new network object (<name>): device ID (<id>) does not match the rule key device ID (<id>). The device IDs must be the same.
400: Device ID is required for a new device network object
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <name>
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <st_uid>
400: <cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty.
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (Device ID is required for an existing device network object)
400: Invalid value for field: <FIELD_NAME> (ST UID is required for an existing device network object
400: Invalid value for field: <FIELD_NAME> (Network Object with device ID <DEVICE_ID> and ST UID <ST_UID> is not available for the action specified. Check the Knowledge Center or API Implementation Notes for more information
400: Status is required for a device network object","folder":"2-23","rawModeData":"{\n\t\"rule_modification_field\": {\n\t\t\"id\": 71,\n\t\t\"name\": \"Fire Wall Rule\",\n\t\t\"devices\": {\n\t\t\t\"device\": {\n\t\t\t\t\"revision_id\": 4,\n\t\t\t\t\"management_name\": \"Panorama/DG_1\",\n\t\t\t\t\"management_id\": 4,\n\t\t\t\t\"management_ip\": \"10.100.111.120\",\n\t\t\t\t\"revision_number\": 1,\n\t\t\t\t\"number_of_rules\": 1,\n\t\t\t\t\"bindings\": {\n\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\"policy_name\": \"Standard\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",\n\t\t\t\t\t\t\t\t\"name\": \"Application test\",\n\t\t\t\t\t\t\t\t\"is_disabled\": false,\n\t\t\t\t\t\t\t\t\"ruleNumber\": 13,\n\t\t\t\t\t\t\t\t\"from_zone\": \"any\",\n\t\t\t\t\t\t\t\t\"to_zone\": \"any\",\n\t\t\t\t\t\t\t\t\"sourceNetworks\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\"display_name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\"comment\": \"comment\",\n\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a01a\",\n\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\"ip\": \"5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"destinationNetworks\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\"display_name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a016\",\n\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"destinationServices\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\"display_name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\"comment\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a018\",\n\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\"min_port\": 82,\n\t\t\t\t\t\t\t\t\t\"max_port\": 82\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"applications\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"single_application\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\"display_name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\"class_name\": \"application_object\",\n\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE_PREDEFINED\",\n\t\t\t\t\t\t\t\t\t\"global\": true,\n\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\"service\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": true,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a014\",\n\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\t\"min_port\": 80,\n\t\t\t\t\t\t\t\t\t\t\t\"max_port\": 80\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"action\": \"ACCEPT\",\n\t\t\t\t\t\t\t\t\"additional_parameters\": \"\",\n\t\t\t\t\t\t\t\t\"options\": {\n\t\t\t\t\t\t\t\t\t\"option\": \"LOG_SESSION\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"rule_location\": \"DG_1\",\n\t\t\t\t\t\t\t\t\"users\": {\n\t\t\t\t\t\t\t\t\t\"user\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Any\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"any_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"displayName\": \"Any\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"track\": {\n\t\t\t\t\t\t\t\t\t\"track_level\": \"LOG\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"install_ons\": \"\",\n\t\t\t\t\t\t\t\t\"communities\": \"\",\n\t\t\t\t\t\t\t\t\"times\": \"\",\n\t\t\t\t\t\t\t\t\"rule_metadata\": {\n\t\t\t\t\t\t\t\t\t\"permissiveness_level\": \"LOW\",\n\t\t\t\t\t\t\t\t\t\"violations\": \"\",\n\t\t\t\t\t\t\t\t\t\"last_hit\": \"No hits\",\n\t\t\t\t\t\t\t\t\t\"shadowed_status\": \"FALSE\",\n\t\t\t\t\t\t\t\t\t\"ticket_ids\": \"\",\n\t\t\t\t\t\t\t\t\t\"business_owners\": \"\",\n\t\t\t\t\t\t\t\t\t\"expirations\": \"\",\n\t\t\t\t\t\t\t\t\t\"applications\": \"\",\n\t\t\t\t\t\t\t\t\t\"last_modified\": \"Today\"\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t\"rule_modifications\": {\n\t\t\t\"rule_modification\": {\n\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\"id\": 12,\n\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"\n\t\t\t\t},\n\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\"id\": 24,\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 84,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 81,\n\t\t\t\t\t\t\t\t\t\"uid\": \"cd555580-3dd2-4830-86c6-260f9783569c\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 81,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Address Ragne\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"192.168.0.1\",\n\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"192.168.0.254\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 83,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 80,\n\t\t\t\t\t\t\t\t\t\"uid\": \"fb534919-e43f-42c9-a7e3-cb00f6b9aaac\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 80,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Network\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.0\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 82,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 79,\n\t\t\t\t\t\t\t\t\t\"uid\": \"b76a4265-dc2d-43c7-a3f2-dfe434f6a034\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 79,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Host\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.10\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\"id\": 23,\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 80,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 82,\n\t\t\t\t\t\t\t\t\t\"uid\": \"314933de-5b19-4d70-8712-576a0919285e\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 2,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 82,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Net_10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 81,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 78,\n\t\t\t\t\t\t\t\t\t\"uid\": \"de5a9ef7-a1f0-463c-bf64-9acacbfdb119\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 78,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host_10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 79,\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 83,\n\t\t\t\t\t\t\t\t\t\"uid\": \"822004d2-05bc-492b-96d5-6180b998fbc5\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 83,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 78,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 84,\n\t\t\t\t\t\t\t\t\t\"uid\": \"714dd5f3-976d-4880-b3cb-e45382ddb8ae\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 84,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Range-Test\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"1.1.2.0\",\n\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"1.1.2.55\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t\"designer_result\": {\n\t\t\t\"status\": \"not run\"\n\t\t}\n\t}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}","collectionId":"2","id":"2-23-133","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get rule decommision verifier results","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/rule_decommission/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type <TYPE>.
404: Verifier results were not found in the request.","dataMode":"params","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/rule_decommission/verifier","collectionId":"2","id":"2-23-134","method":"GET"},{"headers":"Accept: application/json\n","name":"Get designer results according to field id","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"dataMode":"params","description":"Use this API to retrieve designer results generated in R17-2 and later.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/designer

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: Specified field, id: <ID> , name: <NAME>, cannot contain designer result
404: Designer results were not found in the request.","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/designer","collectionId":"2","id":"2-23-135","method":"GET"},{"headers":"Accept: application/json\n","name":"Returns the results of the Commit action","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"},{"value":null,"type":"text","enabled":true,"key":"managementId"}],"dataMode":"params","description":"GENERAL USE
The report returns the Commit results for the device with the specified management ID and for the devices suggested in the Designer results. The report also includes results for devices that are in the related hierarchy of these devices.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID
managementId: Management ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/designer/commit_report/3
OUTPUT{
    \"commit_report\": {
        \"ticketId\": 27,
        \"statTime\": \"24-Oct-2018 08:55 AM\",
        \"endTime\": \"24-Oct-2018 08:56 AM\",
        \"duration\": \"00:00:30\",
        \"vendorName\": \"PALO ALTO NETWORKS\",
        \"managmentName\": \"pano211\",
        \"devices\": {
            \"device\": [
                {
                    \"name\": \"DG1.1\",
                    \"status\": \"success_with_warnings\",
                    \"warnings\": {
                        \"warning\": \"Commit not performed: This device had no policies to install on its managed firewalls\"
                    },
                    \"policies\": \"\"
                },
                {
                    \"name\": \"DG1\",
                    \"status\": \"success_with_warnings\",
                    \"warnings\": {
                        \"warning\": \"Commit not performed: This device had no policies to install on its managed firewalls\"
                    },
                    \"policies\": \"\"
                }
            ]
        }
    }
}


Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: Specified field, id: <ID> , name: <NAME>, cannot contain designer result
404: Designer results were not found in the request.","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/designer/commit_report/{{managementId}}","collectionId":"2","id":"2-23-136","method":"GET"},{"headers":"Accept: application/json\n","name":"Returns the details of a specified ticket stages","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps","collectionId":"2","id":"2-23-137","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Change a field within a task of a ticket at the current step","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"dataMode":"raw","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both object_UID and object_name are defined, object_UID takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldDTO
id: Ticket ID
taskId: Task ID
fieldId: Field ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields/7642
BODY<field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"approve_reject\">
         <id>7661</id>
         <name>approve access</name>
         <approved>true</approved>
         <reason>Request approved</reason>
    </field>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields/71
BODY{
    \"rule_modification_field\": {
        \"id\": 71,
        \"name\": \"Fire Wall Rule\",
        \"devices\": {
            \"device\": {
                \"revision_id\": 4,
                \"management_name\": \"Panorama/DG_1\",
                \"management_id\": 4,
                \"management_ip\": \"10.100.111.120\",
                \"revision_number\": 1,
                \"number_of_rules\": 1,
                \"bindings\": {
                    \"binding\": {
                        \"binding_uid\": \"{00-FACED0-00}\",
                        \"binding\": {
                            \"@xsi.type\": \"policy__binding\",
                            \"policy_name\": \"Standard\"
                        },
                        \"rules\": {
                            \"rule\": {
                                \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                \"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",
                                \"name\": \"Application test\",
                                \"is_disabled\": false,
                                \"ruleNumber\": 13,
                                \"from_zone\": \"any\",
                                \"to_zone\": \"any\",
                                \"sourceNetworks\": {
                                    \"@xsi.type\": \"host_network_object\",
                                    \"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",
                                    \"name\": \"H_5.3.2.5\",
                                    \"display_name\": \"H_5.3.2.5\",
                                    \"class_name\": \"host_plain\",
                                    \"origin\": \"DEVICE\",
                                    \"global\": false,
                                    \"implicit\": false,
                                    \"shared\": false,
                                    \"comment\": \"comment\",
                                    \"id\": \"5df1f2a5e9023c311ae4a01a\",
                                    \"version_id\": 4,
                                    \"device_type\": \"PaloAltoNetworks\",
                                    \"ip_type\": \"IPV4\",
                                    \"referenced\": \"UNKNOWN\",
                                    \"installable_target\": false,
                                    \"ip\": \"5.3.2.5\",
                                    \"subnet_mask\": \"255.255.255.255\"
                                },
                                \"destinationNetworks\": {
                                    \"@xsi.type\": \"host_network_object\",
                                    \"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",
                                    \"name\": \"22.22.2.2\",
                                    \"display_name\": \"22.22.2.2\",
                                    \"class_name\": \"host_plain\",
                                    \"origin\": \"DEVICE\",
                                    \"global\": false,
                                    \"implicit\": false,
                                    \"shared\": false,
                                    \"comment\": \"\",
                                    \"id\": \"5df1f2a5e9023c311ae4a016\",
                                    \"version_id\": 4,
                                    \"device_type\": \"PaloAltoNetworks\",
                                    \"ip_type\": \"IPV4\",
                                    \"referenced\": \"UNKNOWN\",
                                    \"installable_target\": false,
                                    \"ip\": \"22.22.2.2\",
                                    \"subnet_mask\": \"255.255.255.255\"
                                },
                                \"destinationServices\": {
                                    \"@xsi.type\": \"transport_service\",
                                    \"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",
                                    \"name\": \"TCP82\",
                                    \"display_name\": \"TCP82\",
                                    \"class_name\": \"tcp_service\",
                                    \"origin\": \"DEVICE\",
                                    \"global\": false,
                                    \"implicit\": false,
                                    \"shared\": false,
                                    \"comment\": \"TCP82\",
                                    \"id\": \"5df1f2a5e9023c311ae4a018\",
                                    \"version_id\": 4,
                                    \"referenced\": \"UNKNOWN\",
                                    \"type_on_device\": \"\",
                                    \"negate\": false,
                                    \"match_for_any\": false,
                                    \"timeout\": 0,
                                    \"protocol\": 6,
                                    \"min_port\": 82,
                                    \"max_port\": 82
                                },
                                \"applications\": {
                                    \"@xsi.type\": \"single_application\",
                                    \"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",
                                    \"name\": \"web-browsing\",
                                    \"display_name\": \"web-browsing\",
                                    \"class_name\": \"application_object\",
                                    \"origin\": \"DEVICE_PREDEFINED\",
                                    \"global\": true,
                                    \"implicit\": false,
                                    \"shared\": false,
                                    \"comment\": \"\",
                                    \"service\": [
                                        {
                                            \"@xsi.type\": \"transport_service\",
                                            \"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",
                                            \"name\": \"st_implicit_app_web-browsing\",
                                            \"display_name\": \"st_implicit_app_web-browsing\",
                                            \"class_name\": \"tcp_service\",
                                            \"origin\": \"DEVICE\",
                                            \"global\": false,
                                            \"implicit\": true,
                                            \"shared\": false,
                                            \"comment\": \"\",
                                            \"id\": \"5df1f2a5e9023c311ae4a014\",
                                            \"version_id\": 4,
                                            \"referenced\": \"UNKNOWN\",
                                            \"type_on_device\": \"\",
                                            \"negate\": false,
                                            \"match_for_any\": false,
                                            \"timeout\": 0,
                                            \"protocol\": 6,
                                            \"min_port\": 80,
                                            \"max_port\": 80
                                        }
                                    ]
                                },
                                \"action\": \"ACCEPT\",
                                \"additional_parameters\": \"\",
                                \"options\": {
                                    \"option\": \"LOG_SESSION\"
                                },
                                \"rule_location\": \"DG_1\",
                                \"users\": {
                                    \"user\": [
                                        {
                                            \"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",
                                            \"name\": \"Any\",
                                            \"class_name\": \"any_object\",
                                            \"displayName\": \"Any\"
                                        }
                                    ]
                                },
                                \"track\": {
                                    \"track_level\": \"LOG\"
                                },
                                \"install_ons\": \"\",
                                \"communities\": \"\",
                                \"times\": \"\",
                                \"rule_metadata\": {
                                    \"permissiveness_level\": \"LOW\",
                                    \"violations\": \"\",
                                    \"last_hit\": \"No hits\",
                                    \"shadowed_status\": \"FALSE\",
                                    \"ticket_ids\": \"\",
                                    \"business_owners\": \"\",
                                    \"expirations\": \"\",
                                    \"applications\": \"\",
                                    \"last_modified\": \"Today\"
                                }
                            }
                        }
                    }
                }
            }
        },
        \"rule_modifications\": {
            \"rule_modification\": {
                \"@xsi.type\": \"modify_rule_modification\",
                \"id\": 12,
                \"rule_key\": {
                    \"device_id\": 4,
                    \"binding_uid\": \"{00-FACED0-00}\",
                    \"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"
                },
                \"source_modifications\": {
                    \"id\": 24,
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"id\": 84,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 81,
                                    \"uid\": \"cd555580-3dd2-4830-86c6-260f9783569c\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                            \"id\": 81,
                                            \"name\": \"My New Address Ragne\",
                                            \"comment\": \"some comment\",
                                            \"min_ip\": \"192.168.0.1\",
                                            \"max_ip\": \"192.168.0.254\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 83,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 80,
                                    \"uid\": \"fb534919-e43f-42c9-a7e3-cb00f6b9aaac\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                            \"id\": 80,
                                            \"name\": \"My New Network\",
                                            \"comment\": \"some comment\",
                                            \"ip\": \"192.168.0.0\",
                                            \"netmask\": \"255.255.255.0\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 82,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 79,
                                    \"uid\": \"b76a4265-dc2d-43c7-a3f2-dfe434f6a034\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"id\": 79,
                                            \"name\": \"My New Host\",
                                            \"comment\": \"some comment\",
                                            \"ip\": \"192.168.0.10\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                \"destination_modifications\": {
                    \"id\": 23,
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"id\": 80,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 82,
                                    \"uid\": \"314933de-5b19-4d70-8712-576a0919285e\",
                                    \"device_id\": 2,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                            \"id\": 82,
                                            \"name\": \"Net_10.108.151.0\",
                                            \"comment\": \"\",
                                            \"ip\": \"10.108.151.0\",
                                            \"netmask\": \"255.255.255.0\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 81,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 78,
                                    \"uid\": \"de5a9ef7-a1f0-463c-bf64-9acacbfdb119\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"id\": 78,
                                            \"name\": \"Host_10.10.10.10\",
                                            \"comment\": \"\",
                                            \"ip\": \"10.10.10.10\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 79,
                                \"action\": \"REMOVE\",
                                \"device_network_object\": {
                                    \"id\": 83,
                                    \"uid\": \"822004d2-05bc-492b-96d5-6180b998fbc5\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"id\": 83,
                                            \"name\": \"22.22.2.2\",
                                            \"comment\": \"\",
                                            \"ip\": \"22.22.2.2\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 78,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 84,
                                    \"uid\": \"714dd5f3-976d-4880-b3cb-e45382ddb8ae\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                            \"id\": 84,
                                            \"name\": \"Range-Test\",
                                            \"comment\": \"\",
                                            \"min_ip\": \"1.1.2.0\",
                                            \"max_ip\": \"1.1.2.55\"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            }
        },
        \"designer_result\": {
            \"status\": \"not run\"
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: The new network object (<name>): device ID (<id>) does not match the rule key device ID (<id>). The device IDs must be the same.
400: Device ID is required for a new device network object
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <name>
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <st_uid>
400: <cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty.
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (Device ID is required for an existing device network object)
400: Invalid value for field: <FIELD_NAME> (ST UID is required for an existing device network object
400: Invalid value for field: <FIELD_NAME> (Network Object with device ID <DEVICE_ID> and ST UID <ST_UID> is not available for the action specified. Check the Knowledge Center or API Implementation Notes for more information
400: Status is required for a device network object","folder":"2-23","rawModeData":"{\n\t\"rule_modification_field\": {\n\t\t\"id\": 71,\n\t\t\"name\": \"Fire Wall Rule\",\n\t\t\"devices\": {\n\t\t\t\"device\": {\n\t\t\t\t\"revision_id\": 4,\n\t\t\t\t\"management_name\": \"Panorama/DG_1\",\n\t\t\t\t\"management_id\": 4,\n\t\t\t\t\"management_ip\": \"10.100.111.120\",\n\t\t\t\t\"revision_number\": 1,\n\t\t\t\t\"number_of_rules\": 1,\n\t\t\t\t\"bindings\": {\n\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\"policy_name\": \"Standard\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",\n\t\t\t\t\t\t\t\t\"name\": \"Application test\",\n\t\t\t\t\t\t\t\t\"is_disabled\": false,\n\t\t\t\t\t\t\t\t\"ruleNumber\": 13,\n\t\t\t\t\t\t\t\t\"from_zone\": \"any\",\n\t\t\t\t\t\t\t\t\"to_zone\": \"any\",\n\t\t\t\t\t\t\t\t\"sourceNetworks\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\"display_name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\"comment\": \"comment\",\n\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a01a\",\n\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\"ip\": \"5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"destinationNetworks\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\"display_name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a016\",\n\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"destinationServices\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\"display_name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\"comment\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a018\",\n\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\"min_port\": 82,\n\t\t\t\t\t\t\t\t\t\"max_port\": 82\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"applications\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"single_application\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\"display_name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\"class_name\": \"application_object\",\n\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE_PREDEFINED\",\n\t\t\t\t\t\t\t\t\t\"global\": true,\n\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\"service\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": true,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a014\",\n\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\t\"min_port\": 80,\n\t\t\t\t\t\t\t\t\t\t\t\"max_port\": 80\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"action\": \"ACCEPT\",\n\t\t\t\t\t\t\t\t\"additional_parameters\": \"\",\n\t\t\t\t\t\t\t\t\"options\": {\n\t\t\t\t\t\t\t\t\t\"option\": \"LOG_SESSION\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"rule_location\": \"DG_1\",\n\t\t\t\t\t\t\t\t\"users\": {\n\t\t\t\t\t\t\t\t\t\"user\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Any\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"any_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"displayName\": \"Any\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"track\": {\n\t\t\t\t\t\t\t\t\t\"track_level\": \"LOG\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"install_ons\": \"\",\n\t\t\t\t\t\t\t\t\"communities\": \"\",\n\t\t\t\t\t\t\t\t\"times\": \"\",\n\t\t\t\t\t\t\t\t\"rule_metadata\": {\n\t\t\t\t\t\t\t\t\t\"permissiveness_level\": \"LOW\",\n\t\t\t\t\t\t\t\t\t\"violations\": \"\",\n\t\t\t\t\t\t\t\t\t\"last_hit\": \"No hits\",\n\t\t\t\t\t\t\t\t\t\"shadowed_status\": \"FALSE\",\n\t\t\t\t\t\t\t\t\t\"ticket_ids\": \"\",\n\t\t\t\t\t\t\t\t\t\"business_owners\": \"\",\n\t\t\t\t\t\t\t\t\t\"expirations\": \"\",\n\t\t\t\t\t\t\t\t\t\"applications\": \"\",\n\t\t\t\t\t\t\t\t\t\"last_modified\": \"Today\"\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t\"rule_modifications\": {\n\t\t\t\"rule_modification\": {\n\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\"id\": 12,\n\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"\n\t\t\t\t},\n\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\"id\": 24,\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 84,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 81,\n\t\t\t\t\t\t\t\t\t\"uid\": \"cd555580-3dd2-4830-86c6-260f9783569c\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 81,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Address Ragne\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"192.168.0.1\",\n\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"192.168.0.254\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 83,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 80,\n\t\t\t\t\t\t\t\t\t\"uid\": \"fb534919-e43f-42c9-a7e3-cb00f6b9aaac\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 80,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Network\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.0\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 82,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 79,\n\t\t\t\t\t\t\t\t\t\"uid\": \"b76a4265-dc2d-43c7-a3f2-dfe434f6a034\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 79,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Host\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.10\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\"id\": 23,\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 80,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 82,\n\t\t\t\t\t\t\t\t\t\"uid\": \"314933de-5b19-4d70-8712-576a0919285e\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 2,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 82,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Net_10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 81,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 78,\n\t\t\t\t\t\t\t\t\t\"uid\": \"de5a9ef7-a1f0-463c-bf64-9acacbfdb119\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 78,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host_10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 79,\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 83,\n\t\t\t\t\t\t\t\t\t\"uid\": \"822004d2-05bc-492b-96d5-6180b998fbc5\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 83,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 78,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 84,\n\t\t\t\t\t\t\t\t\t\"uid\": \"714dd5f3-976d-4880-b3cb-e45382ddb8ae\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 84,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Range-Test\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"1.1.2.0\",\n\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"1.1.2.55\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t\"designer_result\": {\n\t\t\t\"status\": \"not run\"\n\t\t}\n\t}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/fields/{{fieldId}}","collectionId":"2","id":"2-23-138","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Change multiple field within a task of a ticket in the current step","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"raw","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both object_UID and object_name are defined, object_UID takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldListDTO
id: Ticket ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields
BODY<fields>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_server_decommission_request\">
         <id>7591</id>
         <name>sd</name>
         <server_decommission_request>
             <id>7596</id>
             <order>DR1</order>
             <servers>
                 <server type=\"IP\">
                     <id>7593</id>
                     <ip_address>2.2.2.2</ip_address>
                     <netmask>255.255.255.255</netmask>
                 </server>
             </servers>
             <targets>
                 <target type=\"ANY\">
                     <id>7595</id>
                 </target>
             </targets>
             <comment>change ip from 1.1.1.1 to 2.2.2.2</comment>
         </server_decommission_request>
     </field>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"date\">
         <id>7786</id>
         <name>date</name>
         <value>2015-12-15</value>
     </field>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"time\">
         <id>7787</id>
         <name>time</name>
         <value>12:00</value>
     </field>
</fields>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields
BODY{
    \"fields\": {
        \"field\": {
            \"@xsi.type\": \"rule_modification_field\",
            \"id\": 71,
            \"name\": \"Fire Wall Rule\",
            \"read_only\": false,
            \"devices\": {
                \"device\": {
                    \"revision_id\": 4,
                    \"management_name\": \"Panorama/DG_1\",
                    \"management_id\": 4,
                    \"management_ip\": \"10.100.111.120\",
                    \"revision_number\": 1,
                    \"number_of_rules\": 1,
                    \"bindings\": {
                        \"binding\": {
                            \"binding_uid\": \"{00-FACED0-00}\",
                            \"binding\": {
                                \"@xsi.type\": \"policy__binding\",
                                \"policy_name\": \"Standard\"
                            },
                            \"rules\": {
                                \"rule\": {
                                    \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                    \"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",
                                    \"name\": \"Application test\",
                                    \"is_disabled\": false,
                                    \"ruleNumber\": 13,
                                    \"from_zone\": \"any\",
                                    \"to_zone\": \"any\",
                                    \"sourceNetworks\": {
                                        \"@xsi.type\": \"host_network_object\",
                                        \"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",
                                        \"name\": \"H_5.3.2.5\",
                                        \"display_name\": \"H_5.3.2.5\",
                                        \"class_name\": \"host_plain\",
                                        \"origin\": \"DEVICE\",
                                        \"global\": false,
                                        \"implicit\": false,
                                        \"shared\": false,
                                        \"comment\": \"comment\",
                                        \"id\": \"5df1f2a5e9023c311ae4a01a\",
                                        \"version_id\": 4,
                                        \"device_type\": \"PaloAltoNetworks\",
                                        \"ip_type\": \"IPV4\",
                                        \"referenced\": \"UNKNOWN\",
                                        \"installable_target\": false,
                                        \"ip\": \"5.3.2.5\",
                                        \"subnet_mask\": \"255.255.255.255\"
                                    },
                                    \"destinationNetworks\": {
                                        \"@xsi.type\": \"host_network_object\",
                                        \"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",
                                        \"name\": \"22.22.2.2\",
                                        \"display_name\": \"22.22.2.2\",
                                        \"class_name\": \"host_plain\",
                                        \"origin\": \"DEVICE\",
                                        \"global\": false,
                                        \"implicit\": false,
                                        \"shared\": false,
                                        \"comment\": \"\",
                                        \"id\": \"5df1f2a5e9023c311ae4a016\",
                                        \"version_id\": 4,
                                        \"device_type\": \"PaloAltoNetworks\",
                                        \"ip_type\": \"IPV4\",
                                        \"referenced\": \"UNKNOWN\",
                                        \"installable_target\": false,
                                        \"ip\": \"22.22.2.2\",
                                        \"subnet_mask\": \"255.255.255.255\"
                                    },
                                    \"destinationServices\": {
                                        \"@xsi.type\": \"transport_service\",
                                        \"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",
                                        \"name\": \"TCP82\",
                                        \"display_name\": \"TCP82\",
                                        \"class_name\": \"tcp_service\",
                                        \"origin\": \"DEVICE\",
                                        \"global\": false,
                                        \"implicit\": false,
                                        \"shared\": false,
                                        \"comment\": \"TCP82\",
                                        \"id\": \"5df1f2a5e9023c311ae4a018\",
                                        \"version_id\": 4,
                                        \"referenced\": \"UNKNOWN\",
                                        \"type_on_device\": \"\",
                                        \"negate\": false,
                                        \"match_for_any\": false,
                                        \"timeout\": 0,
                                        \"protocol\": 6,
                                        \"min_port\": 82,
                                        \"max_port\": 82
                                    },
                                    \"applications\": {
                                        \"@xsi.type\": \"single_application\",
                                        \"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",
                                        \"name\": \"web-browsing\",
                                        \"display_name\": \"web-browsing\",
                                        \"class_name\": \"application_object\",
                                        \"origin\": \"DEVICE_PREDEFINED\",
                                        \"global\": true,
                                        \"implicit\": false,
                                        \"shared\": false,
                                        \"comment\": \"\",
                                        \"service\": [
                                            {
                                                \"@xsi.type\": \"transport_service\",
                                                \"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",
                                                \"name\": \"st_implicit_app_web-browsing\",
                                                \"display_name\": \"st_implicit_app_web-browsing\",
                                                \"class_name\": \"tcp_service\",
                                                \"origin\": \"DEVICE\",
                                                \"global\": false,
                                                \"implicit\": true,
                                                \"shared\": false,
                                                \"comment\": \"\",
                                                \"id\": \"5df1f2a5e9023c311ae4a014\",
                                                \"version_id\": 4,
                                                \"referenced\": \"UNKNOWN\",
                                                \"type_on_device\": \"\",
                                                \"negate\": false,
                                                \"match_for_any\": false,
                                                \"timeout\": 0,
                                                \"protocol\": 6,
                                                \"min_port\": 80,
                                                \"max_port\": 80
                                            }
                                        ]
                                    },
                                    \"action\": \"ACCEPT\",
                                    \"additional_parameters\": \"\",
                                    \"options\": {
                                        \"option\": \"LOG_SESSION\"
                                    },
                                    \"rule_location\": \"DG_1\",
                                    \"users\": {
                                        \"user\": [
                                            {
                                                \"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",
                                                \"name\": \"Any\",
                                                \"class_name\": \"any_object\",
                                                \"displayName\": \"Any\"
                                            }
                                        ]
                                    },
                                    \"track\": {
                                        \"track_level\": \"LOG\"
                                    },
                                    \"install_ons\": \"\",
                                    \"communities\": \"\",
                                    \"times\": \"\",
                                    \"rule_metadata\": {
                                        \"permissiveness_level\": \"LOW\",
                                        \"violations\": \"\",
                                        \"last_hit\": \"No hits\",
                                        \"shadowed_status\": \"FALSE\",
                                        \"ticket_ids\": \"\",
                                        \"business_owners\": \"\",
                                        \"expirations\": \"\",
                                        \"applications\": \"\",
                                        \"last_modified\": \"Today\"
                                    }
                                }
                            }
                        }
                    }
                }
            },
            \"rule_modifications\": {
                \"rule_modification\": {
                    \"@xsi.type\": \"modify_rule_modification\",
                    \"id\": 10,
                    \"rule_key\": {
                        \"device_id\": 4,
                        \"binding_uid\": \"{00-FACED0-00}\",
                        \"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"
                    },
                    \"source_modifications\": {
                        \"id\": 20,
                        \"network_object_cell_modifications\": {
                            \"network_object_cell_modification\": [
                                {
                                    \"id\": 69,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 65,
                                        \"uid\": \"9b9062a0-228a-4543-bbd4-9fda5c76573b\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"new\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                \"id\": 65,
                                                \"name\": \"My New Host\",
                                                \"comment\": \"some comment\",
                                                \"ip\": \"192.168.0.10\",
                                                \"netmask\": \"255.255.255.255\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 68,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 64,
                                        \"uid\": \"986c68ab-b5b5-478d-9300-bc0cacc06dfe\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"new\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                \"id\": 64,
                                                \"name\": \"My New Address Ragne\",
                                                \"comment\": \"some comment\",
                                                \"min_ip\": \"192.168.0.1\",
                                                \"max_ip\": \"192.168.0.254\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 70,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 68,
                                        \"uid\": \"1073dad5-4dc9-4392-8b42-f32de2937657\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"new\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                \"id\": 68,
                                                \"name\": \"My New Network\",
                                                \"comment\": \"some comment\",
                                                \"ip\": \"192.168.0.0\",
                                                \"netmask\": \"255.255.255.0\"
                                            }
                                        ]
                                    }
                                }
                            ]
                        }
                    },
                    \"destination_modifications\": {
                        \"id\": 19,
                        \"network_object_cell_modifications\": {
                            \"network_object_cell_modification\": [
                                {
                                    \"id\": 66,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 67,
                                        \"uid\": \"e52c07fc-dffb-4c77-a656-40d1b1322e77\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"existing\",
                                            \"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                \"id\": 67,
                                                \"name\": \"Range-Test\",
                                                \"comment\": \"\",
                                                \"min_ip\": \"1.1.2.0\",
                                                \"max_ip\": \"1.1.2.55\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 67,
                                    \"action\": \"REMOVE\",
                                    \"device_network_object\": {
                                        \"id\": 66,
                                        \"uid\": \"fa681c9b-8c4f-449d-9b31-108a399902f5\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"existing\",
                                            \"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                \"id\": 66,
                                                \"name\": \"22.22.2.2\",
                                                \"comment\": \"\",
                                                \"ip\": \"22.22.2.2\",
                                                \"netmask\": \"255.255.255.255\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 65,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 70,
                                        \"uid\": \"2b8eaa1a-f4ea-4c39-b89e-361af89a308e\",
                                        \"device_id\": 2,
                                        \"status\": {
                                            \"@xsi.type\": \"existing\",
                                            \"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                \"id\": 70,
                                                \"name\": \"Net_10.108.151.0\",
                                                \"comment\": \"\",
                                                \"ip\": \"10.108.151.0\",
                                                \"netmask\": \"255.255.255.0\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 64,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 69,
                                        \"uid\": \"88efeaad-cfb4-41c4-b14c-fff104c24e52\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"existing\",
                                            \"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                \"id\": 69,
                                                \"name\": \"Host_10.10.10.10\",
                                                \"comment\": \"\",
                                                \"ip\": \"10.10.10.10\",
                                                \"netmask\": \"255.255.255.255\"
                                            }
                                        ]
                                    }
                                }
                            ]
                        }
                    }
                }
            },
            \"designer_result\": {
                \"status\": \"not run\"
            }
        }
    }
}}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: The new network object (<name>): device ID (<id>) does not match the rule key device ID (<id>). The device IDs must be the same.
400: Device ID is required for a new device network object
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <name>
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <st_uid>
400: <cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty.
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (Device ID is required for an existing device network object)
400: Invalid value for field: <FIELD_NAME> (ST UID is required for an existing device network object
400: Invalid value for field: <FIELD_NAME> (Network Object with device ID <DEVICE_ID> and ST UID <ST_UID> is not available for the action specified. Check the Knowledge Center or API Implementation Notes for more information
400: Status is required for a device network object","folder":"2-23","rawModeData":"{\n\t\"fields\": {\n\t\t\"field\": {\n\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\"id\": 71,\n\t\t\t\"name\": \"Fire Wall Rule\",\n\t\t\t\"read_only\": false,\n\t\t\t\"devices\": {\n\t\t\t\t\"device\": {\n\t\t\t\t\t\"revision_id\": 4,\n\t\t\t\t\t\"management_name\": \"Panorama/DG_1\",\n\t\t\t\t\t\"management_id\": 4,\n\t\t\t\t\t\"management_ip\": \"10.100.111.120\",\n\t\t\t\t\t\"revision_number\": 1,\n\t\t\t\t\t\"number_of_rules\": 1,\n\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\"policy_name\": \"Standard\"\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"Application test\",\n\t\t\t\t\t\t\t\t\t\"is_disabled\": false,\n\t\t\t\t\t\t\t\t\t\"ruleNumber\": 13,\n\t\t\t\t\t\t\t\t\t\"from_zone\": \"any\",\n\t\t\t\t\t\t\t\t\t\"to_zone\": \"any\",\n\t\t\t\t\t\t\t\t\t\"sourceNetworks\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\"display_name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"comment\",\n\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a01a\",\n\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\t\"ip\": \"5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"destinationNetworks\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\"display_name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a016\",\n\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"destinationServices\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\"display_name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a018\",\n\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\"min_port\": 82,\n\t\t\t\t\t\t\t\t\t\t\"max_port\": 82\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"applications\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"single_application\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\"display_name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\"class_name\": \"application_object\",\n\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE_PREDEFINED\",\n\t\t\t\t\t\t\t\t\t\t\"global\": true,\n\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"service\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\"implicit\": true,\n\t\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a014\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\t\t\"min_port\": 80,\n\t\t\t\t\t\t\t\t\t\t\t\t\"max_port\": 80\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"action\": \"ACCEPT\",\n\t\t\t\t\t\t\t\t\t\"additional_parameters\": \"\",\n\t\t\t\t\t\t\t\t\t\"options\": {\n\t\t\t\t\t\t\t\t\t\t\"option\": \"LOG_SESSION\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"rule_location\": \"DG_1\",\n\t\t\t\t\t\t\t\t\t\"users\": {\n\t\t\t\t\t\t\t\t\t\t\"user\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Any\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"any_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"displayName\": \"Any\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"track\": {\n\t\t\t\t\t\t\t\t\t\t\"track_level\": \"LOG\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"install_ons\": \"\",\n\t\t\t\t\t\t\t\t\t\"communities\": \"\",\n\t\t\t\t\t\t\t\t\t\"times\": \"\",\n\t\t\t\t\t\t\t\t\t\"rule_metadata\": {\n\t\t\t\t\t\t\t\t\t\t\"permissiveness_level\": \"LOW\",\n\t\t\t\t\t\t\t\t\t\t\"violations\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"last_hit\": \"No hits\",\n\t\t\t\t\t\t\t\t\t\t\"shadowed_status\": \"FALSE\",\n\t\t\t\t\t\t\t\t\t\t\"ticket_ids\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"business_owners\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"expirations\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"applications\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"last_modified\": \"Today\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"rule_modifications\": {\n\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\"id\": 10,\n\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"\n\t\t\t\t\t},\n\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\"id\": 20,\n\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 69,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 65,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"9b9062a0-228a-4543-bbd4-9fda5c76573b\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 65,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Host\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 68,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 64,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"986c68ab-b5b5-478d-9300-bc0cacc06dfe\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 64,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Address Ragne\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"192.168.0.1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"192.168.0.254\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 70,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 68,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"1073dad5-4dc9-4392-8b42-f32de2937657\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 68,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Network\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t]\n\t\t\t\t\t\t}\n\t\t\t\t\t},\n\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\"id\": 19,\n\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 66,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 67,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"e52c07fc-dffb-4c77-a656-40d1b1322e77\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 67,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Range-Test\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"1.1.2.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"1.1.2.55\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 67,\n\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 66,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"fa681c9b-8c4f-449d-9b31-108a399902f5\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 66,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 65,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 70,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"2b8eaa1a-f4ea-4c39-b89e-361af89a308e\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 2,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 70,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Net_10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 64,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 69,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"88efeaad-cfb4-41c4-b14c-fff104c24e52\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 69,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host_10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t]\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"designer_result\": {\n\t\t\t\t\"status\": \"not run\"\n\t\t\t}\n\t\t}\n\t}\n}}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/fields","collectionId":"2","id":"2-23-139","method":"PUT"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Modify the Designer suggestions for Access Request or Clone Server Policy","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"instructionId"}],"dataMode":"raw","description":" GENERAL USE
1. Create a ticket using UI/API.
2. Run the designer using UI/API.
3. Use relevent API to get the designer results.
4. Run this API to modify the required parameters.

*Note: you can modify one parameter at a time.

Change rule location use
a. Modifying the rule order places the new rule before the rule with the specified identifier (rule name or number).
b. Modifying the rule placement to \"last\" places the new rule as last rule or last pre-rule (depending on the vendor convention for the device).
c. For vendors that support \"after\" placement, modifying the rule placement allows positioning the new rule before or after the suggested rule location.

track level permitted values:
NONE, LOG, ACCOUNT, ALERT, SNMP, MAIL, USER_DEFINED, EMERGENCIES, ALERTS, CRITICAL, ERRORS, WARNINGS, NOTIFICATIONS, INFORMATIONAL, DEBUGGING, DISABLED, DEFAULT, FULL_LOG, NETWORK_LOG, USER_ALERT_1, USER_ALERT_2, USER_ALERT_3

rule placement permitted values:
BEFORE, AFTER, LAST

Parameters:
body: DesignerInstructionChangeDTO
id: Ticket ID
taskId: Task ID
instructionId: Instruction ID
force: force update when new revision available [optional]

Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"comment\": {\"new_value\":\"new comment\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196?force=true
BODY{
    \"comment\": {\"new_value\":\"new comment\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_name\": {\"new_value\":\"new rule name\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"track_level\": {\"new_value\":\"LOG\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"object_name\": {\"new_value\":\"new object name\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"log_forwarding_profile\": {\"new_value\":\"new log forwarding profile\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"security_profile_group\": {\"new_value\":\"new security profile group\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"object_replace\": {
             \"new_value\":\"new object uid\",
             \"old_value\":\"old object uid\"
    }
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_order\": {\"new_value\":\"8\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_placement\": {\"new_value\":\"last\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_placement\": {\"new_value\":\"before\"}
}


Response Messages:
200: New rule will be shadowed
200: New rule will be shadowed or break acceleration
400: Modify Designer Results API is only supported for Access Request and Clone Server Policy workflows
412: Current instruction cannot be modified because either the implementation was successful or failed irrevocably.
412: Current step does not support Designer modification action
400: A ticket with ID <ID> cannot be found.
400: Task ID <ID> cannot be found in the current step with ID <ID>.
403: Changing <TYPE> is not supported on this device
403: This Change is not supported for <INSTRUCTION TYPE> instruction type\"
401: You do not have permission to update this task. Contact your administrator for assistance.
403: New revision is available, cannot modify the Designer results
404: Specified instruction, id: <ID> was not found
404: Designer results were not found in the access request.
400: a valid object name must start with an alphanumeric character and can contain alphanumeric characters, underscore '_'. Hypen '-', dot '.' or spaces
400: For this device, the comment must be less than 100 characters per line.
400: For this device, this field must be less than <NUMBER OF CHARACTERS> characters
400: For this device, this field is required.
409: Rule name already exists for this device. Please give this rule a unique name.
409: Rule name <NAME> already exists in the device group hierarchy. Choose a unique name for this rule.
400: Comment contains invalid characters.
400: <DEVICE> does not support tracking level <TRACKING LEVEL>
400: <TRACKING LEVEL> is not a valid rule track level value
400: a valid object name cannot contain any of the following characters: <CHARACTERS>
400: a valid object name must be less than <NUMBER OF CHARACTERS> characters
400: a valid object name cannot be empty
400: a valid object name must conform to the following pattern: <STRING PATTERN>
409: Object already exists
400: A security profile group cannot be empty.
404: The security profile group <SECURITY PROFILE GROUP> was not found.
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to validate the security profile group.
400: A log forwarding profile cannot be empty.
404: The log forwarding profile <LOG FORWARDING PROFILE> was not found.
500: An error occurred in SecureTrack while trying to validate the log forwarding profile.
400: Object UID <OLD OBJECT UID> not found in the rule for this instruction.
400: Values of new object UID <NEW OBJECT UID> and old object UID <OLD OBJECT UID> do not match.
400: Rule placement can only be: \"before\", \"after\" or \"last\".
400: You can't change rule placement when there is no rule order. please add rule order first.
400: You can't change rule placement to \"After\" for this type of device.
400: You can't change rule placement to \"Last\" for this type of device.","folder":"2-23","rawModeData":"{\n\t\"rule_placement\": {\"new_value\":\"before\"}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/tasks/{{taskId}}/designer/instruction/{{instructionId}}","collectionId":"2","id":"2-23-140","method":"PUT"},{"headers":"Accept: application/json\n","name":"Returns the details of a specified ticket stages","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"}],"dataMode":"params","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}","collectionId":"2","id":"2-23-141","method":"GET"},{"headers":"Accept: application/json\n","collectionId":"2","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/free_text_search","name":"Returns a list of tickets by search parameters","method":"GET","id":"2-23-142","description":"Parameters:
parameter: Free text search parameter (Search syntax details) [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/free_text_search/?parameter=taskstatus:ASSIGNED AND priority:High

Response Messages:
400: Can not fetch more than 100 tickets in 1 time
401: Access is denied.
404: Illegal ticket status entered. Permitted values are: IN_PROGRESS, REJECTED, CLOSED, CANCELLED, RESOLVED
404: Illegal ticket SLA status entered. Permitted values are: NA, OK, WARNING, ALERT, ESCALATION
404: Illegal ticket priority entered. Permitted values are: LOW, NORMAL, HIGH, CRITICAL
404: Illegal ticket expiration date entered. Permitted date format is: ddMMyyyy (ex. 20.11.2001)
404: No entity found for query","folder":"2-23"},{"headers":"Accept: application/json\n","name":"Get server clone policy verifier results","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/clone_server_policy/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.
404: Verifier results were not found in the server clone policy request.","dataMode":"params","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/clone_server_policy/verifier","collectionId":"2","id":"2-23-143","method":"GET"},{"headers":"Accept: application/json\n","name":"Returns the details of a specified ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
expand_links: See expanded view of the objects [optional]
showStepsDetails: Include steps' details in the response [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1
OUTPUT {
    \"ticket\": {
        \"id\": 1,
        \"subject\": \"AR-Ticket\",
        \"requester\": \"a\",
        \"requester_id\": 4,
        \"priority\": \"Normal\",
        \"status\": \"In Progress\",
        \"domain_name\": \"\",
        \"sla_status\": \"NA\",
        \"sla_outcome\": \"NA\",
        \"workflow\": {
            \"id\": 11,
            \"name\": \"AR & MG\",
            \"uses_topology\": true
        },
        \"steps\": {
            \"step\": [
                {
                    \"id\": 209,
                    \"name\": \"Open request\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 209,
                            \"assignee_id\": 4,
                            \"assignee\": \"a\",
                            \"status\": \"DONE\",
                            \"fields\": {
                                \"field\": [
                                    {
                                        \"@xsi.type\": \"multi_access_request\",
                                        \"id\": 1695,
                                        \"name\": \"AR\",
                                        \"read_only\": false,
                                        \"access_request\": {
                                            \"id\": 1706,
                                            \"order\": \"AR1\",
                                            \"risk_analysis_result\": {
                                                \"status\": \"not run\"
                                            },
                                            \"verifier_result\": {
                                                \"status\": \"not run\"
                                            },
                                            \"use_topology\": true,
                                            \"targets\": {
                                                \"target\": {
                                                    \"@type\": \"ANY\",
                                                    \"id\": 1705
                                                }
                                            },
                                            \"users\": {
                                                \"user\": [
                                                    \"Any\"
                                                ]
                                            },
                                            \"sources\": {
                                                \"source\": [
                                                    {
                                                        \"@type\": \"INTERNET\",
                                                        \"id\": 1701
                                                    },
                                                    {
                                                        \"@type\": \"DNS\",
                                                        \"id\": 1702,
                                                        \"host_name\": \"www.google.com\",
                                                        \"dns_ip_addresses\": {
                                                            \"ip_address\": \"216.58.214.100\"
                                                        }
                                                    },
                                                    {
                                                        \"@type\": \"IP\",
                                                        \"id\": 1703,
                                                        \"ip_address\": \"1.1.1.1\",
                                                        \"netmask\": \"255.255.255.255\",
                                                        \"nat_ip_address\": \"4.4.4.4\",
                                                        \"nat_netmask\": \"255.255.255.255\"
                                                    }
                                                ]
                                            },
                                            \"destinations\": {
                                                \"destination\": [
                                                    {
                                                        \"@type\": \"ANY\",
                                                        \"id\": 1697
                                                    }
                                                ]
                                            },
                                            \"services\": {
                                                \"service\": [
                                                    {
                                                        \"@type\": \"ANY\",
                                                        \"id\": 1699
                                                    }
                                                ]
                                            },
                                            \"action\": \"Accept\",
                                            \"labels\": \"\"
                                        }
                                    },
                                    {
                                        \"@xsi.type\": \"multi_group_change\",
                                        \"id\": 1707,
                                        \"name\": \"MG\",
                                        \"read_only\": false,
                                        \"implementation_status\": \"NOT_SUPPORTED\"
                                    }
                                ]
                            }
                        }
                    }
                },
                {
                    \"id\": 210,
                    \"name\": \"STEP2 - auto AR with designer /update /commit\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 210,
                            \"assignee_id\": 4,
                            \"assignee\": \"a\",
                            \"status\": \"ASSIGNED\",
                            \"unlicensed_devices_for_automation\": {
                                \"unlicensed_device_for_automation\": [
                                    {
                                        \"id\": \"2\",
                                        \"name\": \"asa\"
                                    }
                                ]
                            }
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"multi_access_request\",
                                    \"id\": 1709,
                                    \"name\": \"AR\",
                                    \"read_only\": false,
                                    \"access_request\": {
                                        \"id\": 1720,
                                        \"order\": \"AR1\",
                                        \"risk_analysis_result\": {
                                            \"status\": \"not run\"
                                        },
                                        \"verifier_result\": {
                                            \"status\": \"not run\"
                                        },
                                        \"use_topology\": true,
                                        \"targets\": {
                                            \"target\": {
                                                \"@type\": \"ANY\",
                                                \"id\": 1719
                                            }
                                        },
                                        \"users\": {
                                            \"user\": [
                                                \"Any\"
                                            ]
                                        },
                                        \"sources\": {
                                            \"source\": [
                                                {
                                                    \"@type\": \"INTERNET\",
                                                    \"id\": 1721
                                                },
                                                {
                                                    \"@type\": \"DNS\",
                                                    \"id\": 1722,
                                                    \"host_name\": \"www.google.com\",
                                                    \"dns_ip_addresses\": {
                                                        \"ip_address\": \"216.58.214.100\"
                                                    }
                                                },
                                                {
                                                    \"@type\": \"IP\",
                                                    \"id\": 1723,
                                                    \"ip_address\": \"1.1.1.1\",
                                                    \"netmask\": \"255.255.255.255\",
                                                    \"nat_ip_address\": \"4.4.4.4\",
                                                    \"nat_netmask\": \"255.255.255.255\"
                                                },
                                                {
                                                    \"@type\": \"RANGE\",
                                                    \"id\": 1724,
                                                    \"range_first_ip\": \"1.1.11.1\",
                                                    \"range_last_ip\": \"1.1.11.10\"
                                                }
                                            ]
                                        },
                                        \"destinations\": {
                                            \"destination\": [
                                                {
                                                    \"@type\": \"ANY\",
                                                    \"id\": 1711
                                                }
                                            ]
                                        },
                                        \"services\": {
                                            \"service\": [
                                                {
                                                    \"@type\": \"ANY\",
                                                    \"id\": 1713
                                                }
                                            ]
                                        },
                                        \"action\": \"Accept\",
                                        \"labels\": \"\"
                                    }
                                }
                            }
                        }
                    }
                }
            ]
        },
        \"current_step\": {
            \"id\": 210,
            \"name\": \"STEP2 - auto AR with designer /update /commit\"
        },
        \"comments\": \"\"
    }
}


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2
OUTPUT {
    \"ticket\": {
        \"id\": 2,
        \"subject\": \"Clone Server Policy Ticket\",
        \"requester\": \"a\",
        \"requester_id\": 12,
        \"priority\": \"Normal\",
        \"status\": \"In Progress\",
        \"domain_name\": \"\",
        \"sla_status\": \"NA\",
        \"sla_outcome\": \"NA\",
        \"workflow\": {
            \"id\": 109,
            \"name\": \"sc_12705\",
            \"uses_topology\": false
        },
        \"steps\": {
            \"step\": [
                {
                    \"id\": 78,
                    \"name\": \"Open request\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 78,
                            \"assignee_id\": 12,
                            \"assignee\": \"a\",
                            \"status\": \"DONE\",
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"clone_server_policy_request\",
                                    \"id\": 872,
                                    \"name\": \"Clone Server Policy Field\",
                                    \"from_server\": {
                                        \"@type\": \"IP\",
                                        \"id\": 869,
                                        \"ip_address\": \"1.2.2.2\",
                                        \"cidr\": 32
                                    },
                                    \"to_servers\": {
                                        \"server\": {
                                            \"@type\": \"IP\",
                                            \"id\": 871,
                                            \"ip_address\": \"10.100.23.32\",
                                            \"netmask\": \"255.255.255.255\",
                                            \"cidr\": 32
                                        }
                                    },
                                    \"comment\": \"target servers to clone server policy to\"
                                }
                            }
                        }
                    }
                },
                {
                    \"id\": 79,
                    \"name\": \"Business Approval\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 79,
                            \"assignee_id\": 12,
                            \"assignee\": \"a\",
                            \"status\": \"ASSIGNED\",
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"clone_server_policy_request\",
                                    \"id\": 876,
                                    \"name\": \"Clone Server Policy Field\",
                                    \"from_server\": {
                                        \"@type\": \"IP\",
                                        \"id\": 873,
                                        \"ip_address\": \"1.2.2.2\",
                                        \"cidr\": 32
                                    },
                                    \"to_servers\": {
                                        \"server\": {
                                            \"@type\": \"IP\",
                                            \"id\": 875,
                                            \"ip_address\": \"10.100.23.32\",
                                            \"netmask\": \"255.255.255.255\",
                                            \"cidr\": 32
                                        }
                                    },
                                    \"comment\": \"target servers to clone server policy to\"
                                }
                            }
                        }
                    }
                }
            ]
        },
        \"current_step\": {
            \"id\": 79,
            \"name\": \"Business Approval\"
        },
        \"comments\": \"\"
    }
}


Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: No entity found for query","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}","collectionId":"2","id":"2-23-144","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Submit a new ticket to Secure Change","dataMode":"raw","description":" GENERAL USE
When posting a Modify Group ticket, group scope must be configured for FortiManager advanced and Juniper SRX devices.
Juniper SRX devices:
Global address-book will be used unless an existing address-book is given.
Ticket validation will fail in case given Address Book is not configured on the device.
FortiManager advanced devices:
'Any' zone will be used unless an existing zone is given.
Ticket validation will fail in case given zone is not configured on the device.
*Note: Zones and address-books must not be configured for other devices.

Using newly created objects from a different group in the same ticket
The user can add a newly created object from a different group to the selected group, with object_UID equal to the name of the newly created object.
For management devices with hierarchies, the newly created object does not populate other levels of the hierarchies.

Permitted values for @type
Allowed values for @type property included in DestinationDTO and SourceDTO are:
ANY
IP
DNS
Object - Device's existing object
INTERNET
LDAP (SourceDTO only) - LDAP entity

To use a service object in a new request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id
2. Both object_name and management_name

To use a network object in a new request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both object_UID and object_name are defined, object_UID takes precedence over object_name

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: ticketDTO
closed: Cannot be done from the API [optional]
count [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY<ticket>
    <subject>topology mode_AR1-with topology_AR2-no topology</subject>
    <requester>u1</requester>
    <priority>Normal</priority>
    <domain_name>Default</domain_name>
    <workflow>
         <id>7</id>
         <name>Workflow with topology</name>
    </workflow>
    <steps>
         <step>
             <name>Open request</name>
             <tasks>
                 <task>
                     <fields>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_access_request\">
                             <name>Required Access</name>
                             <access_request>
                                 <use_topology>true</use_topology>
                                 <targets>
                                     <target type=\"Object\">
                                         <object_name>ASA</object_name>
                                         <management_name>ASA</management_name>
                                     </target>
                                 </targets>
                                 <users>
                                     <user>Any</user>
                                 </users>
                                 <sources>
                                     <source type=\"Object\">
                                         <object_name>host_10.100.10.140</object_name>
                                         <management_name>NetScreen</management_name>
                                     </source>
                                 <sources>
                                     <source type=\"Object\">
                                         <object_UID>{55908141-c341-4990-9cc6-a3fd2dfb49e1}</object_UID>
                                         <management_id>13</management_id>
                                     </source>
                                 </sources>
                                 <destinations>
                                     <destination type=\"Object\">
                                         <object_name>h_10.10.10.10</object_name>
                                         <management_name>ASA</management_name>
                                     </destination>
                                 </destinations>
                                 <services>
                                     <service type=\"PROTOCOL\">
                                         <protocol>TCP</protocol>
                                         <port>80</port>
                                     </service>
                                     <service type=\"APPLICATION_IDENTITY\">
                                         <application_name>Gmail</application_name>
                                     </service>
                                 </services>
                                 <action>Accept</action>
                                 <labels/>
                             </access_request>
                             <access_request>
                                 <use_topology>false</use_topology>
                                 <targets>
                                     <target type=\"Object\">
                                         <object_name>inside_access_in</object_name>
                                         <management_name>ASA</management_name>
                                     </target>
                                 </targets>
                                 <users>
                                     <user>Any</user>
                                 </users>
                                 <sources>
                                     <source type=\"Object\">
                                         <object_name>1.1.1.0</object_name>
                                         <management_name>NetScreen</management_name>
                                     </source>
                                 </sources>
                                 <destinations>
                                     <destination type=\"Object\">
                                         <object_name>network_regi3</object_name>
                                         <management_name>ASA</management_name>
                                     </destination>
                                 </destinations>
                                 <services>
                                     <service type=\"ANY\">
                                     </service>
                                 </services>
                                 <action>Accept</action>
                                 <labels/>
                             </access_request>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_area\">
                             <name>Business Justification</name>
                             <text>I need access to ftp </text>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_field\">
                             <name>Project Number</name>
                             <text>CR124560 </text>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"hyperlink\">
                             <name>Hyperlink</name>
                             <url>http://192.168.1.1/ticket</url>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"drop_down_list\">
                             <name>Change Window</name>
                             <selection>Monday</selection>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"manager\">
                             <name>manager email</name>
                             <text>manager@tufin.com</text>
                         </field>
                     </fields>
                 </task>
             </tasks>
        </step>
    </steps>
    <comments/>
</ticket>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY<ticket>
    <subject>New MG ticket</subject>
    <requester>a</requester>
    <requester_id>4</requester_id>
    <priority>Normal</priority>
    <status>In Progress</status>
    <domain_name/>
    <sla_status>NA</sla_status>
    <sla_outcome>NA</sla_outcome>
    <workflow>
        <id>6</id>
        <name>MG</name>
        <uses_topology>false</uses_topology>
    </workflow>
    <steps>
        <step>
            <id>72</id>
            <name>New step</name>
            <redone>false</redone>
            <skipped>false</skipped>
            <tasks>
                <task>
                    <id>72</id>
                    <assignee_id>4</assignee_id>
                    <assignee>a</assignee>
                    <status>ASSIGNED</status>
                    <fields>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_group_change\">
                            <id>262</id>
                            <name>MG</name>
                            <read_only>false</read_only>
                            <implementation_status>NOT_SUPPORTED</implementation_status>
                            <group_change>
                                <name>ExistingGroup</name>
                                <object_UID>{c862fb6f-1314-45da-9e01-56c9b85d001d}</object_UID>
                                <management_id>58</management_id>
                                <management_name>FMG/root</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>157</id>
                                        <name>10.100 net</name>
                                        <object_UID>{37cdc055-7aac-4385-b46b-cc54d95e4b6d}</object_UID>
                                        <object_type>Network</object_type>
                                        <object_details>10.100.0.0/255.255.0.0</object_details>
                                        <management_id>58</management_id>
                                        <management_name>FMG/root</management_name>
                                        <status>NOT_CHANGED</status>
                                        <object_updated_status>EXISTING_EDITED</object_updated_status>
                                        <comment>new_comment</comment>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                                <zone>
                                    <is_global>true</is_global>
                                    <name>any</name>
                                </zone>
                            </group_change>
                            <group_change>
                                <name>78.45.12.0</name>
                                <object_UID>{cac64d34-a05e-4a05-b271-64642eb976ff}</object_UID>
                                <management_id>28</management_id>
                                <management_name>SRX-root-lsys</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>158</id>
                                        <name>78.45.12.1</name>
                                        <object_UID>{7912c335-6dbe-47de-b872-1322f9015b2f}</object_UID>
                                        <object_type>Host</object_type>
                                        <object_details>78.45.12.1/255.255.255.255</object_details>
                                        <management_id>28</management_id>
                                        <management_name>SRX-root-lsys</management_name>
                                        <status>NOT_CHANGED</status>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                                <address_book>
                                    <name>global</name>
                                </address_book>
                            </group_change>
                            <group_change>
                                <name>10.10.0.0/16</name>
                                <object_UID>{5dff0bd8-51e4-4a83-8138-d54dd18ca52b}</object_UID>
                                <management_id>24</management_id>
                                <management_name>NSX-Distributed Firewall</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>161</id>
                                        <name>10.10.0.0/16</name>
                                        <object_UID>{5d7b826c-f053-40fd-81bd-7a6f44cf15ef}</object_UID>
                                        <object_type>Network</object_type>
                                        <object_details>10.10.0.0/255.255.0.0</object_details>
                                        <management_id>24</management_id>
                                        <management_name>NSX-Distributed Firewall</management_name>
                                        <status>NOT_CHANGED</status>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                            </group_change>
                        </field>
                    </fields>
                </task>
            </tasks>
        </step>
    </steps>
</ticket>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY<ticket>
    <subject>test API</subject>
    <requester>a</requester>
    <requester_id>4</requester_id>
    <priority>Normal</priority>
    <domain_name/>
    <sla_status>NA</sla_status>
    <sla_outcome>NA</sla_outcome>
    <workflow>
        <id>8</id>
        <name>Modify group</name>
        <uses_topology>false</uses_topology>
    </workflow>
    <steps>
        <step>
            <id>11</id>
            <name>Open request</name>
            <redone>false</redone>
            <skipped>false</skipped>
            <tasks>
                <task>
                    <id>11</id>
                    <assignee_id>4</assignee_id>
                    <assignee>a</assignee>                    <status>DONE</status>
                    <fields>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_group_change\">
                            <id>137</id>
                            <name>ff</name>
                            <read_only>false</read_only>
                            <implementation_status>NOT_SUPPORTED</implementation_status>
                            <group_change>
                                <name>port1Group</name>
                                <object_UID>{d5b4459b-6b27-4012-9924-b244c250520f}</object_UID>
                                <management_id>64</management_id>
                                <management_name>10.100.111.8/ADOM_5_2</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"HOST\">
                                        <id>69</id>
                                        <name>obj_1</name>
                                        <object_UID>obj_1</object_UID>
                                        <object_type>Host</object_type>
                                        <object_details>6.6.6.6/255.255.255.255</object_details>
                                        <management_id>64</management_id>
                                        <status>ADDED</status>
                                        <comment/>
                                        <object_updated_status>NEW</object_updated_status>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                            </group_change>
                            <group_change>
                                <name>gfd</name>
                                <management_id>64</management_id>
                                <management_name>10.100.111.8/ADOM_5_2</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>70</id>
                                        <name>obj_1</name>
                                        <object_UID>obj_1</object_UID>
                                        <object_type>Host</object_type>
                                        <object_details>6.6.6.6/255.255.255.255</object_details>
                                        <management_id>64</management_id>
                                        <management_name>10.100.111.8/ADOM_5_2</management_name>
                                        <status>ADDED</status>
                                        <object_updated_status>EXISTING_NOT_EDITED</object_updated_status>
                                    </member>
                                </members>
                                <change_action>CREATE</change_action>
                                <zone>
                                    <is_global>true</is_global>
                                    <name>any</name>
                                </zone>
                            </group_change>
                        </field>
                    </fields>
                </task>
            </tasks>
        </step>
    </steps>
    <current_step>
        <id>12</id>
        <name>Copy of Open request</name>
    </current_step>
    <comments/>
</ticket>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY{
    \"ticket\": {
        \"application_details\": { \"id\": \"1\" },
        \"subject\": \"topology mode_AR1-with topology_AR2-no topology\",
        \"priority\": \"Normal\",
        \"workflow\": { \"name\": \"ar\" }
    }
}


Response Messages:
400: Application ID is missing.
400: Create closed ticket is enabled only from SecureApp application.
400: The application was already deleted.
400: The requester must be the currently logged in user.
400: Workflow was not found.
400: Workflow is not active.
400: Workflow configuration is not valid.
400: Workflow is not set
400: You cannot enter a status for a new ticket.
400: Requester cannot open a ticket in domain.
400: Invalid ticket priority.
400: You cannot open a new ticket with an empty subject.
400: Expiration field is required.
400: Submit ticket enabled only with the first step
400: First step can be only with one task
400: The specified workflow does not contain an access request field in the first step.
400: There are no changed connections that are ready for creating a ticket.
400: You cannot use an access request field to create a ticket from SecureApp.
400: The ticket fields do not match the fields in the current step of the workflow.
400: You cannot change the value of a field because it is read-only.
400: Managed tasks are not initialized or done
400: Application Change field cannot be managed via this REST API
400: Invalid value for field: <FIELD_NAME> (Rule Modification workflow is not supported for this device)
401: You do not have permissions to edit this application.
401: Logged in user: NAME do not have permission to perform on behalf actions
401: You are not a participant in the first step of this workflow
401: UNAUTHORIZED
404: There is no application with the specified ID
400: Invalid value for field: <FIELD_NAME> (Device ID is required for an existing device network object)
400: Invalid value for field: <FIELD_NAME> (ST UID is required for an existing device network object
400: Invalid value for field: <FIELD_NAME> (Network Object with device ID <DEVICE_ID> and ST UID <ST_UID> is not available for the action specified. Check the Knowledge Center or API Implementation Notes for more information
400: Status is required for a device network object","folder":"2-23","rawModeData":"{\n\t\"ticket\": {\n\t\t\"application_details\": { \"id\": \"1\" },\n\t\t\"subject\": \"topology mode_AR1-with topology_AR2-no topology\",\n\t\t\"priority\": \"Normal\",\n\t\t\"workflow\": { \"name\": \"ar\" }\n\t}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/","collectionId":"2","id":"2-23-145","method":"POST"},{"headers":"Accept: application/json\n","collectionId":"2","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/","name":"Returns the details of a specified tickets (max 100 tickets in a single query)","method":"GET","id":"2-23-146","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
status: The status of the tickets [optional]
count: Tickets list max pagination length (max value is 100) [optional]
start: Offset the count starting point [optional]
desc: Get the list in descending order [optional]
expand_links: See expanded view of the objects [optional]
showStepsDetails: Include steps' details in the response [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets?status=In Progress&count=10&start=3&expand_links=false

Response Messages:
400: Status is not a valid. The valid values are: TICKET_STATUSES
400: Can not fetch more than 100 tickets in 1 time
401: Access is denied","folder":"2-23"},{"headers":"Accept: application/json\n","collectionId":"2","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/search","name":"Returns a list of tickets by search parameters","method":"GET","id":"2-23-147","description":"If the query is succesful but no results are found (for example, if there is no ticket for the specified Ticket ID) then the return code will be 200 and the results will be empty.

Parameters:
id: The ID number of the ticket as shown in SecureChange [optional]
subject: The subject of the ticket [optional]
requester: The requester of the ticket [optional]
group: The group handling the ticket [optional]
assigned_to: The user name of the person assigned to the ticket [optional]
priority: The priority of the ticket [optional]
status: The status of the ticket [optional]
sla_status: The SLA status of the ticket [optional]
field_name: Field name to search by [optional]
field_value: Field value to search by [optional]
current_step: Current step name [optional]
expiration_date_from: Search requests with expiration date from this date [optional]
expiration_date_to: Search requests with expiration date until this date [optional]
domain_name: The Domain of the ticket [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/search?id=1&status=IN_PROGRESS,REJECTED

Response Messages:
401: Access is denied.
400: Illegal ticket status entered. Permitted values are: IN_PROGRESS, REJECTED, CLOSED, CANCELLED, RESOLVED, WAITING_TO_BE_ASSIGNED, ASSIGNED, WAITING_FOR_MORE_INFO, DONE, INVALID, PENDING, PENDING_LICENS
400: Illegal ticket SLA status entered. Permitted values are: NA, OK, WARNING, ALERT, ESCALATION
400: Illegal ticket priority entered. Permitted values are: LOW, NORMAL, HIGH, CRITICAL
400: Illegal ticket expiration date entered. Permitted date format is: ddMMyyyy (ex. 20.11.2001)
400: Cannot find specified domain <DOMAIN_NAME>","folder":"2-23"},{"name":"Returns topology map image (png file) for specific verifier results","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/multi_access_request/2022/verifier/topology_map

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.
404: Verifier results were not found in the access request.
404: Toplogy map was not found for this field.","dataMode":"params","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_access_request/{{fieldId}}/verifier/topology_map","collectionId":"2","id":"2-23-148","method":"GET"},{"headers":"Accept: application/json\n","name":"Get access request verifier results","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/multi_access_request/2022/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.
404: Verifier results were not found in the access request.","dataMode":"params","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_access_request/{{fieldId}}/verifier","collectionId":"2","id":"2-23-149","method":"GET"},{"headers":"Accept: application/json\n","name":"Returns the details of a specified task","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"params","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
taskId: The ID number of the task as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2?expand_links=true

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.
404: Task with ID was not found in Stage ID in ticket ID .","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}","collectionId":"2","id":"2-23-150","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Change a task of a ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"raw","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both object_UID and object_name are defined, object_UID takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: ticketTaskDTO
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/2/tasks/4
BODY<task>
     <status>ASSIGNED</status>
     <fields>
         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_group_change\">
             <id>7599</id>
             <name>mf</name>
             <read_only>false</read_only>
             <implementation_status>NOT_STARTED</implementation_status>
             <group_change>
                        <name>ggg</name>
                        <object_UID>{A12AE330-0DBD-11E5-B841-7F0000010E0E}</object_UID>
                        <management_id>42</management_id>
                        <management_name>cp239</management_name>
                        <members>
                             <member type=\"Object\">
                                 <id>8</id>
                                 <name>yaakovs_host</name>
                                 <object_UID>{BDAA378C-C90B-4D12-B598-1AFED2D1DA14}</object_UID>
                                 <object_type>Host</object_type>
                                 <object_details>1.1.1.1/255.255.255.255</object_details>
                         <management_id>42</management_id>
                         <management_name>cp239</management_name>
                                 <status>NOT_CHANGED</status>
                             </member>
                             <member type=\"Object\">
                                 <id>9</id>
                                    <name>Avi_10.100.120.254</name>
                                    <object_UID>{8F195CDC-F426-47B6-9E8A-1FF14C17E54F}</object_UID>
                                     <object_type>Host</object_type>
                                     <object_details>10.100.120.254/255.255.255.255</object_details>
                                     <management_id>42</management_id>
                                     <management_name>cp239</management_name>
                                     <status>NOT_CHANGED</status>
                                 </member>
                                 <member type=\"HOST\">
                                     <id>10</id>
                                     <name>h22</name>
                                     <object_type>Host</object_type>
                                     <object_details>2.2.2.2/255.255.255.255</object_details>
                                     <status>ADDED</status>
                                     <comment/>
                                 </member>
                                 <member type=\"HOST\">
                                     <id>10</id>
                                     <name>h22</name>
                                     <object_type>Host</object_type>
                                     <object_details>3.3.3.3/255.255.255.255</object_details>
                                     <status>ADDED</status>
                                     <comment/>
                                 </member>
                 </members>
                 <change_implementation_status>NOT_RUN</change_implementation_status>
                    </group_change>
            </field>
     </fields>
</task>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/
BODY{
    \"task\": {
        \"id\": 4,
        \"assignee_id\": 4,
        \"assignee\": \"a\",
        \"status\": \"ASSIGNED\",
        \"fields\": {
            \"field\": {
                \"@xsi.type\": \"rule_modification_field\",
                \"id\": 71,
                \"name\": \"Fire Wall Rule\",
                \"read_only\": false,
                \"devices\": {
                    \"device\": {
                        \"revision_id\": 4,
                        \"management_name\": \"Panorama/DG_1\",
                        \"management_id\": 4,
                        \"management_ip\": \"10.100.111.120\",
                        \"revision_number\": 1,
                        \"number_of_rules\": 1,
                        \"bindings\": {
                            \"binding\": {
                                \"binding_uid\": \"{00-FACED0-00}\",
                                \"binding\": {
                                    \"@xsi.type\": \"policy__binding\",
                                    \"policy_name\": \"Standard\"
                                },
                                \"rules\": {
                                    \"rule\": {
                                        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                        \"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",
                                        \"name\": \"Application test\",
                                        \"is_disabled\": false,
                                        \"ruleNumber\": 13,
                                        \"from_zone\": \"any\",
                                        \"to_zone\": \"any\",
                                        \"sourceNetworks\": {
                                            \"@xsi.type\": \"host_network_object\",
                                            \"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",
                                            \"name\": \"H_5.3.2.5\",
                                            \"display_name\": \"H_5.3.2.5\",
                                            \"class_name\": \"host_plain\",
                                            \"origin\": \"DEVICE\",
                                            \"global\": false,
                                            \"implicit\": false,
                                            \"shared\": false,
                                            \"comment\": \"comment\",
                                            \"id\": \"5df1f2a5e9023c311ae4a01a\",
                                            \"version_id\": 4,
                                            \"device_type\": \"PaloAltoNetworks\",
                                            \"ip_type\": \"IPV4\",
                                            \"referenced\": \"UNKNOWN\",
                                            \"installable_target\": false,
                                            \"ip\": \"5.3.2.5\",
                                            \"subnet_mask\": \"255.255.255.255\"
                                        },
                                        \"destinationNetworks\": {
                                            \"@xsi.type\": \"host_network_object\",
                                            \"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",
                                            \"name\": \"22.22.2.2\",
                                            \"display_name\": \"22.22.2.2\",
                                            \"class_name\": \"host_plain\",
                                            \"origin\": \"DEVICE\",
                                            \"global\": false,
                                            \"implicit\": false,
                                            \"shared\": false,
                                            \"comment\": \"\",
                                            \"id\": \"5df1f2a5e9023c311ae4a016\",
                                            \"version_id\": 4,
                                            \"device_type\": \"PaloAltoNetworks\",
                                            \"ip_type\": \"IPV4\",
                                            \"referenced\": \"UNKNOWN\",
                                            \"installable_target\": false,
                                            \"ip\": \"22.22.2.2\",
                                            \"subnet_mask\": \"255.255.255.255\"
                                        },
                                        \"destinationServices\": {
                                            \"@xsi.type\": \"transport_service\",
                                            \"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",
                                            \"name\": \"TCP82\",
                                            \"display_name\": \"TCP82\",
                                            \"class_name\": \"tcp_service\",
                                            \"origin\": \"DEVICE\",
                                            \"global\": false,
                                            \"implicit\": false,
                                            \"shared\": false,
                                            \"comment\": \"TCP82\",
                                            \"id\": \"5df1f2a5e9023c311ae4a018\",
                                            \"version_id\": 4,
                                            \"referenced\": \"UNKNOWN\",
                                            \"type_on_device\": \"\",
                                            \"negate\": false,
                                            \"match_for_any\": false,
                                            \"timeout\": 0,
                                            \"protocol\": 6,
                                            \"min_port\": 82,
                                            \"max_port\": 82
                                        },
                                        \"applications\": {
                                            \"@xsi.type\": \"single_application\",
                                            \"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",
                                            \"name\": \"web-browsing\",
                                            \"display_name\": \"web-browsing\",
                                            \"class_name\": \"application_object\",
                                            \"origin\": \"DEVICE_PREDEFINED\",
                                            \"global\": true,
                                            \"implicit\": false,
                                            \"shared\": false,
                                            \"comment\": \"\",
                                            \"service\": [
                                                {
                                                    \"@xsi.type\": \"transport_service\",
                                                    \"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",
                                                    \"name\": \"st_implicit_app_web-browsing\",
                                                    \"display_name\": \"st_implicit_app_web-browsing\",
                                                    \"class_name\": \"tcp_service\",
                                                    \"origin\": \"DEVICE\",
                                                    \"global\": false,
                                                    \"implicit\": true,
                                                    \"shared\": false,
                                                    \"comment\": \"\",
                                                    \"id\": \"5df1f2a5e9023c311ae4a014\",
                                                    \"version_id\": 4,
                                                    \"referenced\": \"UNKNOWN\",
                                                    \"type_on_device\": \"\",
                                                    \"negate\": false,
                                                    \"match_for_any\": false,
                                                    \"timeout\": 0,
                                                    \"protocol\": 6,
                                                    \"min_port\": 80,
                                                    \"max_port\": 80
                                                }
                                            ]
                                        },
                                        \"action\": \"ACCEPT\",
                                        \"additional_parameters\": \"\",
                                        \"options\": {
                                            \"option\": \"LOG_SESSION\"
                                        },
                                        \"rule_location\": \"DG_1\",
                                        \"users\": {
                                            \"user\": [
                                                {
                                                    \"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",
                                                    \"name\": \"Any\",
                                                    \"class_name\": \"any_object\",
                                                    \"displayName\": \"Any\"
                                                }
                                            ]
                                        },
                                        \"track\": {
                                            \"track_level\": \"LOG\"
                                        },
                                        \"install_ons\": \"\",
                                        \"communities\": \"\",
                                        \"times\": \"\",
                                        \"rule_metadata\": {
                                            \"permissiveness_level\": \"LOW\",
                                            \"violations\": \"\",
                                            \"last_hit\": \"No hits\",
                                            \"shadowed_status\": \"FALSE\",
                                            \"ticket_ids\": \"\",
                                            \"business_owners\": \"\",
                                            \"expirations\": \"\",
                                            \"applications\": \"\",
                                            \"last_modified\": \"Today\"
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                \"rule_modifications\": {
                    \"rule_modification\": {
                        \"@xsi.type\": \"modify_rule_modification\",
                        \"id\": 13,
                        \"rule_key\": {
                            \"device_id\": 4,
                            \"binding_uid\": \"{00-FACED0-00}\",
                            \"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"
                        },
                        \"source_modifications\": {
                            \"id\": 26,
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"id\": 89,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 88,
                                            \"uid\": \"e7e4ac52-2fe4-49f7-8071-9638817a7434\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"id\": 88,
                                                    \"name\": \"My New Host\",
                                                    \"comment\": \"some comment\",
                                                    \"ip\": \"192.168.0.10\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 91,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 89,
                                            \"uid\": \"13556e3e-1f93-4f95-939c-428a58001615\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                    \"id\": 89,
                                                    \"name\": \"My New Address Ragne\",
                                                    \"comment\": \"some comment\",
                                                    \"min_ip\": \"192.168.0.1\",
                                                    \"max_ip\": \"192.168.0.254\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 90,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 87,
                                            \"uid\": \"1ecb9679-4da4-4fc5-9382-00f5fa455295\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                    \"id\": 87,
                                                    \"name\": \"My New Network\",
                                                    \"comment\": \"some comment\",
                                                    \"ip\": \"192.168.0.0\",
                                                    \"netmask\": \"255.255.255.0\"
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        },
                        \"destination_modifications\": {
                            \"id\": 25,
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"id\": 88,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 91,
                                            \"uid\": \"50f35caf-3f13-4961-9ccd-055e1703592a\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"id\": 91,
                                                    \"name\": \"Host_10.10.10.10\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"10.10.10.10\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 85,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 90,
                                            \"uid\": \"21342c9a-3974-4bd3-b74b-b142e43ed39a\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                    \"id\": 90,
                                                    \"name\": \"Range-Test\",
                                                    \"comment\": \"\",
                                                    \"min_ip\": \"1.1.2.0\",
                                                    \"max_ip\": \"1.1.2.55\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 86,
                                        \"action\": \"REMOVE\",
                                        \"device_network_object\": {
                                            \"id\": 86,
                                            \"uid\": \"8fff4c36-da34-4945-be33-ffd5d4d444e2\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"id\": 86,
                                                    \"name\": \"22.22.2.2\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"22.22.2.2\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 87,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 85,
                                            \"uid\": \"35ec73ed-e0fa-4690-9570-00b417b63ae6\",
                                            \"device_id\": 2,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                    \"id\": 85,
                                                    \"name\": \"Net_10.108.151.0\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"10.108.151.0\",
                                                    \"netmask\": \"255.255.255.0\"
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        }
                    }
                },
                \"designer_result\": {
                    \"status\": \"not run\"
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket step does not exist, or is not the current step
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Task status does not exist.
400: Task status is not set to ASSIGNED or DONE.
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: The new network object (<name>): device ID (<id>) does not match the rule key device ID (<id>). The device IDs must be the same.
400: Device ID is required for a new device network object
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <name>
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <st_uid>
400: <cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty.
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
403: Task can not be done because there are unlicensed devices for change automation
400: Invalid value for field: <FIELD_NAME> (Device ID is required for an existing device network object)
400: Invalid value for field: <FIELD_NAME> (ST UID is required for an existing device network object
400: Invalid value for field: <FIELD_NAME> (Network Object with device ID <DEVICE_ID> and ST UID <ST_UID> is not available for the action specified. Check the Knowledge Center or API Implementation Notes for more information
400: Status is required for a device network object","folder":"2-23","rawModeData":"{\n\t\"task\": {\n\t\t\"id\": 4,\n\t\t\"assignee_id\": 4,\n\t\t\"assignee\": \"a\",\n\t\t\"status\": \"ASSIGNED\",\n\t\t\"fields\": {\n\t\t\t\"field\": {\n\t\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\t\"id\": 71,\n\t\t\t\t\"name\": \"Fire Wall Rule\",\n\t\t\t\t\"read_only\": false,\n\t\t\t\t\"devices\": {\n\t\t\t\t\t\"device\": {\n\t\t\t\t\t\t\"revision_id\": 4,\n\t\t\t\t\t\t\"management_name\": \"Panorama/DG_1\",\n\t\t\t\t\t\t\"management_id\": 4,\n\t\t\t\t\t\t\"management_ip\": \"10.100.111.120\",\n\t\t\t\t\t\t\"revision_number\": 1,\n\t\t\t\t\t\t\"number_of_rules\": 1,\n\t\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\t\"policy_name\": \"Standard\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"Application test\",\n\t\t\t\t\t\t\t\t\t\t\"is_disabled\": false,\n\t\t\t\t\t\t\t\t\t\t\"ruleNumber\": 13,\n\t\t\t\t\t\t\t\t\t\t\"from_zone\": \"any\",\n\t\t\t\t\t\t\t\t\t\t\"to_zone\": \"any\",\n\t\t\t\t\t\t\t\t\t\t\"sourceNetworks\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"comment\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a01a\",\n\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"destinationNetworks\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a016\",\n\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"destinationServices\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a018\",\n\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\t\"min_port\": 82,\n\t\t\t\t\t\t\t\t\t\t\t\"max_port\": 82\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"applications\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"single_application\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"application_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE_PREDEFINED\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": true,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"service\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"implicit\": true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a014\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_port\": 80,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_port\": 80\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ACCEPT\",\n\t\t\t\t\t\t\t\t\t\t\"additional_parameters\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"options\": {\n\t\t\t\t\t\t\t\t\t\t\t\"option\": \"LOG_SESSION\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"rule_location\": \"DG_1\",\n\t\t\t\t\t\t\t\t\t\t\"users\": {\n\t\t\t\t\t\t\t\t\t\t\t\"user\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Any\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"any_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"displayName\": \"Any\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"track\": {\n\t\t\t\t\t\t\t\t\t\t\t\"track_level\": \"LOG\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"install_ons\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"communities\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"times\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"rule_metadata\": {\n\t\t\t\t\t\t\t\t\t\t\t\"permissiveness_level\": \"LOW\",\n\t\t\t\t\t\t\t\t\t\t\t\"violations\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"last_hit\": \"No hits\",\n\t\t\t\t\t\t\t\t\t\t\t\"shadowed_status\": \"FALSE\",\n\t\t\t\t\t\t\t\t\t\t\t\"ticket_ids\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"business_owners\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"expirations\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"applications\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"last_modified\": \"Today\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"rule_modifications\": {\n\t\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\t\"id\": 13,\n\t\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\t\"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\t\"id\": 26,\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 89,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 88,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"e7e4ac52-2fe4-49f7-8071-9638817a7434\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 88,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Host\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 91,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 89,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"13556e3e-1f93-4f95-939c-428a58001615\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 89,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Address Ragne\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"192.168.0.1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"192.168.0.254\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 90,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 87,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"1ecb9679-4da4-4fc5-9382-00f5fa455295\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 87,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Network\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\t\"id\": 25,\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 88,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 91,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"50f35caf-3f13-4961-9ccd-055e1703592a\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 91,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host_10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 85,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 90,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"21342c9a-3974-4bd3-b74b-b142e43ed39a\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 90,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Range-Test\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"1.1.2.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"1.1.2.55\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 86,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 86,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"8fff4c36-da34-4945-be33-ffd5d4d444e2\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 86,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 87,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 85,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"35ec73ed-e0fa-4690-9570-00b417b63ae6\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 2,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 85,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Net_10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"designer_result\": {\n\t\t\t\t\t\"status\": \"not run\"\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}","collectionId":"2","id":"2-23-151","method":"PUT"},{"headers":"Accept: application/json\n","name":"Returns the details of the tasks","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"}],"dataMode":"params","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks","collectionId":"2","id":"2-23-152","method":"GET"}],"order":[],"name":"Tufin Tufin SecureChange/SecureApp R19-3-GA","id":"2","description":"Tufin Orchestration Suite - Tufin SecureChange/SecureApp APIs.
For detailed information about the APIs please see the documentation at:
https://your-securetrack-server/securechangeworkflow/apidoc"} \ No newline at end of file diff --git a/Postman Format v1/R19-3 postman collection/securetrack_R19-3-GA.json b/Postman Format v1/R19-3 postman collection/securetrack_R19-3-GA.json new file mode 100644 index 0000000..8e6103a --- /dev/null +++ b/Postman Format v1/R19-3 postman collection/securetrack_R19-3-GA.json @@ -0,0 +1 @@ +{"folders":[{"order":["1-1-1","1-1-2","1-1-3","1-1-4"],"collectionId":"1","name":"Additional Policy Fields","hasRequests":true,"id":"1-1"},{"order":["1-2-5","1-2-6","1-2-7","1-2-8"],"collectionId":"1","name":"Application IDs","hasRequests":true,"id":"1-2"},{"order":["1-3-9","1-3-10"],"collectionId":"1","name":"Change Authorization","hasRequests":true,"id":"1-3"},{"order":["1-4-11","1-4-12","1-4-13"],"collectionId":"1","name":"Change Windows","hasRequests":true,"id":"1-4"},{"order":["1-5-14","1-5-15","1-5-16","1-5-17","1-5-18"],"collectionId":"1","name":"Device Interfaces and Zones","hasRequests":true,"id":"1-5"},{"order":["1-6-19","1-6-20","1-6-21","1-6-22"],"collectionId":"1","name":"Domains","hasRequests":true,"id":"1-6"},{"order":["1-7-23"],"collectionId":"1","name":"General Properties","hasRequests":true,"id":"1-7"},{"order":["1-8-24","1-8-25","1-8-26","1-8-27"],"collectionId":"1","name":"IPsec VPN","hasRequests":true,"id":"1-8"},{"order":["1-9-28","1-9-29","1-9-30","1-9-31","1-9-32"],"collectionId":"1","name":"Internet Objects","hasRequests":true,"id":"1-9"},{"order":["1-10-33","1-10-34","1-10-35","1-10-36"],"collectionId":"1","name":"LDAP","hasRequests":true,"id":"1-10"},{"order":["1-11-37","1-11-38","1-11-39","1-11-40","1-11-41","1-11-42","1-11-43","1-11-44","1-11-45","1-11-46","1-11-47"],"collectionId":"1","name":"Monitored Devices","hasRequests":true,"id":"1-11"},{"order":["1-12-48","1-12-49","1-12-50"],"collectionId":"1","name":"NAT Policies","hasRequests":true,"id":"1-12"},{"order":["1-13-51","1-13-52","1-13-53","1-13-54","1-13-55","1-13-56","1-13-57"],"collectionId":"1","name":"Network Objects","hasRequests":true,"id":"1-13"},{"order":["1-14-58","1-14-59","1-14-60","1-14-61","1-14-62","1-14-63","1-14-64","1-14-65","1-14-66","1-14-67","1-14-68","1-14-69","1-14-70","1-14-71","1-14-72","1-14-73","1-14-74","1-14-75","1-14-76","1-14-77","1-14-78"],"collectionId":"1","name":"Network Topology","hasRequests":true,"id":"1-14"},{"order":["1-15-79","1-15-80","1-15-81"],"collectionId":"1","name":"Network Zone Manager - Patterns","hasRequests":true,"id":"1-15"},{"order":["1-16-82","1-16-83","1-16-84","1-16-85","1-16-86","1-16-87","1-16-88"],"collectionId":"1","name":"Network Zone Manager - Subnets","hasRequests":true,"id":"1-16"},{"order":["1-17-89","1-17-90","1-17-91","1-17-92","1-17-93","1-17-94","1-17-95","1-17-96","1-17-97","1-17-98","1-17-99","1-17-100","1-17-101","1-17-102","1-17-103","1-17-104"],"collectionId":"1","name":"Network Zone Manager - Zones","hasRequests":true,"id":"1-17"},{"order":["1-18-105","1-18-106","1-18-107","1-18-108","1-18-109","1-18-110"],"collectionId":"1","name":"Policies and Sub-Policies","hasRequests":true,"id":"1-18"},{"order":["1-19-111"],"collectionId":"1","name":"Policy Analysis","hasRequests":true,"id":"1-19"},{"order":["1-20-112","1-20-113","1-20-114","1-20-115","1-20-116","1-20-117"],"collectionId":"1","name":"Policy Browser (formerly Rule Documentation)","hasRequests":true,"id":"1-20"},{"order":["1-21-118","1-21-119","1-21-120","1-21-121","1-21-122","1-21-123","1-21-124","1-21-125"],"collectionId":"1","name":"Policy Optimization","hasRequests":true,"id":"1-21"},{"order":["1-22-126","1-22-127","1-22-128"],"collectionId":"1","name":"Revisions","hasRequests":true,"id":"1-22"},{"order":["1-23-129","1-23-130"],"collectionId":"1","name":"Rule Usage","hasRequests":true,"id":"1-23"},{"order":["1-24-131","1-24-132","1-24-133","1-24-134","1-24-135","1-24-136","1-24-137","1-24-138"],"collectionId":"1","name":"Security Rules","hasRequests":true,"id":"1-24"},{"order":["1-25-139","1-25-140","1-25-141","1-25-142","1-25-143","1-25-144","1-25-145"],"collectionId":"1","name":"Services and Ports","hasRequests":true,"id":"1-25"},{"order":["1-26-146","1-26-147","1-26-148"],"collectionId":"1","name":"Time Objects","hasRequests":true,"id":"1-26"},{"order":["1-27-149"],"collectionId":"1","name":"Traffic Policy Matcher","hasRequests":true,"id":"1-27"},{"order":["1-28-150","1-28-151","1-28-152","1-28-153","1-28-154"],"collectionId":"1","name":"Unified Security Policy - Access Request Violations","hasRequests":true,"id":"1-28"},{"order":["1-29-155","1-29-156","1-29-157","1-29-158","1-29-159"],"collectionId":"1","name":"Unified Security Policy - Alerts","hasRequests":true,"id":"1-29"},{"order":["1-30-160","1-30-161","1-30-162","1-30-163","1-30-164","1-30-165","1-30-166","1-30-167"],"collectionId":"1","name":"Unified Security Policy - Cloud Tag Policy","hasRequests":true,"id":"1-30"},{"order":["1-31-168","1-31-169","1-31-170","1-31-171","1-31-172","1-31-173","1-31-174","1-31-175"],"collectionId":"1","name":"Unified Security Policy - Exceptions","hasRequests":true,"id":"1-31"},{"order":["1-32-176","1-32-177","1-32-178","1-32-179","1-32-180"],"collectionId":"1","name":"Unified Security Policy - Security Zone Matrix","hasRequests":true,"id":"1-32"},{"order":["1-33-181","1-33-182"],"collectionId":"1","name":"Unified Security Policy - Violations","hasRequests":true,"id":"1-33"}],"requests":[{"headers":"Accept: application/json\n","name":"Get all URL Categories by revision.","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"}],"dataMode":"params","description":"Fetches list of URL Categories defined in a revision given by ID.
This API is supported for Panorama in advanced mode and Panorama Device Groups.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/762/url_categories
","folder":"1-1","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/url_categories","collectionId":"1","id":"1-1-1","method":"GET"},{"headers":"Accept: application/json\n","name":"Get additional parameters identities by revision","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"}],"dataMode":"params","description":"Some firewall vendors use special fields in their security policy.
For example: Palo Alto uses Tags, Security Profiles and Log Profiles and Fortinet uses NAT Pools and other NAT configurations.
SecureTrack refers to these fields as “Additional Parameters”.
The additional parameters API retrieves the possible values of these fields.
This API is currently supported for Palo Alto Networks firewalls and Fortinet devices managed by Fortimanager.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
type: Additional parameter type [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/162/additional_parameters?type=security_profile_group

Response Messages:
200: Successful
400: Invalid request","folder":"1-1","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/additional_parameters","collectionId":"1","id":"1-1-2","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific additional parameter identity","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Some firewall vendors use special fields in their security policy.
For example: Palo Alto uses Tags, Security Profiles and Log Profiles and Fortinet uses NAT Pools and other NAT configurations.
SecureTrack refers to these fields as “Additional Parameters”.
The additional parameters API retrieves the possible values of these fields.
This API is currently supported for Palo Alto Networks firewalls and Fortinet devices managed by Fortimanager.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Additional parameter IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/revisions/162/additional_parameters/242767,242768,242760
","folder":"1-1","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/additional_parameters/{{ids}}","collectionId":"1","id":"1-1-3","method":"GET"},{"headers":"Accept: application/json\n","name":"Get a URL Category.","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches one or more URL Categories.
This API is supported for Panorama in advanced mode and Panorama Device Groups.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Url Category IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/revisions/762/url_categories/242767,242768,242760
","folder":"1-1","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/url_categories/{{ids}}","collectionId":"1","id":"1-1-4","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific application identity","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches one or more applications defined by a device ID and Application Id or comma separated applications ids list.
This API is currently supported for Palo Alto Networks firewalls.
Note: This API retrieves the information from the latest revision.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.


Parameters:
context: Global MSSP context [optional]
id: Device ID
ids: Application IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/devices/1/applications/701
","folder":"1-2","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/applications/{{ids}}","collectionId":"1","id":"1-2-5","method":"GET"},{"headers":"Accept: application/json\n","name":"Get application identities by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of applications defined on device given by ID.
This API is currently supported for Palo Alto Networks firewalls.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.
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.


Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable values are numeric [optional]
count: Number of pages for query allowable values are numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/applications?get_total=true
OUTPUT {
    \"applications\": {
        \"count\": 50,
        \"total\": 100,
        \"application\": [{
            \"@xsi.type\": \"singleApplicationDTO\",
            \"id\": 2095027,
            \"name\": \"any\",
            \"display_name\": \"any\",
            \"class_name\": \"application_object\",
            \"comment\": \"\",
            \"uid\": \"{61B7771C-8B0B-90D6-ED55-B6698691BEED}\",
            \"overrides\": false,
            \"service\": {
                \"id\": 5048925,
                \"uid\": \"{4BC8F8B5-7671-A61B-5DD2-8CA235955162}\",
                \"display_name\": \"any\",
                \"name\": \"any\"
            }
        }]
    }
}

","folder":"1-2","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/applications","collectionId":"1","id":"1-2-6","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific application identity","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches one or more applications defined by a revision ID and Application Id or comma separated applications ids list.
This API is currently supported for Palo Alto Networks firewalls.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.


Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Application IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/revisions/762/applications/242767,242768,242760
","folder":"1-2","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/applications/{{ids}}","collectionId":"1","id":"1-2-7","method":"GET"},{"headers":"Accept: application/json\n","name":"Get applications identities by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of applications defined in a revision given by ID.
This API is currently supported for Palo Alto Networks firewalls.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.
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.


Parameters:
context: Global MSSP context [optional]
id: Revision id
start: Starting page for query allowable value is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/762/applications?get_total=true
OUTPUT {
    \"applications\": {
        \"count\": 1,
        \"total\": 100,
        \"application\": [{
            \"@xsi.type\": \"singleApplicationDTO\",
            \"id\": 2095027,
            \"name\": \"any\",
            \"display_name\": \"any\",
            \"class_name\": \"application_object\",
            \"comment\": \"\",
            \"uid\": \"{61B7771C-8B0B-90D6-ED55-B6698691BEED}\",
            \"overrides\": false,
            \"service\": {
                \"id\": 5048925,
                \"uid\": \"{4BC8F8B5-7671-A61B-5DD2-8CA235955162}\",
                \"display_name\": \"any\",
                \"name\": \"any\"
            }
        }]
    }
}

","folder":"1-2","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/applications","collectionId":"1","id":"1-2-8","method":"GET"},{"headers":"Accept: application/json\n","name":"Determine if changes between two revisions are authorized","data":[{"value":null,"type":"text","enabled":true,"key":"new_version"},{"value":null,"type":"text","enabled":true,"key":"old_version"}],"dataMode":"params","description":"This API checks for unauthorized changes between any two versions of a firewall policy.
The API returns authorized if and only if all traffic changes between the two versions were authorized by SecureChange tickets.
The API returns unauthorized if there is at least one change that cannot be matched to a SecureChange ticket.

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).
The API returns the authorization status, the relevant tickets in SecureChange and the rules that implement unauthorized access changes.

Note 1: To use this API you must enable “Authorize Revisions with Tickets” in SecureTrack/Configuration/Ticketing.
Note 2: Use the ID returned by the /revisions API for new_version and old_version.
Note 3: The default value for traffic_details and ignore_tickets is false.
Note 4: Traffic that is handled by an implicit rule will not have a rule ID.

Parameters:
new_version: New version ID
old_version: Old version ID
traffic_details: Return unauthorized traffic change details for all modified rules [optional]
ignore_tickets: Ignore SecureChange tickets and consider all traffic changes unauthorized [optional]

Usage Example
https://192.168.1.1/securetrack/api/change_authorization?old_version=1&new_version=2

Usage Example
https://192.168.1.1/securetrack/api/change_authorization?old_version=1&new_version=2&traffic_details=true&ignore_tickets=true

Response Messages:
200: Change authorization has been successfully calculated
400: Input parameters are not valid
400: Could not find the requested revisions for comparison","folder":"1-3","url":"https://{{SecureTrack_IP}}/securetrack/api/change_authorization/","collectionId":"1","id":"1-3-9","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Compare revisions on two different devices in terms of traffic.","dataMode":"raw","description":"This API compares two arbitrary revisions from any devices. The comparison will be done in terms of allowed/denied traffic.
The API returns authorized if and only if there are no differences between the traffic allowed/denied by the rules in the two revisions.
The API returns unauthorized if there is at least one difference in terms of allowed/denied traffic between the two revisions.
Note 1: To map policies from one revision to the other use oldId2newIdMap and provide the UIDs of the policies to be compared.
Note 2: Parameter in the request body specifies if the result will return traffic difference details for all incompatible rules
Note 3: The format of the result is the same as the one returned by /change_authorization
Note 4: The API accepts in request body only one pair of oldId - newId map
Note 5: The request is valid only if the mapping ids are found in the active policies

Parameters:
body: Request parameter containing the versions of the revisions to be compared and the policy mapping between the revisions.

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_authorization/policyTrafficComparison
BODY{
    \"policy_traffic_comparison_request\": {
        \"oldVersionId\": \"234\",
        \"newVersionId\": \"179\",
        \"oldId2newIdMap\": [
            {
                \"oldId\": \"{037DEA62-A8D2-46F5-8DC9-DA404A60B96F}\",
                \"newId\" : \"{00-FACED0-00}\"
            }
        ],
        \"withTraffic\": true
    }
}


Response Messages:
200: Policies diff was successfully calculated
400: Could not find the requested revisions for comparison","folder":"1-3","rawModeData":"{\n\t\"policy_traffic_comparison_request\": {\n\t\t\"oldVersionId\": \"234\",\n\t\t\"newVersionId\": \"179\",\n\t\t\"oldId2newIdMap\": [\n\t\t\t{\n\t\t\t\t\"oldId\": \"{037DEA62-A8D2-46F5-8DC9-DA404A60B96F}\",\n\t\t\t\t\"newId\" : \"{00-FACED0-00}\"\n\t\t\t}\n\t\t],\n\t\t\"withTraffic\": true\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/change_authorization/policyTrafficComparison","collectionId":"1","id":"1-3-10","method":"POST"},{"headers":"Accept: application/json\n","collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/change_windows/","name":"Get name and status for all change windows","method":"GET","id":"1-4-11","description":"Retrieves a list of all change windows.
For valid pagination, both start and count should be provided. Otherwise, pagination is turned off.
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.


Parameters:
context: Global MSSP context [optional]
start: Starting result for query allowable value is numeric [optional]
count: Number of change windows for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_windows?start=0&count=50&get_total=true
OUTPUT {
    \"change_windows\": {
        \"count\": 2,
        \"total\": 2,
        \"change_window\": [
            {
                \"uuid\": \"6ae41504-a95c-4f23-98a2-f18b2efadb9d\",
                \"name\": \"cw1\",
                \"domain_id\": 1,
                \"enabled\": true
            },
            {
                \"uuid\": \"fc7b167c-29ea-49a1-9ee3-efb6d1351343\",
                \"name\": \"cw2\",
                \"domain_id\": 1,
                \"enabled\": true
            }
        ]
    }
}


Response Messages:
200: OK
400: For correct pagination provide a value for the start and count parameters
400: Start parameter must be a non-negative value
400: Count parameter must be a positive value
401: Not permitted to access this context ","folder":"1-4"},{"headers":"Accept: application/json\n","name":"Get scheduling and device details for a specific change window","data":[{"value":null,"type":"text","enabled":true,"key":"uid"},{"value":null,"type":"text","enabled":true,"key":"task_id"}],"dataMode":"params","description":"Retrieves scheduling and device details for a specific change window.

Parameters:
context: Global MSSP context [optional]
uid: Change window uuid
task_id: Task Id

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_windows/fc7b167c-29ea-49a1-9ee3-efb6d1351343/tasks/1
OUTPUT {
    \"commit_task\": {
        \"id\": 1,
        \"start_date\": \"04-Nov-2018 01:30:00PM +0200\",
        \"end_date\": \"04-Nov-2018 01:32:01PM +0200\",
        \"errors\": \"\",
        \"device_commits\": {
            \"device_commit\": [
                {
                    \"id\": 1,
                    \"result\": {
                        \"errors\": {
                            \"error\": \"got_error_from_dcs\"
                        },
                        \"device\": {
                            \"id\": 17,
                            \"status\": \"FAILURE\",
                            \"revision_id\": 1,
                            \"errors\": {
                                \"error\": \"Login error\"
                            }
                        }
                    }
                },
                {
                    \"id\": 2,
                    \"result\": {
                        \"errors\": \"\",
                        \"device\": {
                            \"id\": 19,
                            \"status\": \"SUCCESS_WITH_WARNINGS\",
                            \"revision_id\": 1,
                            \"warnings\": {
                                \"warning\": \"Commit not performed: This device had no policies to install on its managed firewalls\"
                            }
                        }
                    }
                }
            ]
        }
    }
}


Response Messages:
200: OK
400: For correct pagination provide a value for the start and count parameters
400: Start parameter must be a non-negative value
400: Count parameter must be a positive value
401: Not permitted to access this context
404: Change window with uuid was not found
404: Change window with uuid was not found in domain
404: Fail to find task for change window ","folder":"1-4","url":"https://{{SecureTrack_IP}}/securetrack/api/change_windows/{{uid}}/tasks/{{task_id}}","collectionId":"1","id":"1-4-12","method":"GET"},{"headers":"Accept: application/json\n","name":"Get a list of completed policy changes for a specific change window","data":[{"value":null,"type":"text","enabled":true,"key":"uid"}],"dataMode":"params","description":"Retrieves a list of completed policy changes for a specific change window.
For valid pagination, both start and count should be provided. Otherwise, pagination is turned off.
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.


Parameters:
context: Global MSSP context [optional]
uid: Change window uuid
start: Starting result for query allowable value is numeric [optional]
count: Number of tasks for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_windows/fc7b167c-29ea-49a1-9ee3-efb6d1351343/tasks?start=0&count=50&get_total=true
OUTPUT {
    \"commit_tasks\": {
        \"count\": 1,
        \"total\": 1,
        \"commit_task\": {
            \"id\": 1,
            \"start_date\": \"04-Nov-2018 01:30:00PM +0200\",
            \"end_date\": \"04-Nov-2018 01:32:01PM +0200\",
            \"errors\": \"\"
        }
    }
}


Response Messages:
200: OK
400: For correct pagination provide a value for the start and count parameters
400: Start parameter must be a non-negative value
400: Count parameter must be a positive value
401: Not permitted to access this context
404: Change window with uuid was not found
404: Change window with uuid was not found in domain ","folder":"1-4","url":"https://{{SecureTrack_IP}}/securetrack/api/change_windows/{{uid}}/tasks","collectionId":"1","id":"1-4-13","method":"GET"},{"headers":"Accept: application/json\n","name":"Get network interfaces by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Reflects static data from the running-config.
For dynamic information see the /topology_interfaces API.
This API is not applicable for Check Point.

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/10/interfaces
","folder":"1-5","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/interfaces","collectionId":"1","id":"1-5-14","method":"GET"},{"headers":"Accept: application/json\n","name":"Get network interfaces by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Reflects static data from the running-config.
For dynamic information see the /topology_interfaces API.
This API is not applicable for Check Point.

Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/227/interfaces
","folder":"1-5","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/interfaces","collectionId":"1","id":"1-5-15","method":"GET"},{"headers":"Accept: application/json\n","name":"Get device zones by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns a list of the zones for the specified Juniper, Stonesoft, Fortinet or Palo Alto Networks revision.
Note: this API returns device zones, not Tufin zones.

Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/787/zones
","folder":"1-5","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/zones","collectionId":"1","id":"1-5-16","method":"GET"},{"headers":"Accept: application/json\n","name":"Get zones and network interfaces that participate in sub-policies","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/104/bindable_objects
","dataMode":"params","folder":"1-5","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/bindable_objects","collectionId":"1","id":"1-5-17","method":"GET"},{"headers":"Accept: application/json\n","name":"Get device zones by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns a list of the zones for the specified Juniper, Stonesoft, Fortinet or Palo Alto Networks device.
Note: this API returns device zones, not Tufin zones.

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/104/zones
","folder":"1-5","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/zones","collectionId":"1","id":"1-5-18","method":"GET"},{"headers":"Accept: application/json\n","name":"Get domain","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
context: Global MSSP context [optional]
id: Domain id

Usage Example
https://192.168.1.1/securetrack/api/domains/1

Response Messages:
401: User not permitted to access domains
400: Domain with ID was not found","dataMode":"params","folder":"1-6","url":"https://{{SecureTrack_IP}}/securetrack/api/domains/{{id}}","collectionId":"1","id":"1-6-19","method":"GET"},{"name":"Update a domain","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
id: Domain id
body [optional]

Usage Example
https://192.168.1.1/securetrack/api/domains/1

Response Messages:
401: User not permitted to access domains
400: Domain with ID was not found
400: Domain with this name already exists
400: Domain name is empty
400: Default domain cannot be changed","dataMode":"params","folder":"1-6","url":"https://{{SecureTrack_IP}}/securetrack/api/domains/{{id}}","collectionId":"1","id":"1-6-20","method":"PUT"},{"headers":"Accept: application/json\n","collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/domains/","name":"Get all domains","method":"GET","id":"1-6-21","description":"

Usage Example
https://192.168.1.1/securetrack/api/domains

Response Messages:
401: User not permitted to access domains","folder":"1-6"},{"collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/domains/","name":"Add a domain","method":"POST","id":"1-6-22","description":"Parameters:
body [optional]

Usage Example
https://192.168.1.1/securetrack/api/domains

Response Messages:
401: User not permitted to access domains
400: Domain with this name already exists
400: Domain name is empty","folder":"1-6"},{"headers":"Accept: application/json\n","collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/properties/","name":"Get general properties","method":"GET","id":"1-7-23","description":"

Usage Example
URLhttps://192.168.1.1/securetrack/api/properties
OUTPUT{
    \"properties\": {
        \"sc_addresses\": {
            \"sc_address\": [
                {
                    \"ip_address\": \"127.0.0.1\",
                    \"type\": \"external\"
                },
                {
                    \"ip_address\": \"127.0.0.1\",
                    \"type\": \"internal\"
                }
            ]
        }
    }
}


Response Messages:
401: User not permitted to view properties","folder":"1-7"},{"headers":"Accept: application/json\n","name":"Get Cisco cryptographic maps by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://191.168.1.1/securetrack/api/revisions/18/crypto_maps
","dataMode":"params","folder":"1-8","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/crypto_maps","collectionId":"1","id":"1-8-24","method":"GET"},{"headers":"Accept: application/json\n","name":"Get Cisco IPsec policy and peers","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"outputInterfaceName"}],"dataMode":"params","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.
You can retrieve the interface names by calling the /devices/id/interfaces API.

Parameters:
device_id: The unique identifier of target device
outputInterfaceName: Interface name

Usage Example
https://192.168.1.1/securetrack/api/bindings/32/ipsec_tunnels?outputInterfaceName=GigabitEthernet1
","folder":"1-8","url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/ipsec_tunnels","collectionId":"1","id":"1-8-25","method":"GET"},{"headers":"Accept: application/json\n","name":"Get Check Point VPN (IPSec) communities and gateways","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"}],"dataMode":"params","description":"Get Check Point VPN (IPSec) Communities and gateways that partcipant in those communities.
Works on clusters and gateways, not on management servers.

Parameters:
device_id: The unique identifier of target device

Usage Example
https://192.168.1.1/securetrack/api/bindings/20/ipsec_communities
","folder":"1-8","url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/ipsec_communities","collectionId":"1","id":"1-8-26","method":"GET"},{"headers":"Accept: application/json\n","name":"Get Cisco cryptographic maps by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/19/crypto_maps
","dataMode":"params","folder":"1-8","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/crypto_maps","collectionId":"1","id":"1-8-27","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Create new Internet representation for a device","dataMode":"raw","description":"The internet referral lets you represent the Internet as an object on a device.
See REST API: /internet_referral/{deviceId:[0-9]+}/object for a description of how internet referral is resolved.

Parameters:
body: Internet referral configuration

Usage Example
URLhttps://192.168.1.1/securetrack/api/internet_referral
BODY{
    \"internet_referral\": {
        \"@xsi.type\": \"internetReferralObjectNameDTO\",
        \"device_id\": 2,
        \"object_name\": \"Host_2.2.2.2\"
    }
}


Response Messages:
201: Internet referral configuration was created
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
400: Internet referral configuration was malformed
400: Internet referral configuration for given device ID already exists
401: Access is denied.","folder":"1-9","rawModeData":"{\n\t\"internet_referral\": {\n\t\t\"@xsi.type\": \"internetReferralObjectNameDTO\",\n\t\t\"device_id\": 2,\n\t\t\"object_name\": \"Host_2.2.2.2\"\n\t}\n}\n","url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/","collectionId":"1","id":"1-9-28","method":"POST"},{"name":"Delete Internet representation for device","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"}],"description":"Parameters:
deviceId: SecureTrack Device ID

Usage Example
https://192.168.1.1/securetrack/api/internet_referral/2

Response Messages:
200: Internet referral configuration was deleted
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
400: Internet referral configuration for device ID does not exist
401: Access is denied.","dataMode":"params","folder":"1-9","url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}","collectionId":"1","id":"1-9-29","method":"DELETE"},{"name":"Get Internet representation for device","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"}],"description":"Parameters:
deviceId: SecureTrack Device ID

Usage Example
https://192.168.1.1/securetrack/api/internet_referral/2

Response Messages:
200: Internet referral configuration is returned
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
404: Internet referral configuration was not found for device ID
401: Access is denied.","dataMode":"params","folder":"1-9","url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}","collectionId":"1","id":"1-9-30","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Update Internet representation for device","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"}],"dataMode":"raw","description":"Updates the Internet referral configuration for the device.
If there was no previous configuration, it will be created.

Parameters:
deviceId: SecureTrack Device ID
body: Internet referral configuration

Usage Example
URLhttps://192.168.1.1/securetrack/api/internet_referral
BODY{
    \"internet_referral\": {
        \"@xsi.type\": \"internetReferralObjectNameDTO\",
        \"device_id\": 2,
        \"object_name\": \"Host_10.11.73.1\"
    }
}


Response Messages:
200: Internet referral configuration was updated
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
400: Internet referral configuration was malformed
401: Access is denied.","folder":"1-9","rawModeData":"{\n\t\"internet_referral\": {\n\t\t\"@xsi.type\": \"internetReferralObjectNameDTO\",\n\t\t\"device_id\": 2,\n\t\t\"object_name\": \"Host_10.11.73.1\"\n\t}\n}\n","url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}","collectionId":"1","id":"1-9-31","method":"PUT"},{"name":"Get resolved Internet representation for device","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"}],"dataMode":"params","description":"The order of precedence used to resolve the Internet object is:
Step 1: Identify the Internet referral:
Search for a defined Internet referral on the specified device.
If it is not found on the device, search the parent and grandparents (up the device tree) for a defined Internet referral.
If a defined Internet referral is found, then match the name in the Internet referral to a network object, as defined in Step 2.
If an Internet referral is not found, it resolves to “Any”.
Step 2: Resolve the object by name:
Search the specified device for a defined network object that matches the name returned in Step 1.
If a matching network object is not found, an error will be returned.

Parameters:
deviceId: SecureTrack Device ID

Usage Example
https://192.168.1.1/securetrack/api/internet_referral/2/object

Response Messages:
200: Resolved Internet referral object for device is returned
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
404: Configured object was not found on the device
401: Access is denied.","folder":"1-9","url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}/object","collectionId":"1","id":"1-9-32","method":"GET"},{"headers":"Accept: application/json\n","collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/getBaseDNEntry","name":"Get the base DN entry details","method":"GET","id":"1-10-33","description":"The returned \"base DN\" is used by GetEntriesByNames API as the search start entry.



Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/getBaseDNEntry
OUTPUT{
    \"ldap_entry\": {
        \"dn\": \"DC=tufintest,DC=com\",
        \"uid\": \"nABbRP/lPUKlteNRI4j6iA==\"
    }
}


Response Messages:
200: OK
404: Base Entry cannot be found
501: LDAP server is not configured
503: No connection to LDAP server","folder":"1-10"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Return LDAP entries which match the given search criteria","dataMode":"raw","description":"Return list of LDAP entries which match the given search criteria according to the search mode (EXACT, CONTAINS, STARTS_WITH, ENDS_WITH).
The search is case insensitive.
The limit of max_search_result is 1000.

Parameters:
body: Search criteria

Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/search
BODY{
    \"search_criteria\": {
        \"search_base_dn\": \"DC=tufintest,DC=com\",
        \"search_text\": \"test\",
        \"ldap_search_options\": {
            \"ldap_entry_types\": {
                \"ldap_entry_type\": [
                    \"OU\",
                    \"USER\"
                ]
            },
            \"search_mode\": \"CONTAINS\",
            \"max_search_result\": 3
        }
    }
}
OUTPUT{
    \"search_result\": {
        \"ldap_entries\": {
            \"ldap_entry\": [
            {
                \"dn\": \"CN=User15ATTesting1,OU=Testing1,OU=new OU,OU=SC_Users,DC=tufintest,DC=com\",
                \"uid\": \"ZRuKW3XqIEOIxCwlfgJQYA==\",
                \"displayName\": \"User15ATTesting1\"
            },
            {
                \"dn\": \"CN=IWAM_TEST2003,CN=Users,DC=tufintest,DC=com\",
                \"uid\": \"bYVqqcZXsUSF51hiP4W7Yw==\",
                \"displayName\": \"Testing1\"
            },
            {
                \"dn\": \"CN=User1ATTesting1,OU=Testing1,OU=new OU,OU=SC_Users,DC=tufintest,DC=com\",
                \"uid\": \"2ma3TrgeHEWQDITwvcRqlg==\",
                \"displayName\": \"test\"
            }
            ]
        },
            \"has_more_results_to_return\": \"true\"
        }
}


Response Messages:
200: OK
400: Bad request (one of the request fields has an illegal or invalid value)
501: LDAP server is not configured
503: No connection to LDAP server","folder":"1-10","rawModeData":"{\n\t\"search_criteria\": {\n\t\t\"search_base_dn\": \"DC=tufintest,DC=com\",\n\t\t\"search_text\": \"test\",\n\t\t\"ldap_search_options\": {\n\t\t\t\"ldap_entry_types\": {\n\t\t\t\t\"ldap_entry_type\": [\n\t\t\t\t\t\"OU\",\n\t\t\t\t\t\"USER\"\n\t\t\t\t]\n\t\t\t},\n\t\t\t\"search_mode\": \"CONTAINS\",\n\t\t\t\"max_search_result\": 3\n\t\t}\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/search","collectionId":"1","id":"1-10-34","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Return entries that exactly match one of the given strings","dataMode":"raw","description":"Return list of LDAP entries which match the exact given multiple search_text.

Parameters:
body: Names to search

Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/getEntriesByNames
BODY{
    \"search_by_name_criteria\": {
        \"search_texts\": {
            \"search_text\": [
                \"Finance\",
                \"Marketing\",
                \"Management\"
            ]
        },
        \"ldap_entry_types\": {
            \"ldap_entry_type\": [
                \"GROUP\"
            ]
        },
        \"max_search_result\": 20
    }
}
OUTPUT{
    \"search_result\": {
        \"ldap_entries\": {
            \"ldap_entry\": [
                {
                    \"@xsi.type\": \"LdapGroup\",
                    \"dn\": \"CN=Finance,OU=SecureTrack,DC=tufintest,DC=com\",
                    \"uid\": \"uOvJTpYRD0aTjEENA87N5A==\",
                    \"displayName\": \"Finance\"
                },
                {
                    \"@xsi.type\": \"LdapGroup\",
                    \"dn\": \"CN=Management,OU=SecureTrack,DC=tufintest,DC=com\",
                    \"uid\": \"jdf778skfsgs730fksdHHs==\",
                    \"displayName\": \"Management\"
                }
            ]
        },
        \"has_more_results_to_return\": false
    }
}


Response Messages:
200: OK
400: Bad request (one of the request fields has an illegal value)
501: LDAP server is not configured
503: No connection to LDAP server","folder":"1-10","rawModeData":"{\n\t\"search_by_name_criteria\": {\n\t\t\"search_texts\": {\n\t\t\t\"search_text\": [\n\t\t\t\t\"Finance\",\n\t\t\t\t\"Marketing\",\n\t\t\t\t\"Management\"\n\t\t\t]\n\t\t},\n\t\t\"ldap_entry_types\": {\n\t\t\t\"ldap_entry_type\": [\n\t\t\t\t\"GROUP\"\n\t\t\t]\n\t\t},\n\t\t\"max_search_result\": 20\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/getEntriesByNames","collectionId":"1","id":"1-10-35","method":"POST"},{"headers":"Accept: application/json\n","name":"Get LDAP entry details by DN","data":[{"value":null,"type":"text","enabled":true,"key":"dn"}],"dataMode":"params","description":"Returns the UID, DN and Name of a LDAP entry specified by the DN.

Parameters:
dn: LDAP DN

Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/getEntryByDN?dn=CN=Manufacturing,OU=RSA_Demo,DC=tufintest,DC=com
OUTPUT{
    \"ldap_entry\": {
        \"uid\": \"mYbWQms7p0q5YinEyW5Byw==\",
        \"dn\": \"CN=Manufacturing,OU=RSA_Demo,DC=tufintest,DC=com\",
        \"name\": \"Manufacturing\"
    }
}


Response Messages:
200: OK
400: Invalid DN format
404: Entry matching the DN cannot be found
501: LDAP server is not configured
503: No connection to LDAP server","folder":"1-10","url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/getEntryByDN","collectionId":"1","id":"1-10-36","method":"GET"},{"headers":"Accept: application/json\n","name":"Get textual configuration by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns textual configuration for the specified revision Id.


Parameters:
context: Global MSSP context [optional]
id: Revision id

Usage Example
https://192.168.1.1/securetrack/api/revisions/227/config
","folder":"1-11","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/config","collectionId":"1","id":"1-11-37","method":"GET"},{"headers":"Accept: application/json\n","collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/","name":"Get devices","method":"GET","id":"1-11-38","description":"Returns the list of devices that are configured in SecureTrack, including the vendor, model, name, domain and device ID.
The results can be sorted by ip, name, vendor and model.
For more information on supported devices, supported models and virtual types please refer to 'Device and Revision Resources' section in the Tufin Knowledge Center .

Parameters:
context: Global MSSP context [optional]
name: Device name [optional]
ip: Device IP address [optional]
vendor: Device vendor [optional]
model: Device model [optional]
sort: Sort ascending or descending allowable types are: asc or desc [optional]
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query starting from starting page allowable type in numeric [optional]
show_os_version: Show os version as apart of the response [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices

Usage Example
https://192.168.1.1/securetrack/api/devices?vendor=VMware

Usage Example
https://192.168.1.1/securetrack/api/devices?sort=ip:asc

Usage Example
https://192.168.1.1/securetrack/api/devices?show_os_version=true
","folder":"1-11"},{"headers":"Content-Type: application/xml\n","name":"Add offline device","dataMode":"raw","description":"You can choose to select the domain either by name or id using the domain_id or domain_name tags.\nDevice name should contain only Lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^()

Parameters:
body: Device to be added

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices
BODY<device>
     <model>asa</model>
     <vendor>Cisco</vendor>
     <domain_id>1</domain_id>
     <domain_name>Default</domain_name>
     <name>API OFFLINE ASA1</name>
     <offline>true</offline>
     <topology>true</topology>
</device>

","folder":"1-11","rawModeData":"\n\t asa \n\t Cisco\n\t 1\n\t Default\n\t API OFFLINE ASA1\n\t true\n\t true\n","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/","collectionId":"1","id":"1-11-39","method":"POST"},{"headers":"Accept: application/json\n","name":"Get textual configuration by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Get latest revision of running configuration for a given device Id.


Parameters:
context: global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/111/config
","folder":"1-11","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/config","collectionId":"1","id":"1-11-40","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Edit Securetrack device","dataMode":"raw","description":"Use this API to edit the settings of a management device, including changing multiple parameters in the same call.
The API body should include a JSON file with the mandatory parameters for the operation.
String parameters contain only lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^().
The following devices can be added: Check Point CMA R77, CMA R80, SMC R77, SMC R80; Cisco ASA; Palo Alto Panorama NG; Fortinet FortiManager.
Note: This API cannot be used to edit SecureTrack Domains and SecureTrack Servers.
This API verifies connection to the provided device, before updating a device.
This is done by:
  Cisco - Connect with SSH and see that the credentials are correct.
  Check Point - Test OPSEC connectivity. For R80 devices, this also verifies the connectivity for API login.
  Panorama - Login through the API to check connectivity.
  Fortimanager - Login through the API to check connectivity.
If the connection test fails the device will not be updated.
Only \"live\" device with correct credentials can be updated using this API.

Parameters:
body: device_list

Usage Example
URL https://192.168.1.1/securetrack/api/devices/bulk
BODY{
     \"devices_list\":{
         \"devices\": [{
             \"device_id\": 1,
             \"display_name\": \"CheckPoint-R77-Device\",
             \"enable_topology\": \"true\",
             \"ip_address\": \"1.1.1.1\",
             \"device_data\": {
                 \"opsec_application\": \"ST-Opsec\",
                 \"activation_key\": \"ST-Activation\",
                 \"authentication_mode\": \"LEA\",
                 \"lea_authentication_mode\": \"ssl_opsec\",
                 \"lea_authentication_port\": \"2488\",
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\"
             }
         },
         {
             \"device_id\": 2,
             \"display_name\": \"CheckPoint-R80-Device\",
             \"enable_topology\": \"true\",
             \"ip_address\": \"1.1.1.2\",
             \"device_data\": {
                 \"opsec_application\": \"ST-Opsec\",
                 \"activation_key\": \"ST-Activation\",
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\",
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\"
             }
         },
         {
             \"device_id\": 3,
             \"display_name\": \"Cisco-Device\",
             \"enable_topology\": \"true\",
             \"ip_address\": \"2.2.2.2\",
             \"device_data\": {
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\",
                 \"enable_password\": \"st-super-password\",
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\"
             }
         },
         {
             \"device_id\": 4,
             \"display_name\": \"PaloAlto-PanoramaNg-Device\",
             \"ip_address\": \"2.2.2.2\",
             \"device_data\": {
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\"
             }
         },
         {
             \"device_id\": 5,
             \"display_name\": \"PaloAlto-DeviceGroup\"
         },
         {
             \"device_id\": 6,
             \"display_name\": \"PaloAlto-FireWall-Device\",
             \"enable_topology\": \"true\",
             \"device_data\": {
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\",
                 \"collect_dynamic_topology\": \"true\"
             }
         },
         {
             \"device_id\": 7,
             \"display_name\": \"Spain-FortiManager\",
             \"ip_address\": \"2.2.2.2\",
             \"device_data\": {
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\"
             }
         },
         {
             \"device_id\": 8,
             \"display_name\": \"FortiManager-Adom\"
         },
         {
             \"device_id\": 9,
             \"display_name\": \"FortiManager-FireWall\",
             \"enable_topology\": \"true\",
             \"device_data\": {
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\",
                 \"collect_dynamic_topology\": \"true\"
             }
         }
        ]
    }
}


Response Messages:
202: Accepted
408: Request timed out
500: Internal server error
503: Task with UID already running","folder":"1-11","rawModeData":"{ \n \t \"devices_list\":{ \n\t\t \"devices\": [{\n\t\t\t \"device_id\": 1,\n\t\t\t \"display_name\": \"CheckPoint-R77-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"ip_address\": \"1.1.1.1\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"opsec_application\": \"ST-Opsec\",\n\t\t\t\t \"activation_key\": \"ST-Activation\",\n\t\t\t\t \"authentication_mode\": \"LEA\",\n\t\t\t\t \"lea_authentication_mode\": \"ssl_opsec\",\n\t\t\t\t \"lea_authentication_port\": \"2488\",\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 2,\n\t\t\t \"display_name\": \"CheckPoint-R80-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"ip_address\": \"1.1.1.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"opsec_application\": \"ST-Opsec\",\n\t\t\t\t \"activation_key\": \"ST-Activation\",\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\",\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 3,\n\t\t\t \"display_name\": \"Cisco-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"ip_address\": \"2.2.2.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\",\n\t\t\t\t \"enable_password\": \"st-super-password\",\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 4,\n\t\t\t \"display_name\": \"PaloAlto-PanoramaNg-Device\",\n\t\t\t \"ip_address\": \"2.2.2.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 5,\n\t\t\t \"display_name\": \"PaloAlto-DeviceGroup\"\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 6,\n\t\t\t \"display_name\": \"PaloAlto-FireWall-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_dynamic_topology\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 7,\n\t\t\t \"display_name\": \"Spain-FortiManager\",\n\t\t\t \"ip_address\": \"2.2.2.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 8,\n\t\t\t \"display_name\": \"FortiManager-Adom\"\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 9,\n\t\t\t \"display_name\": \"FortiManager-FireWall\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_dynamic_topology\": \"true\"\n\t\t\t }\n\t\t }\n\t\t]\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/","collectionId":"1","id":"1-11-41","method":"PATCH"},{"headers":"Content-Type: application/json\n","name":"Add devices to SecureTrack","dataMode":"raw","description":"Use this API to add a single device or a list of devices to SecureTrack.
The following devices can be added: Check Point CMA R77, CMA R80, SMC R77, SMC R80; Cisco ASA; Palo Alto Panorama NG; Fortinet FortiManager.
The API body should include a JSON file with the mandatory parameters for the operation.
String parameters contain only lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^().
Currently supported types: CMA, SMC, ASA, Panorama NG and FortiManager.

This API verifies connection to the provided device, before adding a device.
This is done by:
  Cisco - Connect with SSH and see that the credentials are correct.
  Check Point - Test OPSEC connectivity. For R80 devices, this also verifies the connectivity for API login.
  Panorama - Login through the API to check connectivity.
  Fortimanager - Login through the API to check connectivity.
If the connection test fails the device will not be added.
Only \"live\" device with correct credentials can be added using this API.
To add Checkpoint R77 devices, use \"r80_version\" : \"false\".


Parameters:
body: device_list

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/bulk
BODY{
     \"devices_list\":{
         \"devices\": [{
             \"model\":\"CMA\",
             \"vendor\":\"Checkpoint\",
             \"display_name\":\"Europe-CMA\",
             \"ip_address\":\"192.168.1.1\",
             \"enable_topology\": \"true\",
             \"securetrack_domain\":\"Default\",
             \"device_data\":{
                 \"lea_authentication_port\":\"65000\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"opsec_application\":\"ST-Opsec\",
                 \"activation_key\":\"ST-Activation\",
                 \"r80_version\":\"false\"
             }
         },
         {
             \"model\":\"CMA\",
             \"vendor\":\"Checkpoint\",
             \"display_name\":\"Europe-CMA\",
             \"ip_address\":\"192.168.1.1\",
             \"enable_topology\": \"true\",
             \"securetrack_domain\":\"Default\",
             \"device_data\":{
                 \"lea_authentication_port\":\"65000\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"opsec_application\":\"ST-Opsec\",
                 \"activation_key\":\"ST-Activation\",
                 \"user_name\":\"admin\",
                 \"password\":\"1234\",
                 \"r80_version\":\"true\"
             }
         },
         {
             \"model\":\"ASA\",
             \"vendor\":\"Cisco\",
             \"securetrack_domain\":\"Domain-A\",
             \"display_name\":\"Ireland-ASA\",
             \"ip_address\":\"172.16.1.1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
             \"enable_virtual_contexts\":\"true\",
             \"import_all\":\"false\",
             \"import_devices\":
                     [\"VC1\",\"VC2\"],
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"false\",
                 \"collect_dynamic_topology\":\"false\",
                 \"user_name\":\"St-Super-use\",
                 \"password\":\"st-super-password\",
                 \"enable_password\":\"st-enable-password\"
             }
         },
         {
             \"model\":\"Panorama\",
             \"vendor\":\"PaloAltoNetworks\",
             \"display_name\":\"First-Device-example\",
             \"ip_address\":\"172.16.1.1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"user_name\":\"St-Super-use\",
                 \"password\":\"st-super-password\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"collect_dynamic_topology\":\"false\",
                 \"import_devices\":[
                     {
                         \"name\":\"DG1\",
                         \"import_all\":\"false\",
                         \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"]
                     },
                     {
                         \"name\":\"DG2\",
                         \"import_all\":\"true\"
                     },
                     {
                         \"name\":\"DG3\",
                         \"import_all\":\"false\",
                         \"managed_devices\": []
                     }
                 ]
             }
         },
         {
             \"model\":\"FortiManager\",
             \"vendor\":\"Fortinet\",
             \"display_name\":\"Spain-FortiManager\",
             \"securetrack_server\":\"RemoteControlServerName\",
             \"ip_address\":\"172.16.1.1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"false\",
                 \"user_name\":\"St-Super-use\",
                 \"password\":\"st-super-password\",
                 \"collect_dynamic_topology\":\"false\",
                 \"import_all\": \"false\",
                 \"import_devices\": [
                         {
                 \"name\": \"AdomX\",
                 \"import_all\": \"false\",
                 \"managed_devices\": [\"FW1\"]
                        }
                    ]
                }
            }
        ]
    }
}


Response Messages:
202: Accepted
408: Request timed out
500: Internal server error
503: Task with UID already running","folder":"1-11","rawModeData":"{ \n \t \"devices_list\":{ \n \t\t \"devices\": [{ \n \t\t\t \"model\":\"CMA\",\n \t\t\t \"vendor\":\"Checkpoint\",\n \t\t\t \"display_name\":\"Europe-CMA\",\n \t\t\t \"ip_address\":\"192.168.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"securetrack_domain\":\"Default\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"lea_authentication_port\":\"65000\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"opsec_application\":\"ST-Opsec\",\n \t\t\t\t \"activation_key\":\"ST-Activation\",\n \t\t\t\t \"r80_version\":\"false\"\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"model\":\"CMA\",\n \t\t\t \"vendor\":\"Checkpoint\",\n \t\t\t \"display_name\":\"Europe-CMA\",\n \t\t\t \"ip_address\":\"192.168.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"securetrack_domain\":\"Default\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"lea_authentication_port\":\"65000\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"opsec_application\":\"ST-Opsec\",\n \t\t\t\t \"activation_key\":\"ST-Activation\",\n \t\t\t\t \"user_name\":\"admin\",\n \t\t\t\t \"password\":\"1234\",\n \t\t\t\t \"r80_version\":\"true\"\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"model\":\"ASA\",\n \t\t\t \"vendor\":\"Cisco\",\n \t\t\t \"securetrack_domain\":\"Domain-A\",\n \t\t\t \"display_name\":\"Ireland-ASA\",\n \t\t\t \"ip_address\":\"172.16.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t \"enable_virtual_contexts\":\"true\",\n \t\t\t \"import_all\":\"false\",\n \t\t\t \"import_devices\": \n \t\t\t\t\t [\"VC1\",\"VC2\"],\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"false\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"user_name\":\"St-Super-use\",\n \t\t\t\t \"password\":\"st-super-password\",\n \t\t\t\t \"enable_password\":\"st-enable-password\"\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"model\":\"Panorama\",\n \t\t\t \"vendor\":\"PaloAltoNetworks\",\n \t\t\t \"display_name\":\"First-Device-example\",\n \t\t\t \"ip_address\":\"172.16.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"user_name\":\"St-Super-use\",\n \t\t\t\t \"password\":\"st-super-password\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"import_devices\":[\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG1\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"] \n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG2\",\n \t\t\t\t\t\t \"import_all\":\"true\"\n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG3\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [] \n \t\t\t\t\t }\n \t\t\t\t ]\n \t\t\t }\n \t\t },\n \t\t {\n \t\t\t \"model\":\"FortiManager\",\n \t\t\t \"vendor\":\"Fortinet\",\n \t\t\t \"display_name\":\"Spain-FortiManager\",\n \t\t\t \"securetrack_server\":\"RemoteControlServerName\",\n \t\t\t \"ip_address\":\"172.16.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"false\",\n \t\t\t\t \"user_name\":\"St-Super-use\",\n \t\t\t\t \"password\":\"st-super-password\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"import_all\": \"false\",\n \t\t\t\t \"import_devices\": [\n \t\t\t\t\t\t { \n \t\t\t\t \"name\": \"AdomX\",\n \t\t\t\t \"import_all\": \"false\", \n \t\t\t\t \"managed_devices\": [\"FW1\"]\n \t\t\t\t\t\t}\n \t\t\t\t\t]\n \t\t\t\t}\n \t\t\t}\n \t\t]\n \t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/","collectionId":"1","id":"1-11-42","method":"POST"},{"headers":"Content-Type: application/json\n","name":"Import managed devices","dataMode":"raw","description":"Use this API to import more managed devices to SecureTrack.
The following devices can be added: Device Groups (for Panorama), Administrative Domains (for FortiManager).\nCurrently supported types: Panorama, FortiManager, Cisco ASA.
Please see examples below per device id: device id 1 for Panorama, device 2 for FortiManager, device id 3 for Cisco ASA.

Parameters:
body: device_list

Usage Example
URL https://192.168.1.1/securetrack/api/devices/bulk/import
BODY{
     \"devices_list\":{
         \"devices\":[
         {
             \"device_id\":\"1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"collect_dynamic_topology\":\"false\",
                 \"import_devices\":[
                     {
                         \"name\":\"DG1\",
                         \"import_all\":\"false\",
                         \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"]
                     },
                     {
                         \"name\":\"DG2\",
                         \"import_all\":\"true\"
                     },
                     {
                         \"name\":\"DG3\",
                         \"import_all\":\"false\",
                         \"managed_devices\": []
                     }
                 ]
             }
         },
         {
             \"device_id\":\"2\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"import_devices\": [
                     {
                         \"name\":\"Adom1\",
                         \"import_all\":\"false\",
                         \"managed_devices\": [\"firewall1\", \"firewall2\"]
                     },
                     {
                         \"name\":\"Adom2\",
                         \"import_all\":\"true\"
                     }
                 ]
             }
         },
         {
             \"device_id\":\"3\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"import_devices\": [\"wantedVirtualContext\", \"anotherWantedVirtualContext\"]
             }
         }
        ]
    }
}


Response Messages:
202: Accepted
408: Request timed out
500: Internal server error
503: Task with UID already running","folder":"1-11","rawModeData":"{ \n \t \"devices_list\":{ \n \t\t \"devices\":[ \n \t\t { \n \t\t\t \"device_id\":\"1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"import_devices\":[\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG1\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"] \n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG2\",\n \t\t\t\t\t\t \"import_all\":\"true\"\n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG3\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [] \n \t\t\t\t\t }\n \t\t\t\t ]\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"device_id\":\"2\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"import_devices\": [\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"Adom1\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [\"firewall1\", \"firewall2\"] \n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"Adom2\",\n \t\t\t\t\t\t \"import_all\":\"true\"\n \t\t\t\t\t }\n \t\t\t\t ]\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"device_id\":\"3\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"import_devices\": [\"wantedVirtualContext\", \"anotherWantedVirtualContext\"] \n \t\t\t }\n \t\t }\n \t\t]\n \t}\n} ","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/import","collectionId":"1","id":"1-11-43","method":"POST"},{"headers":"Accept: application/json\n","name":"Get specific task results of bulk operations on devices","data":[{"value":null,"type":"text","enabled":true,"key":"task_uid"}],"dataMode":"params","description":"Use this API to track and display the current progress of the devices being edited or added to\nSecureTrack for a specific Task ID.
For a list of devices, the status of each device is displayed.

A device that was not added due to some reason will be added to \"failed\" list with status element containing a description.
For example:
\"description\": \"No connection to device\".

Parameters:
task_uid: Task UID

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/bulk/tasks/d7e88799-a6e5-45da-8c72-c979a5dbe235
OUTPUT{
    \"task_result\":{
        \"total_succeeded\":\"0\",
        \"total_in_progress\":\"2\",
        \"total_failed\":\"0\",
        \"succeeded\":{
            \"count\":\"0\"
        },
        \"in_progress\":{
            \"count\":\"2\",
            \"devices\":[
                {
                    \"device_id\":\"1\",
                    \"display_name\":\"Europe-CMA\",
                    \"ip_address\":\"192.168.1.1\",
                    \"status\":{
                    }
                },
                {
                    \"device_id\":\"2\",
                    \"display_name\":\"Ireland-ASA\",
                    \"ip_address\":\"172.16.1.1\",
                    \"status\":{
                    }
                }
            ]
        },
        \"failed\":{
            \"count\":\"0\"
        }
    }
}


Response Messages:
404: The task with the given UID was not found
400: Bad request
200: Accepted
408: Request timed out
500: Internal server error","folder":"1-11","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/tasks/{{task_uid}}","collectionId":"1","id":"1-11-44","method":"GET"},{"name":"Add configuration for offline device","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"configuration_file"}],"description":"Parameters:
device_id: Device ID
configuration_file: Configuration File

Usage Example
curl -X POST -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F \"configuration_file=@/tmp/config.txt;type=application/octet-stream\" -F \"device_id=1\" https://192.168.1.1/securetrack/api/tasks/add_device_config_task

Response Messages:
200: Configuration added successfully.","dataMode":"params","folder":"1-11","url":"https://{{SecureTrack_IP}}/securetrack/api/tasks/add_device_config_task","collectionId":"1","id":"1-11-45","method":"POST"},{"headers":"Accept: application/json\n","name":"Get specific device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the vendor, model, name, domain and ID for the specified device.
For more information on supported devices, supported models and virtual types please refer to 'Device and Revision Resources' section in the Tufin Knowledge Center .

Parameters:
context: Global MSSP context [optional]
id: Device ID
show_os_version: Show os version as apart of the response [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/60

Usage Example
https://192.168.1.1/securetrack/api/devices/20?show_os_version=true
","folder":"1-11","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}","collectionId":"1","id":"1-11-46","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Update offline device","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"}],"dataMode":"raw","description":"Device name should contain only Lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^()

Parameters:
device_id: Device ID
body: Device to be updated

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/1
BODY<device>
     <name>API OFFLINE ASA2</name>
     <topology>true</topology>
</device>

","folder":"1-11","rawModeData":"\n\t API OFFLINE ASA2\n\t true\n","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}","collectionId":"1","id":"1-11-47","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get NAT objects by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches a list of NAT objects defined on device given by device ID
Note: NAT objects are only relevant for Check Point management servers and Juniper Netscreen devices.
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.


Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable value is numeric [optional]
count: Starting page for query allowable value is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/nat_objects

Usage Example
https://192.168.1.1/securetrack/api/devices/20/nat_objects?get_total=true
","folder":"1-12","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/nat_objects","collectionId":"1","id":"1-12-48","method":"GET"},{"headers":"Accept: application/json\n","name":"Get NAT rules by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of NAT rules for device given by device ID

input_interface and output_interface are not supported for Panorama running in Advanced management mode
nat_stage is supported for Netscreen and JunOS
nat_type is supported for FortiManager
Note: For Check Point, NAT rules are available from the modules (not managements)
Note: For Palo Alto, filtering NAT rules by interface is only available for firewall devices

Parameters:
context: Global MSSP context [optional]
id: Device ID
input_interface: Input interface for NAT rules, \"any\" for all interfaces [optional]
output_interface: output interface for NAT rules, \"any\" for all interfaces [optional]
nat_stage: NAT stage for NAT rules allowable values: \"pre_policy\" , \"post_policy\" or \"both\" [optional]
nat_type: NAT stage for NAT rules allowable values: \"vip\" or \"reverse_vip\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/10/nat_rules/bindings?input_interface=Any
","folder":"1-12","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/nat_rules/bindings","collectionId":"1","id":"1-12-49","method":"GET"},{"headers":"Accept: application/json\n","name":"Get NAT objects by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches a list of NAT objects for a given revision
Note: NAT objects are only relevant for Check Point management servers and Juniper Netscreen devices.
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.


Parameters:
context: Global MSSP context [optional]
id: Version ID
start: Starting page for query allowable value is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/nat_objects

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/nat_objects?get_total=true
","folder":"1-12","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/nat_objects","collectionId":"1","id":"1-12-50","method":"GET"},{"headers":"Accept: application/json\n","name":"Get network objects by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of network objects defined on device given by ID
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.
The show_members parameter is only relevant if type=group.
If type=group, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.

Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
name: Network object name [optional]
type: Network object type [optional]
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
contains_ip: Get only network objects containing this IP [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]
typeOnDevice: Get EDL groups [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/network_objects

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?get_total=true
OUTPUT {
    \"network_objects\": {
    \"count\": 1,
    \"total\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"hostNetworkObjectDTO\",
                \"id\": 499226,
                \"name\": \"1.1.1.2 not shared\",
                \"display_name\": \"1.1.1.2 not shared\",
                \"class_name\": \"host_plain\",
                \"type\": \"host\",
                \"comment\": \"\",
                \"uid\": \"{EFE8E61B-EE2A-2F55-4C5C-56508661EAA7}\",
                \"implicit\": false,
                \"management_domain\": \"Shared\",
                \"overrides\": false,
                \"ip\": \"1.1.1.2\"
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"count\": 1
        \"network_object\": [
            {
                \"@xsi.type\": \"identityAwarenessDTO\",
                \"id\": 169178,
                \"name\": \"Access_role\",
                \"display_name\": \"Access_role\",
                \"class_name\": \"access_role\",
                \"type\": \"identity_awareness\",
                \"global\": false,
                \"comment\": \"\",
                \"uid\": \"{FC267948-DA8C-4FB6-A736-76B5254BF825}\",
                \"implicit\": false,
                \"overrides\": false,
                \"type_on_device\": \"\",
                \"networks\": {
                    \"network\": {
                        \"@xsi.type\": \"basicNetworkObjectDTO\",
                        \"id\": 168419,
                        \"name\": \"Any\",
                        \"display_name\": \"Any\",
                        \"class_name\": \"any_object\",
                        \"type\": \"basic\",
                        \"global\": false,
                        \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                        \"implicit\": false,
                        \"overrides\": false
                    }
                },
                \"users\": {
                    \"user\": {
                        \"id\": 14320,
                        \"name\": \"ad_group_auto_30K_grp1\",
                        \"display_name\": \"auto_30K_grp1\",
                        \"class_name\": \"ad_group\",
                        \"global\": false,
                        \"comment\": \"\",
                        \"uid\": \"{CAB92DCC-CF63-4E47-B8E3-1E1231996D5E}\",
                        \"dn\": \"CN=auto_30K_grp1,OU=OU_30K_Groups,DC=rnd,DC=local\"
                    }
                }
            },
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?type=group&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 105934,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?typeOnDevice=edl_ip_list&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 1,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 123123,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"type_on_device\": edl_ip_list,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Response Messages:
400: The typeOnDevice value is not valid","folder":"1-13","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/network_objects","collectionId":"1","id":"1-13-51","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific network object","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches a single or partial list of the network objects for a given device ID.
For group network objects, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.
Note: This API retrieves the information from the latest revision.

Parameters:
context: Global MSSP context [optional]
device_id: Device ID
ids: Network object IDs separated by commas
show_members: Set to false to return only the name and ID of the members [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/network_objects/69548

Usage Example
https://192.168.1.1/securetrack/api/devices/31/network_objects/69547,69548,69550

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects/169184?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"network_object\": {
            \"@xsi.type\": \"identityAwarenessDTO\",
            \"id\": 169184,
            \"name\": \"Access_Role_@grp\",
            \"display_name\": \"Access_Role_@grp\",
            \"class_name\": \"access_role\",
            \"type\": \"identity_awareness\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{1870612C-0922-4AEE-81FF-5472DB7C32E1}\",
            \"implicit\": false,
            \"overrides\": false,
            \"type_on_device\": \"\",
            \"networks\": {
                \"network\": {
                    \"@xsi.type\": \"basicNetworkObjectDTO\",
                    \"id\": 168419,
                    \"name\": \"Any\",
                    \"display_name\": \"Any\",
                    \"class_name\": \"any_object\",
                    \"type\": \"basic\",
                    \"global\": false,
                    \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                    \"implicit\": false,
                    \"overrides\": false
                }
            },
            \"users\": {
                \"user\": {
                    \"id\": 14338,
                    \"name\": \"ad_group_grp\",
                    \"display_name\": \"@grp\",
                    \"class_name\": \"ad_group\",
                    \"global\": false,
                    \"comment\": \"\",
                    \"uid\": \"{C5740C23-F36E-4D2E-8B17-1F99C239C12A}\",
                    \"dn\": \"CN=@grp,OU=SC_Users,DC=test,DC=com\"
                }
            }
        }
    }
}

","folder":"1-13","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/network_objects/{{ids}}","collectionId":"1","id":"1-13-52","method":"GET"},{"headers":"Accept: application/json\n","name":"Get network groups containing specified network object","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns groups that contain the specified network object


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the network object.

Usage Example
https://192.168.1.1/securetrack/api/network_objects/69577/groups
","folder":"1-13","url":"https://{{SecureTrack_IP}}/securetrack/api/network_objects/{{id}}/groups","collectionId":"1","id":"1-13-53","method":"GET"},{"headers":"Accept: application/json\n","name":"Get network objects matching specified criteria","data":[{"value":null,"type":"text","enabled":true,"key":"filter"}],"dataMode":"params","description":"You can search for network objects where the IP address, name or comment fields have a specified text string,
or you can search for network objects that have an IP address that matches, contains or is contained in a specified IP subnet,
or you can search for network objects by uid.

Parameters:
context: Returns results for the specified domain ID. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]
filter: “text” filter returns network objects where the IP address, name or comment fields have a specified text string. “subnet” filter returns network objects that have an IP address that matches, contains or is contained in a specified IP subnet. “uid“ filter returns network objects with the specified uid. If no filter is specified, the “text” filter is used.
device_id: Returns network objects belonging to the specified device_id. [optional]
ip: (For “text” filter) You can specify \"ip\" to find network objects with the specified text in the IP address field. [optional]
name: (For “text” filter) You can specify \"name\" to find network objects with the specified text in the name field. [optional]
comment: (For “text” filter) You can specify “comment” to find network objects with the specified text in the comment field. [optional]
any_field: (For “text” filter) You can specify \"any_field\" to find network objects with the specified text in the IP address, name or comment fields. [optional]
exact_match: (For “text” filter) You can add \"exact_match=true\" to find network objects with the specified text in the comment field. If this field is not specified, the query uses \"exact_match=false\". [optional]
contained_in: (For “subnet” filter) You can specify \"contained_in\" to find network objects that are contained in the specified IP subnet. For example, 10.1.0.0 is contained in 10.0.0.0. [optional]
contains: (For “subnet” filter) You can specify \"contains\" to find network objects that contain the specified IP subnet. For example, 10.0.0.0 contains 10.1.0.0. [optional]
exact_subnet: (For “subnet” filter) You can specify \"exact_subnet\" to find network objects that have the specified IP address. [optional]
uid: (for “uid“ filter) Returns network objects with the specified uid. [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]
typeOnDevice: You can specify \"typeOnDevice\" to find network object groups that are EDL. [optional]

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=text&name=host&exact_match=true

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=text&any_field=host&count=10&exact_match=true

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=subnet&contains=10.1.1.0

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=subnet&count=10&exact_subnet=1.1.1.1

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=uid&uid=24a8774d-24c1-4b3a-aae9-3c272a2b5191

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=uid&uid=24a8774d-24c1-4b3a-aae9-3c272a2b5191&device_id=4

Usage Example
URLhttps://192.168.1.1/securetrack/api/network_objects/search?filter=text&name=Access_Role&identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"count\": 1,
        \"total\": 1,
        \"network_object\": {
            \"@xsi.type\": \"identityAwarenessDTO\",
            \"id\": 169197,
            \"name\": \"Access_Role_aaa\",
            \"display_name\": \"Access_Role_aaa\",
            \"class_name\": \"access_role\",
            \"type\": \"identity_awareness\",
            \"global\": false,
            \"device_id\": 158,
            \"comment\": \"\",
            \"uid\": \"{9EDC2607-6BEC-43D7-A99D-B522BA694ADA}\",
            \"implicit\": false,
            \"overrides\": false,
            \"type_on_device\": \"\",
            \"networks\": {
                \"network\": {
                    \"@xsi.type\": \"basicNetworkObjectDTO\",
                    \"id\": 168419,
                    \"name\": \"Any\",
                    \"display_name\": \"Any\",
                    \"class_name\": \"any_object\",
                    \"type\": \"basic\",
                    \"global\": false,
                    \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                    \"implicit\": false,
                    \"overrides\": false
                }
            },
            \"users\": {
                \"user\": {
                    \"id\": 14317,
                    \"name\": \"ad_group_aaa\",
                    \"display_name\": \"aaa\",
                    \"class_name\": \"ad_group\",
                    \"global\": false,
                    \"comment\": \"\",
                    \"uid\": \"{5D16859C-0256-4673-A402-4254588B8F40}\",
                    \"dn\": \"CN=aaa,OU=SC_Users,DC=test,DC=com\"
                }
            }
        }
    }
}


Response Messages:
400: The typeOnDevice value is not valid.Use edl_ip_list as value to search EDL groups.","folder":"1-13","url":"https://{{SecureTrack_IP}}/securetrack/api/network_objects/search","collectionId":"1","id":"1-13-54","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific network objects by revision","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches a single or partial list of the network objects for a given revision.
For group network objects, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision id
ids: Network object IDs separated by commas
show_members: Set to false to return only the name and ID of the members [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/779/network_objects/69548

Usage Example
https://192.168.1.1/securetrack/api/revisions/779/network_objects/69547,69548,69550

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/779/network_objects/69547?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"network_object\": {
            \"@xsi.type\": \"identityAwarenessDTO\",
            \"id\": 169185,
            \"name\": \"Access_Role_Domain Controllers\",
            \"display_name\": \"Access_Role_Domain Controllers\",
            \"class_name\": \"access_role\",
            \"type\": \"identity_awareness\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{140B8F32-188D-414C-A7BE-F4A7D7E9A169}\",
            \"implicit\": false,
            \"overrides\": false,
            \"type_on_device\": \"\",
            \"networks\": {
                \"network\": {
                    \"@xsi.type\": \"basicNetworkObjectDTO\",
                    \"id\": 168419,
                    \"name\": \"Any\",
                    \"display_name\": \"Any\",
                    \"class_name\": \"any_object\",
                    \"type\": \"basic\",
                    \"global\": false,
                    \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                    \"implicit\": false,
                    \"overrides\": false
                }
            },
            \"users\": {
                \"user\": {
                    \"id\": 14237,
                    \"name\": \"ad_group_Domain_Controllers\",
                    \"display_name\": \"Domain Controllers\",
                    \"class_name\": \"ad_group\",
                    \"global\": false,
                    \"comment\": \"\",
                    \"uid\": \"{0A8A459E-58E8-45DC-981E-16BBF2BD1922}\",
                    \"dn\": \"CN=Domain Controllers,CN=Users,DC=rnd,DC=local\"
                }
            }
        }
    }
}

","folder":"1-13","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/network_objects/{{ids}}","collectionId":"1","id":"1-13-55","method":"GET"},{"headers":"Accept: application/json\n","name":"Get network objects by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of network objects from specific revision
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.
The show_members parameter is only relevant if type=group.
If type=group, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.

Parameters:
context: Global MSSP context [optional]
id: Revision id
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
name: Network object name [optional]
type: Network object type [optional]
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
contains_ip: Get only network objects containing this IP [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]
typeOnDevice: Get EDL groups [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/779/network_objects

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?get_total=true
OUTPUT {
    \"network_objects\": {
    \"count\": 1,
    \"total\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"hostNetworkObjectDTO\",
                \"id\": 499226,
                \"name\": \"1.1.1.2 not shared\",
                \"display_name\": \"1.1.1.2 not shared\",
                \"class_name\": \"host_plain\",
                \"type\": \"host\",
                \"comment\": \"\",
                \"uid\": \"{EFE8E61B-EE2A-2F55-4C5C-56508661EAA7}\",
                \"implicit\": false,
                \"management_domain\": \"Shared\",
                \"overrides\": false,
                \"ip\": \"1.1.1.2\"
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/779/network_objects?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
    \"count\": 1,
        \"network_object\": [
            {
                \"@xsi.type\": \"identityAwarenessDTO\",
                \"id\": 169183,
                \"name\": \"Access role 1\",
                \"display_name\": \"Access role 1\",
                \"class_name\": \"access_role\",
                \"type\": \"identity_awareness\",
                \"global\": true,
                \"comment\": \"\",
                \"uid\": \"{1E4C35A0-1FE4-4101-8A38-FDE656BCDCFB}\",
                \"implicit\": false,
                \"overrides\": false,
                \"type_on_device\": \"\",
                \"networks\": {
                    \"network\": {
                        \"@xsi.type\": \"basicNetworkObjectDTO\",
                        \"id\": 168419,
                        \"name\": \"Any\",
                        \"display_name\": \"Any\",
                        \"class_name\": \"any_object\",
                        \"type\": \"basic\",
                        \"global\": false,
                        \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                        \"implicit\": false,
                        \"overrides\": false
                    }
                },
                \"users\": {
                    \"user\": {
                        \"id\": 14346,
                        \"name\": \"all identified\",
                        \"display_name\": \"all identified\",
                        \"class_name\": \"all_identified\",
                        \"global\": false,
                        \"comment\": \"\",
                        \"uid\": \"{17A972AC-4B4A-4715-859F-867128707F59}\",
                        \"dn\": \"\"
                    }
                }
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/31/network_objects?type=group&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 105934,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/31/network_objects?typeOnDevice=edl_ip_list&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 1,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 123123,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"type_on_device\": edl_ip_list,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Response Messages:
400: The typeOnDevice value is not valid","folder":"1-13","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/network_objects","collectionId":"1","id":"1-13-56","method":"GET"},{"headers":"Accept: application/json\n","name":"Get rules containing specified network object","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the security rules that contain the specified network object


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the network object.
include_groups: You can add \"include_groups\" to find rules that include the network object and rules that include the groups that include the network object. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]

Usage Example
https://192.168.1.1/securetrack/api/network_objects/65078/rules?include_groups=true
","folder":"1-13","url":"https://{{SecureTrack_IP}}/securetrack/api/network_objects/{{id}}/rules","collectionId":"1","id":"1-13-57","method":"GET"},{"name":"Add generic device to Topology model","data":[{"value":null,"type":"text","enabled":true,"key":"configuration_file"}],"dataMode":"params","description":"Upload a configuration file that will be used to add a generic device to the Topology model.
The context field is the domain ID to which the generic device is added: If not provided, the device is added to the global domain.
configuration_file must include a valid generic device configuration.
The specified path must point to a file on the computer being sue to make the REST API call.
If update update_topology = true, then the Topology model will be updated immediately after the device is added.
For maximum efficiency, if you are adding multiple generic devices in consecutive API calls, you can set update_topology = false on all API calls except for the last one. On the last call, set update_toplogy = true.Default value for update_topology = true.
For more information on input file formats, refer to Knowledge Center topic 'Adding and Updating a Generic Device'.

Parameters:
body: Generic device to be added
configuration_file: Configuration File for generic device
update_topology: Synchronize And Update Topology [optional]

Usage Example
curl -X POST -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F 'device_data={\"generic_device\":{\"name\": \"my_generic_device\", \"customer_id\": 1}};type=application/json' -F \"configuration_file=@/tmp/config.txt;type=application/octet-stream\" -F \"update_topology=true\" https://192.168.1.1/securetrack/api/generic_devices\n

Response Messages:
201: The generic device was created successfully
401: User is not permitted to access the specified domain
400: Failed to create generic device ","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/","collectionId":"1","id":"1-14-58","method":"POST"},{"headers":"Accept: application/json\n","collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/","name":"Get generic devices that are configured in ST","method":"GET","id":"1-14-59","description":"Returns a list of the generic devices included in all the domains that the user has permission to.
Use context and/or name optional parameters to get more specific results.
To get context optional parameter, you can call /domains/ API and use the id included within the returned domain DTO.

Parameters:
context: Global MSSP context [optional]
name: Generic device name [optional]

Usage Example
https://192.168.1.1/securetrack/api/generic_devices
","folder":"1-14"},{"name":"Get path image for specified traffic","data":[{"value":null,"type":"text","enabled":true,"key":"src"},{"value":null,"type":"text","enabled":true,"key":"dst"},{"value":null,"type":"text","enabled":true,"key":"service"}],"dataMode":"params","description":"Returns an image containing one or more paths for the specified traffic.
src and dst parameters may contain multiple, comma separated values.
Service parameter can be a port (for example, “tcp:80”, “any”) or an application (for example, “Skype”, “Facebook”).
Application names are case sensitive.
Service parameter can also be a combination of ports and applications, for example “tcp:80, Skype, Facebook”
If sourceDomainIdTag is provided, the path starting points will be restricted to the specified domain ID. sourceDomainIdTag is valid only if overlapping IP mode is enabled.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is valid only if MSSP mode is enabled.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.
displayIncompletePaths parameter default value is false, if this parameter is set to true -
all nodes on the path will be displayed, even if the node cannot reach the destination, or if the source and destination are the same.
displayBlockedStatus parameter default value is false, if this parameter is set to true -
blocked traffic icons will be displayed next to devices blocking the traffic.
simulateNat parameter default value is true if this parameter is set to false - NAT simulation will not be used when calculating the path.
lastInstall parameter default value is true, which means simulation would use last installed policies. If this parameter is set to false - simulation would use last saved policies.
This API cannot be executed more than 10 times in parallel.

Parameters:
context: Global MSSP context [optional]
src: Source address/addresses
dst: Destination address/addresses
service: Service/services
sourceDomainIdTag: Path starting point Domain Id [optional]
displayIncompletePaths: Display incomplete paths [optional]
displayBlockedStatus: Display blocked traffic status icons [optional]
simulateNat: Simulate NAT [optional]
lastInstall: Last Installed [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/path_image?src=10.10.10.1&dst=3.3.3.3:32&service=any

Usage Example
https://192.168.1.1/securetrack/api/topology/path_image?src=10.10.10.1&dst=3.3.3.3:32&service=Facebook,tcp:80
","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/path_image","collectionId":"1","id":"1-14-60","method":"GET"},{"headers":"Accept: application/json\n","collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds","name":"Get topology clouds","method":"GET","id":"1-14-61","description":"Returns a list of the topology clouds for all the domains for which the user has permission to access.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
Use the optional name parameter to restrict the results to topology clouds that contain the specified string.
The default pagination is start=0 and count=50.

Parameters:
context: Global MSSP context [optional]
type: Required clouds type [optional]
name: Cloud name [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds
OUTPUT{
    \"topology_clouds\": {
        \"count\": 3,
        \"total\": 3,
        \"topology_cloud\": [
            {
                \"id\": 48,
                \"name\": \"Cloud 69.70.120.155\",
                \"domain\": 1,
                \"type\": \"NON_JOINED\",
                \"ip\": \"69.70.120.155\"
            },
            {
                \"id\": 50,
                \"name\": \"Cloud 10.100.6.238\",
                \"domain\": 1,
                \"type\": \"MEMBER\",
                \"ip\": \"10.100.6.238\"
            },
            {
                \"id\": 66,
                \"name\": \"Cloud 10.100.10.14\",
                \"domain\": 1,
                \"type\": \"JOINED\",
                \"members\": [
                    {
                        \"id\": 50,
                        \"ip\": \"10.100.6.238\",
                        \"name\": \"Cloud 10.100.6.238\"
                    },
                    {
                        \"id\": 73,
                        \"ip\": \"10.100.10.14\",
                        \"name\": \"Cloud 10.100.10.14\"
                    },
                    {
                        \"id\": 74,
                        \"ip\": \"10.100.9.9\",
                        \"name\": \"Cloud 10.100.9.9\"
                    }
                ]
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds?type=non-joined
OUTPUT{
    \"topology_clouds\": {
        \"count\": 2,
        \"total\": 3,
        \"topology_cloud\": [
            {
                \"id\": 48,
                \"name\": \"Cloud 69.70.120.155\",
                \"domain\": 1,
                \"type\": \"NON_JOINED\",
                \"ip\": \"69.70.120.155\"
            },
            {
                \"id\": 50,
                \"name\": \"Cloud 10.100.6.238\",
                \"domain\": 1,
                \"type\": \"NON_JOINED\",
                \"ip\": \"10.100.6.238\"
            }
        ]
    }
}


Response Messages:
401: Access is denied
401: Only users with ‘Super admin’ permissions can access Global domain map
401: You do not have access permission to domain id: domainId
400: Wrong type provided - allowable values are: joined or non-joined","folder":"1-14"},{"headers":"Content-Type: application/json\n","name":"Create a joined topology cloud","dataMode":"raw","description":"Create a new topology cloud in the Interactive Map by joining existing clouds together.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
The body must include at least two topology cloud ids that are on a single domain.
If the context parameter is not provided, then the API will use the context id of the first member of the members list in the body.
Clouds included in the members list of the body must not be joined clouds or members of another joined cloud.
If the provided body does not specify a joined cloud name, the newly created topology cloud will be given the name of the first member of the members list in the body.


Parameters:
context: Global MSSP context [optional]
body: Cloud data

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds
BODY{
    \"cloud_data\":{
        \"cloud_name\" : \"optional new cloud name\",
        \"cloud_members\" : [118,179,258]
    }
}


Response Messages:
201: Joined cloud created successfully
401: Access is denied
401: You do not have access permission to the domain for cloud with id ID
404: Cloud with id ID was not found in the provided MSSP domain
412: You must provide 2 or more clouds
412: Cloud id: cloudId does not belong to domain: Context
412: Cloud with id ID is a joined cloud
412: Cloud with id ID is a member of a joined cloud","folder":"1-14","rawModeData":"{\n\t\"cloud_data\":{\n\t\t\"cloud_name\" : \"optional new cloud name\",\n\t\t\"cloud_members\" : [118,179,258]\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds","collectionId":"1","id":"1-14-62","method":"POST"},{"headers":"Accept: application/json\n","name":"Get path for specified traffic","data":[{"value":null,"type":"text","enabled":true,"key":"src"},{"value":null,"type":"text","enabled":true,"key":"dst"},{"value":null,"type":"text","enabled":true,"key":"service"}],"dataMode":"params","description":"Returns one or more paths for the specified traffic.
src and dst parameters may contain multiple, comma separated values.
Service parameter can be a port (for example, “tcp:80”, “any”) or an application (for example, “Skype”, “Facebook”).
Application names are case sensitive.
Service parameter can also be a combination of ports and applications, for example “tcp:80, Skype, Facebook”
If sourceDomainIdTag is provided, the path starting points will be restricted to the specified domain ID. sourceDomainIdTag is valid only if overlapping IP mode is enabled.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is valid only if MSSP mode is enabled.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.
includeIncompletePaths parameter default value is false, if this parameter is set to true -
all nodes on the path will be included, even if the node cannot reach the destination, or if the source and destination are the same.
simulateNat parameter default value is true if this parameter is set to false - NAT simulation will not be used when calculating the path.
lastInstall parameter default value is true, which means simulation would use last installed policies. If this parameter is set to false - simulation would use last saved policies.
This API cannot be executed more than 10 times in parallel.

Parameters:
context: Global MSSP context [optional]
src: Source address/addresses
dst: Destination address/addresses
service: Service/services
sourceDomainIdTag: Path starting point Domain Id [optional]
includeIncompletePaths: Include incomplete paths [optional]
simulateNat: Simulate NAT [optional]
lastInstall: Last Installed [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/path?src=10.10.10.1&dst=3.3.3.3:32&service=any

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/path?src=29.29.29.1&dst=25.25.25.1&service=Facebook,tcp:80
OUTPUT {
    \"path_calc_results\": {
        \"traffic_allowed\": false,
        \"device_info\": {
            \"id\": \"17\",
            \"name\": \"PA-VM-111.6 (Cluster)\",
            \"type\": \"mgmt\",
            \"vendor\": \"Palo Alto Networks\",
            \"incomingInterfaces\": {
                \"incomingVrf\": \"default\",
                \"ip\": \"29.29.29.1/255.255.255.252\",
                \"name\": \"tunnel.11\"
            },
            \"nextDevices\": {
                \"name\": \"DIRECTLY_CONNECTED\",
                \"routes\": {
                    \"outgoingInterfaceName\": \"ethernet1/5\",
                    \"outgoingVrf\": \"default\",
                    \"routeDestination\": \"25.25.25.1/255.255.255.0\"
                }
            },
            \"bindings\": {
                \"name\": \"\",
                \"rules\": [
                    {
                        \"action\": \"Accept\",
                        \"applications\": \"facebook\",
                        \"destNegated\": false,
                        \"destinations\": \"Any\",
                        \"ruleIdentifier\": 43,
                        \"serviceNegated\": false,
                        \"services\": \"Any\",
                        \"sourceNegated\": false,
                        \"sources\": \"Any\",
                        \"users\": \"Any\"
                    },
                    {
                        \"action\": \"Deny\",
                        \"applications\": \"Any\",
                        \"destNegated\": false,
                        \"destinations\": \"Any\",
                        \"ruleIdentifier\": 62,
                        \"serviceNegated\": false,
                        \"services\": \"Any\",
                        \"sourceNegated\": false,
                        \"sources\": \"Any\",
                        \"users\": \"Any\"
                    }
                ]
            }
        }
    }
}

","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/path","collectionId":"1","id":"1-14-63","method":"GET"},{"headers":"Accept: application/json\n","name":"Get Specific topology subnet","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the subnet for the specified id, including information regarding attached devices and join candidates.
This API requires 'Super admin' or 'Multi-Domain admin' privileges.
Multi-Domain user must have access permission to the domain where the subnet resides.

Parameters:
id: Subnet id

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/subnets/20
OUTPUT{
    \"subnet\": {
        \"id\": 18,
        \"name\": \"90.0.0.0/24\",
        \"ip\": \"90.0.0.0\",
        \"mask\": \"255.255.255.0\",
        \"attached_devices\": {
            \"attached_device\": [
                {
                    \"is_generic\": false,
                    \"id\": 10,
                    \"name\": \"srx\",
                    \"interface_id\": 4,
                    \"interface_name\": \"eth0\",
                    \"interface_ip\": \"90.0.0.1\"
                },
                {
                    \"is_generic\": false,
                    \"id\": 13,
                    \"name\": \"ZBFW\",
                    \"interface_id\": 5,
                    \"interface_name\": \"eth1\",
                    \"interface_ip\": \"90.0.0.124\"
                },
                {
                    \"is_generic\": false,
                    \"id\": 85,
                    \"name\": \"netscreen\",
                    \"interface_id\": 6,
                    \"interface_name\": \"eth2\",
                    \"interface_ip\": \"90.0.0.50\"
                }
            ]
        },
        \"join_candidates\": {
            \"join_candidate\": {
                \"is_generic\": false,
                \"id\": 72,
                \"name\": \"CP25\",
                \"interface_id\": 14,
                \"interface_name\": \"eth24/1\",
                \"interface_ip\": \"90.0.0.83\"
            }
        }
    }
}


Response Messages:
401: Access is denied
401: You do not have access permission to the domain for subnet with id ID
404: No subnet was found for the provided ID","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/subnets/{{id}}","collectionId":"1","id":"1-14-64","method":"GET"},{"headers":"Accept: application/json\n","collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/subnets","name":"Get topology subnets","method":"GET","id":"1-14-65","description":"Returns a list of the topology subnets for all the domains for which the user has permission to access.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
Use the optional name parameter to restrict the results to topology subnet names that match the search criteria provided, as follows:
1. If you provide only a mask, then an exact match search is done on the mask portion of the name
e.g. if name=/2, the results will include 1.2.3.4/2, but not 1.2.3.4/22
2. If you provide only a partial or complete IP address, then a contains search is done in the IPv4 block portion of the name
e.g. name=32, the results will include 192.168.205.32/24 and 55.192.32.22/16, but will not include 55.168.205.5/32
3. If you provide both an IPv4 address (either partial or complete) and a mask, then an exact match search is done
e.g. if name=23.4/2, then the results will include 192.168.23.4/2, but will not include 192.168.23.4/23 or 23.4.192.168/2

The default pagination is start=0 and count=50.

Parameters:
context: Global MSSP context [optional]
name: Subnet name [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/subnets?name=10.27
OUTPUT{
    \"topology_subnets\": {
        \"count\": 4,
        \"total\": 4,
        \"subnets\": [
            {
                \"id\": 615,
                \"name\": \"10.27.122.20/32\",
                \"ip\": \"10.27.122.20\",
                \"mask\": \"255.255.255.255\"
            },
            {
                \"id\": 616,
                \"name\": \"10.27.122.60/32\",
                \"ip\": \"10.27.122.60\",
                \"mask\": \"255.255.255.255\"
            },
            {
                \"id\": 619,
                \"name\": \"10.27.122.0/30\",
                \"ip\": \"10.27.122.0\",
                \"mask\": \"255.255.255.252\"
            },
            {
                \"id\": 620,
                \"name\": \"10.27.122.4/30\",
                \"ip\": \"10.27.122.4\",
                \"mask\": \"255.255.255.252\"
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/subnets?name=144/30
OUTPUT{
    \"topology_subnets\": {
        \"count\": 2,
        \"total\": 2,
        \"subnets\": [
            {
                \"id\": 773,
                \"name\": \"10.13.64.144/30\",
                \"ip\": \"10.13.64.144\",
                \"mask\": \"255.255.255.252\"
            },
            {
                \"id\": 825,
                \"name\": \"10.15.64.144/30\",
                \"ip\": \"10.15.64.144\",
                \"mask\": \"255.255.255.252\"
            }
        ]
    }
}


Response Messages:
401: Access is denied
401: Only users with ‘Super admin’ permissions can access Global domain map
401: You do not have access permission to domain id: domainId","folder":"1-14"},{"headers":"Accept: application/json\n","name":"Get Specific topology cloud","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the topology cloud data for the specified id.
This API requires 'Super admin' or 'Multi-Domain admin' privileges.
Multi-Domain user must have access permission to the domain where the cloud resides.

Parameters:
id: Cloud id

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds/48
OUTPUT{
    \"topology_cloud\": {
        \"id\": 48,
        \"name\": \"Cloud 69.70.120.155\",
        \"domain\": 1,
        \"type\": \"NON_JOINED\",
        \"ip\": \"69.70.120.155\"
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds/66
OUTPUT{
    \"topology_cloud\": {
        \"id\": 66,
        \"name\": \"Cloud 10.100.10.14\",
        \"domain\": 1,
        \"type\": \"JOINED\",
        \"members\": [
            {
                \"id\": 50,
                \"ip\": \"10.100.6.238\",
                \"name\": \"Cloud 10.100.6.238\"
            },
            {
                \"id\": 73,
                \"ip\": \"10.100.10.14\",
                \"name\": \"Cloud 10.100.10.14\"
            },
            {
                \"id\": 74,
                \"ip\": \"10.100.9.9\",
                \"name\": \"Cloud 10.100.9.9\"
            }
        ]
    }
}


Response Messages:
401: Access is denied
401: You do not have access permission to the domain for cloud with id ID
404: No cloud was found for the provided ID","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds/{{id}}","collectionId":"1","id":"1-14-66","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Update a cloud","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"raw","description":"Modify the name of a topology cloud, and add/remove members of a joined cloud.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
Multi-Domain user must have access permission to the domain context of the joined cloud, and any members specified in the body.
To change the name of a topology cloud, enter a value in the name field of the body.
To add/remove members of a joined cloud, specify the action and specify the clouds in the members list of the body.
The action is used only if the body contains a members list. If a members list is provided but no actions is specified, then the default action is ‘add’.
When adding cloud members, clouds included in the members list of the body must not be joined clouds or members of another joined cloud.
When removing cloud members, if only zero or one member remains in the joined cloud, it will be deleted from the Interactive Map.

Parameters:
id: cloud id
action: action [optional]
body: Cloud data

Usage Example
URLfor renaming of any cloud - https://192.168.1.1/securetrack/api/topology/clouds/436
BODY{
    \"cloud_data\":{
        \"cloud_name\" : \"new cloud\"
    }
}


Usage Example
URLfor renaming and members updating of a joined cloud - https://192.168.1.1/securetrack/api/topology/clouds/436?action=remove
BODY{
    \"cloud_data\":{
        \"cloud_name\" : \"new cloud\",
        \"cloud_members\" : [118,179,258]
    }
}


Response Messages:
204: Cloud updated successfully
401: Access is denied
401: You do not have access permission to the domain for cloud with id ID
404: Cloud with id ID was not found in the provided MSSP domain
412: Cloud with id ID is a not joined cloud
412: Cloud id: cloudId does not belong to domain: Context
412: Provided clouds don't belongs to the same domain
412: Cloud with id ID is a joined cloud
412: Cloud with id ID is a member of a joined cloud
412: Member cloud with id ID cannot be removed - it is not a member of a joined cloud","folder":"1-14","rawModeData":"{\n\t\"cloud_data\":{\n\t\t\"cloud_name\" : \"new cloud\",\n\t\t\"cloud_members\" : [118,179,258]\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds/{{id}}","collectionId":"1","id":"1-14-67","method":"PUT"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Get cloud information","data":[{"value":null,"type":"text","enabled":true,"key":"cloud_id"}],"dataMode":"raw","description":"Returns information about a specific cloud in the topology.
This API includes the ID of the cloud, the number of routes that point to the cloud, and the relevant devices (including the management_id) that have routes that point to the cloud.
This information can be used to identify missing devices that may need to be added to the topology or to identify clouds that are candidates for being joined.

Parameters:
cloud_id: cloud id
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/cloud_suggestions/120
BODY{
    \"suggested_clouds\": {
        \"count\": 1,
        \"total\": 1,
        \"cloud\": {
            \"management_name\": \"FW1\",
            \"management_id\": 20,
            \"cloud_name\": \"Cloud 10.100.0.1\",
            \"cloud_id\": 120,
            \"vertex_id\": 250,
            \"ip\": \"10.100.0.1\",
            \"routes_count\": 5,
            \"is_parent\": false
        }
    }
}


Response Messages:
202: Accepted
401: User is not permitted to access the specified domain","folder":"1-14","rawModeData":"{\n\t\"suggested_clouds\": {\n\t\t\"count\": 1,\n\t\t\"total\": 1,\n\t\t\"cloud\": {\n\t\t\t\"management_name\": \"FW1\",\n\t\t\t\"management_id\": 20,\n\t\t\t\"cloud_name\": \"Cloud 10.100.0.1\",\n\t\t\t\"cloud_id\": 120,\n\t\t\t\"vertex_id\": 250,\n\t\t\t\"ip\": \"10.100.0.1\",\n\t\t\t\"routes_count\": 5,\n\t\t\t\"is_parent\": false\n\t\t}\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/cloud_suggestions/{{cloud_id}}","collectionId":"1","id":"1-14-68","method":"GET"},{"headers":"Accept: application/json\n","name":"Get Cloud Internal Networks","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the internal networks for the specified Cloud management id.
This API requires 'Super admin' privileges.

Parameters:
id: Cloud management id

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/cloud_internal_networks/20
OUTPUT{
    \"network_list\":
    {
        \"count\": 3,
        \"total\": 3,
        \"network\":
        {
            \"ip\": \"10.27.122.20\",
            \"mask\": \"255.255.255.255\"
        },
        \"network\":
        {
            \"ip\": \"10.27.122.60\",
            \"mask\": \"255.255.255.255\"
        },
        \"network\":
        {
            \"ip\": \"10.27.122.4\",
            \"mask\": \"255.255.255.252\"
        }
    }
}


Response Messages:
401: Access is denied
401: You do not have access permission to the domain for NSX with id ID
401: Device ID specified is not supported
404: The specified device ID was not found
404: The specified device ID was not found in Topology","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/cloud_internal_networks/{{id}}","collectionId":"1","id":"1-14-69","method":"GET"},{"headers":"Accept: application/json\n","collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/synchronize/status","name":"Get Topology Synchronization status","method":"GET","id":"1-14-70","description":"Returns the progress status of the Topology Model Synchronization.



Usage Example
https://192.168.1.1/securetrack/api/topology/synchronize/status

Response Messages:
200: The topology synchronization was invoked successfully.
401: Access is denied
500: Error getting synchronize progress","folder":"1-14"},{"headers":"Accept: application/json\n","name":"Get most specific network interfaces from which a host IP is accessible","data":[{"value":null,"type":"text","enabled":true,"key":"host"}],"description":"Parameters:
context: Global MSSP context [optional]
host: IP address of device for a query

Usage Example
https://192.168.1.1/securetrack/api/devices/interfaces/last_hop?host=192.168.1.66
","dataMode":"params","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/interfaces/last_hop","collectionId":"1","id":"1-14-71","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Get cloud information","dataMode":"raw","description":"Returns information about all clouds in the topology.
This API includes the ID of the cloud, the number of routes that point to the cloud, and the relevant devices (including the management_id) that have routes that point to the cloud.
This information can be used to identify missing devices that may need to be added to the topology or to identify clouds that are candidates for being joined.

Parameters:
context: Global MSSP context [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/cloud_suggestions
BODY{
    \"suggested_clouds\": {
        \"count\": 2,
        \"total\": 2,
        \"cloud\": [
            {
                \"management_name\": \"FW1\",
                \"management_id\": 20,
                \"cloud_name\": \"Cloud 10.100.0.1\",
                \"cloud_id\": 120,
                \"vertex_id\": 250,
                \"ip\": \"10.100.0.1\",
                \"routes_count\": 5,
                \"is_parent\": false
            },
            {
                \"management_name\": \"FW2\",
                \"management_id\": 21,
                \"cloud_name\": \"Cloud 172.16.0.1\",
                \"cloud_id\": 125,
                \"vertex_id\": 270,
                \"ip\": \"172.16.0.1\",
                \"routes_count\": 7,
                \"is_parent\": false,
                \"parent_vertex_id\": 40
                \"parent_cloud_id\": 45
                \"parent_cloud_name\": \"Cloud 172.16.0.1\",
            }
        ]
    }
}


Response Messages:
202: Accepted
401: User is not permitted to access the specified domain","folder":"1-14","rawModeData":"{\n\t\"suggested_clouds\": {\n\t\t\"count\": 2,\n\t\t\"total\": 2,\n\t\t\"cloud\": [\n\t\t\t{\n\t\t\t\t\"management_name\": \"FW1\",\n\t\t\t\t\"management_id\": 20,\n\t\t\t\t\"cloud_name\": \"Cloud 10.100.0.1\",\n\t\t\t\t\"cloud_id\": 120,\n\t\t\t\t\"vertex_id\": 250,\n\t\t\t\t\"ip\": \"10.100.0.1\",\n\t\t\t\t\"routes_count\": 5,\n\t\t\t\t\"is_parent\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"management_name\": \"FW2\",\n\t\t\t\t\"management_id\": 21,\n\t\t\t\t\"cloud_name\": \"Cloud 172.16.0.1\",\n\t\t\t\t\"cloud_id\": 125,\n\t\t\t\t\"vertex_id\": 270,\n\t\t\t\t\"ip\": \"172.16.0.1\",\n\t\t\t\t\"routes_count\": 7,\n\t\t\t\t\"is_parent\": false,\n\t\t\t\t\"parent_vertex_id\": 40\n\t\t\t\t\"parent_cloud_id\": 45\n\t\t\t\t\"parent_cloud_name\": \"Cloud 172.16.0.1\",\n\t\t\t}\n\t\t]\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/cloud_suggestions","collectionId":"1","id":"1-14-72","method":"GET"},{"headers":"Accept: application/json\n","name":"Get topology network interfaces by device","data":[{"value":null,"type":"text","enabled":true,"key":"mgmtId"}],"dataMode":"params","description":"The returned interfaces are taken from the topology data and will include only devices that are topology enabled.
When adding a device, the user can can choose whether to use dynamic or static topology for the device,
this choice will determine which kind of data is stored in the topology graph and returned by this API.

The parameter mgmtId should be a cluster or a gateway, not a management server.
You may provide a generic device Id (see generic_devices API under 'Monitored Devices' category) -
in this case make sure you set 'is_generic' parameter to 'true'

Parameters:
context: Global MSSP context [optional]
mgmtId: Management Id or Generic Device Id to query
is_generic: Should be set to 'true' if the provided mgmtId is related to generic device [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_interfaces?mgmtId=10

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_interfaces?mgmtId=1&is_generic=true
","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/topology_interfaces","collectionId":"1","id":"1-14-73","method":"GET"},{"headers":"Accept: application/json\n","name":"Get topology routing tables for a given device","data":[{"value":null,"type":"text","enabled":true,"key":"mgmtId"}],"dataMode":"params","description":"The returned routing tables are taken from the topology data and will include only devices that are topology enabled.
When adding a device, the user can can choose whether to use dynamic or static topology for the device,
this choice will determine which kind of data is stored in the topology graph and returned by this API.

The parameter mgmtId should be a cluster or a gateway, not a management server.
You may provide a generic device Id (see generic_devices API under 'Monitored Devices' category) -
in this case make sure you set 'is_generic' parameter to 'true'

Parameters:
mgmtId: Management Id or Generic Device Id to query
is_generic: Should be set to 'true' if the provided mgmtId is related to generic device [optional]
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query from starting page, allowable type is numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_routes?mgmtId=10

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_routes?mgmtId=1&is_generic=true
","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/topology_routes","collectionId":"1","id":"1-14-74","method":"GET"},{"headers":"Accept: application/json\n","collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic_vpns{device_id:(/device_id)?}","name":"Get topology generic VPN connections","method":"GET","id":"1-14-75","description":"Returns a list of the generic vpn connections in the Topology map, for all the domains for which the user has permission to access.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
Use the optional name parameter to restrict the results to topology generic vpn connections that contain the specified string.
The default pagination is start=0 and count=50.

Parameters:
context: Global MSSP context [optional]
is_generic: Get generic devices [optional]
device_id: Device id [optional]
name: VPN connection name (accepts '*', '?' as wildcards) [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/generic_vpns
OUTPUT{
    \"generic_vpns\": {
        \"count\": 3,
        \"total\": 3,
        \"generic_vpn\": [
            {
                \"device_id\": 222,
                \"generic\": false,
                \"id\": 3,
                \"interface_name\": \"tunnel.2\",
                \"tunnel_dest_ip\": \"54.239.63.155\",
                \"tunnel_src_ip\": \"84.200.6.1\",
                \"vpn_name\": \"Palo_to_AWS\"
            },
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 4,
                \"interface_name\": \"tunnel.1\",
                \"tunnel_dest_ip\": \"54.239.63.156\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 5,
                \"interface_name\": \"tunnel.2\",
                \"tunnel_dest_ip\": \"54.239.63.157\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/generic_vpns?is_generic=true
OUTPUT{
    \"generic_vpns\": {
        \"count\": 2,
        \"total\": 2,
        \"generic_vpn\": [
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 4,
                \"interface_name\": \"tunnel.1\",
                \"tunnel_dest_ip\": \"54.239.63.156\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 5,
                \"interface_name\": \"tunnel.2\",
                \"tunnel_dest_ip\": \"54.239.63.157\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
        ]
    }
}


Response Messages:
401: Access is denied
401: Only users with ‘Super admin’ permissions can access Global domain map
401: You do not have access permission to domain id: domainId
400: Wrong type provided - allowable values are: joined or non-joined","folder":"1-14"},{"name":"Delete generic device from Topology model","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Delete a generic device from the Topology model.
The ID must be for a valid generic device listed in the Topology Model.
If update update_topology = true, then the Topology model will be updated immediately after the device is deleted.
For maximum efficiency, if you are deleting multiple generic devices in consecutive API calls, you can set update_topology = false on all API calls except for the last one. On the last call, set update_toplogy = true.
Default value for update_topology = true.

Parameters:
id: Generic device id
update_topology: Synchronize And Update Topology [optional]

Usage Example
https://192.168.1.1/securetrack/api/generic_devices/1

Usage Example
https://192.168.1.1/securetrack/api/generic_devices/10?update_topology=false

Response Messages:
204: Generic Device deleted successfully.
400: Failed to delete generic device with id {}
404: A 'Generic Device' with the specified ID was not found","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/{{id}}","collectionId":"1","id":"1-14-76","method":"DELETE"},{"name":"Update an existing generic device in the Topology model","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Modify an existing generic device by uploading a new configuration file and/or specifying a new name.
If name field is specified, the generic device will be renamed.
configuration_file is optional, if provided it must include a valid generic device configuration.
The specified path points to a file in the client machine.
If a generic device name is changed and a new configuration file is not provided, topology will not be synchronized (update_topology flag is ignored).
Default value for update_topology = true.
To save time when there are several consecutive api calls: For the last call, set update_topology = true (for all other calls, update_topology = false).
For more information on input file formats, refer to Knowledge Center topic 'Adding and Updating a Generic Device'.

Parameters:
id: Generic device id
body: Generic device to be updated [optional]
configuration_file: Configuration File for generic device [optional]
update_topology: Synchronize And Update Topology [optional]

Usage Example
curl -X PUT -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F \"configuration_file=@/tmp/config.txt;type=application/octet-stream\" -F \"update_topology=true\" https://192.168.1.1/securetrack/api/generic_devices/24

Usage Example
curl -X PUT -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F 'device_data={\"generic_device\":{\"name\": \"new_generic_device_name\"}};type=application/json' -F \"update_topology=false\" https://192.168.1.1/securetrack/api/generic_devices/72

Response Messages:
204: The generic device was updated successfully.
400: A new name or a new configuration file must be indicated in order to update generic device with id {}
400: Failed to update generic device with id {}
404: A 'Generic Device' with the specified ID was not found","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/{{id}}","collectionId":"1","id":"1-14-77","method":"PUT"},{"headers":"Accept: application/json\n","collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/synchronize","name":"Synchronize the Topology model","method":"POST","id":"1-14-78","description":"Invoke of the Topology Model Synchronization.
full_sync=false - Builds the topology model from the information stored in the Tufin database.
full_sync=true - Retrieves the current data from devices and builds the topology model.
Default value for full_sync = false.

Parameters:
full_sync: Perform full sync [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/synchronize

Usage Example
https://192.168.1.1/securetrack/api/topology/synchronize?full_sync=true

Response Messages:
200: The topology synchronization was invoked successfully.
401: Access is denied
500: Error Synchronizing Topology Model","folder":"1-14"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Get all pattern entries for specific zones","dataMode":"raw","description":"Get the list of zone pattern entries for specific zones by identifiers

Parameters:
context: Global MSSP context. [optional]
ids: Filter by IDs for the pattern entry results. [optional]
pattern: Filter by pattern string for the zone entry results. [optional]
name: Filter by zone name for the pattern entry results. [optional]
comment: Filter by comment for the pattern entry results. [optional]
sort: Sort ascending or descending. [optional]
start: Starting page number for query results. [optional]
count: Number of pages to return for the query, starting from the specified starting page. [optional]
children: Include child zones in the results. [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/1,2/pattern-entries
BODY<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<pattern_match_entries_find_result>
    <paging_info>
        <start>0</start>
        <count>2</count>
        <total>2</total>
    </paging_info>
    <pattern_match_entries>
        <pattern_match_entry>
            <id>2</id>
            <type>security_group_by_name</type>
            <comment>This is a comment</comment>
            <pattern>WEB</pattern>
            <zone_id>1</zone_id>
        </pattern_match_entry>
        <pattern_match_entry>
            <id>3</id>
            <type>security_group_by_name</type>
            <comment>This is a comment</comment>
            <pattern>WEo</pattern>
            <zone_id>2</zone_id>
        </pattern_match_entry>
    </pattern_match_entries>
</pattern_match_entries_find_result>


Response Messages:
200: The zone pattern entries were successfully retrieved.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-15","rawModeData":"\n\n\t\n\t\t0\n\t\t2\n\t\t2\n\t\n\t\n\t\t\n\t\t\t2\n\t\t\tsecurity_group_by_name\n\t\t\tThis is a comment\n\t\t\tWEB\n\t\t\t1\n\t\t\n\t\t\n\t\t\t3\n\t\t\tsecurity_group_by_name\n\t\t\tThis is a comment\n\t\t\tWEo\n\t\t\t2\n\t\t\n\t\n\n","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/pattern-entries","collectionId":"1","id":"1-15-79","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create a zone pattern entry in a specific zone","data":[{"value":null,"type":"text","enabled":true,"key":"zone_id"}],"dataMode":"raw","description":"Create a zone pattern entry in a specific zone by identifier

Parameters:
context: Global MSSP context. [optional]
zone_id: Identifier of the zone containing the zone pattern entry.
body: The zone pattern entry to create.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/pattern-entries
BODY<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<create_pattern_match_entry>
    <pattern_match_entry>
        <id>1</id>
        <zone_id>2</zone_id>
        <domain>
            <id>1</id>
            <name>Default</name>
        </domain>
        <pattern>WEB</pattern>
        <type>security_group_by_name</type>
        <comment>This is a comment</comment>
    </pattern_match_entry>
</create_pattern_match_entry>


Response Messages:
201: The zone pattern entry was created successfully.
401: User is not permitted to access the specified domain
400: Some of pattern entry parameters were invalid or missing
404: A zone with the specified identifier was not found.","folder":"1-15","rawModeData":"\n\n\t\n\t\t1\n\t\t2\n\t\t\n\t\t\t1\n\t\t\tDefault\n\t\t\n\t\tWEB\n\t\tsecurity_group_by_name\n\t\tThis is a comment\n\t\n","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/pattern-entries","collectionId":"1","id":"1-15-80","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Get a specific zone pattern entry for a specific zone","data":[{"value":null,"type":"text","enabled":true,"key":"zone_id"},{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"raw","description":"Get a specific zone pattern entry for a specific zone by identifier

Parameters:
context: Global MSSP context. [optional]
zone_id: Identifier of the zone containing the zone entry.
id: Identifier of the zone pattern entry.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/75/pattern-entries/2
BODY<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<pattern_match_entry>
    <id>2</id>    <type>security_group_by_name</type>
    <comment>This is a comment</comment>
    <pattern>WEB</pattern>
    <zone_id>75</zone_id>
    <zone_name>Zone_10_0_0_1</zone_name>
    <domain>
        <address>koko</address>
        <description>bobo</description>
        <id>1</id>
        <name>Default</name>
    </domain>
</pattern_match_entry>


Response Messages:
200: The zone pattern entry was successfully retrieved.
401: User is not permitted to access the specified domain
404: A zone with the specified identifier was not found.
404: A zone pattern entry with the specified identifier was not found.","folder":"1-15","rawModeData":"\n\n\t2\tsecurity_group_by_name\n\tThis is a comment\n\tWEB\n\t75\n\tZone_10_0_0_1\n\t\n\t\t
koko
\n\t\tbobo\n\t\t1\n\t\tDefault\n\t\n\n","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/pattern-entries/{{id}}","collectionId":"1","id":"1-15-81","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Modify multiple existing zone entries","data":[{"value":null,"type":"text","enabled":true,"key":"zone_ids"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"raw","description":"For IPv4 entry provide IP and netmask/prefix.
For IPv6 provide IP and prefix only, netmask is not allowed.
new_zone_id is not optional, it may be the same as the present zoneId.

Parameters:
context: Global MSSP context. [optional]
zone_ids: The ID(s) of the zones containing the zone entries.
ids: The ID(s) of the zone entries to modify.
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/85,98/entries/120,139
BODY{
\"zone_entries\" : {
        \"zone_entry\": [
            {
                \"id\": 120,
                \"ip\": \"3.3.3.3\",
                \"prefix\": 32,
                \"new_zone_id\": 85
            },
            {
                \"id\": 139,
                \"ip\": \"1b98:c72:1f00:0001::\",
                \"prefix\": \"52\",
                \"new_zone_id\": 98
            }
        ]
}
}


Response Messages:
200: The zone entry was modified successfully.
401: User is not permitted to access the specified domain
400: The zone entry parameters were invalid
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found.","folder":"1-16","rawModeData":"{\n\"zone_entries\" : {\n\t\t\"zone_entry\": [\n\t\t\t{\n\t\t\t\t\"id\": 120,\n\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\"prefix\": 32,\n\t\t\t\t\"new_zone_id\": 85\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": 139,\n\t\t\t\t\"ip\": \"1b98:c72:1f00:0001::\",\n\t\t\t\t\"prefix\": \"52\",\n\t\t\t\t\"new_zone_id\": 98\n\t\t\t}\n\t\t]\n}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_ids}}/entries/{{ids}}","collectionId":"1","id":"1-16-82","method":"PUT"},{"headers":"Content-Type: application/json\n","name":"Create a zone entry","data":[{"value":null,"type":"text","enabled":true,"key":"zone_id"}],"dataMode":"raw","description":"For IPv4 entry provide IP and netmask/prefix (see Usage Example #1 and #2).
For IPv6 provide IP and prefix only, netmask is not allowed(see Usage Example #3).

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
body: The zone entry to create.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"netmask\": \"255.255.255.0\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"prefix\": \"24\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries
BODY{
\"zone_entry\": {
    \"ip\": \"1b98:c72:1f00:0000::\",
    \"prefix\": \"52\"
    }
}


Response Messages:
201: The zone entry was created successfully.
401: User is not permitted to access the specified domain
400: The zone entry parameters were invalid
404: A zone with the specified ID was not found.","folder":"1-16","rawModeData":"{\n\"zone_entry\": {\n\t\"ip\": \"1b98:c72:1f00:0000::\",\n\t\"prefix\": \"52\"\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries","collectionId":"1","id":"1-16-83","method":"POST"},{"headers":"Content-Type: application/json\n","name":"Modify a zone entry","data":[{"value":null,"type":"text","enabled":true,"key":"zone_id"},{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"raw","description":"For IPv4 entry provide IP and netmask/prefix (see Usage Example #1 and #2).
For IPv6 provide IP and prefix only, netmask is not allowed(see Usage Example #3).

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
id: The ID of the zone entry.
body: The modified zone entry.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries/1
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"netmask\": \"255.255.255.0\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries/1
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"prefix\": \"24\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries/1
BODY{
\"zone_entry\": {
    \"ip\": \"1b98:c72:1f00:0000::\",
    \"prefix\": \"52\"
    }
}


Response Messages:
200: The zone entry was modified successfully.
401: User is not permitted to access the specified domain
400: The zone entry parameters were invalid
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found.","folder":"1-16","rawModeData":"{\n\"zone_entry\": {\n\t\"ip\": \"1b98:c72:1f00:0000::\",\n\t\"prefix\": \"52\"\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries/{{id}}","collectionId":"1","id":"1-16-84","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get a specific zone entry","data":[{"value":null,"type":"text","enabled":true,"key":"zone_id"},{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Get a specific zone entry by ID for a zone.

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
id: The ID of the zone entry.

Usage Example
https://192.168.1.1/securetrack/api/zones/2/entries/123

Response Messages:
200: The zone entry was successfully retrieved.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found.","folder":"1-16","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries/{{id}}","collectionId":"1","id":"1-16-85","method":"GET"},{"name":"Delete zone entries","data":[{"value":null,"type":"text","enabled":true,"key":"zone_id"},{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Delete existing zone entries.

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
id: The ID of the zone entry to delete.

Usage Example
https://192.168.1.1/securetrack/api/zones/2/entries/10

Response Messages:
200: The zone entry was deleted successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found.","folder":"1-16","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries/{{id}}","collectionId":"1","id":"1-16-86","method":"DELETE"},{"headers":"Accept: application/json\n","collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/entries","name":"Get entries for a zone","method":"GET","id":"1-16-87","description":"Get the list of zone entries for a zone.

Parameters:
context: Global MSSP context. [optional]
ids: Filter by IDs for the zone entry results. [optional]
name: Filter by name for the zone entry results. [optional]
ip: Filter by IP for the zone entry results. [optional]
netmask: Filter by netmask for the zone entry results. [optional]
prefix: Filter by prefix for the zone entry results. [optional]
comment: Filter by comment for the zone entry results. [optional]
group: Filter by device group for the zone entry results. [optional]
sort: Sort ascending or descending. [optional]
start: Starting page number for query results. [optional]
count: Number of pages to return for the query, starting from the specified starting page. [optional]
children: Include child zones in the results. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/2/entries

Response Messages:
200: The zone entries were successfully retrieved.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-16"},{"name":"Modify a zone entry","data":[{"value":null,"type":"text","enabled":true,"key":"zone_ids"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Modify an existing zone entry.

Parameters:
context: Global MSSP context. [optional]
zone_ids: The ID(s) of the zones containing the zone entry.
ids: The ID(s) of the zone entries to delete.

Usage Example
https://192.168.1.1/securetrack/api/zones/2,3/entries/10,20

Response Messages:
200: The zone entry was deleted successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found.","folder":"1-16","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_ids}}/entries/{{ids}}","collectionId":"1","id":"1-16-88","method":"DELETE"},{"name":"Delete a zone","data":[{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Delete an existing zone.

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zone to delete.

Usage Example
https://192.168.1.1/securetrack/api/zones/1,2

Response Messages:
204: The specified zone was successfully deleted.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}","collectionId":"1","id":"1-17-89","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get descendant zones for a zone","data":[{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Get a list of zones descended from the specified zone(s).

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones for which to look for descendant zones.

Usage Example
https://192.168.1.1/securetrack/api/zones/10,20/descendants

Response Messages:
200: The zone descendants were retrieved successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/descendants","collectionId":"1","id":"1-17-90","method":"GET"},{"headers":"Accept: application/json\n","name":"Get ancestor zones for a zone","data":[{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Get a list of ancestor zones for the specified zone(s).

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones for which to look for ancestor zones.

Usage Example
https://192.168.1.1/securetrack/api/zones/123,234/ancestors

Response Messages:
200: The zone ancestors were retrieved successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/ancestors","collectionId":"1","id":"1-17-91","method":"GET"},{"headers":"Accept: application/json\n","collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/shared","name":"Get shared zones","method":"GET","id":"1-17-92","description":"Get a list of shared zones.

Parameters:
context: Global MSSP context. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/shared

Response Messages:
200: The list of shared zones was retrieved successfully.
401: User is not permitted to access the specified domain","folder":"1-17"},{"collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/import/{{ids}}","name":"Import a zone","method":"POST","id":"1-17-93","description":"Import a shared zone into the specified domain

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones to import. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/import/10,20

Response Messages:
200: The zone was imported successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17"},{"name":"Remove a zone as an descendants to a zone","data":[{"value":null,"type":"text","enabled":true,"key":"parent_id"},{"value":null,"type":"text","enabled":true,"key":"child_ids"}],"dataMode":"params","description":"Remove a zone(s) as an descendants to a existing zone.

Parameters:
context: Global MSSP context. [optional]
parent_id: The ID of the zone for which to remove descendant zone(s).
child_ids: The ID(s) of the zone to remove as a descendant.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/descendants/10,20

Response Messages:
200: The zone was removed as an descendant successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{parent_id}}/descendants/{{child_ids}}","collectionId":"1","id":"1-17-94","method":"DELETE"},{"name":"Add a zone as a descendant to a zone","data":[{"value":null,"type":"text","enabled":true,"key":"parent_id"},{"value":null,"type":"text","enabled":true,"key":"child_ids"}],"dataMode":"params","description":"Add a zone(s) as a descendant to a existing zone.

Parameters:
context: Global MSSP context. [optional]
parent_id: The ID of the zone for which to add descendant zone(s).
child_ids: The ID(s) of the zones to add as descendants.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/descendants/10,20

Response Messages:
200: The zone was added as an descendant successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{parent_id}}/descendants/{{child_ids}}","collectionId":"1","id":"1-17-95","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get configuration usages for a zone","data":[{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Get a list of configuration usages for the specified zone(s).

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones for which to look for configuration dependencies.

Usage Example
https://192.168.1.1/securetrack/api/zones/2,3/dependencies

Response Messages:
200: The zone dependencies were retrieved successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/dependencies","collectionId":"1","id":"1-17-96","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create a zone","dataMode":"raw","description":"Create a zone.

Parameters:
context: Global MSSP context. [optional]
body: The zone to add.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones
BODY<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<zone>
    <name>DMZ</name>
    <comment>All DMZ addresses</comment>
    <shared>false</shared>
</zone>


Response Messages:
201: The zone was created successfully.
401: User is not permitted to access the specified domain
400: The zone parameters were invalid","folder":"1-17","rawModeData":"\n\n\tDMZ\n\tAll DMZ addresses\n\tfalse\n","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/","collectionId":"1","id":"1-17-97","method":"POST"},{"collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/","name":"Delete all zones","method":"DELETE","id":"1-17-98","description":"Delete all existing zones.

Parameters:
context: Global MSSP context. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones

Response Messages:
204: All zones were successfully deleted.
401: User is not permitted to access the specified domain","folder":"1-17"},{"headers":"Accept: application/json\n","collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/","name":"Get all zones","method":"GET","id":"1-17-99","description":"Gets a list of all zones.

Parameters:
context: Global MSSP context. [optional]
name: Filter by zone name for the zone results. [optional]
comment: Filter by zone comment for the zone results. [optional]
imported: List domains that imported zones. [optional]
includeInternet: Include the Internet zone. [optional]
includeImported: Include imported zones. [optional]
sort: Sort ascending or descending. [optional]
start: Starting page number for query results. [optional]
count: Number of pages to return for the query, starting from the specified starting page. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones

Response Messages:
200: The zones were retrieved successfully.
401: User is not permitted to access the specified domain","folder":"1-17"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Map network elements to security zones","dataMode":"raw","description":"This API maps each network element in the AccessRequestNetworkListDTO (such as IP address, IP address range, object, or group) to all matching Tufin security zones. If the network element is a group, then each zone also identifies all matching group members. The internet referral object can be included in the list, and will always map to the predefined Internet security zone. If the 'Any' element is included in the list it will map to all zones.
Note: if multi-domain mode is enabled, the API calls only checks zones that are in the “Default” domain.

Parameters:
body: AccessRequestNetworkListDTO

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_zones
BODY<network_objects>
     <network_object xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"ip_network\">
         <network xsi:type=\"raw_network_subnet\">
         <ip>10.8.8.0</ip>
         <mask>255.255.255.0</mask>
         </network>
     </network_object>
</network_objects>


Response Messages:
200: Returns mapping of network elements to security zones
400: Access Request Network List is malformed.
401: Access is denied.","folder":"1-17","rawModeData":"\n\t \n\t\t \n\t\t 10.8.8.0\n\t\t 255.255.255.0\n\t\t \n\t \n","url":"https://{{SecureTrack_IP}}/securetrack/api/security_zones/","collectionId":"1","id":"1-17-100","method":"POST"},{"headers":"Accept: application/json\n","name":"Get a specific zone","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Get the zone with the specified ID.

Parameters:
context: Global MSSP context. [optional]
id: The ID of the zone to get.
imported: List domains that imported zones. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/2

Response Messages:
200: The zone was retrieved successfully.
401: User is not permitted to access the specified domain
401: A zone with the specified ID does not exist.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{id}}","collectionId":"1","id":"1-17-101","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Modify a zone","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"raw","description":"Modify an existing zone.

Parameters:
context: Global MSSP context. [optional]
id: The ID of the zone to modify.
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2
BODY<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<zone>
    <id>2</id>
    <name>DMZ</name>
    <comment>All DMZ hosts</comment>
    <shared>false</shared>
    <internet>false</internet>
    <user_networks>false</user_networks>
    <unassociated_networks>false</unassociated_networks>
</zone>


Response Messages:
204: The specified zone was successfully modified.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
400: The zone parameters were invalid","folder":"1-17","rawModeData":"\n\n\t2\n\tDMZ\n\tAll DMZ hosts\n\tfalse\n\tfalse\n\tfalse\n\tfalse\n","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{id}}","collectionId":"1","id":"1-17-102","method":"PUT"},{"name":"Remove a zone as an ancestor to a zone","data":[{"value":null,"type":"text","enabled":true,"key":"child_id"},{"value":null,"type":"text","enabled":true,"key":"parent_ids"}],"dataMode":"params","description":"Remove a zone(s) as an ancestor to a existing zone.

Parameters:
context: Global MSSP context. [optional]
child_id: The ID of the zone for which to remove ancestors zone(s).
parent_ids: The ID(s) of the zones to remove as ancestors.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/ancestors/10,20

Response Messages:
200: The zone was removed as an ancestor successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{child_id}}/ancestors/{{parent_ids}}","collectionId":"1","id":"1-17-103","method":"DELETE"},{"name":"Add a zone as an ancestor to a zone","data":[{"value":null,"type":"text","enabled":true,"key":"child_id"},{"value":null,"type":"text","enabled":true,"key":"parent_ids"}],"dataMode":"params","description":"Add a zone(s) as an ancestor to a existing zone.

Parameters:
context: Global MSSP context. [optional]
child_id: The ID of the zone for which to add ancestors zone(s).
parent_ids: The ID(s) of the zones to add as ancestors.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/ancestors/10,20

Response Messages:
200: The zone was added as an ancestor successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{child_id}}/ancestors/{{parent_ids}}","collectionId":"1","id":"1-17-104","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get rules by input and output interfaces","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"}],"description":"Parameters:
device_id: The unique identifier of target device
inputInterfaceName: Input interface name [optional]
outputInterfaceName: Output interface name [optional]

Usage Example
https://192.168.1.1/securetrack/api/bindings/2/topology_interfaces?inputInterfaceName=ethernet1/1&outputInterfaceName=ethernet1/2
","dataMode":"params","folder":"1-18","url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/topology_interfaces","collectionId":"1","id":"1-18-105","method":"GET"},{"headers":"Accept: application/json\n","name":"Get sub-policies (bindings) by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns a list of all of the subpolicies (bindings) for a given device.
The definition of subpolicy is different for each vendor:
Check Point - policy package and inline layer (inline layer will be returned only when the optional include_subpolicy parameter is set to true)
Cisco - ACL
Juniper/Fortinet/Palo Alto/Stonesoft - zone-to-zone policy
Cloud platforms - Security Groups


Parameters:
context: Global MSSP context [optional]
id: Device ID
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
include_subpolicy: when set to true, includes sub policies in the returned result, supported only for Checkpoint [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/bindings

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/bindings? include_subpolicy=true
","folder":"1-18","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/bindings","collectionId":"1","id":"1-18-106","method":"GET"},{"headers":"Accept: application/json\n","name":"Get policies by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of policies defined on a given revision ID

Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/policies
","folder":"1-18","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/policies","collectionId":"1","id":"1-18-107","method":"GET"},{"headers":"Accept: application/json\n","name":"Get list of sub-policies (bindings) with input and/or output interfaces","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"supremum_version_id"},{"value":null,"type":"text","enabled":true,"key":"inputInterfaceName"},{"value":null,"type":"text","enabled":true,"key":"outputInterfaceName"}],"dataMode":"params","description":"Retrieve list of bindings of input and/or output interfaces

Parameters:
device_id: The unique identifier of target device
supremum_version_id: The unique identifier of target revision
inputInterfaceName: Input interface name
outputInterfaceName: Output interface name

Usage Example
https://192.168.1.1/securetrack/api/bindings/20/binding_query?supremum_version_id=785&inputInterfaceName=Any&outputInterfaceName=Any
","folder":"1-18","url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/binding_query","collectionId":"1","id":"1-18-108","method":"GET"},{"headers":"Accept: application/json\n","name":"Get sub-policies (bindings) by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns a list of all of the subpolicies (bindings) for a given revision.
The definition of subpolicy is different for each vendor:
Check Point - policy package and inline layer (inline layer will be returned only when the optional include_subpolicy parameter is set to true)
Cisco - ACL
Juniper/Fortinet/Palo Alto/Stonesoft - zone-to-zone policy
Cloud platforms - Security Groups


Parameters:
context: Global MSSP context [optional]
id: Revision ID
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
include_subpolicy: when set to true, includes sub policies in the returned result, supported only for Checkpoint [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/bindings

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/bindings? include_subpolicy=true
","folder":"1-18","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/bindings","collectionId":"1","id":"1-18-109","method":"GET"},{"headers":"Accept: application/json\n","name":"Get policies by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of policies defined on a given device ID.
Supported devices: CheckPoint, Panorama Advanced, FortiManager Basic and Advanced, FMC and NSX.

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/20/policies
","folder":"1-18","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/policies","collectionId":"1","id":"1-18-110","method":"GET"},{"headers":"Accept: application/json\n","name":"Run Policy Analysis query","data":[{"value":null,"type":"text","enabled":true,"key":"device_ids"},{"value":null,"type":"text","enabled":true,"key":"sources"},{"value":null,"type":"text","enabled":true,"key":"destinations"},{"value":null,"type":"text","enabled":true,"key":"services"}],"description":"Parameters:
device_ids: Device ids
sources: Source list
destinations: Destination list
services: Service list
exclude_any: Exclude any in the specified, comma-separated fields of source, destination or service. For example: exclude_any = destination,service [optional]
action: Action [optional]

Usage Example
https://192.168.1.1/securetrack/api/policy_analysis/query/matching_rules?device_ids=41&sources=33.33.33.0:24,113.113.113.100&destinations=114.1.1.0:24&services=tcp:80&exclude_any=source,destination

Response Messages:
200: Returns request results.
400: Error in request syntax.","dataMode":"params","folder":"1-19","url":"https://{{SecureTrack_IP}}/securetrack/api/policy_analysis/query/matching_rules","collectionId":"1","id":"1-19-111","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific rule documentation","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"rule_id"}],"dataMode":"params","description":"Fetches rule documentation for a single rule given by device ID and rule ID

Parameters:
context: Global MSSP context [optional]
id: Device ID
rule_id: Rule ID

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules/16373/documentation
","folder":"1-20","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules/{{rule_id}}/documentation","collectionId":"1","id":"1-20-112","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Modify specific rule documentation","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"rule_id"}],"dataMode":"raw","description":"Modify rule documentation for a single rule given by device ID and rule ID
A single rule can be set as either a stealth rule or legacy rule. If both flags are set, an error will be returned (error 400, Bad request).
If there is no existing rule documentation for the rule, the specified documentation is added to the rule and the response code is: 201 Created.
If there is existing rule documentation for the rule, the specified documentation replaces the existing documentation and the response code is: 204 No Content.

Parameters:
context: Global MSSP context [optional]
id: Device ID
rule_id: Rule ID
body: RuleDocumentationDTO

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/20/rules/3040/documentation
BODY<rule_documentation>
     <tech_owner>admin</tech_owner>
     <comment>Comment text</comment>
     <legacy_rule>false</legacy_rule>
     <stealth_rule>true</stealth_rule>
     <record_set>
         <businessOwnerEmail>user@company.com</businessOwnerEmail>
         <businessOwnerName>Business Owner</businessOwnerName>
         <expireDate>2013-01-08T00:00:00+02:00</expireDate>
         <id>173</id>
         <ticketCr>789112</ticketCr>
     </record_set>
</rule_documentation>

","folder":"1-20","rawModeData":"\n\t admin\n\t Comment text\n\t false\n\t true\n\t \n\t\t user@company.com\n\t\t Business Owner\n\t\t 2013-01-08T00:00:00+02:00\n\t\t 173\n\t\t 789112\n\t \n\n","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules/{{rule_id}}/documentation","collectionId":"1","id":"1-20-113","method":"PUT"},{"name":"Delete specific rule documentation","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"rule_id"}],"dataMode":"params","description":"Delete rule documentation for a single rule given by device ID and rule ID

Parameters:
context: Global MSSP context [optional]
id: Device ID
rule_id: Rule ID

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules/3040/documentation
","folder":"1-20","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules/{{rule_id}}/documentation","collectionId":"1","id":"1-20-114","method":"DELETE"},{"name":"Delete specific rule documentation","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"rule_id"}],"dataMode":"params","description":"Delete rule documentation for a single rule given by revision ID and rule ID.
If the rule has automatic mapping to a ticket, the record is not deleted.

Parameters:
context: Global MSSP context [optional]
id: Revision id
rule_id: Rule id

Usage Example
https://192.168.1.1/securetrack/api/revisions/173/rules/3373/documentation
","folder":"1-20","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules/{{rule_id}}/documentation","collectionId":"1","id":"1-20-115","method":"DELETE"},{"headers":"Content-Type: application/xml\n","name":"Modify specific rule documentation","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"rule_id"}],"dataMode":"raw","description":"Modify rule documentation for a single rule identified by revision ID and rule ID.
A single rule can be set as either a stealth rule or legacy rule. If both flags are set, an error will be returned (error 400, Bad request).
If no rule documentation exists for the rule, the specified documentation is added to the rule and the response code is: 201 Created.
If rule documentation already exists for the rule, the specified documentation replaces the existing documentation and the response code is: 204 No Content.
Record set entries that are automatically created or calculated, for example automatic mapping to a SecureChange ticket, cannot be modified.
The following fields are automatically calculated, and cannot be modified:
Permissiveness, Violations, Last Hit, Last Modified, Shadowing Status, Certification Status, Certification Date, Certification Expiration Date, Application Name, Application Owner

Parameters:
context: Global MSSP context [optional]
id: Revision id
rule_id: Id of the changed rule
body: RuleDocumentationDTO

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/173/rules/3373/documentation
BODY<rule_documentation>
     <tech_owner>admin</tech_owner>
     <comment>Comment text</comment>
     <legacy_rule>false</legacy_rule>
     <stealth_rule>true</stealth_rule>
     <record_set>
         <businessOwnerEmail>user@company.com</businessOwnerEmail>
         <businessOwnerName>Business Owner</businessOwnerName>
         <expireDate>2013-01-08T00:00:00+02:00</expireDate>
         <id>172</id>
         <ticketCr>789111</ticketCr>
     </record_set>
</rule_documentation>

","folder":"1-20","rawModeData":"\n\t admin\n\t Comment text\n\t false\n\t true\n\t \n\t\t user@company.com\n\t\t Business Owner\n\t\t 2013-01-08T00:00:00+02:00\n\t\t 172\n\t\t 789111\n\t \n","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules/{{rule_id}}/documentation","collectionId":"1","id":"1-20-116","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get specific rule documentation","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"rule_id"}],"dataMode":"params","description":"Fetches rule documentation for a single rule given by revision ID and rule ID.

Parameters:
context: Global MSSP context [optional]
id: Revision id
rule_id: Id of the requested rule

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules/16373/documentation
","folder":"1-20","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules/{{rule_id}}/documentation","collectionId":"1","id":"1-20-117","method":"GET"},{"headers":"Accept: application/json\n","name":"Get cleanups by device","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"code"}],"dataMode":"params","description":"Fetches set of Cleanup calculation results for a device given by ID.
Only fully shadowed rules (cleanup code C01) are supported.

Parameters:
context: Global MSSP context [optional]
device_id: Device ID
code: Cleanup category code
start: Starting page for query allowable values are numeric [optional]
count: Number of pages for query result allowable values are numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/cleanups?code=C01
","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/cleanups","collectionId":"1","id":"1-21-118","method":"GET"},{"headers":"Accept: application/json\n","collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/risk/","name":"Get risks results","method":"GET","id":"1-21-119","description":"Parameters:
context: Global MSSP context [optional]
devices: Devices ids [optional]

Usage Example
https://192.168.1.1/securetrack/api/risk
","folder":"1-21"},{"headers":"Accept: application/json\n","name":"Get devices in cleanup results","data":[{"value":null,"type":"text","enabled":true,"key":"cleanup_id"}],"description":"Parameters:
context: Global MSSP context [optional]
cleanup_id: Cleanup id

Usage Example
https://192.168.1.1/securetrack/api/cleanup/1/devices
","dataMode":"params","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/cleanup/{{cleanup_id}}/devices","collectionId":"1","id":"1-21-120","method":"GET"},{"headers":"Accept: application/json\n","name":"Get the specific objects or rules identified for the cleanup results","data":[{"value":null,"type":"text","enabled":true,"key":"cleanup_id"}],"description":"Parameters:
context: Global MSSP context [optional]
cleanup_id: Cleanup id
devices: Devices ids [optional]
start: Start [optional]
count: Results count [optional]

Usage Example
https://192.168.1.1/securetrack/api/cleanup/1/instances
","dataMode":"params","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/cleanup/{{cleanup_id}}/instances","collectionId":"1","id":"1-21-121","method":"GET"},{"headers":"Accept: application/json\n","name":"Get devices in risk results","data":[{"value":null,"type":"text","enabled":true,"key":"risk_id"}],"description":"Parameters:
context: Global MSSP context [optional]
risk_id: Risk id

Usage Example
https://192.168.1.1/securetrack/api/risk/1/devices
","dataMode":"params","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/risk/{{risk_id}}/devices","collectionId":"1","id":"1-21-122","method":"GET"},{"headers":"Accept: application/json\n","name":"Get the specific objects or rules identified for the risk results","data":[{"value":null,"type":"text","enabled":true,"key":"risk_id"}],"description":"Parameters:
context: Global MSSP context [optional]
risk_id: Risk id
devices: Devices ids [optional]
start: Start [optional]
count: Results count [optional]

Usage Example
https://192.168.1.1/securetrack/api/risk/1/instances
","dataMode":"params","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/risk/{{risk_id}}/instances","collectionId":"1","id":"1-21-123","method":"GET"},{"headers":"Accept: application/json\n","name":"Get shadowing rules by device","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"shadowed_uids"}],"dataMode":"params","description":"Find shadowing rules for given shadowed rules of a specific device

Parameters:
device_id: Device ID
shadowed_uids: UIDs of shadowed rules separated by commas

Usage Example
https://192.168.1.1/securetrack/api/devices/31/shadowing_rules?shadowed_uids=78786a0d-b9cc-478e-b7a2-dea953c976c7
","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/shadowing_rules","collectionId":"1","id":"1-21-124","method":"GET"},{"headers":"Accept: application/json\n","collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/cleanup/","name":"Get cleanups results","method":"GET","id":"1-21-125","description":"Parameters:
context: Global MSSP context [optional]
devices: Devices ids [optional]

Usage Example
https://192.168.1.1/securetrack/api/cleanup
","folder":"1-21"},{"headers":"Accept: application/json\n","name":"Get specific revision","data":[{"value":null,"type":"text","enabled":true,"key":"revId"}],"dataMode":"params","description":"Fetches a revision specified by revision Id.
To get revId for this API, use the 'id' property of RevisionDTO that is returned by 'Get revisions by device' or 'Get latest revision by device' APIs

Parameters:
context: Global MSSP context [optional]
revId: Id of fetched revision

Usage Example
https://192.168.1.1/securetrack/api/revisions/785
","folder":"1-22","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revId}}","collectionId":"1","id":"1-22-126","method":"GET"},{"headers":"Accept: application/json\n","name":"Get latest revision by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches latest revision for a given device

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/105/latest_revision
","folder":"1-22","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/latest_revision","collectionId":"1","id":"1-22-127","method":"GET"},{"headers":"Accept: application/json\n","name":"Get revisions by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches revisions for a given device

Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query starting from starting page allowable type is numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/105/revisions
","folder":"1-22","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/revisions","collectionId":"1","id":"1-22-128","method":"GET"},{"headers":"Accept: application/json\n","name":"Get last hits for all rules by device","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"}],"dataMode":"params","description":"Get last hit dates for all rules in a given device.
For Palo Alto firewalls, this also returns last hits for users and applications in the rule.

Parameters:
device_id: device id

Usage Example
https://192.168.1.1/securetrack/api/rule_last_usage/find_all/20
","folder":"1-23","url":"https://{{SecureTrack_IP}}/securetrack/api/rule_last_usage/find_all/{{device_id}}","collectionId":"1","id":"1-23-129","method":"GET"},{"headers":"Accept: application/json\n","name":"Get last hit for a specific rule","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"rule_uid"}],"dataMode":"params","description":"Get last hit dates for all rules in a given device.
For Palo Alto firewalls, this also returns last hits for users and applications in the rule.
The rule_uid is the value from the uid field returned by the /rules API: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Parameters:
device_id: device_id
rule_uid: rule_uid

Usage Example
https://192.168.1.1/securetrack/api/rule_last_usage/find/20/ea9db13e-d058-45c6-a2f0-cd731027c22b
","folder":"1-23","url":"https://{{SecureTrack_IP}}/securetrack/api/rule_last_usage/find/{{device_id}}/{{rule_uid}}","collectionId":"1","id":"1-23-130","method":"GET"},{"headers":"Accept: application/json\n","name":"Get rules by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns a list of all of the security rules for the specified revision.
Use add=documentation to retrieve rule documentation.
The is_global parameter is device dependent. For ACL devices, only global rules are returned when set to true. For Check Point R80, only global layers are returned when set to true, and specify a layer name in the subpolicy_name parameter This parameter is ignored for all other vendors. The default value is false.
The subpolicy_name parameter is device dependent. For Check Point R80, only rules that use the specified layer are returned. You can only specify the name of a single layer. This parameter is ignored for all other vendors.


Parameters:
context: Global MSSP context [optional]
id: Revision id
policyId: Policy id [optional]
policy: Policy name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules only(device dependent, see implementation Notes) [optional]
add: If set to \"documentation\" result will include rule documentation [optional]
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
groupBy: Rules grouping criteria, can be set only to \"bindings\" [optional]
with_zb: Include zone-based rules [optional]
uid: Binding UID [optional]
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
subpolicy_name: Filter by sub policy name (see implementation notes) [optional]
is_alternate_order: OrderBy alternate order, for display Aci rules by contracts [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules?subpolicy_name=layer1&is_global=true
","folder":"1-24","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules","collectionId":"1","id":"1-24-131","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific rule","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Returns a list of rules by device ID, rule IDs and additional criteria.
Note: This API retrieves the information from the latest revision.


Parameters:
context: Global MSSP context [optional]
device_id: Device ID
ids: Rule IDs
policy: Policy Name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules only(device dependent, see implementation Notes) [optional]
add: If set to \"documentation\" result will include rule documentation [optional]
groupBy: Rules grouping criteria, can be set only to \"bindings\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules/16370
","folder":"1-24","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/rules/{{ids}}","collectionId":"1","id":"1-24-132","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific rule","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Returns a list of rules by revision ID, rule IDs and additional criteria

Parameters:
context: Global MSSP context [optional]
revision_id: Revision id
ids: Rule IDs
policy: Policy name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules (Only for: ACL devices) [optional]
add: If set to \\\"documentation\\\" result will include rule documentation [optional]
groupBy: Rules grouping criteria, can be set only to \\\"bindings\\\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules/16370
","folder":"1-24","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/rules/{{ids}}","collectionId":"1","id":"1-24-133","method":"GET"},{"headers":"Accept: application/json\n","name":"Get rules by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns a list of all of the security rules for the specified device.
Use add=documentation to retrieve rule documentation.
The is_global parameter is device dependent. For ACL devices, only global rules are returned when set to true. For Check Point R80, only global layers are returned when set to true, and specify a layer name in the subpolicy_name parameter This parameter is ignored for all other vendors. The default value is false.
The subpolicy_name parameter is device dependent. For Check Point R80, only rules that use the specified layer are returned. You can only specify the name of a single layer. This parameter is ignored for all other vendors.


Parameters:
context: Global MSSP context [optional]
id: Device ID
policyId: Policy ID [optional]
policy: Policy Name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules (Only for: ACL devices) [optional]
add: If set to \"documentation\" result will include rule documentation [optional]
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
groupBy: Show rules grouping criteria. Can be set only to \"bindings\". Output will be grouped by bindings and section header for Check Point devices, ACL for Cisco devices, and Zones for Juniper, Palo Alto, and Fortinet device [optional]
with_zb: Include zone based rules, values can be 'true' or 'false' [optional]
uid: Binding UID [optional]
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
subpolicy_name: Filter by sub policy name (see implementation notes) [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules?subpolicy_name=layer1&is_global=true
","folder":"1-24","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules","collectionId":"1","id":"1-24-134","method":"GET"},{"headers":"Accept: application/json\n","collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/rule_search/","name":"Get rule count per device","method":"GET","id":"1-24-135","description":"The search_text parameter provides the same capabilities as the Policy Browser feature in SecureTrack.
You can search for a string across all rule fields, or you can search for a combination of specific strings in specific fields.
The text format is for a field is <fieldname>:<text> for example uid:9259f6ee-47a0-4996-a214-ab7edc14a916.
See the search info documentation in Securetrack Policy Browser page for more information.
This API will return a list of all the devices, the devices that has rules that match the search criteria will have rule_count that is bigger than 0

Parameters:
context: Global MSSP context [optional]
search_text: Search text [optional]
devices: Devices ids [optional]

Usage Example
https://192.168.1.1/securetrack/api/rule_search/87

Usage Example
https://192.168.1.1/securetrack/api/rule_search/87?search_text=ICMP application:facebook

Usage Example
URLhttps://192.168.1.1/securetrack/api/rule_search?search_text=uid:9259f6ee-47a0-4996-a214-ab7edc14a916
OUTPUT{
    \"device_list\":{
        \"device\":[
            {
                \"device_id\":512,
                \"revision_id\":6864,
                \"rule_count\":1
            },
            {
                \"device_id\":59,
                \"revision_id\":543,
                \"rule_count\":0
            }
        ]
    }
}

","folder":"1-24"},{"headers":"Accept: application/json\n","name":"Find rules","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"}],"dataMode":"params","description":"The search_text parameter provides the same capabilities as the Policy Browser feature in SecureTrack.
You can search for a string across all rule fields, or you can search for a combination of specific strings in specific fields.
The text format is for a field is <fieldname>:<text> for example uid:9259f6ee-47a0-4996-a214-ab7edc14a916.
See the search info documentation in Securetrack Policy Browser page for more information.To get more information regarding objects included in the returned rules (like src_network or dst_network) use their uid, as the objects’ ID might change.
\n By default, if there are less than 3,000 rules - the API will return all the rules.\nIn case there are more than 3,000 rules the API will return an error code 413 with the error message “There are more than 3000 rules, you must use pagination”

Parameters:
context: Global MSSP context [optional]
search_text: Search text [optional]
device_id: Device id
start: The starting rule to include in the returned results [optional]
count: Number of rules to include in the results [optional]

Usage Example
https://192.168.1.1/securetrack/api/rule_search/31?search_text=source:Sales_192.168.2.60 fromzone:sales tozone:External

Usage Example
https://192.168.1.1/securetrack/api/rule_search/20?search_text=Mobile Access hascomment:false

Usage Example
https://192.168.1.1/securetrack/api/rule_search/87?search_text=web_server&start=0&count=10

Usage Example
URLhttps://192.168.1.1/securetrack/api/rule_search/59?search_text=uid:9259f6ee-47a0-4996-a214-ab7edc14a916
OUTPUT {
    \"rules\":{
        \"count\":1,
        \"total\":1,
        \"rule\":{
            \"@xsi.type\":\"securityRuleDTO\",
            \"id\":21,
            \"cp_uid\":\"\",
            \"uid\":\"{9259f6ee-47a0-4996-a214-ab7edc14a916}\",
            \"order\":2,
            \"binding\":{
                \"default\":true,
                \"policy\":{
                    \"@xsi.type\":\"managementDomainPolicyDTO\",
                    \"id\":2,
                    \"name\":\"Standard\",
                    \"installable_targets\":\"\"
                },
                \"rule_count\":19,
                \"security_rule_count\":19,
                \"uid\":\"{00-FACED0-00}\"
                },
            \"acceleration_breaker\":false,
            \"action\":\"Accept\",
            \"application\":{
                \"id\":4735,
                \"display_name\":\"ssh\",
                \"name\":\"ssh\"
            },
            \"authentication_rule\":false,
            \"comment\":\"DO NOT DELETE OR EDIT\",
            \"dst_network\":{
                \"id\":39,
                \"display_name\":\"Net_10.110.65.0\",
                \"name\":\"Net_10.110.65.0\"
                \"uid\":\"{1290f6ee-47a1-4996-a214-ab2edc26a916}\"
            },
            \"dest_networks_negated\":false,
            \"dst_service\":{
                \"id\":7420,
                \"display_name\":\"ssh\",
                \"name\":\"ssh\"
                \"uid\":\"{2904f6ee-47a1-4996-a214-ab2edc26a916}\"
            },
            \"dest_services_negated\":false,
            \"dst_zone\":\"any\",
            \"disabled\":false,
            \"external\":false,
            \"implicit\":false,
            \"dst_zone_any\":true,
            \"src_zone_any\":true,
            \"name\":\"Accept SSHG\",
            \"option\":\"LOG_SESSION\",
            \"documentation\":{
                \"permissiveness_level\":\"LOW\",
                \"shadowed\":\"Not shadowed\",
                \"last_modified\":\"Today\",
                \"last_hit\":\"N/A\",
                \"violations\":\"\"
            },
            \"rule_location\":\"Shared\",
            \"rule_location_display\":\"Shared - Pre Rule\",
            \"rule_number\":2,
            \"rule_type\":\"universal\",
            \"src_zone\":\"any\",
            \"src_network\":{
                \"id\":38,
                \"display_name\":\"Net_10.110.64.0\",
                \"name\":\"Net_10.110.64.0\"
                \"uid\":\"{4934f6ee-47a1-4996-a214-ab2edc26a916}\"
            },
            \"src_networks_negated\":false,
            \"src_services_negated\":false,
            \"track\":{
                \"level\":\"LOG\"
            },
            \"type\":\"rule\",
            \"users\":{
                \"id\":5,
                \"display_name\":\"tufin\\\\regina\",
                \"name\":\"tufin\\\\regina@ldap\"
            }
        }
    }
}


Response Messages:
400: Value for start parameter is missing or not valid
400: Value for count parameter is missing or not valid
413: Max supported count is 3000
413: There are more than 3000 rules, you must use pagination","folder":"1-24","url":"https://{{SecureTrack_IP}}/securetrack/api/rule_search/{{device_id}}","collectionId":"1","id":"1-24-136","method":"GET"},{"collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/rule_search/export","name":"Create a CSV file for rules search results","method":"GET","id":"1-24-137","description":"The search_text parameter provides the same capabilities as the Policy Browser feature in SecureTrack.
You can search for a string across all rule fields, or you can search for a combination of specific strings in specific fields.
The text format is for a field is : for example uid:9259f6ee-47a0-4996-a214-ab7edc14a916.
See the search info documentation in Securetrack Policy Browser page for more information.
This API exports the results data as a CSV file in the SecureTrack Reports Repository.

Parameters:
context: Global MSSP context [optional]
search_text: Search text [optional]

Usage Example
https://192.168.1.1/securetrack/api/rule_search/export

Usage Example
https://192.168.1.1/securetrack/api/rule_search/export?search_text=shadowed:true
","folder":"1-24"},{"headers":"Accept: application/json\n","name":"Get a specific rule","data":[{"value":null,"type":"text","enabled":true,"key":"ruleId"}],"description":"Parameters:
ruleId: Rule ID

Usage Example
https://192.168.1.1/securetrack/api/rules/60
","dataMode":"params","folder":"1-24","url":"https://{{SecureTrack_IP}}/securetrack/api/rules/{{ruleId}}","collectionId":"1","id":"1-24-138","method":"GET"},{"headers":"Accept: application/json\n","name":"Get service groups containing specified service objects","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns groups that contain the specified service objects


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the service object.

Usage Example
https://192.168.1.1/securetrack/api/services/69577/groups
","folder":"1-25","url":"https://{{SecureTrack_IP}}/securetrack/api/services/{{id}}/groups","collectionId":"1","id":"1-25-139","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific service","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches list of specific service objects defined in device given by device ID and specified by their IDs.
Note: This API retrieves the information from the latest revision.

Parameters:
context: Global MSSP context [optional]
device_id: Device ID
ids: Service object IDs separated by commas
show_members: Set to false to return only the name and ID of the members [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/services/959888,959966
","folder":"1-25","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/services/{{ids}}","collectionId":"1","id":"1-25-140","method":"GET"},{"headers":"Accept: application/json\n","name":"Get services by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of service objects defined on device given by device ID.
The default value for get_total is false. For APIF 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.


Parameters:
context: Global MSSP context [optional]
id: Device ID
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
start: Starting page for query allowable types are numeric [optional]
count: Number of pages for query allowable values are numeric [optional]
name: Service name [optional]
type: Service type, allowable values are: tcp, udp, ip or icmp [optional]
port: Service port [optional]
icmp_type: Service ICMP type allowable values are numeric between 0 to 40 [optional]
protocol: Service protocol, allowable values are numeric between 0 to 255 [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/20/services?get_total=true
OUTPUT {
    \"services\": {
        \"count\": 50,
        \"total\": 100,
        \"service\": [{
            \"@xsi.type\": \"singleServiceDTO\",
            \"id\": 5129479,
            \"name\": \"Tcp30025\",
            \"display_name\": \"Tcp30025\",
            \"class_name\": \"tcp_service\",
            \"type\": \"tcp_service\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{079F15A5-009E-7E47-BBD0-E65973646562}\",
            \"implicit\": false,
            \"overrides\": false,
            \"max\": 30025,
            \"min\": 30025,
            \"negate\": false,
            \"protocol\": 6,
            \"timeout\": 0
        }]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/services?type=group&show_members=false
OUTPUT{
    \"services\": {
    \"count\": 100,
        \"service\": [
            {
                \"@xsi.type\": \"serviceGroupDTO\",
                \"id\": 1359066,
                \"name\": \"#Shared Domain@DNS\",
                \"display_name\": \"DNS\",
                \"class_name\": \"service_group\",
                \"type\": \"group\",
                \"global\": \"false\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": false,
                \"overrides\": \"false\",
                \"type_on_device\": gen_service_group,
                \"is_device_predefined\": true,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"DNS\",
                    \"name\": \"#Shared Domain@DNS\",
            }
        ]
    }
}

","folder":"1-25","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/services","collectionId":"1","id":"1-25-141","method":"GET"},{"headers":"Accept: application/json\n","name":"Get rules containing specified service object","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the security rules that contain the specified service object


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the service object.
include_groups: You can add \"include_groups\" to find rules that include the service object and rules that include the groups that include the service object. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]

Usage Example
https://192.168.1.1/securetrack/api/services/65078/rules?include_groups=true
","folder":"1-25","url":"https://{{SecureTrack_IP}}/securetrack/api/services/{{id}}/rules","collectionId":"1","id":"1-25-142","method":"GET"},{"headers":"Accept: application/json\n","name":"Get services by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of service objects defined in revision given by revision ID
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.


Parameters:
context: Global MSSP context [optional]
id: Revision id
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
start: Starting page for query allowable types are numeric [optional]
count: Number of pages for query allowable values are numeric [optional]
name: Service name [optional]
type: Service type, allowable values are: tcp, udp, ip or icmp [optional]
port: Service port [optional]
icmp_type: Service ICMP type allowable values are numeric between 0 to 40 [optional]
protocol: Service protocol, allowable values are numeric betweenm 0 to 255 [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/785/services?get_total=true
OUTPUT {
    \"services\": {
        \"count\": 50,
        \"total\": 100,
        \"service\": [{
            \"@xsi.type\": \"singleServiceDTO\",
            \"id\": 5129479,
            \"name\": \"Tcp30025\",
            \"display_name\": \"Tcp30025\",
            \"class_name\": \"tcp_service\",
            \"type\": \"tcp_service\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{079F15A5-009E-7E47-BBD0-E65973646562}\",
            \"implicit\": false,
            \"overrides\": false,
            \"max\": 30025,
            \"min\": 30025,
            \"negate\": false,
            \"protocol\": 6,
            \"timeout\": 0
        }]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/31/services?type=group&show_members=false
OUTPUT{
    \"services\": {
    \"count\": 100,
        \"service\": [
            {
                \"@xsi.type\": \"serviceGroupDTO\",
                \"id\": 1359066,
                \"name\": \"#Shared Domain@DNS\",
                \"display_name\": \"DNS\",
                \"class_name\": \"service_group\",
                \"type\": \"group\",
                \"global\": \"false\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": false,
                \"overrides\": \"false\",
                \"type_on_device\": gen_service_group,
                \"is_device_predefined\": true,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"DNS\",
                    \"name\": \"#Shared Domain@DNS\",
            }
        ]
    }
}

","folder":"1-25","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/services","collectionId":"1","id":"1-25-143","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific service","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches list of specific service objects defined in revision given by revision ID and specified by their IDs

Parameters:
context: Global MSSP context [optional]
revision_id: Revision id
ids: Rule IDs
show_members: Set to false to return only the name and ID of the members [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/services/959888
","folder":"1-25","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/services/{{ids}}","collectionId":"1","id":"1-25-144","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Get services objects matching specified criteria","data":[{"value":null,"type":"text","enabled":true,"key":"filter"}],"dataMode":"raw","description":"You can search for service objects where the name or comment fields have a specified text string,
or you can search for service objects that have an Port or protocol that matches,
or you can search for service objects by uid.

Parameters:
context: Returns results for the specified domain ID. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]
filter: “text” filter returns service objects where the name or comment fields have a specified text string. \n“protocol” filter returns service objects that have a protocol that matches specified IP protocol number.\n“port” filter returns service objects that have a port that matches specified port number.\n “uid“ filter returns service objects with the specified uid.\n If no filter is specified, the “text” filter is used.
device_id: Returns service objects belonging to the specified device_id. [optional]
name: (For “text” filter) You can specify \"name\" to find service objects with the specified text in the name field. [optional]
comment: (For “text” filter) You can specify “comment” to find service objects with the specified text in the comment field. [optional]
protocol: Specify Protocolto find service objects that have the specified IP Protocol. [optional]
port: Specify Portto find service objects that have the specified Port. [optional]
uid: (for “uid“ filter) Returns service objects with the specified uid. [optional]

Usage Example
https://192.168.1.1/securetrack/api/services/search?filter=protocol&protocol=6&device_id=68

Usage Example
https://192.168.1.1/securetrack/api/services/search?filter=port&port=80

Usage Example
https://192.168.1.1/securetrack/api/services/search?filter=uid&uid=24a8774d-24c1-4b3a-aae9-3c272a2b5191

Usage Example
URLhttps://192.168.1.1/securetrack/api/services/search?filter=text&name=tcp_10
BODY{
    \"services\": {
        \"count\": 1,
        \"total\": 1,
        \"service:\": {
            \"id\": 169197,
            \"name\": \"tcp_10\",
            \"display_name\": \"tcp_10\",
            \"class_name\": \"access_role\",
            \"global\": false,
            \"device_id\": 158,
            \"comment\": \"\",
            \"uid\": \"{9EDC2607-6BEC-43D7-A99D-B522BA694ADA}\",
            \"implicit\": false,
            \"max\": false,
            \"min\": false,
            \"protocol\": 6,
            \"timeout\": \"\",
            \"type\": \"tcp_service\",
            }
        }
    }
}

","folder":"1-25","rawModeData":"{\n\t\"services\": {\n\t\t\"count\": 1,\n\t\t\"total\": 1,\n\t\t\"service:\": {\n\t\t\t\"id\": 169197,\n\t\t\t\"name\": \"tcp_10\",\n\t\t\t\"display_name\": \"tcp_10\",\n\t\t\t\"class_name\": \"access_role\",\n\t\t\t\"global\": false,\n\t\t\t\"device_id\": 158,\n\t\t\t\"comment\": \"\",\n\t\t\t\"uid\": \"{9EDC2607-6BEC-43D7-A99D-B522BA694ADA}\",\n\t\t\t\"implicit\": false,\n\t\t\t\"max\": false,\n\t\t\t\"min\": false,\n\t\t\t\"protocol\": 6,\n\t\t\t\"timeout\": \"\",\n\t\t\t\"type\": \"tcp_service\",\n\t\t\t}\n\t\t}\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/services/search","collectionId":"1","id":"1-25-145","method":"GET"},{"headers":"Accept: application/json\n","name":"Get time objects by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the time objects used in the specified device.

Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable values are numeric [optional]
count: Starting page for query allowable values are numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/time_objects
","folder":"1-26","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/time_objects","collectionId":"1","id":"1-26-146","method":"GET"},{"headers":"Accept: application/json\n","name":"Get time objects by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the time objects used in the specified revision.

Parameters:
context: Global MSSP context [optional]
id: Revision ID
start: Starting page for query allowable value is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/time_objects
","folder":"1-26","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/time_objects","collectionId":"1","id":"1-26-147","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific time object","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches list of time objects by revision ID and rule ID

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Rule IDs

Usage Example
https://192.168.1.1/securetrack/api/revisions/7/time_objects/9
","folder":"1-26","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/time_objects/{{ids}}","collectionId":"1","id":"1-26-148","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Get policy relevance metrics for traffic","dataMode":"raw","description":"The response lists all the relevant security groups, tags, relevant instances, and count of unrelated instances for each Amazon VPC in the specified traffic path.
A relevant security group contains at least one instance including either the source or destination IP address.
An unrelated instance is included in the security group but not part of the specified traffic path.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is used only if MSSP mode is enabled. If MSSP mode is disabled context is ignored.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.

Parameters:
context: Global MSSP context [optional]
body: Relevance metrics request

Usage Example
URLhttps://192.168.1.1/securetrack/api/traffic_policy
BODY{
    \"relevance_metrics\": {
        \"source_ips\": {
            \"source\":[\"10.10.253.0/24\", \"172.31.50.99/32\"]
        },
        \"dest_ips\": {
            \"dest\": [\"172.31.150.0/24\", \"172.31.50.99/32\"]
        },
        \"targets\": {
            \"target\": [4, 10]
        }
    }
}


Response Messages:
200: Successful
401: Insufficient user permissions
404: Device not found
400: Invalid parameters","folder":"1-27","rawModeData":"{\n\t\"relevance_metrics\": {\n\t\t\"source_ips\": {\n\t\t\t\"source\":[\"10.10.253.0/24\", \"172.31.50.99/32\"]\n\t\t},\n\t\t\"dest_ips\": {\n\t\t\t\"dest\": [\"172.31.150.0/24\", \"172.31.50.99/32\"]\n\t\t},\n\t\t\"targets\": {\n\t\t\t\"target\": [4, 10]\n\t\t}\n\t}\n}\n","url":"https://{{SecureTrack_IP}}/securetrack/api/traffic_policy/","collectionId":"1","id":"1-27-149","method":"POST"},{"name":"Cancel violation task","data":[{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"params","description":"Delete an access request violations task.

Parameters:
taskId: The unique identifier of the access request violations task.

Usage Example
https://192.168.1.1/securetrack/api/violations/access_requests/task/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
204: Access request violations task has been aborted successfully.
401: Access is denied.
404: Access request violations task was not found.","folder":"1-28","url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/task/{{taskId}}","collectionId":"1","id":"1-28-150","method":"DELETE"},{"headers":"Content-Type: application/xml\n","name":"Start a task to calculate violations for an access request","dataMode":"raw","description":"Create a calculation task to find access requests violations.
Returns a task Id that can be used to check the task status and get the task results

Parameters:
body [optional]
use_topology: Use topology to determine access request domains. [optional]
ar_domain_mode: The access request uses resources from multiple domains. [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/violations/access_requests/task?use_topology=false&ar_domain_mode=false
BODY<access_requests>
    <access_request>
     <use_topology>false</use_topology>
     <access_request_order>0</access_request_order>
     <access_request_source xsi:type=\"internet\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"/>
     <access_request_destination xsi:type=\"ip_network\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <network xsi:type=\"raw_network_subnet\">
         <negate>false</negate>
         <ip>10.100.0.1</ip>
         <mask>255.255.255.255</mask>
         </network>
     </access_request_destination>
     <access_request_service xsi:type=\"implicit_service\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <name>ssh</name>
         <service>
             <predefined>true</predefined>
             <min_protocol>6</min_protocol>
             <max_protocol>6</max_protocol>
             <min_port>22</min_port>
             <max_port>22</max_port>
             <negate>false</negate>
         </service>
     </access_request_service>
     <action>ACCEPT</action>
    </access_request>
</access_requests>


Response Messages:
202: Access request violations task was accepted.
400: Access request order is not unique.
400: Domain cannot be specified when domain mode is false.
400: Cannot specify both ticket domain id and source and destination domains.
400: No domain specified in MSSP mode.
400: Domain does not exist.
400: Access request is malformed.
400: No valid access requests (Access requests cannot have topology enabled and the Internet object in the Source/Destination)
400: No network source were specified.
400: No network destination were specified.
401: Access is denied.
503: Access request violations task was rejected.","folder":"1-28","rawModeData":"\n\t\n\t false\n\t 0\n\t \n\t \n\t\t \n\t\t false\n\t\t 10.100.0.1\n\t\t 255.255.255.255\n\t\t \n\t \n\t \n\t\t ssh\n\t\t \n\t\t\t true\n\t\t\t 6\n\t\t\t 6\n\t\t\t 22\n\t\t\t 22\n\t\t\t false\n\t\t \n\t \n\t ACCEPT\n\t\n\n","url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/task","collectionId":"1","id":"1-28-151","method":"POST"},{"headers":"Accept: application/json\n","name":"Get violation task results","data":[{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"params","description":"Get result of access requests violations task.

Parameters:
taskId: The unique identifier of the access request violations task.

Usage Example
https://192.168.1.1/securetrack/api/violations/access_requests/result/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Access request violations task results were received.
401: Access is denied.
404: An error occurred during the calculation.
404: The calculation for the task has not finished yet.","folder":"1-28","url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/result/{{taskId}}","collectionId":"1","id":"1-28-152","method":"GET"},{"headers":"Accept: application/json\n","name":"Get violation task status","data":[{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"params","description":"Get access requests violations task status.

Parameters:
taskId: The unique identifier of the access request violations task.

Usage Example
https://192.168.1.1/securetrack/api/violations/access_requests/status/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Access request violations task status was received.
401: Access is denied.
404: Access request violations task status was not found.","folder":"1-28","url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/status/{{taskId}}","collectionId":"1","id":"1-28-153","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Get violations for an access request","dataMode":"raw","description":"Calculate the violations for the given access request.
Note: this API may take a while to complete.
See the asynchronous API /violations/access_request/task as an alternative.

Parameters:
body: AccessRequestListDTO
use_topology: Use topology to determine access request domains. [optional]
ar_domain_mode: The access request supports multiple domains. [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/violations/access_requests/sync?use_topology=false&ar_domain_mode=false
BODY<access_requests>
    <access_request>
     <use_topology>false</use_topology>
     <access_request_order>0</access_request_order>
     <access_request_source xsi:type=\"internet\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"/>
     <access_request_destination xsi:type=\"ip_network\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <network xsi:type=\"raw_network_subnet\">
         <negate>false</negate>
         <ip>10.100.0.1</ip>
         <mask>255.255.255.255</mask>
         </network>
     </access_request_destination>
     <access_request_service xsi:type=\"implicit_service\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <name>ssh</name>
         <service>
             <predefined>true</predefined>
             <min_protocol>6</min_protocol>
             <max_protocol>6</max_protocol>
             <min_port>22</min_port>
             <max_port>22</max_port>
             <negate>false</negate>
         </service>
     </access_request_service>
     <action>ACCEPT</action>
    </access_request>
</access_requests>


Response Messages:
200: Access request violations were calculated.
400: Access request order is not unique.
400: Domain cannot be specified when domain mode is false.
400: Cannot specify both ticket domain id and source and destination domains.
400: No domain specified in MSSP mode.
400: Domain does not exist.
400: Access request is malformed.
400: No valid access requests (Access requests cannot have topology enabled and the Internet object in the Source/Destination).
401: Access is denied.","folder":"1-28","rawModeData":"\n\t\n\t false\n\t 0\n\t \n\t \n\t\t \n\t\t false\n\t\t 10.100.0.1\n\t\t 255.255.255.255\n\t\t \n\t \n\t \n\t\t ssh\n\t\t \n\t\t\t true\n\t\t\t 6\n\t\t\t 6\n\t\t\t 22\n\t\t\t 22\n\t\t\t false\n\t\t \n\t \n\t ACCEPT\n\t\n\n","url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/sync","collectionId":"1","id":"1-28-154","method":"POST"},{"name":"Delete alerts by ids","data":[{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Delete specified alerts by IDs
To delete multiple alert_ids, use a comma between each ID

Parameters:
context: Delete alerts in the specified domain ID. [optional]
ids: The alert Ids for deletion

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts/87

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts/86,87,88

Response Messages:
200:
401: Security Policy Alert Ids: :|'alert ids'| don't exist","folder":"1-29","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/{{ids}}","collectionId":"1","id":"1-29-155","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get a specific alert","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns a specified alert.
If the alert_id does not exist, an error message is returned.

Parameters:
context: MSSP context [optional]
id: The alert Id

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts/1

Response Messages:
401: Alert ID does not exist","folder":"1-29","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/{{id}}","collectionId":"1","id":"1-29-156","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Update an alert","dataMode":"raw","description":"Update an alert for unified security policies.
Alerts can be defined for all devices (all_devices:true) or for specified device IDs.
An email and/or user name must be defined. For multiple entries of emails or user names, use a semicolon to separate values. For SecureTrack, users in the collection are populated with \"user_ids\". The alert will be sent to the users (according to the addresses configured in SecureTrack) and to the emails.
To get the domain_id (optional parameter), call /domains/ API and use the ID included within the returned domain DTO.
At least one severity should be marked as 'true'.
There are no default values

Parameters:
context: Global MSSP context [optional]
id: The alert ID for updating [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_policies/alerts/1
BODY{
    \"usp_alert_configuration\": {
        \"name\": \"uspAlert\",
        \"description\": \"description\",
        \"status\": \"ACTIVE\",
        \"domain_id\": 6,
        \"all_devices\": false,
        \"device_ids\": {
            \"device_id\": [
                1,
                2,
                3,
                4
            ]
        },
        \"low_severity\": true,
        \"medium_severity\": true,
        \"high_severity\": true,
        \"critical_severity\": false,
        \"user_ids\": {
            \"user_id\": \"moshe\"
        },
        \"emails\": \"user@doamin.com\",
        \"send_syslog\": true
    }
}


Response Messages:
204: Alert ID: 'alertId' was updated successfully
404: Alert ID: 'alertId' does not exist
412: Alert name not specified
409: Alert name specified already exists
412: Status not specified
412: Domain not specified
404: Domain specified does not exist
401: User is not authorized to configure alerts for domain 'domainId'
412: Device not specified
404: Device ID specified does not exist or belongs to a different domain
403: Device: 'deviceId' not supported for USP
412: Severity not specified
412: No recipient details entered for alert
412: Invalid email address. Format must be name@domain.com
404: Username: 'userName' does not exist
403: User is not authorized to configure alerts for Super Admin user: 'userName'
403: Username: 'userName' not valid for the specified domain","folder":"1-29","rawModeData":"{\n\t\"usp_alert_configuration\": {\n\t\t\"name\": \"uspAlert\",\n\t\t\"description\": \"description\",\n\t\t\"status\": \"ACTIVE\",\n\t\t\"domain_id\": 6,\n\t\t\"all_devices\": false,\n\t\t\"device_ids\": {\n\t\t\t\"device_id\": [\n\t\t\t\t1,\n\t\t\t\t2,\n\t\t\t\t3,\n\t\t\t\t4\n\t\t\t]\n\t\t},\n\t\t\"low_severity\": true,\n\t\t\"medium_severity\": true,\n\t\t\"high_severity\": true,\n\t\t\"critical_severity\": false,\n\t\t\"user_ids\": {\n\t\t\t\"user_id\": \"moshe\"\n\t\t},\n\t\t\"emails\": \"user@doamin.com\",\n\t\t\"send_syslog\": true\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/{{id}}","collectionId":"1","id":"1-29-157","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get alerts","data":[{"value":null,"type":"text","enabled":true,"key":"start"},{"value":null,"type":"text","enabled":true,"key":"count"}],"dataMode":"params","description":"Returns a list of all alerts. If an empty list is returned, it implies that there are no configured alerts for that context.
You must set start and count parameters to limit the number of returned alerts.
Start is zero based - to start from the second rule use start=1, to get rules 51-60 use start=50 and count=10.

Parameters:
context: MSSP context [optional]
start: Returns the results beginning with the specified result number
count: Returns the specified number of results

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts?start=10&count=25

Response Messages:
400: Value for start parameter is missing or not valid
400: Value for count parameter is missing or not valid","folder":"1-29","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/","collectionId":"1","id":"1-29-158","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Create an alert","dataMode":"raw","description":"Create an alert for unified security policies.
Returns location with the alert id to get the alert.
Alerts can be defined for all devices (all_devices:true) or for specified device IDs.
An email and/or user name must be defined. For multiple entries of emails or user names, use a semicolon to separate values. For SecureTrack, users in the collection are populated with \"user_ids\". The alert will be sent to the users (according to the addresses configured in SecureTrack) and to the emails.
To get the domain_id (optional parameter), call /domains/ API and use the ID included within the returned domain DTO.
At least one severity should be marked as 'true'.
There are no default values

Parameters:
context: Global MSSP context [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_policies/alerts
BODY{
    \"usp_alert_configuration\": {
        \"name\": \"uspAlert\",
        \"description\": \"description\",
        \"status\": \"ACTIVE\",
        \"domain_id\": 6,
        \"all_devices\": false,
        \"device_ids\": {
            \"device_id\": [
                1,
                2,
                3,
                4
            ]
        },
        \"low_severity\": true,
        \"medium_severity\": true,
        \"high_severity\": true,
        \"critical_severity\": false,
        \"user_ids\": {
            \"user_id\": \"moshe\"
        },
        \"emails\": \"user@doamin.com\",
        \"send_syslog\": true
    }
}


Response Messages:
201: Security policy alert id :|'alertId'| , name : 'alertName'
412: Alert name not specified
409: Alert name specified already exists
412: Status not specified
412: Domain not specified
404: Domain specified does not exist
401: User is not authorized to configure alerts for domain 'domainId'
412: Device not specified
404: Device ID specified does not exist or belongs to a different domain
403: Device: 'deviceId' not supported for USP
412: Severity not specified
412: No recipient details entered for alert
412: Invalid email address. Format must be name@domain.com
404: Username: 'userName' does not exist
403: User is not authorized to configure alerts for Super Admin user: 'userName'
403: Username: 'userName' not valid for the specified domain","folder":"1-29","rawModeData":"{\n\t\"usp_alert_configuration\": {\n\t\t\"name\": \"uspAlert\",\n\t\t\"description\": \"description\",\n\t\t\"status\": \"ACTIVE\",\n\t\t\"domain_id\": 6,\n\t\t\"all_devices\": false,\n\t\t\"device_ids\": {\n\t\t\t\"device_id\": [\n\t\t\t\t1,\n\t\t\t\t2,\n\t\t\t\t3,\n\t\t\t\t4\n\t\t\t]\n\t\t},\n\t\t\"low_severity\": true,\n\t\t\"medium_severity\": true,\n\t\t\"high_severity\": true,\n\t\t\"critical_severity\": false,\n\t\t\"user_ids\": {\n\t\t\t\"user_id\": \"moshe\"\n\t\t},\n\t\t\"emails\": \"user@doamin.com\",\n\t\t\"send_syslog\": true\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/","collectionId":"1","id":"1-29-159","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Check if tags are compliant with cloud tag policies","data":[{"value":null,"type":"text","enabled":true,"key":"policy_external_id"}],"dataMode":"raw","description":"Check if the tags of a cloud resource are compliant with the specified cloud tag policy. Specify the tag policy to validate in the TagPolicyViolationsCheckRequestDTO. The tags of a cloud resource are specified as a json object with the attribute 'tags' at the root level. 'tags' attributes can be a list of tag names or a map including both the tag name and value. If no tags are specified or if the tag is specified incorrectly, The compliance check will treat the resource as if it has no tags. If no cloud tag policy violations are found the API returns an empty violations list.

Parameters:
context: Returns results for the specified domain ID [optional]
policy_external_id: Tag policy external identifier
body: Tag policy violation check request

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/violation_check?policy_external_id=policyId
BODY {
    \"type\": \"vm\",
    \"name\": \"CRM-FE\",
    \"os\": \"ubuntu14.4\",
    \"image\": \"AMI-12345\",
    \"tags\": {
        \"Role\": \"webserver\",
        \"Budget\": \"corporate\",
        \"Owner\": \"Steve.Smith\"
    }
}


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions
404: Resource not found","folder":"1-30","rawModeData":" {\n\t\"type\": \"vm\",\n\t\"name\": \"CRM-FE\",\n\t\"os\": \"ubuntu14.4\",\n\t\"image\": \"AMI-12345\",\n\t\"tags\": {\n\t\t\"Role\": \"webserver\",\n\t\t\"Budget\": \"corporate\",\n\t\t\"Owner\": \"Steve.Smith\"\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/violation_check/","collectionId":"1","id":"1-30-160","method":"POST"},{"headers":"Accept: application/json\n","collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/policies/","name":"Get all cloud tag policies","method":"GET","id":"1-30-161","description":"This API returns the details of all the tag policies.

Results are filtered according to user domain permissions and request context. If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Returns results for the specified domain ID [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/
OUTPUT{
        \"status\": \"OK\",
        \"result\": [
                {
                        \"policy_id\": \"tp-101\",
                        \"policy_name\": \"myPolicy1\",
                        \"requirements\": [
                                {
                                        \"requirement_type\": \"mandatory_tags\",
                                        \"requirement_name\": \"myMandatoryRequirement\",
                                        \"requirement_severity\": \"HIGH\",
                                        \"tags\": [
                                                \"Owner\",
                                                \"Name\"
                                        ]
                                },
                                {
                                        \"requirement_type\": \"valid_values\",
                                        \"requirement_name\": \"myValidValueRequirement\",
                                        \"requirement_severity\": \"CRTICAL\",
                                        \"tag\": \"Budget\",
                                        \"values\": [
                                                \"R&D\",
                                                \"HR\"
                                        ]
                                }
                        ]
                },
                {
                        \"policy_id\": \"tp-102\",
                        \"policy_name\": \"myPolicy2\",
                        \"requirements\": [
                                {
                                        \"requirement_type\": \"mandatory_tags\",
                                        \"requirement_name\": \"myMandatoryRequirement\",
                                        \"requirement_severity\": \"HIGH\",
                                        \"tags\": [
                                                \"Owner\"
                                        ]
                                },
                                {
                                        \"requirement_type\": \"valid_values\",
                                        \"requirement_name\": \"myValidValueRequirement\",
                                        \"requirement_severity\": \"CRTICAL\",
                                        \"tag\": \"Budget\",
                                        \"values\": [
                                                \"R&D\",
                                                \"HR\"
                                        ]
                                }
                        ]
                }
        ]
}


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions","folder":"1-30"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Create a cloud tag policy","dataMode":"raw","description":"Create a new cloud tag policy. The policyName field specified in the TagPolicyDTO must be unique. Define the requirements enforced by the cloud tag policy in the requirements field of the TagPolicyDTO. The supported value for the \"requirement_type\" field are \"mandatory_tags\" and \"valid_values\"If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Create policy for the specified domain ID [optional]
body: cloud tag policy DTO [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/
BODY {
    \"policy_name\": \"Production-VPC-Tag-Policy\",
    \"policy_description\": \"Instances tags in production\",
    \"requirements\": [
        {
            \"requirement_type\": \"mandatory_tags\",
            \"requirement_name\": \"mandatory_financial_tags\",
            \"requirement_severity\": \"HIGH\",
            \"tags\": [
                \"Owner\",
                \"Budget\"
            ]
        },
        {
            \"requirement_type\": \"valid_values\",
            \"requirement_name\": \"budget_valid_values\",
            \"requirement_severity\": \"CRITICAL\",
            \"tag\": \"Budget\",
            \"values\": [
                \"Corporate\",
                \"Dev\"
            ]
        }
    ]
}
OUTPUT{
        \"status\": \"OK\",
        \"policy_id\": \"tp-123\"
}


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions
409: Policy name already exists","folder":"1-30","rawModeData":" {\n\t\"policy_name\": \"Production-VPC-Tag-Policy\",\n\t\"policy_description\": \"Instances tags in production\",\n\t\"requirements\": [\n\t\t{\n\t\t\t\"requirement_type\": \"mandatory_tags\",\n\t\t\t\"requirement_name\": \"mandatory_financial_tags\",\n\t\t\t\"requirement_severity\": \"HIGH\",\n\t\t\t\"tags\": [\n\t\t\t\t\"Owner\",\n\t\t\t\t\"Budget\"\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"requirement_type\": \"valid_values\",\n\t\t\t\"requirement_name\": \"budget_valid_values\",\n\t\t\t\"requirement_severity\": \"CRITICAL\",\n\t\t\t\"tag\": \"Budget\",\n\t\t\t\"values\": [\n\t\t\t\t\"Corporate\",\n\t\t\t\t\"Dev\"\n\t\t\t]\n\t\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/policies/","collectionId":"1","id":"1-30-162","method":"POST"},{"headers":"Accept: application/json\n","name":"Get all cloud tag policy violations for a VPC","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"},{"value":null,"type":"text","enabled":true,"key":"severity"}],"dataMode":"params","description":"Retrieve all cloud tag policy violations for the specified VPC and severity level.

Parameters:
context: Global MSSP context. [optional]
deviceId: The device ID for which to get violations
severity: Return only violations of this severity
resourceId: The id of the VM instance [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses \"count=100\". [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tag_violations?deviceId=123&severity=CRITICAL
OUTPUT<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<tag_policy_device_violations>
    <violating_resources_count>2</violating_resources_count>
    <device_name>Amazon Test VPC </device_name>
    <severity>critical</severity>
    <violating_resources>
        <violating_resource>
            <tag_violations>
                <tag_violation>
                    <violation_message>Tag 'Name' value 'email server' is not valid. Valid values are [R&D, HR]</violation_message>
                    <policy_id>tp-100</policy_id>
                    <policy_name>Tag policy 1</policy_name>
                    <requirement_name>validValue_constraint2</requirement_name>
                    <requirement_severity>high</requirement_severity>
                    <violation_attributes xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"valid_values\">
                        <tag>Name</tag>
                        <valid_values>
                            <valid_value>R&D</valid_value>
                            <valid_value>HR</valid_value>
                        </valid_values>
                        <invalid_value>email server</invalid_value>
                    </violation_attributes>
                </tag_violation>
            </tag_violations>
            <resource_id>i-abc12345</resource_id>
            <resource_name>email server</resource_name>
        </violating_resource>
        <violating_resource>
            <tag_violations>
                <tag_violation>
                    <violation_message>Tag 'Application' is missing</violation_message>
                    <policy_id>tp-105</policy_id>
                    <policy_name>Tag policy 1</policy_name>
                    <requirement_name>mandatory_constraint1</requirement_name>
                    <requirement_severity>critical</requirement_severity>
                    <violation_attributes xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"mandatory_tags\">
                        <missing_tag>Application</missing_tag>
                    </violation_attributes>
                </tag_violation>
            </tag_violations>
            <resource_id>i-12345678</resource_id>
            <resource_name>Violations tests server</resource_name>
        </violating_resource>
    </violating_resources>
</tag_policy_device_violations>


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions
404: A device with the specified ID was not found","folder":"1-30","url":"https://{{SecureTrack_IP}}/securetrack/api/tag_violations/","collectionId":"1","id":"1-30-163","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Replace a cloud tag policy","dataMode":"raw","description":"Replace the cloud tag policy specified by policyID with the new policy attributes.

Use PATCH in order to partially modify a policy. If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Replace policy of the specified domain ID [optional]
policyId: cloud tag policy id [optional]
body: cloud tag policy dTO [optional]

Usage Example
URLhttps://{ip}/securetrack/api/tagpolicy/policies/policyId
BODY{
    \"policy_name\": \"myPolicyName\",
    \"requirements\": [
        {
            \"requirement_type\": \"mandatory_tags\",
            \"requirement_name\": \"mandatory_requirement1\",
            \"requirement_severity\": \"CRTICAL\",
            \"tags\": [
                \"Owner\",
                \"Role\"
            ]
        }
    ]
}
OUTPUT{
        \"status\": \"OK\",
        \"policy_id\": \"tp-123\"
}

","folder":"1-30","rawModeData":"{\n\t\"policy_name\": \"myPolicyName\",\n\t\"requirements\": [\n\t\t{\n\t\t\t\"requirement_type\": \"mandatory_tags\",\n\t\t\t\"requirement_name\": \"mandatory_requirement1\",\n\t\t\t\"requirement_severity\": \"CRTICAL\",\n\t\t\t\"tags\": [\n\t\t\t\t\"Owner\",\n\t\t\t\t\"Role\"\n\t\t\t]\n\t\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","collectionId":"1","id":"1-30-164","method":"PUT"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Modify a cloud tag policy","dataMode":"raw","description":"Partially modify a cloud tag policy by stating the modified attributes. Providing requirements replaces the entire list.

Specifying an empty requirement list is not permitted. Modify some attributes of the cloud tag policy specified by policyID with the attributes provided. If one or more \"requirement\" objects is provided, the exsiting \"requirement\" objects will be deleted and replaced with the new objetcs. Specifying an empty requirement list is not permitted.If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Rename policy of the specified domain ID [optional]
policyId: cloud tag policy id [optional]
body: cloud tag policy dTO [optional]

Usage Example
URLhttps://{ip}/securetrack/api/tagpolicy/policies/policyId
BODY{
    \"policy_name\": \"myPolicyName\",
    \"requirements\": [
        {
            \"requirement_type\": \"mandatory_tags\",
            \"requirement_name\": \"mandatory_requirement1\",
            \"requirement_severity\": \"CRTICAL\",
            \"tags\": [
                \"Owner\",
                \"Role\"
            ]
        }
    ]
}
OUTPUT{
        \"status\": \"OK\",
        \"policy_id\": \"tp-123\"
}


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions
404: Resource not found","folder":"1-30","rawModeData":"{\n\t\"policy_name\": \"myPolicyName\",\n\t\"requirements\": [\n\t\t{\n\t\t\t\"requirement_type\": \"mandatory_tags\",\n\t\t\t\"requirement_name\": \"mandatory_requirement1\",\n\t\t\t\"requirement_severity\": \"CRTICAL\",\n\t\t\t\"tags\": [\n\t\t\t\t\"Owner\",\n\t\t\t\t\"Role\"\n\t\t\t]\n\t\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","collectionId":"1","id":"1-30-165","method":"PATCH"},{"headers":"Accept: application/json\n","collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","name":"Delete cloud tag policy","method":"DELETE","id":"1-30-166","description":"Delete the cloud tag policy specified by policyId.

If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Delete policy of the specified domain ID [optional]
policyId: cloud tag policy id [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/policyId
OUTPUT {
        \"status\": \"OK\",
        \"policy_name\": \"myPolicyName\"
}


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions
404: Resource not found","folder":"1-30"},{"headers":"Accept: application/json\n","collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","name":"Get cloud tag policy","method":"GET","id":"1-30-167","description":"This API retrieves the details of the cloud tag policy specified by policyId.

User must have admin permissions to the policy affiliated domain. If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Returns results for the specified domain ID [optional]
policyId: cloud tag policy id [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/policyId
OUTPUT{
        \"status\": \"OK\",
        \"result\": [
                {
                        \"policy_id\": \"tp-101\",
                        \"policy_name\": \"myPolicyName\",
                        \"requirements\": [
                                {
                                        \"requirement_type\": \"mandatory_tags\",
                                        \"requirement_name\": \"myMandatoryTagsRequirement\",
                                    \"requirement_severity\": \"CRTICAL\",
                                        \"tags\": [
                                                \"Owner\",
                                                \"Name\"
                                        ]
                                },
                                {
                                        \"requirement_type\": \"valid_values\",
                                        \"requirement_name\": \"myValidValueRequirement\",
                                    \"requirement_severity\": \"CRTICAL\",
                                        \"tag\": \"Budget\",
                                        \"values\": [
                                                \"R&D\",
                                                \"HR\"
                                        ]
                                }
                        ]
                }
        ]
}


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions
404: Resource not found","folder":"1-30"},{"headers":"Accept: application/json\n","name":"Get matching rules task status","data":[{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
taskId: The unique identifier of the matching rules task.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/matching_rules/status/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Matching rules task status was received.
401: User not permitted to Security policy exceptions.
404: Matching rules task status was not found.","dataMode":"params","folder":"1-31","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/matching_rules/status/{{taskId}}","collectionId":"1","id":"1-31-168","method":"GET"},{"headers":"Accept: application/json\n","name":"Get matching rules task results","data":[{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
taskId: The unique identifier of the matching rules task.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/matching_rules/result/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Matching rules task results were received.
401: User not permitted to Security policy exceptions.
404: An error occurred during the calculation.
404: The calculation for the task has not finished yet.","dataMode":"params","folder":"1-31","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/matching_rules/result/{{taskId}}","collectionId":"1","id":"1-31-169","method":"GET"},{"headers":"Accept: application/json\n","name":"Get a specific exception","data":[{"value":null,"type":"text","enabled":true,"key":"exceptionId"}],"dataMode":"params","description":"Gets a specific exception for unified security policies.

Parameters:
exceptionId: The ID of the exception to get.
context: Global MSSP context [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/14

Response Messages:
401: User not permitted to access the specified domain
404: A security policy exception with the specified ID was not found.","folder":"1-31","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/{{exceptionId}}","collectionId":"1","id":"1-31-170","method":"GET"},{"headers":"Accept: application/json\n","name":"Delete an exception","data":[{"value":null,"type":"text","enabled":true,"key":"exceptionId"}],"dataMode":"params","description":"Delete the specific unified security policy exceptions

Parameters:
exceptionId: The ID of the exception to delete.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/14

Response Messages:
404: The security policy with the specified ID does not exist
401: User not permitted to access the specified domain.","folder":"1-31","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/{{exceptionId}}","collectionId":"1","id":"1-31-171","method":"DELETE"},{"name":"Start a task to calculate matching rules for an exception","data":[{"value":null,"type":"text","enabled":true,"key":"exceptionId"}],"dataMode":"params","description":"Create a calculation task to find matching rules.
The results will be on the relevant devices for each access.
Returns a task Id that can be used to check the task status and get the task results

Parameters:
exceptionId: Security policy Exception ID on which to run the API.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/1/matching_rules/start

Response Messages:
401: User not permitted to Security policy exceptions.
404: A security policy exception with the specified ID was not found.","folder":"1-31","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/{{exceptionId}}/matching_rules/start","collectionId":"1","id":"1-31-172","method":"POST"},{"name":"Cancel Matching rules task","data":[{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
taskId: The unique identifier of the matching rules task.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/matching_rules/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
204: Matching rules task has been aborted successfully.
401: User not permitted to Security policy exceptions.
404: Matching rules task was not found.","dataMode":"params","folder":"1-31","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/matching_rules/{{taskId}}","collectionId":"1","id":"1-31-173","method":"DELETE"},{"headers":"Accept: application/json\n","collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/","name":"Get all exceptions","method":"GET","id":"1-31-174","description":"Gets a list of all unified security policy exceptions.

Parameters:
context: Global MSSP context [optional]
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query starting from starting page allowable type in numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions

Response Messages:
401: User not permitted to access the specified domain","folder":"1-31"},{"headers":"Content-Type: application/xml\n","name":"Create an exception","dataMode":"raw","description":"Create an exception for unified security policies.

Parameters:
context: Global MSSP context [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_policies/exceptions
BODY<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<security_policy_exception>
    <approved_by>admin</approved_by>
    <created_by>st_user</created_by>
    <creation_date>2015-01-01</creation_date>
    <description>Allow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321</description>
    <exempted_traffic_list>
        <exempted_traffic>
            <comment>Creating USP exception for ticket 123</comment>
            <dest_network_collection>
                <network_items>
                    <network_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"subnet\">
                        <ip>192.168.1.2</ip>
                        <netmask>255.255.255.255</netmask>
                    </network_item>
                </network_items>
            </dest_network_collection>
            <security_requirements>
                <zone_to_zone_security_requirement>
                    <from_zone>LAN</from_zone>
                    <policy_name>corporate security policy</policy_name>
                    <to_zone>DMZ</to_zone>
                </zone_to_zone_security_requirement>
            </security_requirements>
            <service_collection>
                <service_items>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"custom\">
                        <port>4321</port>
                        <protocol>tcp</protocol>
                    </service_item>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"device_service\">
                        <mgmt_id>1</mgmt_id>
                        <service_uid>{5aa1c104-bd4d-4635-a281-b3a5442639ba}</service_uid>
                    </service_item>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"predefined\">
                        <predefined_service_name>http</predefined_service_name>
                    </service_item>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"range_service\">
                        <minProtocol>10</minProtocol>
                        <maxProtocol>20</maxProtocol>
                    </service_item>
                </service_items>
            </service_collection>
            <source_network_collection>
                <network_items>
                    <network_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"subnet\">
                        <ip>192.168.1.1</ip>
                        <netmask>255.255.255.255</netmask>
                    </network_item>
                </network_items>
            </source_network_collection>
        </exempted_traffic>
    </exempted_traffic_list>
    <expiration_date>2025-01-01</expiration_date>
    <name>Allow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321</name>
    <requested_by>admin</requested_by>
    <ticket_id>123</ticket_id>
</security_policy_exception>


Response Messages:
400: The specified network item is not valid.
400: The specified zone name does not exist.
400: The security policy with the specified name does not exist
400: The security policy 'created by' user is not valid.
400: The security policy with the specified name already exists.
401: User not permitted to access the specified domain.","folder":"1-31","rawModeData":"\n\n\tadmin\n\tst_user\n\t2015-01-01\n\tAllow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321\n\t\n\t\t\n\t\t\tCreating USP exception for ticket 123\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t192.168.1.2\n\t\t\t\t\t\t255.255.255.255\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\tLAN\n\t\t\t\t\tcorporate security policy\n\t\t\t\t\tDMZ\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t4321\n\t\t\t\t\t\ttcp\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t1\n\t\t\t\t\t\t{5aa1c104-bd4d-4635-a281-b3a5442639ba}\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\thttp\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t10\n\t\t\t\t\t\t20\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t192.168.1.1\n\t\t\t\t\t\t255.255.255.255\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\t2025-01-01\n\tAllow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321\n\tadmin\n\t123\n","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/","collectionId":"1","id":"1-31-175","method":"POST"},{"headers":"Accept: application/json\n","collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/","name":"Get unified security policies","method":"GET","id":"1-32-176","description":"Fetches the security zone matrices defined under Unified Security Policy.

Parameters:
context: Returns results for the specified domain ID. [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies

Response Messages:
401: User not permitted to access the specified domain","folder":"1-32"},{"headers":"Content-Type: application/xml\n","name":"Set manual device mapping","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"}],"dataMode":"raw","description":"Add or remove a zone on a device interface

Parameters:
context: Global MSSP context [optional]
deviceId: Device ID
body: InterfacesManualMappingsDTO

Usage Example
URLhttps://127.0.0.1/securetrack/api/security_policies/10/manual_mapping
BODY<interfaces_manual_mappings>
<interface_manual_mapping>
<interface_name>Vlan_30</interface_name>
<zones_user_actions>
<zone_user_action>
<zoneId>10</zoneId>
<action>add</action>
</zone_user_action>
</zones_user_actions>
</interface_manual_mapping>
</interfaces_manual_mappings>


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions
404: Not found error
404: User action not valid (only add/remove)
404: No interface with name for device with id
404: No zone with id
404: No revision for device with id
404: No device with ID
404: Access denied for device with ID
404: InterfacesManualMappingsDTO is empty
404: Error on updating security_policy_interface_zone_mapping_user_action table for device with ID","folder":"1-32","rawModeData":"\n \n Vlan_30\n \n \n 10\n add\n \n \n \n\n ","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/{{deviceId}}/manual_mapping","collectionId":"1","id":"1-32-177","method":"POST"},{"headers":"Accept: application/json\n","collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/global","name":"Get global unified security policies","method":"GET","id":"1-32-178","description":"Fetches the global security zone matrices defined under Unified Security Policy.



Usage Example
https://192.168.1.1/securetrack/api/security_policies/global

Response Messages:
401: User not permitted to access global security policies","folder":"1-32"},{"collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/{{id}}/export","name":"Get unified security policy as CSV","method":"GET","id":"1-32-179","description":"Exports a Security Policy in CSV format

Parameters:
context: Returns results for the specified domain ID. [optional]
id: ID of the security policy. [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies/1/export

Response Messages:
401: User not permitted to access the specified domain
404: Security Policy does not exist","folder":"1-32"},{"name":"Delete unified security policy","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Delete a Security Policy Matrix

Parameters:
context: Returns results for the specified domain ID. [optional]
id: The unique identifier of the security policy matrix to delete

Usage Example
https://192.168.1.1/securetrack/api/security_policies/1
","folder":"1-32","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/{{id}}","collectionId":"1","id":"1-32-180","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get the violating rules for the specified device.","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"},{"value":null,"type":"text","enabled":true,"key":"severity"},{"value":null,"type":"text","enabled":true,"key":"type"}],"dataMode":"params","description":"policyName is supported for management devices running in Advanced management mode.

Parameters:
deviceId: The device ID for which to get violations
policyName: Return only violations that match this policy [optional]
severity: Return only violations of this severity
type: Return only violations of this type

Usage Example
https://192.168.1.1/securetrack/api/violating_rules/1/device_violations?policy=policy_name&type=SECURITY_POLICY&severity=MEDIUM

Response Messages:
200: The violations were successfully retrieved
400: The specified value for the violation severity is invalid
400: The specified value for the violation type is invalid
400: You cannot specify a policyName because the device is not running in Advanced management mode
404: A device with the specified ID was not found
404: A policy with the specified policyName was not found for this device","folder":"1-33","url":"https://{{SecureTrack_IP}}/securetrack/api/violating_rules/{{deviceId}}/device_violations","collectionId":"1","id":"1-33-181","method":"GET"},{"headers":"Accept: application/json\n","name":"Get the amount of violating rules for the specified device.","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"}],"description":"Parameters:
deviceId: The device ID for which to get violations.

Usage Example
https://192.168.1.1/securetrack/api/violating_rules/1/count

Response Messages:
200: The violation count was successfully retrieved
404: Device with id: <deviceId> doesn't exist","dataMode":"params","folder":"1-33","url":"https://{{SecureTrack_IP}}/securetrack/api/violating_rules/{{deviceId}}/count","collectionId":"1","id":"1-33-182","method":"GET"}],"order":[],"name":"Tufin Tufin SecureTrack R19-3-GA","id":"1","description":"Tufin Orchestration Suite - Tufin SecureTrack APIs.
For detailed information about the APIs please see the documentation at:
https://your-securetrack-server/securetrack/apidoc"} \ No newline at end of file diff --git a/Postman Format v1/R19-3 postman collection/tufin.postman_environment b/Postman Format v1/R19-3 postman collection/tufin.postman_environment new file mode 100644 index 0000000..51d4258 --- /dev/null +++ b/Postman Format v1/R19-3 postman collection/tufin.postman_environment @@ -0,0 +1 @@ +{"name":"Tufin environment","values":[{"type":"text","key":"SecureApp_IP"},{"type":"text","key":"SecureChange_IP"},{"type":"text","key":"SecureTrack_IP"},{"type":"text","key":"applicationId"},{"type":"text","key":"applicationInterfaceId"},{"type":"text","key":"application_id"},{"type":"text","key":"application_pack_id"},{"type":"text","key":"assigneeId"},{"type":"text","key":"child_id"},{"type":"text","key":"child_ids"},{"type":"text","key":"cleanup_id"},{"type":"text","key":"cloud_id"},{"type":"text","key":"connectionId"},{"type":"text","key":"connectionInterfaceId"},{"type":"text","key":"connectionToApplicationId"},{"type":"text","key":"connection_id"},{"type":"text","key":"connection_to_application_pack_id"},{"type":"text","key":"customer_id"},{"type":"text","key":"deviceId"},{"type":"text","key":"device_id"},{"type":"text","key":"domainId"},{"type":"text","key":"exceptionId"},{"type":"text","key":"fieldId"},{"type":"text","key":"id"},{"type":"text","key":"ids"},{"type":"text","key":"instructionId"},{"type":"text","key":"managementId"},{"type":"text","key":"parent_id"},{"type":"text","key":"parent_ids"},{"type":"text","key":"policyId"},{"type":"text","key":"requestId"},{"type":"text","key":"revId"},{"type":"text","key":"revision_id"},{"type":"text","key":"risk_id"},{"type":"text","key":"ruleId"},{"type":"text","key":"rule_id"},{"type":"text","key":"rule_uid"},{"type":"text","key":"serverId"},{"type":"text","key":"serviceId"},{"type":"text","key":"sourceApplicationId"},{"type":"text","key":"stepId"},{"type":"text","key":"tag_id"},{"type":"text","key":"targetApplicationId"},{"type":"text","key":"taskId"},{"type":"text","key":"task_id"},{"type":"text","key":"task_uid"},{"type":"text","key":"toStepId"},{"type":"text","key":"uid"},{"type":"text","key":"userId"},{"type":"text","key":"zone_id"},{"type":"text","key":"zone_ids"}]} \ No newline at end of file diff --git a/Postman Format v1/R20-1 postman collection/securechangeworkflow_R20-1-GA.json b/Postman Format v1/R20-1 postman collection/securechangeworkflow_R20-1-GA.json new file mode 100644 index 0000000..4e7d9d3 --- /dev/null +++ b/Postman Format v1/R20-1 postman collection/securechangeworkflow_R20-1-GA.json @@ -0,0 +1 @@ +{"folders":[{"order":["2-1-1","2-1-2","2-1-3","2-1-4","2-1-5"],"collectionId":"2","name":"Access Portal","hasRequests":true,"id":"2-1"},{"order":["2-2-6","2-2-7","2-2-8","2-2-9","2-2-10","2-2-11","2-2-12","2-2-13"],"collectionId":"2","name":"Application Connections","hasRequests":true,"id":"2-2"},{"order":["2-3-14"],"collectionId":"2","name":"Application Identities","hasRequests":true,"id":"2-3"},{"order":["2-4-15","2-4-16","2-4-17","2-4-18","2-4-19","2-4-20","2-4-21","2-4-22","2-4-23","2-4-24","2-4-25","2-4-26","2-4-27","2-4-28","2-4-29"],"collectionId":"2","name":"Application Interfaces","hasRequests":true,"id":"2-4"},{"order":["2-5-30","2-5-31","2-5-32","2-5-33","2-5-34"],"collectionId":"2","name":"Application Migration","hasRequests":true,"id":"2-5"},{"order":["2-6-35","2-6-36","2-6-37","2-6-38","2-6-39","2-6-40","2-6-41","2-6-42","2-6-43","2-6-44","2-6-45","2-6-46","2-6-47","2-6-48","2-6-49","2-6-50","2-6-51","2-6-52"],"collectionId":"2","name":"Application Packs","hasRequests":true,"id":"2-6"},{"order":["2-7-53"],"collectionId":"2","name":"Application Pending Changes","hasRequests":true,"id":"2-7"},{"order":["2-8-54","2-8-55"],"collectionId":"2","name":"Application Servers (across all applications)","hasRequests":true,"id":"2-8"},{"order":["2-9-56","2-9-57","2-9-58","2-9-59","2-9-60","2-9-61","2-9-62","2-9-63"],"collectionId":"2","name":"Application Servers (by application)","hasRequests":true,"id":"2-9"},{"order":["2-10-64","2-10-65","2-10-66","2-10-67","2-10-68","2-10-69"],"collectionId":"2","name":"Application Services (global)","hasRequests":true,"id":"2-10"},{"order":["2-11-70","2-11-71","2-11-72","2-11-73","2-11-74"],"collectionId":"2","name":"Application Services (local)","hasRequests":true,"id":"2-11"},{"order":["2-12-75","2-12-76","2-12-77","2-12-78"],"collectionId":"2","name":"Application Users","hasRequests":true,"id":"2-12"},{"order":["2-13-79","2-13-80","2-13-81","2-13-82","2-13-83","2-13-84","2-13-85","2-13-86","2-13-87","2-13-88","2-13-89"],"collectionId":"2","name":"Applications","hasRequests":true,"id":"2-13"},{"order":["2-14-90","2-14-91","2-14-92"],"collectionId":"2","name":"Cloud Console","hasRequests":true,"id":"2-14"},{"order":["2-15-93","2-15-94","2-15-95","2-15-96","2-15-97","2-15-98","2-15-99"],"collectionId":"2","name":"Customers","hasRequests":true,"id":"2-15"},{"order":["2-16-100","2-16-101","2-16-102"],"collectionId":"2","name":"Domains","hasRequests":true,"id":"2-16"},{"order":["2-17-103"],"collectionId":"2","name":"Load Balancers","hasRequests":true,"id":"2-17"},{"order":["2-18-104","2-18-105","2-18-106","2-18-107"],"collectionId":"2","name":"SecureChange Devices","hasRequests":true,"id":"2-18"},{"order":["2-19-108","2-19-109","2-19-110","2-19-111","2-19-112","2-19-113"],"collectionId":"2","name":"Server Decommissioning","hasRequests":true,"id":"2-19"},{"order":["2-20-114","2-20-115"],"collectionId":"2","name":"System Configuration","hasRequests":true,"id":"2-20"},{"order":["2-21-116","2-21-117","2-21-118","2-21-119","2-21-120","2-21-121","2-21-122"],"collectionId":"2","name":"System Users","hasRequests":true,"id":"2-21"},{"order":["2-22-123","2-22-124","2-22-125","2-22-126","2-22-127","2-22-128","2-22-129","2-22-130"],"collectionId":"2","name":"Ticket Lifecycle","hasRequests":true,"id":"2-22"},{"order":["2-23-131","2-23-132","2-23-133","2-23-134","2-23-135","2-23-136","2-23-137","2-23-138","2-23-139","2-23-140","2-23-141","2-23-142","2-23-143","2-23-144","2-23-145","2-23-146","2-23-147","2-23-148","2-23-149","2-23-150","2-23-151","2-23-152","2-23-153","2-23-154","2-23-155","2-23-156"],"collectionId":"2","name":"Tickets","hasRequests":true,"id":"2-23"}],"requests":[{"headers":"Accept: application/json\n","name":"Retrieve existing application access requests","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests

Response Messages:
400: The application was already deleted.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.","dataMode":"params","folder":"2-1","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests","collectionId":"2","id":"2-1-1","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Update application access requests","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"dataMode":"raw","description":"Use this API to approve or reject application access requests

Parameters:
applicationId: The unique identifier of the application
body: application access requests

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests
BODY<application_access_requests>
    <application_access_request>
        <id>1</id>
        <action>APPROVE</action>
    </application_access_request>
    <application_access_request>
        <id>2</id>
        <action>REJECT</action>
    </application_access_request>
</application_access_requests>


Response Messages:
200: Application access requests were updated.
400: The application was already deleted.
400: Invalid ID for access request
400: Cannot update access request with id ID
400: Action cannot be empty in request with id ID
400: Invalid action in request with id ID
400: The Server group is lock for discovery
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","folder":"2-1","rawModeData":"\n\t\n\t\t1\n\t\tAPPROVE\n\t\n\t\n\t\t2\n\t\tREJECT\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests","collectionId":"2","id":"2-1-2","method":"PUT"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Create application access request","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: application access request

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests
BODY<application_access_request>
    <server_group_id>1</server_group_id>
    <server_ip>1.1.1.1</server_ip>
    <comment>Request to join the WebServers server group</comment>
</application_access_request>


Response Messages:
201: Application access request was submitted.
400: The application was already deleted.
400: Server id cannot be empty.
400: Hostname or IP cannot be empty.
400: The provided server does not exist in application.
400: The provided server is not allowed to access.
400: Request already created
400: Requester cannot be null
400: Group cannot be empty
400: Invalid ip
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","dataMode":"raw","folder":"2-1","rawModeData":"\n\t1\n\t1.1.1.1\n\tRequest to join the WebServers server group\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests","collectionId":"2","id":"2-1-3","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Update an application access request","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"requestId"}],"dataMode":"raw","description":"Use this API to approve or reject application access requests

Parameters:
applicationId: The unique identifier of the application
requestId: The unique identifier of the application access request
body: application access request

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests/1
BODY<application_access_request>
    <action>APPROVE</action>
</application_access_request>


Response Messages:
200: Application access request was updated.
400: The application was already deleted.
400: Invalid ID for access request
400: Cannot update access request with id ID
400: Action cannot be empty in request with id ID
400: Invalid action in request with id ID
400: The Server group is lock for discovery
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","folder":"2-1","rawModeData":"\n\tAPPROVE\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests/{{requestId}}","collectionId":"2","id":"2-1-4","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve an existing application access request by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"requestId"}],"description":"Parameters:
applicationId: The unique identifier of the application
requestId: The unique identifier of the application access request

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests/1

Response Messages:
400: The application was already deleted.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Access request with id ID was not found in application with id ID","dataMode":"params","folder":"2-1","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests/{{requestId}}","collectionId":"2","id":"2-1-5","method":"GET"},{"headers":"Accept: application/json\n","name":"Retrieve existing connections, with extended resources information","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the connection [optional]
start: Return results starting only from the specified index; 0-based index; default value = 0 [optional]
count: Return the specified number of results. Returns all results if no value specified [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended?name=Connection Name

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended?name=Connection Name&start=50&count=100

Response Messages:
400: Start value cannot be a negative number.
400: Count value must be greater than 0.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: Access is denied.
404: There is no application with the specified ID.
404: There are no connections with the name NAME.","dataMode":"params","folder":"2-2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_extended","collectionId":"2","id":"2-2-6","method":"GET"},{"headers":"Accept: application/json\n","name":"Retrieve an existing connection by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"connectionId"}],"description":"Parameters:
applicationId: The unique identifier of the application
connectionId: The unique identifier of the connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/1

Response Messages:
401: No available licenses. Ask your SecureApp administrator for assistance.
401: Access is denied
401: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID.","dataMode":"params","folder":"2-2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}","collectionId":"2","id":"2-2-7","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Update a connection","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"connectionId"}],"description":"Parameters:
applicationId: The unique identifier of the application
connectionId: The unique identifier of the connection
body: Connection

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections/1
BODY <connection>
     <name>Connection A</name>
     <comment>Connection A comment</comment>
     <sources>
         <source>
             <id>2</id>
         </source>
         <source>
             <id>3</id>
         </source>
     </sources>
     <services>
         <service>
             <id>1</id>
         </service>
     </services>
     <destinations>
         <destination>
             <id>1</id>
         </destination>
     </destinations>
</connection>


Response Messages:
200: Connection was modified.
400: Reference to service ID is invalid.
400: Reference to source/destination with ID is invalid.
400: Connection name cannot be empty.
400: Connection name already exists.
400: Connection NAME contains duplicate destinations.
400: Destination cannot contain users.
400: Resource cannot contain other objects along with Any.
400: Connection NAME contains duplicate sources.
400: You cannot add external resources to interface connections.
400: You cannot have Any in both the source and destination.
400: You cannot add external resources to interface connections.
400: Source cannot contain both users and servers.
400: Connection NAME contains duplicate services.
400: Cannot contain other services along with ANY.
400: Connections can only include objects within the same customer.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permission to access application that contains the server ID
401: You do not have permissions to edit this application.
401: Access is denied
401: You cannot edit or delete an external connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID.","dataMode":"raw","folder":"2-2","rawModeData":" \n\t Connection A\n\t Connection A comment\n\t \n\t\t \n\t\t\t 2\n\t\t \n\t\t \n\t\t\t 3\n\t\t \n\t \n\t \n\t\t \n\t\t\t 1\n\t\t \n\t \n\t \n\t\t \n\t\t\t 1\n\t\t \n\t \n ","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}","collectionId":"2","id":"2-2-8","method":"PUT"},{"name":"Delete connection","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"connectionId"}],"description":"Parameters:
applicationId: The unique identifier of the application
connectionId: The unique identifier of the connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/1

Response Messages:
200: Connection was deleted.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
401: Access is denied
401: You cannot edit or delete an external connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID.","dataMode":"params","folder":"2-2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}","collectionId":"2","id":"2-2-9","method":"DELETE"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Create a ticket to repair a connection","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"},{"value":null,"type":"text","enabled":true,"key":"connection_id"}],"description":"Parameters:
application_id: The application ID
connection_id: The connection ID
body: Ticket

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/2/repair
BODY<ticket>
    <subject>Repair connection 2</subject>
    <requester>u1</requester>
    <priority>Normal</priority>
    <workflow>
        <name>Workflow with topology</name>
    </workflow>
    <steps>
        <step>
            <name>Open request</name>
            <tasks>
                <task>
                    <fields>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_area\">
                            <name>Business Justification</name>
                            <text>I need access to ftp </text>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_field\">
                            <name>Project Number</name>
                            <text>CR124560</text>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"hyperlink\">
                            <name>Hyperlink</name>
                            <url>http://192.168.1.1/ticket</url>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"drop_down_list\">
                            <name>Change Window</name>
                            <selection>Monday</selection>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"manager\">
                            <name>manager email</name>
                            <text>manager@tufin.com</text>
                        </field>
                    </fields>
                </task>
            </tasks>
        </step>
    </steps>
    <comments/>
</ticket>


Response Messages:
201: Ticket was created.
400: The requester must be the currently logged in user.
400: Workflow was not found.
400: Workflow is not active.
400: Workflow configuration is not valid.
400: Workflow is not set.
400: You cannot enter a status for a new ticket.
400: Requester cannot open a ticket in domain.
400: Invalid ticket priority.
400: Expiration field is required.
400: Submit ticket enabled only with the first step.
400: First step can be only with one task.
400: The specified workflow does not contain an access request field in the first step.
400: You cannot use an access request field to create a ticket from SecureApp.
400: The ticket fields do not match the fields in the current step of the workflow.
400: You cannot change the value of a field because it is read-only.
401: Logged in user: NAME do not have permission to perform on behalf actions.
401: You are not a participant in the first step of this workflow.
401: Access is denied.
401: To create a ticket you must purchase a valid SecureChange license.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: Cannot create a ticket to repair this connection because the connection status is not disconnected.
403: Cannot create a ticket to repair this connection because the connection was edited but a ticket has not been created yet.
403: Cannot create a ticket to repair this connection because there are other open tickets for an application that includes this connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID.","dataMode":"raw","folder":"2-2","rawModeData":"\n\tRepair connection 2\n\tu1\n\tNormal\n\t\n\t\tWorkflow with topology\n\t\n\t\n\t\t\n\t\t\tOpen request\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tBusiness Justification\n\t\t\t\t\t\t\tI need access to ftp \n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tProject Number\n\t\t\t\t\t\t\tCR124560\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tHyperlink\n\t\t\t\t\t\t\thttp://192.168.1.1/ticket\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tChange Window\n\t\t\t\t\t\t\tMonday\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tmanager email\n\t\t\t\t\t\t\tmanager@tufin.com\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connections/{{connection_id}}/repair","collectionId":"2","id":"2-2-10","method":"POST"},{"headers":"Content-Type: application/xml\n","name":"Update connections","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: List of connections

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections
BODY<connections>
     <connection>
         <id>1</id>
         <name>Connection A</name>
         <comment>Connection A comment</comment>
         <sources>
             <source>
                 <id>2</id>
             </source>
             <source>
                 <id>3</id>
             </source>
         </sources>
         <services>
             <service>
                 <id>1</id>
             </service>
         </services>
         <destinations>
             <destination>
                 <id>1</id>
             </destination>
         </destinations>
     </connection>
     <connection>
         <id>2</id>
         <name>Connection B</name>
     </connection>
     <connection>
         <id>3</id>
         <name>Connection C</name>
         <sources>
             <source>
                 <id>2</id>
             </source>
         </sources>
     </connection>
</connections>


Response Messages:
200: Connections were modified.
400: Reference to service ID is invalid.
400: Reference to source/destination with ID is invalid.
400: Connection name cannot be empty.
400: Connection name already exists.
400: Connection NAME contains duplicate destinations.
400: Destination cannot contain users.
400: Resource cannot contain other objects along with Any.
400: Connection NAME contains duplicate sources.
400: You cannot add external resources to interface connections.
400: You cannot have Any in both the source and destination.
400: You cannot add external resources to interface connections.
400: Source cannot contain both users and servers.
400: Connection NAME contains duplicate services.
400: Cannot contain other services along with ANY.
400: Connections can only include objects within the same customer.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permission to access application that contains the server ID
401: You do not have permissions to edit this application.
401: Access is denied
401: You cannot edit or delete an external connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID.","dataMode":"raw","folder":"2-2","rawModeData":"\n\t \n\t\t 1\n\t\t Connection A\n\t\t Connection A comment\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t\t \n\t\t\t\t 3\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t \n\t \n\t\t 2\n\t\t Connection B\n\t \n\t \n\t\t 3\n\t\t Connection C\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t \n\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections","collectionId":"2","id":"2-2-11","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve existing connections","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the connection [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections?name=Connection Name

Response Messages:
401: No available licenses. Ask your SecureApp administrator for assistance.
401: Access is denied
401: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: There are no connections with the name NAME.","dataMode":"params","folder":"2-2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections","collectionId":"2","id":"2-2-12","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create connections","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: The list of the connections

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections
BODY<connections>
     <connection>
         <name>Connection A</name>
         <comment>Connection A comment</comment>
         <sources>
             <source>
                 <id>2</id>
             </source>
             <source>
                 <id>3</id>
             </source>
         </sources>
         <services>
             <service>
                 <id>1</id>
             </service>
         </services>
         <destinations>
             <destination>
                 <id>1</id>
             </destination>
         </destinations>
     </connection>
     <connection>
         <name>Connection B</name>
     </connection>
     <connection>
         <name>Connection C</name>
         <sources>
             <source>
                 <id>2</id>
             </source>
         </sources>
     </connection>
</connections>


Response Messages:
200: Connections were created.
201: Connection was created.
400: There are no items to add.
400: You cannot add to application NAME because it was decommissioned.
400: Connection name already exists.
400: Reference to service ID is invalid.
400: Reference to source/destination with ID is invalid.
400: Connection NAME contains duplicate destinations.
400: Destination cannot contain users.
400: Resource cannot contain other objects along with Any.
400: Connection NAME contains duplicate sources.
400: You cannot add external resources to interface connections.
400: You cannot have Any in both the source and destination.
400: You cannot add external resources to interface connections.
400: Source cannot contain both users and servers.
400: Connection NAME contains duplicate services.
400: Cannot contain other services along with ANY.
400: Connections can only include objects within the same customer.
401: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
401: Access is denied
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","dataMode":"raw","folder":"2-2","rawModeData":"\n\t \n\t\t Connection A\n\t\t Connection A comment\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t\t \n\t\t\t\t 3\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t \n\t \n\t\t Connection B\n\t \n\t \n\t\t Connection C\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t \n\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections","collectionId":"2","id":"2-2-13","method":"POST"},{"headers":"Accept: application/json\n","name":"Fetches application identities","description":"Fetches the list of pre-defined application identities (like facebook) that can be used in a connection.

Parameters:
name: The name of the service [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/application_identities

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/application_identities?name=facebook

Response Messages:
404: There are no application identities with the name NAME.
401: Access is denied.","folder":"2-3","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/application_identities","collectionId":"2","id":"2-3-14","method":"GET"},{"headers":"Accept: application/json\n","name":"Retrieve an existing application interface by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}","collectionId":"2","id":"2-4-15","method":"GET"},{"name":"Delete application interface","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1

Response Messages:
200: Application interface was deleted.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}","collectionId":"2","id":"2-4-16","method":"DELETE"},{"headers":"Content-Type: application/xml\n","name":"Update an application interface","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"}],"dataMode":"raw","description":"Update the application interface properties. If is_published is set to true, the application interface is published for use by other users.

Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of The application interface
body: The application interface

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1
BODY<application_interface>
    <name>updated name</name>
    <comment>Updated application interface</comment>
    <is_published>true</is_published>
</application_interface>


Response Messages:
200: Application interface was modified.
400: Application interface is not complete for publish.
400: Name cannot be empty.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.","folder":"2-4","rawModeData":"\n\tupdated name\n\tUpdated application interface\n\ttrue\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}","collectionId":"2","id":"2-4-17","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve existing interface connections","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
name: The name of the interface connection [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections?name=Connection 1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There are no connection interfaces with the name NAME.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections","collectionId":"2","id":"2-4-18","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create interface connections","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
body: The interface connections

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections
BODY<interface_connections>
    <interface_connection>
        <name>Connection 1</name>
        <sources>
            <source>
                <id>3</id>
            </source>
        </sources>
        <services>
            <service>
                <id>3</id>
            </service>
            <service>
                <id>Facebook</id>
            </service>
        </services>
        <comment>New connection</comment>
    </interface_connection>
</interface_connections>


Response Messages:
200: Interface connections were created.
201: Interface connection was created.
400: There are no items to add.
400: Cannot create interface connection without a name.
400: Connection name already exists.
400: You cannot add user to connection interface.
400: You cannot add Any to connection interface.
400: You cannot add Internet to connection interface.
400: Cannot have external servers.
400: Cannot have both sources and destinations.
400: Connection NAME contains duplicate sources.
400: Connection NAME contains duplicate services.
400: Connection NAME contains duplicate destinations.
400: Reference to source/destination with ID is invalid.
400: Reference to service ID is invalid.
401: Access is denied.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.","dataMode":"raw","folder":"2-4","rawModeData":"\n\t\n\t\tConnection 1\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\t\n\t\t\t\tFacebook\n\t\t\t\n\t\t\n\t\tNew connection\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections","collectionId":"2","id":"2-4-19","method":"POST"},{"headers":"Content-Type: application/xml\n","name":"Create connection to application","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"dataMode":"raw","description":"Create a connection from this application to an application interface.

Parameters:
applicationId: The unique identifier of the application
body: The connection to application

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications
BODY<connection_to_application>
    <name>Connection to Application 1</name>
    <comment>New connection to application</comment>
    <application_interface_id>1</application_interface_id>
    <servers>
        <server>
            <id>3</id>
        </server>
    </servers>
</connection_to_application>


Response Messages:
201: Connection to application was created.
400: You cannot add to application NAME because it was decommissioned.
400: The selected interface cannot be used more than once in the application.
400: Name cannot be empty.
400: Cannot create from local interface.
400: ApplicationInterface didn't got published.
400: Name already exists.
400: Cannot create connection to application without servers, there should be at least one server.
400: Reference to source/destination with ID is invalid.
400: You can use only interface from the same customer.
400: You cannot add ANY to connection to application.
400: You cannot add user to connection to application.
400: You cannot add Internet to connection to application.
401: Access is denied
401: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found.","folder":"2-4","rawModeData":"\n\tConnection to Application 1\n\tNew connection to application\n\t1\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications","collectionId":"2","id":"2-4-20","method":"POST"},{"headers":"Accept: application/json\n","name":"Retrieve existing connections to application","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the connection to application [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications?name=Connection to Application 1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications","collectionId":"2","id":"2-4-21","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Update an interface connection","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"},{"value":null,"type":"text","enabled":true,"key":"connectionInterfaceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
connectionInterfaceId: The unique identifier of the interface connection
body: The interface connection

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections/1
BODY<interface_connection>
    <name>Updated name</name>
    <sources>
        <source>
            <id>19</id>
        </source>
    </sources>
    <services>
        <service>
            <id>9</id>
        </service>
    </services>
    <comment>Updated connection</comment>
</interface_connection>


Response Messages:
200: Interface connection was modified.
400: Interface connection name cannot be empty.
400: Connection name already exists.
400: You cannot add user to connection interface.
400: You cannot add Any to connection interface.
400: You cannot add Internet to connection interface.
400: Cannot have external servers.
400: Cannot have both sources and destinations.
400: Connection NAME contains duplicate sources.
400: Connection NAME contains duplicate services.
400: Connection NAME contains duplicate destinations.
400: Reference to source/destination with ID is invalid.
400: Reference to service ID is invalid.
401: Access is denied.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID.","dataMode":"raw","folder":"2-4","rawModeData":"\n\tUpdated name\n\t\n\t\t\n\t\t\t19\n\t\t\n\t\n\t\n\t\t\n\t\t\t9\n\t\t\n\t\n\tUpdated connection\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}","collectionId":"2","id":"2-4-22","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve an existing interface connection by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"},{"value":null,"type":"text","enabled":true,"key":"connectionInterfaceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
connectionInterfaceId: The unique identifier of the interface connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections/1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}","collectionId":"2","id":"2-4-23","method":"GET"},{"name":"Delete interface connection","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"},{"value":null,"type":"text","enabled":true,"key":"connectionInterfaceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
connectionInterfaceId: The unique identifier of the interface connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections/1

Response Messages:
200: Interface connection was deleted.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}","collectionId":"2","id":"2-4-24","method":"DELETE"},{"headers":"Content-Type: application/xml\n","name":"Update a connection to application","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"connectionToApplicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
connectionToApplicationId: The unique identifier of the connection to application
body: The connection to application

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications/1
BODY<connection_to_application>
    <name>Updated name</name>
    <comment>Updated connection to application</comment>
    <servers>
        <server>
            <id>4</id>
        </server>
    </servers>
</connection_to_application>


Response Messages:
200: Connection to application was modified.
400: Name cannot be empty.
400: Name already exists.
400: Reference to source/destination with ID is invalid.
400: You cannot add ANY to connection to application.
400: You cannot add user to connection to application.
400: You cannot add Internet to connection to application.
401: Access is denied
401: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection to application with ID was not found for application interface with ID.","dataMode":"raw","folder":"2-4","rawModeData":"\n\tUpdated name\n\tUpdated connection to application\n\t\n\t\t\n\t\t\t4\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications/{{connectionToApplicationId}}","collectionId":"2","id":"2-4-25","method":"PUT"},{"name":"Delete connection to application","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"connectionToApplicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
connectionToApplicationId: The unique identifier of the connection to application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications/1

Response Messages:
200: Connection to application was deleted.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection to application with ID was not found for application interface with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications/{{connectionToApplicationId}}","collectionId":"2","id":"2-4-26","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Retrieve an existing connection to application by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"connectionToApplicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
connectionToApplicationId: The unique identifier of the connection to application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications/1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Connection to application with ID was not found for application interface with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications/{{connectionToApplicationId}}","collectionId":"2","id":"2-4-27","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create application interface","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: The application interface

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces
BODY<application_interface>
    <name>Interface to Application 1</name>
    <comment>New application interface</comment>
</application_interface>


Response Messages:
201: Application interface was created.
400: You cannot add to application NAME because it was decommissioned.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.","dataMode":"raw","folder":"2-4","rawModeData":"\n\tInterface to Application 1\n\tNew application interface\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces","collectionId":"2","id":"2-4-28","method":"POST"},{"headers":"Accept: application/json\n","name":"Retrieve existing application interfaces","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"dataMode":"params","description":"To improve response time, set 'calculateIsPublished = false' to avoid calculating 'is_published'.

Parameters:
applicationId: The unique identifier of the application
name: The name of the application interface [optional]
calculateIsPublished: Should calculate is_published value [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces?name=Interface to Application 1

Response Messages:
400: There is no application with the specified ID.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There are no application interfaces with the name NAME.","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces","collectionId":"2","id":"2-4-29","method":"GET"},{"headers":"Accept: application/json\n","name":"Retrieve server mappings for source and target applications","data":[{"value":null,"type":"text","enabled":true,"key":"sourceApplicationId"},{"value":null,"type":"text","enabled":true,"key":"targetApplicationId"}],"description":"Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application
search_servers_type: Search server type [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/servers_mapping

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/servers_mapping?search_servers_type=EXTERNAL

Response Messages:
400: Search migrated servers type parameter must be either internal, external or both.
400: Cannot get mappings between application to itself.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permission to access application with ID
401: You do not have permissions to edit this application.
404: There is no application with the specified ID.","dataMode":"params","folder":"2-5","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/servers_mapping","collectionId":"2","id":"2-5-30","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Update server mappings for source and target applications","data":[{"value":null,"type":"text","enabled":true,"key":"sourceApplicationId"},{"value":null,"type":"text","enabled":true,"key":"targetApplicationId"}],"dataMode":"raw","description":"Use id=-1 for target_network_object if new mapping is “Not Needed”.
If the source is specified and the target is empty, the mapping that is currently configured will be deleted.

Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application
body: The server mapping list [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/servers_mapping
BODY<servers_mapping>
    <server_mapping>
        <source_network_object>
            <id>3</id>
        </source_network_object>
        <target_network_object>
            <id>4</id>
        </target_network_object>
    </server_mapping>
    <server_mapping>
        <source_network_object>
            <id>5</id>
        </source_network_object>
        <target_network_object>
            <id>-1</id>
        </target_network_object>
    </server_mapping>
    <server_mapping>
        <source_network_object>
            <id>6</id>
        </source_network_object>
    </server_mapping>
</servers_mapping>


Response Messages:
200: Server mappings were modified.
400: Source network object cannot be empty.
400: Source network object is not valid
400: Target network object is not valid
400: Source and target network objects must be internal or external both.
400: Cannot use DEVICE application resources as external network objects.
400: Source network object with ID must be used by any connection.
400: Cannot remove mapping of network object with ID because it has never been mapped.
400: Cannot migrate application to itself.
400: Cannot map to ANY network object.
400: Cannot map Internet network object.
400: Cannot map to Internet network object.
400: Target network object ID must be in the same customer as the target application.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Server with ID was not found.","folder":"2-5","rawModeData":"\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n\t\n\t\t\n\t\t\t5\n\t\t\n\t\t\n\t\t\t-1\n\t\t\n\t\n\t\n\t\t\n\t\t\t6\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/servers_mapping","collectionId":"2","id":"2-5-31","method":"PUT"},{"name":"Copy application servers and connections to another application.","data":[{"value":null,"type":"text","enabled":true,"key":"sourceApplicationId"},{"value":null,"type":"text","enabled":true,"key":"targetApplicationId"}],"dataMode":"params","description":"This API can be used to:
1. Create applications based on a blueprint (template).
2. Copy applications between environments (dev, test, prod).
3. Migrate applications between data-centers.

Before migrating make sure to map servers and connections to applications (if any exist).\nThis migration uses the configuration specified in the other API calls.

Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2

Response Messages:
200: Application was migrated.
400: Cannot migrate a decommissioned application.
400: Cannot migrate to a decommissioned application.
400: Cannot migrate an application to itself.
400: Cannot edit target DEVICE application.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
400: The source application has no connections to migrate.
409: You cannot migrate the application because not all servers are mapped.
409: You cannot migrate the application because not all connections to application are mapped.
409: You cannot migrate the application because one of the interfaces in the original application has been changed and has not been published.","folder":"2-5","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}","collectionId":"2","id":"2-5-32","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Update connection to application mappings for source and target applications","data":[{"value":null,"type":"text","enabled":true,"key":"sourceApplicationId"},{"value":null,"type":"text","enabled":true,"key":"targetApplicationId"}],"dataMode":"raw","description":"Use id=-1 for target_application_interface if new mapping is “Not Needed”.
If the source is specified and the target is empty, the mapping that is currently configured will be deleted.

Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application
body: The interface instance mapping list [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/connections_to_applications_mapping
BODY<connections_to_applications_mapping>
    <connection_to_application_mapping>
        <source_connection_to_application>
            <id>1</id>
        </source_connection_to_application>
        <target_application_interface>
            <id>4</id>
        </target_application_interface>
    </connection_to_application_mapping>
    <connection_to_application_mapping>
        <source_connection_to_application>
            <id>2</id>
        </source_connection_to_application>
        <target_application_interface>
            <id>-1</id>
        </target_application_interface>
    </connection_to_application_mapping>
    <connection_to_application_mapping>
        <source_connection_to_application>
            <id>3</id>
        </source_connection_to_application>
    </connection_to_application_mapping>
</connections_to_applications_mapping>


Response Messages:
200: Connection to application mappings were modified.
400: Source interface instance cannot be empty.
400: Source interface instance object is not valid
400: Target application interface is not valid
400: Connection to application with ID: ID was not found.
400: Interface with ID: ID was not found.
400: Cannot remove mapping of instance with ID because it has never been mapped.
400: Cannot migrate application to itself.
400: Cannot map instance to interface with ID ID because the interface exists in target application.
400: Cannot map to duplicate application interfaces
400: Application interface didn't got published
400: Connection to application with id: ID must used by source application
400: You cannot map connection to application ID, because it is contained in a connection to application pack.
400: Application interface ID must be in the same customer as the target application.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","folder":"2-5","rawModeData":"\n\t\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n\t\n\t\t\n\t\t\t2\n\t\t\n\t\t\n\t\t\t-1\n\t\t\n\t\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/connections_to_applications_mapping","collectionId":"2","id":"2-5-33","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve connection to application mappings for source and target applications","data":[{"value":null,"type":"text","enabled":true,"key":"sourceApplicationId"},{"value":null,"type":"text","enabled":true,"key":"targetApplicationId"}],"description":"Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/connections_to_applications_mapping

Response Messages:
400: Cannot get mappings between application to itself.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.","dataMode":"params","folder":"2-5","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/connections_to_applications_mapping","collectionId":"2","id":"2-5-34","method":"GET"},{"headers":"Accept: application/json\n","name":"List all application packs","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
name: The name of the application pack [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs?name=Application pack 1

Response Messages:
401: Access is denied
404: There are no application packs with the NAME in customer with ID.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/","collectionId":"2","id":"2-6-35","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create new application packs","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
body: List of application packs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs
BODY<application_packs>
    <application_pack>
        <name>Application pack 1</name>
        <comment>New application pack</comment>
        <owner>
            <id>4</id>
        </owner>
        <editors>
            <editor>
                <id>3</id>
            </editor>
        </editors>
        <viewers>
            <viewer>
                <id>5</id>
            </viewer>
        </viewers>
    </application_pack>
</application_packs>


Response Messages:
401: Access is denied
401: You do not have permission to access application that contains the interface ID
400: There are no application packs to add.
400: Application pack can be created only in meshed domain mode.
404: Customer with ID was not found.
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to owner ID is invalid.
400: There is an editor without an ID or name.
400: The application pack owner cannot also be an editor of the application pack.
400: There is a viewer without an ID or name.
400: The application pack owner cannot also be a viewer of the application pack.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application pack.
400: The owner NAME does not have permission to access applications.
400: Application pack was already saved.
400: Application pack NAME already exists.
400: Application pack name must contain at least 2 and no more than 160 characters.
400: Customer NAME is not imported to SecureApp.
400: Customer NAME was decommissioned.","dataMode":"raw","folder":"2-6","rawModeData":"\n\t\n\t\tApplication pack 1\n\t\tNew application pack\n\t\t\n\t\t\t4\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t5\n\t\t\t\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/","collectionId":"2","id":"2-6-36","method":"POST"},{"headers":"Content-Type: application/xml\n","name":"Update application packs","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"}],"dataMode":"raw","description":"Update the application packs properties. If is_published is set to true, the application pack is published for use by other users.

Parameters:
customer_id: The unique identifier of customer
body: List of application packs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs
BODY<application_packs>
    <application_pack>
        <id>1</id>
        <name>Updated name</name>
        <comment>Updated application pack</comment>
        <owner>
            <id>4</id>
        </owner>
        <editors>
            <editor>
                <id>3</id>
            </editor>
        </editors>
        <is_published>false</is_published>
    </application_pack>
</application_packs>


Response Messages:
400: There are no application packs to edit.
400: Application pack ID cannot be empty.
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to owner ID is invalid.
400: The owner NAME does not have permission to access applications.
400: There is an editor without an ID or name.
400: The application pack owner cannot also be an editor of the application pack.
400: There is a viewer without an ID or name.
400: The application pack owner cannot also be a viewer of the application pack.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application pack.
400: Application pack NAME already exists.
400: Application pack name must contain at least 2 and no more than 160 characters.
400: Customer NAME is not imported to SecureApp.
400: Customer NAME was decommissioned.
400: Application pack with ID is not ready for publish, or has no changes from the last publish.
401: Access is denied
401: You do not have permission to access application that contains the interface ID
401: You do not have permissions to edit this application pack.
401: You do not have permissions to change the owner of application pack ID.
401: You do not have permissions to change the editors and viewers of application pack ID.
404: There are no application packs with the NAME in customer with ID.","folder":"2-6","rawModeData":"\n\t\n\t\t1\n\t\tUpdated name\n\t\tUpdated application pack\n\t\t\n\t\t\t4\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\n\t\tfalse\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/","collectionId":"2","id":"2-6-37","method":"PUT"},{"name":"Delete a connection to application pack","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"},{"value":null,"type":"text","enabled":true,"key":"connection_to_application_pack_id"}],"description":"Parameters:
application_id: The unique identifier of application
connection_to_application_pack_id: The unique identifier of the connection to application pack to delete

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs/1

Response Messages:
400: Connection to application pack with ID was not found for application with ID.
400: The connection to application pack was already deleted.
401: Access is denied.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/{{connection_to_application_pack_id}}","collectionId":"2","id":"2-6-38","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Retrieve an existing connection to application pack by ID.","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"},{"value":null,"type":"text","enabled":true,"key":"connection_to_application_pack_id"}],"description":"Parameters:
application_id: The unique identifier of application
connection_to_application_pack_id: The unique identifier of the connection to application pack

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs/1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
404: There is no connection to application pack with the specified ID.
400: Application with ID doesn't own a connection to application pack with ID.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/{{connection_to_application_pack_id}}","collectionId":"2","id":"2-6-39","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Update an application pack","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"},{"value":null,"type":"text","enabled":true,"key":"connection_to_application_pack_id"}],"description":"Parameters:
application_id: The unique identifier of application
connection_to_application_pack_id: The unique identifier of the connection to application pack to update
body: Connection to application pack

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs/1
BODY<connection_to_application_pack>
    <name>Updated name</name>
    <comment>Updated Connection to application pack</comment>
    <tags_servers>
        <tag_servers>
            <tag>
                <id>1</id>
            </tag>
            <servers>
                <server>
                    <id>3</id>
                </server>
            </servers>
        </tag_servers>
        <tag_servers>
            <tag>
                <name>Tag 1</name>
            </tag>
            <servers>
            </servers>
        </tag_servers>
    </tags_servers>
</connection_to_application_pack>


Response Messages:
400: There is no application with the specified ID.
400: There is no connection to application pack with the specified ID.
400: Application with ID doesn't own a connection to application pack with ID.
400: Name cannot be empty.
400: Name must contain at least 2 and no more than 160 characters.
400: Name already exists.
400: Tag cannot be empty.
400: Tag ID or name is required.
400: Tag with Name was not found.
400: Server ID cannot be empty.
400: Servers cannot be null.
400: You cannot add ANY to connection to application pack.
400: You cannot add user to connection to application pack.
400: You cannot add Internet to connection to application pack.
401: Access is denied.
401: You do not have permission to access application that contains the server ID
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.","dataMode":"raw","folder":"2-6","rawModeData":"\n\tUpdated name\n\tUpdated Connection to application pack\n\t\n\t\t\n\t\t\t\n\t\t\t\t1\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t3\n\t\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\tTag 1\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/{{connection_to_application_pack_id}}","collectionId":"2","id":"2-6-40","method":"PUT"},{"name":"Remove application interfaces from application pack","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"},{"value":null,"type":"text","enabled":true,"key":"application_interface_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
application_interface_id: IDs of application interfaces to remove

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/application_interfaces?application_interface_id=1&application_interface_id=2

Response Messages:
200: Application Interface was deleted.
401: Access is denied
401: You do not have permissions to edit this application pack.
404: There are no application packs with the ID in customer with ID.
404: Application Package ID was not found.
404: Application interface ID was not found in application pack ID.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/application_interfaces","collectionId":"2","id":"2-6-41","method":"DELETE"},{"headers":"Content-Type: application/xml\n","name":"Update application interfaces and tag mapping","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"}],"dataMode":"raw","description":"Add application interfaces to application pack, and map a tag to the application interface. If a tag is not specified for the interface, the tag will be set to “No Tag”.

Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
body: List of interface tag mapping to be added or modified

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/application_interfaces
BODY<application_interface_tags>
    <application_interface_tag>
        <application_interface>
            <id>1</id>
        </application_interface>
        <tag>
            <id>3</id>
        </tag>
    </application_interface_tag>
    <application_interface_tag>
        <application_interface>
            <id>2</id>
        </application_interface>
    </application_interface_tag>
</application_interface_tags>


Response Messages:
401: Access is denied
404: There are no application packs with the NAME in customer with ID.
401: You do not have permissions to edit this application pack.
401: You do not have permission to access application that contains the interface ID
400: You cannot edit APPLICATION PACK because it was decommissioned.
400: Application Interface can't be null.
400: Empty interface ID is not valid.","folder":"2-6","rawModeData":"\n\t\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t3\n\t\t\n\t\n\t\n\t\t\n\t\t\t2\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/application_interfaces","collectionId":"2","id":"2-6-42","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Modify tags of an application pack","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
body: Tags to modify

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags
BODY<tags>
    <tag>
        <id>1</id>
        <name>Tag 1</name>
    </tag>
    <tag>
        <id>2</id>    
        <name>Tag 2</name>
    </tag>
</tags>


Response Messages:
401: Access is denied
401: You do not have permissions to edit this application pack.
404: Customer with ID was not found.
404: There is no application pack with the ID in customer with ID.
400: Tag with NAME already exists in application pack ID.
400: Updated tag ID can't be empty
400: Updated Tag ID doesn't exist on application pack ID.","dataMode":"raw","folder":"2-6","rawModeData":"\n\t\n\t\t1\n\t\tTag 1\n\t\n\t\n\t\t2\t\n\t\tTag 2\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","collectionId":"2","id":"2-6-43","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Create new Tag under an application pack ","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack
body: List of tags

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags
BODY<tags>
    <tag>
        <name>Tag 1</name>
    </tag>
    <tag>
        <name>Tag 2</name>
    </tag>
</tags>


Response Messages:
401: Access is denied
404: There is no application pack with the ID in customer with ID.
400: You cannot edit APPLICATION PACK because it was decommissioned.
400: Tag name must contain at least 2 and no more than 160 characters.
400: Tag with NAME already exists in application pack ID.","dataMode":"raw","folder":"2-6","rawModeData":"\n\t\n\t\tTag 1\n\t\n\t\n\t\tTag 2\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","collectionId":"2","id":"2-6-44","method":"POST"},{"name":"Delete tags from application pack","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"},{"value":null,"type":"text","enabled":true,"key":"tag_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
tag_id: IDs of tags to remove

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/21/tags?tag_id=1&tag_id=2

Response Messages:
200: Tags were deleted.
401: Access is denied
401: You do not have permissions to edit this application pack.
404: There are no application packs with the ID in customer with ID.
404: Application Package ID was not found.
404: Tag ID was not found in application pack ID.
404: Tag ID is in use so can't be deleted.
404: Removed tag ID can't be empty.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","collectionId":"2","id":"2-6-45","method":"DELETE"},{"headers":"Accept: application/json\n","name":"List all application pack tags","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags

Response Messages:
401: Access is denied
404: There is no application pack with the ID.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","collectionId":"2","id":"2-6-46","method":"GET"},{"name":"Delete application pack","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1

Response Messages:
200: Application pack wes deleted.
401: You do not have permissions to delete this application pack.
400: There is no application pack with the specified ID.
400: Customer with ID doesn't own an application pack with ID.
400: Application Pack ID cannot be deleted. It is in use by applications IDs.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}","collectionId":"2","id":"2-6-47","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Retrieve an existing application pack by ID","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to retrieve

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1

Response Messages:
401: Access is denied
401: You do not have permission to access application pack with ID
404: Application pack with ID was not found for customer with ID.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}","collectionId":"2","id":"2-6-48","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Update an application pack","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"}],"dataMode":"raw","description":"Update the application pack properties. If is_published is set to true, the application pack is published for use by other users.

Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
body: Application pack

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1
BODY<application_pack>
    <name>Updated name</name>
    <comment>Updated application pack</comment>
    <owner>
        <id>4</id>
    </owner>
    <editors>
        <editor>
            <id>3</id>
        </editor>
    </editors>
    <viewers>
        <viewer>
            <id>5</id>
        </viewer>
    </viewers>
    <is_published>true</is_published>
</application_pack>


Response Messages:
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to owner ID is invalid.
400: The owner NAME does not have permission to access applications.
400: There is an editor without an ID or name.
400: The application pack owner cannot also be an editor of the application pack.
400: There is a viewer without an ID or name.
400: The application pack owner cannot also be a viewer of the application pack.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application pack.
400: Application pack NAME already exists.
400: Application pack name must contain at least 2 and no more than 160 characters.
400: Customer NAME is not imported to SecureApp.
400: Customer NAME was decommissioned.
400: Application pack with ID is not ready for publish, or has no changes from the last publish.
401: Access is denied
401: You do not have permission to access application that contains the interface ID
401: You do not have permissions to edit this application pack.
401: You do not have permissions to change the owner of application pack ID.
401: You do not have permissions to change the editors and viewers of application pack ID.
404: There are no application packs with the NAME in customer with ID.","folder":"2-6","rawModeData":"\n\tUpdated name\n\tUpdated application pack\n\t\n\t\t4\n\t\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\n\t\n\t\t\n\t\t\t5\n\t\t\n\t\n\ttrue\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}","collectionId":"2","id":"2-6-49","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get tag by ID","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"},{"value":null,"type":"text","enabled":true,"key":"tag_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack
tag_id: The unique identifier of a tag

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags/1

Response Messages:
401: Access is denied
404: There is no tag with ID.
404: Customer with ID doesn't own a tag with ID.
404: Application Pack with ID doesn't own a tag with ID.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags/{{tag_id}}","collectionId":"2","id":"2-6-50","method":"GET"},{"headers":"Accept: application/json\n","name":"Retrieve a list of all connection to application pack by application ID.","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"}],"description":"Parameters:
application_id: The unique identifier of application
name: The name of the connection to application pack [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs?name=Connection to application pack 1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
404: There are no connection to application pack with the NAME in application with ID.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/","collectionId":"2","id":"2-6-51","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create new connection to application packs","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"}],"description":"Parameters:
application_id: The unique identifier of application
body: List of connection to application packs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs
BODY<connection_to_application_packs>
    <connection_to_application_pack>
        <name>Connection to application pack 1</name>
        <comment>New Connection to application pack</comment>
        <application_pack>
            <id>1</id>
        </application_pack>
        <tags_servers>
            <tag_servers>
                <tag>
                    <id>1</id>
                </tag>
                <servers>
                    <server>
                        <id>3</id>
                    </server>
                </servers>
            </tag_servers>
            <tag_servers>
                <tag>
                    <name>Tag 1</name>
                </tag>
                <servers>
                    <server>
                        <id>4</id>
                    </server>
                </servers>
            </tag_servers>
        </tags_servers>
    </connection_to_application_pack>
</connection_to_application_packs>


Response Messages:
400: There are no connection to application packs to add.
400: Application pack ID cannot be empty.
400: Application with ID was not found.
400: There is no application with the specified ID.
400: There is no application pack with the specified ID.
400: Application pack with ID was decommissioned.
400: Application pack with ID was not published.
400: Connection to application pack cannot be created in the domain of the application pack.
400: The application pack cannot be used more than once in the application.
400: Name cannot be empty.
400: Name must contain at least 2 and no more than 160 characters.
400: Name already exists.
400: Tag cannot be empty.
400: Tag ID or name is missing.
400: Tag ID does not exist.
400: Server ID does not exist.
400: Tag ID is not in use in connection to application pack ID, so it cannot be updated.
400: Servers cannot be null.
400: You cannot add ANY to connection to application pack.
400: You cannot add user to connection to application pack.
400: You cannot add Internet to connection to application pack.
401: Access is denied.
401: You do not have permission to access application that contains the server ID
401: You do not have permission to access application pack with ID
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Tag with NAME was not found.","dataMode":"raw","folder":"2-6","rawModeData":"\n\t\n\t\tConnection to application pack 1\n\t\tNew Connection to application pack\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t1\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t3\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\tTag 1\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t4\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/","collectionId":"2","id":"2-6-52","method":"POST"},{"headers":"Accept: application/json\n","name":"Retrieve existing access rules","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/87/access_requests

Response Messages:
400: The application was already deleted.
400: There are no changed connections that are ready for creating a ticket.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
400: Application with ID ID was not found.","dataMode":"params","folder":"2-7","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/access_requests","collectionId":"2","id":"2-7-53","method":"GET"},{"headers":"Accept: application/json\n","name":"Fetches server by ID","data":[{"value":null,"type":"text","enabled":true,"key":"serverId"}],"description":"Parameters:
serverId: The ID of the server

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects/87

Response Messages:
400: Server with id ID was not found.
400: Application with ID ID was not found.
400: The application was already deleted.
401: Access is denied
401: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.","dataMode":"params","folder":"2-8","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/network_objects/{{serverId}}","collectionId":"2","id":"2-8-54","method":"GET"},{"headers":"Accept: application/json\n","name":"Fetches servers","description":"Parameters:
name: The name of the servers [optional]
typeOnDevice: The typeOnDevice of the servers [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects?name=server1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects?typeOnDevice=edl_ip_list

Response Messages:
400: Server with name NAME was not found.
400: Parameter typeOnDevice is not valid.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There are no servers with the name NAME
404: There are no servers with the typeOnDevice TYPEONDEVICE ","folder":"2-8","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/network_objects","collectionId":"2","id":"2-8-55","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Create servers","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: List of servers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects
BODY<network_objects xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
     <network_object xsi:type=\"hostNetworkObjectDTO\">
         <comment>host comment</comment>
         <name>host1</name>
         <ip>1.1.1.1</ip>
     </network_object>
     <network_object xsi:type=\"rangeNetworkObjectDTO\">
         <comment>range comment</comment>
         <name>range1</name>
         <first_ip>2.2.2.2</first_ip>
         <last_ip>2.2.2.22</last_ip>
     </network_object>
     <network_object xsi:type=\"subnetNetworkObjectDTO\">
         <comment>subnet comment</comment>
         <name>subnet1</name>
         <ip>3.3.3.3</ip>
         <netmask>255.255.255.0</netmask>
     </network_object>
     <network_object xsi:type=\"networkObjectVirtualServerDTO\">
         <comment>virtual server comment</comment>
         <uid>{e1a7722f-e92e-48f2-9087-9cb1711eb8b9}</uid>
         <device_id>12</device_id>
     </network_object>
     <network_object xsi:type=\"networkObjectGroupDTO\">
         <comment>group comment</comment>
         <name>group1</name>
         <access_allowed>true</access_allowed>
         <member>
             <id>3</id>
         </member>
        <type_on_device>edl_ip_list</type_on_device>     </network_object>
</network_objects>


Response Messages:
400: There are no items to add.
400: The application was already deleted.
400: You cannot add to application NAME because it was decommissioned.
400: Network object was already saved
400: Name cannot be empty
400: Server with NAME already exists.
400: IP is missing
400: Mask is missing
400: Invalid IP
400: Invalid mask
400: Max IP is missing
400: Min IP is missing
400: Invalid min IP
400: Invalid max IP
400: Min IP cannot be larger than max IP
400: Invalid network object type CLASS_NAME.
400: Invalid uid
400: Invalid device ID
400: Virtual server does not exist in SecureTrack
400: The virtual server already exists in SecureApp as resource NAME: VIRTUAL SERVER NAME VIRTUAL SERVER DEVICE NAME.
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Internet cannot be a member of a group.
400: Cannot save the server because the virtual server does not exist.
400: Cannot save the server because an error occurred
400: The type_on_device value is not valid
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID.
404: Virtual server was not found in SecureTrack.
503: Not connected to SecureTrack.","dataMode":"raw","folder":"2-9","rawModeData":"\n\t \n\t\t host comment\n\t\t host1\n\t\t 1.1.1.1\n\t \n\t \n\t\t range comment\n\t\t range1\n\t\t 2.2.2.2\n \t\t 2.2.2.22\n\t \n\t \n\t\t subnet comment\n\t\t subnet1\n\t\t 3.3.3.3\n\t\t 255.255.255.0\n\t \n\t \n\t\t virtual server comment\n\t\t {e1a7722f-e92e-48f2-9087-9cb1711eb8b9}\n\t\t 12\n\t \n\t \n\t\t group comment\n\t\t group1\n\t\t true\n\t\t \n\t\t\t 3\n\t\t \n\t\tedl_ip_list\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects","collectionId":"2","id":"2-9-56","method":"POST"},{"headers":"Accept: application/json\n","name":"Retrieve existing servers","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the server [optional]
typeOnDevice: The typeOnDevice of the servers [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects?name=ServerName

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects?typeOnDevice=edl_ip_list

Response Messages:
400: The application was already deleted.
400: Parameter typeOnDevice is not valid.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: There are no servers with the name NAME.
404: There are no servers with the typeOnDevice TYPEONDEVICE ","dataMode":"params","folder":"2-9","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects","collectionId":"2","id":"2-9-57","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Update servers","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: List of servers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects
BODY<network_objects xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
     <network_object xsi:type=\"hostNetworkObjectDTO\">
         <id>1</id>
         <comment>host comment</comment>
         <name>host1</name>
         <ip>1.1.1.1</ip>
         <type>host</type>
     </network_object>
     <network_object xsi:type=\"rangeNetworkObjectDTO\">
         <id>2</id>
         <comment>range comment</comment>
         <name>range1</name>
         <first_ip>2.2.2.2</first_ip>
         <last_ip>2.2.2.22</last_ip>
         <type>range</type>
     </network_object>
     <network_object xsi:type=\"subnetNetworkObjectDTO\">
         <id>3</id>
         <comment>subnet comment</comment>
         <name>subnet1</name>
         <ip>3.3.3.3</ip>
         <netmask>255.255.255.0</netmask>
         <type>subnet</type>
     </network_object>
     <network_object xsi:type=\"networkObjectVirtualServerDTO\">
         <id>4</id>
         <comment>virtual server comment</comment>
         <uid>{e1a7722f-e92e-48f2-9087-9cb1711eb8b9}</uid>
         <device_id>12</device_id>
         <type>virtual-server</type>
     </network_object>
     <network_object xsi:type=\"vmInstanceDTO\">
         <id>5</id>
         <name>vm1</name>
         <comment>vm instance comment</comment>
         <type>vm_instance</type>
     </network_object>
     <network_object xsi:type=\"networkObjectGroupDTO\">
         <id>6</id>
         <comment>group comment</comment>
         <name>group1</name>
         <access_allowed>true</access_allowed>
         <type>group</type>
         <member>
             <id>3</id>
         </member>
        <type_on_device>edl_ip_list</type_on_device>     </network_object>
</network_objects>


Response Messages:
400: The application was already deleted.
400: You cannot update a predefined object.
400: Invalid type in server with id ID.
400: Invalid member with id ID
400: Invalid ID
400: Invalid uid
400: Invalid network object type NAME
400: Cannot update user
400: Network object is new
400: Name cannot be empty
400: Server is in discovery
400: Ip is missing
400: Mask is missing
400: Invalid ip
400: Invalid mask
400: Max ip is missing
400: Min ip is missing
400: Invalid min ip
400: Invalid max ip
400: Min ip cannot be larger than max ip
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Internet cannot be a member of a group.
400: Server with NAME already exists.
400: Invalid device ID
400: The type_on_device value is not valid
400: An EDL group can not be modified to a regular group
400: The virtual server already exists in SecureApp as resource NAME: VIRTUAL SERVER NAME VIRTUAL SERVER DEVICE NAME.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: DTO type used for server id ID is incompatible with this vendor.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Virtual server was not found in ST.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID.
503: Not connected to SecureTrack.","dataMode":"raw","folder":"2-9","rawModeData":"\n\t \n\t\t 1\n\t\t host comment\n\t\t host1\n\t\t 1.1.1.1\n\t\t host\n\t \n\t \n\t\t 2\n\t\t range comment\n\t\t range1\n\t\t 2.2.2.2\n\t\t 2.2.2.22\n\t\t range\n\t \n\t \n\t\t 3\n\t\t subnet comment\n\t\t subnet1\n\t\t 3.3.3.3\n\t\t 255.255.255.0\n\t\t subnet\n\t \n\t \n\t\t 4\n\t\t virtual server comment\n\t\t {e1a7722f-e92e-48f2-9087-9cb1711eb8b9}\n\t\t 12\n\t\t virtual-server\n\t \n\t \n\t\t 5\n\t\t vm1\n\t\t vm instance comment\n\t\t vm_instance\n\t \n\t \n\t\t 6\n\t\t group comment\n\t\t group1\n\t\t true\n\t\t group\n\t\t \n\t\t\t 3\n\t\t \n\t\tedl_ip_list\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects","collectionId":"2","id":"2-9-58","method":"PUT"},{"name":"Delete server","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"serverId"}],"dataMode":"params","description":"To decommission a serer use force=true.

Parameters:
applicationId: The unique identifier of the application
serverId: The unique identifier of the server
force: Force delete [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/4

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/4?force=true

Response Messages:
400: The application was already deleted.
400: You cannot delete a predefined object.
400: Cannot delete an object that is being referenced by other objects
400: Cannot delete a predefined object.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID.","folder":"2-9","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}","collectionId":"2","id":"2-9-59","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Retrieve an existing server by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"serverId"}],"description":"Parameters:
applicationId: The unique identifier of the application
serverId: The unique identifier of the server

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/3

Response Messages:
400: The application was already deleted.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID.","dataMode":"params","folder":"2-9","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}","collectionId":"2","id":"2-9-60","method":"GET"},{"collectionId":"2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}/impact_analysis_csv","name":"Export Server Impact Analysis to a CSV file.","method":"GET","id":"2-9-61","description":"Parameters:
applicationId [optional]
serverId [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/6/impact_analysis_csv

Response Messages:
400: Server with ID was not found.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
404: There is no application with the specified ID.","folder":"2-9"},{"name":"Move server","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"},{"value":null,"type":"text","enabled":true,"key":"server_id"},{"value":null,"type":"text","enabled":true,"key":"target_application_id"}],"description":"Parameters:
application_id: The unique identifier of the application
server_id: The unique identifier of the server
target_application_id: The unique identifier of the target application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/move_server?server_id=5&target_application_id=3

Response Messages:
400: Server ID is missing.
400: Target application ID is missing.
400: You cannot move a predefined object.
400: Server with ID is already associated to application with ID.
400: Cannot move server to a different customer.
400: The application was already deleted.
400: You cannot add to application APPLICATION_NAME because it was decommissioned.
400: Group/Server cannot be moved because there is no other application to move it to.
400: Group/Server cannot be moved because it or at least one of its group members is part of these groups: GROUPS_NAME.
400: Group/Server cannot be moved because it or at least one of its group members is locked for discovery.
400: Group/Server cannot be moved because it or at least one of its group members is used in these application interfaces: APPLICATION_INTERFACE_NAME.
400: Group/Server cannot be moved because it or at least one of its group members is used in these connections with another external resource: CONNECTION_NAME
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","dataMode":"params","folder":"2-9","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/move_server","collectionId":"2","id":"2-9-62","method":"POST"},{"headers":"Accept: application/json\n","name":"If the identified server is a group, return a list of its members. When the media type is 'text/plain' (default), print each member on a separate line.","description":"Parameters:
applicationId [optional]
serverId [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/6/members

Response Messages:
400: Server with ID is not of type group
401: Access is denied
401: You do not have permissions to view this application
403: No available licenses. Ask your SecureApp administrator for assistance
404: There is no application with the specified ID
404: Server with ID was not found","folder":"2-9","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}/members","collectionId":"2","id":"2-9-63","method":"GET"},{"headers":"Accept: application/json\n","name":"Fetches service by ID","data":[{"value":null,"type":"text","enabled":true,"key":"serviceId"}],"description":"Parameters:
serviceId: The ID of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services/2

Response Messages:
404: Service with ID <ID> was not found.
401: Access is denied.","dataMode":"params","folder":"2-10","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services/{{serviceId}}","collectionId":"2","id":"2-10-64","method":"GET"},{"name":"Delete unused and non predefined global service","data":[{"value":null,"type":"text","enabled":true,"key":"serviceId"}],"description":"Parameters:
serviceId: The ID of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services/260

Response Messages:
200: Service was deleted.
404: Global Service with ID was not found.
400: Cannot delete an object that is being referenced by other objects.
400: You cannot delete a predefined object.
401: Access is denied.","dataMode":"params","folder":"2-10","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services/{{serviceId}}","collectionId":"2","id":"2-10-65","method":"DELETE"},{"headers":"Content-Type: application/xml\n","name":"Modify unused and non predefined global services","dataMode":"raw","description":"Parameters:
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>250</id>
        <name>icmp service updated</name>
        <comment>Updated comment</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>251</id>
        <name>ip service updated</name>
        <comment>Updated comment</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>252</id>
        <name>tcp service updated</name>
        <comment>Updated comment</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>253</id>
        <name>udp service updated</name>
        <comment>Updated comment</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <id>254</id>
        <name>Service Group 1 updated</name>
        <comment>Updated comment</comment>
        <type>group</type>
        <member>
            <id>3</id>
        </member>
        <member>
            <id>4</id>
        </member>
    </service>
</services>


Response Messages:
200: Services were modified.
400: Members IDs cannot be empty.
404: Service with ID <ID> was not found.
400: Service type must be either SingleServiceDTO or ServiceMemberDTO.
400: Service is new.
400: You cannot update a predefined object.
400: Name <NAME> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: Invalid protocol
400: Global Service cannot be associated with an application.
400: Cannot update a global service that is being referenced by other objects.
400: Cannot update an empty global group.
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Cannot have a local member in global group.
400: Group cannot contain itself as a member.
400: Application identity cannot be a member of a group.
401: Access is denied.","folder":"2-10","rawModeData":"\n\t\n\t\t250\n\t\ticmp service updated\n\t\tUpdated comment\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\t251\n\t\tip service updated\n\t\tUpdated comment\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\t252\n\t\ttcp service updated\n\t\tUpdated comment\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t253\n\t\tudp service updated\n\t\tUpdated comment\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t254\n\t\tService Group 1 updated\n\t\tUpdated comment\n\t\tgroup\n\t\t\n\t\t\t3\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services/","collectionId":"2","id":"2-10-66","method":"PUT"},{"headers":"Accept: application/json\n","name":"Fetches services","description":"Parameters:
globals_only: get only globals [optional]
name: The name of the service [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?name=AH

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?globals_only=true

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?globals_only=true&name=AH

Response Messages:
404: There are no services with the name NAME.
401: Access is denied.","folder":"2-10","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services","collectionId":"2","id":"2-10-67","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create global services","dataMode":"raw","description":"Parameters:
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>icmp service</name>
        <comment>New service</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>ip service</name>
        <comment>IPSEC Authentication Header Protocol</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>tcp service</name>
        <comment>Discard Server Protocol (TCP)</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>udp service</name>
        <comment>Discard Server Protocol (UDP)</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <name>Service Group 1</name>
        <comment>New Service group</comment>
        <type>group</type>
        <member>
            <id>1</id>
        </member>
        <member>
            <id>2</id>
        </member>
    </service>
</services>


Response Messages:
201: Service was created.
200: Services were created.
400: There are no items to add.
400: Members IDs cannot be empty.
404: Service with ID <ID> was not found.
400: Invalid service type <TYPE>
400: Name <NAME> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: Global Service cannot be associated with an application.
400: Cannot create an empty global group.
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Cannot have a local member in global group.
400: Application identity cannot be a member of a group.
401: Access is denied.","folder":"2-10","rawModeData":"\n\t\n\t\ticmp service\n\t\tNew service\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\tip service\n\t\tIPSEC Authentication Header Protocol\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\ttcp service\n\t\tDiscard Server Protocol (TCP)\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tudp service\n\t\tDiscard Server Protocol (UDP)\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tService Group 1\n\t\tNew Service group\n\t\tgroup\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t2\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services","collectionId":"2","id":"2-10-68","method":"POST"},{"name":"Delete unused and non predefined global service by name","data":[{"value":null,"type":"text","enabled":true,"key":"name"}],"description":"Parameters:
name: The name of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?name=Global service

Response Messages:
200: Service was deleted.
404: Service name has not been provided.
404: There are no services with the name NAME.
400: Cannot delete ANY.
400: Cannot delete an object that is being referenced by other objects.
400: Cannot delete a predefined object.
401: Access is denied.","dataMode":"params","folder":"2-10","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services","collectionId":"2","id":"2-10-69","method":"DELETE"},{"name":"Delete service","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"serviceId"}],"dataMode":"params","description":"Use force=true to delete a service with decommission.

Parameters:
applicationId: The unique identifier of the application
serviceId: The unique identifier of the service
force: Force delete [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services/250

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services/250?force=true

Response Messages:
400: The application was already deleted.
400: Cannot delete an object that is being referenced by other objects.
400: Cannot delete a predefined object.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Service with ID <SERVICE_ID> was not found in application with id <APPLICATION_ID>","folder":"2-11","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services/{{serviceId}}","collectionId":"2","id":"2-11-70","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Retrieve an existing service by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"serviceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
serviceId: The unique identifier of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services/250

Response Messages:
400: The application was already deleted.
401: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: Service with ID was not found.","dataMode":"params","folder":"2-11","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services/{{serviceId}}","collectionId":"2","id":"2-11-71","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Create services","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>icmp service</name>
        <comment>New service</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>ip service</name>
        <comment>IPSEC Authentication Header Protocol</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>tcp service</name>
        <comment>Discard Server Protocol (TCP)</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>udp service</name>
        <comment>Discard Server Protocol (UDP)</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <name>Service Group 1</name>
        <comment>New Service group</comment>
        <type>group</type>
        <member>
            <id>1</id>
        </member>
        <member>
            <id>2</id>
        </member>
    </service>
</services>


Response Messages:
201: Service was created.
200: Services were created.
400: There are no items to add.
400: Members IDs cannot be empty.
400: Invalid service type <TYPE>
400: Name <NAME> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: Cannot create an empty global group.
400: The group contains duplicate members.
400: ANY cannot be a member of a group.
400: Cannot have members from different applications.
400: Can not have application identity in group
401: Access is denied
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Service with ID <ID> was not found.
404: There is no application with the specified ID.","dataMode":"raw","folder":"2-11","rawModeData":"\n\t\n\t\ticmp service\n\t\tNew service\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\tip service\n\t\tIPSEC Authentication Header Protocol\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\ttcp service\n\t\tDiscard Server Protocol (TCP)\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tudp service\n\t\tDiscard Server Protocol (UDP)\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tService Group 1\n\t\tNew Service group\n\t\tgroup\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t2\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services","collectionId":"2","id":"2-11-72","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Update services","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>250</id>
        <name>icmp service updated</name>
        <comment>Updated comment</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>251</id>
        <name>ip service updated</name>
        <comment>Updated comment</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>252</id>
        <name>tcp service updated</name>
        <comment>Updated comment</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>253</id>
        <name>udp service updated</name>
        <comment>Updated comment</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <id>254</id>
        <name>Service Group 1 updated</name>
        <comment>Updated comment</comment>
        <type>group</type>
        <member>
            <id>3</id>
        </member>
        <member>
            <id>4</id>
        </member>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <id>255</id>
        <name>Service Group 2 updated</name>
        <comment>Updated comment</comment>
        <type>group</type>
    </service>
</services>


Response Messages:
200: Services were modified.
400: Members IDs cannot be empty.
400: Service type must be either SingleServiceDTO or ServiceMemberDTO.
400: Local service must be associated with an application.
400: Service is locked for discovery.
400: Service is new.
400: Name <NAME> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: The group contains duplicate members.
400: ANY cannot be a member of a group.
400: Application identity cannot be a member of a group.
401: Access is denied
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Service with ID <ID> was not found.","dataMode":"raw","folder":"2-11","rawModeData":"\n\t\n\t\t250\n\t\ticmp service updated\n\t\tUpdated comment\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\t251\n\t\tip service updated\n\t\tUpdated comment\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\t252\n\t\ttcp service updated\n\t\tUpdated comment\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t253\n\t\tudp service updated\n\t\tUpdated comment\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t254\n\t\tService Group 1 updated\n\t\tUpdated comment\n\t\tgroup\n\t\t\n\t\t\t3\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n\t\n\t\t255\n\t\tService Group 2 updated\n\t\tUpdated comment\n\t\tgroup\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services","collectionId":"2","id":"2-11-73","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve existing services","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the service [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services?name=Local service

Response Messages:
400: The application was already deleted.
401: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: There are no services with the name NAME.","dataMode":"params","folder":"2-11","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services","collectionId":"2","id":"2-11-74","method":"GET"},{"name":"Delete unused user","data":[{"value":null,"type":"text","enabled":true,"key":"userId"}],"description":"Parameters:
userId: The ID of the user

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users/10

Response Messages:
200: User was deleted.
404: User with ID <ID> was not found.
400: Cannot delete an object that is being referenced by other objects.
401: Access is denied.","dataMode":"params","folder":"2-12","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users/{{userId}}","collectionId":"2","id":"2-12-75","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Fetches user by ID","data":[{"value":null,"type":"text","enabled":true,"key":"userId"}],"description":"Parameters:
userId: The ID of the user

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users/10

Response Messages:
404: User with ID <ID> was not found.
401: Access is denied.","dataMode":"params","folder":"2-12","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users/{{userId}}","collectionId":"2","id":"2-12-76","method":"GET"},{"headers":"Accept: application/json\n","name":"Fetches users","description":"Parameters:
name: The name of the user [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users?name=Local user 1

Response Messages:
404: There are no users with the name NAME.
401: Access is denied.","folder":"2-12","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users","collectionId":"2","id":"2-12-77","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create users","dataMode":"raw","description":"Parameters:
body: List of users

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/users
BODY<users>
    <user>
        <name>Local user 1</name>
        <comment>New local user</comment>
        <ip>8.8.8.8</ip>
    </user>
    <user>
        <name>Ldap user 1</name>
        <comment>New ldap user</comment>
    </user>
    <user xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"userObjectGroupDTO\">
        <name>User group 1</name>
        <comment>New user group</comment>
        <member>
            <id>14</id>
        </member>
        <member>
            <id>15</id>
        </member>
    </user>
</users>


Response Messages:
201: User was created.
200: Users were created.
400: There are no items to add.
400: Members IDs cannot be empty.
404: User with id <ID> was not found.
400: Invalid user type <TYPE>
400: Name cannot be empty.
400: User with name <NAME> already exists.
400: Invalid ip
401: Access is denied.","folder":"2-12","rawModeData":"\n\t\n\t\tLocal user 1\n\t\tNew local user\n\t\t8.8.8.8\n\t\n\t\n\t\tLdap user 1\n\t\tNew ldap user\n\t\n\t\n\t\tUser group 1\n\t\tNew user group\n\t\t\n\t\t\t14\n\t\t\n\t\t\n\t\t\t15\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users","collectionId":"2","id":"2-12-78","method":"POST"},{"name":"Delete an application","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application to delete

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1

Response Messages:
400: The application was already deleted.
400: The resources of application NAME are used in connections for other applications.
400: You cannot delete application NAME because its application interfaces are used in other applications.
400: You cannot delete application NAME because its application interfaces are used in other application packs.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
400: Application with ID ID was not found.
400: You cannot delete application NAME because there are connection changes pending a ticket in other application.","dataMode":"params","folder":"2-13","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}","collectionId":"2","id":"2-13-79","method":"DELETE"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Change an application","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"dataMode":"raw","description":"This API can be used to delete or decommission an application.
To decommission an application, send true in decommissioned tag.

Parameters:
applicationId: The unique identifier of an application to change
body: Application

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/139
BODY<application>
     <id>139</id>
     <name>UpdatedAppName</name>
     <comment>UpdatedComment</comment>
     <decommissioned>false</decommissioned>
     <owner>
         <id>4</id>
     </owner>
     <editors>
         <editor>
             <id>3</id>
         </editor>
     </editors>
     <viewers>
         <viewer>
             <id>5</id>
         </viewer>
     </viewers>
</application>


Response Messages:
400: The application was already deleted.
400: Application owner is missing.
400: Owner cannot be empty.
400: Reference to owner ID is invalid.
400: There is an editor without an ID or name.
400: The application owner cannot also be an editor of the application.
400: There is a viewer without an ID or name.
400: The application owner cannot also be a viewer of the application.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application.
401: Access is denied
401: You do not have permissions to change the owner of application ID.
401: You do not have permissions to change the editors and a viewer of application ID.
401: You do not have permissions to decommission this application.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","folder":"2-13","rawModeData":"\n\t 139\n\t UpdatedAppName\n\t UpdatedComment\n\t false\n\t \n\t\t 4\n\t \n\t \n\t\t \n\t\t\t 3\n\t\t \n\t \n\t \n\t\t \n\t\t\t 5\n\t\t \n\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}","collectionId":"2","id":"2-13-80","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve an existing application by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of an application to retrieve

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1

Response Messages:
400: The application was already deleted.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: Access is denied
401: You do not have permission to access application with ID
404: There is no application with the specified ID.","dataMode":"params","folder":"2-13","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}","collectionId":"2","id":"2-13-81","method":"GET"},{"name":"Export application history to PDF","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"}],"description":"Parameters:
application_id: The unique identifier of the application
start_date: States starting date to fetch history since. Date format expected: yyyy-mm-dd [optional]
end_date: Get history until this date. Date format expected: yyyy-mm-dd [optional]
count: History max rows [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?start_date=2015-07-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?start_date=2015-07-18&end_date=2015-12-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?start_date=2015-07-18&count=2

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?count=2

Response Messages:
401: Access is denied.
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
400: The date format must be: yyyy-mm-dd
400: Start date must be before End date","dataMode":"params","folder":"2-13","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/history/export_pdf","collectionId":"2","id":"2-13-82","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Update applications","dataMode":"raw","description":"This API can be used to delete or decommission an application.
To decommission an application, send true in decommissioned tag.

Parameters:
body: List of applications

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications
BODY<applications>
     <application>
         <id>140</id>
         <name>App1</name>
         <decommissioned>true</decommissioned>
         <owner>
             <id>4</id>
         </owner>
     </application>
     <application>
         <id>139</id>
         <name>UpdatedAppName</name>
         <comment>Updated Comment</comment>
         <owner>
             <id>4</id>
         </owner>
         <editors>
             <editor>
                 <id>3</id>
             </editor>
         </editors>
         <viewers>
             <viewer>
                 <id>5</id>
             </viewer>
         </viewers>
     </application>
</applications>


Response Messages:
400: Application ID is missing.
400: Application ID is invalid
400: The application was already deleted.
400: You must include the owner field.
400: There is an editor without an ID or name.
400: The application owner cannot also be an editor of the application.
400: There is a viewer without an ID or name.
400: The application owner cannot also be a viewer of the application.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application.
401: Access is denied
401: You do not have permissions to change the owner of application ID.
401: You do not have permissions to change the editors and a viewer of application ID.
401: You do not have permissions to decommission this application.
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.","folder":"2-13","rawModeData":"\n\t \n\t\t 140\n\t\t App1\n\t\t true\n\t\t \n\t\t\t 4\n\t\t \n\t \n\t \n\t\t 139\n\t\t UpdatedAppName\n\t\t Updated Comment\n\t\t \n\t\t\t 4\n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 3\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 5\n\t\t\t \n\t\t \n\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/","collectionId":"2","id":"2-13-83","method":"PUT"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Create new applications","dataMode":"raw","description":"Parameters:
body: List all applications

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications
BODY<applications>
     <application>
         <name>AppName</name>
         <comment>Comment</comment>
         <owner>
             <id>3</id>
         </owner>
         <editors>
             <editor>
                 <id>4</id>
             </editor>
         </editors>
         <viewers>
             <viewer>
                 <id>5</id>
             </viewer>
         </viewers>
         <customer>
             <id>24</id>
         </customer>
     </application>
</applications>


Response Messages:
400: There are no items to add.
400: Application was already saved.
400: Application name must contain at least 2 and no more than 160 characters.
400: Owner cannot be empty.
400: The specified owner does not exist.
400: The owner NAME does not have permission to access applications.
400: There is an editor without an ID or name.
400: The application owner cannot also be an editor of the application.
400: There is a viewer without an ID or name.
400: The application owner cannot also be a viewer of the application.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application.
400: Application with NAME already exists.
400: Application owner is missing.
400: Reference to owner ID is invalid.
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to customer ID is invalid.
400: You must specify the name or ID of the customer.
400: The customer has no ID or name.
400: The specified customer does not exist.
400: There is an editor without an ID or name.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no editor with the name NAME.","folder":"2-13","rawModeData":"\n\t \n\t\t AppName\n\t\t Comment\n\t\t \n\t\t\t 3\n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 4\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 5\n\t\t\t \n\t\t \n\t\t \n\t\t\t 24\n\t\t \n\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/","collectionId":"2","id":"2-13-84","method":"POST"},{"headers":"Accept: application/json\n","name":"List all applications","description":"Parameters:
userId: Applications by user ID, if not given the default is logged in user id [optional]
name: The name of the application [optional]
app_permissions: Filter applications by the given permissions (separated with commas):\napp_owner - returns applications where the user is the owner\napp_editor - returns applications where the user has been explicitly added as an editor\napp_viewer - returns applications where the user has been explicitly added as a viewer\napp_adminonly - returns applications where the user only has editor access because user has “edit all applications” permission, and does not include applications where this user is either the app_owner, app_editor, or app_viewer [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?name=App

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?userId=1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?app_permissions=app_owner,app_editor,app_viewer

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?name=App&app_permissions=app_adminonly

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications

Response Messages:
400: Invalid app_permissions value: 'appPermissions'.
401: Access is denied
401: You can't use the parameter 'userId' because you don't have 'View all applications' permission.
404: There are no applications matching your filter.
404: User with ID 'userId' was not found.","folder":"2-13","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/","collectionId":"2","id":"2-13-85","method":"GET"},{"name":"Export Impact Analysis to a CSV file.","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"}],"dataMode":"params","description":"To prevent a CSV injection attack when exporting Impact Analysis to a CSV file, if a special character ( = - + @ ) appears at the beginning of any field, a single quote (') is added before the character.

Parameters:
application_id: The unique identifier of the application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/impact_analysis_csv

Response Messages:
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
404: There is no application with the specified ID.","folder":"2-13","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/impact_analysis_csv","collectionId":"2","id":"2-13-86","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Move applications to another customer","dataMode":"raw","description":"Parameters:
body: List of applications and customers [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/move_applications
BODY<move_applications>
     <move_application>
         <application>
            <id>1</id>
         </application>
         <customer>
             <id>2</id>
         </customer>
     </move_application>
     <move_application>
         <application>
            <id>2</id>
         </application>
         <customer>
            <name>Default</name>
         </customer>
     </move_application>
</move_applications>


Response Messages:
200: Applications were moved successfully.
400: Multi-Customer mode is not enabled.
400: You cannot move an application pack to a different customer.
400: Reference to application is invalid.
400: APPLICATION already exists in CUSTOMER.
400: You must specify the name or ID of the customer.
400: The customer has no ID or name.
400: Reference to CUSTOMER is invalid.
400: CUSTOMER is not imported to SecureApp.
400: CUSTOMER was decommissioned.
400: You must delete virtual servers from CUSTOMER before you move APPLICATION to another customer.
400: You must remove virtual servers from the INTERFACE and publish it before you move APPLICATION to another customer.
400: You cannot move APPLICATION to CUSTOMER because the connection to application pack and the application pack cannot be in the same customer.
400: You cannot move APPLICATION to a different customer because the application interface and the application pack must be in the same customer.
400: You must remove INTERFACE from APPLICATION PACK and publish it before you can move APPLICATION to another customer.
400: CONNECTION TO APPLICATION from APPLICATION must use interface from CUSTOMER.
400: Sources in CONNECTION from APPLICATION must all be from applications in the same customer.
400: Destinations in CONNECTION in APPLICATION must all be from applications in the same customer.
400: Servers in CONNECTION from APPLICATION must all be from CUSTOMER.
400: Servers in CONNECTION TO APPLICATION from APPLICATION must be from applications in the same customer.
400: Servers in CONNECTION TO APPLICATION from APPLICATION must be from CUSTOMER.
400: Application or application pack with NAME already exists in CUSTOMER.
400: There are no applications to move.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","folder":"2-13","rawModeData":"\n\t \n\t\t \n\t\t\t1\n\t\t \n\t\t \n\t\t\t 2\n\t\t \n\t \n\t \n\t\t \n\t\t\t2\n\t\t \n\t\t \n\t\t\tDefault\n\t\t \n\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/move_applications","collectionId":"2","id":"2-13-87","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve security policy violations from SecureTrack","description":"Parameters:
applicationId [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/compliance_violations

Response Messages:
400: No valid connections found in APPLICATION.
400: Security policy compliance check is not available because a security policy has not been defined.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
503: Cannot connect to SecureTrack.
503: Timeout occurred while waiting for response from SecureTrack.
500: An error occurred in SecureTrack when running the security compliance check.","folder":"2-13","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/compliance_violations","collectionId":"2","id":"2-13-88","method":"GET"},{"headers":"Accept: application/json\n","name":"Retrieve application history","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
start_date: States starting date to fetch history since. Date format expected: yyyy-mm-dd [optional]
end_date: Get history until this date. Date format expected: yyyy-mm-dd [optional]
count: History list length [optional]
start: Offset the count starting point [optional]
type: States the history type to fetch [optional]
user: The username of the user made the changes [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start_date=2015-07-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start_date=2015-07-18&end_date=2015-12-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start_date=2015-07-18&count=1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start=0&count=1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?type=SERVER

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?user=Jack

Response Messages:
400: The date format must be: yyyy-mm-dd
400: Start date must be before End date
400: Count parameter must be a number
400: Start parameter must be a number
400: Start parameter must be less than total
400: Type parameter must be either server, server_group, connection, application, application_interface, connection_interface or connection_to_application
400: User not found
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.","dataMode":"params","folder":"2-13","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/history","collectionId":"2","id":"2-13-89","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Associate cloud servers from SecureTrack with an application","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"}],"description":"Parameters:
application_id: The ID of the application
body: List of device IDs and cloud server UIDs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers?application_id=87
BODY<devices_to_uids>
    <device_to_uids>
        <device_id>9</device_id>
        <uids>
            <uid>{b503916e-4468-4dc8-981b-2ec534587352}</uid>
            <uid>{0cc947a5-276f-4a4a-9d12-df5284fce609}</uid>
        </uids>
    </device_to_uids>
</devices_to_uids>


Response Messages:
201: Servers were imported to SecureApp.
401: Access is denied
400: There is no application with the specified ID.
401: No available licenses. Ask your SecureApp administrator for assistance.
400: You do not have permissions to edit this application.
400: You cannot associate servers with this application, because the application has been decommissioned.
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to add cloud servers.
403: UID does not exist in device ID.
403: Device with ID does not exist.
403: Device with ID does not exist in DOMAIN.
403: The AWS instance with UID and device ID has already been imported to application NAME. You cannot import the same instance multiple times.","dataMode":"raw","folder":"2-14","rawModeData":"\n\t\n\t\t9\n\t\t\n\t\t\t{b503916e-4468-4dc8-981b-2ec534587352}\n\t\t\t{0cc947a5-276f-4a4a-9d12-df5284fce609}\n\t\t\n\t\n\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/cloud_console/servers/","collectionId":"2","id":"2-14-90","method":"POST"},{"headers":"Accept: application/json\n","name":"Retrieve cloud server listing from SecureTrack","data":[{"value":null,"type":"text","enabled":true,"key":"vendor"},{"value":null,"type":"text","enabled":true,"key":"search_string"}],"description":"Parameters:
customer_id: Customer ID to be filtered by. [optional]
vendor: Vendor to be filtered by.
search_string: Search text.
start: Returning matching result starting from this element in the array (0-based). [optional]
count: Total number of matching servers to return. [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers?vendor=Amazon&search_string=WebServe

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers?vendor=Amazon&search_string=\"WebServer1\"

Response Messages:
401: Access is denied
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to search for cloud servers.
400: Illegal search string.
400: Start is bigger then possible result count.
400: Start and count cannot hold negative values.
400: Vendor query param is required.
400: Vendor should be one of the following: Amazon.
400: Search string query param is required.
400: Customer with ID does not exist in SecureApp
400: Customer with ID was decommissioned.","dataMode":"params","folder":"2-14","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/cloud_console/servers/","collectionId":"2","id":"2-14-91","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Auto associate cloud servers from SecureTrack with an application","dataMode":"raw","description":"When auto-associate is enabled, user must enter key value

Parameters:
body: Auto association rule

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers/auto_association_rule
BODY<auto_association_rule>
    <key>Application</key>
    <enabled>true</enabled>
</auto_association_rule>


Response Messages:
200: Auto association rule is saved.
400: Enabled rule requires key value.
401: Access is denied
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to search for cloud servers.","folder":"2-14","rawModeData":"\n\tApplication\n\ttrue\n\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/cloud_console/servers/auto_association_rule","collectionId":"2","id":"2-14-92","method":"PUT"},{"headers":"Accept: application/json\n","name":"Fetches customer by ID","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"}],"description":"Parameters:
customer_id: The ID of the customer

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/1

Response Messages:
400: Not available in single-customer mode.
400: Customer with id ID was not found.","dataMode":"params","folder":"2-15","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/{{customer_id}}","collectionId":"2","id":"2-15-93","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Update a customer","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"}],"description":"Parameters:
customer_id: The ID of the customer
body: Customers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/customers/2
BODY<customer>
    <usage_mode>NOT_IMPORTED</usage_mode>
</customer>


Response Messages:
400: Not available in single-customer mode.
400: Customer with id ID was not found.
400: Can not update Default customer.
400: This customer is already not imported.
400: USAGE_MODE is not a valid state. The valid values are: USAGE_MODES
401: Access is denied
500: This customer is not imported.
400: You cannot delete this customer because there are connection changes pending a ticket in another customer.You must decommission this customer first, and then delete it.","dataMode":"raw","folder":"2-15","rawModeData":"\n\tNOT_IMPORTED\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/{{customer_id}}","collectionId":"2","id":"2-15-94","method":"PUT"},{"headers":"Accept: application/json\n","name":"List all customers","description":"Parameters:
name: The name of the customer [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers?name=Customer 1

Response Messages:
400: Not available in single-customer mode.
404: There are no customers with the name NAME.","folder":"2-15","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/","collectionId":"2","id":"2-15-95","method":"GET"},{"headers":"Accept: application/json\n","name":"Retrieve existing applications for specific domain","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"}],"description":"Parameters:
customer_id: The ID of the customer

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/2/applications

Response Messages:
400: Not available in single-customer mode.
400: Customer with id ID was not found.
401: Access is denied","dataMode":"params","folder":"2-15","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/{{customer_id}}/applications","collectionId":"2","id":"2-15-96","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"import customers","dataMode":"raw","description":"Only users with 'Create new applications' and 'View all applications' permissions can run this API.

Parameters:
body: Customers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/customers/import
BODY<customers>
    <customer>
        <id>2</id>
    </customer>
    <customer>
        <id>3</id>
    </customer>
</customers>


Response Messages:
400: Not available in single-customer mode.
400: ID can not be empty.
400: There are some id's that doesn't exist.
401: Access is denied
503: Not connected to SecureTrack.","folder":"2-15","rawModeData":"\n\t\n\t\t2\n\t\n\t\n\t\t3\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/import","collectionId":"2","id":"2-15-97","method":"PUT"},{"headers":"Accept: application/json\n","name":"List all non-imported customers","description":"Only users with 'Create new applications' and 'View all applications' permissions can run this API.



Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/not_imported

Response Messages:
400: Not available in single-customer mode.
401: Access is denied
503: Not connected to SecureTrack.","folder":"2-15","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/not_imported","collectionId":"2","id":"2-15-98","method":"GET"},{"headers":"Accept: application/json\n","name":"List all imported customers","description":"

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/imported

Response Messages:
400: Not available in single-customer mode.
401: Access is denied","folder":"2-15","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/imported","collectionId":"2","id":"2-15-99","method":"GET"},{"headers":"Accept: application/json\n","name":"List all domains","description":"Parameters:
name: The name of the domain [optional]

Usage Example


Response Messages:
404: There are no domains with the name NAME.","folder":"2-16","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/domains/","collectionId":"2","id":"2-16-100","method":"GET"},{"collectionId":"2","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/domains/synchronize","name":"synchronize domains","method":"PUT","id":"2-16-101","description":"Retrieves all the domains lists in ST , for use by SC. If a domain was deleted in ST, then it will be removed from SC



Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/domains/synchronize

Response Messages:
500: Multi-Domain mode is disabled in SecureChange. Unable to synchronize with SecureTrack domains","folder":"2-16"},{"headers":"Accept: application/json\n","name":"Fetches domain by ID","data":[{"value":null,"type":"text","enabled":true,"key":"domainId"}],"description":"Parameters:
domainId: The ID of the domain

Usage Example


Response Messages:
400: Domain with id ID was not found.","dataMode":"params","folder":"2-16","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/domains/{{domainId}}","collectionId":"2","id":"2-16-102","method":"GET"},{"headers":"Accept: application/json\n","name":"Fetches virtual servers from SecureTrack","data":[{"value":null,"type":"text","enabled":true,"key":"ip"}],"dataMode":"params","description":"Find virtual servers matching a given IP address.
You can search for the virtual server itself of any of its members.

Parameters:
ip: ip
domainId: The unique identifier of a domain [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/external_resources/f5_virtual_servers?ip=2.2.2.2

Response Messages:
400: Invalid IP
400: Invalid Subnet
400: There is no domain with the specified ID.
401: Access is denied
503: Not connected to SecureTrack.","folder":"2-17","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/external_resources/f5_virtual_servers","collectionId":"2","id":"2-17-103","method":"GET"},{"headers":"Accept: application/json\n","name":"Returns the details of the devices that you can select as a target in SecureChange","description":"Parameters:
name: device name or part of a name [optional]
show_targets: show devices as targets [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/devices?name=asa&show_targets=true

Response Messages:
404: Devices not found","folder":"2-18","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/","collectionId":"2","id":"2-18-104","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Update the whole list of excluded devices in SecureChange","dataMode":"raw","description":"Parameters:
body [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded
BODY<device_ids>
    <id>1</id>
    <id>12</id>
</device_ids>

","folder":"2-18","rawModeData":"\n\t1\n\t12\n\n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/excluded","collectionId":"2","id":"2-18-105","method":"PUT"},{"headers":"Accept: application/json\n","name":"Returns IDs for specified list of excluded parent management devices and child firewalls in SecureChange","description":"For example on this Panorama hierarchy:
DG1 - Excluded
  DG1.1
    FW1
    FW2
    FW3

Calling this API with false value will return only DG1’s id.
Calling this API with true value will return DG1, FW1, FW2, FW3 id’s.


Parameters:
show_all: When set to true - Displays the specified devices and all their child firewalls in the hierarchy, which will be excluded implicitly.
When set to false - Displays only the devices which were explicitly excluded.
Default value is false.
[optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded
OUTPUT<device_ids>
    <id>10</id>
    <id>11</id>
</device_ids>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded?show_all=false
OUTPUT<device_ids>
    <id>10</id>
    <id>11</id>
</device_ids>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded?show_all=true
OUTPUT<device_ids>
    <id>33</id>
    <id>10</id>
    <id>11</id>
    <id>35</id>
    <id>29</id>
    <id>31</id>
</device_ids>

","folder":"2-18","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/excluded","collectionId":"2","id":"2-18-106","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Get suggested targets for a given access request","data":[{"value":null,"type":"text","enabled":true,"key":"domain_name"},{"value":null,"type":"text","enabled":true,"key":"workflow_name"}],"dataMode":"raw","description":"Returns a list of suggested targets for a given access request, based on topology calculations.

Parameters:
body [optional]
domain_name: Domain Name
workflow_name: Workflow Name

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/suggest_target?domain_name=Default&workflow_name=AR
BODY{
    \"access_request\":{
        \"users\":{
            \"user\":[
                \"Any\"
            ]
        },
        \"sources\":{
            \"source\":[
                {
                    \"@type\":\"IP\",
                    \"ip_address\":\"10.100.1.1\",
                    \"netmask\":\"255.255.255.255\",
                    \"cidr\":32
                }
            ]
        },
        \"destinations\":{
            \"destination\":[
                {
                    \"@type\":\"IP\",
                    \"ip_address\":\"10.100.20.2\",
                    \"netmask\":\"255.255.255.255\",
                    \"cidr\":32
                }
            ]
        },
        \"services\":{
            \"service\":[
                {
                    \"@type\":\"ANY\",
                }
            ]
        },
        \"action\":\"Accept\",
    }
}
OUTPUT{
    \"multi_target\": {
        \"target\": {
            \"@type\": \"Object\",
            \"object_name\": \"Device-1\",
            \"object_type\": \"firewall\",
            \"object_details\": \"10.100.40.1\",
            \"management_id\": 250,
            \"management_name\": \"Panorama/Domain1\"
        }
    }
}


Response Messages:
200: Targets returned successfully
400: User does not have permissions to domain or domain does not exist
401: Access is denied","folder":"2-18","rawModeData":"{\n\t\"access_request\":{\n\t\t\"users\":{\n\t\t\t\"user\":[\n\t\t\t\t\"Any\"\n\t\t\t]\n\t\t},\n\t\t\"sources\":{\n\t\t\t\"source\":[\n\t\t\t\t{\n\t\t\t\t\t\"@type\":\"IP\",\n\t\t\t\t\t\"ip_address\":\"10.100.1.1\",\n\t\t\t\t\t\"netmask\":\"255.255.255.255\",\n\t\t\t\t\t\"cidr\":32\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"destinations\":{\n\t\t\t\"destination\":[\n\t\t\t\t{\n\t\t\t\t\t\"@type\":\"IP\",\n\t\t\t\t\t\"ip_address\":\"10.100.20.2\",\n\t\t\t\t\t\"netmask\":\"255.255.255.255\",\n\t\t\t\t\t\"cidr\":32\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"services\":{\n\t\t\t\"service\":[\n\t\t\t\t{\n\t\t\t\t\t\"@type\":\"ANY\",\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"action\":\"Accept\",\n\t}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/suggest_target","collectionId":"2","id":"2-18-107","method":"POST"},{"headers":"Accept: application/json\n","name":"Get server decommission designer results","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"dataMode":"params","description":"Use this API to retrieve designer results generated in R17-1 and earlier.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Server Decommission Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/multi_server_decommission_request/261/designer

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.","folder":"2-19","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_server_decommission_request/{{fieldId}}/designer","collectionId":"2","id":"2-19-108","method":"GET"},{"headers":"Accept: application/json\n","name":"Get verifier results","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Server Decommission Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/multi_server_decommission_request/261/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.","dataMode":"params","folder":"2-19","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_server_decommission_request/{{fieldId}}/verifier","collectionId":"2","id":"2-19-109","method":"GET"},{"name":"Run server decommission designer for given task","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/multi_server_decommission_request/designer

Response Messages:
400: Server decommission designer is not defined for the requested field.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a decommission request field.
401: You do not have permission to update this task. Contact your administrator for assistance.","dataMode":"params","folder":"2-19","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/multi_server_decommission_request/designer","collectionId":"2","id":"2-19-110","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get impact analysis results","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Server Decommission Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/multi_server_decommission_request/261/impact_analysis

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.","dataMode":"params","folder":"2-19","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_server_decommission_request/{{fieldId}}/impact_analysis","collectionId":"2","id":"2-19-111","method":"GET"},{"name":"Run Verifier for given task","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/multi_server_decommission_request/verifier

Response Messages:
400: Verifier is not defined for the requested field.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a decommission request field.
401: You do not have permission to update this task. Contact your administrator for assistance.","dataMode":"params","folder":"2-19","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/multi_server_decommission_request/verifier","collectionId":"2","id":"2-19-112","method":"PUT"},{"name":"Run Impact Analysis for given task","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/multi_server_decommission_request/impact_analysis

Response Messages:
400: Impact analysis is not defined for the requested field.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a decommission request field.
401: You do not have permission to update this task. Contact your administrator for assistance.","dataMode":"params","folder":"2-19","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/multi_server_decommission_request/impact_analysis","collectionId":"2","id":"2-19-113","method":"PUT"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Modify the SecureTrack connection settings and test the connection status","dataMode":"raw","description":"Parameters:
testOnly: Test the connection status using the specified settings. The new settings are not saved. The default value is false [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/integration_with_secureTrack
BODY    <secureTrack_settings>
        <host xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"remoteHost\">
            <IP_or_hostname>192.168.11.1</IP_or_hostname>
            <user_name>admin</user_name>
        </host>
        <show_link_to_secureTrack>false</show_link_to_secureTrack>
        <check_connection_interval>30</check_connection_interval>
        <internal_IP_of_secureChange_server>192.168.2.2</internal_IP_of_secureChange_server>
    </secureTrack_settings>


Response Messages:
400: Invalid host name or IP address.
400: show_link_to_secureTrack is invalid. It must be 'true', 'false' or empty.","folder":"2-20","rawModeData":"\t\n\t\t \n\t\t\t192.168.11.1\n\t\t\tadmin\n\t\t\n\t\tfalse\n\t\t30\n\t\t192.168.2.2\n\t","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/integration_with_secureTrack/","collectionId":"2","id":"2-20-114","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve the SecureTrack connection settings and status","description":"

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/integration_with_secureTrack?testOnly=false
","folder":"2-20","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/integration_with_secureTrack/","collectionId":"2","id":"2-20-115","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Import LDAP users to SecureChange by simulating login process","dataMode":"raw","description":"This API implicitly imports LDAP users to SecureChange by simulating their login.
To explicitly import LDAP entities- both users and groups, it is recommended to use /users/import API

Parameters:
body: partyDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/users
BODY<user xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"user\">
    <name>x</name>
    <origin_type>LDAP</origin_type>
        <ldap_configuration>
            <id>1</id>
        </ldap_configuration>
</user>


Response Messages:
401: Access is denied.
400: Name is missing.
400: Origin is missing.
400: User {login_name} already exists, with ID (id} and name {name}.
400: User {login_name} not found in LDAP.
400: Creating a user via REST API is available only if origin is LDAP.
400: Creating a user via REST API is available only if type is User.
400: Ldap configuration with ID {id} not found.","folder":"2-21","rawModeData":"\n\tx\n\tLDAP\n\t\t\n\t\t\t1\n\t\t\n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/","collectionId":"2","id":"2-21-116","method":"POST"},{"collectionId":"2","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/","name":"Return the list of users","method":"GET","id":"2-21-117","description":"user_name: case insensitive, search mode: contains text
exact_name: when set to true, user_name search mode is case sensitive and exact text
email: case insentitive, search mode: exact match
Logical OR between user_name and email.

Parameters:
showIndirectRelation: Members that belong to the selected group only indirectly [optional]
user_name: The user's login name [optional]
email: The user's email [optional]
exact_name: Search user_name as exact match [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/users?email=bob@tufin.com&user_name=bob&exact_name=true
","folder":"2-21"},{"headers":"Content-Type: application/json\n","name":"Change local group members","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"raw","description":"Only users with 'view settings tab' permission can run this API.

Parameters:
id: Group ID
body: groupChangeDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/users/group/1
BODY{
    \"group_change\":{
        \"member_ids_to_add\": [1,2],
        \"member_ids_to_remove\":[3,4]
    }
}    


Response Messages:
400: Exceeded limit of {MAXIMUM} group member changes
400: These user IDs do not exist: {IDs}
400: These user IDs do not exist or are not group members: {IDs}
400: Group ID {ID} is not a local group
400: Group ID {ID} does not exist
400: Cannot add a group to itself
400: Cannot add a group to a group that it already contains. Group {ID1} contains group {ID2}","folder":"2-21","rawModeData":"{\n\t\"group_change\":{\n\t\t\"member_ids_to_add\": [1,2],\n\t\t\"member_ids_to_remove\":[3,4]\n\t}\n}\t","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/group/{{id}}","collectionId":"2","id":"2-21-118","method":"PUT"},{"headers":"Content-Type: application/json\n","name":"Import user / group from LDAP","dataMode":"raw","description":"The imported user / group will be visible in SecureChange GUI under users section.
In multi domain mode, imported entity will be assigned with the domains of \"any user\" group.
Only users with 'view settings tab' permission can run this API.

Parameters:
body: ldapPartyDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/users/import
BODY{
    \"ldap_party\": {
        \"ldap_configuration_name\": \"ldap_name\",
        \"ldap_dn\": \"CN=alice,OU=Advertising,OU=Marketing,DC=testEnv,DC=com\"
    }
}


Response Messages:
400: The LDAP configuration name does not exist
400: The given ldap_dn does not exist
400: The given ldap_dn is already imported
400: Failed to create the selected user
400: Failed to create the selected group
400: Selected user already exists in SecureChange but is not synchronized with the LDAP server. Go to Settings > LDAP and synchronize with the LDAP
400: This group has a large number of users, and will not be expanded in the users console. To be able to configure roles and step participation for individual users from the group, add them explicitly.
400: Failed to update the selected group
400: Unsupported LDAP object class
400: Unable to establish a connection to server <SERVER_IP>:<SERVER_PORT> within the configured timeout of <TIMEOUT> milliseconds.
401: Access is denied","folder":"2-21","rawModeData":"{\n\t\"ldap_party\": {\n\t\t\"ldap_configuration_name\": \"ldap_name\",\n\t\t\"ldap_dn\": \"CN=alice,OU=Advertising,OU=Marketing,DC=testEnv,DC=com\"\n\t}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/import","collectionId":"2","id":"2-21-119","method":"POST"},{"headers":"Content-Type: application/json\n","name":"Create local group","dataMode":"raw","description":"Only users with 'view settings tab' permission can run this API.

Parameters:
body: CreateGroupDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/users/group
BODY{
    \"group\": {
        \"name\": \"name1\",
        \"description\": \"description1\",
        \"email\": \"email1@tufin.com\"
    }
}    


Response Messages:
400: Input Validation Error : {field name}: {input validation error message}
400: Name already exists","folder":"2-21","rawModeData":"{\n\t\"group\": {\n\t\t\"name\": \"name1\",\n\t\t\"description\": \"description1\",\n\t\t\"email\": \"email1@tufin.com\"\n\t}\n}\t","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/group","collectionId":"2","id":"2-21-120","method":"POST"},{"name":"Delete the specified User or Group","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
id: User ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/users/5

Response Messages:
400: User with id {id} does not exist","dataMode":"params","folder":"2-21","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/{{id}}","collectionId":"2","id":"2-21-121","method":"DELETE"},{"name":"Return the specified user","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
id: User ID
showIndirectRelation: Members that belong to the selected group only indirectly [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/users/5

Response Messages:
400: User or group was not found.","dataMode":"params","folder":"2-21","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/{{id}}","collectionId":"2","id":"2-21-122","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Reject a ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
id: The ID of the ticket as shown in SecureChange
handler_id: The user id, when logged in user is rejecting on behalf [optional]
body: Reject comment

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/reject?handler_id=5
BODY<reject_comment>
    <comment>rejected</comment>
</reject_comment>


Response Messages:
400: Ticket status <STATUS> is incorrect to perform this action
400: User <NAME> has no permissions to perform this action
400: Comment cannot be empty
401: User is not permitted to reject this ticket on behalf another user
401: You do not have permission to access ticket <ID>
401: On behalf user do not have permission to access ticket <ID>
401: Access is denied.
404: There is no ticket with ID <ID>.
404: There is no handler (User) with ID <ID>.","dataMode":"raw","folder":"2-22","rawModeData":"\n\trejected\n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/reject","collectionId":"2","id":"2-22-123","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Change the requester of the specified ticket task to the specified user.","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"assigneeId"}],"description":"Parameters:
id: Ticket ID
assigneeId: The assignee ID
body: CommentDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/change_requester/4
BODY<comment>
    <comment>user was deleted moving tickets to Bob</comment>
</comment>


Response Messages:
400: The change requester comment must be set in order to change the requester the ticket.
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
404: There is no ticket with ID.
404: There is no requester (User) with ID.","dataMode":"raw","folder":"2-22","rawModeData":"\n\tuser was deleted moving tickets to Bob\n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/change_requester/{{assigneeId}}","collectionId":"2","id":"2-22-124","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Returns the specified ticket to the specified step","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"toStepId"}],"dataMode":"raw","description":"Values can only be updated for the current step.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
toStepId: To which step we the ticket will return
body: RedoCommentDto

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/redo/1
BODY<redo_step_comment>
    <comment>please fix source </comment>
</redo_step_comment>


Response Messages:
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Task <NAME> is no longer active
401: User has no permissions to redo ticket steps.
404: There is no ticket with ID.
404: No entity found for query","folder":"2-22","rawModeData":"\n\tplease fix source \n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/redo/{{toStepId}}","collectionId":"2","id":"2-22-125","method":"PUT"},{"headers":"Accept: application/json\n","name":"Cancel a ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
id: The ID of the ticket as shown in SecureChange
requester_id: The user of the ticket's requester, when logged in user is canceling on behalf [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/cancel?requester_id=5

Response Messages:
401: Access is denied.
404: Ticket is already closed
404: Ticket ID was not found","dataMode":"params","folder":"2-22","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/cancel","collectionId":"2","id":"2-22-126","method":"PUT"},{"name":"Map rules to ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Maps the rules from the ticket to the relevant rules in SecureTrack.
Adds record set entries to the relevant rules metadata.
Link to history is found in the returned location header.
Applicable only for closed tickets in the following workflows: Access Request, Access Request and Modify Group, and Clone Server Policy.
Use handler_id for running on behalf of another user.
To get handler_id, use the System Users API.

Parameters:
id: The ID of the ticket as shown in SecureChange
handler_id: Run API on behalf of defined user id [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/map_rules

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/map_rules?handler_id=5

Response Messages:
201: Started asynchronous mapping of rules to ticket ID <ID>. Mapping status is displayed in ticket history.
400: Ticket's workflow type does not support this operation
401: Access is denied.
401: You do not have permission to access ticket <ID>
401: On behalf user do not have permission to access ticket <ID>
404: There is no ticket with ID <ID>.
404: There is no handler (User) with ID <ID>.
412: Ticket is not in closed status","folder":"2-22","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/map_rules","collectionId":"2","id":"2-22-127","method":"POST"},{"headers":"Accept: application/json\n","name":"Returns the history of the specified ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
id: Ticket ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/history

Response Messages:
401: User has no permissions to view ticket history
404: You do not have permission to view this task. Contact your administrator for assistance.
404: There is no ticket with ID.","dataMode":"params","folder":"2-22","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/history","collectionId":"2","id":"2-22-128","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Confirm the request","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
id: Ticket ID
requester_id: The user of the ticket's requester, when logged in user is confirm on behalf [optional]
body: Confirm comment

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/confirm?requester_id=5
BODY<confirm_comment>
    <comment>confirmed</comment>
</confirm_comment>


Response Messages:
400: User is trying to confirm a ticket that belongs to another user
400: User is not permitted to confirm this ticket on behalf another user
400: The user can not confirm the ticket, because he is not in the domain of the ticket
401: Access is denied.
404: There is no ticket with ID .","dataMode":"raw","folder":"2-22","rawModeData":"\n\tconfirmed\n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/confirm","collectionId":"2","id":"2-22-129","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Reassigns the specified ticket task to the specified user.","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"assigneeId"}],"dataMode":"raw","description":"Values can only be updated for the current step.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
assigneeId: The assignee ID
body: ReassignTaskCommentDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/reassign/4
BODY<reassign_task_comment>
    <comment>Please complete the AR</comment>
</reassign_task_comment>


Response Messages:
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Task <NAME> is no longer active
404: There is no ticket with ID.
404: No entity found for query","folder":"2-22","rawModeData":"\n\tPlease complete the AR\n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/reassign/{{assigneeId}}","collectionId":"2","id":"2-22-130","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get server clone policy verifier results","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/clone_server_policy/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.
404: Verifier results were not found in the server clone policy request.","dataMode":"params","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/clone_server_policy/verifier","collectionId":"2","id":"2-23-131","method":"GET"},{"headers":"Accept: application/json\n","name":"Get access request verifier results","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/multi_access_request/2022/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.
404: Verifier results were not found in the access request.","dataMode":"params","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_access_request/{{fieldId}}/verifier","collectionId":"2","id":"2-23-132","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Change a task of a ticket at the current step","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"raw","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: ticketTaskDTO
id: Ticket ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4
BODY<task>
    <status>DONE</status>
    <fields/>
</task>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4
BODY{
    \"task\": {
        \"status\": \"ASSIGNED\",
        \"fields\": {
            \"field\": {
                \"@xsi.type\": \"rule_modification_field\",
                \"id\": 743,
                \"devices\": {
                    \"device\": {
                        \"revision_id\": 24,
                        \"management_id\": 5,
                        \"bindings\": {
                            \"binding\": {
                                \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                                \"binding\": {
                                    \"@xsi.type\": \"policy__binding\",
                                    \"policy_name\": \"FortiGate-VM64-111-10_3\"
                                },
                                \"rules\": {
                                    \"rule\": {
                                        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                        \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                                    }
                                }
                            }
                        }
                    }
                },
                \"rule_modifications\": {
                    \"rule_modification\": {
                        \"@xsi.type\": \"modify_rule_modification\",
                        \"rule_key\": {
                            \"device_id\": 5,
                            \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                            \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                        },
                        \"source_modifications\": {
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                    \"name\": \"RANGE_1\",
                                                    \"comment\": \"EXAMPLE_RANGE\",
                                                    \"min_ip\": \"3.3.3.3\",
                                                    \"max_ip\": \"5.5.5.5\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                    \"name\": \"NET_1\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"3.3.3.3\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        },
                        \"destination_modifications\": {
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                    \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"name\": \"Host123\",
                                                    \"comment\": \"cccHost\",
                                                    \"ip\": \"1.2.3.4\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"REMOVE\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                            }
                                        }
                                    }
                                ]
                            }
                        },
                        \"service_modifications\": {
                            \"service_object_cell_modifications\": {
                                \"service_object_cell_modification\": [
                                    {
                                        \"action\": \"REMOVE\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                                \"name\": \"ICMP_1\",
                                                \"comment\": \"EXAMPLE_ICMP\",
                                                \"type\": {
                                                    \"from\": 55,
                                                    \"to\": 55
                                                }
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                \"name\": \"TCP_1\",
                                                \"comment\": \"EXAMPLE_TCP\",
                                                \"port\": {
                                                    \"from\": 1234,
                                                    \"to\": 1234
                                                },
                                                \"protocol\": \"TCP\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                \"name\": \"UDP_1\",
                                                \"comment\": \"EXAMPLE_UDP\",
                                                \"port\": {
                                                    \"from\": 3,
                                                    \"to\": 3
                                                },
                                                \"protocol\": \"UDP\"
                                            }
                                        }
                                    }
                                ]
                            }
                        }
                    }
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Task status does not exist.
400: Task status is not set to ASSIGNED or DONE.
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
403: Task can not be done because there are unlicensed devices for change automation
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value","folder":"2-23","rawModeData":"{\n\t\"task\": {\n\t\t\"status\": \"ASSIGNED\",\n\t\t\"fields\": {\n\t\t\t\"field\": {\n\t\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\t\"id\": 743,\n\t\t\t\t\"devices\": {\n\t\t\t\t\t\"device\": {\n\t\t\t\t\t\t\"revision_id\": 24,\n\t\t\t\t\t\t\"management_id\": 5,\n\t\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"rule_modifications\": {\n\t\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}","collectionId":"2","id":"2-23-133","method":"PUT"},{"headers":"Accept: application/json\n","name":"Returns a list of tickets by search parameters","description":"If the query is succesful but no results are found (for example, if there is no ticket for the specified Ticket ID) then the return code will be 200 and the results will be empty.

Parameters:
id: The ID number of the ticket as shown in SecureChange [optional]
subject: The subject of the ticket [optional]
requester: The requester of the ticket [optional]
group: The group handling the ticket [optional]
assigned_to: The user name of the person assigned to the ticket [optional]
priority: The priority of the ticket [optional]
status: The status of the ticket [optional]
sla_status: The SLA status of the ticket [optional]
field_name: Field name to search by [optional]
field_value: Field value to search by [optional]
current_step: Current step name [optional]
expiration_date_from: Search requests with expiration date from this date [optional]
expiration_date_to: Search requests with expiration date until this date [optional]
domain_name: The Domain of the ticket [optional]
start: Offset the count starting point [optional]
count: Ticket list length [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/search?id=1&status=IN_PROGRESS,REJECTED

Response Messages:
401: Access is denied.
400: Illegal ticket status entered. Permitted values are: IN_PROGRESS, REJECTED, CLOSED, CANCELLED, RESOLVED, WAITING_TO_BE_ASSIGNED, ASSIGNED, WAITING_FOR_MORE_INFO, DONE, INVALID, PENDING, PENDING_LICENS
400: Illegal ticket SLA status entered. Permitted values are: NA, OK, WARNING, ALERT, ESCALATION
400: Illegal ticket priority entered. Permitted values are: LOW, NORMAL, HIGH, CRITICAL
400: Illegal ticket expiration date entered. Permitted date format is: ddMMyyyy (ex. 20.11.2001)
400: Cannot find specified domain <DOMAIN_NAME>","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/search","collectionId":"2","id":"2-23-134","method":"GET"},{"headers":"Accept: application/json\n","name":"Get designer results according to field id","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"dataMode":"params","description":"Use this API to retrieve designer results generated in R17-2 and later.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/designer

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: Specified field, id: <ID> , name: <NAME>, cannot contain designer result
404: Designer results were not found in the request.","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/designer","collectionId":"2","id":"2-23-135","method":"GET"},{"headers":"Accept: application/json\n","name":"Returns the details of a specified ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
expand_links: See expanded view of the objects [optional]
showStepsDetails: Include steps' details in the response [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1
OUTPUT {
    \"ticket\": {
        \"id\": 1,
        \"subject\": \"AR-Ticket\",
        \"requester\": \"a\",
        \"requester_id\": 4,
        \"priority\": \"Normal\",
        \"status\": \"In Progress\",
        \"domain_name\": \"\",
        \"sla_status\": \"NA\",
        \"sla_outcome\": \"NA\",
        \"workflow\": {
            \"id\": 11,
            \"name\": \"AR & MG\",
            \"uses_topology\": true
        },
        \"steps\": {
            \"step\": [
                {
                    \"id\": 209,
                    \"name\": \"Open request\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 209,
                            \"assignee_id\": 4,
                            \"assignee\": \"a\",
                            \"status\": \"DONE\",
                            \"fields\": {
                                \"field\": [
                                    {
                                        \"@xsi.type\": \"multi_access_request\",
                                        \"id\": 1695,
                                        \"name\": \"AR\",
                                        \"read_only\": false,
                                        \"access_request\": {
                                            \"id\": 1706,
                                            \"order\": \"AR1\",
                                            \"risk_analysis_result\": {
                                                \"status\": \"not run\"
                                            },
                                            \"verifier_result\": {
                                                \"status\": \"not run\"
                                            },
                                            \"use_topology\": true,
                                            \"targets\": {
                                                \"target\": {
                                                    \"@type\": \"ANY\",
                                                    \"id\": 1705
                                                }
                                            },
                                            \"users\": {
                                                \"user\": [
                                                    \"Any\"
                                                ]
                                            },
                                            \"sources\": {
                                                \"source\": [
                                                    {
                                                        \"@type\": \"INTERNET\",
                                                        \"id\": 1701
                                                    },
                                                    {
                                                        \"@type\": \"DNS\",
                                                        \"id\": 1702,
                                                        \"host_name\": \"www.google.com\",
                                                        \"dns_ip_addresses\": {
                                                            \"ip_address\": \"216.58.214.100\"
                                                        }
                                                    },
                                                    {
                                                        \"@type\": \"IP\",
                                                        \"id\": 1703,
                                                        \"ip_address\": \"1.1.1.1\",
                                                        \"netmask\": \"255.255.255.255\",
                                                        \"nat_ip_address\": \"4.4.4.4\",
                                                        \"nat_netmask\": \"255.255.255.255\"
                                                    }
                                                ]
                                            },
                                            \"destinations\": {
                                                \"destination\": [
                                                    {
                                                        \"@type\": \"ANY\",
                                                        \"id\": 1697
                                                    }
                                                ]
                                            },
                                            \"services\": {
                                                \"service\": [
                                                    {
                                                        \"@type\": \"ANY\",
                                                        \"id\": 1699
                                                    }
                                                ]
                                            },
                                            \"action\": \"Accept\",
                                            \"labels\": \"\"
                                        }
                                    },
                                    {
                                        \"@xsi.type\": \"multi_group_change\",
                                        \"id\": 1707,
                                        \"name\": \"MG\",
                                        \"read_only\": false,
                                        \"implementation_status\": \"NOT_SUPPORTED\"
                                    }
                                ]
                            }
                        }
                    }
                },
                {
                    \"id\": 210,
                    \"name\": \"STEP2 - auto AR with designer /update /commit\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 210,
                            \"assignee_id\": 4,
                            \"assignee\": \"a\",
                            \"status\": \"ASSIGNED\",
                            \"unlicensed_devices_for_automation\": {
                                \"unlicensed_device_for_automation\": [
                                    {
                                        \"id\": \"2\",
                                        \"name\": \"asa\"
                                    }
                                ]
                            }
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"multi_access_request\",
                                    \"id\": 1709,
                                    \"name\": \"AR\",
                                    \"read_only\": false,
                                    \"access_request\": {
                                        \"id\": 1720,
                                        \"order\": \"AR1\",
                                        \"risk_analysis_result\": {
                                            \"status\": \"not run\"
                                        },
                                        \"verifier_result\": {
                                            \"status\": \"not run\"
                                        },
                                        \"use_topology\": true,
                                        \"targets\": {
                                            \"target\": {
                                                \"@type\": \"ANY\",
                                                \"id\": 1719
                                            }
                                        },
                                        \"users\": {
                                            \"user\": [
                                                \"Any\"
                                            ]
                                        },
                                        \"sources\": {
                                            \"source\": [
                                                {
                                                    \"@type\": \"INTERNET\",
                                                    \"id\": 1721
                                                },
                                                {
                                                    \"@type\": \"DNS\",
                                                    \"id\": 1722,
                                                    \"host_name\": \"www.google.com\",
                                                    \"dns_ip_addresses\": {
                                                        \"ip_address\": \"216.58.214.100\"
                                                    }
                                                },
                                                {
                                                    \"@type\": \"IP\",
                                                    \"id\": 1723,
                                                    \"ip_address\": \"1.1.1.1\",
                                                    \"netmask\": \"255.255.255.255\",
                                                    \"nat_ip_address\": \"4.4.4.4\",
                                                    \"nat_netmask\": \"255.255.255.255\"
                                                },
                                                {
                                                    \"@type\": \"RANGE\",
                                                    \"id\": 1724,
                                                    \"range_first_ip\": \"1.1.11.1\",
                                                    \"range_last_ip\": \"1.1.11.10\"
                                                }
                                            ]
                                        },
                                        \"destinations\": {
                                            \"destination\": [
                                                {
                                                    \"@type\": \"ANY\",
                                                    \"id\": 1711
                                                }
                                            ]
                                        },
                                        \"services\": {
                                            \"service\": [
                                                {
                                                    \"@type\": \"ANY\",
                                                    \"id\": 1713
                                                }
                                            ]
                                        },
                                        \"action\": \"Accept\",
                                        \"labels\": \"\"
                                    }
                                }
                            }
                        }
                    }
                }
            ]
        },
        \"current_step\": {
            \"id\": 210,
            \"name\": \"STEP2 - auto AR with designer /update /commit\"
        },
        \"comments\": \"\"
    }
}


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2
OUTPUT {
    \"ticket\": {
        \"id\": 2,
        \"subject\": \"Clone Server Policy Ticket\",
        \"requester\": \"a\",
        \"requester_id\": 12,
        \"priority\": \"Normal\",
        \"status\": \"In Progress\",
        \"domain_name\": \"\",
        \"sla_status\": \"NA\",
        \"sla_outcome\": \"NA\",
        \"workflow\": {
            \"id\": 109,
            \"name\": \"sc_12705\",
            \"uses_topology\": false
        },
        \"steps\": {
            \"step\": [
                {
                    \"id\": 78,
                    \"name\": \"Open request\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 78,
                            \"assignee_id\": 12,
                            \"assignee\": \"a\",
                            \"status\": \"DONE\",
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"clone_server_policy_request\",
                                    \"id\": 872,
                                    \"name\": \"Clone Server Policy Field\",
                                    \"from_server\": {
                                        \"@type\": \"IP\",
                                        \"id\": 869,
                                        \"ip_address\": \"1.2.2.2\",
                                        \"cidr\": 32
                                    },
                                    \"to_servers\": {
                                        \"server\": {
                                            \"@type\": \"IP\",
                                            \"id\": 871,
                                            \"ip_address\": \"10.100.23.32\",
                                            \"netmask\": \"255.255.255.255\",
                                            \"cidr\": 32
                                        }
                                    },
                                    \"comment\": \"target servers to clone server policy to\"
                                }
                            }
                        }
                    }
                },
                {
                    \"id\": 79,
                    \"name\": \"Business Approval\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 79,
                            \"assignee_id\": 12,
                            \"assignee\": \"a\",
                            \"status\": \"ASSIGNED\",
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"clone_server_policy_request\",
                                    \"id\": 876,
                                    \"name\": \"Clone Server Policy Field\",
                                    \"from_server\": {
                                        \"@type\": \"IP\",
                                        \"id\": 873,
                                        \"ip_address\": \"1.2.2.2\",
                                        \"cidr\": 32
                                    },
                                    \"to_servers\": {
                                        \"server\": {
                                            \"@type\": \"IP\",
                                            \"id\": 875,
                                            \"ip_address\": \"10.100.23.32\",
                                            \"netmask\": \"255.255.255.255\",
                                            \"cidr\": 32
                                        }
                                    },
                                    \"comment\": \"target servers to clone server policy to\"
                                }
                            }
                        }
                    }
                }
            ]
        },
        \"current_step\": {
            \"id\": 79,
            \"name\": \"Business Approval\"
        },
        \"comments\": \"\"
    }
}


Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: No entity found for query","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}","collectionId":"2","id":"2-23-136","method":"GET"},{"headers":"Accept: application/json\n","name":"Get commands for device from designer results of a specific field id","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"deviceId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
deviceId: Device ID
fieldId: Field ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/designer/device/136/commands

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: Specified field, id: <ID> , name: <NAME>, cannot contain designer result
404: Designer results were not found in the access request.
404: Device with ID <ID> was not found in Designer result.
404: Device with ID <ID> does not support Commands feature.","dataMode":"params","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/designer/device/{{deviceId}}/commands","collectionId":"2","id":"2-23-137","method":"GET"},{"headers":"Accept: application/json\n","name":"Returns the details of a specified ticket stages","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps","collectionId":"2","id":"2-23-138","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Change multiple fields within a task of a ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"raw","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldListDTO
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/2/tasks/4/fields
BODY<fields>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_network_object\">
         <id>7885</id>
         <name>n_obj</name>
         <network_object type=\"Object\">
             <object_name>Host_10.1.1.1</object_name>
             <management_name>cp239</management_name>
         </network_object>
         <network_object type=\"Object\">
             <st_uid>{55908141-c341-4990-9cc6-a3fd2dfb49e1}</st_uid>
             <management_id>2</management_id>
         </network_object>
         <network_object type=\"DNS\">
             <host_name>tufin.com</host_name>
         </network_object>
     <field>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_service\">
         <id>7887</id>
         <name>service</name>
         <service type=\"PROTOCOL\">
             <protocol>TCP</protocol>
             <port>80</port>
         </service>
         <service type=\"Object\">
             <object_name>AOL</object_name>
             <management_name>cp239</management_name>
         </service>
     </field>
</fields>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/fields
BODY{
\"fields\": {
\"field\": {
\"@xsi.type\": \"rule_modification_field\",
\"id\": 746,
\"name\": \"rm\",
\"devices\": {
    \"device\": {
    \"revision_id\": 24,
    \"management_id\": 5,
    \"bindings\": {
    \"binding\": {
    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
    \"binding\": {
        \"@xsi.type\": \"policy__binding\",
        \"policy_name\": \"FortiGate-VM64-111-10_3\"
    },
    \"rules\": {
        \"rule\": {
        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
        \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
        }
    }
    }
    }
    }
},
\"rule_modifications\": {
    \"rule_modification\": {
    \"@xsi.type\": \"modify_rule_modification\",
    \"rule_key\": {
    \"device_id\": 5,
    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
    \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
    },
    \"source_modifications\": {
    \"network_object_cell_modifications\": {
    \"network_object_cell_modification\": [
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
            \"name\": \"NET_1\",
            \"comment\": \"\",
            \"ip\": \"3.3.3.3\",
            \"netmask\": \"255.255.255.255\"
        }
        ]
        }
        },
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
            \"name\": \"RANGE_1\",
            \"comment\": \"EXAMPLE_RANGE\",
            \"min_ip\": \"3.3.3.3\",
            \"max_ip\": \"5.5.5.5\"
        }
        ]
        }
        }
    ]
    }
    },
    \"destination_modifications\": {
    \"network_object_cell_modifications\": {
    \"network_object_cell_modification\": [
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
        }
        }
        },
        {
        \"action\": \"REMOVE\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
            \"name\": \"Host123\",
            \"comment\": \"cccHost\",
            \"ip\": \"1.2.3.4\",
            \"netmask\": \"255.255.255.255\"
        }
        ]
        }
        }
    ]
    }
    },
    \"service_modifications\": {
    \"service_object_cell_modifications\": {
    \"service_object_cell_modification\": [
        {
        \"action\": \"REMOVE\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:icmp_service\",
        \"name\": \"ICMP_1\",
        \"comment\": \"EXAMPLE_ICMP\",
        \"type\": {
            \"from\": 55,
            \"to\": 55
        }
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:transport_service\",
        \"name\": \"TCP_1\",
        \"comment\": \"EXAMPLE_TCP\",
        \"port\": {
            \"from\": 1234,
            \"to\": 1234
        },
        \"protocol\": \"TCP\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:transport_service\",
        \"name\": \"UDP_1\",
        \"comment\": \"EXAMPLE_UDP\",
        \"port\": {
            \"from\": 3,
            \"to\": 3
        },
        \"protocol\": \"UDP\"
        }
        }
        }
    ]
    }
    }
    }
}
}
}
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket step does not exist, or is not the current step
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (Network Object with device ID <DEVICE_ID> and ST UID <ST_UID> is not available for the action specified. Check the Knowledge Center or API Implementation Notes for more information
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value","folder":"2-23","rawModeData":"{\n\"fields\": {\n\"field\": {\n\"@xsi.type\": \"rule_modification_field\",\n\"id\": 746,\n\"name\": \"rm\",\n\"devices\": {\n\t\"device\": {\n\t\"revision_id\": 24,\n\t\"management_id\": 5,\n\t\"bindings\": {\n\t\"binding\": {\n\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\"binding\": {\n\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t},\n\t\"rules\": {\n\t\t\"rule\": {\n\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t}\n\t}\n\t}\n\t}\n\t}\n},\n\"rule_modifications\": {\n\t\"rule_modification\": {\n\t\"@xsi.type\": \"modify_rule_modification\",\n\t\"rule_key\": {\n\t\"device_id\": 5,\n\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t},\n\t\"source_modifications\": {\n\t\"network_object_cell_modifications\": {\n\t\"network_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\"name\": \"NET_1\",\n\t\t\t\"comment\": \"\",\n\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t}\n\t\t]\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t}\n\t\t]\n\t\t}\n\t\t}\n\t]\n\t}\n\t},\n\t\"destination_modifications\": {\n\t\"network_object_cell_modifications\": {\n\t\"network_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"REMOVE\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\"name\": \"Host123\",\n\t\t\t\"comment\": \"cccHost\",\n\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t}\n\t\t]\n\t\t}\n\t\t}\n\t]\n\t}\n\t},\n\t\"service_modifications\": {\n\t\"service_object_cell_modifications\": {\n\t\"service_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"REMOVE\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\"name\": \"ICMP_1\",\n\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\"type\": {\n\t\t\t\"from\": 55,\n\t\t\t\"to\": 55\n\t\t}\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\"name\": \"TCP_1\",\n\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\"port\": {\n\t\t\t\"from\": 1234,\n\t\t\t\"to\": 1234\n\t\t},\n\t\t\"protocol\": \"TCP\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\"name\": \"UDP_1\",\n\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\"port\": {\n\t\t\t\"from\": 3,\n\t\t\t\"to\": 3\n\t\t},\n\t\t\"protocol\": \"UDP\"\n\t\t}\n\t\t}\n\t\t}\n\t]\n\t}\n\t}\n\t}\n}\n}\n}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields","collectionId":"2","id":"2-23-139","method":"PUT"},{"headers":"Accept: application/json\n","name":"Returns the details of a the fields","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"params","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
taskId: The ID number of the task as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.
404: Task with ID was not found in Stage ID in ticket ID .","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields","collectionId":"2","id":"2-23-140","method":"GET"},{"headers":"Accept: application/json\n","name":"Returns the details of a specified field","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"dataMode":"params","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
taskId: The ID number of the task as shown in SecureChange
fieldId: The ID number of the field as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/229

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.
404: Task with ID was not found in Stage ID in ticket ID .
404: Field ID was not found in Task ID in Stage ID in ticket ID .","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}","collectionId":"2","id":"2-23-141","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Change a field within a task of a ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"dataMode":"raw","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldDTO
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/2/tasks/4/fields/7742
BODY<field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multiple_selection\">
     <id>7742</id>
     <name>filter type</name>
     <selected_options>
         <selected_option>
             <value>FTP</value>
         </selected_option>
     </selected_options>
</field>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/fields/71
BODY{
    \"rule_modification_field\": {
        \"devices\": {
            \"device\": {
                \"management_id\": 5,
                \"bindings\": {
                    \"binding\": {
                        \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                        \"binding\": {
                            \"@xsi.type\": \"policy__binding\",
                            \"policy_name\": \"FortiGate-VM64-111-10_3\"
                        },
                        \"rules\": {
                            \"rule\": {
                                \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                            }
                        }
                    }
                }
            }
        },
        \"rule_modifications\": {
            \"rule_modification\": {
                \"@xsi.type\": \"modify_rule_modification\",
                \"rule_key\": {
                    \"device_id\": 5,
                    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                    \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                },
                \"source_modifications\": {
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                            \"name\": \"NET_1\",
                                            \"comment\": \"\",
                                            \"ip\": \"3.3.3.3\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                            \"name\": \"RANGE_1\",
                                            \"comment\": \"EXAMPLE_RANGE\",
                                            \"min_ip\": \"3.3.3.3\",
                                            \"max_ip\": \"5.5.5.5\"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                \"destination_modifications\": {
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"name\": \"Host123\",
                                            \"comment\": \"cccHost\",
                                            \"ip\": \"1.2.3.4\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"action\": \"REMOVE\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                    }
                                }
                            }
                        ]
                    }
                },
                \"service_modifications\": {
                    \"service_object_cell_modifications\": {
                        \"service_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                        \"name\": \"TCP_1\",
                                        \"comment\": \"EXAMPLE_TCP\",
                                        \"port\": {
                                            \"from\": 1234,
                                            \"to\": 1234
                                        },
                                        \"protocol\": \"TCP\"
                                    }
                                }
                            },
                            {
                                \"action\": \"REMOVE\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"uid\": \"551556da-22dc-46f4-9253-a7ceee70394b\",
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                        \"name\": \"UDP_1\",
                                        \"comment\": \"EXAMPLE_UDP\",
                                        \"port\": {
                                            \"from\": 3,
                                            \"to\": 3
                                        },
                                        \"protocol\": \"UDP\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                        \"name\": \"ICMP_1\",
                                        \"comment\": \"EXAMPLE_ICMP\",
                                        \"type\": {
                                            \"from\": 55,
                                            \"to\": 55
                                        }
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                    }
                                }
                            }
                        ]
                    }
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket step does not exist, or is not the current step
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: Deleting rule recertification info is not allowed
400: Application Change field cannot be managed via this REST API
400: Rule associated with successfully updated recertification info cannot be removed
400: Rule was already updated
400: Rule does not exist
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value","folder":"2-23","rawModeData":"{\n\t\"rule_modification_field\": {\n\t\t\"devices\": {\n\t\t\t\"device\": {\n\t\t\t\t\"management_id\": 5,\n\t\t\t\t\"bindings\": {\n\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t\"rule_modifications\": {\n\t\t\t\"rule_modification\": {\n\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t},\n\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"uid\": \"551556da-22dc-46f4-9253-a7ceee70394b\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}","collectionId":"2","id":"2-23-142","method":"PUT"},{"headers":"Accept: application/json\n","name":"Returns the results of the Commit action","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"},{"value":null,"type":"text","enabled":true,"key":"managementId"}],"dataMode":"params","description":"GENERAL USE
The report returns the Commit results for the device with the specified management ID and for the devices suggested in the Designer results. The report also includes results for devices that are in the related hierarchy of these devices.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID
managementId: Management ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/designer/commit_report/3
OUTPUT{
    \"commit_report\": {
        \"ticketId\": 27,
        \"statTime\": \"24-Oct-2018 08:55 AM\",
        \"endTime\": \"24-Oct-2018 08:56 AM\",
        \"duration\": \"00:00:30\",
        \"vendorName\": \"PALO ALTO NETWORKS\",
        \"managmentName\": \"pano211\",
        \"devices\": {
            \"device\": [
                {
                    \"name\": \"DG1.1\",
                    \"status\": \"success_with_warnings\",
                    \"warnings\": {
                        \"warning\": \"Commit not performed: This device had no policies to install on its managed firewalls\"
                    },
                    \"policies\": \"\"
                },
                {
                    \"name\": \"DG1\",
                    \"status\": \"success_with_warnings\",
                    \"warnings\": {
                        \"warning\": \"Commit not performed: This device had no policies to install on its managed firewalls\"
                    },
                    \"policies\": \"\"
                }
            ]
        }
    }
}


Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: Specified field, id: <ID> , name: <NAME>, cannot contain designer result
404: Designer results were not found in the request.","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/designer/commit_report/{{managementId}}","collectionId":"2","id":"2-23-143","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Change the ticket properties","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"raw","description":"Change the ticket properties listed in the TicketPropertiesDTO.
When specifying the notification_group property you must use the ID of the group or leave the ID empty to remove the group.

Parameters:
body: ticketPropertiesDTO
id: The ID number of the ticket as shown in SecureChange

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/ticket_properties
BODY<ticket_properties>
    <notification_group>
        <id>10</id>
    </notification_group>
</ticket_properties>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/ticket_properties
BODY<ticket_properties>
    <notification_group>
        <id/>
    </notification_group>
</ticket_properties>


Response Messages:
400: Notification Group <ID> is a user and not a user group
400: Notification Group <ID> exceeds the configured maximum allowed number of users for notifications
400: <ID> (“Any User”) is not allowed as a Notification Group
400: Notification Group <ID> does not have permission of 'Group members can perform actions on requests submitted by other members'
400: Notification Group <ID> is not a member in the first step of the workflow
400: Notification Group is not enabled in this workflow
401: You do not have permission to change the Notification Group
404: There is no group with ID <ID>.
404: There is no ticket with ID <ID>.","folder":"2-23","rawModeData":"\n\t\n\t\t\n\t\n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/ticket_properties","collectionId":"2","id":"2-23-144","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Change multiple field within a task of a ticket in the current step","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"raw","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldListDTO
id: Ticket ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields
BODY<fields>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_server_decommission_request\">
         <id>7591</id>
         <name>sd</name>
         <server_decommission_request>
             <id>7596</id>
             <order>DR1</order>
             <servers>
                 <server type=\"IP\">
                     <id>7593</id>
                     <ip_address>2.2.2.2</ip_address>
                     <netmask>255.255.255.255</netmask>
                 </server>
             </servers>
             <targets>
                 <target type=\"ANY\">
                     <id>7595</id>
                 </target>
             </targets>
             <comment>change ip from 1.1.1.1 to 2.2.2.2</comment>
         </server_decommission_request>
     </field>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"date\">
         <id>7786</id>
         <name>date</name>
         <value>2015-12-15</value>
     </field>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"time\">
         <id>7787</id>
         <name>time</name>
         <value>12:00</value>
     </field>
</fields>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields
BODY{
\"fields\": {
\"field\": {
\"@xsi.type\": \"rule_modification_field\",
\"id\": 746,
\"name\": \"rm\",
\"devices\": {
    \"device\": {
    \"revision_id\": 24,
    \"management_id\": 5,
    \"bindings\": {
    \"binding\": {
    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
    \"binding\": {
        \"@xsi.type\": \"policy__binding\",
        \"policy_name\": \"FortiGate-VM64-111-10_3\"
    },
    \"rules\": {
        \"rule\": {
        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
        \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
        }
    }
    }
    }
    }
},
\"rule_modifications\": {
    \"rule_modification\": {
    \"@xsi.type\": \"modify_rule_modification\",
    \"rule_key\": {
    \"device_id\": 5,
    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
    \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
    },
    \"source_modifications\": {
    \"network_object_cell_modifications\": {
    \"network_object_cell_modification\": [
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
            \"name\": \"NET_1\",
            \"comment\": \"\",
            \"ip\": \"3.3.3.3\",
            \"netmask\": \"255.255.255.255\"
        }
        ]
        }
        },
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
            \"name\": \"RANGE_1\",
            \"comment\": \"EXAMPLE_RANGE\",
            \"min_ip\": \"3.3.3.3\",
            \"max_ip\": \"5.5.5.5\"
        }
        ]
        }
        }
    ]
    }
    },
    \"destination_modifications\": {
    \"network_object_cell_modifications\": {
    \"network_object_cell_modification\": [
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
        }
        }
        },
        {
        \"action\": \"REMOVE\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
            \"name\": \"Host123\",
            \"comment\": \"cccHost\",
            \"ip\": \"1.2.3.4\",
            \"netmask\": \"255.255.255.255\"
        }
        ]
        }
        }
    ]
    }
    },
    \"service_modifications\": {
    \"service_object_cell_modifications\": {
    \"service_object_cell_modification\": [
        {
        \"action\": \"REMOVE\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:icmp_service\",
        \"name\": \"ICMP_1\",
        \"comment\": \"EXAMPLE_ICMP\",
        \"type\": {
            \"from\": 55,
            \"to\": 55
        }
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:transport_service\",
        \"name\": \"TCP_1\",
        \"comment\": \"EXAMPLE_TCP\",
        \"port\": {
            \"from\": 1234,
            \"to\": 1234
        },
        \"protocol\": \"TCP\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:transport_service\",
        \"name\": \"UDP_1\",
        \"comment\": \"EXAMPLE_UDP\",
        \"port\": {
            \"from\": 3,
            \"to\": 3
        },
        \"protocol\": \"UDP\"
        }
        }
        }
    ]
    }
    }
    }
}
}
}
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value","folder":"2-23","rawModeData":"{\n\"fields\": {\n\"field\": {\n\"@xsi.type\": \"rule_modification_field\",\n\"id\": 746,\n\"name\": \"rm\",\n\"devices\": {\n\t\"device\": {\n\t\"revision_id\": 24,\n\t\"management_id\": 5,\n\t\"bindings\": {\n\t\"binding\": {\n\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\"binding\": {\n\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t},\n\t\"rules\": {\n\t\t\"rule\": {\n\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t}\n\t}\n\t}\n\t}\n\t}\n},\n\"rule_modifications\": {\n\t\"rule_modification\": {\n\t\"@xsi.type\": \"modify_rule_modification\",\n\t\"rule_key\": {\n\t\"device_id\": 5,\n\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t},\n\t\"source_modifications\": {\n\t\"network_object_cell_modifications\": {\n\t\"network_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\"name\": \"NET_1\",\n\t\t\t\"comment\": \"\",\n\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t}\n\t\t]\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t}\n\t\t]\n\t\t}\n\t\t}\n\t]\n\t}\n\t},\n\t\"destination_modifications\": {\n\t\"network_object_cell_modifications\": {\n\t\"network_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"REMOVE\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\"name\": \"Host123\",\n\t\t\t\"comment\": \"cccHost\",\n\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t}\n\t\t]\n\t\t}\n\t\t}\n\t]\n\t}\n\t},\n\t\"service_modifications\": {\n\t\"service_object_cell_modifications\": {\n\t\"service_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"REMOVE\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\"name\": \"ICMP_1\",\n\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\"type\": {\n\t\t\t\"from\": 55,\n\t\t\t\"to\": 55\n\t\t}\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\"name\": \"TCP_1\",\n\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\"port\": {\n\t\t\t\"from\": 1234,\n\t\t\t\"to\": 1234\n\t\t},\n\t\t\"protocol\": \"TCP\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\"name\": \"UDP_1\",\n\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\"port\": {\n\t\t\t\"from\": 3,\n\t\t\t\"to\": 3\n\t\t},\n\t\t\"protocol\": \"UDP\"\n\t\t}\n\t\t}\n\t\t}\n\t]\n\t}\n\t}\n\t}\n}\n}\n}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/fields","collectionId":"2","id":"2-23-145","method":"PUT"},{"headers":"Accept: application/json\n","name":"Returns the details of a specified ticket stages","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"}],"dataMode":"params","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}","collectionId":"2","id":"2-23-146","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Submit a new ticket to Secure Change","dataMode":"raw","description":" GENERAL USE
When posting a Modify Group ticket, group scope must be configured for FortiManager advanced and Juniper SRX devices.
Juniper SRX devices:
Global address-book will be used unless an existing address-book is given.
Ticket validation will fail in case given Address Book is not configured on the device.
FortiManager advanced devices:
'Any' zone will be used unless an existing zone is given.
Ticket validation will fail in case given zone is not configured on the device.
*Note: Zones and address-books must not be configured for other devices.

Using newly created objects from a different group in the same ticket
The user can add a newly created object from a different group to the selected group, with object_UID equal to the name of the newly created object.
For management devices with hierarchies, the newly created object does not populate other levels of the hierarchies.

Permitted values for @type
Allowed values for @type property included in DestinationDTO and SourceDTO are:
ANY
IP
DNS
Object - Device's existing object
INTERNET
LDAP (SourceDTO only) - LDAP entity

To use a service object in a new request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id
2. Both object_name and management_name

To use a network object in a new request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both object_UID and object_name are defined, object_UID takes precedence over object_name

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: ticketDTO
closed: Cannot be done from the API [optional]
count [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY<ticket>
    <subject>topology mode_AR1-with topology_AR2-no topology</subject>
    <requester>u1</requester>
    <priority>Normal</priority>
    <domain_name>Default</domain_name>
    <workflow>
         <id>7</id>
         <name>Workflow with topology</name>
    </workflow>
    <steps>
         <step>
             <name>Open request</name>
             <tasks>
                 <task>
                     <fields>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_access_request\">
                             <name>Required Access</name>
                             <access_request>
                                 <use_topology>true</use_topology>
                                 <targets>
                                     <target type=\"Object\">
                                         <object_name>ASA</object_name>
                                         <management_name>ASA</management_name>
                                     </target>
                                 </targets>
                                 <users>
                                     <user>Any</user>
                                 </users>
                                 <sources>
                                     <source type=\"Object\">
                                         <object_name>host_10.100.10.140</object_name>
                                         <management_name>NetScreen</management_name>
                                     </source>
                                 <sources>
                                     <source type=\"Object\">
                                         <object_UID>{55908141-c341-4990-9cc6-a3fd2dfb49e1}</object_UID>
                                         <management_id>13</management_id>
                                     </source>
                                 </sources>
                                 <destinations>
                                     <destination type=\"Object\">
                                         <object_name>h_10.10.10.10</object_name>
                                         <management_name>ASA</management_name>
                                     </destination>
                                 </destinations>
                                 <services>
                                     <service type=\"PROTOCOL\">
                                         <protocol>TCP</protocol>
                                         <port>80</port>
                                     </service>
                                     <service type=\"APPLICATION_IDENTITY\">
                                         <application_name>Gmail</application_name>
                                     </service>
                                 </services>
                                 <action>Accept</action>
                                 <labels/>
                             </access_request>
                             <access_request>
                                 <use_topology>false</use_topology>
                                 <targets>
                                     <target type=\"Object\">
                                         <object_name>inside_access_in</object_name>
                                         <management_name>ASA</management_name>
                                     </target>
                                 </targets>
                                 <users>
                                     <user>Any</user>
                                 </users>
                                 <sources>
                                     <source type=\"Object\">
                                         <object_name>1.1.1.0</object_name>
                                         <management_name>NetScreen</management_name>
                                     </source>
                                 </sources>
                                 <destinations>
                                     <destination type=\"Object\">
                                         <object_name>network_regi3</object_name>
                                         <management_name>ASA</management_name>
                                     </destination>
                                 </destinations>
                                 <services>
                                     <service type=\"ANY\">
                                     </service>
                                 </services>
                                 <action>Accept</action>
                                 <labels/>
                             </access_request>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_area\">
                             <name>Business Justification</name>
                             <text>I need access to ftp </text>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_field\">
                             <name>Project Number</name>
                             <text>CR124560 </text>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"hyperlink\">
                             <name>Hyperlink</name>
                             <url>http://192.168.1.1/ticket</url>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"drop_down_list\">
                             <name>Change Window</name>
                             <selection>Monday</selection>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"manager\">
                             <name>manager email</name>
                             <text>manager@tufin.com</text>
                         </field>
                     </fields>
                 </task>
             </tasks>
        </step>
    </steps>
    <comments/>
</ticket>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY<ticket>
    <subject>New MG ticket</subject>
    <requester>a</requester>
    <requester_id>4</requester_id>
    <priority>Normal</priority>
    <status>In Progress</status>
    <domain_name/>
    <sla_status>NA</sla_status>
    <sla_outcome>NA</sla_outcome>
    <workflow>
        <id>6</id>
        <name>MG</name>
        <uses_topology>false</uses_topology>
    </workflow>
    <steps>
        <step>
            <id>72</id>
            <name>New step</name>
            <redone>false</redone>
            <skipped>false</skipped>
            <tasks>
                <task>
                    <id>72</id>
                    <assignee_id>4</assignee_id>
                    <assignee>a</assignee>
                    <status>ASSIGNED</status>
                    <fields>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_group_change\">
                            <id>262</id>
                            <name>MG</name>
                            <read_only>false</read_only>
                            <implementation_status>NOT_SUPPORTED</implementation_status>
                            <group_change>
                                <name>ExistingGroup</name>
                                <object_UID>{c862fb6f-1314-45da-9e01-56c9b85d001d}</object_UID>
                                <management_id>58</management_id>
                                <management_name>FMG/root</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>157</id>
                                        <name>10.100 net</name>
                                        <object_UID>{37cdc055-7aac-4385-b46b-cc54d95e4b6d}</object_UID>
                                        <object_type>Network</object_type>
                                        <object_details>10.100.0.0/255.255.0.0</object_details>
                                        <management_id>58</management_id>
                                        <management_name>FMG/root</management_name>
                                        <status>NOT_CHANGED</status>
                                        <object_updated_status>EXISTING_EDITED</object_updated_status>
                                        <comment>new_comment</comment>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                                <zone>
                                    <is_global>true</is_global>
                                    <name>any</name>
                                </zone>
                            </group_change>
                            <group_change>
                                <name>78.45.12.0</name>
                                <object_UID>{cac64d34-a05e-4a05-b271-64642eb976ff}</object_UID>
                                <management_id>28</management_id>
                                <management_name>SRX-root-lsys</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>158</id>
                                        <name>78.45.12.1</name>
                                        <object_UID>{7912c335-6dbe-47de-b872-1322f9015b2f}</object_UID>
                                        <object_type>Host</object_type>
                                        <object_details>78.45.12.1/255.255.255.255</object_details>
                                        <management_id>28</management_id>
                                        <management_name>SRX-root-lsys</management_name>
                                        <status>NOT_CHANGED</status>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                                <address_book>
                                    <name>global</name>
                                </address_book>
                            </group_change>
                            <group_change>
                                <name>10.10.0.0/16</name>
                                <object_UID>{5dff0bd8-51e4-4a83-8138-d54dd18ca52b}</object_UID>
                                <management_id>24</management_id>
                                <management_name>NSX-Distributed Firewall</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>161</id>
                                        <name>10.10.0.0/16</name>
                                        <object_UID>{5d7b826c-f053-40fd-81bd-7a6f44cf15ef}</object_UID>
                                        <object_type>Network</object_type>
                                        <object_details>10.10.0.0/255.255.0.0</object_details>
                                        <management_id>24</management_id>
                                        <management_name>NSX-Distributed Firewall</management_name>
                                        <status>NOT_CHANGED</status>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                            </group_change>
                        </field>
                    </fields>
                </task>
            </tasks>
        </step>
    </steps>
</ticket>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY<ticket>
    <subject>test API</subject>
    <requester>a</requester>
    <requester_id>4</requester_id>
    <priority>Normal</priority>
    <domain_name/>
    <sla_status>NA</sla_status>
    <sla_outcome>NA</sla_outcome>
    <workflow>
        <id>8</id>
        <name>Modify group</name>
        <uses_topology>false</uses_topology>
    </workflow>
    <steps>
        <step>
            <id>11</id>
            <name>Open request</name>
            <redone>false</redone>
            <skipped>false</skipped>
            <tasks>
                <task>
                    <id>11</id>
                    <assignee_id>4</assignee_id>
                    <assignee>a</assignee>                    <status>DONE</status>
                    <fields>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_group_change\">
                            <id>137</id>
                            <name>ff</name>
                            <read_only>false</read_only>
                            <implementation_status>NOT_SUPPORTED</implementation_status>
                            <group_change>
                                <name>port1Group</name>
                                <object_UID>{d5b4459b-6b27-4012-9924-b244c250520f}</object_UID>
                                <management_id>64</management_id>
                                <management_name>10.100.111.8/ADOM_5_2</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"HOST\">
                                        <id>69</id>
                                        <name>obj_1</name>
                                        <object_UID>obj_1</object_UID>
                                        <object_type>Host</object_type>
                                        <object_details>6.6.6.6/255.255.255.255</object_details>
                                        <management_id>64</management_id>
                                        <status>ADDED</status>
                                        <comment/>
                                        <object_updated_status>NEW</object_updated_status>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                            </group_change>
                            <group_change>
                                <name>gfd</name>
                                <management_id>64</management_id>
                                <management_name>10.100.111.8/ADOM_5_2</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>70</id>
                                        <name>obj_1</name>
                                        <object_UID>obj_1</object_UID>
                                        <object_type>Host</object_type>
                                        <object_details>6.6.6.6/255.255.255.255</object_details>
                                        <management_id>64</management_id>
                                        <management_name>10.100.111.8/ADOM_5_2</management_name>
                                        <status>ADDED</status>
                                        <object_updated_status>EXISTING_NOT_EDITED</object_updated_status>
                                    </member>
                                </members>
                                <change_action>CREATE</change_action>
                                <zone>
                                    <is_global>true</is_global>
                                    <name>any</name>
                                </zone>
                            </group_change>
                        </field>
                    </fields>
                </task>
            </tasks>
        </step>
    </steps>
    <current_step>
        <id>12</id>
        <name>Copy of Open request</name>
    </current_step>
    <comments/>
</ticket>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY{
    \"ticket\": {
        \"application_details\": { \"id\": \"1\" },
        \"subject\": \"topology mode_AR1-with topology_AR2-no topology\",
        \"priority\": \"Normal\",
        \"workflow\": { \"name\": \"ar\" }
    }
}


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY{
    \"ticket\": {
        \"subject\": \"RM_EXAMPLE\",
        \"requester\": \"m\",
        \"requester_id\": 4,
        \"priority\": \"Normal\",
        \"domain_name\": \"\",
        \"workflow\": {
            \"name\": \"RM\",
        },
        \"steps\": {
            \"step\": [
                {
                    \"tasks\": {
                        \"task\": {
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"rule_modification_field\",
                                    \"devices\": {
                                        \"device\": {
                                            \"revision_id\": 24,
                                            \"management_id\": 5,
                                            \"bindings\": {
                                                \"binding\": {
                                                    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                                                    \"binding\": {
                                                        \"@xsi.type\": \"policy__binding\",
                                                        \"policy_name\": \"FortiGate-VM64-111-10_3\"
                                                    },
                                                    \"rules\": {
                                                        \"rule\": {
                                                            \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                                            \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    \"rule_modifications\": {
                                        \"rule_modification\": {
                                            \"@xsi.type\": \"modify_rule_modification\",
                                            \"rule_key\": {
                                                \"device_id\": 5,
                                                \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                                                \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                                            },
                                            \"source_modifications\": {
                                                \"network_object_cell_modifications\": {
                                                    \"network_object_cell_modification\": [
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"network_object\": [
                                                                    {
                                                                        \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                                        \"name\": \"RANGE_1\",
                                                                        \"comment\": \"EXAMPLE_RANGE\",
                                                                        \"min_ip\": \"3.3.3.3\",
                                                                        \"max_ip\": \"5.5.5.5\"
                                                                    }
                                                                ]
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"network_object\": [
                                                                    {
                                                                        \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                                        \"name\": \"NET_1\",
                                                                        \"comment\": \"\",
                                                                        \"ip\": \"3.3.3.3\",
                                                                        \"netmask\": \"255.255.255.255\"
                                                                    }
                                                                ]
                                                            }
                                                        }
                                                    ]
                                                }
                                            },
                                            \"destination_modifications\": {
                                                \"id\": 11,
                                                \"network_object_cell_modifications\": {
                                                    \"network_object_cell_modification\": [
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"existing\",
                                                                    \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"REMOVE\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"existing\",
                                                                    \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"network_object\": [
                                                                    {
                                                                        \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                                        \"name\": \"Host123\",
                                                                        \"comment\": \"cccHost\",
                                                                        \"ip\": \"1.2.3.4\",
                                                                        \"netmask\": \"255.255.255.255\"
                                                                    }
                                                                ]
                                                            }
                                                        }
                                                    ]
                                                }
                                            },
                                            \"service_modifications\": {
                                                \"id\": 9,
                                                \"service_object_cell_modifications\": {
                                                    \"service_object_cell_modification\": [
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"service_object\": {
                                                                    \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                                                    \"name\": \"ICMP_1\",
                                                                    \"comment\": \"EXAMPLE_ICMP\",
                                                                    \"type\": {
                                                                        \"from\": 55,
                                                                        \"to\": 55
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"service_object\": {
                                                                    \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                                    \"name\": \"UDP_1\",
                                                                    \"comment\": \"EXAMPLE_UDP\",
                                                                    \"port\": {
                                                                        \"from\": 3,
                                                                        \"to\": 3
                                                                    },
                                                                    \"protocol\": \"UDP\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"service_object\": {
                                                                    \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                                    \"name\": \"TCP_1\",
                                                                    \"comment\": \"EXAMPLE_TCP\",
                                                                    \"port\": {
                                                                        \"from\": 1234,
                                                                        \"to\": 1234
                                                                    },
                                                                    \"protocol\": \"TCP\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"existing\",
                                                                    \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"REMOVE\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"existing\",
                                                                    \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                                                }
                                                            }
                                                        }
                                                    ]
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            ]
        },
    }
}


Response Messages:
400: Application ID is missing.
400: Create closed ticket is enabled only from SecureApp application.
400: The application was already deleted.
400: The requester must be the currently logged in user.
400: Workflow was not found.
400: Workflow is not active.
400: Workflow configuration is not valid.
400: Workflow is not set
400: You cannot enter a status for a new ticket.
400: Requester cannot open a ticket in domain.
400: Invalid ticket priority.
400: You cannot open a new ticket with an empty subject.
400: Expiration field is required.
400: Submit ticket enabled only with the first step
400: First step can be only with one task
400: The specified workflow does not contain an access request field in the first step.
400: There are no changed connections that are ready for creating a ticket.
400: You cannot use an access request field to create a ticket from SecureApp.
400: The ticket fields do not match the fields in the current step of the workflow.
400: You cannot change the value of a field because it is read-only.
400: Managed tasks are not initialized or done
400: Application Change field cannot be managed via this REST API
400: Invalid value for field: <FIELD_NAME> (Rule Modification workflow is not supported for this device)
401: You do not have permissions to edit this application.
401: Logged in user: NAME do not have permission to perform on behalf actions
401: You are not a participant in the first step of this workflow
401: UNAUTHORIZED
404: There is no application with the specified ID
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (Network object cell modification missing action)
400: Invalid value for field: <FIELD_NAME> (Network object cell modification element cannot be empty)
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value","folder":"2-23","rawModeData":"{\n\t\"ticket\": {\n\t\t\"subject\": \"RM_EXAMPLE\",\n\t\t\"requester\": \"m\",\n\t\t\"requester_id\": 4,\n\t\t\"priority\": \"Normal\",\n\t\t\"domain_name\": \"\",\n\t\t\"workflow\": {\n\t\t\t\"name\": \"RM\",\n\t\t},\n\t\t\"steps\": {\n\t\t\t\"step\": [\n\t\t\t\t{\n\t\t\t\t\t\"tasks\": {\n\t\t\t\t\t\t\"task\": {\n\t\t\t\t\t\t\t\"fields\": {\n\t\t\t\t\t\t\t\t\"field\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\t\t\t\t\t\t\"devices\": {\n\t\t\t\t\t\t\t\t\t\t\"device\": {\n\t\t\t\t\t\t\t\t\t\t\t\"revision_id\": 24,\n\t\t\t\t\t\t\t\t\t\t\t\"management_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"rule_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\t\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 11,\n\t\t\t\t\t\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 9,\n\t\t\t\t\t\t\t\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/","collectionId":"2","id":"2-23-147","method":"POST"},{"headers":"Accept: application/json\n","name":"Returns the details of a specified tickets (max 100 tickets in a single query)","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
status: The status of the tickets [optional]
count: Tickets list max pagination length (max value is 100) [optional]
start: Offset the count starting point [optional]
desc: Get the list in descending order [optional]
expand_links: See expanded view of the objects [optional]
showStepsDetails: Include steps' details in the response [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets?status=In Progress&count=10&start=3&expand_links=false

Response Messages:
400: Status is not a valid. The valid values are: TICKET_STATUSES
400: Can not fetch more than 100 tickets in 1 time
401: Access is denied","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/","collectionId":"2","id":"2-23-148","method":"GET"},{"headers":"Accept: application/json\n","name":"Returns a list of tickets by search parameters","description":"Parameters:
parameter: Free text search parameter (Search syntax details) [optional]
start: Offset the count starting point [optional]
count: Tickets list max length (max value is 1000) [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/free_text_search/?parameter=taskstatus:ASSIGNED AND priority:High

Response Messages:
400: Can not fetch more than 1000 tickets in 1 time
401: Access is denied.
404: Illegal ticket status entered. Permitted values are: IN_PROGRESS, REJECTED, CLOSED, CANCELLED, RESOLVED
404: Illegal ticket SLA status entered. Permitted values are: NA, OK, WARNING, ALERT, ESCALATION
404: Illegal ticket priority entered. Permitted values are: LOW, NORMAL, HIGH, CRITICAL
400: Illegal count value entered. Max value is 1000
404: Illegal ticket expiration date entered. Permitted date format is: ddMMyyyy (ex. 20.11.2001)
404: No entity found for query","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/free_text_search","collectionId":"2","id":"2-23-149","method":"GET"},{"headers":"Accept: application/json\n","name":"Returns the details of the tasks","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"}],"dataMode":"params","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks","collectionId":"2","id":"2-23-150","method":"GET"},{"name":"Returns topology map image (png file) for specific verifier results","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/multi_access_request/2022/verifier/topology_map

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.
404: Verifier results were not found in the access request.
404: Toplogy map was not found for this field.","dataMode":"params","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_access_request/{{fieldId}}/verifier/topology_map","collectionId":"2","id":"2-23-151","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Change a task of a ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"raw","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: ticketTaskDTO
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/2/tasks/4
BODY<task>
     <status>ASSIGNED</status>
     <fields>
         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_group_change\">
             <id>7599</id>
             <name>mf</name>
             <read_only>false</read_only>
             <implementation_status>NOT_STARTED</implementation_status>
             <group_change>
                        <name>ggg</name>
                        <st_uid>{A12AE330-0DBD-11E5-B841-7F0000010E0E}</st_uid>
                        <management_id>42</management_id>
                        <management_name>cp239</management_name>
                        <members>
                             <member type=\"Object\">
                                 <id>8</id>
                                 <name>yaakovs_host</name>
                                 <st_uid>{BDAA378C-C90B-4D12-B598-1AFED2D1DA14}</st_uid>
                                 <object_type>Host</object_type>
                                 <object_details>1.1.1.1/255.255.255.255</object_details>
                         <management_id>42</management_id>
                         <management_name>cp239</management_name>
                                 <status>NOT_CHANGED</status>
                             </member>
                             <member type=\"Object\">
                                 <id>9</id>
                                    <name>Avi_10.100.120.254</name>
                                    <st_uid>{8F195CDC-F426-47B6-9E8A-1FF14C17E54F}</st_uid>
                                     <object_type>Host</object_type>
                                     <object_details>10.100.120.254/255.255.255.255</object_details>
                                     <management_id>42</management_id>
                                     <management_name>cp239</management_name>
                                     <status>NOT_CHANGED</status>
                                 </member>
                                 <member type=\"HOST\">
                                     <id>10</id>
                                     <name>h22</name>
                                     <object_type>Host</object_type>
                                     <object_details>2.2.2.2/255.255.255.255</object_details>
                                     <status>ADDED</status>
                                     <comment/>
                                 </member>
                                 <member type=\"HOST\">
                                     <id>10</id>
                                     <name>h22</name>
                                     <object_type>Host</object_type>
                                     <object_details>3.3.3.3/255.255.255.255</object_details>
                                     <status>ADDED</status>
                                     <comment/>
                                 </member>
                 </members>
                 <change_implementation_status>NOT_RUN</change_implementation_status>
                    </group_change>
            </field>
     </fields>
</task>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4
BODY{
    \"task\": {
        \"status\": \"ASSIGNED\",
        \"fields\": {
            \"field\": {
                \"@xsi.type\": \"rule_modification_field\",
                \"id\": 743,
                \"devices\": {
                    \"device\": {
                        \"revision_id\": 24,
                        \"management_id\": 5,
                        \"bindings\": {
                            \"binding\": {
                                \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                                \"binding\": {
                                    \"@xsi.type\": \"policy__binding\",
                                    \"policy_name\": \"FortiGate-VM64-111-10_3\"
                                },
                                \"rules\": {
                                    \"rule\": {
                                        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                        \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                                    }
                                }
                            }
                        }
                    }
                },
                \"rule_modifications\": {
                    \"rule_modification\": {
                        \"@xsi.type\": \"modify_rule_modification\",
                        \"rule_key\": {
                            \"device_id\": 5,
                            \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                            \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                        },
                        \"source_modifications\": {
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                    \"name\": \"RANGE_1\",
                                                    \"comment\": \"EXAMPLE_RANGE\",
                                                    \"min_ip\": \"3.3.3.3\",
                                                    \"max_ip\": \"5.5.5.5\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                    \"name\": \"NET_1\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"3.3.3.3\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        },
                        \"destination_modifications\": {
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                    \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"name\": \"Host123\",
                                                    \"comment\": \"cccHost\",
                                                    \"ip\": \"1.2.3.4\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"REMOVE\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                            }
                                        }
                                    }
                                ]
                            }
                        },
                        \"service_modifications\": {
                            \"service_object_cell_modifications\": {
                                \"service_object_cell_modification\": [
                                    {
                                        \"action\": \"REMOVE\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                                \"name\": \"ICMP_1\",
                                                \"comment\": \"EXAMPLE_ICMP\",
                                                \"type\": {
                                                    \"from\": 55,
                                                    \"to\": 55
                                                }
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                \"name\": \"TCP_1\",
                                                \"comment\": \"EXAMPLE_TCP\",
                                                \"port\": {
                                                    \"from\": 1234,
                                                    \"to\": 1234
                                                },
                                                \"protocol\": \"TCP\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                \"name\": \"UDP_1\",
                                                \"comment\": \"EXAMPLE_UDP\",
                                                \"port\": {
                                                    \"from\": 3,
                                                    \"to\": 3
                                                },
                                                \"protocol\": \"UDP\"
                                            }
                                        }
                                    }
                                ]
                            }
                        }
                    }
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket step does not exist, or is not the current step
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Task status does not exist.
400: Task status is not set to ASSIGNED or DONE.
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
403: Task can not be done because there are unlicensed devices for change automation
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value","folder":"2-23","rawModeData":"{\n\t\"task\": {\n\t\t\"status\": \"ASSIGNED\",\n\t\t\"fields\": {\n\t\t\t\"field\": {\n\t\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\t\"id\": 743,\n\t\t\t\t\"devices\": {\n\t\t\t\t\t\"device\": {\n\t\t\t\t\t\t\"revision_id\": 24,\n\t\t\t\t\t\t\"management_id\": 5,\n\t\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"rule_modifications\": {\n\t\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}","collectionId":"2","id":"2-23-152","method":"PUT"},{"headers":"Accept: application/json\n","name":"Returns the details of a specified task","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"params","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
taskId: The ID number of the task as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2?expand_links=true

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.
404: Task with ID was not found in Stage ID in ticket ID .","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}","collectionId":"2","id":"2-23-153","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Modify the Designer suggestions for Access Request or Clone Server Policy","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"instructionId"}],"dataMode":"raw","description":" GENERAL USE
1. Create a ticket using UI/API.
2. Run the designer using UI/API.
3. Use relevent API to get the designer results.
4. Run this API to modify the required parameters.

*Note: you can modify one parameter at a time.

Change rule location use
a. Modifying the rule order places the new rule before the rule with the specified identifier (rule name or number).
b. Modifying the rule placement to \"last\" places the new rule as last rule or last pre-rule (depending on the vendor convention for the device).
c. For vendors that support \"after\" placement, modifying the rule placement allows positioning the new rule before or after the suggested rule location.

track level permitted values:
NONE, LOG, ACCOUNT, ALERT, SNMP, MAIL, USER_DEFINED, EMERGENCIES, ALERTS, CRITICAL, ERRORS, WARNINGS, NOTIFICATIONS, INFORMATIONAL, DEBUGGING, DISABLED, DEFAULT, FULL_LOG, NETWORK_LOG, USER_ALERT_1, USER_ALERT_2, USER_ALERT_3

rule placement permitted values:
BEFORE, AFTER, LAST

Parameters:
body: DesignerInstructionChangeDTO
id: Ticket ID
taskId: Task ID
instructionId: Instruction ID
force: force update when new revision available [optional]

Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"comment\": {\"new_value\":\"new comment\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196?force=true
BODY{
    \"comment\": {\"new_value\":\"new comment\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_name\": {\"new_value\":\"new rule name\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"track_level\": {\"new_value\":\"LOG\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"object_name\": {\"new_value\":\"new object name\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"log_forwarding_profile\": {\"new_value\":\"new log forwarding profile\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"security_profile_group\": {\"new_value\":\"new security profile group\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"object_replace\": {
             \"new_value\":\"new object uid\",
             \"old_value\":\"old object uid\"
    }
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_order\": {\"new_value\":\"8\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_placement\": {\"new_value\":\"last\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_placement\": {\"new_value\":\"before\"}
}


Response Messages:
200: New rule will be shadowed
200: New rule will be shadowed or break acceleration
400: Modify Designer Results API is only supported for Access Request and Clone Server Policy workflows
412: Current instruction cannot be modified because either the implementation was successful or failed irrevocably.
412: Current step does not support Designer modification action
400: A ticket with ID <ID> cannot be found.
400: Task ID <ID> cannot be found in the current step with ID <ID>.
403: Changing <TYPE> is not supported on this device
403: This Change is not supported for <INSTRUCTION TYPE> instruction type\"
401: You do not have permission to update this task. Contact your administrator for assistance.
403: New revision is available, cannot modify the Designer results
404: Specified instruction, id: <ID> was not found
404: Designer results were not found in the access request.
400: a valid object name must start with an alphanumeric character and can contain alphanumeric characters, underscore '_'. Hypen '-', dot '.' or spaces
400: For this device, the comment must be less than 100 characters per line.
400: For this device, this field must be less than <NUMBER OF CHARACTERS> characters
400: For this device, this field is required.
400: For this device, a valid object name cannot be <OBJECT NAME> because it is a reserved word
409: Rule name already exists for this device. Please give this rule a unique name.
409: Rule name <NAME> already exists in the device group hierarchy. Choose a unique name for this rule.
400: Comment contains invalid characters.
400: <DEVICE> does not support tracking level <TRACKING LEVEL>
400: <TRACKING LEVEL> is not a valid rule track level value
400: a valid object name cannot contain any of the following characters: <CHARACTERS>
400: a valid object name must be less than <NUMBER OF CHARACTERS> characters
400: a valid object name cannot be empty
400: a valid object name must conform to the following pattern: <STRING PATTERN>
409: Object already exists
400: A security profile group cannot be empty.
404: The security profile group <SECURITY PROFILE GROUP> was not found.
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to validate the security profile group.
400: A log forwarding profile cannot be empty.
404: The log forwarding profile <LOG FORWARDING PROFILE> was not found.
500: An error occurred in SecureTrack while trying to validate the log forwarding profile.
400: Object UID <OLD OBJECT UID> not found in the rule for this instruction.
400: Values of new object UID <NEW OBJECT UID> and old object UID <OLD OBJECT UID> do not match.
400: Rule placement can only be: \"before\", \"after\" or \"last\".
400: You can't change rule placement when there is no rule order. please add rule order first.
400: You can't change rule placement to \"After\" for this type of device.
400: You can't change rule placement to \"Last\" for this type of device.","folder":"2-23","rawModeData":"{\n\t\"rule_placement\": {\"new_value\":\"before\"}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/tasks/{{taskId}}/designer/instruction/{{instructionId}}","collectionId":"2","id":"2-23-154","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get rule decommision verifier results","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/rule_decommission/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type <TYPE>.
404: Verifier results were not found in the request.","dataMode":"params","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/rule_decommission/verifier","collectionId":"2","id":"2-23-155","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Change a field within a task of a ticket at the current step","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"dataMode":"raw","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldDTO
id: Ticket ID
taskId: Task ID
fieldId: Field ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields/7642
BODY<field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"approve_reject\">
         <id>7661</id>
         <name>approve access</name>
         <approved>true</approved>
         <reason>Request approved</reason>
    </field>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields/71
BODY{
    \"rule_modification_field\": {
        \"devices\": {
            \"device\": {
                \"management_id\": 5,
                \"bindings\": {
                    \"binding\": {
                        \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                        \"binding\": {
                            \"@xsi.type\": \"policy__binding\",
                            \"policy_name\": \"FortiGate-VM64-111-10_3\"
                        },
                        \"rules\": {
                            \"rule\": {
                                \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                            }
                        }
                    }
                }
            }
        },
        \"rule_modifications\": {
            \"rule_modification\": {
                \"@xsi.type\": \"modify_rule_modification\",
                \"rule_key\": {
                    \"device_id\": 5,
                    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                    \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                },
                \"source_modifications\": {
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                            \"name\": \"NET_1\",
                                            \"comment\": \"\",
                                            \"ip\": \"3.3.3.3\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                            \"name\": \"RANGE_1\",
                                            \"comment\": \"EXAMPLE_RANGE\",
                                            \"min_ip\": \"3.3.3.3\",
                                            \"max_ip\": \"5.5.5.5\"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                \"destination_modifications\": {
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"name\": \"Host123\",
                                            \"comment\": \"cccHost\",
                                            \"ip\": \"1.2.3.4\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"action\": \"REMOVE\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                    }
                                }
                            }
                        ]
                    }
                },
                \"service_modifications\": {
                    \"service_object_cell_modifications\": {
                        \"service_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                        \"name\": \"TCP_1\",
                                        \"comment\": \"EXAMPLE_TCP\",
                                        \"port\": {
                                            \"from\": 1234,
                                            \"to\": 1234
                                        },
                                        \"protocol\": \"TCP\"
                                    }
                                }
                            },
                            {
                                \"action\": \"REMOVE\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"uid\": \"551556da-22dc-46f4-9253-a7ceee70394b\",
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                        \"name\": \"UDP_1\",
                                        \"comment\": \"EXAMPLE_UDP\",
                                        \"port\": {
                                            \"from\": 3,
                                            \"to\": 3
                                        },
                                        \"protocol\": \"UDP\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                        \"name\": \"ICMP_1\",
                                        \"comment\": \"EXAMPLE_ICMP\",
                                        \"type\": {
                                            \"from\": 55,
                                            \"to\": 55
                                        }
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                    }
                                }
                            }
                        ]
                    }
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value","folder":"2-23","rawModeData":"{\n\t\"rule_modification_field\": {\n\t\t\"devices\": {\n\t\t\t\"device\": {\n\t\t\t\t\"management_id\": 5,\n\t\t\t\t\"bindings\": {\n\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t\"rule_modifications\": {\n\t\t\t\"rule_modification\": {\n\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t},\n\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"uid\": \"551556da-22dc-46f4-9253-a7ceee70394b\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/fields/{{fieldId}}","collectionId":"2","id":"2-23-156","method":"PUT"}],"order":[],"name":"Tufin Tufin SecureChange/SecureApp R20-1-GA","id":"2","description":"Tufin Orchestration Suite - Tufin SecureChange/SecureApp APIs.
For detailed information about the APIs please see the documentation at:
https://your-securetrack-server/securechangeworkflow/apidoc"} \ No newline at end of file diff --git a/Postman Format v1/R20-1 postman collection/securetrack_R20-1-GA.json b/Postman Format v1/R20-1 postman collection/securetrack_R20-1-GA.json new file mode 100644 index 0000000..6a2ac51 --- /dev/null +++ b/Postman Format v1/R20-1 postman collection/securetrack_R20-1-GA.json @@ -0,0 +1 @@ +{"folders":[{"order":["1-1-1","1-1-2","1-1-3","1-1-4"],"collectionId":"1","name":"Additional Policy Fields","hasRequests":true,"id":"1-1"},{"order":["1-2-5","1-2-6","1-2-7","1-2-8"],"collectionId":"1","name":"Application IDs","hasRequests":true,"id":"1-2"},{"order":["1-3-9","1-3-10"],"collectionId":"1","name":"Change Authorization","hasRequests":true,"id":"1-3"},{"order":["1-4-11","1-4-12","1-4-13"],"collectionId":"1","name":"Change Windows","hasRequests":true,"id":"1-4"},{"order":["1-5-14","1-5-15","1-5-16","1-5-17","1-5-18"],"collectionId":"1","name":"Device Interfaces and Zones","hasRequests":true,"id":"1-5"},{"order":["1-6-19","1-6-20","1-6-21","1-6-22"],"collectionId":"1","name":"Domains","hasRequests":true,"id":"1-6"},{"order":["1-7-23"],"collectionId":"1","name":"General Properties","hasRequests":true,"id":"1-7"},{"order":["1-8-24","1-8-25","1-8-26","1-8-27"],"collectionId":"1","name":"IPsec VPN","hasRequests":true,"id":"1-8"},{"order":["1-9-28","1-9-29","1-9-30","1-9-31","1-9-32"],"collectionId":"1","name":"Internet Objects","hasRequests":true,"id":"1-9"},{"order":["1-10-33","1-10-34","1-10-35","1-10-36"],"collectionId":"1","name":"LDAP","hasRequests":true,"id":"1-10"},{"order":["1-11-37","1-11-38","1-11-39","1-11-40","1-11-41","1-11-42","1-11-43","1-11-44","1-11-45","1-11-46","1-11-47"],"collectionId":"1","name":"Monitored Devices","hasRequests":true,"id":"1-11"},{"order":["1-12-48","1-12-49","1-12-50"],"collectionId":"1","name":"NAT Policies","hasRequests":true,"id":"1-12"},{"order":["1-13-51","1-13-52","1-13-53","1-13-54","1-13-55","1-13-56","1-13-57"],"collectionId":"1","name":"Network Objects","hasRequests":true,"id":"1-13"},{"order":["1-14-58","1-14-59","1-14-60","1-14-61","1-14-62","1-14-63","1-14-64","1-14-65","1-14-66","1-14-67","1-14-68","1-14-69","1-14-70","1-14-71","1-14-72","1-14-73","1-14-74","1-14-75","1-14-76","1-14-77","1-14-78","1-14-79","1-14-80","1-14-81","1-14-82","1-14-83","1-14-84","1-14-85","1-14-86","1-14-87","1-14-88","1-14-89","1-14-90","1-14-91","1-14-92","1-14-93","1-14-94","1-14-95","1-14-96","1-14-97","1-14-98","1-14-99","1-14-100","1-14-101","1-14-102","1-14-103","1-14-104","1-14-105","1-14-106","1-14-107","1-14-108","1-14-109","1-14-110","1-14-111","1-14-112","1-14-113","1-14-114"],"collectionId":"1","name":"Network Topology","hasRequests":true,"id":"1-14"},{"order":["1-15-115","1-15-116","1-15-117"],"collectionId":"1","name":"Network Zone Manager - Patterns","hasRequests":true,"id":"1-15"},{"order":["1-16-118","1-16-119","1-16-120","1-16-121","1-16-122","1-16-123","1-16-124"],"collectionId":"1","name":"Network Zone Manager - Subnets","hasRequests":true,"id":"1-16"},{"order":["1-17-125","1-17-126","1-17-127","1-17-128","1-17-129","1-17-130","1-17-131","1-17-132","1-17-133","1-17-134","1-17-135","1-17-136","1-17-137","1-17-138","1-17-139","1-17-140"],"collectionId":"1","name":"Network Zone Manager - Zones","hasRequests":true,"id":"1-17"},{"order":["1-18-141","1-18-142","1-18-143","1-18-144","1-18-145","1-18-146"],"collectionId":"1","name":"Policies and Sub-Policies","hasRequests":true,"id":"1-18"},{"order":["1-19-147"],"collectionId":"1","name":"Policy Analysis","hasRequests":true,"id":"1-19"},{"order":["1-20-148","1-20-149","1-20-150","1-20-151","1-20-152","1-20-153"],"collectionId":"1","name":"Policy Browser (formerly Rule Documentation)","hasRequests":true,"id":"1-20"},{"order":["1-21-154","1-21-155","1-21-156","1-21-157","1-21-158","1-21-159","1-21-160","1-21-161"],"collectionId":"1","name":"Policy Optimization","hasRequests":true,"id":"1-21"},{"order":["1-22-162","1-22-163","1-22-164"],"collectionId":"1","name":"Revisions","hasRequests":true,"id":"1-22"},{"order":["1-23-165","1-23-166"],"collectionId":"1","name":"Rule Usage","hasRequests":true,"id":"1-23"},{"order":["1-24-167","1-24-168","1-24-169","1-24-170","1-24-171","1-24-172","1-24-173","1-24-174"],"collectionId":"1","name":"Security Rules","hasRequests":true,"id":"1-24"},{"order":["1-25-175","1-25-176","1-25-177","1-25-178","1-25-179","1-25-180","1-25-181"],"collectionId":"1","name":"Services and Ports","hasRequests":true,"id":"1-25"},{"order":["1-26-182","1-26-183","1-26-184"],"collectionId":"1","name":"Time Objects","hasRequests":true,"id":"1-26"},{"order":["1-27-185"],"collectionId":"1","name":"Traffic Policy Matcher","hasRequests":true,"id":"1-27"},{"order":["1-28-186","1-28-187","1-28-188","1-28-189","1-28-190"],"collectionId":"1","name":"Unified Security Policy - Access Request Violations","hasRequests":true,"id":"1-28"},{"order":["1-29-191","1-29-192","1-29-193","1-29-194","1-29-195"],"collectionId":"1","name":"Unified Security Policy - Alerts","hasRequests":true,"id":"1-29"},{"order":["1-30-196","1-30-197","1-30-198","1-30-199","1-30-200","1-30-201","1-30-202","1-30-203"],"collectionId":"1","name":"Unified Security Policy - Cloud Tag Policy","hasRequests":true,"id":"1-30"},{"order":["1-31-204","1-31-205","1-31-206","1-31-207","1-31-208","1-31-209","1-31-210","1-31-211"],"collectionId":"1","name":"Unified Security Policy - Exceptions","hasRequests":true,"id":"1-31"},{"order":["1-32-212","1-32-213","1-32-214","1-32-215","1-32-216"],"collectionId":"1","name":"Unified Security Policy - Security Zone Matrix","hasRequests":true,"id":"1-32"},{"order":["1-33-217","1-33-218"],"collectionId":"1","name":"Unified Security Policy - Violations","hasRequests":true,"id":"1-33"}],"requests":[{"headers":"Accept: application/json\n","name":"Get additional parameters identities by revision","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"}],"dataMode":"params","description":"Some firewall vendors use special fields in their security policy.
For example: Palo Alto uses Tags, Security Profiles and Log Profiles and Fortinet uses NAT Pools and other NAT configurations.
SecureTrack refers to these fields as “Additional Parameters”.
The additional parameters API retrieves the possible values of these fields.
This API is currently supported for Palo Alto Networks firewalls and Fortinet devices managed by Fortimanager.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
type: Additional parameter type [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/162/additional_parameters?type=security_profile_group

Response Messages:
200: Successful
400: Invalid request","folder":"1-1","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/additional_parameters","collectionId":"1","id":"1-1-1","method":"GET"},{"headers":"Accept: application/json\n","name":"Get all URL Categories by revision.","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"}],"dataMode":"params","description":"Fetches list of URL Categories defined in a revision given by ID.
This API is supported for Panorama in advanced mode and Panorama Device Groups.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/762/url_categories
","folder":"1-1","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/url_categories","collectionId":"1","id":"1-1-2","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific additional parameter identity","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Some firewall vendors use special fields in their security policy.
For example: Palo Alto uses Tags, Security Profiles and Log Profiles and Fortinet uses NAT Pools and other NAT configurations.
SecureTrack refers to these fields as “Additional Parameters”.
The additional parameters API retrieves the possible values of these fields.
This API is currently supported for Palo Alto Networks firewalls and Fortinet devices managed by Fortimanager.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Additional parameter IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/revisions/162/additional_parameters/242767,242768,242760
","folder":"1-1","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/additional_parameters/{{ids}}","collectionId":"1","id":"1-1-3","method":"GET"},{"headers":"Accept: application/json\n","name":"Get a URL Category.","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches one or more URL Categories.
This API is supported for Panorama in advanced mode and Panorama Device Groups.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Url Category IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/revisions/762/url_categories/242767,242768,242760
","folder":"1-1","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/url_categories/{{ids}}","collectionId":"1","id":"1-1-4","method":"GET"},{"headers":"Accept: application/json\n","name":"Get applications identities by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of applications defined in a revision given by ID.
This API is currently supported for Palo Alto Networks firewalls.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.
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.


Parameters:
context: Global MSSP context [optional]
id: Revision id
start: Starting page for query allowable value is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/762/applications?get_total=true
OUTPUT {
    \"applications\": {
        \"count\": 1,
        \"total\": 100,
        \"application\": [{
            \"@xsi.type\": \"singleApplicationDTO\",
            \"id\": 2095027,
            \"name\": \"any\",
            \"display_name\": \"any\",
            \"class_name\": \"application_object\",
            \"comment\": \"\",
            \"uid\": \"{61B7771C-8B0B-90D6-ED55-B6698691BEED}\",
            \"overrides\": false,
            \"service\": {
                \"id\": 5048925,
                \"uid\": \"{4BC8F8B5-7671-A61B-5DD2-8CA235955162}\",
                \"display_name\": \"any\",
                \"name\": \"any\"
            }
        }]
    }
}

","folder":"1-2","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/applications","collectionId":"1","id":"1-2-5","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific application identity","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches one or more applications defined by a revision ID and Application Id or comma separated applications ids list.
This API is currently supported for Palo Alto Networks firewalls.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.


Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Application IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/revisions/762/applications/242767,242768,242760
","folder":"1-2","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/applications/{{ids}}","collectionId":"1","id":"1-2-6","method":"GET"},{"headers":"Accept: application/json\n","name":"Get application identities by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of applications defined on device given by ID.
This API is currently supported for Palo Alto Networks firewalls.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.
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.


Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable values are numeric [optional]
count: Number of pages for query allowable values are numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/applications?get_total=true
OUTPUT {
    \"applications\": {
        \"count\": 50,
        \"total\": 100,
        \"application\": [{
            \"@xsi.type\": \"singleApplicationDTO\",
            \"id\": 2095027,
            \"name\": \"any\",
            \"display_name\": \"any\",
            \"class_name\": \"application_object\",
            \"comment\": \"\",
            \"uid\": \"{61B7771C-8B0B-90D6-ED55-B6698691BEED}\",
            \"overrides\": false,
            \"service\": {
                \"id\": 5048925,
                \"uid\": \"{4BC8F8B5-7671-A61B-5DD2-8CA235955162}\",
                \"display_name\": \"any\",
                \"name\": \"any\"
            }
        }]
    }
}

","folder":"1-2","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/applications","collectionId":"1","id":"1-2-7","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific application identity","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches one or more applications defined by a device ID and Application Id or comma separated applications ids list.
This API is currently supported for Palo Alto Networks firewalls.
Note: This API retrieves the information from the latest revision.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.


Parameters:
context: Global MSSP context [optional]
id: Device ID
ids: Application IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/devices/1/applications/701
","folder":"1-2","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/applications/{{ids}}","collectionId":"1","id":"1-2-8","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Compare revisions on two different devices in terms of traffic.","dataMode":"raw","description":"This API compares two arbitrary revisions from any devices. The comparison will be done in terms of allowed/denied traffic.
The API returns authorized if and only if there are no differences between the traffic allowed/denied by the rules in the two revisions.
The API returns unauthorized if there is at least one difference in terms of allowed/denied traffic between the two revisions.
Note 1: To map policies from one revision to the other use oldId2newIdMap and provide the UIDs of the policies to be compared.
Note 2: Parameter in the request body specifies if the result will return traffic difference details for all incompatible rules
Note 3: The format of the result is the same as the one returned by /change_authorization
Note 4: The API accepts in request body only one pair of oldId - newId map
Note 5: The request is valid only if the mapping ids are found in the active policies

Parameters:
body: Request parameter containing the versions of the revisions to be compared and the policy mapping between the revisions.

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_authorization/policyTrafficComparison
BODY{
    \"policy_traffic_comparison_request\": {
        \"oldVersionId\": \"234\",
        \"newVersionId\": \"179\",
        \"oldId2newIdMap\": [
            {
                \"oldId\": \"{037DEA62-A8D2-46F5-8DC9-DA404A60B96F}\",
                \"newId\" : \"{00-FACED0-00}\"
            }
        ],
        \"withTraffic\": true
    }
}


Response Messages:
200: Policies diff was successfully calculated
400: Could not find the requested revisions for comparison","folder":"1-3","rawModeData":"{\n\t\"policy_traffic_comparison_request\": {\n\t\t\"oldVersionId\": \"234\",\n\t\t\"newVersionId\": \"179\",\n\t\t\"oldId2newIdMap\": [\n\t\t\t{\n\t\t\t\t\"oldId\": \"{037DEA62-A8D2-46F5-8DC9-DA404A60B96F}\",\n\t\t\t\t\"newId\" : \"{00-FACED0-00}\"\n\t\t\t}\n\t\t],\n\t\t\"withTraffic\": true\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/change_authorization/policyTrafficComparison","collectionId":"1","id":"1-3-9","method":"POST"},{"headers":"Accept: application/json\n","name":"Determine if changes between two revisions are authorized","data":[{"value":null,"type":"text","enabled":true,"key":"new_version"},{"value":null,"type":"text","enabled":true,"key":"old_version"}],"dataMode":"params","description":"This API checks for unauthorized changes between any two versions of a firewall policy.
The API returns authorized if and only if all traffic changes between the two versions were authorized by SecureChange tickets.
The API returns unauthorized if there is at least one change that cannot be matched to a SecureChange ticket.

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).
The API returns the authorization status, the relevant tickets in SecureChange and the rules that implement unauthorized access changes.

Note 1: To use this API you must enable “Authorize Revisions with Tickets” in SecureTrack/Configuration/Ticketing.
Note 2: Use the ID returned by the /revisions API for new_version and old_version.
Note 3: The default value for traffic_details and ignore_tickets is false.
Note 4: Traffic that is handled by an implicit rule will not have a rule ID.

Parameters:
new_version: New version ID
old_version: Old version ID
traffic_details: Return unauthorized traffic change details for all modified rules [optional]
ignore_tickets: Ignore SecureChange tickets and consider all traffic changes unauthorized [optional]

Usage Example
https://192.168.1.1/securetrack/api/change_authorization?old_version=1&new_version=2

Usage Example
https://192.168.1.1/securetrack/api/change_authorization?old_version=1&new_version=2&traffic_details=true&ignore_tickets=true

Response Messages:
200: Change authorization has been successfully calculated
400: Input parameters are not valid
400: Could not find the requested revisions for comparison","folder":"1-3","url":"https://{{SecureTrack_IP}}/securetrack/api/change_authorization/","collectionId":"1","id":"1-3-10","method":"GET"},{"headers":"Accept: application/json\n","name":"Get a list of completed policy changes for a specific change window","data":[{"value":null,"type":"text","enabled":true,"key":"uid"}],"dataMode":"params","description":"Retrieves a list of completed policy changes for a specific change window.
For valid pagination, both start and count should be provided. Otherwise, pagination is turned off.
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.


Parameters:
context: Global MSSP context [optional]
uid: Change window uuid
start: Starting result for query allowable value is numeric [optional]
count: Number of tasks for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_windows/fc7b167c-29ea-49a1-9ee3-efb6d1351343/tasks?start=0&count=50&get_total=true
OUTPUT {
    \"commit_tasks\": {
        \"count\": 1,
        \"total\": 1,
        \"commit_task\": {
            \"id\": 1,
            \"start_date\": \"04-Nov-2018 01:30:00PM +0200\",
            \"end_date\": \"04-Nov-2018 01:32:01PM +0200\",
            \"errors\": \"\"
        }
    }
}


Response Messages:
200: OK
400: For correct pagination provide a value for the start and count parameters
400: Start parameter must be a non-negative value
400: Count parameter must be a positive value
401: Not permitted to access this context
404: Change window with uuid was not found
404: Change window with uuid was not found in domain ","folder":"1-4","url":"https://{{SecureTrack_IP}}/securetrack/api/change_windows/{{uid}}/tasks","collectionId":"1","id":"1-4-11","method":"GET"},{"headers":"Accept: application/json\n","name":"Get scheduling and device details for a specific change window","data":[{"value":null,"type":"text","enabled":true,"key":"uid"},{"value":null,"type":"text","enabled":true,"key":"task_id"}],"dataMode":"params","description":"Retrieves scheduling and device details for a specific change window.

Parameters:
context: Global MSSP context [optional]
uid: Change window uuid
task_id: Task Id

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_windows/fc7b167c-29ea-49a1-9ee3-efb6d1351343/tasks/1
OUTPUT {
    \"commit_task\": {
        \"id\": 1,
        \"start_date\": \"04-Nov-2018 01:30:00PM +0200\",
        \"end_date\": \"04-Nov-2018 01:32:01PM +0200\",
        \"errors\": \"\",
        \"device_commits\": {
            \"device_commit\": [
                {
                    \"id\": 1,
                    \"result\": {
                        \"errors\": {
                            \"error\": \"got_error_from_dcs\"
                        },
                        \"device\": {
                            \"id\": 17,
                            \"status\": \"FAILURE\",
                            \"revision_id\": 1,
                            \"errors\": {
                                \"error\": \"Login error\"
                            }
                        }
                    }
                },
                {
                    \"id\": 2,
                    \"result\": {
                        \"errors\": \"\",
                        \"device\": {
                            \"id\": 19,
                            \"status\": \"SUCCESS_WITH_WARNINGS\",
                            \"revision_id\": 1,
                            \"warnings\": {
                                \"warning\": \"Commit not performed: This device had no policies to install on its managed firewalls\"
                            }
                        }
                    }
                }
            ]
        }
    }
}


Response Messages:
200: OK
400: For correct pagination provide a value for the start and count parameters
400: Start parameter must be a non-negative value
400: Count parameter must be a positive value
401: Not permitted to access this context
404: Change window with uuid was not found
404: Change window with uuid was not found in domain
404: Fail to find task for change window ","folder":"1-4","url":"https://{{SecureTrack_IP}}/securetrack/api/change_windows/{{uid}}/tasks/{{task_id}}","collectionId":"1","id":"1-4-12","method":"GET"},{"headers":"Accept: application/json\n","name":"Get name and status for all change windows","description":"Retrieves a list of all change windows.
For valid pagination, both start and count should be provided. Otherwise, pagination is turned off.
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.


Parameters:
context: Global MSSP context [optional]
start: Starting result for query allowable value is numeric [optional]
count: Number of change windows for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_windows?start=0&count=50&get_total=true
OUTPUT {
    \"change_windows\": {
        \"count\": 2,
        \"total\": 2,
        \"change_window\": [
            {
                \"uuid\": \"6ae41504-a95c-4f23-98a2-f18b2efadb9d\",
                \"name\": \"cw1\",
                \"domain_id\": 1,
                \"enabled\": true
            },
            {
                \"uuid\": \"fc7b167c-29ea-49a1-9ee3-efb6d1351343\",
                \"name\": \"cw2\",
                \"domain_id\": 1,
                \"enabled\": true
            }
        ]
    }
}


Response Messages:
200: OK
400: For correct pagination provide a value for the start and count parameters
400: Start parameter must be a non-negative value
400: Count parameter must be a positive value
401: Not permitted to access this context ","folder":"1-4","url":"https://{{SecureTrack_IP}}/securetrack/api/change_windows/","collectionId":"1","id":"1-4-13","method":"GET"},{"headers":"Accept: application/json\n","name":"Get device zones by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns a list of the zones for the specified Juniper, Stonesoft, Fortinet or Palo Alto Networks revision.
Note: this API returns device zones, not Tufin zones.

Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/787/zones
","folder":"1-5","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/zones","collectionId":"1","id":"1-5-14","method":"GET"},{"headers":"Accept: application/json\n","name":"Get network interfaces by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Reflects static data from the running-config.
For dynamic information see the /topology_interfaces API.
This API is not applicable for Check Point.

Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/227/interfaces
","folder":"1-5","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/interfaces","collectionId":"1","id":"1-5-15","method":"GET"},{"headers":"Accept: application/json\n","name":"Get device zones by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns a list of the zones for the specified Juniper, Stonesoft, Fortinet or Palo Alto Networks device.
Note: this API returns device zones, not Tufin zones.

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/104/zones
","folder":"1-5","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/zones","collectionId":"1","id":"1-5-16","method":"GET"},{"headers":"Accept: application/json\n","name":"Get zones and network interfaces that participate in sub-policies","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/104/bindable_objects
","dataMode":"params","folder":"1-5","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/bindable_objects","collectionId":"1","id":"1-5-17","method":"GET"},{"headers":"Accept: application/json\n","name":"Get network interfaces by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Reflects static data from the running-config.
For dynamic information see the /topology_interfaces API.
This API is not applicable for Check Point.

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/10/interfaces
","folder":"1-5","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/interfaces","collectionId":"1","id":"1-5-18","method":"GET"},{"headers":"Accept: application/json\n","name":"Get domain","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
context: Global MSSP context [optional]
id: Domain id

Usage Example
https://192.168.1.1/securetrack/api/domains/1

Response Messages:
401: User not permitted to access domains
400: Domain with ID was not found","dataMode":"params","folder":"1-6","url":"https://{{SecureTrack_IP}}/securetrack/api/domains/{{id}}","collectionId":"1","id":"1-6-19","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Update a domain","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
id: Domain id
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/domains/2
BODY{
    \"domain\": {
        \"name\": \"edited name\",
        \"address\": \"edited address\",
        \"description\": \"edited description\"
    }
}


Response Messages:
401: User not permitted to access domains
400: Domain with ID was not found
400: Domain with this name already exists
400: Domain name is empty
400: Default domain cannot be changed","dataMode":"raw","folder":"1-6","rawModeData":"{\n\t\"domain\": {\n\t\t\"name\": \"edited name\",\n\t\t\"address\": \"edited address\",\n\t\t\"description\": \"edited description\"\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/domains/{{id}}","collectionId":"1","id":"1-6-20","method":"PUT"},{"headers":"Content-Type: application/json\n","name":"Add a domain","dataMode":"raw","description":"Parameters:
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/domains
BODY{
    \"domain\": {
        \"name\": \"domain1\",
        \"address\": \"address\",
        \"description\": \"description\"
    }
}


Response Messages:
401: User not permitted to access domains
400: Domain with this name already exists
400: Domain name is empty","folder":"1-6","rawModeData":"{\n\t\"domain\": {\n\t\t\"name\": \"domain1\",\n\t\t\"address\": \"address\",\n\t\t\"description\": \"description\"\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/domains/","collectionId":"1","id":"1-6-21","method":"POST"},{"headers":"Accept: application/json\n","name":"Get all domains","description":"

Usage Example
https://192.168.1.1/securetrack/api/domains

Response Messages:
401: User not permitted to access domains","folder":"1-6","url":"https://{{SecureTrack_IP}}/securetrack/api/domains/","collectionId":"1","id":"1-6-22","method":"GET"},{"headers":"Accept: application/json\n","name":"Get general properties","description":"This API requires 'Super admin' privileges



Usage Example
URLhttps://192.168.1.1/securetrack/api/properties
OUTPUT{
    \"properties\": {
        \"sc_addresses\": {
            \"sc_address\": [
                {
                    \"ip_address\": \"127.0.0.1\",
                    \"type\": \"external\"
                },
                {
                    \"ip_address\": \"127.0.0.1\",
                    \"type\": \"internal\"
                }
            ]
        }
    }
}


Response Messages:
401: User not permitted to view properties","folder":"1-7","url":"https://{{SecureTrack_IP}}/securetrack/api/properties/","collectionId":"1","id":"1-7-23","method":"GET"},{"headers":"Accept: application/json\n","name":"Get Cisco cryptographic maps by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://191.168.1.1/securetrack/api/revisions/18/crypto_maps
","dataMode":"params","folder":"1-8","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/crypto_maps","collectionId":"1","id":"1-8-24","method":"GET"},{"headers":"Accept: application/json\n","name":"Get Check Point VPN (IPSec) communities and gateways","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"}],"dataMode":"params","description":"Get Check Point VPN (IPSec) Communities and gateways that partcipant in those communities.
Works on clusters and gateways, not on management servers.

Parameters:
device_id: The unique identifier of target device

Usage Example
https://192.168.1.1/securetrack/api/bindings/20/ipsec_communities
","folder":"1-8","url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/ipsec_communities","collectionId":"1","id":"1-8-25","method":"GET"},{"headers":"Accept: application/json\n","name":"Get Cisco IPsec policy and peers","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"outputInterfaceName"}],"dataMode":"params","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.
You can retrieve the interface names by calling the /devices/id/interfaces API.

Parameters:
device_id: The unique identifier of target device
outputInterfaceName: Interface name

Usage Example
https://192.168.1.1/securetrack/api/bindings/32/ipsec_tunnels?outputInterfaceName=GigabitEthernet1
","folder":"1-8","url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/ipsec_tunnels","collectionId":"1","id":"1-8-26","method":"GET"},{"headers":"Accept: application/json\n","name":"Get Cisco cryptographic maps by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/19/crypto_maps
","dataMode":"params","folder":"1-8","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/crypto_maps","collectionId":"1","id":"1-8-27","method":"GET"},{"name":"Get resolved Internet representation for device","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"}],"dataMode":"params","description":"The order of precedence used to resolve the Internet object is:
Step 1: Identify the Internet referral:
Search for a defined Internet referral on the specified device.
If it is not found on the device, search the parent and grandparents (up the device tree) for a defined Internet referral.
If a defined Internet referral is found, then match the name in the Internet referral to a network object, as defined in Step 2.
If an Internet referral is not found, it resolves to “Any”.
Step 2: Resolve the object by name:
Search the specified device for a defined network object that matches the name returned in Step 1.
If a matching network object is not found, an error will be returned.

Parameters:
deviceId: SecureTrack Device ID

Usage Example
https://192.168.1.1/securetrack/api/internet_referral/2/object

Response Messages:
200: Resolved Internet referral object for device is returned
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
404: Configured object was not found on the device
401: Access is denied.","folder":"1-9","url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}/object","collectionId":"1","id":"1-9-28","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Update Internet representation for device","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"}],"dataMode":"raw","description":"Updates the Internet referral configuration for the device.
If there was no previous configuration, it will be created.

Parameters:
deviceId: SecureTrack Device ID
body: Internet referral configuration

Usage Example
URLhttps://192.168.1.1/securetrack/api/internet_referral
BODY{
    \"internet_referral\": {
        \"@xsi.type\": \"internetReferralObjectNameDTO\",
        \"device_id\": 2,
        \"object_name\": \"Host_10.11.73.1\"
    }
}


Response Messages:
200: Internet referral configuration was updated
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
400: Internet referral configuration was malformed
401: Access is denied.","folder":"1-9","rawModeData":"{\n\t\"internet_referral\": {\n\t\t\"@xsi.type\": \"internetReferralObjectNameDTO\",\n\t\t\"device_id\": 2,\n\t\t\"object_name\": \"Host_10.11.73.1\"\n\t}\n}\n","url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}","collectionId":"1","id":"1-9-29","method":"PUT"},{"name":"Get Internet representation for device","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"}],"description":"Parameters:
deviceId: SecureTrack Device ID

Usage Example
https://192.168.1.1/securetrack/api/internet_referral/2

Response Messages:
200: Internet referral configuration is returned
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
404: Internet referral configuration was not found for device ID
401: Access is denied.","dataMode":"params","folder":"1-9","url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}","collectionId":"1","id":"1-9-30","method":"GET"},{"name":"Delete Internet representation for device","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"}],"description":"Parameters:
deviceId: SecureTrack Device ID

Usage Example
https://192.168.1.1/securetrack/api/internet_referral/2

Response Messages:
200: Internet referral configuration was deleted
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
400: Internet referral configuration for device ID does not exist
401: Access is denied.","dataMode":"params","folder":"1-9","url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}","collectionId":"1","id":"1-9-31","method":"DELETE"},{"headers":"Content-Type: application/json\n","name":"Create new Internet representation for a device","dataMode":"raw","description":"The internet referral lets you represent the Internet as an object on a device.
See REST API: /internet_referral/{deviceId:[0-9]+}/object for a description of how internet referral is resolved.

Parameters:
body: Internet referral configuration

Usage Example
URLhttps://192.168.1.1/securetrack/api/internet_referral
BODY{
    \"internet_referral\": {
        \"@xsi.type\": \"internetReferralObjectNameDTO\",
        \"device_id\": 2,
        \"object_name\": \"Host_2.2.2.2\"
    }
}


Response Messages:
201: Internet referral configuration was created
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
400: Internet referral configuration was malformed
400: Internet referral configuration for given device ID already exists
401: Access is denied.","folder":"1-9","rawModeData":"{\n\t\"internet_referral\": {\n\t\t\"@xsi.type\": \"internetReferralObjectNameDTO\",\n\t\t\"device_id\": 2,\n\t\t\"object_name\": \"Host_2.2.2.2\"\n\t}\n}\n","url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/","collectionId":"1","id":"1-9-32","method":"POST"},{"headers":"Accept: application/json\n","name":"Get LDAP entry details by DN","data":[{"value":null,"type":"text","enabled":true,"key":"dn"}],"dataMode":"params","description":"Returns the UID, DN and Name of a LDAP entry specified by the DN.

Parameters:
dn: LDAP DN

Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/getEntryByDN?dn=CN=Manufacturing,OU=RSA_Demo,DC=tufintest,DC=com
OUTPUT{
    \"ldap_entry\": {
        \"uid\": \"mYbWQms7p0q5YinEyW5Byw==\",
        \"dn\": \"CN=Manufacturing,OU=RSA_Demo,DC=tufintest,DC=com\",
        \"name\": \"Manufacturing\"
    }
}


Response Messages:
200: OK
400: Invalid DN format
404: Entry matching the DN cannot be found
501: LDAP server is not configured
503: No connection to LDAP server","folder":"1-10","url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/getEntryByDN","collectionId":"1","id":"1-10-33","method":"GET"},{"headers":"Accept: application/json\n","name":"Get the base DN entry details","description":"The returned \"base DN\" is used by GetEntriesByNames API as the search start entry.



Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/getBaseDNEntry
OUTPUT{
    \"ldap_entry\": {
        \"dn\": \"DC=tufintest,DC=com\",
        \"uid\": \"nABbRP/lPUKlteNRI4j6iA==\"
    }
}


Response Messages:
200: OK
404: Base Entry cannot be found
501: LDAP server is not configured
503: No connection to LDAP server","folder":"1-10","url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/getBaseDNEntry","collectionId":"1","id":"1-10-34","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Return entries that exactly match one of the given strings","dataMode":"raw","description":"Return list of LDAP entries which match the exact given multiple search_text.

Parameters:
body: Names to search

Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/getEntriesByNames
BODY{
    \"search_by_name_criteria\": {
        \"search_texts\": {
            \"search_text\": [
                \"Finance\",
                \"Marketing\",
                \"Management\"
            ]
        },
        \"ldap_entry_types\": {
            \"ldap_entry_type\": [
                \"GROUP\"
            ]
        },
        \"max_search_result\": 20
    }
}
OUTPUT{
    \"search_result\": {
        \"ldap_entries\": {
            \"ldap_entry\": [
                {
                    \"@xsi.type\": \"LdapGroup\",
                    \"dn\": \"CN=Finance,OU=SecureTrack,DC=tufintest,DC=com\",
                    \"uid\": \"uOvJTpYRD0aTjEENA87N5A==\",
                    \"displayName\": \"Finance\"
                },
                {
                    \"@xsi.type\": \"LdapGroup\",
                    \"dn\": \"CN=Management,OU=SecureTrack,DC=tufintest,DC=com\",
                    \"uid\": \"jdf778skfsgs730fksdHHs==\",
                    \"displayName\": \"Management\"
                }
            ]
        },
        \"has_more_results_to_return\": false
    }
}


Response Messages:
200: OK
400: Bad request (one of the request fields has an illegal value)
501: LDAP server is not configured
503: No connection to LDAP server","folder":"1-10","rawModeData":"{\n\t\"search_by_name_criteria\": {\n\t\t\"search_texts\": {\n\t\t\t\"search_text\": [\n\t\t\t\t\"Finance\",\n\t\t\t\t\"Marketing\",\n\t\t\t\t\"Management\"\n\t\t\t]\n\t\t},\n\t\t\"ldap_entry_types\": {\n\t\t\t\"ldap_entry_type\": [\n\t\t\t\t\"GROUP\"\n\t\t\t]\n\t\t},\n\t\t\"max_search_result\": 20\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/getEntriesByNames","collectionId":"1","id":"1-10-35","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Return LDAP entries which match the given search criteria","dataMode":"raw","description":"Return list of LDAP entries which match the given search criteria according to the search mode (EXACT, CONTAINS, STARTS_WITH, ENDS_WITH).
The search is case insensitive.
The limit of max_search_result is 1000.

Parameters:
body: Search criteria

Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/search
BODY{
    \"search_criteria\": {
        \"search_base_dn\": \"DC=tufintest,DC=com\",
        \"search_text\": \"test\",
        \"ldap_search_options\": {
            \"ldap_entry_types\": {
                \"ldap_entry_type\": [
                    \"OU\",
                    \"USER\"
                ]
            },
            \"search_mode\": \"CONTAINS\",
            \"max_search_result\": 3
        }
    }
}
OUTPUT{
    \"search_result\": {
        \"ldap_entries\": {
            \"ldap_entry\": [
            {
                \"dn\": \"CN=User15ATTesting1,OU=Testing1,OU=new OU,OU=SC_Users,DC=tufintest,DC=com\",
                \"uid\": \"ZRuKW3XqIEOIxCwlfgJQYA==\",
                \"displayName\": \"User15ATTesting1\"
            },
            {
                \"dn\": \"CN=IWAM_TEST2003,CN=Users,DC=tufintest,DC=com\",
                \"uid\": \"bYVqqcZXsUSF51hiP4W7Yw==\",
                \"displayName\": \"Testing1\"
            },
            {
                \"dn\": \"CN=User1ATTesting1,OU=Testing1,OU=new OU,OU=SC_Users,DC=tufintest,DC=com\",
                \"uid\": \"2ma3TrgeHEWQDITwvcRqlg==\",
                \"displayName\": \"test\"
            }
            ]
        },
            \"has_more_results_to_return\": \"true\"
        }
}


Response Messages:
200: OK
400: Bad request (one of the request fields has an illegal or invalid value)
501: LDAP server is not configured
503: No connection to LDAP server","folder":"1-10","rawModeData":"{\n\t\"search_criteria\": {\n\t\t\"search_base_dn\": \"DC=tufintest,DC=com\",\n\t\t\"search_text\": \"test\",\n\t\t\"ldap_search_options\": {\n\t\t\t\"ldap_entry_types\": {\n\t\t\t\t\"ldap_entry_type\": [\n\t\t\t\t\t\"OU\",\n\t\t\t\t\t\"USER\"\n\t\t\t\t]\n\t\t\t},\n\t\t\t\"search_mode\": \"CONTAINS\",\n\t\t\t\"max_search_result\": 3\n\t\t}\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/search","collectionId":"1","id":"1-10-36","method":"POST"},{"headers":"Content-Type: application/json\n","name":"Add devices to SecureTrack","dataMode":"raw","description":"Use this API to add a single device or a list of devices to SecureTrack.
The following devices can be added: Check Point CMA R77, CMA R80, SMC R77, SMC R80; Cisco ASA; Palo Alto Panorama NG; Fortinet FortiManager.
The API body should include a JSON file with the mandatory parameters for the operation.
String parameters contain only lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^().
Currently supported types: CMA, SMC, ASA, Panorama NG and FortiManager.

This API verifies connection to the provided device, before adding a device.
This is done by:
  Cisco - Connect with SSH and see that the credentials are correct.
  Check Point - Test OPSEC connectivity. For R80 devices, this also verifies the connectivity for API login.
  Panorama - Login through the API to check connectivity.
  Fortimanager - Login through the API to check connectivity.
If the connection test fails the device will not be added.
Only \"live\" device with correct credentials can be added using this API.
To add Checkpoint R77 devices, use \"r80_version\" : \"false\".


Parameters:
body: device_list

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/bulk
BODY{
     \"devices_list\":{
         \"devices\": [{
             \"model\":\"CMA\",
             \"vendor\":\"Checkpoint\",
             \"display_name\":\"Europe-CMA\",
             \"ip_address\":\"192.168.1.1\",
             \"enable_topology\": \"true\",
             \"securetrack_domain\":\"Default\",
             \"device_data\":{
                 \"lea_authentication_port\":\"65000\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"opsec_application\":\"ST-Opsec\",
                 \"activation_key\":\"ST-Activation\",
                 \"r80_version\":\"false\"
             }
         },
         {
             \"model\":\"CMA\",
             \"vendor\":\"Checkpoint\",
             \"display_name\":\"Europe-CMA\",
             \"ip_address\":\"192.168.1.1\",
             \"enable_topology\": \"true\",
             \"securetrack_domain\":\"Default\",
             \"device_data\":{
                 \"lea_authentication_port\":\"65000\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"opsec_application\":\"ST-Opsec\",
                 \"activation_key\":\"ST-Activation\",
                 \"user_name\":\"admin\",
                 \"password\":\"1234\",
                 \"r80_version\":\"true\"
             }
         },
         {
             \"model\":\"ASA\",
             \"vendor\":\"Cisco\",
             \"securetrack_domain\":\"Domain-A\",
             \"display_name\":\"Ireland-ASA\",
             \"ip_address\":\"172.16.1.1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
             \"enable_virtual_contexts\":\"true\",
             \"import_all\":\"false\",
             \"import_devices\":
                     [\"VC1\",\"VC2\"],
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"false\",
                 \"collect_dynamic_topology\":\"false\",
                 \"user_name\":\"St-Super-use\",
                 \"password\":\"st-super-password\",
                 \"enable_password\":\"st-enable-password\"
             }
         },
         {
             \"model\":\"Panorama\",
             \"vendor\":\"PaloAltoNetworks\",
             \"display_name\":\"First-Device-example\",
             \"ip_address\":\"172.16.1.1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"user_name\":\"St-Super-use\",
                 \"password\":\"st-super-password\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"collect_dynamic_topology\":\"false\",
                 \"import_devices\":[
                     {
                         \"name\":\"DG1\",
                         \"import_all\":\"false\",
                         \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"]
                     },
                     {
                         \"name\":\"DG2\",
                         \"import_all\":\"true\"
                     },
                     {
                         \"name\":\"DG3\",
                         \"import_all\":\"false\",
                         \"managed_devices\": []
                     }
                 ]
             }
         },
         {
             \"model\":\"FortiManager\",
             \"vendor\":\"Fortinet\",
             \"display_name\":\"Spain-FortiManager\",
             \"securetrack_server\":\"RemoteControlServerName\",
             \"ip_address\":\"172.16.1.1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"false\",
                 \"user_name\":\"St-Super-use\",
                 \"password\":\"st-super-password\",
                 \"collect_dynamic_topology\":\"false\",
                 \"import_all\": \"false\",
                 \"import_devices\": [
                         {
                 \"name\": \"AdomX\",
                 \"import_all\": \"false\",
                 \"managed_devices\": [\"FW1\"]
                        }
                    ]
                }
            }
        ]
    }
}


Response Messages:
202: Accepted
408: Request timed out
500: Internal server error
503: Task with UID already running","folder":"1-11","rawModeData":"{ \n \t \"devices_list\":{ \n \t\t \"devices\": [{ \n \t\t\t \"model\":\"CMA\",\n \t\t\t \"vendor\":\"Checkpoint\",\n \t\t\t \"display_name\":\"Europe-CMA\",\n \t\t\t \"ip_address\":\"192.168.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"securetrack_domain\":\"Default\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"lea_authentication_port\":\"65000\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"opsec_application\":\"ST-Opsec\",\n \t\t\t\t \"activation_key\":\"ST-Activation\",\n \t\t\t\t \"r80_version\":\"false\"\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"model\":\"CMA\",\n \t\t\t \"vendor\":\"Checkpoint\",\n \t\t\t \"display_name\":\"Europe-CMA\",\n \t\t\t \"ip_address\":\"192.168.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"securetrack_domain\":\"Default\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"lea_authentication_port\":\"65000\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"opsec_application\":\"ST-Opsec\",\n \t\t\t\t \"activation_key\":\"ST-Activation\",\n \t\t\t\t \"user_name\":\"admin\",\n \t\t\t\t \"password\":\"1234\",\n \t\t\t\t \"r80_version\":\"true\"\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"model\":\"ASA\",\n \t\t\t \"vendor\":\"Cisco\",\n \t\t\t \"securetrack_domain\":\"Domain-A\",\n \t\t\t \"display_name\":\"Ireland-ASA\",\n \t\t\t \"ip_address\":\"172.16.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t \"enable_virtual_contexts\":\"true\",\n \t\t\t \"import_all\":\"false\",\n \t\t\t \"import_devices\": \n \t\t\t\t\t [\"VC1\",\"VC2\"],\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"false\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"user_name\":\"St-Super-use\",\n \t\t\t\t \"password\":\"st-super-password\",\n \t\t\t\t \"enable_password\":\"st-enable-password\"\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"model\":\"Panorama\",\n \t\t\t \"vendor\":\"PaloAltoNetworks\",\n \t\t\t \"display_name\":\"First-Device-example\",\n \t\t\t \"ip_address\":\"172.16.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"user_name\":\"St-Super-use\",\n \t\t\t\t \"password\":\"st-super-password\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"import_devices\":[\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG1\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"] \n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG2\",\n \t\t\t\t\t\t \"import_all\":\"true\"\n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG3\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [] \n \t\t\t\t\t }\n \t\t\t\t ]\n \t\t\t }\n \t\t },\n \t\t {\n \t\t\t \"model\":\"FortiManager\",\n \t\t\t \"vendor\":\"Fortinet\",\n \t\t\t \"display_name\":\"Spain-FortiManager\",\n \t\t\t \"securetrack_server\":\"RemoteControlServerName\",\n \t\t\t \"ip_address\":\"172.16.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"false\",\n \t\t\t\t \"user_name\":\"St-Super-use\",\n \t\t\t\t \"password\":\"st-super-password\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"import_all\": \"false\",\n \t\t\t\t \"import_devices\": [\n \t\t\t\t\t\t { \n \t\t\t\t \"name\": \"AdomX\",\n \t\t\t\t \"import_all\": \"false\", \n \t\t\t\t \"managed_devices\": [\"FW1\"]\n \t\t\t\t\t\t}\n \t\t\t\t\t]\n \t\t\t\t}\n \t\t\t}\n \t\t]\n \t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/","collectionId":"1","id":"1-11-37","method":"POST"},{"headers":"Content-Type: application/json\n","name":"Edit Securetrack device","dataMode":"raw","description":"Use this API to edit the settings of a management device, including changing multiple parameters in the same call.
The API body should include a JSON file with the mandatory parameters for the operation.
String parameters contain only lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^().
The following devices can be added: Check Point CMA R77, CMA R80, SMC R77, SMC R80; Cisco ASA; Palo Alto Panorama NG; Fortinet FortiManager.
Note: This API cannot be used to edit SecureTrack Domains and SecureTrack Servers.
This API verifies connection to the provided device, before updating a device.
This is done by:
  Cisco - Connect with SSH and see that the credentials are correct.
  Check Point - Test OPSEC connectivity. For R80 devices, this also verifies the connectivity for API login.
  Panorama - Login through the API to check connectivity.
  Fortimanager - Login through the API to check connectivity.
If the connection test fails the device will not be updated.
Only \"live\" device with correct credentials can be updated using this API.

Parameters:
body: device_list

Usage Example
URL https://192.168.1.1/securetrack/api/devices/bulk
BODY{
     \"devices_list\":{
         \"devices\": [{
             \"device_id\": 1,
             \"display_name\": \"CheckPoint-R77-Device\",
             \"enable_topology\": \"true\",
             \"ip_address\": \"1.1.1.1\",
             \"device_data\": {
                 \"opsec_application\": \"ST-Opsec\",
                 \"activation_key\": \"ST-Activation\",
                 \"authentication_mode\": \"LEA\",
                 \"lea_authentication_mode\": \"ssl_opsec\",
                 \"lea_authentication_port\": \"2488\",
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\"
             }
         },
         {
             \"device_id\": 2,
             \"display_name\": \"CheckPoint-R80-Device\",
             \"enable_topology\": \"true\",
             \"ip_address\": \"1.1.1.2\",
             \"device_data\": {
                 \"opsec_application\": \"ST-Opsec\",
                 \"activation_key\": \"ST-Activation\",
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\",
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\"
             }
         },
         {
             \"device_id\": 3,
             \"display_name\": \"Cisco-Device\",
             \"enable_topology\": \"true\",
             \"ip_address\": \"2.2.2.2\",
             \"device_data\": {
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\",
                 \"enable_password\": \"st-super-password\",
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\"
             }
         },
         {
             \"device_id\": 4,
             \"display_name\": \"PaloAlto-PanoramaNg-Device\",
             \"ip_address\": \"2.2.2.2\",
             \"device_data\": {
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\"
             }
         },
         {
             \"device_id\": 5,
             \"display_name\": \"PaloAlto-DeviceGroup\"
         },
         {
             \"device_id\": 6,
             \"display_name\": \"PaloAlto-FireWall-Device\",
             \"enable_topology\": \"true\",
             \"device_data\": {
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\",
                 \"collect_dynamic_topology\": \"true\"
             }
         },
         {
             \"device_id\": 7,
             \"display_name\": \"Spain-FortiManager\",
             \"ip_address\": \"2.2.2.2\",
             \"device_data\": {
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\"
             }
         },
         {
             \"device_id\": 8,
             \"display_name\": \"FortiManager-Adom\"
         },
         {
             \"device_id\": 9,
             \"display_name\": \"FortiManager-FireWall\",
             \"enable_topology\": \"true\",
             \"device_data\": {
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\",
                 \"collect_dynamic_topology\": \"true\"
             }
         }
        ]
    }
}


Response Messages:
202: Accepted
408: Request timed out
500: Internal server error
503: Task with UID already running","folder":"1-11","rawModeData":"{ \n \t \"devices_list\":{ \n\t\t \"devices\": [{\n\t\t\t \"device_id\": 1,\n\t\t\t \"display_name\": \"CheckPoint-R77-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"ip_address\": \"1.1.1.1\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"opsec_application\": \"ST-Opsec\",\n\t\t\t\t \"activation_key\": \"ST-Activation\",\n\t\t\t\t \"authentication_mode\": \"LEA\",\n\t\t\t\t \"lea_authentication_mode\": \"ssl_opsec\",\n\t\t\t\t \"lea_authentication_port\": \"2488\",\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 2,\n\t\t\t \"display_name\": \"CheckPoint-R80-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"ip_address\": \"1.1.1.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"opsec_application\": \"ST-Opsec\",\n\t\t\t\t \"activation_key\": \"ST-Activation\",\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\",\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 3,\n\t\t\t \"display_name\": \"Cisco-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"ip_address\": \"2.2.2.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\",\n\t\t\t\t \"enable_password\": \"st-super-password\",\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 4,\n\t\t\t \"display_name\": \"PaloAlto-PanoramaNg-Device\",\n\t\t\t \"ip_address\": \"2.2.2.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 5,\n\t\t\t \"display_name\": \"PaloAlto-DeviceGroup\"\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 6,\n\t\t\t \"display_name\": \"PaloAlto-FireWall-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_dynamic_topology\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 7,\n\t\t\t \"display_name\": \"Spain-FortiManager\",\n\t\t\t \"ip_address\": \"2.2.2.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 8,\n\t\t\t \"display_name\": \"FortiManager-Adom\"\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 9,\n\t\t\t \"display_name\": \"FortiManager-FireWall\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_dynamic_topology\": \"true\"\n\t\t\t }\n\t\t }\n\t\t]\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/","collectionId":"1","id":"1-11-38","method":"PATCH"},{"name":"Add configuration for offline device","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"configuration_file"}],"description":"Parameters:
device_id: Device ID
configuration_file: Configuration File

Usage Example
curl -X POST -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F \"configuration_file=@/tmp/config.txt;type=application/octet-stream\" -F \"device_id=1\" https://192.168.1.1/securetrack/api/tasks/add_device_config_task

Response Messages:
200: Configuration added successfully.","dataMode":"params","folder":"1-11","url":"https://{{SecureTrack_IP}}/securetrack/api/tasks/add_device_config_task","collectionId":"1","id":"1-11-39","method":"POST"},{"headers":"Accept: application/json\n","name":"Get textual configuration by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns textual configuration for the specified revision Id.


Parameters:
context: Global MSSP context [optional]
id: Revision id

Usage Example
https://192.168.1.1/securetrack/api/revisions/227/config
","folder":"1-11","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/config","collectionId":"1","id":"1-11-40","method":"GET"},{"headers":"Accept: application/json\n","name":"Get textual configuration by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Get latest revision of running configuration for a given device Id.


Parameters:
context: global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/111/config
","folder":"1-11","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/config","collectionId":"1","id":"1-11-41","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Update offline device","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"}],"dataMode":"raw","description":"Device name should contain only Lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^()

Parameters:
device_id: Device ID
body: Device to be updated

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/1
BODY<device>
     <name>API OFFLINE ASA2</name>
     <topology>true</topology>
</device>

","folder":"1-11","rawModeData":"\n\t API OFFLINE ASA2\n\t true\n","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}","collectionId":"1","id":"1-11-42","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get specific device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the vendor, model, name, domain and ID for the specified device.
For more information on supported devices, supported models and virtual types please refer to 'Device and Revision Resources' section in the Tufin Knowledge Center .

Parameters:
context: Global MSSP context [optional]
id: Device ID
show_os_version: Show os version as apart of the response [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/60

Usage Example
https://192.168.1.1/securetrack/api/devices/20?show_os_version=true
","folder":"1-11","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}","collectionId":"1","id":"1-11-43","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Import managed devices","dataMode":"raw","description":"Use this API to import more managed devices to SecureTrack.
The following devices can be added: Device Groups (for Panorama), Administrative Domains (for FortiManager).\nCurrently supported types: Panorama, FortiManager, Cisco ASA.
Please see examples below per device id: device id 1 for Panorama, device 2 for FortiManager, device id 3 for Cisco ASA.

Parameters:
body: device_list

Usage Example
URL https://192.168.1.1/securetrack/api/devices/bulk/import
BODY{
     \"devices_list\":{
         \"devices\":[
         {
             \"device_id\":\"1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"collect_dynamic_topology\":\"false\",
                 \"import_devices\":[
                     {
                         \"name\":\"DG1\",
                         \"import_all\":\"false\",
                         \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"]
                     },
                     {
                         \"name\":\"DG2\",
                         \"import_all\":\"true\"
                     },
                     {
                         \"name\":\"DG3\",
                         \"import_all\":\"false\",
                         \"managed_devices\": []
                     }
                 ]
             }
         },
         {
             \"device_id\":\"2\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"import_devices\": [
                     {
                         \"name\":\"Adom1\",
                         \"import_all\":\"false\",
                         \"managed_devices\": [\"firewall1\", \"firewall2\"]
                     },
                     {
                         \"name\":\"Adom2\",
                         \"import_all\":\"true\"
                     }
                 ]
             }
         },
         {
             \"device_id\":\"3\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"import_devices\": [\"wantedVirtualContext\", \"anotherWantedVirtualContext\"]
             }
         }
        ]
    }
}


Response Messages:
202: Accepted
408: Request timed out
500: Internal server error
503: Task with UID already running","folder":"1-11","rawModeData":"{ \n \t \"devices_list\":{ \n \t\t \"devices\":[ \n \t\t { \n \t\t\t \"device_id\":\"1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"import_devices\":[\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG1\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"] \n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG2\",\n \t\t\t\t\t\t \"import_all\":\"true\"\n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG3\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [] \n \t\t\t\t\t }\n \t\t\t\t ]\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"device_id\":\"2\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"import_devices\": [\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"Adom1\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [\"firewall1\", \"firewall2\"] \n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"Adom2\",\n \t\t\t\t\t\t \"import_all\":\"true\"\n \t\t\t\t\t }\n \t\t\t\t ]\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"device_id\":\"3\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"import_devices\": [\"wantedVirtualContext\", \"anotherWantedVirtualContext\"] \n \t\t\t }\n \t\t }\n \t\t]\n \t}\n} ","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/import","collectionId":"1","id":"1-11-44","method":"POST"},{"headers":"Content-Type: application/xml\n","name":"Add offline device","dataMode":"raw","description":"You can choose to select the domain either by name or id using the domain_id or domain_name tags.\nDevice name should contain only Lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^()

Parameters:
body: Device to be added

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices
BODY<device>
     <model>asa</model>
     <vendor>Cisco</vendor>
     <domain_id>1</domain_id>
     <domain_name>Default</domain_name>
     <name>API OFFLINE ASA1</name>
     <offline>true</offline>
     <topology>true</topology>
</device>

","folder":"1-11","rawModeData":"\n\t asa \n\t Cisco\n\t 1\n\t Default\n\t API OFFLINE ASA1\n\t true\n\t true\n","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/","collectionId":"1","id":"1-11-45","method":"POST"},{"headers":"Accept: application/json\n","name":"Get devices","description":"Returns the list of devices that are configured in SecureTrack, including the vendor, model, name, domain and device ID.
The results can be sorted by ip, name, vendor and model.
For more information on supported devices, supported models and virtual types please refer to 'Device and Revision Resources' section in the Tufin Knowledge Center .

Parameters:
context: Global MSSP context [optional]
name: Device name [optional]
ip: Device IP address [optional]
vendor: Device vendor [optional]
model: Device model [optional]
sort: Sort ascending or descending allowable types are: asc or desc [optional]
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query starting from starting page allowable type in numeric [optional]
show_os_version: Show os version as apart of the response [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices

Usage Example
https://192.168.1.1/securetrack/api/devices?vendor=VMware

Usage Example
https://192.168.1.1/securetrack/api/devices?sort=ip:asc

Usage Example
https://192.168.1.1/securetrack/api/devices?show_os_version=true
","folder":"1-11","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/","collectionId":"1","id":"1-11-46","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific task results of bulk operations on devices","data":[{"value":null,"type":"text","enabled":true,"key":"task_uid"}],"dataMode":"params","description":"Use this API to track and display the current progress of the devices being edited or added to\nSecureTrack for a specific Task ID.
For a list of devices, the status of each device is displayed.

A device that was not added due to some reason will be added to \"failed\" list with status element containing a description.
For example:
\"description\": \"No connection to device\".

Parameters:
task_uid: Task UID

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/bulk/tasks/d7e88799-a6e5-45da-8c72-c979a5dbe235
OUTPUT{
    \"task_result\":{
        \"total_succeeded\":\"0\",
        \"total_in_progress\":\"2\",
        \"total_failed\":\"0\",
        \"succeeded\":{
            \"count\":\"0\"
        },
        \"in_progress\":{
            \"count\":\"2\",
            \"devices\":[
                {
                    \"device_id\":\"1\",
                    \"display_name\":\"Europe-CMA\",
                    \"ip_address\":\"192.168.1.1\",
                    \"status\":{
                    }
                },
                {
                    \"device_id\":\"2\",
                    \"display_name\":\"Ireland-ASA\",
                    \"ip_address\":\"172.16.1.1\",
                    \"status\":{
                    }
                }
            ]
        },
        \"failed\":{
            \"count\":\"0\"
        }
    }
}


Response Messages:
404: The task with the given UID was not found
400: Bad request
200: Accepted
408: Request timed out
500: Internal server error","folder":"1-11","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/tasks/{{task_uid}}","collectionId":"1","id":"1-11-47","method":"GET"},{"headers":"Accept: application/json\n","name":"Get NAT objects by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches a list of NAT objects for a given revision
Note: NAT objects are only relevant for Check Point management servers and Juniper Netscreen devices.
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.


Parameters:
context: Global MSSP context [optional]
id: Version ID
start: Starting page for query allowable value is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/nat_objects

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/nat_objects?get_total=true
","folder":"1-12","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/nat_objects","collectionId":"1","id":"1-12-48","method":"GET"},{"headers":"Accept: application/json\n","name":"Get NAT rules by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of NAT rules for device given by device ID

input_interface and output_interface are not supported for Panorama running in Advanced management mode
nat_stage is supported for Netscreen and JunOS
nat_type is supported for FortiManager
Note: For Check Point, NAT rules are available from the modules (not managements)
Note: For Palo Alto, filtering NAT rules by interface is only available for firewall devices

Parameters:
context: Global MSSP context [optional]
id: Device ID
input_interface: Input interface for NAT rules, \"any\" for all interfaces [optional]
output_interface: output interface for NAT rules, \"any\" for all interfaces [optional]
nat_stage: NAT stage for NAT rules allowable values: \"pre_policy\" , \"post_policy\" or \"both\" [optional]
nat_type: NAT stage for NAT rules allowable values: \"vip\" or \"reverse_vip\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/10/nat_rules/bindings?input_interface=Any
","folder":"1-12","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/nat_rules/bindings","collectionId":"1","id":"1-12-49","method":"GET"},{"headers":"Accept: application/json\n","name":"Get NAT objects by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches a list of NAT objects defined on device given by device ID
Note: NAT objects are only relevant for Check Point management servers and Juniper Netscreen devices.
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.


Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable value is numeric [optional]
count: Starting page for query allowable value is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/nat_objects

Usage Example
https://192.168.1.1/securetrack/api/devices/20/nat_objects?get_total=true
","folder":"1-12","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/nat_objects","collectionId":"1","id":"1-12-50","method":"GET"},{"headers":"Accept: application/json\n","name":"Get rules containing specified network object","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the security rules that contain the specified network object


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the network object.
include_groups: You can add \"include_groups\" to find rules that include the network object and rules that include the groups that include the network object. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]

Usage Example
https://192.168.1.1/securetrack/api/network_objects/65078/rules?include_groups=true
","folder":"1-13","url":"https://{{SecureTrack_IP}}/securetrack/api/network_objects/{{id}}/rules","collectionId":"1","id":"1-13-51","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific network objects by revision","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches a single or partial list of the network objects for a given revision.
For group network objects, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision id
ids: Network object IDs separated by commas
show_members: Set to false to return only the name and ID of the members [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/779/network_objects/69548

Usage Example
https://192.168.1.1/securetrack/api/revisions/779/network_objects/69547,69548,69550

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/779/network_objects/69547?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"network_object\": {
            \"@xsi.type\": \"identityAwarenessDTO\",
            \"id\": 169185,
            \"name\": \"Access_Role_Domain Controllers\",
            \"display_name\": \"Access_Role_Domain Controllers\",
            \"class_name\": \"access_role\",
            \"type\": \"identity_awareness\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{140B8F32-188D-414C-A7BE-F4A7D7E9A169}\",
            \"implicit\": false,
            \"overrides\": false,
            \"type_on_device\": \"\",
            \"networks\": {
                \"network\": {
                    \"@xsi.type\": \"basicNetworkObjectDTO\",
                    \"id\": 168419,
                    \"name\": \"Any\",
                    \"display_name\": \"Any\",
                    \"class_name\": \"any_object\",
                    \"type\": \"basic\",
                    \"global\": false,
                    \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                    \"implicit\": false,
                    \"overrides\": false
                }
            },
            \"users\": {
                \"user\": {
                    \"id\": 14237,
                    \"name\": \"ad_group_Domain_Controllers\",
                    \"display_name\": \"Domain Controllers\",
                    \"class_name\": \"ad_group\",
                    \"global\": false,
                    \"comment\": \"\",
                    \"uid\": \"{0A8A459E-58E8-45DC-981E-16BBF2BD1922}\",
                    \"dn\": \"CN=Domain Controllers,CN=Users,DC=rnd,DC=local\"
                }
            }
        }
    }
}

","folder":"1-13","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/network_objects/{{ids}}","collectionId":"1","id":"1-13-52","method":"GET"},{"headers":"Accept: application/json\n","name":"Get network objects by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of network objects defined on device given by ID
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.
The show_members parameter is only relevant if type=group.
If type=group, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.

Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
name: Network object name [optional]
type: Network object type [optional]
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
contains_ip: Get only network objects containing this IP [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]
typeOnDevice: Get EDL groups [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/network_objects

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?get_total=true
OUTPUT {
    \"network_objects\": {
    \"count\": 1,
    \"total\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"hostNetworkObjectDTO\",
                \"id\": 499226,
                \"name\": \"1.1.1.2 not shared\",
                \"display_name\": \"1.1.1.2 not shared\",
                \"class_name\": \"host_plain\",
                \"type\": \"host\",
                \"comment\": \"\",
                \"uid\": \"{EFE8E61B-EE2A-2F55-4C5C-56508661EAA7}\",
                \"implicit\": false,
                \"management_domain\": \"Shared\",
                \"overrides\": false,
                \"ip\": \"1.1.1.2\"
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"count\": 1
        \"network_object\": [
            {
                \"@xsi.type\": \"identityAwarenessDTO\",
                \"id\": 169178,
                \"name\": \"Access_role\",
                \"display_name\": \"Access_role\",
                \"class_name\": \"access_role\",
                \"type\": \"identity_awareness\",
                \"global\": false,
                \"comment\": \"\",
                \"uid\": \"{FC267948-DA8C-4FB6-A736-76B5254BF825}\",
                \"implicit\": false,
                \"overrides\": false,
                \"type_on_device\": \"\",
                \"networks\": {
                    \"network\": {
                        \"@xsi.type\": \"basicNetworkObjectDTO\",
                        \"id\": 168419,
                        \"name\": \"Any\",
                        \"display_name\": \"Any\",
                        \"class_name\": \"any_object\",
                        \"type\": \"basic\",
                        \"global\": false,
                        \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                        \"implicit\": false,
                        \"overrides\": false
                    }
                },
                \"users\": {
                    \"user\": {
                        \"id\": 14320,
                        \"name\": \"ad_group_auto_30K_grp1\",
                        \"display_name\": \"auto_30K_grp1\",
                        \"class_name\": \"ad_group\",
                        \"global\": false,
                        \"comment\": \"\",
                        \"uid\": \"{CAB92DCC-CF63-4E47-B8E3-1E1231996D5E}\",
                        \"dn\": \"CN=auto_30K_grp1,OU=OU_30K_Groups,DC=rnd,DC=local\"
                    }
                }
            },
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?type=group&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 105934,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?typeOnDevice=edl_ip_list&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 1,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 123123,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"type_on_device\": edl_ip_list,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Response Messages:
400: The typeOnDevice value is not valid","folder":"1-13","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/network_objects","collectionId":"1","id":"1-13-53","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific network object","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches a single or partial list of the network objects for a given device ID.
For group network objects, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.
Note: This API retrieves the information from the latest revision.

Parameters:
context: Global MSSP context [optional]
device_id: Device ID
ids: Network object IDs separated by commas
show_members: Set to false to return only the name and ID of the members [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/network_objects/69548

Usage Example
https://192.168.1.1/securetrack/api/devices/31/network_objects/69547,69548,69550

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects/169184?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"network_object\": {
            \"@xsi.type\": \"identityAwarenessDTO\",
            \"id\": 169184,
            \"name\": \"Access_Role_@grp\",
            \"display_name\": \"Access_Role_@grp\",
            \"class_name\": \"access_role\",
            \"type\": \"identity_awareness\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{1870612C-0922-4AEE-81FF-5472DB7C32E1}\",
            \"implicit\": false,
            \"overrides\": false,
            \"type_on_device\": \"\",
            \"networks\": {
                \"network\": {
                    \"@xsi.type\": \"basicNetworkObjectDTO\",
                    \"id\": 168419,
                    \"name\": \"Any\",
                    \"display_name\": \"Any\",
                    \"class_name\": \"any_object\",
                    \"type\": \"basic\",
                    \"global\": false,
                    \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                    \"implicit\": false,
                    \"overrides\": false
                }
            },
            \"users\": {
                \"user\": {
                    \"id\": 14338,
                    \"name\": \"ad_group_grp\",
                    \"display_name\": \"@grp\",
                    \"class_name\": \"ad_group\",
                    \"global\": false,
                    \"comment\": \"\",
                    \"uid\": \"{C5740C23-F36E-4D2E-8B17-1F99C239C12A}\",
                    \"dn\": \"CN=@grp,OU=SC_Users,DC=test,DC=com\"
                }
            }
        }
    }
}

","folder":"1-13","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/network_objects/{{ids}}","collectionId":"1","id":"1-13-54","method":"GET"},{"headers":"Accept: application/json\n","name":"Get network objects matching specified criteria","data":[{"value":null,"type":"text","enabled":true,"key":"filter"}],"dataMode":"params","description":"You can search for network objects where the IP address, name or comment fields have a specified text string,
or you can search for network objects that have an IP address that matches, contains or is contained in a specified IP subnet,
or you can search for network objects by uid.

Parameters:
context: Returns results for the specified domain ID. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]
filter: “text” filter returns network objects where the IP address, name or comment fields have a specified text string. “subnet” filter returns network objects that have an IP address that matches, contains or is contained in a specified IP subnet. “uid“ filter returns network objects with the specified uid. If no filter is specified, the “text” filter is used.
device_id: Returns network objects belonging to the specified device_id. [optional]
ip: (For “text” filter) You can specify \"ip\" to find network objects with the specified text in the IP address field. [optional]
name: (For “text” filter) You can specify \"name\" to find network objects with the specified text in the name field. [optional]
comment: (For “text” filter) You can specify “comment” to find network objects with the specified text in the comment field. [optional]
any_field: (For “text” filter) You can specify \"any_field\" to find network objects with the specified text in the IP address, name or comment fields. [optional]
exact_match: (For “text” filter) You can add \"exact_match=true\" to find network objects with the specified text in the comment field. If this field is not specified, the query uses \"exact_match=false\". [optional]
contained_in: (For “subnet” filter) You can specify \"contained_in\" to find network objects that are contained in the specified IP subnet. For example, 10.1.0.0 is contained in 10.0.0.0. [optional]
contains: (For “subnet” filter) You can specify \"contains\" to find network objects that contain the specified IP subnet. For example, 10.0.0.0 contains 10.1.0.0. [optional]
exact_subnet: (For “subnet” filter) You can specify \"exact_subnet\" to find network objects that have the specified IP address. [optional]
uid: (for “uid“ filter) Returns network objects with the specified uid. [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]
typeOnDevice: You can specify \"typeOnDevice\" to find network object groups that are EDL. [optional]

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=text&name=host&exact_match=true

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=text&any_field=host&count=10&exact_match=true

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=subnet&contains=10.1.1.0

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=subnet&count=10&exact_subnet=1.1.1.1

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=uid&uid=24a8774d-24c1-4b3a-aae9-3c272a2b5191

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=uid&uid=24a8774d-24c1-4b3a-aae9-3c272a2b5191&device_id=4

Usage Example
URLhttps://192.168.1.1/securetrack/api/network_objects/search?filter=text&name=Access_Role&identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"count\": 1,
        \"total\": 1,
        \"network_object\": {
            \"@xsi.type\": \"identityAwarenessDTO\",
            \"id\": 169197,
            \"name\": \"Access_Role_aaa\",
            \"display_name\": \"Access_Role_aaa\",
            \"class_name\": \"access_role\",
            \"type\": \"identity_awareness\",
            \"global\": false,
            \"device_id\": 158,
            \"comment\": \"\",
            \"uid\": \"{9EDC2607-6BEC-43D7-A99D-B522BA694ADA}\",
            \"implicit\": false,
            \"overrides\": false,
            \"type_on_device\": \"\",
            \"networks\": {
                \"network\": {
                    \"@xsi.type\": \"basicNetworkObjectDTO\",
                    \"id\": 168419,
                    \"name\": \"Any\",
                    \"display_name\": \"Any\",
                    \"class_name\": \"any_object\",
                    \"type\": \"basic\",
                    \"global\": false,
                    \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                    \"implicit\": false,
                    \"overrides\": false
                }
            },
            \"users\": {
                \"user\": {
                    \"id\": 14317,
                    \"name\": \"ad_group_aaa\",
                    \"display_name\": \"aaa\",
                    \"class_name\": \"ad_group\",
                    \"global\": false,
                    \"comment\": \"\",
                    \"uid\": \"{5D16859C-0256-4673-A402-4254588B8F40}\",
                    \"dn\": \"CN=aaa,OU=SC_Users,DC=test,DC=com\"
                }
            }
        }
    }
}


Response Messages:
400: The typeOnDevice value is not valid.Use edl_ip_list as value to search EDL groups.","folder":"1-13","url":"https://{{SecureTrack_IP}}/securetrack/api/network_objects/search","collectionId":"1","id":"1-13-55","method":"GET"},{"headers":"Accept: application/json\n","name":"Get network groups containing specified network object","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns groups that contain the specified network object


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the network object.

Usage Example
https://192.168.1.1/securetrack/api/network_objects/69577/groups
","folder":"1-13","url":"https://{{SecureTrack_IP}}/securetrack/api/network_objects/{{id}}/groups","collectionId":"1","id":"1-13-56","method":"GET"},{"headers":"Accept: application/json\n","name":"Get network objects by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of network objects from specific revision
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.
The show_members parameter is only relevant if type=group.
If type=group, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.

Parameters:
context: Global MSSP context [optional]
id: Revision id
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
name: Network object name [optional]
type: Network object type [optional]
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
contains_ip: Get only network objects containing this IP [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]
typeOnDevice: Get EDL groups [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/779/network_objects

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?get_total=true
OUTPUT {
    \"network_objects\": {
    \"count\": 1,
    \"total\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"hostNetworkObjectDTO\",
                \"id\": 499226,
                \"name\": \"1.1.1.2 not shared\",
                \"display_name\": \"1.1.1.2 not shared\",
                \"class_name\": \"host_plain\",
                \"type\": \"host\",
                \"comment\": \"\",
                \"uid\": \"{EFE8E61B-EE2A-2F55-4C5C-56508661EAA7}\",
                \"implicit\": false,
                \"management_domain\": \"Shared\",
                \"overrides\": false,
                \"ip\": \"1.1.1.2\"
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/779/network_objects?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
    \"count\": 1,
        \"network_object\": [
            {
                \"@xsi.type\": \"identityAwarenessDTO\",
                \"id\": 169183,
                \"name\": \"Access role 1\",
                \"display_name\": \"Access role 1\",
                \"class_name\": \"access_role\",
                \"type\": \"identity_awareness\",
                \"global\": true,
                \"comment\": \"\",
                \"uid\": \"{1E4C35A0-1FE4-4101-8A38-FDE656BCDCFB}\",
                \"implicit\": false,
                \"overrides\": false,
                \"type_on_device\": \"\",
                \"networks\": {
                    \"network\": {
                        \"@xsi.type\": \"basicNetworkObjectDTO\",
                        \"id\": 168419,
                        \"name\": \"Any\",
                        \"display_name\": \"Any\",
                        \"class_name\": \"any_object\",
                        \"type\": \"basic\",
                        \"global\": false,
                        \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                        \"implicit\": false,
                        \"overrides\": false
                    }
                },
                \"users\": {
                    \"user\": {
                        \"id\": 14346,
                        \"name\": \"all identified\",
                        \"display_name\": \"all identified\",
                        \"class_name\": \"all_identified\",
                        \"global\": false,
                        \"comment\": \"\",
                        \"uid\": \"{17A972AC-4B4A-4715-859F-867128707F59}\",
                        \"dn\": \"\"
                    }
                }
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/31/network_objects?type=group&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 105934,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/31/network_objects?typeOnDevice=edl_ip_list&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 1,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 123123,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"type_on_device\": edl_ip_list,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Response Messages:
400: The typeOnDevice value is not valid","folder":"1-13","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/network_objects","collectionId":"1","id":"1-13-57","method":"GET"},{"headers":"Accept: application/json\n","name":"Get generic Route","description":"Get a generic Route by Id.

Parameters:
routeId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/route/30
OUTPUT{
    GenericRoute: {
        id: 30,
        mgmtId: 2,
        destination: \"222.100.10.22\",
        mask: \"255.255.0.0\",
        interfaceName: \"catch22\",
        nextHop: \"100.100.10.10\",
        nextHopType: \"IP\",
        vrf: \"V102-YO\"
    }
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Generic Route Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/{{routeId}}","collectionId":"1","id":"1-14-58","method":"GET"},{"headers":"Accept: application/json\n","name":"Delete generic Route","description":"Delete a generic Route by Id.

Parameters:
routeId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/route/5\n

Response Messages:
204: No Content.
400: Bad Request.
401: Access is denied.
404: Generic Route Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/{{routeId}}","collectionId":"1","id":"1-14-59","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get topology routing tables for a given device","data":[{"value":null,"type":"text","enabled":true,"key":"mgmtId"}],"dataMode":"params","description":"The returned routing tables are taken from the topology data and will include only devices that are topology enabled.
When adding a device, the user can can choose whether to use dynamic or static topology for the device,
this choice will determine which kind of data is stored in the topology graph and returned by this API.

The parameter mgmtId should be a cluster or a gateway, not a management server.
You may provide a generic device Id (see generic_devices API under 'Monitored Devices' category) -
in this case make sure you set 'is_generic' parameter to 'true'

Parameters:
mgmtId: Management Id or Generic Device Id to query
is_generic: Should be set to 'true' if the provided mgmtId is related to generic device [optional]
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query from starting page, allowable type is numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_routes?mgmtId=10

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_routes?mgmtId=1&is_generic=true
","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/topology_routes","collectionId":"1","id":"1-14-60","method":"GET"},{"headers":"Accept: application/json\n","name":"Delete Ignored Interfaces.","description":"Delete Ignored Interfaces by management id.

Parameters:
mgmtId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/ignoredinterface/mgmt/10\n

Response Messages:
200: 2 entries deleted where mgmtId = 10
400: Bad Request.
401: Access is denied.
404: Management Id 10 not found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/ignoredinterface/mgmt/{{mgmtId}}","collectionId":"1","id":"1-14-61","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get Ignored Interfaces.","description":"Get Ignored Interfaces by management id.

Parameters:
mgmtId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/ignoredinterface/mgmt/10
OUTPUT{
    IgnoredInterfaces: [
        {
            interfaceName: \"eth2\",
            mgmtId: 10,
            ip: \"0.0.0.0\"
        },
        {
            interfaceName: \"loopback100\",
            mgmtId: 10,
            ip: \"34.34.34.34\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/ignoredinterface/mgmt/{{mgmtId}}","collectionId":"1","id":"1-14-62","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Get cloud information","data":[{"value":null,"type":"text","enabled":true,"key":"cloud_id"}],"dataMode":"raw","description":"Returns information about a specific cloud in the topology.
This API includes the ID of the cloud, the number of routes that point to the cloud, and the relevant devices (including the management_id) that have routes that point to the cloud.
This information can be used to identify missing devices that may need to be added to the topology or to identify clouds that are candidates for being joined.

Parameters:
cloud_id: cloud id
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/cloud_suggestions/120
BODY{
    \"suggested_clouds\": {
        \"count\": 1,
        \"total\": 1,
        \"cloud\": {
            \"management_name\": \"FW1\",
            \"management_id\": 20,
            \"cloud_name\": \"Cloud 10.100.0.1\",
            \"cloud_id\": 120,
            \"vertex_id\": 250,
            \"ip\": \"10.100.0.1\",
            \"routes_count\": 5,
            \"is_parent\": false
        }
    }
}


Response Messages:
202: Accepted
401: User is not permitted to access the specified domain","folder":"1-14","rawModeData":"{\n\t\"suggested_clouds\": {\n\t\t\"count\": 1,\n\t\t\"total\": 1,\n\t\t\"cloud\": {\n\t\t\t\"management_name\": \"FW1\",\n\t\t\t\"management_id\": 20,\n\t\t\t\"cloud_name\": \"Cloud 10.100.0.1\",\n\t\t\t\"cloud_id\": 120,\n\t\t\t\"vertex_id\": 250,\n\t\t\t\"ip\": \"10.100.0.1\",\n\t\t\t\"routes_count\": 5,\n\t\t\t\"is_parent\": false\n\t\t}\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/cloud_suggestions/{{cloud_id}}","collectionId":"1","id":"1-14-63","method":"GET"},{"name":"Add generic device to Topology model","data":[{"value":null,"type":"text","enabled":true,"key":"configuration_file"}],"dataMode":"params","description":"Upload a configuration file that will be used to add a generic device to the Topology model.
The context field is the domain ID to which the generic device is added: If not provided, the device is added to the global domain.
configuration_file must include a valid generic device configuration.
The specified path must point to a file on the computer being sue to make the REST API call.
If update update_topology = true, then the Topology model will be updated immediately after the device is added.
For maximum efficiency, if you are adding multiple generic devices in consecutive API calls, you can set update_topology = false on all API calls except for the last one. On the last call, set update_toplogy = true.Default value for update_topology = true.
For more information on input file formats, refer to Knowledge Center topic 'Adding and Updating a Generic Device'.

Parameters:
body: Generic device to be added
configuration_file: Configuration File for generic device
update_topology: Synchronize And Update Topology [optional]

Usage Example
curl -X POST -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F 'device_data={\"generic_device\":{\"name\": \"my_generic_device\", \"customer_id\": 1}};type=application/json' -F \"configuration_file=@/tmp/config.txt;type=application/octet-stream\" -F \"update_topology=true\" https://192.168.1.1/securetrack/api/generic_devices\n

Response Messages:
201: The generic device was created successfully
401: User is not permitted to access the specified domain
400: Failed to create generic device ","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/","collectionId":"1","id":"1-14-64","method":"POST"},{"headers":"Accept: application/json\n","name":"Get generic devices that are configured in ST","description":"Returns a list of the generic devices included in all the domains that the user has permission to.
Use context and/or name optional parameters to get more specific results.
To get context optional parameter, you can call /domains/ API and use the id included within the returned domain DTO.

Parameters:
context: Global MSSP context [optional]
name: Generic device name [optional]

Usage Example
https://192.168.1.1/securetrack/api/generic_devices
","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/","collectionId":"1","id":"1-14-65","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Get cloud information","dataMode":"raw","description":"Returns information about all clouds in the topology.
This API includes the ID of the cloud, the number of routes that point to the cloud, and the relevant devices (including the management_id) that have routes that point to the cloud.
This information can be used to identify missing devices that may need to be added to the topology or to identify clouds that are candidates for being joined.

Parameters:
context: Global MSSP context [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/cloud_suggestions
BODY{
    \"suggested_clouds\": {
        \"count\": 2,
        \"total\": 2,
        \"cloud\": [
            {
                \"management_name\": \"FW1\",
                \"management_id\": 20,
                \"cloud_name\": \"Cloud 10.100.0.1\",
                \"cloud_id\": 120,
                \"vertex_id\": 250,
                \"ip\": \"10.100.0.1\",
                \"routes_count\": 5,
                \"is_parent\": false
            },
            {
                \"management_name\": \"FW2\",
                \"management_id\": 21,
                \"cloud_name\": \"Cloud 172.16.0.1\",
                \"cloud_id\": 125,
                \"vertex_id\": 270,
                \"ip\": \"172.16.0.1\",
                \"routes_count\": 7,
                \"is_parent\": false,
                \"parent_vertex_id\": 40
                \"parent_cloud_id\": 45
                \"parent_cloud_name\": \"Cloud 172.16.0.1\",
            }
        ]
    }
}


Response Messages:
202: Accepted
401: User is not permitted to access the specified domain","folder":"1-14","rawModeData":"{\n\t\"suggested_clouds\": {\n\t\t\"count\": 2,\n\t\t\"total\": 2,\n\t\t\"cloud\": [\n\t\t\t{\n\t\t\t\t\"management_name\": \"FW1\",\n\t\t\t\t\"management_id\": 20,\n\t\t\t\t\"cloud_name\": \"Cloud 10.100.0.1\",\n\t\t\t\t\"cloud_id\": 120,\n\t\t\t\t\"vertex_id\": 250,\n\t\t\t\t\"ip\": \"10.100.0.1\",\n\t\t\t\t\"routes_count\": 5,\n\t\t\t\t\"is_parent\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"management_name\": \"FW2\",\n\t\t\t\t\"management_id\": 21,\n\t\t\t\t\"cloud_name\": \"Cloud 172.16.0.1\",\n\t\t\t\t\"cloud_id\": 125,\n\t\t\t\t\"vertex_id\": 270,\n\t\t\t\t\"ip\": \"172.16.0.1\",\n\t\t\t\t\"routes_count\": 7,\n\t\t\t\t\"is_parent\": false,\n\t\t\t\t\"parent_vertex_id\": 40\n\t\t\t\t\"parent_cloud_id\": 45\n\t\t\t\t\"parent_cloud_name\": \"Cloud 172.16.0.1\",\n\t\t\t}\n\t\t]\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/cloud_suggestions","collectionId":"1","id":"1-14-66","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Create generic Vpns","dataMode":"raw","description":"Create generic Vpns.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/vpn
BODY{
    \"GenericVpns\": [
    {
        \"generic\": true,
        \"deviceId\": 3,
        \"interfaceName\": \"33\",
        \"vpnName\": null,
        \"tunnelSourceIpAddr\": \"3.3.3.33\",
        \"tunnelDestIpAddr\": \"1.1.1.11\"
    },
    {
        \"generic\": false,
        \"deviceId\": 1,
        \"interfaceName\": \"111\",
        \"vpnName\": null,
        \"tunnelSourceIpAddr\": \"1.1.1.11\",
        \"tunnelDestIpAddr\": \"3.3.3.33\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"GenericVpns\": [\n\t{\n\t\t\"generic\": true,\n\t\t\"deviceId\": 3,\n\t\t\"interfaceName\": \"33\",\n\t\t\"vpnName\": null,\n\t\t\"tunnelSourceIpAddr\": \"3.3.3.33\",\n\t\t\"tunnelDestIpAddr\": \"1.1.1.11\"\n\t},\n\t{\n\t\t\"generic\": false,\n\t\t\"deviceId\": 1,\n\t\t\"interfaceName\": \"111\",\n\t\t\"vpnName\": null,\n\t\t\"tunnelSourceIpAddr\": \"1.1.1.11\",\n\t\t\"tunnelDestIpAddr\": \"3.3.3.33\"\n\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/","collectionId":"1","id":"1-14-67","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Update generic Vpns","dataMode":"raw","description":"Update generic Vpns.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/vpn
BODY{
    \"GenericVpns\": [
    {
        \"id\": 24,
        \"generic\": true,
        \"deviceId\": 3,
        \"interfaceName\": \"new33\",
        \"vpnName\": null,
        \"tunnelSourceIpAddr\": \"3.3.3.33\",
        \"tunnelDestIpAddr\": \"1.1.1.11\"
    },
    {
        \"id\": 25,
        \"generic\": false,
        \"deviceId\": 1,
        \"interfaceName\": \"new111\",
        \"vpnName\": null,
        \"tunnelSourceIpAddr\": \"1.1.1.11\",
        \"tunnelDestIpAddr\": \"3.3.3.33\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Vpn/Management/GenericDevice Not Found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"GenericVpns\": [\n\t{\n\t\t\"id\": 24,\n\t\t\"generic\": true,\n\t\t\"deviceId\": 3,\n\t\t\"interfaceName\": \"new33\",\n\t\t\"vpnName\": null,\n\t\t\"tunnelSourceIpAddr\": \"3.3.3.33\",\n\t\t\"tunnelDestIpAddr\": \"1.1.1.11\"\n\t},\n\t{\n\t\t\"id\": 25,\n\t\t\"generic\": false,\n\t\t\"deviceId\": 1,\n\t\t\"interfaceName\": \"new111\",\n\t\t\"vpnName\": null,\n\t\t\"tunnelSourceIpAddr\": \"1.1.1.11\",\n\t\t\"tunnelDestIpAddr\": \"3.3.3.33\"\n\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/","collectionId":"1","id":"1-14-68","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get Transparent Firewalls","description":"Get Transparent Firewalls for participated managed/generic DeviceId

Parameters:
deviceId [optional]
generic [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/transparentfw/device/9?generic=false
OUTPUT{
    TransparentFirewalls: [
        {
            id: 17,
            outputL3DeviceId: 22,
            outputL3IsGenericDevice: false,
            outputL3InterfaceName: \"FastEthernet0/0\",
            layer2DeviceId: 9,
            inputL2InterfaceName: \"inside\",
            outputL2InterfaceName: \"outside\",
            inputL3DeviceId: 1,
            inputL3IsGenericDevice: true,
            inputL3InterfaceName: \"interface2\"
        },
        {
            id: 23,
            outputL3DeviceId: 23,
            outputL3IsGenericDevice: false,
            outputL3InterfaceName: \"FastEthernet2/0\",
            layer2DeviceId: 9,
            inputL2InterfaceName: \"inside\",
            outputL2InterfaceName: \"outside\",
            inputL3DeviceId: 17,
            inputL3IsGenericDevice: false,
            inputL3InterfaceName: \"mgmt\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw/device/{{deviceId}}","collectionId":"1","id":"1-14-69","method":"GET"},{"headers":"Accept: application/json\n","name":"Delete Transparent Firewalls.","description":"Delete Transparent Firewalls for participated layer 2 deviceId

Parameters:
deviceId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/transparentfw/device/9\n

Response Messages:
200: 4 entries deleted where layer2 deviceId = 9
400: Bad Request.
401: Access is denied.
404: DeviceId 9 not found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw/device/{{deviceId}}","collectionId":"1","id":"1-14-70","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Delete generic Vpns","description":"Delete all generic Vpns from management/genericDevice Id.

Parameters:
deviceId [optional]
generic [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/vpn/device/2?generic=false\n

Response Messages:
200: 4 Generic Vpns were deleted from mgmtId 2.
400: Bad Request.
401: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/device/{{deviceId}}","collectionId":"1","id":"1-14-71","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get generic Vpns","description":"Get generic Vpns of management/genericDevice Id.

Parameters:
deviceId [optional]
generic [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/vpn/device/3?generic=true
OUTPUT{
    GenericVpns: [
    {
        id: 17,
        generic: true,
        deviceId: 3,
        interfaceName: \"777\",
        tunnelSourceIpAddr: \"1.1.1.177\",
        tunnelDestIpAddr: \"1.1.1.188\"
    },
    {
        id: 22,
        generic: true,
        deviceId: 3,
        interfaceName: \"111\",
        tunnelSourceIpAddr: \"1.1.1.188\",
        tunnelDestIpAddr: \"1.1.1.177\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/device/{{deviceId}}","collectionId":"1","id":"1-14-72","method":"GET"},{"headers":"Accept: application/json\n","name":"Get topology subnets","description":"Returns a list of the topology subnets for all the domains for which the user has permission to access.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
Use the optional name parameter to restrict the results to topology subnet names that match the search criteria provided, as follows:
1. If you provide only a mask, then an exact match search is done on the mask portion of the name
e.g. if name=/2, the results will include 1.2.3.4/2, but not 1.2.3.4/22
2. If you provide only a partial or complete IP address, then a contains search is done in the IPv4 block portion of the name
e.g. name=32, the results will include 192.168.205.32/24 and 55.192.32.22/16, but will not include 55.168.205.5/32
3. If you provide both an IPv4 address (either partial or complete) and a mask, then an exact match search is done
e.g. if name=23.4/2, then the results will include 192.168.23.4/2, but will not include 192.168.23.4/23 or 23.4.192.168/2

The default pagination is start=0 and count=50.

Parameters:
context: Global MSSP context [optional]
name: Subnet name [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/subnets?name=10.27
OUTPUT{
    \"topology_subnets\": {
        \"count\": 4,
        \"total\": 4,
        \"subnets\": [
            {
                \"id\": 615,
                \"name\": \"10.27.122.20/32\",
                \"ip\": \"10.27.122.20\",
                \"mask\": \"255.255.255.255\"
            },
            {
                \"id\": 616,
                \"name\": \"10.27.122.60/32\",
                \"ip\": \"10.27.122.60\",
                \"mask\": \"255.255.255.255\"
            },
            {
                \"id\": 619,
                \"name\": \"10.27.122.0/30\",
                \"ip\": \"10.27.122.0\",
                \"mask\": \"255.255.255.252\"
            },
            {
                \"id\": 620,
                \"name\": \"10.27.122.4/30\",
                \"ip\": \"10.27.122.4\",
                \"mask\": \"255.255.255.252\"
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/subnets?name=144/30
OUTPUT{
    \"topology_subnets\": {
        \"count\": 2,
        \"total\": 2,
        \"subnets\": [
            {
                \"id\": 773,
                \"name\": \"10.13.64.144/30\",
                \"ip\": \"10.13.64.144\",
                \"mask\": \"255.255.255.252\"
            },
            {
                \"id\": 825,
                \"name\": \"10.15.64.144/30\",
                \"ip\": \"10.15.64.144\",
                \"mask\": \"255.255.255.252\"
            }
        ]
    }
}


Response Messages:
401: Access is denied
401: Only users with ‘Super admin’ permissions can access Global domain map
401: You do not have access permission to domain id: domainId","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/subnets","collectionId":"1","id":"1-14-73","method":"GET"},{"headers":"Accept: application/json\n","name":"Delete Transparent Firewall","description":"Delete Transparent Firewall by Id.

Parameters:
layer2DataId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/transparentfw/17\n

Response Messages:
200: layer2DataId 17 deleted.
400: Bad Request.
401: Access is denied.
404: Layer2Data Id 17 not found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw/{{layer2DataId}}","collectionId":"1","id":"1-14-74","method":"DELETE"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Create Join Cloud","dataMode":"raw","description":"Create Join Cloud.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/join/clouds
BODY{
    \"JoinCloud\" :
    {
        \"name\" : \"Yami\",
        \"clouds\" : [1, 2]
    }
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Cloud Not Found.
500: General error occurred.","folder":"1-14","rawModeData":"{ \n\t\"JoinCloud\" : \n\t{\n\t\t\"name\" : \"Yami\",\n\t\t\"clouds\" : [1, 2]\n\t}\n} ","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/join/clouds/","collectionId":"1","id":"1-14-75","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Update Join Cloud","dataMode":"raw","description":"Update Join Clouds.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/join/clouds
BODY{
    \"JoinCloud\" :
    {
        \"id\" : 67,
        \"name\" : \"Yamile\",
        \"clouds\" : [1, 2, 57]
    }
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Cloud Not Found.
500: General error occurred.","folder":"1-14","rawModeData":"{ \n\t\"JoinCloud\" : \n\t{\n\t\t\"id\" : 67,\n\t\t\"name\" : \"Yamile\",\n\t\t\"clouds\" : [1, 2, 57]\n\t}\n} ","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/join/clouds/","collectionId":"1","id":"1-14-76","method":"PUT"},{"name":"Get path image for specified traffic","data":[{"value":null,"type":"text","enabled":true,"key":"src"},{"value":null,"type":"text","enabled":true,"key":"dst"},{"value":null,"type":"text","enabled":true,"key":"service"}],"dataMode":"params","description":"Returns an image containing one or more paths for the specified traffic.
src and dst parameters may contain multiple, comma separated values.
Service parameter can be a port (for example, “tcp:80”, “any”) or an application (for example, “Skype”, “Facebook”).
Application names are case sensitive.
Service parameter can also be a combination of ports and applications, for example “tcp:80, Skype, Facebook”
If sourceDomainIdTag is provided, the path starting points will be restricted to the specified domain ID. sourceDomainIdTag is valid only if overlapping IP mode is enabled.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is valid only if MSSP mode is enabled.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.
displayIncompletePaths parameter default value is false, if this parameter is set to true -
all nodes on the path will be displayed, even if the node cannot reach the destination, or if the source and destination are the same.
displayBlockedStatus parameter default value is false, if this parameter is set to true -
blocked traffic icons will be displayed next to devices blocking the traffic.
simulateNat parameter default value is true if this parameter is set to false - NAT simulation will not be used when calculating the path.
lastInstall parameter default value is true, which means simulation would use last installed policies. If this parameter is set to false - simulation would use last saved policies.
This API cannot be executed more than 10 times in parallel.

Parameters:
context: Global MSSP context [optional]
src: Source address/addresses
dst: Destination address/addresses
service: Service/services
sourceDomainIdTag: Path starting point Domain Id [optional]
displayIncompletePaths: Display incomplete paths [optional]
displayBlockedStatus: Display blocked traffic status icons [optional]
simulateNat: Simulate NAT [optional]
lastInstall: Last Installed [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/path_image?src=10.10.10.1&dst=3.3.3.3:32&service=any

Usage Example
https://192.168.1.1/securetrack/api/topology/path_image?src=10.10.10.1&dst=3.3.3.3:32&service=Facebook,tcp:80
","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/path_image","collectionId":"1","id":"1-14-77","method":"GET"},{"headers":"Accept: application/json\n","name":"Delete generic Vpn","description":"Delete a generic Vpn by Id.

Parameters:
vpnId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/vpn/5\n

Response Messages:
204: No Content.
400: Bad Request.
401: Access is denied.
404: Generic Vpn Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/{{vpnId}}","collectionId":"1","id":"1-14-78","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get generic Vpn","description":"Get a generic Vpn by Id.

Parameters:
vpnId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/vpn/18
OUTPUT{
    GenericVpn: {
        id: 18,
        generic: false,
        deviceId: 2,
        interfaceName: \"777\",
        tunnelSourceIpAddr: \"1.1.1.77\",
        tunnelDestIpAddr: \"1.1.1.88\"
    }
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Generic Vpn Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/{{vpnId}}","collectionId":"1","id":"1-14-79","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Update generic Interfaces","dataMode":"raw","description":"Update generic Interfaces.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interface
BODY{
    \"GenericInterfaces\": [
    {
        \"id\": 204,
        \"mgmtId\": 1,
        \"name\": \"NewBob1\",
        \"ip\": \"100.100.45.55\",
        \"mask\": \"255.255.0.0\",
        \"vrf\": \"V101-LV\",
        \"mpls\": false,
        \"unnumbered\": false,
        \"type\": null
    },
    {
        \"id\": 205,
        \"mgmtId\": 2,
        \"name\": \"NewBob2\",
        \"ip\": \"100.100.45.55\",
        \"mask\": \"255.255.255.0\",
        \"vrf\": \"V101-LV\",
        \"mpls\": false,
        \"unnumbered\": false,
        \"type\": \"external\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Interface/Management Not Found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"GenericInterfaces\": [\n\t{\n\t\t\"id\": 204,\n\t\t\"mgmtId\": 1,\n\t\t\"name\": \"NewBob1\",\n\t\t\"ip\": \"100.100.45.55\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"vrf\": \"V101-LV\",\n\t\t\"mpls\": false,\n\t\t\"unnumbered\": false,\n\t\t\"type\": null\n\t},\n\t{\n\t\t\"id\": 205,\n\t\t\"mgmtId\": 2,\n\t\t\"name\": \"NewBob2\",\n\t\t\"ip\": \"100.100.45.55\",\n\t\t\"mask\": \"255.255.255.0\",\n\t\t\"vrf\": \"V101-LV\",\n\t\t\"mpls\": false,\n\t\t\"unnumbered\": false,\n\t\t\"type\": \"external\"\n\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface","collectionId":"1","id":"1-14-80","method":"PUT"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Create generic Interfaces","dataMode":"raw","description":"Create generic Interfaces.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interface
BODY{
    \"GenericInterfaces\": [
    {
        \"mgmtId\": 1,
        \"name\": \"Bob1\",
        \"ip\": \"100.100.45.55\",
        \"mask\": \"255.255.0.0\",
        \"vrf\": \"V101-PA\",
        \"mpls\": false,
        \"unnumbered\": false,
        \"type\": \"external\"
    },
    {
        \"mgmtId\": 2,
        \"name\": \"Bob2\",
        \"ip\": \"100.100.45.66\",
        \"mask\": \"255.255.255.0\",
        \"vrf\": \"V101-BA\",
        \"mpls\": false,
        \"unnumbered\": false,
        \"type\": \"external\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Management Not Found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"GenericInterfaces\": [\n\t{\n\t\t\"mgmtId\": 1,\n\t\t\"name\": \"Bob1\",\n\t\t\"ip\": \"100.100.45.55\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"vrf\": \"V101-PA\",\n\t\t\"mpls\": false,\n\t\t\"unnumbered\": false,\n\t\t\"type\": \"external\"\n\t},\n\t{\n\t\t\"mgmtId\": 2,\n\t\t\"name\": \"Bob2\",\n\t\t\"ip\": \"100.100.45.66\",\n\t\t\"mask\": \"255.255.255.0\",\n\t\t\"vrf\": \"V101-BA\",\n\t\t\"mpls\": false,\n\t\t\"unnumbered\": false,\n\t\t\"type\": \"external\"\n\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface","collectionId":"1","id":"1-14-81","method":"POST"},{"headers":"Accept: application/json\n","name":"Get generic Interfaces","description":"Get generic Interfaces of management Id.

Parameters:
mgmtId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interface/mgmt/1
OUTPUT{
    GenericInterfaces: [
    {
        id: 206,
        mgmtId: 1,
        name: \"newApo3\",
        ip: \"100.103.33.33\",
        mask: \"255.255.255.0\",
        vrf: \"V101-PA\",
        mpls: false,
        unnumbered: false,
        type: \"external\"
    },
    {
        id: 208,
        mgmtId: 1,
        name: \"newApo4\",
        ip: \"100.103.33.34\",
        mask: \"255.255.255.0\",
        vrf: \"V101-PA\",
        mpls: false,
        unnumbered: false,
        type: \"internal\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Management Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface/mgmt/{{mgmtId}}","collectionId":"1","id":"1-14-82","method":"GET"},{"headers":"Accept: application/json\n","name":"Delete generic Interfaces","description":"Delete all generic Interfaces from management Id.

Parameters:
mgmtId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/interface/mgmt/2\n

Response Messages:
200: 11 Generic Interfaces were deleted from mgmtId 2.
400: Bad Request.
401: Access is denied.
404: Management Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface/mgmt/{{mgmtId}}","collectionId":"1","id":"1-14-83","method":"DELETE"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Create Ignored Interfaces.","dataMode":"raw","description":"Create Ignored Interfaces.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/ignoredinterface
BODY{
    \"IgnoredInterfaces\":
    [
        {
            \"interfaceName\" : \"eth2\",
            \"mgmtId\" : 10,
            \"ip\" : \"0.0.0.0\"
        },
        {
            \"interfaceName\" : \"loopback100\",
            \"mgmtId\" : 10,
            \"ip\" : \"34.34.34.34\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Management Id 10 not found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"IgnoredInterfaces\": \n\t[\n\t\t{\n\t\t\t\"interfaceName\" : \"eth2\",\n\t\t\t\"mgmtId\" : 10,\n\t\t\t\"ip\" : \"0.0.0.0\"\n\t\t},\n\t\t{\n\t\t\t\"interfaceName\" : \"loopback100\",\n\t\t\t\"mgmtId\" : 10,\n\t\t\t\"ip\" : \"34.34.34.34\"\n\t\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/ignoredinterface","collectionId":"1","id":"1-14-84","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Create manual Interface CustomerTags","dataMode":"raw","description":"Create manual Interface CustomerTags.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interfacecustomer
BODY{
    \"InterfaceCustomerTags\":
    [
        {
            \"generic\": false,
            \"deviceId\": 5,
            \"interfaceName\": \"port4\",
            \"customerId\": 2
        },
        {
            \"generic\": false,
            \"deviceId\": 6,
            \"interfaceName\": \"port3\",
            \"customerId\": 3
        }
    ]
}


Response Messages:
200: OK.
400: Interface CustomerTag already exist for deviceId-InterfaceName/Interface not found on deviceId
401: Access is denied.
404: Management/GenericDevice Not Found./Customer Id not found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"InterfaceCustomerTags\": \n\t[\n\t\t{\n\t\t\t\"generic\": false,\n\t\t\t\"deviceId\": 5,\n\t\t\t\"interfaceName\": \"port4\",\n\t\t\t\"customerId\": 2\n\t\t},\n\t\t{\n\t\t\t\"generic\": false,\n\t\t\t\"deviceId\": 6,\n\t\t\t\"interfaceName\": \"port3\",\n\t\t\t\"customerId\": 3\n\t\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/","collectionId":"1","id":"1-14-85","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Update manual Interface CustomerTags","dataMode":"raw","description":"Update manual Interface CustomerTags.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interfacecustomer
BODY{
    \"InterfaceCustomerTags\":
    [
        {
            \"id\": 73,
            \"generic\": false,
            \"deviceId\": 5,
            \"interfaceName\": \"port5\",
            \"customerId\": 2
        },
        {
            \"id\": 74,
            \"generic\": false,
            \"deviceId\": 5,
            \"interfaceName\": \"port3\",
            \"customerId\": 3
        }
    ]
}


Response Messages:
200: OK.
400: Interface CustomerTag already exist for deviceId-InterfaceName/Interface not found on deviceId
401: Access is denied.
404: Management/GenericDevice Not Found./Customer Id not found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"InterfaceCustomerTags\": \n\t[\n\t\t{\n\t\t\t\"id\": 73,\n\t\t\t\"generic\": false,\n\t\t\t\"deviceId\": 5,\n\t\t\t\"interfaceName\": \"port5\",\n\t\t\t\"customerId\": 2\n\t\t},\n\t\t{\n\t\t\t\"id\": 74,\n\t\t\t\"generic\": false,\n\t\t\t\"deviceId\": 5,\n\t\t\t\"interfaceName\": \"port3\",\n\t\t\t\"customerId\": 3\n\t\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/","collectionId":"1","id":"1-14-86","method":"PUT"},{"headers":"Accept: application/json\n","name":"Delete manual Interface CustomerTag","description":"Delete a manual Interface CustomerTag by Id.

Parameters:
interfaceCustomerId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/interfacecustomer/66\n

Response Messages:
204: No Content.
400: Bad Request.
401: Access is denied.
404: InterfaceCustomer Id 66 not found
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/{{interfaceCustomerId}}","collectionId":"1","id":"1-14-87","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get manual Interface CustomerTag","description":"Get manual Interface CustomerTag by Id.

Parameters:
interfaceCustomerId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interfacecustomer/74
OUTPUT{
    InterfaceCustomerTag: {
        id: 74,
        generic: false,
        deviceId: 5,
        interfaceName: \"port4.1\",
        customerId: 3
    }
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: InterfaceCustomer Id 74 not found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/{{interfaceCustomerId}}","collectionId":"1","id":"1-14-88","method":"GET"},{"headers":"Accept: application/json\n","name":"Get manual Interface CustomerTags","description":"Get manual Interface CustomerTags of management/genericDevice Id.

Parameters:
deviceId [optional]
generic [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interfacecustomer/device/5?generic=false
OUTPUT{
    InterfaceCustomerTags: [
        {
            id: 73,
            generic: false,
            deviceId: 5,
            interfaceName: \"port4\",
            customerId: 2
        },
        {
            id: 74,
            generic: false,
            deviceId: 5,
            interfaceName: \"port4.1\",
            customerId: 3
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/device/{{deviceId}}","collectionId":"1","id":"1-14-89","method":"GET"},{"headers":"Accept: application/json\n","name":"Delete manual Interface CustomerTags","description":"Delete all manual Interface CustomerTags from management/genericDevice Id.

Parameters:
deviceId [optional]
generic [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/interfacecustomer/device/6?generic=false\n

Response Messages:
200: 2 Interface Customers were deleted from deviceId 6.
400: Bad Request.
401: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/device/{{deviceId}}","collectionId":"1","id":"1-14-90","method":"DELETE"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Create generic Routes","dataMode":"raw","description":"Create generic Routes.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/route
BODY{
    \"GenericRoutes\": [
    {
        \"mgmtId\": 1,
        \"destination\": \"111.100.10.11\",
        \"mask\": \"255.255.0.0\",
        \"interfaceName\": \"YOLO3\",
        \"nextHop\": \"100.100.10.10\",
        \"nextHopType\": \"IP\",
        \"vrf\": \"V103-KO\"
    },
    {
        \"mgmtId\": 2,
        \"destination\": \"222.100.10.22\",
        \"mask\": \"255.255.0.0\",
        \"interfaceName\": \"catch22\",
        \"nextHop\": \"100.100.10.10\",
        \"nextHopType\": \"IP\",
        \"vrf\": \"V103-KO\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Management Not Found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"GenericRoutes\": [\n\t{\n\t\t\"mgmtId\": 1,\n\t\t\"destination\": \"111.100.10.11\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"interfaceName\": \"YOLO3\",\n\t\t\"nextHop\": \"100.100.10.10\",\n\t\t\"nextHopType\": \"IP\",\n\t\t\"vrf\": \"V103-KO\"\n\t},\n\t{\n\t\t\"mgmtId\": 2,\n\t\t\"destination\": \"222.100.10.22\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"interfaceName\": \"catch22\",\n\t\t\"nextHop\": \"100.100.10.10\",\n\t\t\"nextHopType\": \"IP\",\n\t\t\"vrf\": \"V103-KO\"\n\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/","collectionId":"1","id":"1-14-91","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Update generic Routes","dataMode":"raw","description":"Update generic Routes.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/route
BODY{
    \"GenericRoutes\": [
    {
        \"id\": 29,
        \"mgmtId\": 3,
        \"destination\": \"111.100.10.11\",
        \"mask\": \"255.255.0.0\",
        \"interfaceName\": \"YOLO3\",
        \"nextHop\": \"100.100.10.10\",
        \"nextHopType\": \"IP\",
        \"vrf\": \"V103-KO\"
    },
    {
        \"id\": 30,
        \"mgmtId\": 3,
        \"destination\": \"222.100.10.22\",
        \"mask\": \"255.255.0.0\",
        \"interfaceName\": \"catch22\",
        \"nextHop\": \"100.100.10.10\",
        \"nextHopType\": \"IP\",
        \"vrf\": \"V103-KO\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Interface/Management Not Found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"GenericRoutes\": [\n\t{\n\t\t\"id\": 29,\n\t\t\"mgmtId\": 3,\n\t\t\"destination\": \"111.100.10.11\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"interfaceName\": \"YOLO3\",\n\t\t\"nextHop\": \"100.100.10.10\",\n\t\t\"nextHopType\": \"IP\",\n\t\t\"vrf\": \"V103-KO\"\n\t},\n\t{\n\t\t\"id\": 30,\n\t\t\"mgmtId\": 3,\n\t\t\"destination\": \"222.100.10.22\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"interfaceName\": \"catch22\",\n\t\t\"nextHop\": \"100.100.10.10\",\n\t\t\"nextHopType\": \"IP\",\n\t\t\"vrf\": \"V103-KO\"\n\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/","collectionId":"1","id":"1-14-92","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get Cloud Internal Networks","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the internal networks for the specified Cloud management id.
This API requires 'Super admin' privileges.

Parameters:
id: Cloud management id

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/cloud_internal_networks/20
OUTPUT{
    \"network_list\":
    {
        \"count\": 3,
        \"total\": 3,
        \"network\":
        {
            \"ip\": \"10.27.122.20\",
            \"mask\": \"255.255.255.255\"
        },
        \"network\":
        {
            \"ip\": \"10.27.122.60\",
            \"mask\": \"255.255.255.255\"
        },
        \"network\":
        {
            \"ip\": \"10.27.122.4\",
            \"mask\": \"255.255.255.252\"
        }
    }
}


Response Messages:
401: Access is denied
401: You do not have access permission to the domain for NSX with id ID
401: Device ID specified is not supported
404: The specified device ID was not found
404: The specified device ID was not found in Topology","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/cloud_internal_networks/{{id}}","collectionId":"1","id":"1-14-93","method":"GET"},{"headers":"Accept: application/json\n","name":"Synchronize the Topology model","description":"Invoke of the Topology Model Synchronization.
full_sync=false - Builds the topology model from the information stored in the Tufin database.
full_sync=true - Retrieves the current data from devices and builds the topology model.
Default value for full_sync = false.

Parameters:
full_sync: Perform full sync [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/synchronize

Usage Example
https://192.168.1.1/securetrack/api/topology/synchronize?full_sync=true

Response Messages:
200: The topology synchronization was invoked successfully.
401: Access is denied
500: Error Synchronizing Topology Model","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/synchronize","collectionId":"1","id":"1-14-94","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Create Transparent Firewalls","dataMode":"raw","description":"Create Transparent Firewalls.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/transparentfw
BODY{
    \"TransparentFirewalls\":
    [
     {
            \"outputL3DeviceId\" : 22,
            \"outputL3IsGenericDevice\" : false,
            \"outputL3InterfaceName\" : \"FastEthernet0/0\",
            \"outputL3InterfaceIp\" : \"\",
            \"layer2DeviceId\" : 21,
            \"inputL2InterfaceName\" : \"inside\",
            \"outputL2InterfaceName\" : \"outside\",
            \"inputL3DeviceId\" : 20,
            \"inputL3IsGenericDevice\" : false,
            \"inputL3InterfaceName\" : \"Loopback0\",
            \"inputL3InterfaceIp\" : \"\"
        },
        {
            \"outputL3DeviceId\" : 23,
            \"outputL3IsGenericDevice\" : false,
            \"outputL3InterfaceName\" : \"FastEthernet2/0\",
            \"outputL3InterfaceIp\" : \"\",
            \"layer2DeviceId\" : 9,
            \"inputL2InterfaceName\" : \"inside\",
            \"outputL2InterfaceName\" : \"outside\",
            \"inputL3DeviceId\" : 17,
            \"inputL3IsGenericDevice\" : false,
            \"inputL3InterfaceName\" : \"mgmt\",
            \"inputL3InterfaceIp\" : \"\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Device Id 23 not found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"TransparentFirewalls\": \n\t[\n\t {\n\t\t\t\"outputL3DeviceId\" : 22,\n\t\t\t\"outputL3IsGenericDevice\" : false,\n\t\t\t\"outputL3InterfaceName\" : \"FastEthernet0/0\",\n\t\t\t\"outputL3InterfaceIp\" : \"\",\n\t\t\t\"layer2DeviceId\" : 21,\n\t\t\t\"inputL2InterfaceName\" : \"inside\",\n\t\t\t\"outputL2InterfaceName\" : \"outside\",\n\t\t\t\"inputL3DeviceId\" : 20,\n\t\t\t\"inputL3IsGenericDevice\" : false,\n\t\t\t\"inputL3InterfaceName\" : \"Loopback0\",\n\t\t\t\"inputL3InterfaceIp\" : \"\"\n\t\t},\n\t\t{\n\t\t\t\"outputL3DeviceId\" : 23,\n\t\t\t\"outputL3IsGenericDevice\" : false,\n\t\t\t\"outputL3InterfaceName\" : \"FastEthernet2/0\",\n\t\t\t\"outputL3InterfaceIp\" : \"\",\n\t\t\t\"layer2DeviceId\" : 9,\n\t\t\t\"inputL2InterfaceName\" : \"inside\",\n\t\t\t\"outputL2InterfaceName\" : \"outside\",\n\t\t\t\"inputL3DeviceId\" : 17,\n\t\t\t\"inputL3IsGenericDevice\" : false,\n\t\t\t\"inputL3InterfaceName\" : \"mgmt\",\n\t\t\t\"inputL3InterfaceIp\" : \"\"\n\t\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw","collectionId":"1","id":"1-14-95","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Update Transparent Firewalls","dataMode":"raw","description":"Update Transparent Firewalls.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/transparentfw
BODY{
    \"TransparentFirewalls\":
    [
     {
            \"id\" : 25,
            \"outputL3DeviceId\" : 22,
            \"outputL3IsGenericDevice\" : false,
            \"outputL3InterfaceName\" : \"FastEthernet0/0\",
            \"outputL3InterfaceIp\" : \"\",
            \"layer2DeviceId\" : 21,
            \"inputL2InterfaceName\" : \"inside\",
            \"outputL2InterfaceName\" : \"outside\",
            \"inputL3DeviceId\" : 20,
            \"inputL3IsGenericDevice\" : false,
            \"inputL3InterfaceName\" : \"Loopback2\",
            \"inputL3InterfaceIp\" : \"\"
        },
        {
            \"id\" : 27,
            \"outputL3DeviceId\" : 23,
            \"outputL3IsGenericDevice\" : false,
            \"outputL3InterfaceName\" : \"FastEthernet2/0\",
            \"outputL3InterfaceIp\" : \"\",
            \"layer2DeviceId\" : 9,
            \"inputL2InterfaceName\" : \"inside\",
            \"outputL2InterfaceName\" : \"outside\",
            \"inputL3DeviceId\" : 17,
            \"inputL3IsGenericDevice\" : false,
            \"inputL3InterfaceName\" : \"mgmt2\",
            \"inputL3InterfaceIp\" : \"\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Device Id 23 not found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"TransparentFirewalls\": \n\t[\n\t {\n\t\t\t\"id\" : 25,\n\t\t\t\"outputL3DeviceId\" : 22,\n\t\t\t\"outputL3IsGenericDevice\" : false,\n\t\t\t\"outputL3InterfaceName\" : \"FastEthernet0/0\",\n\t\t\t\"outputL3InterfaceIp\" : \"\",\n\t\t\t\"layer2DeviceId\" : 21,\n\t\t\t\"inputL2InterfaceName\" : \"inside\",\n\t\t\t\"outputL2InterfaceName\" : \"outside\",\n\t\t\t\"inputL3DeviceId\" : 20,\n\t\t\t\"inputL3IsGenericDevice\" : false,\n\t\t\t\"inputL3InterfaceName\" : \"Loopback2\",\n\t\t\t\"inputL3InterfaceIp\" : \"\"\n\t\t},\n\t\t{\n\t\t\t\"id\" : 27,\n\t\t\t\"outputL3DeviceId\" : 23,\n\t\t\t\"outputL3IsGenericDevice\" : false,\n\t\t\t\"outputL3InterfaceName\" : \"FastEthernet2/0\",\n\t\t\t\"outputL3InterfaceIp\" : \"\",\n\t\t\t\"layer2DeviceId\" : 9,\n\t\t\t\"inputL2InterfaceName\" : \"inside\",\n\t\t\t\"outputL2InterfaceName\" : \"outside\",\n\t\t\t\"inputL3DeviceId\" : 17,\n\t\t\t\"inputL3IsGenericDevice\" : false,\n\t\t\t\"inputL3InterfaceName\" : \"mgmt2\",\n\t\t\t\"inputL3InterfaceIp\" : \"\"\n\t\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw","collectionId":"1","id":"1-14-96","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get topology network interfaces by device","data":[{"value":null,"type":"text","enabled":true,"key":"mgmtId"}],"dataMode":"params","description":"The returned interfaces are taken from the topology data and will include only devices that are topology enabled.
When adding a device, the user can can choose whether to use dynamic or static topology for the device,
this choice will determine which kind of data is stored in the topology graph and returned by this API.

The parameter mgmtId should be a cluster or a gateway, not a management server.
You may provide a generic device Id (see generic_devices API under 'Monitored Devices' category) -
in this case make sure you set 'is_generic' parameter to 'true'

Parameters:
context: Global MSSP context [optional]
mgmtId: Management Id or Generic Device Id to query
is_generic: Should be set to 'true' if the provided mgmtId is related to generic device [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_interfaces?mgmtId=10

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_interfaces?mgmtId=1&is_generic=true
","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/topology_interfaces","collectionId":"1","id":"1-14-97","method":"GET"},{"headers":"Accept: application/json\n","name":"Get Specific topology cloud","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the topology cloud data for the specified id.
This API requires 'Super admin' or 'Multi-Domain admin' privileges.
Multi-Domain user must have access permission to the domain where the cloud resides.

Parameters:
id: Cloud id

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds/48
OUTPUT{
    \"topology_cloud\": {
        \"id\": 48,
        \"name\": \"Cloud 69.70.120.155\",
        \"domain\": 1,
        \"type\": \"NON_JOINED\",
        \"ip\": \"69.70.120.155\"
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds/66
OUTPUT{
    \"topology_cloud\": {
        \"id\": 66,
        \"name\": \"Cloud 10.100.10.14\",
        \"domain\": 1,
        \"type\": \"JOINED\",
        \"members\": [
            {
                \"id\": 50,
                \"ip\": \"10.100.6.238\",
                \"name\": \"Cloud 10.100.6.238\"
            },
            {
                \"id\": 73,
                \"ip\": \"10.100.10.14\",
                \"name\": \"Cloud 10.100.10.14\"
            },
            {
                \"id\": 74,
                \"ip\": \"10.100.9.9\",
                \"name\": \"Cloud 10.100.9.9\"
            }
        ]
    }
}


Response Messages:
401: Access is denied
401: You do not have access permission to the domain for cloud with id ID
404: No cloud was found for the provided ID","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds/{{id}}","collectionId":"1","id":"1-14-98","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Update a cloud","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"raw","description":"Modify the name of a topology cloud, and add/remove members of a joined cloud.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
Multi-Domain user must have access permission to the domain context of the joined cloud, and any members specified in the body.
To change the name of a topology cloud, enter a value in the name field of the body.
To add/remove members of a joined cloud, specify the action and specify the clouds in the members list of the body.
The action is used only if the body contains a members list. If a members list is provided but no actions is specified, then the default action is ‘add’.
When adding cloud members, clouds included in the members list of the body must not be joined clouds or members of another joined cloud.
When removing cloud members, if only zero or one member remains in the joined cloud, it will be deleted from the Interactive Map.

Parameters:
id: cloud id
action: action [optional]
body: Cloud data

Usage Example
URLfor renaming of any cloud - https://192.168.1.1/securetrack/api/topology/clouds/436
BODY{
    \"cloud_data\":{
        \"cloud_name\" : \"new cloud\"
    }
}


Usage Example
URLfor renaming and members updating of a joined cloud - https://192.168.1.1/securetrack/api/topology/clouds/436?action=remove
BODY{
    \"cloud_data\":{
        \"cloud_name\" : \"new cloud\",
        \"cloud_members\" : [118,179,258]
    }
}


Response Messages:
204: Cloud updated successfully
401: Access is denied
401: You do not have access permission to the domain for cloud with id ID
404: Cloud with id ID was not found in the provided MSSP domain
412: Cloud with id ID is a not joined cloud
412: Cloud id: cloudId does not belong to domain: Context
412: Provided clouds don't belongs to the same domain
412: Cloud with id ID is a joined cloud
412: Cloud with id ID is a member of a joined cloud
412: Member cloud with id ID cannot be removed - it is not a member of a joined cloud","folder":"1-14","rawModeData":"{\n\t\"cloud_data\":{\n\t\t\"cloud_name\" : \"new cloud\",\n\t\t\"cloud_members\" : [118,179,258]\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds/{{id}}","collectionId":"1","id":"1-14-99","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get Topology Synchronization status","description":"Returns the progress status of the Topology Model Synchronization.



Usage Example
https://192.168.1.1/securetrack/api/topology/synchronize/status

Response Messages:
200: The topology synchronization was invoked successfully.
401: Access is denied
500: Error getting synchronize progress","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/synchronize/status","collectionId":"1","id":"1-14-100","method":"GET"},{"headers":"Accept: application/json\n","name":"Delete Join Cloud","description":"Delete Join Cloud by Id.

Parameters:
cloudId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/join/clouds/67\n

Response Messages:
204: No Content.
400: Bad Request.
401: Access is denied.
404: Cloud Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/join/clouds/{{cloudId}}","collectionId":"1","id":"1-14-101","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get Join Cloud","description":"Get Join Cloud by Id.

Parameters:
cloudId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/join/clouds/67
OUTPUT{
    id: 67,
    name: \"Yami\",
    clouds: [
        1,
        2,
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Cloud Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/join/clouds/{{cloudId}}","collectionId":"1","id":"1-14-102","method":"GET"},{"headers":"Accept: application/json\n","name":"Get generic Interface","description":"Get a generic Interface by Id.

Parameters:
inId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interface/212
OUTPUT{
    GenericInterface: {
        id: 212,
        mgmtId: 1,
        name: \"newApo5\",
        ip: \"100.103.33.33\",
        mask: \"255.255.255.0\",
        vrf: \"V101-PAL\",
        mpls: false,
        unnumbered: false,
        type: \"external\"
    }
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Generic Interface Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface/{{inId}}","collectionId":"1","id":"1-14-103","method":"GET"},{"headers":"Accept: application/json\n","name":"Delete generic Interface","description":"Delete a generic Interface by Id.

Parameters:
inId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/interface/5\n

Response Messages:
204: No Content.
400: Bad Request.
401: Access is denied.
404: Generic Interface Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface/{{inId}}","collectionId":"1","id":"1-14-104","method":"DELETE"},{"headers":"Content-Type: application/json\n","name":"Create a joined topology cloud","dataMode":"raw","description":"Create a new topology cloud in the Interactive Map by joining existing clouds together.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
The body must include at least two topology cloud ids that are on a single domain.
If the context parameter is not provided, then the API will use the context id of the first member of the members list in the body.
Clouds included in the members list of the body must not be joined clouds or members of another joined cloud.
If the provided body does not specify a joined cloud name, the newly created topology cloud will be given the name of the first member of the members list in the body.


Parameters:
context: Global MSSP context [optional]
body: Cloud data

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds
BODY{
    \"cloud_data\":{
        \"cloud_name\" : \"optional new cloud name\",
        \"cloud_members\" : [118,179,258]
    }
}


Response Messages:
201: Joined cloud created successfully
401: Access is denied
401: You do not have access permission to the domain for cloud with id ID
404: Cloud with id ID was not found in the provided MSSP domain
412: You must provide 2 or more clouds
412: Cloud id: cloudId does not belong to domain: Context
412: Cloud with id ID is a joined cloud
412: Cloud with id ID is a member of a joined cloud","folder":"1-14","rawModeData":"{\n\t\"cloud_data\":{\n\t\t\"cloud_name\" : \"optional new cloud name\",\n\t\t\"cloud_members\" : [118,179,258]\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds","collectionId":"1","id":"1-14-105","method":"POST"},{"headers":"Accept: application/json\n","name":"Get topology clouds","description":"Returns a list of the topology clouds for all the domains for which the user has permission to access.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
Use the optional name parameter to restrict the results to topology clouds that contain the specified string.
The default pagination is start=0 and count=50.

Parameters:
context: Global MSSP context [optional]
type: Required clouds type [optional]
name: Cloud name [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds
OUTPUT{
    \"topology_clouds\": {
        \"count\": 3,
        \"total\": 3,
        \"topology_cloud\": [
            {
                \"id\": 48,
                \"name\": \"Cloud 69.70.120.155\",
                \"domain\": 1,
                \"type\": \"NON_JOINED\",
                \"ip\": \"69.70.120.155\"
            },
            {
                \"id\": 50,
                \"name\": \"Cloud 10.100.6.238\",
                \"domain\": 1,
                \"type\": \"MEMBER\",
                \"ip\": \"10.100.6.238\"
            },
            {
                \"id\": 66,
                \"name\": \"Cloud 10.100.10.14\",
                \"domain\": 1,
                \"type\": \"JOINED\",
                \"members\": [
                    {
                        \"id\": 50,
                        \"ip\": \"10.100.6.238\",
                        \"name\": \"Cloud 10.100.6.238\"
                    },
                    {
                        \"id\": 73,
                        \"ip\": \"10.100.10.14\",
                        \"name\": \"Cloud 10.100.10.14\"
                    },
                    {
                        \"id\": 74,
                        \"ip\": \"10.100.9.9\",
                        \"name\": \"Cloud 10.100.9.9\"
                    }
                ]
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds?type=non-joined
OUTPUT{
    \"topology_clouds\": {
        \"count\": 2,
        \"total\": 3,
        \"topology_cloud\": [
            {
                \"id\": 48,
                \"name\": \"Cloud 69.70.120.155\",
                \"domain\": 1,
                \"type\": \"NON_JOINED\",
                \"ip\": \"69.70.120.155\"
            },
            {
                \"id\": 50,
                \"name\": \"Cloud 10.100.6.238\",
                \"domain\": 1,
                \"type\": \"NON_JOINED\",
                \"ip\": \"10.100.6.238\"
            }
        ]
    }
}


Response Messages:
401: Access is denied
401: Only users with ‘Super admin’ permissions can access Global domain map
401: You do not have access permission to domain id: domainId
400: Wrong type provided - allowable values are: joined or non-joined","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds","collectionId":"1","id":"1-14-106","method":"GET"},{"headers":"Accept: application/json\n","name":"Get path for specified traffic","data":[{"value":null,"type":"text","enabled":true,"key":"src"},{"value":null,"type":"text","enabled":true,"key":"dst"},{"value":null,"type":"text","enabled":true,"key":"service"}],"dataMode":"params","description":"Returns one or more paths for the specified traffic.
src and dst parameters may contain multiple, comma separated values.
Service parameter can be a port (for example, “tcp:80”, “any”) or an application (for example, “Skype”, “Facebook”).
Application names are case sensitive.
Service parameter can also be a combination of ports and applications, for example “tcp:80, Skype, Facebook”
If sourceDomainIdTag is provided, the path starting points will be restricted to the specified domain ID. sourceDomainIdTag is valid only if overlapping IP mode is enabled.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is valid only if MSSP mode is enabled.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.
includeIncompletePaths parameter default value is false, if this parameter is set to true -
all nodes on the path will be included, even if the node cannot reach the destination, or if the source and destination are the same.
simulateNat parameter default value is true if this parameter is set to false - NAT simulation will not be used when calculating the path.
lastInstall parameter default value is true, which means simulation would use last installed policies. If this parameter is set to false - simulation would use last saved policies.
This API cannot be executed more than 10 times in parallel.

Parameters:
context: Global MSSP context [optional]
src: Source address/addresses
dst: Destination address/addresses
service: Service/services
sourceDomainIdTag: Path starting point Domain Id [optional]
includeIncompletePaths: Include incomplete paths [optional]
simulateNat: Simulate NAT [optional]
lastInstall: Last Installed [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/path?src=10.10.10.1&dst=3.3.3.3:32&service=any

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/path?src=29.29.29.1&dst=25.25.25.1&service=Facebook,tcp:80
OUTPUT {
    \"path_calc_results\": {
        \"traffic_allowed\": false,
        \"device_info\": {
            \"id\": \"17\",
            \"name\": \"PA-VM-111.6 (Cluster)\",
            \"type\": \"mgmt\",
            \"vendor\": \"Palo Alto Networks\",
            \"incomingInterfaces\": {
                \"incomingVrf\": \"default\",
                \"ip\": \"29.29.29.1/255.255.255.252\",
                \"name\": \"tunnel.11\"
            },
            \"nextDevices\": {
                \"name\": \"DIRECTLY_CONNECTED\",
                \"routes\": {
                    \"outgoingInterfaceName\": \"ethernet1/5\",
                    \"outgoingVrf\": \"default\",
                    \"routeDestination\": \"25.25.25.1/255.255.255.0\"
                }
            },
            \"bindings\": {
                \"name\": \"\",
                \"rules\": [
                    {
                        \"action\": \"Accept\",
                        \"applications\": \"facebook\",
                        \"destNegated\": false,
                        \"destinations\": \"Any\",
                        \"ruleIdentifier\": 43,
                        \"serviceNegated\": false,
                        \"services\": \"Any\",
                        \"sourceNegated\": false,
                        \"sources\": \"Any\",
                        \"users\": \"Any\"
                    },
                    {
                        \"action\": \"Deny\",
                        \"applications\": \"Any\",
                        \"destNegated\": false,
                        \"destinations\": \"Any\",
                        \"ruleIdentifier\": 62,
                        \"serviceNegated\": false,
                        \"services\": \"Any\",
                        \"sourceNegated\": false,
                        \"sources\": \"Any\",
                        \"users\": \"Any\"
                    }
                ]
            }
        }
    }
}

","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/path","collectionId":"1","id":"1-14-107","method":"GET"},{"name":"Delete generic device from Topology model","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Delete a generic device from the Topology model.
The ID must be for a valid generic device listed in the Topology Model.
If update update_topology = true, then the Topology model will be updated immediately after the device is deleted.
For maximum efficiency, if you are deleting multiple generic devices in consecutive API calls, you can set update_topology = false on all API calls except for the last one. On the last call, set update_toplogy = true.
Default value for update_topology = true.

Parameters:
id: Generic device id
update_topology: Synchronize And Update Topology [optional]

Usage Example
https://192.168.1.1/securetrack/api/generic_devices/1

Usage Example
https://192.168.1.1/securetrack/api/generic_devices/10?update_topology=false

Response Messages:
204: Generic Device deleted successfully.
400: Failed to delete generic device with id {}
404: A 'Generic Device' with the specified ID was not found","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/{{id}}","collectionId":"1","id":"1-14-108","method":"DELETE"},{"name":"Update an existing generic device in the Topology model","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Modify an existing generic device by uploading a new configuration file and/or specifying a new name.
If name field is specified, the generic device will be renamed.
configuration_file is optional, if provided it must include a valid generic device configuration.
The specified path points to a file in the client machine.
If a generic device name is changed and a new configuration file is not provided, topology will not be synchronized (update_topology flag is ignored).
Default value for update_topology = true.
To save time when there are several consecutive api calls: For the last call, set update_topology = true (for all other calls, update_topology = false).
For more information on input file formats, refer to Knowledge Center topic 'Adding and Updating a Generic Device'.

Parameters:
id: Generic device id
body: Generic device to be updated [optional]
configuration_file: Configuration File for generic device [optional]
update_topology: Synchronize And Update Topology [optional]

Usage Example
curl -X PUT -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F \"configuration_file=@/tmp/config.txt;type=application/octet-stream\" -F \"update_topology=true\" https://192.168.1.1/securetrack/api/generic_devices/24

Usage Example
curl -X PUT -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F 'device_data={\"generic_device\":{\"name\": \"new_generic_device_name\"}};type=application/json' -F \"update_topology=false\" https://192.168.1.1/securetrack/api/generic_devices/72

Response Messages:
204: The generic device was updated successfully.
400: A new name or a new configuration file must be indicated in order to update generic device with id {}
400: Failed to update generic device with id {}
404: A 'Generic Device' with the specified ID was not found","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/{{id}}","collectionId":"1","id":"1-14-109","method":"PUT"},{"headers":"Accept: application/json\n","name":"Delete generic Routes","description":"Delete all generic Routes from management Id.

Parameters:
mgmtId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/route/mgmt/2\n

Response Messages:
200: 11 Generic Routes were deleted from mgmtId 2.
400: Bad Request.
401: Access is denied.
404: Management Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/mgmt/{{mgmtId}}","collectionId":"1","id":"1-14-110","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get generic Routes","description":"Get generic Routes of management Id.

Parameters:
mgmtId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/route/mgmt/2
OUTPUT{
    GenericRoutes: [
    {
        id: 27,
        mgmtId: 2,
        destination: \"10.4.4.4\",
        mask: \"255.0.0.0\",
        interfaceName: \"\",
        nextHop: \"AA\",
        nextHopType: \"VR\",
        vrf: \"V102-YO\"
    },
    {
        id: 28,
        mgmtId: 2,
        destination: \"10.4.5.5\",
        mask: \"255.0.0.0\",
        interfaceName: \"eeee\",
        nextHop: \"\",
        nextHopType: \"IP\",
        vrf: \"V101-PA\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Management Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/mgmt/{{mgmtId}}","collectionId":"1","id":"1-14-111","method":"GET"},{"headers":"Accept: application/json\n","name":"Get most specific network interfaces from which a host IP is accessible","data":[{"value":null,"type":"text","enabled":true,"key":"host"}],"description":"Parameters:
context: Global MSSP context [optional]
host: IP address of device for a query

Usage Example
https://192.168.1.1/securetrack/api/devices/interfaces/last_hop?host=192.168.1.66
","dataMode":"params","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/interfaces/last_hop","collectionId":"1","id":"1-14-112","method":"GET"},{"headers":"Accept: application/json\n","name":"Get topology generic VPN connections","description":"Returns a list of the generic vpn connections in the Topology map, for all the domains for which the user has permission to access.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
Use the optional name parameter to restrict the results to topology generic vpn connections that contain the specified string.
The default pagination is start=0 and count=50.

Parameters:
context: Global MSSP context [optional]
is_generic: Get generic devices [optional]
device_id: Device id [optional]
name: VPN connection name (accepts '*', '?' as wildcards) [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/generic_vpns
OUTPUT{
    \"generic_vpns\": {
        \"count\": 3,
        \"total\": 3,
        \"generic_vpn\": [
            {
                \"device_id\": 222,
                \"generic\": false,
                \"id\": 3,
                \"interface_name\": \"tunnel.2\",
                \"tunnel_dest_ip\": \"54.239.63.155\",
                \"tunnel_src_ip\": \"84.200.6.1\",
                \"vpn_name\": \"Palo_to_AWS\"
            },
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 4,
                \"interface_name\": \"tunnel.1\",
                \"tunnel_dest_ip\": \"54.239.63.156\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 5,
                \"interface_name\": \"tunnel.2\",
                \"tunnel_dest_ip\": \"54.239.63.157\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/generic_vpns?is_generic=true
OUTPUT{
    \"generic_vpns\": {
        \"count\": 2,
        \"total\": 2,
        \"generic_vpn\": [
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 4,
                \"interface_name\": \"tunnel.1\",
                \"tunnel_dest_ip\": \"54.239.63.156\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 5,
                \"interface_name\": \"tunnel.2\",
                \"tunnel_dest_ip\": \"54.239.63.157\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
        ]
    }
}


Response Messages:
401: Access is denied
401: Only users with ‘Super admin’ permissions can access Global domain map
401: You do not have access permission to domain id: domainId
400: Wrong type provided - allowable values are: joined or non-joined","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic_vpns{device_id:(/device_id)?}","collectionId":"1","id":"1-14-113","method":"GET"},{"headers":"Accept: application/json\n","name":"Get Specific topology subnet","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the subnet for the specified id, including information regarding attached devices and join candidates.
This API requires 'Super admin' or 'Multi-Domain admin' privileges.
Multi-Domain user must have access permission to the domain where the subnet resides.

Parameters:
id: Subnet id

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/subnets/20
OUTPUT{
    \"subnet\": {
        \"id\": 18,
        \"name\": \"90.0.0.0/24\",
        \"ip\": \"90.0.0.0\",
        \"mask\": \"255.255.255.0\",
        \"attached_devices\": {
            \"attached_device\": [
                {
                    \"is_generic\": false,
                    \"id\": 10,
                    \"name\": \"srx\",
                    \"interface_id\": 4,
                    \"interface_name\": \"eth0\",
                    \"interface_ip\": \"90.0.0.1\"
                },
                {
                    \"is_generic\": false,
                    \"id\": 13,
                    \"name\": \"ZBFW\",
                    \"interface_id\": 5,
                    \"interface_name\": \"eth1\",
                    \"interface_ip\": \"90.0.0.124\"
                },
                {
                    \"is_generic\": false,
                    \"id\": 85,
                    \"name\": \"netscreen\",
                    \"interface_id\": 6,
                    \"interface_name\": \"eth2\",
                    \"interface_ip\": \"90.0.0.50\"
                }
            ]
        },
        \"join_candidates\": {
            \"join_candidate\": {
                \"is_generic\": false,
                \"id\": 72,
                \"name\": \"CP25\",
                \"interface_id\": 14,
                \"interface_name\": \"eth24/1\",
                \"interface_ip\": \"90.0.0.83\"
            }
        }
    }
}


Response Messages:
401: Access is denied
401: You do not have access permission to the domain for subnet with id ID
404: No subnet was found for the provided ID","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/subnets/{{id}}","collectionId":"1","id":"1-14-114","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Get a specific zone pattern entry for a specific zone","data":[{"value":null,"type":"text","enabled":true,"key":"zone_id"},{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"raw","description":"Get a specific zone pattern entry for a specific zone by identifier

Parameters:
context: Global MSSP context. [optional]
zone_id: Identifier of the zone containing the zone entry.
id: Identifier of the zone pattern entry.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/75/pattern-entries/2
BODY<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<pattern_match_entry>
    <id>2</id>    <type>security_group_by_name</type>
    <comment>This is a comment</comment>
    <pattern>WEB</pattern>
    <zone_id>75</zone_id>
    <zone_name>Zone_10_0_0_1</zone_name>
    <domain>
        <address>koko</address>
        <description>bobo</description>
        <id>1</id>
        <name>Default</name>
    </domain>
</pattern_match_entry>


Response Messages:
200: The zone pattern entry was successfully retrieved.
401: User is not permitted to access the specified domain
404: A zone with the specified identifier was not found.
404: A zone pattern entry with the specified identifier was not found.","folder":"1-15","rawModeData":"\n\n\t2\tsecurity_group_by_name\n\tThis is a comment\n\tWEB\n\t75\n\tZone_10_0_0_1\n\t\n\t\t
koko
\n\t\tbobo\n\t\t1\n\t\tDefault\n\t\n\n","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/pattern-entries/{{id}}","collectionId":"1","id":"1-15-115","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create a zone pattern entry in a specific zone","data":[{"value":null,"type":"text","enabled":true,"key":"zone_id"}],"dataMode":"raw","description":"Create a zone pattern entry in a specific zone by identifier

Parameters:
context: Global MSSP context. [optional]
zone_id: Identifier of the zone containing the zone pattern entry.
body: The zone pattern entry to create.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/pattern-entries
BODY<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<create_pattern_match_entry>
    <pattern_match_entry>
        <id>1</id>
        <zone_id>2</zone_id>
        <domain>
            <id>1</id>
            <name>Default</name>
        </domain>
        <pattern>WEB</pattern>
        <type>security_group_by_name</type>
        <comment>This is a comment</comment>
    </pattern_match_entry>
</create_pattern_match_entry>


Response Messages:
201: The zone pattern entry was created successfully.
401: User is not permitted to access the specified domain
400: Some of pattern entry parameters were invalid or missing
404: A zone with the specified identifier was not found.","folder":"1-15","rawModeData":"\n\n\t\n\t\t1\n\t\t2\n\t\t\n\t\t\t1\n\t\t\tDefault\n\t\t\n\t\tWEB\n\t\tsecurity_group_by_name\n\t\tThis is a comment\n\t\n","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/pattern-entries","collectionId":"1","id":"1-15-116","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Get all pattern entries for specific zones","dataMode":"raw","description":"Get the list of zone pattern entries for specific zones by identifiers

Parameters:
context: Global MSSP context. [optional]
ids: Filter by IDs for the pattern entry results. [optional]
pattern: Filter by pattern string for the zone entry results. [optional]
name: Filter by zone name for the pattern entry results. [optional]
comment: Filter by comment for the pattern entry results. [optional]
sort: Sort ascending or descending. [optional]
start: Starting page number for query results. [optional]
count: Number of pages to return for the query, starting from the specified starting page. [optional]
children: Include child zones in the results. [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/1,2/pattern-entries
BODY<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<pattern_match_entries_find_result>
    <paging_info>
        <start>0</start>
        <count>2</count>
        <total>2</total>
    </paging_info>
    <pattern_match_entries>
        <pattern_match_entry>
            <id>2</id>
            <type>security_group_by_name</type>
            <comment>This is a comment</comment>
            <pattern>WEB</pattern>
            <zone_id>1</zone_id>
        </pattern_match_entry>
        <pattern_match_entry>
            <id>3</id>
            <type>security_group_by_name</type>
            <comment>This is a comment</comment>
            <pattern>WEo</pattern>
            <zone_id>2</zone_id>
        </pattern_match_entry>
    </pattern_match_entries>
</pattern_match_entries_find_result>


Response Messages:
200: The zone pattern entries were successfully retrieved.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-15","rawModeData":"\n\n\t\n\t\t0\n\t\t2\n\t\t2\n\t\n\t\n\t\t\n\t\t\t2\n\t\t\tsecurity_group_by_name\n\t\t\tThis is a comment\n\t\t\tWEB\n\t\t\t1\n\t\t\n\t\t\n\t\t\t3\n\t\t\tsecurity_group_by_name\n\t\t\tThis is a comment\n\t\t\tWEo\n\t\t\t2\n\t\t\n\t\n\n","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/pattern-entries","collectionId":"1","id":"1-15-117","method":"GET"},{"headers":"Accept: application/json\n","name":"Get a specific zone entry","data":[{"value":null,"type":"text","enabled":true,"key":"zone_id"},{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Get a specific zone entry by ID for a zone.

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
id: The ID of the zone entry.

Usage Example
https://192.168.1.1/securetrack/api/zones/2/entries/123

Response Messages:
200: The zone entry was successfully retrieved.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found.","folder":"1-16","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries/{{id}}","collectionId":"1","id":"1-16-118","method":"GET"},{"name":"Delete zone entries","data":[{"value":null,"type":"text","enabled":true,"key":"zone_id"},{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Delete existing zone entries.

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
id: The ID of the zone entry to delete.

Usage Example
https://192.168.1.1/securetrack/api/zones/2/entries/10

Response Messages:
200: The zone entry was deleted successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found.","folder":"1-16","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries/{{id}}","collectionId":"1","id":"1-16-119","method":"DELETE"},{"headers":"Content-Type: application/json\n","name":"Create a zone entry","data":[{"value":null,"type":"text","enabled":true,"key":"zone_id"}],"dataMode":"raw","description":"For IPv4 entry provide IP and netmask/prefix (see Usage Example #1 and #2).
For IPv6 provide IP and prefix only, netmask is not allowed(see Usage Example #3).

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
body: The zone entry to create.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"netmask\": \"255.255.255.0\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"prefix\": \"24\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries
BODY{
\"zone_entry\": {
    \"ip\": \"1b98:c72:1f00:0000::\",
    \"prefix\": \"52\"
    }
}


Response Messages:
201: The zone entry was created successfully.
401: User is not permitted to access the specified domain
400: The zone entry parameters were invalid
404: A zone with the specified ID was not found.","folder":"1-16","rawModeData":"{\n\"zone_entry\": {\n\t\"ip\": \"1b98:c72:1f00:0000::\",\n\t\"prefix\": \"52\"\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries","collectionId":"1","id":"1-16-120","method":"POST"},{"headers":"Accept: application/json\n","name":"Get entries for a zone","description":"Get the list of zone entries for a zone.

Parameters:
context: Global MSSP context. [optional]
ids: Filter by IDs for the zone entry results. [optional]
name: Filter by name for the zone entry results. [optional]
ip: Filter by IP for the zone entry results. [optional]
netmask: Filter by netmask for the zone entry results. [optional]
prefix: Filter by prefix for the zone entry results. [optional]
comment: Filter by comment for the zone entry results. [optional]
group: Filter by device group for the zone entry results. [optional]
sort: Sort ascending or descending. [optional]
start: Starting page number for query results. [optional]
count: Number of pages to return for the query, starting from the specified starting page. [optional]
children: Include child zones in the results. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/2/entries

Response Messages:
200: The zone entries were successfully retrieved.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-16","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/entries","collectionId":"1","id":"1-16-121","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Modify multiple existing zone entries","data":[{"value":null,"type":"text","enabled":true,"key":"zone_ids"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"raw","description":"For IPv4 entry provide IP and netmask/prefix.
For IPv6 provide IP and prefix only, netmask is not allowed.
new_zone_id is not optional, it may be the same as the present zoneId.

Parameters:
context: Global MSSP context. [optional]
zone_ids: The ID(s) of the zones containing the zone entries.
ids: The ID(s) of the zone entries to modify.
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/85,98/entries/120,139
BODY{
\"zone_entries\" : {
        \"zone_entry\": [
            {
                \"id\": 120,
                \"ip\": \"3.3.3.3\",
                \"prefix\": 32,
                \"new_zone_id\": 85
            },
            {
                \"id\": 139,
                \"ip\": \"1b98:c72:1f00:0001::\",
                \"prefix\": \"52\",
                \"new_zone_id\": 98
            }
        ]
}
}


Response Messages:
200: The zone entry was modified successfully.
401: User is not permitted to access the specified domain
400: The zone entry parameters were invalid
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found.","folder":"1-16","rawModeData":"{\n\"zone_entries\" : {\n\t\t\"zone_entry\": [\n\t\t\t{\n\t\t\t\t\"id\": 120,\n\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\"prefix\": 32,\n\t\t\t\t\"new_zone_id\": 85\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": 139,\n\t\t\t\t\"ip\": \"1b98:c72:1f00:0001::\",\n\t\t\t\t\"prefix\": \"52\",\n\t\t\t\t\"new_zone_id\": 98\n\t\t\t}\n\t\t]\n}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_ids}}/entries/{{ids}}","collectionId":"1","id":"1-16-122","method":"PUT"},{"headers":"Content-Type: application/json\n","name":"Modify a zone entry","data":[{"value":null,"type":"text","enabled":true,"key":"zone_id"},{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"raw","description":"For IPv4 entry provide IP and netmask/prefix (see Usage Example #1 and #2).
For IPv6 provide IP and prefix only, netmask is not allowed(see Usage Example #3).

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
id: The ID of the zone entry.
body: The modified zone entry.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries/1
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"netmask\": \"255.255.255.0\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries/1
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"prefix\": \"24\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries/1
BODY{
\"zone_entry\": {
    \"ip\": \"1b98:c72:1f00:0000::\",
    \"prefix\": \"52\"
    }
}


Response Messages:
200: The zone entry was modified successfully.
401: User is not permitted to access the specified domain
400: The zone entry parameters were invalid
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found.","folder":"1-16","rawModeData":"{\n\"zone_entry\": {\n\t\"ip\": \"1b98:c72:1f00:0000::\",\n\t\"prefix\": \"52\"\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries/{{id}}","collectionId":"1","id":"1-16-123","method":"PUT"},{"name":"Modify a zone entry","data":[{"value":null,"type":"text","enabled":true,"key":"zone_ids"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Modify an existing zone entry.

Parameters:
context: Global MSSP context. [optional]
zone_ids: The ID(s) of the zones containing the zone entry.
ids: The ID(s) of the zone entries to delete.

Usage Example
https://192.168.1.1/securetrack/api/zones/2,3/entries/10,20

Response Messages:
200: The zone entry was deleted successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found.","folder":"1-16","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_ids}}/entries/{{ids}}","collectionId":"1","id":"1-16-124","method":"DELETE"},{"name":"Add a zone as an ancestor to a zone","data":[{"value":null,"type":"text","enabled":true,"key":"child_id"},{"value":null,"type":"text","enabled":true,"key":"parent_ids"}],"dataMode":"params","description":"Add a zone(s) as an ancestor to a existing zone.

Parameters:
context: Global MSSP context. [optional]
child_id: The ID of the zone for which to add ancestors zone(s).
parent_ids: The ID(s) of the zones to add as ancestors.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/ancestors/10,20

Response Messages:
200: The zone was added as an ancestor successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{child_id}}/ancestors/{{parent_ids}}","collectionId":"1","id":"1-17-125","method":"PUT"},{"name":"Remove a zone as an ancestor to a zone","data":[{"value":null,"type":"text","enabled":true,"key":"child_id"},{"value":null,"type":"text","enabled":true,"key":"parent_ids"}],"dataMode":"params","description":"Remove a zone(s) as an ancestor to a existing zone.

Parameters:
context: Global MSSP context. [optional]
child_id: The ID of the zone for which to remove ancestors zone(s).
parent_ids: The ID(s) of the zones to remove as ancestors.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/ancestors/10,20

Response Messages:
200: The zone was removed as an ancestor successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{child_id}}/ancestors/{{parent_ids}}","collectionId":"1","id":"1-17-126","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get ancestor zones for a zone","data":[{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Get a list of ancestor zones for the specified zone(s).

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones for which to look for ancestor zones.

Usage Example
https://192.168.1.1/securetrack/api/zones/123,234/ancestors

Response Messages:
200: The zone ancestors were retrieved successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/ancestors","collectionId":"1","id":"1-17-127","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create a zone","dataMode":"raw","description":"Create a zone.

Parameters:
context: Global MSSP context. [optional]
body: The zone to add.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones
BODY<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<zone>
    <name>DMZ</name>
    <comment>All DMZ addresses</comment>
    <shared>false</shared>
</zone>


Response Messages:
201: The zone was created successfully.
401: User is not permitted to access the specified domain
400: The zone parameters were invalid","folder":"1-17","rawModeData":"\n\n\tDMZ\n\tAll DMZ addresses\n\tfalse\n","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/","collectionId":"1","id":"1-17-128","method":"POST"},{"headers":"Accept: application/json\n","name":"Get all zones","description":"Gets a list of all zones.

Parameters:
context: Global MSSP context. [optional]
name: Filter by zone name for the zone results. [optional]
comment: Filter by zone comment for the zone results. [optional]
imported: List domains that imported zones. [optional]
includeInternet: Include the Internet zone. [optional]
includeImported: Include imported zones. [optional]
sort: Sort ascending or descending. [optional]
start: Starting page number for query results. [optional]
count: Number of pages to return for the query, starting from the specified starting page. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones

Response Messages:
200: The zones were retrieved successfully.
401: User is not permitted to access the specified domain","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/","collectionId":"1","id":"1-17-129","method":"GET"},{"collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/","name":"Delete all zones","method":"DELETE","id":"1-17-130","description":"Delete all existing zones.

Parameters:
context: Global MSSP context. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones

Response Messages:
204: All zones were successfully deleted.
401: User is not permitted to access the specified domain","folder":"1-17"},{"headers":"Accept: application/json\n","name":"Get shared zones","description":"Get a list of shared zones.

Parameters:
context: Global MSSP context. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/shared

Response Messages:
200: The list of shared zones was retrieved successfully.
401: User is not permitted to access the specified domain","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/shared","collectionId":"1","id":"1-17-131","method":"GET"},{"collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/import/{{ids}}","name":"Import a zone","method":"POST","id":"1-17-132","description":"Import a shared zone into the specified domain

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones to import. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/import/10,20

Response Messages:
200: The zone was imported successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17"},{"name":"Delete a zone","data":[{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Delete an existing zone.

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zone to delete.

Usage Example
https://192.168.1.1/securetrack/api/zones/1,2

Response Messages:
204: The specified zone was successfully deleted.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}","collectionId":"1","id":"1-17-133","method":"DELETE"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Map network elements to security zones","dataMode":"raw","description":"This API maps each network element in the AccessRequestNetworkListDTO (such as IP address, IP address range, object, or group) to all matching Tufin security zones. If the network element is a group, then each zone also identifies all matching group members. The internet referral object can be included in the list, and will always map to the predefined Internet security zone. If the 'Any' element is included in the list it will map to all zones.
Note: if multi-domain mode is enabled, the API calls only checks zones that are in the “Default” domain.

Parameters:
body: AccessRequestNetworkListDTO

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_zones
BODY<network_objects>
     <network_object xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"ip_network\">
         <network xsi:type=\"raw_network_subnet\">
         <ip>10.8.8.0</ip>
         <mask>255.255.255.0</mask>
         </network>
     </network_object>
</network_objects>


Response Messages:
200: Returns mapping of network elements to security zones
400: Access Request Network List is malformed.
401: Access is denied.","folder":"1-17","rawModeData":"\n\t \n\t\t \n\t\t 10.8.8.0\n\t\t 255.255.255.0\n\t\t \n\t \n","url":"https://{{SecureTrack_IP}}/securetrack/api/security_zones/","collectionId":"1","id":"1-17-134","method":"POST"},{"headers":"Content-Type: application/xml\n","name":"Modify a zone","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"raw","description":"Modify an existing zone.

Parameters:
context: Global MSSP context. [optional]
id: The ID of the zone to modify.
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2
BODY<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<zone>
    <id>2</id>
    <name>DMZ</name>
    <comment>All DMZ hosts</comment>
    <shared>false</shared>
    <internet>false</internet>
    <user_networks>false</user_networks>
    <unassociated_networks>false</unassociated_networks>
</zone>


Response Messages:
204: The specified zone was successfully modified.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
400: The zone parameters were invalid","folder":"1-17","rawModeData":"\n\n\t2\n\tDMZ\n\tAll DMZ hosts\n\tfalse\n\tfalse\n\tfalse\n\tfalse\n","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{id}}","collectionId":"1","id":"1-17-135","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get a specific zone","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Get the zone with the specified ID.

Parameters:
context: Global MSSP context. [optional]
id: The ID of the zone to get.
imported: List domains that imported zones. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/2

Response Messages:
200: The zone was retrieved successfully.
401: User is not permitted to access the specified domain
401: A zone with the specified ID does not exist.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{id}}","collectionId":"1","id":"1-17-136","method":"GET"},{"headers":"Accept: application/json\n","name":"Get descendant zones for a zone","data":[{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Get a list of zones descended from the specified zone(s).

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones for which to look for descendant zones.

Usage Example
https://192.168.1.1/securetrack/api/zones/10,20/descendants

Response Messages:
200: The zone descendants were retrieved successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/descendants","collectionId":"1","id":"1-17-137","method":"GET"},{"headers":"Accept: application/json\n","name":"Get configuration usages for a zone","data":[{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Get a list of configuration usages for the specified zone(s).

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones for which to look for configuration dependencies.

Usage Example
https://192.168.1.1/securetrack/api/zones/2,3/dependencies

Response Messages:
200: The zone dependencies were retrieved successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/dependencies","collectionId":"1","id":"1-17-138","method":"GET"},{"name":"Remove a zone as an descendants to a zone","data":[{"value":null,"type":"text","enabled":true,"key":"parent_id"},{"value":null,"type":"text","enabled":true,"key":"child_ids"}],"dataMode":"params","description":"Remove a zone(s) as an descendants to a existing zone.

Parameters:
context: Global MSSP context. [optional]
parent_id: The ID of the zone for which to remove descendant zone(s).
child_ids: The ID(s) of the zone to remove as a descendant.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/descendants/10,20

Response Messages:
200: The zone was removed as an descendant successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{parent_id}}/descendants/{{child_ids}}","collectionId":"1","id":"1-17-139","method":"DELETE"},{"name":"Add a zone as a descendant to a zone","data":[{"value":null,"type":"text","enabled":true,"key":"parent_id"},{"value":null,"type":"text","enabled":true,"key":"child_ids"}],"dataMode":"params","description":"Add a zone(s) as a descendant to a existing zone.

Parameters:
context: Global MSSP context. [optional]
parent_id: The ID of the zone for which to add descendant zone(s).
child_ids: The ID(s) of the zones to add as descendants.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/descendants/10,20

Response Messages:
200: The zone was added as an descendant successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{parent_id}}/descendants/{{child_ids}}","collectionId":"1","id":"1-17-140","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get sub-policies (bindings) by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns a list of all of the subpolicies (bindings) for a given revision.
The definition of subpolicy is different for each vendor:
Check Point - policy package and inline layer (inline layer will be returned only when the optional include_subpolicy parameter is set to true)
Cisco - ACL
Juniper/Fortinet/Palo Alto/Stonesoft - zone-to-zone policy
Cloud platforms - Security Groups


Parameters:
context: Global MSSP context [optional]
id: Revision ID
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
include_subpolicy: when set to true, includes sub policies in the returned result, supported only for Checkpoint [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/bindings

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/bindings? include_subpolicy=true
","folder":"1-18","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/bindings","collectionId":"1","id":"1-18-141","method":"GET"},{"headers":"Accept: application/json\n","name":"Get list of sub-policies (bindings) with input and/or output interfaces","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"supremum_version_id"},{"value":null,"type":"text","enabled":true,"key":"inputInterfaceName"},{"value":null,"type":"text","enabled":true,"key":"outputInterfaceName"}],"dataMode":"params","description":"Retrieve list of bindings of input and/or output interfaces

Parameters:
device_id: The unique identifier of target device
supremum_version_id: The unique identifier of target revision
inputInterfaceName: Input interface name
outputInterfaceName: Output interface name

Usage Example
https://192.168.1.1/securetrack/api/bindings/20/binding_query?supremum_version_id=785&inputInterfaceName=Any&outputInterfaceName=Any
","folder":"1-18","url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/binding_query","collectionId":"1","id":"1-18-142","method":"GET"},{"headers":"Accept: application/json\n","name":"Get sub-policies (bindings) by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns a list of all of the subpolicies (bindings) for a given device.
The definition of subpolicy is different for each vendor:
Check Point - policy package and inline layer (inline layer will be returned only when the optional include_subpolicy parameter is set to true)
Cisco - ACL
Juniper/Fortinet/Palo Alto/Stonesoft - zone-to-zone policy
Cloud platforms - Security Groups


Parameters:
context: Global MSSP context [optional]
id: Device ID
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
include_subpolicy: when set to true, includes sub policies in the returned result, supported only for Checkpoint [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/bindings

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/bindings? include_subpolicy=true
","folder":"1-18","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/bindings","collectionId":"1","id":"1-18-143","method":"GET"},{"headers":"Accept: application/json\n","name":"Get policies by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of policies defined on a given device ID.
Supported devices: CheckPoint, Panorama Advanced, FortiManager Basic and Advanced, FMC and NSX.

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/20/policies
","folder":"1-18","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/policies","collectionId":"1","id":"1-18-144","method":"GET"},{"headers":"Accept: application/json\n","name":"Get policies by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of policies defined on a given revision ID

Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/policies
","folder":"1-18","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/policies","collectionId":"1","id":"1-18-145","method":"GET"},{"headers":"Accept: application/json\n","name":"Get rules by input and output interfaces","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"}],"description":"Parameters:
device_id: The unique identifier of target device
inputInterfaceName: Input interface name [optional]
outputInterfaceName: Output interface name [optional]

Usage Example
https://192.168.1.1/securetrack/api/bindings/2/topology_interfaces?inputInterfaceName=ethernet1/1&outputInterfaceName=ethernet1/2
","dataMode":"params","folder":"1-18","url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/topology_interfaces","collectionId":"1","id":"1-18-146","method":"GET"},{"headers":"Accept: application/json\n","name":"Run Policy Analysis query","data":[{"value":null,"type":"text","enabled":true,"key":"device_ids"},{"value":null,"type":"text","enabled":true,"key":"sources"},{"value":null,"type":"text","enabled":true,"key":"destinations"},{"value":null,"type":"text","enabled":true,"key":"services"}],"description":"Parameters:
device_ids: Device ids
sources: Source list
destinations: Destination list
services: Service list
exclude_any: Exclude any in the specified, comma-separated fields of source, destination or service. For example: exclude_any = destination,service [optional]
action: Action [optional]

Usage Example
https://192.168.1.1/securetrack/api/policy_analysis/query/matching_rules?device_ids=41&sources=33.33.33.0:24,113.113.113.100&destinations=114.1.1.0:24&services=tcp:80&exclude_any=source,destination

Response Messages:
200: Returns request results.
400: Error in request syntax.","dataMode":"params","folder":"1-19","url":"https://{{SecureTrack_IP}}/securetrack/api/policy_analysis/query/matching_rules","collectionId":"1","id":"1-19-147","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific rule documentation","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"rule_id"}],"dataMode":"params","description":"Fetches rule documentation for a single rule given by revision ID and rule ID.

Parameters:
context: Global MSSP context [optional]
id: Revision id
rule_id: Id of the requested rule

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules/16373/documentation
","folder":"1-20","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules/{{rule_id}}/documentation","collectionId":"1","id":"1-20-148","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Modify specific rule documentation","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"rule_id"}],"dataMode":"raw","description":"Modify rule documentation for a single rule identified by revision ID and rule ID.
A single rule can be set as either a stealth rule or legacy rule. If both flags are set, an error will be returned (error 400, Bad request).
If no rule documentation exists for the rule, the specified documentation is added to the rule and the response code is: 201 Created.
If rule documentation already exists for the rule, the specified documentation replaces the existing documentation and the response code is: 204 No Content.
Record set entries that are automatically created or calculated, for example automatic mapping to a SecureChange ticket, cannot be modified.
The following fields are automatically calculated, and cannot be modified:
Permissiveness, Violations, Last Hit, Last Modified, Shadowing Status, Certification Status, Certification Date, Certification Expiration Date, Application Name, Application Owner

Parameters:
context: Global MSSP context [optional]
id: Revision id
rule_id: Id of the changed rule
body: RuleDocumentationDTO

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/173/rules/3373/documentation
BODY<rule_documentation>
     <tech_owner>admin</tech_owner>
     <comment>Comment text</comment>
     <legacy_rule>false</legacy_rule>
     <stealth_rule>true</stealth_rule>
     <record_set>
         <businessOwnerEmail>user@company.com</businessOwnerEmail>
         <businessOwnerName>Business Owner</businessOwnerName>
         <expireDate>2013-01-08T00:00:00+02:00</expireDate>
         <id>172</id>
         <ticketCr>789111</ticketCr>
     </record_set>
</rule_documentation>

","folder":"1-20","rawModeData":"\n\t admin\n\t Comment text\n\t false\n\t true\n\t \n\t\t user@company.com\n\t\t Business Owner\n\t\t 2013-01-08T00:00:00+02:00\n\t\t 172\n\t\t 789111\n\t \n","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules/{{rule_id}}/documentation","collectionId":"1","id":"1-20-149","method":"PUT"},{"name":"Delete specific rule documentation","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"rule_id"}],"dataMode":"params","description":"Delete rule documentation for a single rule given by revision ID and rule ID.
If the rule has automatic mapping to a ticket, the record is not deleted.

Parameters:
context: Global MSSP context [optional]
id: Revision id
rule_id: Rule id

Usage Example
https://192.168.1.1/securetrack/api/revisions/173/rules/3373/documentation
","folder":"1-20","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules/{{rule_id}}/documentation","collectionId":"1","id":"1-20-150","method":"DELETE"},{"headers":"Content-Type: application/xml\n","name":"Modify specific rule documentation","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"rule_id"}],"dataMode":"raw","description":"Modify rule documentation for a single rule given by device ID and rule ID
A single rule can be set as either a stealth rule or legacy rule. If both flags are set, an error will be returned (error 400, Bad request).
If there is no existing rule documentation for the rule, the specified documentation is added to the rule and the response code is: 201 Created.
If there is existing rule documentation for the rule, the specified documentation replaces the existing documentation and the response code is: 204 No Content.

Parameters:
context: Global MSSP context [optional]
id: Device ID
rule_id: Rule ID
body: RuleDocumentationDTO

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/20/rules/3040/documentation
BODY<rule_documentation>
     <tech_owner>admin</tech_owner>
     <comment>Comment text</comment>
     <legacy_rule>false</legacy_rule>
     <stealth_rule>true</stealth_rule>
     <record_set>
         <businessOwnerEmail>user@company.com</businessOwnerEmail>
         <businessOwnerName>Business Owner</businessOwnerName>
         <expireDate>2013-01-08T00:00:00+02:00</expireDate>
         <id>173</id>
         <ticketCr>789112</ticketCr>
     </record_set>
</rule_documentation>

","folder":"1-20","rawModeData":"\n\t admin\n\t Comment text\n\t false\n\t true\n\t \n\t\t user@company.com\n\t\t Business Owner\n\t\t 2013-01-08T00:00:00+02:00\n\t\t 173\n\t\t 789112\n\t \n\n","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules/{{rule_id}}/documentation","collectionId":"1","id":"1-20-151","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get specific rule documentation","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"rule_id"}],"dataMode":"params","description":"Fetches rule documentation for a single rule given by device ID and rule ID

Parameters:
context: Global MSSP context [optional]
id: Device ID
rule_id: Rule ID

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules/16373/documentation
","folder":"1-20","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules/{{rule_id}}/documentation","collectionId":"1","id":"1-20-152","method":"GET"},{"name":"Delete specific rule documentation","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"rule_id"}],"dataMode":"params","description":"Delete rule documentation for a single rule given by device ID and rule ID

Parameters:
context: Global MSSP context [optional]
id: Device ID
rule_id: Rule ID

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules/3040/documentation
","folder":"1-20","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules/{{rule_id}}/documentation","collectionId":"1","id":"1-20-153","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get the specific objects or rules identified for the cleanup results","data":[{"value":null,"type":"text","enabled":true,"key":"cleanup_id"}],"description":"Parameters:
context: Global MSSP context [optional]
cleanup_id: Cleanup id
devices: Devices ids [optional]
start: Start [optional]
count: Results count [optional]

Usage Example
https://192.168.1.1/securetrack/api/cleanup/1/instances
","dataMode":"params","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/cleanup/{{cleanup_id}}/instances","collectionId":"1","id":"1-21-154","method":"GET"},{"headers":"Accept: application/json\n","name":"Get cleanups results","description":"Parameters:
context: Global MSSP context [optional]
devices: Devices ids [optional]

Usage Example
https://192.168.1.1/securetrack/api/cleanup
","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/cleanup/","collectionId":"1","id":"1-21-155","method":"GET"},{"headers":"Accept: application/json\n","name":"Get cleanups by device","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"code"}],"dataMode":"params","description":"Fetches set of Cleanup calculation results for a device given by ID.
Only fully shadowed rules (cleanup code C01) are supported.

Parameters:
context: Global MSSP context [optional]
device_id: Device ID
code: Cleanup category code
start: Starting page for query allowable values are numeric [optional]
count: Number of pages for query result allowable values are numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/cleanups?code=C01
","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/cleanups","collectionId":"1","id":"1-21-156","method":"GET"},{"headers":"Accept: application/json\n","name":"Get shadowing rules by device","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"shadowed_uids"}],"dataMode":"params","description":"Find shadowing rules for given shadowed rules of a specific device

Parameters:
device_id: Device ID
shadowed_uids: UIDs of shadowed rules separated by commas

Usage Example
https://192.168.1.1/securetrack/api/devices/31/shadowing_rules?shadowed_uids=78786a0d-b9cc-478e-b7a2-dea953c976c7
","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/shadowing_rules","collectionId":"1","id":"1-21-157","method":"GET"},{"headers":"Accept: application/json\n","name":"Get devices in risk results","data":[{"value":null,"type":"text","enabled":true,"key":"risk_id"}],"description":"Parameters:
context: Global MSSP context [optional]
risk_id: Risk id

Usage Example
https://192.168.1.1/securetrack/api/risk/1/devices
","dataMode":"params","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/risk/{{risk_id}}/devices","collectionId":"1","id":"1-21-158","method":"GET"},{"headers":"Accept: application/json\n","name":"Get risks results","description":"Parameters:
context: Global MSSP context [optional]
devices: Devices ids [optional]

Usage Example
https://192.168.1.1/securetrack/api/risk
","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/risk/","collectionId":"1","id":"1-21-159","method":"GET"},{"headers":"Accept: application/json\n","name":"Get the specific objects or rules identified for the risk results","data":[{"value":null,"type":"text","enabled":true,"key":"risk_id"}],"description":"Parameters:
context: Global MSSP context [optional]
risk_id: Risk id
devices: Devices ids [optional]
start: Start [optional]
count: Results count [optional]

Usage Example
https://192.168.1.1/securetrack/api/risk/1/instances
","dataMode":"params","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/risk/{{risk_id}}/instances","collectionId":"1","id":"1-21-160","method":"GET"},{"headers":"Accept: application/json\n","name":"Get devices in cleanup results","data":[{"value":null,"type":"text","enabled":true,"key":"cleanup_id"}],"description":"Parameters:
context: Global MSSP context [optional]
cleanup_id: Cleanup id

Usage Example
https://192.168.1.1/securetrack/api/cleanup/1/devices
","dataMode":"params","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/cleanup/{{cleanup_id}}/devices","collectionId":"1","id":"1-21-161","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific revision","data":[{"value":null,"type":"text","enabled":true,"key":"revId"}],"dataMode":"params","description":"Fetches a revision specified by revision Id.
To get revId for this API, use the 'id' property of RevisionDTO that is returned by 'Get revisions by device' or 'Get latest revision by device' APIs

Parameters:
context: Global MSSP context [optional]
revId: Id of fetched revision

Usage Example
https://192.168.1.1/securetrack/api/revisions/785
","folder":"1-22","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revId}}","collectionId":"1","id":"1-22-162","method":"GET"},{"headers":"Accept: application/json\n","name":"Get latest revision by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches latest revision for a given device

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/105/latest_revision
","folder":"1-22","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/latest_revision","collectionId":"1","id":"1-22-163","method":"GET"},{"headers":"Accept: application/json\n","name":"Get revisions by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches revisions for a given device

Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query starting from starting page allowable type is numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/105/revisions
","folder":"1-22","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/revisions","collectionId":"1","id":"1-22-164","method":"GET"},{"headers":"Accept: application/json\n","name":"Get last hit for a specific rule","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"rule_uid"}],"dataMode":"params","description":"Get last hit dates for all rules in a given device.
For Palo Alto firewalls, this also returns last hits for users and applications in the rule.
The rule_uid is the value from the uid field returned by the /rules API: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Parameters:
device_id: device_id
rule_uid: rule_uid

Usage Example
https://192.168.1.1/securetrack/api/rule_last_usage/find/20/ea9db13e-d058-45c6-a2f0-cd731027c22b
","folder":"1-23","url":"https://{{SecureTrack_IP}}/securetrack/api/rule_last_usage/find/{{device_id}}/{{rule_uid}}","collectionId":"1","id":"1-23-165","method":"GET"},{"headers":"Accept: application/json\n","name":"Get last hits for all rules by device","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"}],"dataMode":"params","description":"Get last hit dates for all rules in a given device.
For Palo Alto firewalls, this also returns last hits for users and applications in the rule.

Parameters:
device_id: device id

Usage Example
https://192.168.1.1/securetrack/api/rule_last_usage/find_all/20
","folder":"1-23","url":"https://{{SecureTrack_IP}}/securetrack/api/rule_last_usage/find_all/{{device_id}}","collectionId":"1","id":"1-23-166","method":"GET"},{"headers":"Accept: application/json\n","name":"Get a specific rule","data":[{"value":null,"type":"text","enabled":true,"key":"ruleId"}],"description":"Parameters:
ruleId: Rule ID

Usage Example
https://192.168.1.1/securetrack/api/rules/60
","dataMode":"params","folder":"1-24","url":"https://{{SecureTrack_IP}}/securetrack/api/rules/{{ruleId}}","collectionId":"1","id":"1-24-167","method":"GET"},{"headers":"Accept: application/json\n","name":"Get rule count per device","description":"The search_text parameter provides the same capabilities as the Policy Browser feature in SecureTrack.
You can search for a string across all rule fields, or you can search for a combination of specific strings in specific fields.
The text format is for a field is <fieldname>:<text> for example uid:9259f6ee-47a0-4996-a214-ab7edc14a916.
See the search info documentation in Securetrack Policy Browser page for more information.
This API will return a list of all the devices, the devices that has rules that match the search criteria will have rule_count that is bigger than 0

Parameters:
context: Global MSSP context [optional]
search_text: Search text [optional]
devices: Devices ids [optional]

Usage Example
https://192.168.1.1/securetrack/api/rule_search/87

Usage Example
https://192.168.1.1/securetrack/api/rule_search/87?search_text=ICMP application:facebook

Usage Example
URLhttps://192.168.1.1/securetrack/api/rule_search?search_text=uid:9259f6ee-47a0-4996-a214-ab7edc14a916
OUTPUT{
    \"device_list\":{
        \"device\":[
            {
                \"device_id\":512,
                \"revision_id\":6864,
                \"rule_count\":1
            },
            {
                \"device_id\":59,
                \"revision_id\":543,
                \"rule_count\":0
            }
        ]
    }
}

","folder":"1-24","url":"https://{{SecureTrack_IP}}/securetrack/api/rule_search/","collectionId":"1","id":"1-24-168","method":"GET"},{"headers":"Accept: application/json\n","name":"Get rules by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns a list of all of the security rules for the specified revision.
Use add=documentation to retrieve rule documentation.
The is_global parameter is device dependent. For ACL devices, only global rules are returned when set to true. For Check Point R80, only global layers are returned when set to true, and specify a layer name in the subpolicy_name parameter This parameter is ignored for all other vendors. The default value is false.
The subpolicy_name parameter is device dependent. For Check Point R80, only rules that use the specified layer are returned. You can only specify the name of a single layer. This parameter is ignored for all other vendors.


Parameters:
context: Global MSSP context [optional]
id: Revision id
policyId: Policy id [optional]
policy: Policy name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules only(device dependent, see implementation Notes) [optional]
add: If set to \"documentation\" result will include rule documentation [optional]
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
groupBy: Rules grouping criteria, can be set only to \"bindings\" [optional]
with_zb: Include zone-based rules [optional]
uid: Binding UID [optional]
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
subpolicy_name: Filter by sub policy name (see implementation notes) [optional]
is_alternate_order: OrderBy alternate order, for display Aci rules by contracts [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules?subpolicy_name=layer1&is_global=true
","folder":"1-24","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules","collectionId":"1","id":"1-24-169","method":"GET"},{"headers":"Accept: application/json\n","name":"Get rules by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns a list of all of the security rules for the specified device.
Use add=documentation to retrieve rule documentation.
The is_global parameter is device dependent. For ACL devices, only global rules are returned when set to true. For Check Point R80, only global layers are returned when set to true, and specify a layer name in the subpolicy_name parameter This parameter is ignored for all other vendors. The default value is false.
The subpolicy_name parameter is device dependent. For Check Point R80, only rules that use the specified layer are returned. You can only specify the name of a single layer. This parameter is ignored for all other vendors.


Parameters:
context: Global MSSP context [optional]
id: Device ID
policyId: Policy ID [optional]
policy: Policy Name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules (Only for: ACL devices) [optional]
add: If set to \"documentation\" result will include rule documentation [optional]
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
groupBy: Show rules grouping criteria. Can be set only to \"bindings\". Output will be grouped by bindings and section header for Check Point devices, ACL for Cisco devices, and Zones for Juniper, Palo Alto, and Fortinet device [optional]
with_zb: Include zone based rules, values can be 'true' or 'false' [optional]
uid: Binding UID [optional]
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
subpolicy_name: Filter by sub policy name (see implementation notes) [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules?subpolicy_name=layer1&is_global=true
","folder":"1-24","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules","collectionId":"1","id":"1-24-170","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific rule","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Returns a list of rules by revision ID, rule IDs and additional criteria

Parameters:
context: Global MSSP context [optional]
revision_id: Revision id
ids: Rule IDs
policy: Policy name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules (Only for: ACL devices) [optional]
add: If set to \\\"documentation\\\" result will include rule documentation [optional]
groupBy: Rules grouping criteria, can be set only to \\\"bindings\\\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules/16370
","folder":"1-24","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/rules/{{ids}}","collectionId":"1","id":"1-24-171","method":"GET"},{"collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/rule_search/export","name":"Create a CSV file for rules search results","method":"GET","id":"1-24-172","description":"The search_text parameter provides the same capabilities as the Policy Browser feature in SecureTrack.
You can search for a string across all rule fields, or you can search for a combination of specific strings in specific fields.
The text format is for a field is : for example uid:9259f6ee-47a0-4996-a214-ab7edc14a916.
See the search info documentation in Securetrack Policy Browser page for more information.
This API exports the results data as a CSV file in the SecureTrack Reports Repository.

Parameters:
context: Global MSSP context [optional]
search_text: Search text [optional]

Usage Example
https://192.168.1.1/securetrack/api/rule_search/export

Usage Example
https://192.168.1.1/securetrack/api/rule_search/export?search_text=shadowed:true
","folder":"1-24"},{"headers":"Accept: application/json\n","name":"Find rules","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"}],"dataMode":"params","description":"The search_text parameter provides the same capabilities as the Policy Browser feature in SecureTrack.
You can search for a string across all rule fields, or you can search for a combination of specific strings in specific fields.
The text format is for a field is <fieldname>:<text> for example uid:9259f6ee-47a0-4996-a214-ab7edc14a916.
See the search info documentation in Securetrack Policy Browser page for more information.To get more information regarding objects included in the returned rules (like src_network or dst_network) use their uid, as the objects’ ID might change.
\n By default, if there are less than 3,000 rules - the API will return all the rules.\nIn case there are more than 3,000 rules the API will return an error code 413 with the error message “There are more than 3000 rules, you must use pagination”

Parameters:
context: Global MSSP context [optional]
search_text: Search text [optional]
device_id: Device id
start: The starting rule to include in the returned results [optional]
count: Number of rules to include in the results [optional]

Usage Example
https://192.168.1.1/securetrack/api/rule_search/31?search_text=source:Sales_192.168.2.60 fromzone:sales tozone:External

Usage Example
https://192.168.1.1/securetrack/api/rule_search/20?search_text=Mobile Access hascomment:false

Usage Example
https://192.168.1.1/securetrack/api/rule_search/87?search_text=web_server&start=0&count=10

Usage Example
URLhttps://192.168.1.1/securetrack/api/rule_search/59?search_text=uid:9259f6ee-47a0-4996-a214-ab7edc14a916
OUTPUT {
    \"rules\":{
        \"count\":1,
        \"total\":1,
        \"rule\":{
            \"@xsi.type\":\"securityRuleDTO\",
            \"id\":21,
            \"cp_uid\":\"\",
            \"uid\":\"{9259f6ee-47a0-4996-a214-ab7edc14a916}\",
            \"order\":2,
            \"binding\":{
                \"default\":true,
                \"policy\":{
                    \"@xsi.type\":\"managementDomainPolicyDTO\",
                    \"id\":2,
                    \"name\":\"Standard\",
                    \"installable_targets\":\"\"
                },
                \"rule_count\":19,
                \"security_rule_count\":19,
                \"uid\":\"{00-FACED0-00}\"
                },
            \"acceleration_breaker\":false,
            \"action\":\"Accept\",
            \"application\":{
                \"id\":4735,
                \"display_name\":\"ssh\",
                \"name\":\"ssh\"
            },
            \"authentication_rule\":false,
            \"comment\":\"DO NOT DELETE OR EDIT\",
            \"dst_network\":{
                \"id\":39,
                \"display_name\":\"Net_10.110.65.0\",
                \"name\":\"Net_10.110.65.0\"
                \"uid\":\"{1290f6ee-47a1-4996-a214-ab2edc26a916}\"
            },
            \"dest_networks_negated\":false,
            \"dst_service\":{
                \"id\":7420,
                \"display_name\":\"ssh\",
                \"name\":\"ssh\"
                \"uid\":\"{2904f6ee-47a1-4996-a214-ab2edc26a916}\"
            },
            \"dest_services_negated\":false,
            \"dst_zone\":\"any\",
            \"disabled\":false,
            \"external\":false,
            \"implicit\":false,
            \"dst_zone_any\":true,
            \"src_zone_any\":true,
            \"name\":\"Accept SSHG\",
            \"option\":\"LOG_SESSION\",
            \"documentation\":{
                \"permissiveness_level\":\"LOW\",
                \"shadowed\":\"Not shadowed\",
                \"last_modified\":\"Today\",
                \"last_hit\":\"N/A\",
                \"violations\":\"\"
            },
            \"rule_location\":\"Shared\",
            \"rule_location_display\":\"Shared - Pre Rule\",
            \"rule_number\":2,
            \"rule_type\":\"universal\",
            \"src_zone\":\"any\",
            \"src_network\":{
                \"id\":38,
                \"display_name\":\"Net_10.110.64.0\",
                \"name\":\"Net_10.110.64.0\"
                \"uid\":\"{4934f6ee-47a1-4996-a214-ab2edc26a916}\"
            },
            \"src_networks_negated\":false,
            \"src_services_negated\":false,
            \"track\":{
                \"level\":\"LOG\"
            },
            \"type\":\"rule\",
            \"users\":{
                \"id\":5,
                \"display_name\":\"tufin\\\\regina\",
                \"name\":\"tufin\\\\regina@ldap\"
            }
        }
    }
}


Response Messages:
400: Value for start parameter is missing or not valid
400: Value for count parameter is missing or not valid
413: Max supported count is 3000
413: There are more than 3000 rules, you must use pagination","folder":"1-24","url":"https://{{SecureTrack_IP}}/securetrack/api/rule_search/{{device_id}}","collectionId":"1","id":"1-24-173","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific rule","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Returns a list of rules by device ID, rule IDs and additional criteria.
Note: This API retrieves the information from the latest revision.


Parameters:
context: Global MSSP context [optional]
device_id: Device ID
ids: Rule IDs
policy: Policy Name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules only(device dependent, see implementation Notes) [optional]
add: If set to \"documentation\" result will include rule documentation [optional]
groupBy: Rules grouping criteria, can be set only to \"bindings\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules/16370
","folder":"1-24","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/rules/{{ids}}","collectionId":"1","id":"1-24-174","method":"GET"},{"headers":"Accept: application/json\n","name":"Get services by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of service objects defined in revision given by revision ID
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.


Parameters:
context: Global MSSP context [optional]
id: Revision id
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
start: Starting page for query allowable types are numeric [optional]
count: Number of pages for query allowable values are numeric [optional]
name: Service name [optional]
type: Service type, allowable values are: tcp, udp, ip or icmp [optional]
port: Service port [optional]
icmp_type: Service ICMP type allowable values are numeric between 0 to 40 [optional]
protocol: Service protocol, allowable values are numeric betweenm 0 to 255 [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/785/services?get_total=true
OUTPUT {
    \"services\": {
        \"count\": 50,
        \"total\": 100,
        \"service\": [{
            \"@xsi.type\": \"singleServiceDTO\",
            \"id\": 5129479,
            \"name\": \"Tcp30025\",
            \"display_name\": \"Tcp30025\",
            \"class_name\": \"tcp_service\",
            \"type\": \"tcp_service\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{079F15A5-009E-7E47-BBD0-E65973646562}\",
            \"implicit\": false,
            \"overrides\": false,
            \"max\": 30025,
            \"min\": 30025,
            \"negate\": false,
            \"protocol\": 6,
            \"timeout\": 0
        }]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/31/services?type=group&show_members=false
OUTPUT{
    \"services\": {
    \"count\": 100,
        \"service\": [
            {
                \"@xsi.type\": \"serviceGroupDTO\",
                \"id\": 1359066,
                \"name\": \"#Shared Domain@DNS\",
                \"display_name\": \"DNS\",
                \"class_name\": \"service_group\",
                \"type\": \"group\",
                \"global\": \"false\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": false,
                \"overrides\": \"false\",
                \"type_on_device\": gen_service_group,
                \"is_device_predefined\": true,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"DNS\",
                    \"name\": \"#Shared Domain@DNS\",
            }
        ]
    }
}

","folder":"1-25","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/services","collectionId":"1","id":"1-25-175","method":"GET"},{"headers":"Accept: application/json\n","name":"Get rules containing specified service object","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the security rules that contain the specified service object


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the service object.
include_groups: You can add \"include_groups\" to find rules that include the service object and rules that include the groups that include the service object. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]

Usage Example
https://192.168.1.1/securetrack/api/services/65078/rules?include_groups=true
","folder":"1-25","url":"https://{{SecureTrack_IP}}/securetrack/api/services/{{id}}/rules","collectionId":"1","id":"1-25-176","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific service","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches list of specific service objects defined in revision given by revision ID and specified by their IDs

Parameters:
context: Global MSSP context [optional]
revision_id: Revision id
ids: Rule IDs
show_members: Set to false to return only the name and ID of the members [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/services/959888
","folder":"1-25","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/services/{{ids}}","collectionId":"1","id":"1-25-177","method":"GET"},{"headers":"Accept: application/json\n","name":"Get service groups containing specified service objects","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns groups that contain the specified service objects


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the service object.

Usage Example
https://192.168.1.1/securetrack/api/services/69577/groups
","folder":"1-25","url":"https://{{SecureTrack_IP}}/securetrack/api/services/{{id}}/groups","collectionId":"1","id":"1-25-178","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific service","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches list of specific service objects defined in device given by device ID and specified by their IDs.
Note: This API retrieves the information from the latest revision.

Parameters:
context: Global MSSP context [optional]
device_id: Device ID
ids: Service object IDs separated by commas
show_members: Set to false to return only the name and ID of the members [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/services/959888,959966
","folder":"1-25","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/services/{{ids}}","collectionId":"1","id":"1-25-179","method":"GET"},{"headers":"Accept: application/json\n","name":"Get services by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of service objects defined on device given by device ID.
The default value for get_total is false. For APIF 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.


Parameters:
context: Global MSSP context [optional]
id: Device ID
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
start: Starting page for query allowable types are numeric [optional]
count: Number of pages for query allowable values are numeric [optional]
name: Service name [optional]
type: Service type, allowable values are: tcp, udp, ip or icmp [optional]
port: Service port [optional]
icmp_type: Service ICMP type allowable values are numeric between 0 to 40 [optional]
protocol: Service protocol, allowable values are numeric between 0 to 255 [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/20/services?get_total=true
OUTPUT {
    \"services\": {
        \"count\": 50,
        \"total\": 100,
        \"service\": [{
            \"@xsi.type\": \"singleServiceDTO\",
            \"id\": 5129479,
            \"name\": \"Tcp30025\",
            \"display_name\": \"Tcp30025\",
            \"class_name\": \"tcp_service\",
            \"type\": \"tcp_service\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{079F15A5-009E-7E47-BBD0-E65973646562}\",
            \"implicit\": false,
            \"overrides\": false,
            \"max\": 30025,
            \"min\": 30025,
            \"negate\": false,
            \"protocol\": 6,
            \"timeout\": 0
        }]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/services?type=group&show_members=false
OUTPUT{
    \"services\": {
    \"count\": 100,
        \"service\": [
            {
                \"@xsi.type\": \"serviceGroupDTO\",
                \"id\": 1359066,
                \"name\": \"#Shared Domain@DNS\",
                \"display_name\": \"DNS\",
                \"class_name\": \"service_group\",
                \"type\": \"group\",
                \"global\": \"false\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": false,
                \"overrides\": \"false\",
                \"type_on_device\": gen_service_group,
                \"is_device_predefined\": true,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"DNS\",
                    \"name\": \"#Shared Domain@DNS\",
            }
        ]
    }
}

","folder":"1-25","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/services","collectionId":"1","id":"1-25-180","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Get services objects matching specified criteria","data":[{"value":null,"type":"text","enabled":true,"key":"filter"}],"dataMode":"raw","description":"You can search for service objects where the name or comment fields have a specified text string,
or you can search for service objects that have an Port or protocol that matches,
or you can search for service objects by uid.

Parameters:
context: Returns results for the specified domain ID. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]
filter: “text” filter returns service objects where the name or comment fields have a specified text string. \n“protocol” filter returns service objects that have a protocol that matches specified IP protocol number.\n“port” filter returns service objects that have a port that matches specified port number.\n “uid“ filter returns service objects with the specified uid.\n If no filter is specified, the “text” filter is used.
device_id: Returns service objects belonging to the specified device_id. [optional]
name: (For “text” filter) You can specify \"name\" to find service objects with the specified text in the name field. [optional]
comment: (For “text” filter) You can specify “comment” to find service objects with the specified text in the comment field. [optional]
protocol: Specify Protocolto find service objects that have the specified IP Protocol. [optional]
port: Specify Portto find service objects that have the specified Port. [optional]
uid: (for “uid“ filter) Returns service objects with the specified uid. [optional]

Usage Example
https://192.168.1.1/securetrack/api/services/search?filter=protocol&protocol=6&device_id=68

Usage Example
https://192.168.1.1/securetrack/api/services/search?filter=port&port=80

Usage Example
https://192.168.1.1/securetrack/api/services/search?filter=uid&uid=24a8774d-24c1-4b3a-aae9-3c272a2b5191

Usage Example
URLhttps://192.168.1.1/securetrack/api/services/search?filter=text&name=tcp_10
BODY{
    \"services\": {
        \"count\": 1,
        \"total\": 1,
        \"service:\": {
            \"id\": 169197,
            \"name\": \"tcp_10\",
            \"display_name\": \"tcp_10\",
            \"class_name\": \"access_role\",
            \"global\": false,
            \"device_id\": 158,
            \"comment\": \"\",
            \"uid\": \"{9EDC2607-6BEC-43D7-A99D-B522BA694ADA}\",
            \"implicit\": false,
            \"max\": false,
            \"min\": false,
            \"protocol\": 6,
            \"timeout\": \"\",
            \"type\": \"tcp_service\",
            }
        }
    }
}

","folder":"1-25","rawModeData":"{\n\t\"services\": {\n\t\t\"count\": 1,\n\t\t\"total\": 1,\n\t\t\"service:\": {\n\t\t\t\"id\": 169197,\n\t\t\t\"name\": \"tcp_10\",\n\t\t\t\"display_name\": \"tcp_10\",\n\t\t\t\"class_name\": \"access_role\",\n\t\t\t\"global\": false,\n\t\t\t\"device_id\": 158,\n\t\t\t\"comment\": \"\",\n\t\t\t\"uid\": \"{9EDC2607-6BEC-43D7-A99D-B522BA694ADA}\",\n\t\t\t\"implicit\": false,\n\t\t\t\"max\": false,\n\t\t\t\"min\": false,\n\t\t\t\"protocol\": 6,\n\t\t\t\"timeout\": \"\",\n\t\t\t\"type\": \"tcp_service\",\n\t\t\t}\n\t\t}\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/services/search","collectionId":"1","id":"1-25-181","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific time object","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches list of time objects by revision ID and rule ID

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Rule IDs

Usage Example
https://192.168.1.1/securetrack/api/revisions/7/time_objects/9
","folder":"1-26","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/time_objects/{{ids}}","collectionId":"1","id":"1-26-182","method":"GET"},{"headers":"Accept: application/json\n","name":"Get time objects by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the time objects used in the specified device.

Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable values are numeric [optional]
count: Starting page for query allowable values are numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/time_objects
","folder":"1-26","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/time_objects","collectionId":"1","id":"1-26-183","method":"GET"},{"headers":"Accept: application/json\n","name":"Get time objects by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the time objects used in the specified revision.

Parameters:
context: Global MSSP context [optional]
id: Revision ID
start: Starting page for query allowable value is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/time_objects
","folder":"1-26","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/time_objects","collectionId":"1","id":"1-26-184","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Get policy relevance metrics for traffic","dataMode":"raw","description":"The response lists all the relevant security groups, tags, relevant instances, and count of unrelated instances for each Amazon VPC in the specified traffic path.
A relevant security group contains at least one instance including either the source or destination IP address.
An unrelated instance is included in the security group but not part of the specified traffic path.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is used only if MSSP mode is enabled. If MSSP mode is disabled context is ignored.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.

Parameters:
context: Global MSSP context [optional]
body: Relevance metrics request

Usage Example
URLhttps://192.168.1.1/securetrack/api/traffic_policy
BODY{
    \"relevance_metrics\": {
        \"source_ips\": {
            \"source\":[\"10.10.253.0/24\", \"172.31.50.99/32\"]
        },
        \"dest_ips\": {
            \"dest\": [\"172.31.150.0/24\", \"172.31.50.99/32\"]
        },
        \"targets\": {
            \"target\": [4, 10]
        }
    }
}


Response Messages:
200: Successful
401: Insufficient user permissions
404: Device not found
400: Invalid parameters","folder":"1-27","rawModeData":"{\n\t\"relevance_metrics\": {\n\t\t\"source_ips\": {\n\t\t\t\"source\":[\"10.10.253.0/24\", \"172.31.50.99/32\"]\n\t\t},\n\t\t\"dest_ips\": {\n\t\t\t\"dest\": [\"172.31.150.0/24\", \"172.31.50.99/32\"]\n\t\t},\n\t\t\"targets\": {\n\t\t\t\"target\": [4, 10]\n\t\t}\n\t}\n}\n","url":"https://{{SecureTrack_IP}}/securetrack/api/traffic_policy/","collectionId":"1","id":"1-27-185","method":"POST"},{"headers":"Content-Type: application/xml\n","name":"Start a task to calculate violations for an access request","dataMode":"raw","description":"Create a calculation task to find access requests violations.
Returns a task Id that can be used to check the task status and get the task results

Parameters:
body [optional]
use_topology: Use topology to determine access request domains. [optional]
ar_domain_mode: The access request uses resources from multiple domains. [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/violations/access_requests/task?use_topology=false&ar_domain_mode=false
BODY<access_requests>
    <access_request>
     <use_topology>false</use_topology>
     <access_request_order>0</access_request_order>
     <access_request_source xsi:type=\"internet\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"/>
     <access_request_destination xsi:type=\"ip_network\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <network xsi:type=\"raw_network_subnet\">
         <negate>false</negate>
         <ip>10.100.0.1</ip>
         <mask>255.255.255.255</mask>
         </network>
     </access_request_destination>
     <access_request_service xsi:type=\"implicit_service\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <name>ssh</name>
         <service>
             <predefined>true</predefined>
             <min_protocol>6</min_protocol>
             <max_protocol>6</max_protocol>
             <min_port>22</min_port>
             <max_port>22</max_port>
             <negate>false</negate>
         </service>
     </access_request_service>
     <action>ACCEPT</action>
    </access_request>
</access_requests>


Response Messages:
202: Access request violations task was accepted.
400: Access request order is not unique.
400: Domain cannot be specified when domain mode is false.
400: Cannot specify both ticket domain id and source and destination domains.
400: No domain specified in MSSP mode.
400: Domain does not exist.
400: Access request is malformed.
400: No valid access requests (Access requests cannot have topology enabled and the Internet object in the Source/Destination)
400: No network source were specified.
400: No network destination were specified.
401: Access is denied.
503: Access request violations task was rejected.","folder":"1-28","rawModeData":"\n\t\n\t false\n\t 0\n\t \n\t \n\t\t \n\t\t false\n\t\t 10.100.0.1\n\t\t 255.255.255.255\n\t\t \n\t \n\t \n\t\t ssh\n\t\t \n\t\t\t true\n\t\t\t 6\n\t\t\t 6\n\t\t\t 22\n\t\t\t 22\n\t\t\t false\n\t\t \n\t \n\t ACCEPT\n\t\n\n","url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/task","collectionId":"1","id":"1-28-186","method":"POST"},{"headers":"Accept: application/json\n","name":"Get violation task results","data":[{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"params","description":"Get result of access requests violations task.

Parameters:
taskId: The unique identifier of the access request violations task.

Usage Example
https://192.168.1.1/securetrack/api/violations/access_requests/result/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Access request violations task results were received.
401: Access is denied.
404: An error occurred during the calculation.
404: The calculation for the task has not finished yet.","folder":"1-28","url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/result/{{taskId}}","collectionId":"1","id":"1-28-187","method":"GET"},{"name":"Cancel violation task","data":[{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"params","description":"Delete an access request violations task.

Parameters:
taskId: The unique identifier of the access request violations task.

Usage Example
https://192.168.1.1/securetrack/api/violations/access_requests/task/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
204: Access request violations task has been aborted successfully.
401: Access is denied.
404: Access request violations task was not found.","folder":"1-28","url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/task/{{taskId}}","collectionId":"1","id":"1-28-188","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get violation task status","data":[{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"params","description":"Get access requests violations task status.

Parameters:
taskId: The unique identifier of the access request violations task.

Usage Example
https://192.168.1.1/securetrack/api/violations/access_requests/status/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Access request violations task status was received.
401: Access is denied.
404: Access request violations task status was not found.","folder":"1-28","url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/status/{{taskId}}","collectionId":"1","id":"1-28-189","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Get violations for an access request","dataMode":"raw","description":"Calculate the violations for the given access request.
Note: this API may take a while to complete.
See the asynchronous API /violations/access_request/task as an alternative.

Parameters:
body: AccessRequestListDTO
use_topology: Use topology to determine access request domains. [optional]
ar_domain_mode: The access request supports multiple domains. [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/violations/access_requests/sync?use_topology=false&ar_domain_mode=false
BODY<access_requests>
    <access_request>
     <use_topology>false</use_topology>
     <access_request_order>0</access_request_order>
     <access_request_source xsi:type=\"internet\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"/>
     <access_request_destination xsi:type=\"ip_network\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <network xsi:type=\"raw_network_subnet\">
         <negate>false</negate>
         <ip>10.100.0.1</ip>
         <mask>255.255.255.255</mask>
         </network>
     </access_request_destination>
     <access_request_service xsi:type=\"implicit_service\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <name>ssh</name>
         <service>
             <predefined>true</predefined>
             <min_protocol>6</min_protocol>
             <max_protocol>6</max_protocol>
             <min_port>22</min_port>
             <max_port>22</max_port>
             <negate>false</negate>
         </service>
     </access_request_service>
     <action>ACCEPT</action>
    </access_request>
</access_requests>


Response Messages:
200: Access request violations were calculated.
400: Access request order is not unique.
400: Domain cannot be specified when domain mode is false.
400: Cannot specify both ticket domain id and source and destination domains.
400: No domain specified in MSSP mode.
400: Domain does not exist.
400: Access request is malformed.
400: No valid access requests (Access requests cannot have topology enabled and the Internet object in the Source/Destination).
401: Access is denied.","folder":"1-28","rawModeData":"\n\t\n\t false\n\t 0\n\t \n\t \n\t\t \n\t\t false\n\t\t 10.100.0.1\n\t\t 255.255.255.255\n\t\t \n\t \n\t \n\t\t ssh\n\t\t \n\t\t\t true\n\t\t\t 6\n\t\t\t 6\n\t\t\t 22\n\t\t\t 22\n\t\t\t false\n\t\t \n\t \n\t ACCEPT\n\t\n\n","url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/sync","collectionId":"1","id":"1-28-190","method":"POST"},{"name":"Delete alerts by ids","data":[{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Delete specified alerts by IDs
To delete multiple alert_ids, use a comma between each ID

Parameters:
context: Delete alerts in the specified domain ID. [optional]
ids: The alert Ids for deletion

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts/87

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts/86,87,88

Response Messages:
200:
401: Security Policy Alert Ids: :|'alert ids'| don't exist","folder":"1-29","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/{{ids}}","collectionId":"1","id":"1-29-191","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get a specific alert","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns a specified alert.
If the alert_id does not exist, an error message is returned.

Parameters:
context: MSSP context [optional]
id: The alert Id

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts/1

Response Messages:
401: Alert ID does not exist","folder":"1-29","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/{{id}}","collectionId":"1","id":"1-29-192","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Update an alert","dataMode":"raw","description":"Update an alert for unified security policies.
Alerts can be defined for all devices (all_devices:true) or for specified device IDs.
An email and/or user name must be defined. For multiple entries of emails or user names, use a semicolon to separate values. For SecureTrack, users in the collection are populated with \"user_ids\". The alert will be sent to the users (according to the addresses configured in SecureTrack) and to the emails.
To get the domain_id (optional parameter), call /domains/ API and use the ID included within the returned domain DTO.
At least one severity should be marked as 'true'.
There are no default values

Parameters:
context: Global MSSP context [optional]
id: The alert ID for updating [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_policies/alerts/1
BODY{
    \"usp_alert_configuration\": {
        \"name\": \"uspAlert\",
        \"description\": \"description\",
        \"status\": \"ACTIVE\",
        \"domain_id\": 6,
        \"all_devices\": false,
        \"device_ids\": {
            \"device_id\": [
                1,
                2,
                3,
                4
            ]
        },
        \"low_severity\": true,
        \"medium_severity\": true,
        \"high_severity\": true,
        \"critical_severity\": false,
        \"user_ids\": {
            \"user_id\": \"moshe\"
        },
        \"emails\": \"user@doamin.com\",
        \"send_syslog\": true
    }
}


Response Messages:
204: Alert ID: 'alertId' was updated successfully
404: Alert ID: 'alertId' does not exist
412: Alert name not specified
409: Alert name specified already exists
412: Status not specified
412: Domain not specified
404: Domain specified does not exist
401: User is not authorized to configure alerts for domain 'domainId'
412: Device not specified
404: Device ID specified does not exist or belongs to a different domain
403: Device: 'deviceId' not supported for USP
412: Severity not specified
412: No recipient details entered for alert
412: Invalid email address. Format must be name@domain.com
404: Username: 'userName' does not exist
403: User is not authorized to configure alerts for Super Admin user: 'userName'
403: Username: 'userName' not valid for the specified domain","folder":"1-29","rawModeData":"{\n\t\"usp_alert_configuration\": {\n\t\t\"name\": \"uspAlert\",\n\t\t\"description\": \"description\",\n\t\t\"status\": \"ACTIVE\",\n\t\t\"domain_id\": 6,\n\t\t\"all_devices\": false,\n\t\t\"device_ids\": {\n\t\t\t\"device_id\": [\n\t\t\t\t1,\n\t\t\t\t2,\n\t\t\t\t3,\n\t\t\t\t4\n\t\t\t]\n\t\t},\n\t\t\"low_severity\": true,\n\t\t\"medium_severity\": true,\n\t\t\"high_severity\": true,\n\t\t\"critical_severity\": false,\n\t\t\"user_ids\": {\n\t\t\t\"user_id\": \"moshe\"\n\t\t},\n\t\t\"emails\": \"user@doamin.com\",\n\t\t\"send_syslog\": true\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/{{id}}","collectionId":"1","id":"1-29-193","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get alerts","data":[{"value":null,"type":"text","enabled":true,"key":"start"},{"value":null,"type":"text","enabled":true,"key":"count"}],"dataMode":"params","description":"Returns a list of all alerts. If an empty list is returned, it implies that there are no configured alerts for that context.
You must set start and count parameters to limit the number of returned alerts.
Start is zero based - to start from the second rule use start=1, to get rules 51-60 use start=50 and count=10.

Parameters:
context: MSSP context [optional]
start: Returns the results beginning with the specified result number
count: Returns the specified number of results

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts?start=10&count=25

Response Messages:
400: Value for start parameter is missing or not valid
400: Value for count parameter is missing or not valid","folder":"1-29","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/","collectionId":"1","id":"1-29-194","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Create an alert","dataMode":"raw","description":"Create an alert for unified security policies.
Returns location with the alert id to get the alert.
Alerts can be defined for all devices (all_devices:true) or for specified device IDs.
An email and/or user name must be defined. For multiple entries of emails or user names, use a semicolon to separate values. For SecureTrack, users in the collection are populated with \"user_ids\". The alert will be sent to the users (according to the addresses configured in SecureTrack) and to the emails.
To get the domain_id (optional parameter), call /domains/ API and use the ID included within the returned domain DTO.
At least one severity should be marked as 'true'.
There are no default values

Parameters:
context: Global MSSP context [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_policies/alerts
BODY{
    \"usp_alert_configuration\": {
        \"name\": \"uspAlert\",
        \"description\": \"description\",
        \"status\": \"ACTIVE\",
        \"domain_id\": 6,
        \"all_devices\": false,
        \"device_ids\": {
            \"device_id\": [
                1,
                2,
                3,
                4
            ]
        },
        \"low_severity\": true,
        \"medium_severity\": true,
        \"high_severity\": true,
        \"critical_severity\": false,
        \"user_ids\": {
            \"user_id\": \"moshe\"
        },
        \"emails\": \"user@doamin.com\",
        \"send_syslog\": true
    }
}


Response Messages:
201: Security policy alert id :|'alertId'| , name : 'alertName'
412: Alert name not specified
409: Alert name specified already exists
412: Status not specified
412: Domain not specified
404: Domain specified does not exist
401: User is not authorized to configure alerts for domain 'domainId'
412: Device not specified
404: Device ID specified does not exist or belongs to a different domain
403: Device: 'deviceId' not supported for USP
412: Severity not specified
412: No recipient details entered for alert
412: Invalid email address. Format must be name@domain.com
404: Username: 'userName' does not exist
403: User is not authorized to configure alerts for Super Admin user: 'userName'
403: Username: 'userName' not valid for the specified domain","folder":"1-29","rawModeData":"{\n\t\"usp_alert_configuration\": {\n\t\t\"name\": \"uspAlert\",\n\t\t\"description\": \"description\",\n\t\t\"status\": \"ACTIVE\",\n\t\t\"domain_id\": 6,\n\t\t\"all_devices\": false,\n\t\t\"device_ids\": {\n\t\t\t\"device_id\": [\n\t\t\t\t1,\n\t\t\t\t2,\n\t\t\t\t3,\n\t\t\t\t4\n\t\t\t]\n\t\t},\n\t\t\"low_severity\": true,\n\t\t\"medium_severity\": true,\n\t\t\"high_severity\": true,\n\t\t\"critical_severity\": false,\n\t\t\"user_ids\": {\n\t\t\t\"user_id\": \"moshe\"\n\t\t},\n\t\t\"emails\": \"user@doamin.com\",\n\t\t\"send_syslog\": true\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/","collectionId":"1","id":"1-29-195","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Create a cloud tag policy","dataMode":"raw","description":"Create a new cloud tag policy. The policyName field specified in the TagPolicyDTO must be unique. Define the requirements enforced by the cloud tag policy in the requirements field of the TagPolicyDTO. The supported value for the \"requirement_type\" field are \"mandatory_tags\" and \"valid_values\"If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Create policy for the specified domain ID [optional]
body: cloud tag policy DTO [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/
BODY {
    \"policy_name\": \"Production-VPC-Tag-Policy\",
    \"policy_description\": \"Instances tags in production\",
    \"requirements\": [
        {
            \"requirement_type\": \"mandatory_tags\",
            \"requirement_name\": \"mandatory_financial_tags\",
            \"requirement_severity\": \"HIGH\",
            \"tags\": [
                \"Owner\",
                \"Budget\"
            ]
        },
        {
            \"requirement_type\": \"valid_values\",
            \"requirement_name\": \"budget_valid_values\",
            \"requirement_severity\": \"CRITICAL\",
            \"tag\": \"Budget\",
            \"values\": [
                \"Corporate\",
                \"Dev\"
            ]
        }
    ]
}
OUTPUT{
        \"status\": \"OK\",
        \"policy_id\": \"tp-123\"
}


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions
409: Policy name already exists","folder":"1-30","rawModeData":" {\n\t\"policy_name\": \"Production-VPC-Tag-Policy\",\n\t\"policy_description\": \"Instances tags in production\",\n\t\"requirements\": [\n\t\t{\n\t\t\t\"requirement_type\": \"mandatory_tags\",\n\t\t\t\"requirement_name\": \"mandatory_financial_tags\",\n\t\t\t\"requirement_severity\": \"HIGH\",\n\t\t\t\"tags\": [\n\t\t\t\t\"Owner\",\n\t\t\t\t\"Budget\"\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"requirement_type\": \"valid_values\",\n\t\t\t\"requirement_name\": \"budget_valid_values\",\n\t\t\t\"requirement_severity\": \"CRITICAL\",\n\t\t\t\"tag\": \"Budget\",\n\t\t\t\"values\": [\n\t\t\t\t\"Corporate\",\n\t\t\t\t\"Dev\"\n\t\t\t]\n\t\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/policies/","collectionId":"1","id":"1-30-196","method":"POST"},{"headers":"Accept: application/json\n","name":"Get all cloud tag policies","description":"This API returns the details of all the tag policies.

Results are filtered according to user domain permissions and request context. If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Returns results for the specified domain ID [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/
OUTPUT{
        \"status\": \"OK\",
        \"result\": [
                {
                        \"policy_id\": \"tp-101\",
                        \"policy_name\": \"myPolicy1\",
                        \"requirements\": [
                                {
                                        \"requirement_type\": \"mandatory_tags\",
                                        \"requirement_name\": \"myMandatoryRequirement\",
                                        \"requirement_severity\": \"HIGH\",
                                        \"tags\": [
                                                \"Owner\",
                                                \"Name\"
                                        ]
                                },
                                {
                                        \"requirement_type\": \"valid_values\",
                                        \"requirement_name\": \"myValidValueRequirement\",
                                        \"requirement_severity\": \"CRTICAL\",
                                        \"tag\": \"Budget\",
                                        \"values\": [
                                                \"R&D\",
                                                \"HR\"
                                        ]
                                }
                        ]
                },
                {
                        \"policy_id\": \"tp-102\",
                        \"policy_name\": \"myPolicy2\",
                        \"requirements\": [
                                {
                                        \"requirement_type\": \"mandatory_tags\",
                                        \"requirement_name\": \"myMandatoryRequirement\",
                                        \"requirement_severity\": \"HIGH\",
                                        \"tags\": [
                                                \"Owner\"
                                        ]
                                },
                                {
                                        \"requirement_type\": \"valid_values\",
                                        \"requirement_name\": \"myValidValueRequirement\",
                                        \"requirement_severity\": \"CRTICAL\",
                                        \"tag\": \"Budget\",
                                        \"values\": [
                                                \"R&D\",
                                                \"HR\"
                                        ]
                                }
                        ]
                }
        ]
}


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions","folder":"1-30","url":"https://{{SecureTrack_IP}}/securetrack/api/policies/","collectionId":"1","id":"1-30-197","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Replace a cloud tag policy","dataMode":"raw","description":"Replace the cloud tag policy specified by policyID with the new policy attributes.

Use PATCH in order to partially modify a policy. If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Replace policy of the specified domain ID [optional]
policyId: cloud tag policy id [optional]
body: cloud tag policy dTO [optional]

Usage Example
URLhttps://{ip}/securetrack/api/tagpolicy/policies/policyId
BODY{
    \"policy_name\": \"myPolicyName\",
    \"requirements\": [
        {
            \"requirement_type\": \"mandatory_tags\",
            \"requirement_name\": \"mandatory_requirement1\",
            \"requirement_severity\": \"CRTICAL\",
            \"tags\": [
                \"Owner\",
                \"Role\"
            ]
        }
    ]
}
OUTPUT{
        \"status\": \"OK\",
        \"policy_id\": \"tp-123\"
}

","folder":"1-30","rawModeData":"{\n\t\"policy_name\": \"myPolicyName\",\n\t\"requirements\": [\n\t\t{\n\t\t\t\"requirement_type\": \"mandatory_tags\",\n\t\t\t\"requirement_name\": \"mandatory_requirement1\",\n\t\t\t\"requirement_severity\": \"CRTICAL\",\n\t\t\t\"tags\": [\n\t\t\t\t\"Owner\",\n\t\t\t\t\"Role\"\n\t\t\t]\n\t\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","collectionId":"1","id":"1-30-198","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get cloud tag policy","description":"This API retrieves the details of the cloud tag policy specified by policyId.

User must have admin permissions to the policy affiliated domain. If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Returns results for the specified domain ID [optional]
policyId: cloud tag policy id [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/policyId
OUTPUT{
        \"status\": \"OK\",
        \"result\": [
                {
                        \"policy_id\": \"tp-101\",
                        \"policy_name\": \"myPolicyName\",
                        \"requirements\": [
                                {
                                        \"requirement_type\": \"mandatory_tags\",
                                        \"requirement_name\": \"myMandatoryTagsRequirement\",
                                    \"requirement_severity\": \"CRTICAL\",
                                        \"tags\": [
                                                \"Owner\",
                                                \"Name\"
                                        ]
                                },
                                {
                                        \"requirement_type\": \"valid_values\",
                                        \"requirement_name\": \"myValidValueRequirement\",
                                    \"requirement_severity\": \"CRTICAL\",
                                        \"tag\": \"Budget\",
                                        \"values\": [
                                                \"R&D\",
                                                \"HR\"
                                        ]
                                }
                        ]
                }
        ]
}


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions
404: Resource not found","folder":"1-30","url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","collectionId":"1","id":"1-30-199","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Modify a cloud tag policy","dataMode":"raw","description":"Partially modify a cloud tag policy by stating the modified attributes. Providing requirements replaces the entire list.

Specifying an empty requirement list is not permitted. Modify some attributes of the cloud tag policy specified by policyID with the attributes provided. If one or more \"requirement\" objects is provided, the exsiting \"requirement\" objects will be deleted and replaced with the new objetcs. Specifying an empty requirement list is not permitted.If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Rename policy of the specified domain ID [optional]
policyId: cloud tag policy id [optional]
body: cloud tag policy dTO [optional]

Usage Example
URLhttps://{ip}/securetrack/api/tagpolicy/policies/policyId
BODY{
    \"policy_name\": \"myPolicyName\",
    \"requirements\": [
        {
            \"requirement_type\": \"mandatory_tags\",
            \"requirement_name\": \"mandatory_requirement1\",
            \"requirement_severity\": \"CRTICAL\",
            \"tags\": [
                \"Owner\",
                \"Role\"
            ]
        }
    ]
}
OUTPUT{
        \"status\": \"OK\",
        \"policy_id\": \"tp-123\"
}


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions
404: Resource not found","folder":"1-30","rawModeData":"{\n\t\"policy_name\": \"myPolicyName\",\n\t\"requirements\": [\n\t\t{\n\t\t\t\"requirement_type\": \"mandatory_tags\",\n\t\t\t\"requirement_name\": \"mandatory_requirement1\",\n\t\t\t\"requirement_severity\": \"CRTICAL\",\n\t\t\t\"tags\": [\n\t\t\t\t\"Owner\",\n\t\t\t\t\"Role\"\n\t\t\t]\n\t\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","collectionId":"1","id":"1-30-200","method":"PATCH"},{"headers":"Accept: application/json\n","name":"Delete cloud tag policy","description":"Delete the cloud tag policy specified by policyId.

If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Delete policy of the specified domain ID [optional]
policyId: cloud tag policy id [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/policyId
OUTPUT {
        \"status\": \"OK\",
        \"policy_name\": \"myPolicyName\"
}


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions
404: Resource not found","folder":"1-30","url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","collectionId":"1","id":"1-30-201","method":"DELETE"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Check if tags are compliant with cloud tag policies","data":[{"value":null,"type":"text","enabled":true,"key":"policy_external_id"}],"dataMode":"raw","description":"Check if the tags of a cloud resource are compliant with the specified cloud tag policy. Specify the tag policy to validate in the TagPolicyViolationsCheckRequestDTO. The tags of a cloud resource are specified as a json object with the attribute 'tags' at the root level. 'tags' attributes can be a list of tag names or a map including both the tag name and value. If no tags are specified or if the tag is specified incorrectly, The compliance check will treat the resource as if it has no tags. If no cloud tag policy violations are found the API returns an empty violations list.

Parameters:
context: Returns results for the specified domain ID [optional]
policy_external_id: Tag policy external identifier
body: Tag policy violation check request

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/violation_check?policy_external_id=policyId
BODY {
    \"type\": \"vm\",
    \"name\": \"CRM-FE\",
    \"os\": \"ubuntu14.4\",
    \"image\": \"AMI-12345\",
    \"tags\": {
        \"Role\": \"webserver\",
        \"Budget\": \"corporate\",
        \"Owner\": \"Steve.Smith\"
    }
}


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions
404: Resource not found","folder":"1-30","rawModeData":" {\n\t\"type\": \"vm\",\n\t\"name\": \"CRM-FE\",\n\t\"os\": \"ubuntu14.4\",\n\t\"image\": \"AMI-12345\",\n\t\"tags\": {\n\t\t\"Role\": \"webserver\",\n\t\t\"Budget\": \"corporate\",\n\t\t\"Owner\": \"Steve.Smith\"\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/violation_check/","collectionId":"1","id":"1-30-202","method":"POST"},{"headers":"Accept: application/json\n","name":"Get all cloud tag policy violations for a VPC","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"},{"value":null,"type":"text","enabled":true,"key":"severity"}],"dataMode":"params","description":"Retrieve all cloud tag policy violations for the specified VPC and severity level.

Parameters:
context: Global MSSP context. [optional]
deviceId: The device ID for which to get violations
severity: Return only violations of this severity
resourceId: The id of the VM instance [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses \"count=100\". [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tag_violations?deviceId=123&severity=CRITICAL
OUTPUT<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<tag_policy_device_violations>
    <violating_resources_count>2</violating_resources_count>
    <device_name>Amazon Test VPC </device_name>
    <severity>critical</severity>
    <violating_resources>
        <violating_resource>
            <tag_violations>
                <tag_violation>
                    <violation_message>Tag 'Name' value 'email server' is not valid. Valid values are [R&D, HR]</violation_message>
                    <policy_id>tp-100</policy_id>
                    <policy_name>Tag policy 1</policy_name>
                    <requirement_name>validValue_constraint2</requirement_name>
                    <requirement_severity>high</requirement_severity>
                    <violation_attributes xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"valid_values\">
                        <tag>Name</tag>
                        <valid_values>
                            <valid_value>R&D</valid_value>
                            <valid_value>HR</valid_value>
                        </valid_values>
                        <invalid_value>email server</invalid_value>
                    </violation_attributes>
                </tag_violation>
            </tag_violations>
            <resource_id>i-abc12345</resource_id>
            <resource_name>email server</resource_name>
        </violating_resource>
        <violating_resource>
            <tag_violations>
                <tag_violation>
                    <violation_message>Tag 'Application' is missing</violation_message>
                    <policy_id>tp-105</policy_id>
                    <policy_name>Tag policy 1</policy_name>
                    <requirement_name>mandatory_constraint1</requirement_name>
                    <requirement_severity>critical</requirement_severity>
                    <violation_attributes xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"mandatory_tags\">
                        <missing_tag>Application</missing_tag>
                    </violation_attributes>
                </tag_violation>
            </tag_violations>
            <resource_id>i-12345678</resource_id>
            <resource_name>Violations tests server</resource_name>
        </violating_resource>
    </violating_resources>
</tag_policy_device_violations>


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions
404: A device with the specified ID was not found","folder":"1-30","url":"https://{{SecureTrack_IP}}/securetrack/api/tag_violations/","collectionId":"1","id":"1-30-203","method":"GET"},{"headers":"Accept: application/json\n","name":"Delete an exception","data":[{"value":null,"type":"text","enabled":true,"key":"exceptionId"}],"dataMode":"params","description":"Delete the specific unified security policy exceptions

Parameters:
exceptionId: The ID of the exception to delete.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/14

Response Messages:
404: The security policy with the specified ID does not exist
401: User not permitted to access the specified domain.","folder":"1-31","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/{{exceptionId}}","collectionId":"1","id":"1-31-204","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get a specific exception","data":[{"value":null,"type":"text","enabled":true,"key":"exceptionId"}],"dataMode":"params","description":"Gets a specific exception for unified security policies.

Parameters:
exceptionId: The ID of the exception to get.
context: Global MSSP context [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/14

Response Messages:
401: User not permitted to access the specified domain
404: A security policy exception with the specified ID was not found.","folder":"1-31","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/{{exceptionId}}","collectionId":"1","id":"1-31-205","method":"GET"},{"headers":"Accept: application/json\n","name":"Get matching rules task status","data":[{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
taskId: The unique identifier of the matching rules task.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/matching_rules/status/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Matching rules task status was received.
401: User not permitted to Security policy exceptions.
404: Matching rules task status was not found.","dataMode":"params","folder":"1-31","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/matching_rules/status/{{taskId}}","collectionId":"1","id":"1-31-206","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create an exception","dataMode":"raw","description":"Create an exception for unified security policies.

Parameters:
context: Global MSSP context [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_policies/exceptions
BODY<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<security_policy_exception>
    <approved_by>admin</approved_by>
    <created_by>st_user</created_by>
    <creation_date>2015-01-01</creation_date>
    <description>Allow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321</description>
    <exempted_traffic_list>
        <exempted_traffic>
            <comment>Creating USP exception for ticket 123</comment>
            <dest_network_collection>
                <network_items>
                    <network_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"subnet\">
                        <ip>192.168.1.2</ip>
                        <netmask>255.255.255.255</netmask>
                    </network_item>
                </network_items>
            </dest_network_collection>
            <security_requirements>
                <zone_to_zone_security_requirement>
                    <from_zone>LAN</from_zone>
                    <policy_name>corporate security policy</policy_name>
                    <to_zone>DMZ</to_zone>
                </zone_to_zone_security_requirement>
            </security_requirements>
            <service_collection>
                <service_items>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"custom\">
                        <port>4321</port>
                        <protocol>tcp</protocol>
                    </service_item>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"device_service\">
                        <mgmt_id>1</mgmt_id>
                        <service_uid>{5aa1c104-bd4d-4635-a281-b3a5442639ba}</service_uid>
                    </service_item>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"predefined\">
                        <predefined_service_name>http</predefined_service_name>
                    </service_item>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"range_service\">
                        <minProtocol>10</minProtocol>
                        <maxProtocol>20</maxProtocol>
                    </service_item>
                </service_items>
            </service_collection>
            <source_network_collection>
                <network_items>
                    <network_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"subnet\">
                        <ip>192.168.1.1</ip>
                        <netmask>255.255.255.255</netmask>
                    </network_item>
                </network_items>
            </source_network_collection>
        </exempted_traffic>
    </exempted_traffic_list>
    <expiration_date>2025-01-01</expiration_date>
    <name>Allow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321</name>
    <requested_by>admin</requested_by>
    <ticket_id>123</ticket_id>
</security_policy_exception>


Response Messages:
400: The specified network item is not valid.
400: The specified zone name does not exist.
400: The security policy with the specified name does not exist
400: The security policy 'created by' user is not valid.
400: The security policy with the specified name already exists.
401: User not permitted to access the specified domain.","folder":"1-31","rawModeData":"\n\n\tadmin\n\tst_user\n\t2015-01-01\n\tAllow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321\n\t\n\t\t\n\t\t\tCreating USP exception for ticket 123\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t192.168.1.2\n\t\t\t\t\t\t255.255.255.255\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\tLAN\n\t\t\t\t\tcorporate security policy\n\t\t\t\t\tDMZ\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t4321\n\t\t\t\t\t\ttcp\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t1\n\t\t\t\t\t\t{5aa1c104-bd4d-4635-a281-b3a5442639ba}\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\thttp\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t10\n\t\t\t\t\t\t20\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t192.168.1.1\n\t\t\t\t\t\t255.255.255.255\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\t2025-01-01\n\tAllow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321\n\tadmin\n\t123\n","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/","collectionId":"1","id":"1-31-207","method":"POST"},{"headers":"Accept: application/json\n","name":"Get all exceptions","description":"Gets a list of all unified security policy exceptions.

Parameters:
context: Global MSSP context [optional]
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query starting from starting page allowable type in numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions

Response Messages:
401: User not permitted to access the specified domain","folder":"1-31","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/","collectionId":"1","id":"1-31-208","method":"GET"},{"name":"Start a task to calculate matching rules for an exception","data":[{"value":null,"type":"text","enabled":true,"key":"exceptionId"}],"dataMode":"params","description":"Create a calculation task to find matching rules.
The results will be on the relevant devices for each access.
Returns a task Id that can be used to check the task status and get the task results

Parameters:
exceptionId: Security policy Exception ID on which to run the API.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/1/matching_rules/start

Response Messages:
401: User not permitted to Security policy exceptions.
404: A security policy exception with the specified ID was not found.","folder":"1-31","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/{{exceptionId}}/matching_rules/start","collectionId":"1","id":"1-31-209","method":"POST"},{"headers":"Accept: application/json\n","name":"Get matching rules task results","data":[{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
taskId: The unique identifier of the matching rules task.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/matching_rules/result/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Matching rules task results were received.
401: User not permitted to Security policy exceptions.
404: An error occurred during the calculation.
404: The calculation for the task has not finished yet.","dataMode":"params","folder":"1-31","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/matching_rules/result/{{taskId}}","collectionId":"1","id":"1-31-210","method":"GET"},{"name":"Cancel Matching rules task","data":[{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
taskId: The unique identifier of the matching rules task.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/matching_rules/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
204: Matching rules task has been aborted successfully.
401: User not permitted to Security policy exceptions.
404: Matching rules task was not found.","dataMode":"params","folder":"1-31","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/matching_rules/{{taskId}}","collectionId":"1","id":"1-31-211","method":"DELETE"},{"headers":"Content-Type: application/xml\n","name":"Set manual device mapping","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"}],"dataMode":"raw","description":"Add or remove a zone on a device interface

Parameters:
context: Global MSSP context [optional]
deviceId: Device ID
body: InterfacesManualMappingsDTO

Usage Example
URLhttps://127.0.0.1/securetrack/api/security_policies/10/manual_mapping
BODY<interfaces_manual_mappings>
<interface_manual_mapping>
<interface_name>Vlan_30</interface_name>
<zones_user_actions>
<zone_user_action>
<zoneId>10</zoneId>
<action>add</action>
</zone_user_action>
</zones_user_actions>
</interface_manual_mapping>
</interfaces_manual_mappings>


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions
404: Not found error
404: User action not valid (only add/remove)
404: No interface with name for device with id
404: No zone with id
404: No revision for device with id
404: No device with ID
404: Access denied for device with ID
404: InterfacesManualMappingsDTO is empty
404: Error on updating security_policy_interface_zone_mapping_user_action table for device with ID","folder":"1-32","rawModeData":"\n \n Vlan_30\n \n \n 10\n add\n \n \n \n\n ","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/{{deviceId}}/manual_mapping","collectionId":"1","id":"1-32-212","method":"POST"},{"name":"Delete unified security policy","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Delete a Security Policy Matrix

Parameters:
context: Returns results for the specified domain ID. [optional]
id: The unique identifier of the security policy matrix to delete

Usage Example
https://192.168.1.1/securetrack/api/security_policies/1
","folder":"1-32","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/{{id}}","collectionId":"1","id":"1-32-213","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get global unified security policies","description":"Fetches the global security zone matrices defined under Unified Security Policy.



Usage Example
https://192.168.1.1/securetrack/api/security_policies/global

Response Messages:
401: User not permitted to access global security policies","folder":"1-32","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/global","collectionId":"1","id":"1-32-214","method":"GET"},{"collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/{{id}}/export","name":"Get unified security policy as CSV","method":"GET","id":"1-32-215","description":"Exports a Security Policy in CSV format

Parameters:
context: Returns results for the specified domain ID. [optional]
id: ID of the security policy. [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies/1/export

Response Messages:
401: User not permitted to access the specified domain
404: Security Policy does not exist","folder":"1-32"},{"headers":"Accept: application/json\n","name":"Get unified security policies","description":"Fetches the security zone matrices defined under Unified Security Policy.

Parameters:
context: Returns results for the specified domain ID. [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies

Response Messages:
401: User not permitted to access the specified domain","folder":"1-32","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/","collectionId":"1","id":"1-32-216","method":"GET"},{"headers":"Accept: application/json\n","name":"Get the amount of violating rules for the specified device.","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"}],"description":"Parameters:
deviceId: The device ID for which to get violations.

Usage Example
https://192.168.1.1/securetrack/api/violating_rules/1/count

Response Messages:
200: The violation count was successfully retrieved
404: Device with id: <deviceId> doesn't exist","dataMode":"params","folder":"1-33","url":"https://{{SecureTrack_IP}}/securetrack/api/violating_rules/{{deviceId}}/count","collectionId":"1","id":"1-33-217","method":"GET"},{"headers":"Accept: application/json\n","name":"Get the violating rules for the specified device.","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"},{"value":null,"type":"text","enabled":true,"key":"severity"},{"value":null,"type":"text","enabled":true,"key":"type"}],"dataMode":"params","description":"policyName is supported for management devices running in Advanced management mode.

Parameters:
deviceId: The device ID for which to get violations
policyName: Return only violations that match this policy [optional]
severity: Return only violations of this severity
type: Return only violations of this type

Usage Example
https://192.168.1.1/securetrack/api/violating_rules/1/device_violations?policy=policy_name&type=SECURITY_POLICY&severity=MEDIUM

Response Messages:
200: The violations were successfully retrieved
400: The specified value for the violation severity is invalid
400: The specified value for the violation type is invalid
400: You cannot specify a policyName because the device is not running in Advanced management mode
404: A device with the specified ID was not found
404: A policy with the specified policyName was not found for this device","folder":"1-33","url":"https://{{SecureTrack_IP}}/securetrack/api/violating_rules/{{deviceId}}/device_violations","collectionId":"1","id":"1-33-218","method":"GET"}],"order":[],"name":"Tufin Tufin SecureTrack R20-1-GA","id":"1","description":"Tufin Orchestration Suite - Tufin SecureTrack APIs.
For detailed information about the APIs please see the documentation at:
https://your-securetrack-server/securetrack/apidoc"} \ No newline at end of file diff --git a/Postman Format v1/R20-1 postman collection/tufin.postman_environment b/Postman Format v1/R20-1 postman collection/tufin.postman_environment new file mode 100644 index 0000000..c031d2b --- /dev/null +++ b/Postman Format v1/R20-1 postman collection/tufin.postman_environment @@ -0,0 +1 @@ +{"name":"Tufin environment","values":[{"type":"text","key":"SecureApp_IP"},{"type":"text","key":"SecureChange_IP"},{"type":"text","key":"SecureTrack_IP"},{"type":"text","key":"applicationId"},{"type":"text","key":"applicationInterfaceId"},{"type":"text","key":"application_id"},{"type":"text","key":"application_pack_id"},{"type":"text","key":"assigneeId"},{"type":"text","key":"child_id"},{"type":"text","key":"child_ids"},{"type":"text","key":"cleanup_id"},{"type":"text","key":"cloudId"},{"type":"text","key":"cloud_id"},{"type":"text","key":"connectionId"},{"type":"text","key":"connectionInterfaceId"},{"type":"text","key":"connectionToApplicationId"},{"type":"text","key":"connection_id"},{"type":"text","key":"connection_to_application_pack_id"},{"type":"text","key":"customer_id"},{"type":"text","key":"deviceId"},{"type":"text","key":"device_id"},{"type":"text","key":"domainId"},{"type":"text","key":"exceptionId"},{"type":"text","key":"fieldId"},{"type":"text","key":"id"},{"type":"text","key":"ids"},{"type":"text","key":"inId"},{"type":"text","key":"instructionId"},{"type":"text","key":"interfaceCustomerId"},{"type":"text","key":"layer2DataId"},{"type":"text","key":"managementId"},{"type":"text","key":"mgmtId"},{"type":"text","key":"parent_id"},{"type":"text","key":"parent_ids"},{"type":"text","key":"policyId"},{"type":"text","key":"requestId"},{"type":"text","key":"revId"},{"type":"text","key":"revision_id"},{"type":"text","key":"risk_id"},{"type":"text","key":"routeId"},{"type":"text","key":"ruleId"},{"type":"text","key":"rule_id"},{"type":"text","key":"rule_uid"},{"type":"text","key":"serverId"},{"type":"text","key":"serviceId"},{"type":"text","key":"sourceApplicationId"},{"type":"text","key":"stepId"},{"type":"text","key":"tag_id"},{"type":"text","key":"targetApplicationId"},{"type":"text","key":"taskId"},{"type":"text","key":"task_id"},{"type":"text","key":"task_uid"},{"type":"text","key":"toStepId"},{"type":"text","key":"uid"},{"type":"text","key":"userId"},{"type":"text","key":"vpnId"},{"type":"text","key":"zone_id"},{"type":"text","key":"zone_ids"}]} \ No newline at end of file diff --git a/Postman Format v1/R20-2 postman collection/securechangeworkflow_R20-2-HF2.json b/Postman Format v1/R20-2 postman collection/securechangeworkflow_R20-2-HF2.json new file mode 100644 index 0000000..3a0cf83 --- /dev/null +++ b/Postman Format v1/R20-2 postman collection/securechangeworkflow_R20-2-HF2.json @@ -0,0 +1 @@ +{"folders":[{"order":["2-1-1","2-1-2","2-1-3","2-1-4","2-1-5"],"collectionId":"2","name":"Access Portal","hasRequests":true,"id":"2-1"},{"order":["2-2-6","2-2-7","2-2-8","2-2-9","2-2-10","2-2-11","2-2-12","2-2-13"],"collectionId":"2","name":"Application Connections","hasRequests":true,"id":"2-2"},{"order":["2-3-14"],"collectionId":"2","name":"Application Identities","hasRequests":true,"id":"2-3"},{"order":["2-4-15","2-4-16","2-4-17","2-4-18","2-4-19","2-4-20","2-4-21","2-4-22","2-4-23","2-4-24","2-4-25","2-4-26","2-4-27","2-4-28","2-4-29"],"collectionId":"2","name":"Application Interfaces","hasRequests":true,"id":"2-4"},{"order":["2-5-30","2-5-31","2-5-32","2-5-33","2-5-34"],"collectionId":"2","name":"Application Migration","hasRequests":true,"id":"2-5"},{"order":["2-6-35","2-6-36","2-6-37","2-6-38","2-6-39","2-6-40","2-6-41","2-6-42","2-6-43","2-6-44","2-6-45","2-6-46","2-6-47","2-6-48","2-6-49","2-6-50","2-6-51","2-6-52"],"collectionId":"2","name":"Application Packs","hasRequests":true,"id":"2-6"},{"order":["2-7-53"],"collectionId":"2","name":"Application Pending Changes","hasRequests":true,"id":"2-7"},{"order":["2-8-54","2-8-55"],"collectionId":"2","name":"Application Servers (across all applications)","hasRequests":true,"id":"2-8"},{"order":["2-9-56","2-9-57","2-9-58","2-9-59","2-9-60","2-9-61","2-9-62","2-9-63"],"collectionId":"2","name":"Application Servers (by application)","hasRequests":true,"id":"2-9"},{"order":["2-10-64","2-10-65","2-10-66","2-10-67","2-10-68","2-10-69"],"collectionId":"2","name":"Application Services (global)","hasRequests":true,"id":"2-10"},{"order":["2-11-70","2-11-71","2-11-72","2-11-73","2-11-74"],"collectionId":"2","name":"Application Services (local)","hasRequests":true,"id":"2-11"},{"order":["2-12-75","2-12-76","2-12-77","2-12-78"],"collectionId":"2","name":"Application Users","hasRequests":true,"id":"2-12"},{"order":["2-13-79","2-13-80","2-13-81","2-13-82","2-13-83","2-13-84","2-13-85","2-13-86","2-13-87","2-13-88","2-13-89"],"collectionId":"2","name":"Applications","hasRequests":true,"id":"2-13"},{"order":["2-14-90","2-14-91","2-14-92"],"collectionId":"2","name":"Cloud Console","hasRequests":true,"id":"2-14"},{"order":["2-15-93","2-15-94","2-15-95","2-15-96","2-15-97","2-15-98","2-15-99"],"collectionId":"2","name":"Customers","hasRequests":true,"id":"2-15"},{"order":["2-16-100","2-16-101","2-16-102"],"collectionId":"2","name":"Domains","hasRequests":true,"id":"2-16"},{"order":["2-17-103"],"collectionId":"2","name":"Load Balancers","hasRequests":true,"id":"2-17"},{"order":["2-18-104"],"collectionId":"2","name":"Rule Recertification","hasRequests":true,"id":"2-18"},{"order":["2-19-105","2-19-106","2-19-107","2-19-108"],"collectionId":"2","name":"SecureChange Devices","hasRequests":true,"id":"2-19"},{"order":["2-20-109","2-20-110","2-20-111","2-20-112","2-20-113","2-20-114"],"collectionId":"2","name":"Server Decommissioning","hasRequests":true,"id":"2-20"},{"order":["2-21-115","2-21-116"],"collectionId":"2","name":"System Configuration","hasRequests":true,"id":"2-21"},{"order":["2-22-117","2-22-118","2-22-119","2-22-120","2-22-121","2-22-122","2-22-123"],"collectionId":"2","name":"System Users","hasRequests":true,"id":"2-22"},{"order":["2-23-124","2-23-125","2-23-126","2-23-127","2-23-128","2-23-129","2-23-130","2-23-131"],"collectionId":"2","name":"Ticket Lifecycle","hasRequests":true,"id":"2-23"},{"order":["2-24-132","2-24-133","2-24-134","2-24-135","2-24-136","2-24-137","2-24-138","2-24-139","2-24-140","2-24-141","2-24-142","2-24-143","2-24-144","2-24-145","2-24-146","2-24-147","2-24-148","2-24-149","2-24-150","2-24-151","2-24-152","2-24-153","2-24-154","2-24-155","2-24-156","2-24-157","2-24-158"],"collectionId":"2","name":"Tickets","hasRequests":true,"id":"2-24"}],"requests":[{"headers":"Accept: application/json\n","name":"Retrieve existing application access requests","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests

Response Messages:
400: The application was already deleted.
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.","dataMode":"params","folder":"2-1","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests","collectionId":"2","id":"2-1-1","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Create application access request","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: application access request

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests
BODY<application_access_request>
    <server_group_id>1</server_group_id>
    <server_ip>1.1.1.1</server_ip>
    <comment>Request to join the WebServers server group</comment>
</application_access_request>


Response Messages:
201: Application access request was submitted.
400: The application was already deleted.
400: Server id cannot be empty.
400: Hostname or IP cannot be empty.
400: The provided server does not exist in application.
400: The provided server is not allowed to access.
400: Request already created
400: Requester cannot be null
400: Group cannot be empty
400: Invalid ip
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","dataMode":"raw","folder":"2-1","rawModeData":"\n\t1\n\t1.1.1.1\n\tRequest to join the WebServers server group\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests","collectionId":"2","id":"2-1-2","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Update application access requests","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"dataMode":"raw","description":"Use this API to approve or reject application access requests

Parameters:
applicationId: The unique identifier of the application
body: application access requests

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests
BODY<application_access_requests>
    <application_access_request>
        <id>1</id>
        <action>APPROVE</action>
    </application_access_request>
    <application_access_request>
        <id>2</id>
        <action>REJECT</action>
    </application_access_request>
</application_access_requests>


Response Messages:
200: Application access requests were updated.
400: The application was already deleted.
400: Invalid ID for access request
400: Cannot update access request with id ID
400: Action cannot be empty in request with id ID
400: Invalid action in request with id ID
400: The Server group is lock for discovery
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","folder":"2-1","rawModeData":"\n\t\n\t\t1\n\t\tAPPROVE\n\t\n\t\n\t\t2\n\t\tREJECT\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests","collectionId":"2","id":"2-1-3","method":"PUT"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Update an application access request","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"requestId"}],"dataMode":"raw","description":"Use this API to approve or reject application access requests

Parameters:
applicationId: The unique identifier of the application
requestId: The unique identifier of the application access request
body: application access request

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests/1
BODY<application_access_request>
    <action>APPROVE</action>
</application_access_request>


Response Messages:
200: Application access request was updated.
400: The application was already deleted.
400: Invalid ID for access request
400: Cannot update access request with id ID
400: Action cannot be empty in request with id ID
400: Invalid action in request with id ID
400: The Server group is lock for discovery
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","folder":"2-1","rawModeData":"\n\tAPPROVE\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests/{{requestId}}","collectionId":"2","id":"2-1-4","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve an existing application access request by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"requestId"}],"description":"Parameters:
applicationId: The unique identifier of the application
requestId: The unique identifier of the application access request

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests/1

Response Messages:
400: The application was already deleted.
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Access request with id ID was not found in application with id ID","dataMode":"params","folder":"2-1","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests/{{requestId}}","collectionId":"2","id":"2-1-5","method":"GET"},{"headers":"Accept: application/json\n","name":"Retrieve existing connections, with extended resources information","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the connection [optional]
start: Return results starting only from the specified index; 0-based index; default value = 0 [optional]
count: Return the specified number of results. Returns all results if no value specified [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended?name=Connection Name

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended?name=Connection Name&start=50&count=100

Response Messages:
400: Start value cannot be a negative number.
400: Count value must be greater than 0.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: Access is denied.
404: There is no application with the specified ID.
404: There are no connections with the name NAME.","dataMode":"params","folder":"2-2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_extended","collectionId":"2","id":"2-2-6","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Create a ticket to repair a connection","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"},{"value":null,"type":"text","enabled":true,"key":"connection_id"}],"description":"Parameters:
application_id: The application ID
connection_id: The connection ID
body: Ticket

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/2/repair
BODY<ticket>
    <subject>Repair connection 2</subject>
    <requester>u1</requester>
    <priority>Normal</priority>
    <workflow>
        <name>Workflow with topology</name>
    </workflow>
    <steps>
        <step>
            <name>Open request</name>
            <tasks>
                <task>
                    <fields>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_area\">
                            <name>Business Justification</name>
                            <text>I need access to ftp </text>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_field\">
                            <name>Project Number</name>
                            <text>CR124560</text>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"hyperlink\">
                            <name>Hyperlink</name>
                            <url>http://192.168.1.1/ticket</url>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"drop_down_list\">
                            <name>Change Window</name>
                            <selection>Monday</selection>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"manager\">
                            <name>manager email</name>
                            <text>manager@tufin.com</text>
                        </field>
                    </fields>
                </task>
            </tasks>
        </step>
    </steps>
    <comments/>
</ticket>


Response Messages:
201: Ticket was created.
400: The requester must be the currently logged in user.
400: Workflow was not found.
400: Workflow is not active.
400: Workflow configuration is not valid.
400: Workflow is not set.
400: You cannot enter a status for a new ticket.
400: Requester cannot open a ticket in domain.
400: Invalid ticket priority.
400: Expiration field is required.
400: Submit ticket enabled only with the first step.
400: First step can be only with one task.
400: The specified workflow does not contain an access request field in the first step.
400: You cannot use an access request field to create a ticket from SecureApp.
400: The ticket fields do not match the fields in the current step of the workflow.
400: You cannot change the value of a field because it is read-only.
403: Logged in user: NAME do not have permission to perform on behalf actions.
403: You are not a participant in the first step of this workflow.
403: Access is denied.
403: To create a ticket you must purchase a valid SecureChange license.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: Cannot create a ticket to repair this connection because the connection status is not disconnected.
403: Cannot create a ticket to repair this connection because the connection was edited but a ticket has not been created yet.
403: Cannot create a ticket to repair this connection because there are other open tickets for an application that includes this connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID.","dataMode":"raw","folder":"2-2","rawModeData":"\n\tRepair connection 2\n\tu1\n\tNormal\n\t\n\t\tWorkflow with topology\n\t\n\t\n\t\t\n\t\t\tOpen request\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tBusiness Justification\n\t\t\t\t\t\t\tI need access to ftp \n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tProject Number\n\t\t\t\t\t\t\tCR124560\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tHyperlink\n\t\t\t\t\t\t\thttp://192.168.1.1/ticket\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tChange Window\n\t\t\t\t\t\t\tMonday\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tmanager email\n\t\t\t\t\t\t\tmanager@tufin.com\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connections/{{connection_id}}/repair","collectionId":"2","id":"2-2-7","method":"POST"},{"headers":"Accept: application/json\n","name":"Retrieve an existing connection by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"connectionId"}],"description":"Parameters:
applicationId: The unique identifier of the application
connectionId: The unique identifier of the connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/1

Response Messages:
401: No available licenses. Ask your SecureApp administrator for assistance.
403: Access is denied
403: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID.","dataMode":"params","folder":"2-2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}","collectionId":"2","id":"2-2-8","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Update a connection","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"connectionId"}],"description":"Parameters:
applicationId: The unique identifier of the application
connectionId: The unique identifier of the connection
body: Connection

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections/1
BODY <connection>
     <name>Connection A</name>
     <comment>Connection A comment</comment>
     <sources>
         <source>
             <id>2</id>
         </source>
         <source>
             <id>3</id>
         </source>
     </sources>
     <services>
         <service>
             <id>1</id>
         </service>
     </services>
     <destinations>
         <destination>
             <id>1</id>
         </destination>
     </destinations>
</connection>


Response Messages:
200: Connection was modified.
400: Reference to service ID is invalid.
400: Reference to source/destination with ID is invalid.
400: Connection name cannot be empty.
400: Connection name already exists.
400: Connection NAME contains duplicate destinations.
400: Destination cannot contain users.
400: Resource cannot contain other objects along with Any.
400: Connection NAME contains duplicate sources.
400: You cannot add external resources to interface connections.
400: You cannot have Any in both the source and destination.
400: You cannot add external resources to interface connections.
400: Source cannot contain both users and servers.
400: Connection NAME contains duplicate services.
400: Cannot contain other services along with ANY.
400: Connections can only include objects within the same customer.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permission to access application that contains the server ID
403: You do not have permissions to edit this application.
403: Access is denied
403: You cannot edit or delete an external connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID.","dataMode":"raw","folder":"2-2","rawModeData":" \n\t Connection A\n\t Connection A comment\n\t \n\t\t \n\t\t\t 2\n\t\t \n\t\t \n\t\t\t 3\n\t\t \n\t \n\t \n\t\t \n\t\t\t 1\n\t\t \n\t \n\t \n\t\t \n\t\t\t 1\n\t\t \n\t \n ","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}","collectionId":"2","id":"2-2-9","method":"PUT"},{"name":"Delete connection","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"connectionId"}],"description":"Parameters:
applicationId: The unique identifier of the application
connectionId: The unique identifier of the connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/1

Response Messages:
200: Connection was deleted.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: Access is denied
403: You cannot edit or delete an external connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID.","dataMode":"params","folder":"2-2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}","collectionId":"2","id":"2-2-10","method":"DELETE"},{"headers":"Content-Type: application/xml\n","name":"Update connections","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: List of connections

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections
BODY<connections>
     <connection>
         <id>1</id>
         <name>Connection A</name>
         <comment>Connection A comment</comment>
         <sources>
             <source>
                 <id>2</id>
             </source>
             <source>
                 <id>3</id>
             </source>
         </sources>
         <services>
             <service>
                 <id>1</id>
             </service>
         </services>
         <destinations>
             <destination>
                 <id>1</id>
             </destination>
         </destinations>
     </connection>
     <connection>
         <id>2</id>
         <name>Connection B</name>
     </connection>
     <connection>
         <id>3</id>
         <name>Connection C</name>
         <sources>
             <source>
                 <id>2</id>
             </source>
         </sources>
     </connection>
</connections>


Response Messages:
200: Connections were modified.
400: Reference to service ID is invalid.
400: Reference to source/destination with ID is invalid.
400: Connection name cannot be empty.
400: Connection name already exists.
400: Connection NAME contains duplicate destinations.
400: Destination cannot contain users.
400: Resource cannot contain other objects along with Any.
400: Connection NAME contains duplicate sources.
400: You cannot add external resources to interface connections.
400: You cannot have Any in both the source and destination.
400: You cannot add external resources to interface connections.
400: Source cannot contain both users and servers.
400: Connection NAME contains duplicate services.
400: Cannot contain other services along with ANY.
400: Connections can only include objects within the same customer.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permission to access application that contains the server ID
403: You do not have permissions to edit this application.
403: Access is denied
403: You cannot edit or delete an external connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID.","dataMode":"raw","folder":"2-2","rawModeData":"\n\t \n\t\t 1\n\t\t Connection A\n\t\t Connection A comment\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t\t \n\t\t\t\t 3\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t \n\t \n\t\t 2\n\t\t Connection B\n\t \n\t \n\t\t 3\n\t\t Connection C\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t \n\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections","collectionId":"2","id":"2-2-11","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve existing connections","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the connection [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections?name=Connection Name

Response Messages:
401: No available licenses. Ask your SecureApp administrator for assistance.
403: Access is denied
403: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: There are no connections with the name NAME.","dataMode":"params","folder":"2-2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections","collectionId":"2","id":"2-2-12","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create connections","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: The list of the connections

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections
BODY<connections>
     <connection>
         <name>Connection A</name>
         <comment>Connection A comment</comment>
         <sources>
             <source>
                 <id>2</id>
             </source>
             <source>
                 <id>3</id>
             </source>
         </sources>
         <services>
             <service>
                 <id>1</id>
             </service>
         </services>
         <destinations>
             <destination>
                 <id>1</id>
             </destination>
         </destinations>
     </connection>
     <connection>
         <name>Connection B</name>
     </connection>
     <connection>
         <name>Connection C</name>
         <sources>
             <source>
                 <id>2</id>
             </source>
         </sources>
     </connection>
</connections>


Response Messages:
200: Connections were created.
201: Connection was created.
400: There are no items to add.
400: You cannot add to application NAME because it was decommissioned.
400: Connection name already exists.
400: Reference to service ID is invalid.
400: Reference to source/destination with ID is invalid.
400: Connection NAME contains duplicate destinations.
400: Destination cannot contain users.
400: Resource cannot contain other objects along with Any.
400: Connection NAME contains duplicate sources.
400: You cannot add external resources to interface connections.
400: You cannot have Any in both the source and destination.
400: You cannot add external resources to interface connections.
400: Source cannot contain both users and servers.
400: Connection NAME contains duplicate services.
400: Cannot contain other services along with ANY.
400: Connections can only include objects within the same customer.
403: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: Access is denied
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","dataMode":"raw","folder":"2-2","rawModeData":"\n\t \n\t\t Connection A\n\t\t Connection A comment\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t\t \n\t\t\t\t 3\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t \n\t \n\t\t Connection B\n\t \n\t \n\t\t Connection C\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t \n\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections","collectionId":"2","id":"2-2-13","method":"POST"},{"headers":"Accept: application/json\n","name":"Fetches application identities","description":"Fetches the list of pre-defined application identities (like facebook) that can be used in a connection.

Parameters:
name: The name of the service [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/application_identities

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/application_identities?name=facebook

Response Messages:
404: There are no application identities with the name NAME.
403: Access is denied.","folder":"2-3","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/application_identities","collectionId":"2","id":"2-3-14","method":"GET"},{"headers":"Accept: application/json\n","name":"Retrieve existing interface connections","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
name: The name of the interface connection [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections?name=Connection 1

Response Messages:
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There are no connection interfaces with the name NAME.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections","collectionId":"2","id":"2-4-15","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create interface connections","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
body: The interface connections

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections
BODY<interface_connections>
    <interface_connection>
        <name>Connection 1</name>
        <sources>
            <source>
                <id>3</id>
            </source>
        </sources>
        <services>
            <service>
                <id>3</id>
            </service>
            <service>
                <id>Facebook</id>
            </service>
        </services>
        <comment>New connection</comment>
    </interface_connection>
</interface_connections>


Response Messages:
200: Interface connections were created.
201: Interface connection was created.
400: There are no items to add.
400: Cannot create interface connection without a name.
400: Connection name already exists.
400: You cannot add user to connection interface.
400: You cannot add Any to connection interface.
400: You cannot add Internet to connection interface.
400: Cannot have external servers.
400: Cannot have both sources and destinations.
400: Connection NAME contains duplicate sources.
400: Connection NAME contains duplicate services.
400: Connection NAME contains duplicate destinations.
400: Reference to source/destination with ID is invalid.
400: Reference to service ID is invalid.
403: Access is denied.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.","dataMode":"raw","folder":"2-4","rawModeData":"\n\t\n\t\tConnection 1\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\t\n\t\t\t\tFacebook\n\t\t\t\n\t\t\n\t\tNew connection\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections","collectionId":"2","id":"2-4-16","method":"POST"},{"headers":"Accept: application/json\n","name":"Retrieve an existing interface connection by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"},{"value":null,"type":"text","enabled":true,"key":"connectionInterfaceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
connectionInterfaceId: The unique identifier of the interface connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections/1

Response Messages:
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}","collectionId":"2","id":"2-4-17","method":"GET"},{"name":"Delete interface connection","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"},{"value":null,"type":"text","enabled":true,"key":"connectionInterfaceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
connectionInterfaceId: The unique identifier of the interface connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections/1

Response Messages:
200: Interface connection was deleted.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}","collectionId":"2","id":"2-4-18","method":"DELETE"},{"headers":"Content-Type: application/xml\n","name":"Update an interface connection","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"},{"value":null,"type":"text","enabled":true,"key":"connectionInterfaceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
connectionInterfaceId: The unique identifier of the interface connection
body: The interface connection

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections/1
BODY<interface_connection>
    <name>Updated name</name>
    <sources>
        <source>
            <id>19</id>
        </source>
    </sources>
    <services>
        <service>
            <id>9</id>
        </service>
    </services>
    <comment>Updated connection</comment>
</interface_connection>


Response Messages:
200: Interface connection was modified.
400: Interface connection name cannot be empty.
400: Connection name already exists.
400: You cannot add user to connection interface.
400: You cannot add Any to connection interface.
400: You cannot add Internet to connection interface.
400: Cannot have external servers.
400: Cannot have both sources and destinations.
400: Connection NAME contains duplicate sources.
400: Connection NAME contains duplicate services.
400: Connection NAME contains duplicate destinations.
400: Reference to source/destination with ID is invalid.
400: Reference to service ID is invalid.
403: Access is denied.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID.","dataMode":"raw","folder":"2-4","rawModeData":"\n\tUpdated name\n\t\n\t\t\n\t\t\t19\n\t\t\n\t\n\t\n\t\t\n\t\t\t9\n\t\t\n\t\n\tUpdated connection\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}","collectionId":"2","id":"2-4-19","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve an existing application interface by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1

Response Messages:
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}","collectionId":"2","id":"2-4-20","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Update an application interface","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"}],"dataMode":"raw","description":"Update the application interface properties. If is_published is set to true, the application interface is published for use by other users.

Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of The application interface
body: The application interface

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1
BODY<application_interface>
    <name>updated name</name>
    <comment>Updated application interface</comment>
    <is_published>true</is_published>
</application_interface>


Response Messages:
200: Application interface was modified.
400: Application interface is not complete for publish.
400: Name cannot be empty.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.","folder":"2-4","rawModeData":"\n\tupdated name\n\tUpdated application interface\n\ttrue\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}","collectionId":"2","id":"2-4-21","method":"PUT"},{"name":"Delete application interface","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1

Response Messages:
200: Application interface was deleted.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}","collectionId":"2","id":"2-4-22","method":"DELETE"},{"name":"Delete connection to application","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"connectionToApplicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
connectionToApplicationId: The unique identifier of the connection to application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications/1

Response Messages:
200: Connection to application was deleted.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection to application with ID was not found for application interface with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications/{{connectionToApplicationId}}","collectionId":"2","id":"2-4-23","method":"DELETE"},{"headers":"Content-Type: application/xml\n","name":"Update a connection to application","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"connectionToApplicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
connectionToApplicationId: The unique identifier of the connection to application
body: The connection to application

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications/1
BODY<connection_to_application>
    <name>Updated name</name>
    <comment>Updated connection to application</comment>
    <servers>
        <server>
            <id>4</id>
        </server>
    </servers>
</connection_to_application>


Response Messages:
200: Connection to application was modified.
400: Name cannot be empty.
400: Name already exists.
400: Reference to source/destination with ID is invalid.
400: You cannot add ANY to connection to application.
400: You cannot add user to connection to application.
400: You cannot add Internet to connection to application.
403: Access is denied
403: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection to application with ID was not found for application interface with ID.","dataMode":"raw","folder":"2-4","rawModeData":"\n\tUpdated name\n\tUpdated connection to application\n\t\n\t\t\n\t\t\t4\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications/{{connectionToApplicationId}}","collectionId":"2","id":"2-4-24","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve an existing connection to application by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"connectionToApplicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
connectionToApplicationId: The unique identifier of the connection to application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications/1

Response Messages:
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Connection to application with ID was not found for application interface with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications/{{connectionToApplicationId}}","collectionId":"2","id":"2-4-25","method":"GET"},{"headers":"Accept: application/json\n","name":"Retrieve existing connections to application","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the connection to application [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications?name=Connection to Application 1

Response Messages:
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications","collectionId":"2","id":"2-4-26","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create connection to application","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"dataMode":"raw","description":"Create a connection from this application to an application interface.

Parameters:
applicationId: The unique identifier of the application
body: The connection to application

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications
BODY<connection_to_application>
    <name>Connection to Application 1</name>
    <comment>New connection to application</comment>
    <application_interface_id>1</application_interface_id>
    <servers>
        <server>
            <id>3</id>
        </server>
    </servers>
</connection_to_application>


Response Messages:
201: Connection to application was created.
400: You cannot add to application NAME because it was decommissioned.
400: The selected interface cannot be used more than once in the application.
400: Name cannot be empty.
400: Cannot create from local interface.
400: ApplicationInterface didn't got published.
400: Name already exists.
400: Cannot create connection to application without servers, there should be at least one server.
400: Reference to source/destination with ID is invalid.
400: You can use only interface from the same customer.
400: You cannot add ANY to connection to application.
400: You cannot add user to connection to application.
400: You cannot add Internet to connection to application.
403: Access is denied
403: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found.","folder":"2-4","rawModeData":"\n\tConnection to Application 1\n\tNew connection to application\n\t1\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications","collectionId":"2","id":"2-4-27","method":"POST"},{"headers":"Content-Type: application/xml\n","name":"Create application interface","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: The application interface

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces
BODY<application_interface>
    <name>Interface to Application 1</name>
    <comment>New application interface</comment>
</application_interface>


Response Messages:
201: Application interface was created.
400: You cannot add to application NAME because it was decommissioned.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.","dataMode":"raw","folder":"2-4","rawModeData":"\n\tInterface to Application 1\n\tNew application interface\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces","collectionId":"2","id":"2-4-28","method":"POST"},{"headers":"Accept: application/json\n","name":"Retrieve existing application interfaces","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"dataMode":"params","description":"To improve response time, set 'calculateIsPublished = false' to avoid calculating 'is_published'.

Parameters:
applicationId: The unique identifier of the application
name: The name of the application interface [optional]
calculateIsPublished: Should calculate is_published value [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces?name=Interface to Application 1

Response Messages:
400: There is no application with the specified ID.
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There are no application interfaces with the name NAME.","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces","collectionId":"2","id":"2-4-29","method":"GET"},{"name":"Copy application servers and connections to another application.","data":[{"value":null,"type":"text","enabled":true,"key":"sourceApplicationId"},{"value":null,"type":"text","enabled":true,"key":"targetApplicationId"}],"dataMode":"params","description":"This API can be used to:
1. Create applications based on a blueprint (template).
2. Copy applications between environments (dev, test, prod).
3. Migrate applications between data-centers.

Before migrating make sure to map servers and connections to applications (if any exist).\nThis migration uses the configuration specified in the other API calls.

Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2

Response Messages:
200: Application was migrated.
400: Cannot migrate a decommissioned application.
400: Cannot migrate to a decommissioned application.
400: Cannot migrate an application to itself.
400: Cannot edit target DEVICE application.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
400: The source application has no connections to migrate.
409: You cannot migrate the application because not all servers are mapped.
409: You cannot migrate the application because not all connections to application are mapped.
409: You cannot migrate the application because one of the interfaces in the original application has been changed and has not been published.","folder":"2-5","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}","collectionId":"2","id":"2-5-30","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve server mappings for source and target applications","data":[{"value":null,"type":"text","enabled":true,"key":"sourceApplicationId"},{"value":null,"type":"text","enabled":true,"key":"targetApplicationId"}],"description":"Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application
search_servers_type: Search server type [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/servers_mapping

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/servers_mapping?search_servers_type=EXTERNAL

Response Messages:
400: Search migrated servers type parameter must be either internal, external or both.
400: Cannot get mappings between application to itself.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permission to access application with ID
403: You do not have permissions to edit this application.
404: There is no application with the specified ID.","dataMode":"params","folder":"2-5","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/servers_mapping","collectionId":"2","id":"2-5-31","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Update server mappings for source and target applications","data":[{"value":null,"type":"text","enabled":true,"key":"sourceApplicationId"},{"value":null,"type":"text","enabled":true,"key":"targetApplicationId"}],"dataMode":"raw","description":"Use id=-1 for target_network_object if new mapping is “Not Needed”.
If the source is specified and the target is empty, the mapping that is currently configured will be deleted.

Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application
body: The server mapping list [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/servers_mapping
BODY<servers_mapping>
    <server_mapping>
        <source_network_object>
            <id>3</id>
        </source_network_object>
        <target_network_object>
            <id>4</id>
        </target_network_object>
    </server_mapping>
    <server_mapping>
        <source_network_object>
            <id>5</id>
        </source_network_object>
        <target_network_object>
            <id>-1</id>
        </target_network_object>
    </server_mapping>
    <server_mapping>
        <source_network_object>
            <id>6</id>
        </source_network_object>
    </server_mapping>
</servers_mapping>


Response Messages:
200: Server mappings were modified.
400: Source network object cannot be empty.
400: Source network object is not valid
400: Target network object is not valid
400: Source and target network objects must be internal or external both.
400: Cannot use DEVICE application resources as external network objects.
400: Source network object with ID must be used by any connection.
400: Cannot remove mapping of network object with ID because it has never been mapped.
400: Cannot migrate application to itself.
400: Cannot map to ANY network object.
400: Cannot map Internet network object.
400: Cannot map to Internet network object.
400: Target network object ID must be in the same customer as the target application.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Server with ID was not found.","folder":"2-5","rawModeData":"\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n\t\n\t\t\n\t\t\t5\n\t\t\n\t\t\n\t\t\t-1\n\t\t\n\t\n\t\n\t\t\n\t\t\t6\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/servers_mapping","collectionId":"2","id":"2-5-32","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Update connection to application mappings for source and target applications","data":[{"value":null,"type":"text","enabled":true,"key":"sourceApplicationId"},{"value":null,"type":"text","enabled":true,"key":"targetApplicationId"}],"dataMode":"raw","description":"Use id=-1 for target_application_interface if new mapping is “Not Needed”.
If the source is specified and the target is empty, the mapping that is currently configured will be deleted.

Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application
body: The interface instance mapping list [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/connections_to_applications_mapping
BODY<connections_to_applications_mapping>
    <connection_to_application_mapping>
        <source_connection_to_application>
            <id>1</id>
        </source_connection_to_application>
        <target_application_interface>
            <id>4</id>
        </target_application_interface>
    </connection_to_application_mapping>
    <connection_to_application_mapping>
        <source_connection_to_application>
            <id>2</id>
        </source_connection_to_application>
        <target_application_interface>
            <id>-1</id>
        </target_application_interface>
    </connection_to_application_mapping>
    <connection_to_application_mapping>
        <source_connection_to_application>
            <id>3</id>
        </source_connection_to_application>
    </connection_to_application_mapping>
</connections_to_applications_mapping>


Response Messages:
200: Connection to application mappings were modified.
400: Source interface instance cannot be empty.
400: Source interface instance object is not valid
400: Target application interface is not valid
400: Connection to application with ID: ID was not found.
400: Interface with ID: ID was not found.
400: Cannot remove mapping of instance with ID because it has never been mapped.
400: Cannot migrate application to itself.
400: Cannot map instance to interface with ID ID because the interface exists in target application.
400: Cannot map to duplicate application interfaces
400: Application interface didn't got published
400: Connection to application with id: ID must used by source application
400: You cannot map connection to application ID, because it is contained in a connection to application pack.
400: Application interface ID must be in the same customer as the target application.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","folder":"2-5","rawModeData":"\n\t\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n\t\n\t\t\n\t\t\t2\n\t\t\n\t\t\n\t\t\t-1\n\t\t\n\t\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/connections_to_applications_mapping","collectionId":"2","id":"2-5-33","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve connection to application mappings for source and target applications","data":[{"value":null,"type":"text","enabled":true,"key":"sourceApplicationId"},{"value":null,"type":"text","enabled":true,"key":"targetApplicationId"}],"description":"Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/connections_to_applications_mapping

Response Messages:
400: Cannot get mappings between application to itself.
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.","dataMode":"params","folder":"2-5","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/connections_to_applications_mapping","collectionId":"2","id":"2-5-34","method":"GET"},{"headers":"Accept: application/json\n","name":"Retrieve an existing application pack by ID","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to retrieve

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1

Response Messages:
403: Access is denied
403: You do not have permission to access application pack with ID
404: Application pack with ID was not found for customer with ID.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}","collectionId":"2","id":"2-6-35","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Update an application pack","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"}],"dataMode":"raw","description":"Update the application pack properties. If is_published is set to true, the application pack is published for use by other users.

Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
body: Application pack

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1
BODY<application_pack>
    <name>Updated name</name>
    <comment>Updated application pack</comment>
    <owner>
        <id>4</id>
    </owner>
    <editors>
        <editor>
            <id>3</id>
        </editor>
    </editors>
    <viewers>
        <viewer>
            <id>5</id>
        </viewer>
    </viewers>
    <is_published>true</is_published>
</application_pack>


Response Messages:
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to owner ID is invalid.
400: The owner NAME does not have permission to access applications.
400: There is an editor without an ID or name.
400: The application pack owner cannot also be an editor of the application pack.
400: There is a viewer without an ID or name.
400: The application pack owner cannot also be a viewer of the application pack.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application pack.
400: Application pack NAME already exists.
400: Application pack name must contain at least 2 and no more than 160 characters.
400: Customer NAME is not imported to SecureApp.
400: Customer NAME was decommissioned.
400: Application pack with ID is not ready for publish, or has no changes from the last publish.
403: Access is denied
403: You do not have permission to access application that contains the interface ID
403: You do not have permissions to edit this application pack.
403: You do not have permissions to change the owner of application pack ID.
403: You do not have permissions to change the editors and viewers of application pack ID.
404: There are no application packs with the NAME in customer with ID.","folder":"2-6","rawModeData":"\n\tUpdated name\n\tUpdated application pack\n\t\n\t\t4\n\t\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\n\t\n\t\t\n\t\t\t5\n\t\t\n\t\n\ttrue\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}","collectionId":"2","id":"2-6-36","method":"PUT"},{"name":"Delete application pack","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1

Response Messages:
200: Application pack wes deleted.
403: You do not have permissions to delete this application pack.
400: There is no application pack with the specified ID.
400: Customer with ID doesn't own an application pack with ID.
400: Application Pack ID cannot be deleted. It is in use by applications IDs.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}","collectionId":"2","id":"2-6-37","method":"DELETE"},{"name":"Remove application interfaces from application pack","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"},{"value":null,"type":"text","enabled":true,"key":"application_interface_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
application_interface_id: IDs of application interfaces to remove

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/application_interfaces?application_interface_id=1&application_interface_id=2

Response Messages:
200: Application Interface was deleted.
403: Access is denied
403: You do not have permissions to edit this application pack.
404: There are no application packs with the ID in customer with ID.
404: Application Package ID was not found.
404: Application interface ID was not found in application pack ID.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/application_interfaces","collectionId":"2","id":"2-6-38","method":"DELETE"},{"headers":"Content-Type: application/xml\n","name":"Update application interfaces and tag mapping","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"}],"dataMode":"raw","description":"Add application interfaces to application pack, and map a tag to the application interface. If a tag is not specified for the interface, the tag will be set to “No Tag”.

Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
body: List of interface tag mapping to be added or modified

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/application_interfaces
BODY<application_interface_tags>
    <application_interface_tag>
        <application_interface>
            <id>1</id>
        </application_interface>
        <tag>
            <id>3</id>
        </tag>
    </application_interface_tag>
    <application_interface_tag>
        <application_interface>
            <id>2</id>
        </application_interface>
    </application_interface_tag>
</application_interface_tags>


Response Messages:
403: Access is denied
404: There are no application packs with the NAME in customer with ID.
403: You do not have permissions to edit this application pack.
403: You do not have permission to access application that contains the interface ID
400: You cannot edit APPLICATION PACK because it was decommissioned.
400: Application Interface can't be null.
400: Empty interface ID is not valid.","folder":"2-6","rawModeData":"\n\t\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t3\n\t\t\n\t\n\t\n\t\t\n\t\t\t2\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/application_interfaces","collectionId":"2","id":"2-6-39","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Update application packs","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"}],"dataMode":"raw","description":"Update the application packs properties. If is_published is set to true, the application pack is published for use by other users.

Parameters:
customer_id: The unique identifier of customer
body: List of application packs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs
BODY<application_packs>
    <application_pack>
        <id>1</id>
        <name>Updated name</name>
        <comment>Updated application pack</comment>
        <owner>
            <id>4</id>
        </owner>
        <editors>
            <editor>
                <id>3</id>
            </editor>
        </editors>
        <is_published>false</is_published>
    </application_pack>
</application_packs>


Response Messages:
400: There are no application packs to edit.
400: Application pack ID cannot be empty.
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to owner ID is invalid.
400: The owner NAME does not have permission to access applications.
400: There is an editor without an ID or name.
400: The application pack owner cannot also be an editor of the application pack.
400: There is a viewer without an ID or name.
400: The application pack owner cannot also be a viewer of the application pack.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application pack.
400: Application pack NAME already exists.
400: Application pack name must contain at least 2 and no more than 160 characters.
400: Customer NAME is not imported to SecureApp.
400: Customer NAME was decommissioned.
400: Application pack with ID is not ready for publish, or has no changes from the last publish.
403: Access is denied
403: You do not have permission to access application that contains the interface ID
403: You do not have permissions to edit this application pack.
403: You do not have permissions to change the owner of application pack ID.
403: You do not have permissions to change the editors and viewers of application pack ID.
404: There are no application packs with the NAME in customer with ID.","folder":"2-6","rawModeData":"\n\t\n\t\t1\n\t\tUpdated name\n\t\tUpdated application pack\n\t\t\n\t\t\t4\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\n\t\tfalse\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/","collectionId":"2","id":"2-6-40","method":"PUT"},{"headers":"Accept: application/json\n","name":"List all application packs","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
name: The name of the application pack [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs?name=Application pack 1

Response Messages:
403: Access is denied
404: There are no application packs with the NAME in customer with ID.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/","collectionId":"2","id":"2-6-41","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create new application packs","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
body: List of application packs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs
BODY<application_packs>
    <application_pack>
        <name>Application pack 1</name>
        <comment>New application pack</comment>
        <owner>
            <id>4</id>
        </owner>
        <editors>
            <editor>
                <id>3</id>
            </editor>
        </editors>
        <viewers>
            <viewer>
                <id>5</id>
            </viewer>
        </viewers>
    </application_pack>
</application_packs>


Response Messages:
403: Access is denied
403: You do not have permission to access application that contains the interface ID
400: There are no application packs to add.
400: Application pack can be created only in meshed domain mode.
404: Customer with ID was not found.
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to owner ID is invalid.
400: There is an editor without an ID or name.
400: The application pack owner cannot also be an editor of the application pack.
400: There is a viewer without an ID or name.
400: The application pack owner cannot also be a viewer of the application pack.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application pack.
400: The owner NAME does not have permission to access applications.
400: Application pack was already saved.
400: Application pack NAME already exists.
400: Application pack name must contain at least 2 and no more than 160 characters.
400: Customer NAME is not imported to SecureApp.
400: Customer NAME was decommissioned.","dataMode":"raw","folder":"2-6","rawModeData":"\n\t\n\t\tApplication pack 1\n\t\tNew application pack\n\t\t\n\t\t\t4\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t5\n\t\t\t\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/","collectionId":"2","id":"2-6-42","method":"POST"},{"headers":"Content-Type: application/xml\n","name":"Modify tags of an application pack","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
body: Tags to modify

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags
BODY<tags>
    <tag>
        <id>1</id>
        <name>Tag 1</name>
    </tag>
    <tag>
        <id>2</id>    
        <name>Tag 2</name>
    </tag>
</tags>


Response Messages:
403: Access is denied
403: You do not have permissions to edit this application pack.
404: Customer with ID was not found.
404: There is no application pack with the ID in customer with ID.
400: Tag with NAME already exists in application pack ID.
400: Updated tag ID can't be empty
400: Updated Tag ID doesn't exist on application pack ID.","dataMode":"raw","folder":"2-6","rawModeData":"\n\t\n\t\t1\n\t\tTag 1\n\t\n\t\n\t\t2\t\n\t\tTag 2\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","collectionId":"2","id":"2-6-43","method":"PUT"},{"name":"Delete tags from application pack","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"},{"value":null,"type":"text","enabled":true,"key":"tag_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
tag_id: IDs of tags to remove

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/21/tags?tag_id=1&tag_id=2

Response Messages:
200: Tags were deleted.
403: Access is denied
403: You do not have permissions to edit this application pack.
404: There are no application packs with the ID in customer with ID.
404: Application Package ID was not found.
404: Tag ID was not found in application pack ID.
404: Tag ID is in use so can't be deleted.
404: Removed tag ID can't be empty.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","collectionId":"2","id":"2-6-44","method":"DELETE"},{"headers":"Accept: application/json\n","name":"List all application pack tags","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags

Response Messages:
403: Access is denied
404: There is no application pack with the ID.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","collectionId":"2","id":"2-6-45","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create new Tag under an application pack ","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack
body: List of tags

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags
BODY<tags>
    <tag>
        <name>Tag 1</name>
    </tag>
    <tag>
        <name>Tag 2</name>
    </tag>
</tags>


Response Messages:
403: Access is denied
404: There is no application pack with the ID in customer with ID.
400: You cannot edit APPLICATION PACK because it was decommissioned.
400: Tag name must contain at least 2 and no more than 160 characters.
400: Tag with NAME already exists in application pack ID.","dataMode":"raw","folder":"2-6","rawModeData":"\n\t\n\t\tTag 1\n\t\n\t\n\t\tTag 2\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","collectionId":"2","id":"2-6-46","method":"POST"},{"headers":"Content-Type: application/xml\n","name":"Create new connection to application packs","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"}],"description":"Parameters:
application_id: The unique identifier of application
body: List of connection to application packs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs
BODY<connection_to_application_packs>
    <connection_to_application_pack>
        <name>Connection to application pack 1</name>
        <comment>New Connection to application pack</comment>
        <application_pack>
            <id>1</id>
        </application_pack>
        <tags_servers>
            <tag_servers>
                <tag>
                    <id>1</id>
                </tag>
                <servers>
                    <server>
                        <id>3</id>
                    </server>
                </servers>
            </tag_servers>
            <tag_servers>
                <tag>
                    <name>Tag 1</name>
                </tag>
                <servers>
                    <server>
                        <id>4</id>
                    </server>
                </servers>
            </tag_servers>
        </tags_servers>
    </connection_to_application_pack>
</connection_to_application_packs>


Response Messages:
400: There are no connection to application packs to add.
400: Application pack ID cannot be empty.
400: Application with ID was not found.
400: There is no application with the specified ID.
400: There is no application pack with the specified ID.
400: Application pack with ID was decommissioned.
400: Application pack with ID was not published.
400: Connection to application pack cannot be created in the domain of the application pack.
400: The application pack cannot be used more than once in the application.
400: Name cannot be empty.
400: Name must contain at least 2 and no more than 160 characters.
400: Name already exists.
400: Tag cannot be empty.
400: Tag ID or name is missing.
400: Tag ID does not exist.
400: Server ID does not exist.
400: Tag ID is not in use in connection to application pack ID, so it cannot be updated.
400: Servers cannot be null.
400: You cannot add ANY to connection to application pack.
400: You cannot add user to connection to application pack.
400: You cannot add Internet to connection to application pack.
403: Access is denied.
403: You do not have permission to access application that contains the server ID
403: You do not have permission to access application pack with ID
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Tag with NAME was not found.","dataMode":"raw","folder":"2-6","rawModeData":"\n\t\n\t\tConnection to application pack 1\n\t\tNew Connection to application pack\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t1\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t3\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\tTag 1\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t4\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/","collectionId":"2","id":"2-6-47","method":"POST"},{"headers":"Accept: application/json\n","name":"Retrieve a list of all connection to application pack by application ID.","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"}],"description":"Parameters:
application_id: The unique identifier of application
name: The name of the connection to application pack [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs?name=Connection to application pack 1

Response Messages:
403: Access is denied
403: You do not have permission to access application with ID
404: There are no connection to application pack with the NAME in application with ID.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/","collectionId":"2","id":"2-6-48","method":"GET"},{"headers":"Accept: application/json\n","name":"Get tag by ID","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"},{"value":null,"type":"text","enabled":true,"key":"tag_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack
tag_id: The unique identifier of a tag

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags/1

Response Messages:
403: Access is denied
404: There is no tag with ID.
404: Customer with ID doesn't own a tag with ID.
404: Application Pack with ID doesn't own a tag with ID.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags/{{tag_id}}","collectionId":"2","id":"2-6-49","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Update an application pack","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"},{"value":null,"type":"text","enabled":true,"key":"connection_to_application_pack_id"}],"description":"Parameters:
application_id: The unique identifier of application
connection_to_application_pack_id: The unique identifier of the connection to application pack to update
body: Connection to application pack

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs/1
BODY<connection_to_application_pack>
    <name>Updated name</name>
    <comment>Updated Connection to application pack</comment>
    <tags_servers>
        <tag_servers>
            <tag>
                <id>1</id>
            </tag>
            <servers>
                <server>
                    <id>3</id>
                </server>
            </servers>
        </tag_servers>
        <tag_servers>
            <tag>
                <name>Tag 1</name>
            </tag>
            <servers>
            </servers>
        </tag_servers>
    </tags_servers>
</connection_to_application_pack>


Response Messages:
400: There is no application with the specified ID.
400: There is no connection to application pack with the specified ID.
400: Application with ID doesn't own a connection to application pack with ID.
400: Name cannot be empty.
400: Name must contain at least 2 and no more than 160 characters.
400: Name already exists.
400: Tag cannot be empty.
400: Tag ID or name is required.
400: Tag with Name was not found.
400: Server ID cannot be empty.
400: Servers cannot be null.
400: You cannot add ANY to connection to application pack.
400: You cannot add user to connection to application pack.
400: You cannot add Internet to connection to application pack.
403: Access is denied.
403: You do not have permission to access application that contains the server ID
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.","dataMode":"raw","folder":"2-6","rawModeData":"\n\tUpdated name\n\tUpdated Connection to application pack\n\t\n\t\t\n\t\t\t\n\t\t\t\t1\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t3\n\t\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\tTag 1\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/{{connection_to_application_pack_id}}","collectionId":"2","id":"2-6-50","method":"PUT"},{"name":"Delete a connection to application pack","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"},{"value":null,"type":"text","enabled":true,"key":"connection_to_application_pack_id"}],"description":"Parameters:
application_id: The unique identifier of application
connection_to_application_pack_id: The unique identifier of the connection to application pack to delete

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs/1

Response Messages:
400: Connection to application pack with ID was not found for application with ID.
400: The connection to application pack was already deleted.
403: Access is denied.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/{{connection_to_application_pack_id}}","collectionId":"2","id":"2-6-51","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Retrieve an existing connection to application pack by ID.","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"},{"value":null,"type":"text","enabled":true,"key":"connection_to_application_pack_id"}],"description":"Parameters:
application_id: The unique identifier of application
connection_to_application_pack_id: The unique identifier of the connection to application pack

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs/1

Response Messages:
403: Access is denied
403: You do not have permission to access application with ID
404: There is no connection to application pack with the specified ID.
400: Application with ID doesn't own a connection to application pack with ID.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/{{connection_to_application_pack_id}}","collectionId":"2","id":"2-6-52","method":"GET"},{"headers":"Accept: application/json\n","name":"Retrieve existing access rules","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/87/access_requests

Response Messages:
400: The application was already deleted.
400: There are no changed connections that are ready for creating a ticket.
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
400: Application with ID ID was not found.","dataMode":"params","folder":"2-7","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/access_requests","collectionId":"2","id":"2-7-53","method":"GET"},{"headers":"Accept: application/json\n","name":"Fetches server by ID","data":[{"value":null,"type":"text","enabled":true,"key":"serverId"}],"description":"Parameters:
serverId: The ID of the server

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects/87

Response Messages:
400: Server with id ID was not found.
400: Application with ID ID was not found.
400: The application was already deleted.
403: Access is denied
403: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.","dataMode":"params","folder":"2-8","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/network_objects/{{serverId}}","collectionId":"2","id":"2-8-54","method":"GET"},{"headers":"Accept: application/json\n","name":"Fetches servers","description":"Parameters:
name: The name of the servers [optional]
typeOnDevice: The typeOnDevice of the servers [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects?name=server1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects?typeOnDevice=edl_ip_list

Response Messages:
400: Server with name NAME was not found.
400: Parameter typeOnDevice is not valid.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There are no servers with the name NAME
404: There are no servers with the typeOnDevice TYPEONDEVICE ","folder":"2-8","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/network_objects","collectionId":"2","id":"2-8-55","method":"GET"},{"name":"Delete server","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"serverId"}],"dataMode":"params","description":"To decommission a serer use force=true.

Parameters:
applicationId: The unique identifier of the application
serverId: The unique identifier of the server
force: Force delete [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/4

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/4?force=true

Response Messages:
400: The application was already deleted.
400: You cannot delete a predefined object.
400: Cannot delete an object that is being referenced by other objects
400: Cannot delete a predefined object.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID.","folder":"2-9","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}","collectionId":"2","id":"2-9-56","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Retrieve an existing server by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"serverId"}],"description":"Parameters:
applicationId: The unique identifier of the application
serverId: The unique identifier of the server

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/3

Response Messages:
400: The application was already deleted.
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID.","dataMode":"params","folder":"2-9","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}","collectionId":"2","id":"2-9-57","method":"GET"},{"headers":"Accept: application/json\n","name":"If the identified server is a group, return a list of its members. When the media type is 'text/plain' (default), print each member on a separate line.","description":"Parameters:
applicationId [optional]
serverId [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/6/members

Response Messages:
400: Server with ID is not of type group
403: Access is denied
403: You do not have permissions to view this application
403: No available licenses. Ask your SecureApp administrator for assistance
404: There is no application with the specified ID
404: Server with ID was not found","folder":"2-9","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}/members","collectionId":"2","id":"2-9-58","method":"GET"},{"collectionId":"2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}/impact_analysis_csv","name":"Export Server Impact Analysis to a CSV file.","method":"GET","id":"2-9-59","description":"Parameters:
applicationId [optional]
serverId [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/6/impact_analysis_csv

Response Messages:
400: Server with ID was not found.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
404: There is no application with the specified ID.","folder":"2-9"},{"name":"Move server","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"},{"value":null,"type":"text","enabled":true,"key":"server_id"},{"value":null,"type":"text","enabled":true,"key":"target_application_id"}],"description":"Parameters:
application_id: The unique identifier of the application
server_id: The unique identifier of the server
target_application_id: The unique identifier of the target application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/move_server?server_id=5&target_application_id=3

Response Messages:
400: Server ID is missing.
400: Target application ID is missing.
400: You cannot move a predefined object.
400: Server with ID is already associated to application with ID.
400: Cannot move server to a different customer.
400: The application was already deleted.
400: You cannot add to application APPLICATION_NAME because it was decommissioned.
400: Group/Server cannot be moved because there is no other application to move it to.
400: Group/Server cannot be moved because it or at least one of its group members is part of these groups: GROUPS_NAME.
400: Group/Server cannot be moved because it or at least one of its group members is locked for discovery.
400: Group/Server cannot be moved because it or at least one of its group members is used in these application interfaces: APPLICATION_INTERFACE_NAME.
400: Group/Server cannot be moved because it or at least one of its group members is used in these connections with another external resource: CONNECTION_NAME
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","dataMode":"params","folder":"2-9","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/move_server","collectionId":"2","id":"2-9-60","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Update servers","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: List of servers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects
BODY<network_objects xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
     <network_object xsi:type=\"hostNetworkObjectDTO\">
         <id>1</id>
         <comment>host comment</comment>
         <name>host1</name>
         <ip>1.1.1.1</ip>
         <type>host</type>
     </network_object>
     <network_object xsi:type=\"rangeNetworkObjectDTO\">
         <id>2</id>
         <comment>range comment</comment>
         <name>range1</name>
         <first_ip>2.2.2.2</first_ip>
         <last_ip>2.2.2.22</last_ip>
         <type>range</type>
     </network_object>
     <network_object xsi:type=\"subnetNetworkObjectDTO\">
         <id>3</id>
         <comment>subnet comment</comment>
         <name>subnet1</name>
         <ip>3.3.3.3</ip>
         <netmask>255.255.255.0</netmask>
         <type>subnet</type>
     </network_object>
     <network_object xsi:type=\"networkObjectVirtualServerDTO\">
         <id>4</id>
         <comment>virtual server comment</comment>
         <uid>{e1a7722f-e92e-48f2-9087-9cb1711eb8b9}</uid>
         <device_id>12</device_id>
         <type>virtual-server</type>
     </network_object>
     <network_object xsi:type=\"vmInstanceDTO\">
         <id>5</id>
         <name>vm1</name>
         <comment>vm instance comment</comment>
         <type>vm_instance</type>
     </network_object>
     <network_object xsi:type=\"networkObjectGroupDTO\">
         <id>6</id>
         <comment>group comment</comment>
         <name>group1</name>
         <access_allowed>true</access_allowed>
         <type>group</type>
         <member>
             <id>3</id>
         </member>
        <type_on_device>edl_ip_list</type_on_device>     </network_object>
</network_objects>


Response Messages:
400: The application was already deleted.
400: You cannot update a predefined object.
400: Invalid type in server with id ID.
400: Invalid member with id ID
400: Invalid ID
400: Invalid uid
400: Invalid network object type NAME
400: Cannot update user
400: Network object is new
400: Name cannot be empty
400: Server is in discovery
400: Ip is missing
400: Mask is missing
400: Invalid ip
400: Invalid mask
400: Max ip is missing
400: Min ip is missing
400: Invalid min ip
400: Invalid max ip
400: Min ip cannot be larger than max ip
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Internet cannot be a member of a group.
400: Server with NAME already exists.
400: Invalid device ID
400: The type_on_device value is not valid
400: An EDL group can not be modified to a regular group
400: The virtual server already exists in SecureApp as resource NAME: VIRTUAL SERVER NAME VIRTUAL SERVER DEVICE NAME.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: DTO type used for server id ID is incompatible with this vendor.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Virtual server was not found in ST.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID.
503: Not connected to SecureTrack.","dataMode":"raw","folder":"2-9","rawModeData":"\n\t \n\t\t 1\n\t\t host comment\n\t\t host1\n\t\t 1.1.1.1\n\t\t host\n\t \n\t \n\t\t 2\n\t\t range comment\n\t\t range1\n\t\t 2.2.2.2\n\t\t 2.2.2.22\n\t\t range\n\t \n\t \n\t\t 3\n\t\t subnet comment\n\t\t subnet1\n\t\t 3.3.3.3\n\t\t 255.255.255.0\n\t\t subnet\n\t \n\t \n\t\t 4\n\t\t virtual server comment\n\t\t {e1a7722f-e92e-48f2-9087-9cb1711eb8b9}\n\t\t 12\n\t\t virtual-server\n\t \n\t \n\t\t 5\n\t\t vm1\n\t\t vm instance comment\n\t\t vm_instance\n\t \n\t \n\t\t 6\n\t\t group comment\n\t\t group1\n\t\t true\n\t\t group\n\t\t \n\t\t\t 3\n\t\t \n\t\tedl_ip_list\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects","collectionId":"2","id":"2-9-61","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve existing servers","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the server [optional]
typeOnDevice: The typeOnDevice of the servers [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects?name=ServerName

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects?typeOnDevice=edl_ip_list

Response Messages:
400: The application was already deleted.
400: Parameter typeOnDevice is not valid.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: There are no servers with the name NAME.
404: There are no servers with the typeOnDevice TYPEONDEVICE ","dataMode":"params","folder":"2-9","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects","collectionId":"2","id":"2-9-62","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Create servers","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: List of servers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects
BODY<network_objects xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
     <network_object xsi:type=\"hostNetworkObjectDTO\">
         <comment>host comment</comment>
         <name>host1</name>
         <ip>1.1.1.1</ip>
     </network_object>
     <network_object xsi:type=\"rangeNetworkObjectDTO\">
         <comment>range comment</comment>
         <name>range1</name>
         <first_ip>2.2.2.2</first_ip>
         <last_ip>2.2.2.22</last_ip>
     </network_object>
     <network_object xsi:type=\"subnetNetworkObjectDTO\">
         <comment>subnet comment</comment>
         <name>subnet1</name>
         <ip>3.3.3.3</ip>
         <netmask>255.255.255.0</netmask>
     </network_object>
     <network_object xsi:type=\"networkObjectVirtualServerDTO\">
         <comment>virtual server comment</comment>
         <uid>{e1a7722f-e92e-48f2-9087-9cb1711eb8b9}</uid>
         <device_id>12</device_id>
     </network_object>
     <network_object xsi:type=\"networkObjectGroupDTO\">
         <comment>group comment</comment>
         <name>group1</name>
         <access_allowed>true</access_allowed>
         <member>
             <id>3</id>
         </member>
        <type_on_device>edl_ip_list</type_on_device>     </network_object>
</network_objects>


Response Messages:
400: There are no items to add.
400: The application was already deleted.
400: You cannot add to application NAME because it was decommissioned.
400: Network object was already saved
400: Name cannot be empty
400: Server with NAME already exists.
400: IP is missing
400: Mask is missing
400: Invalid IP
400: Invalid mask
400: Max IP is missing
400: Min IP is missing
400: Invalid min IP
400: Invalid max IP
400: Min IP cannot be larger than max IP
400: Invalid network object type CLASS_NAME.
400: Invalid uid
400: Invalid device ID
400: Virtual server does not exist in SecureTrack
400: The virtual server already exists in SecureApp as resource NAME: VIRTUAL SERVER NAME VIRTUAL SERVER DEVICE NAME.
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Internet cannot be a member of a group.
400: Cannot save the server because the virtual server does not exist.
400: Cannot save the server because an error occurred
400: The type_on_device value is not valid
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID.
404: Virtual server was not found in SecureTrack.
503: Not connected to SecureTrack.","dataMode":"raw","folder":"2-9","rawModeData":"\n\t \n\t\t host comment\n\t\t host1\n\t\t 1.1.1.1\n\t \n\t \n\t\t range comment\n\t\t range1\n\t\t 2.2.2.2\n \t\t 2.2.2.22\n\t \n\t \n\t\t subnet comment\n\t\t subnet1\n\t\t 3.3.3.3\n\t\t 255.255.255.0\n\t \n\t \n\t\t virtual server comment\n\t\t {e1a7722f-e92e-48f2-9087-9cb1711eb8b9}\n\t\t 12\n\t \n\t \n\t\t group comment\n\t\t group1\n\t\t true\n\t\t \n\t\t\t 3\n\t\t \n\t\tedl_ip_list\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects","collectionId":"2","id":"2-9-63","method":"POST"},{"headers":"Content-Type: application/xml\n","name":"Modify unused and non predefined global services","dataMode":"raw","description":"Parameters:
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>250</id>
        <name>icmp service updated</name>
        <comment>Updated comment</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>251</id>
        <name>ip service updated</name>
        <comment>Updated comment</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>252</id>
        <name>tcp service updated</name>
        <comment>Updated comment</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>253</id>
        <name>udp service updated</name>
        <comment>Updated comment</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <id>254</id>
        <name>Service Group 1 updated</name>
        <comment>Updated comment</comment>
        <type>group</type>
        <member>
            <id>3</id>
        </member>
        <member>
            <id>4</id>
        </member>
    </service>
</services>


Response Messages:
200: Services were modified.
400: Members IDs cannot be empty.
404: Service with ID <ID> was not found.
400: Service type must be either SingleServiceDTO or ServiceMemberDTO.
400: Service is new.
400: You cannot update a predefined object.
400: Name <NAME> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: Invalid protocol
400: Global Service cannot be associated with an application.
400: Cannot update a global service that is being referenced by other objects.
400: Cannot update an empty global group.
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Cannot have a local member in global group.
400: Group cannot contain itself as a member.
400: Application identity cannot be a member of a group.
403: Access is denied.","folder":"2-10","rawModeData":"\n\t\n\t\t250\n\t\ticmp service updated\n\t\tUpdated comment\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\t251\n\t\tip service updated\n\t\tUpdated comment\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\t252\n\t\ttcp service updated\n\t\tUpdated comment\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t253\n\t\tudp service updated\n\t\tUpdated comment\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t254\n\t\tService Group 1 updated\n\t\tUpdated comment\n\t\tgroup\n\t\t\n\t\t\t3\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services/","collectionId":"2","id":"2-10-64","method":"PUT"},{"headers":"Accept: application/json\n","name":"Fetches services","description":"Parameters:
globals_only: get only globals [optional]
name: The name of the service [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?name=AH

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?globals_only=true

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?globals_only=true&name=AH

Response Messages:
404: There are no services with the name NAME.
403: Access is denied.","folder":"2-10","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services","collectionId":"2","id":"2-10-65","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create global services","dataMode":"raw","description":"Parameters:
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>icmp service</name>
        <comment>New service</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>ip service</name>
        <comment>IPSEC Authentication Header Protocol</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>tcp service</name>
        <comment>Discard Server Protocol (TCP)</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>udp service</name>
        <comment>Discard Server Protocol (UDP)</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <name>Service Group 1</name>
        <comment>New Service group</comment>
        <type>group</type>
        <member>
            <id>1</id>
        </member>
        <member>
            <id>2</id>
        </member>
    </service>
</services>


Response Messages:
201: Service was created.
200: Services were created.
400: There are no items to add.
400: Members IDs cannot be empty.
404: Service with ID <ID> was not found.
400: Invalid service type <TYPE>
400: Name <NAME> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: Global Service cannot be associated with an application.
400: Cannot create an empty global group.
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Cannot have a local member in global group.
400: Application identity cannot be a member of a group.
403: Access is denied.","folder":"2-10","rawModeData":"\n\t\n\t\ticmp service\n\t\tNew service\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\tip service\n\t\tIPSEC Authentication Header Protocol\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\ttcp service\n\t\tDiscard Server Protocol (TCP)\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tudp service\n\t\tDiscard Server Protocol (UDP)\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tService Group 1\n\t\tNew Service group\n\t\tgroup\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t2\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services","collectionId":"2","id":"2-10-66","method":"POST"},{"name":"Delete unused and non predefined global service by name","data":[{"value":null,"type":"text","enabled":true,"key":"name"}],"description":"Parameters:
name: The name of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?name=Global service

Response Messages:
200: Service was deleted.
404: Service name has not been provided.
404: There are no services with the name NAME.
400: Cannot delete ANY.
400: Cannot delete an object that is being referenced by other objects.
400: Cannot delete a predefined object.
403: Access is denied.","dataMode":"params","folder":"2-10","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services","collectionId":"2","id":"2-10-67","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Fetches service by ID","data":[{"value":null,"type":"text","enabled":true,"key":"serviceId"}],"description":"Parameters:
serviceId: The ID of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services/2

Response Messages:
404: Service with ID <ID> was not found.
403: Access is denied.","dataMode":"params","folder":"2-10","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services/{{serviceId}}","collectionId":"2","id":"2-10-68","method":"GET"},{"name":"Delete unused and non predefined global service","data":[{"value":null,"type":"text","enabled":true,"key":"serviceId"}],"description":"Parameters:
serviceId: The ID of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services/260

Response Messages:
200: Service was deleted.
404: Global Service with ID was not found.
400: Cannot delete an object that is being referenced by other objects.
400: You cannot delete a predefined object.
403: Access is denied.","dataMode":"params","folder":"2-10","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services/{{serviceId}}","collectionId":"2","id":"2-10-69","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Retrieve an existing service by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"serviceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
serviceId: The unique identifier of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services/250

Response Messages:
400: The application was already deleted.
403: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: Service with ID was not found.","dataMode":"params","folder":"2-11","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services/{{serviceId}}","collectionId":"2","id":"2-11-70","method":"GET"},{"name":"Delete service","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"serviceId"}],"dataMode":"params","description":"Use force=true to delete a service with decommission.

Parameters:
applicationId: The unique identifier of the application
serviceId: The unique identifier of the service
force: Force delete [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services/250

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services/250?force=true

Response Messages:
400: The application was already deleted.
400: Cannot delete an object that is being referenced by other objects.
400: Cannot delete a predefined object.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Service with ID <SERVICE_ID> was not found in application with id <APPLICATION_ID>","folder":"2-11","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services/{{serviceId}}","collectionId":"2","id":"2-11-71","method":"DELETE"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Create services","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>icmp service</name>
        <comment>New service</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>ip service</name>
        <comment>IPSEC Authentication Header Protocol</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>tcp service</name>
        <comment>Discard Server Protocol (TCP)</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>udp service</name>
        <comment>Discard Server Protocol (UDP)</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <name>Service Group 1</name>
        <comment>New Service group</comment>
        <type>group</type>
        <member>
            <id>1</id>
        </member>
        <member>
            <id>2</id>
        </member>
    </service>
</services>


Response Messages:
201: Service was created.
200: Services were created.
400: There are no items to add.
400: Members IDs cannot be empty.
400: Invalid service type <TYPE>
400: Name <NAME> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: Cannot create an empty global group.
400: The group contains duplicate members.
400: ANY cannot be a member of a group.
400: Cannot have members from different applications.
400: Can not have application identity in group
403: Access is denied
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Service with ID <ID> was not found.
404: There is no application with the specified ID.","dataMode":"raw","folder":"2-11","rawModeData":"\n\t\n\t\ticmp service\n\t\tNew service\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\tip service\n\t\tIPSEC Authentication Header Protocol\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\ttcp service\n\t\tDiscard Server Protocol (TCP)\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tudp service\n\t\tDiscard Server Protocol (UDP)\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tService Group 1\n\t\tNew Service group\n\t\tgroup\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t2\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services","collectionId":"2","id":"2-11-72","method":"POST"},{"headers":"Accept: application/json\n","name":"Retrieve existing services","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the service [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services?name=Local service

Response Messages:
400: The application was already deleted.
403: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: There are no services with the name NAME.","dataMode":"params","folder":"2-11","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services","collectionId":"2","id":"2-11-73","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Update services","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>250</id>
        <name>icmp service updated</name>
        <comment>Updated comment</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>251</id>
        <name>ip service updated</name>
        <comment>Updated comment</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>252</id>
        <name>tcp service updated</name>
        <comment>Updated comment</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>253</id>
        <name>udp service updated</name>
        <comment>Updated comment</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <id>254</id>
        <name>Service Group 1 updated</name>
        <comment>Updated comment</comment>
        <type>group</type>
        <member>
            <id>3</id>
        </member>
        <member>
            <id>4</id>
        </member>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <id>255</id>
        <name>Service Group 2 updated</name>
        <comment>Updated comment</comment>
        <type>group</type>
    </service>
</services>


Response Messages:
200: Services were modified.
400: Members IDs cannot be empty.
400: Service type must be either SingleServiceDTO or ServiceMemberDTO.
400: Local service must be associated with an application.
400: Service is locked for discovery.
400: Service is new.
400: Name <NAME> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: The group contains duplicate members.
400: ANY cannot be a member of a group.
400: Application identity cannot be a member of a group.
403: Access is denied
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Service with ID <ID> was not found.","dataMode":"raw","folder":"2-11","rawModeData":"\n\t\n\t\t250\n\t\ticmp service updated\n\t\tUpdated comment\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\t251\n\t\tip service updated\n\t\tUpdated comment\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\t252\n\t\ttcp service updated\n\t\tUpdated comment\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t253\n\t\tudp service updated\n\t\tUpdated comment\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t254\n\t\tService Group 1 updated\n\t\tUpdated comment\n\t\tgroup\n\t\t\n\t\t\t3\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n\t\n\t\t255\n\t\tService Group 2 updated\n\t\tUpdated comment\n\t\tgroup\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services","collectionId":"2","id":"2-11-74","method":"PUT"},{"headers":"Accept: application/json\n","name":"Fetches users","description":"Parameters:
name: The name of the user [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users?name=Local user 1

Response Messages:
404: There are no users with the name NAME.
403: Access is denied.","folder":"2-12","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users","collectionId":"2","id":"2-12-75","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create users","dataMode":"raw","description":"Parameters:
body: List of users

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/users
BODY<users>
    <user>
        <name>Local user 1</name>
        <comment>New local user</comment>
        <ip>8.8.8.8</ip>
    </user>
    <user>
        <name>Ldap user 1</name>
        <comment>New ldap user</comment>
    </user>
    <user xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"userObjectGroupDTO\">
        <name>User group 1</name>
        <comment>New user group</comment>
        <member>
            <id>14</id>
        </member>
        <member>
            <id>15</id>
        </member>
    </user>
</users>


Response Messages:
201: User was created.
200: Users were created.
400: There are no items to add.
400: Members IDs cannot be empty.
404: User with id <ID> was not found.
400: Invalid user type <TYPE>
400: Name cannot be empty.
400: User with name <NAME> already exists.
400: Invalid ip
403: Access is denied.","folder":"2-12","rawModeData":"\n\t\n\t\tLocal user 1\n\t\tNew local user\n\t\t8.8.8.8\n\t\n\t\n\t\tLdap user 1\n\t\tNew ldap user\n\t\n\t\n\t\tUser group 1\n\t\tNew user group\n\t\t\n\t\t\t14\n\t\t\n\t\t\n\t\t\t15\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users","collectionId":"2","id":"2-12-76","method":"POST"},{"name":"Delete unused user","data":[{"value":null,"type":"text","enabled":true,"key":"userId"}],"description":"Parameters:
userId: The ID of the user

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users/10

Response Messages:
200: User was deleted.
404: User with ID <ID> was not found.
400: Cannot delete an object that is being referenced by other objects.
403: Access is denied.","dataMode":"params","folder":"2-12","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users/{{userId}}","collectionId":"2","id":"2-12-77","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Fetches user by ID","data":[{"value":null,"type":"text","enabled":true,"key":"userId"}],"description":"Parameters:
userId: The ID of the user

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users/10

Response Messages:
404: User with ID <ID> was not found.
403: Access is denied.","dataMode":"params","folder":"2-12","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users/{{userId}}","collectionId":"2","id":"2-12-78","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Move applications to another customer","dataMode":"raw","description":"Parameters:
body: List of applications and customers [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/move_applications
BODY<move_applications>
     <move_application>
         <application>
            <id>1</id>
         </application>
         <customer>
             <id>2</id>
         </customer>
     </move_application>
     <move_application>
         <application>
            <id>2</id>
         </application>
         <customer>
            <name>Default</name>
         </customer>
     </move_application>
</move_applications>


Response Messages:
200: Applications were moved successfully.
400: Multi-Customer mode is not enabled.
400: You cannot move an application pack to a different customer.
400: Reference to application is invalid.
400: APPLICATION already exists in CUSTOMER.
400: You must specify the name or ID of the customer.
400: The customer has no ID or name.
400: Reference to CUSTOMER is invalid.
400: CUSTOMER is not imported to SecureApp.
400: CUSTOMER was decommissioned.
400: You must delete virtual servers from CUSTOMER before you move APPLICATION to another customer.
400: You must remove virtual servers from the INTERFACE and publish it before you move APPLICATION to another customer.
400: You cannot move APPLICATION to CUSTOMER because the connection to application pack and the application pack cannot be in the same customer.
400: You cannot move APPLICATION to a different customer because the application interface and the application pack must be in the same customer.
400: You must remove INTERFACE from APPLICATION PACK and publish it before you can move APPLICATION to another customer.
400: CONNECTION TO APPLICATION from APPLICATION must use interface from CUSTOMER.
400: Sources in CONNECTION from APPLICATION must all be from applications in the same customer.
400: Destinations in CONNECTION in APPLICATION must all be from applications in the same customer.
400: Servers in CONNECTION from APPLICATION must all be from CUSTOMER.
400: Servers in CONNECTION TO APPLICATION from APPLICATION must be from applications in the same customer.
400: Servers in CONNECTION TO APPLICATION from APPLICATION must be from CUSTOMER.
400: Application or application pack with NAME already exists in CUSTOMER.
400: There are no applications to move.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","folder":"2-13","rawModeData":"\n\t \n\t\t \n\t\t\t1\n\t\t \n\t\t \n\t\t\t 2\n\t\t \n\t \n\t \n\t\t \n\t\t\t2\n\t\t \n\t\t \n\t\t\tDefault\n\t\t \n\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/move_applications","collectionId":"2","id":"2-13-79","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve an existing application by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of an application to retrieve

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1

Response Messages:
400: The application was already deleted.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: Access is denied
403: You do not have permission to access application with ID
404: There is no application with the specified ID.","dataMode":"params","folder":"2-13","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}","collectionId":"2","id":"2-13-80","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Change an application","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"dataMode":"raw","description":"This API can be used to delete or decommission an application.
To decommission an application, send true in decommissioned tag.

Parameters:
applicationId: The unique identifier of an application to change
body: Application

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/139
BODY<application>
     <id>139</id>
     <name>UpdatedAppName</name>
     <comment>UpdatedComment</comment>
     <decommissioned>false</decommissioned>
     <owner>
         <id>4</id>
     </owner>
     <editors>
         <editor>
             <id>3</id>
         </editor>
     </editors>
     <viewers>
         <viewer>
             <id>5</id>
         </viewer>
     </viewers>
</application>


Response Messages:
400: The application was already deleted.
400: Application owner is missing.
400: Owner cannot be empty.
400: Reference to owner ID is invalid.
400: There is an editor without an ID or name.
400: The application owner cannot also be an editor of the application.
400: There is a viewer without an ID or name.
400: The application owner cannot also be a viewer of the application.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application.
403: Access is denied
403: You do not have permissions to change the owner of application ID.
403: You do not have permissions to change the editors and a viewer of application ID.
403: You do not have permissions to decommission this application.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","folder":"2-13","rawModeData":"\n\t 139\n\t UpdatedAppName\n\t UpdatedComment\n\t false\n\t \n\t\t 4\n\t \n\t \n\t\t \n\t\t\t 3\n\t\t \n\t \n\t \n\t\t \n\t\t\t 5\n\t\t \n\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}","collectionId":"2","id":"2-13-81","method":"PUT"},{"name":"Delete an application","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application to delete

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1

Response Messages:
400: The application was already deleted.
400: The resources of application NAME are used in connections for other applications.
400: You cannot delete application NAME because its application interfaces are used in other applications.
400: You cannot delete application NAME because its application interfaces are used in other application packs.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
400: Application with ID ID was not found.
400: You cannot delete application NAME because there are connection changes pending a ticket in other application.","dataMode":"params","folder":"2-13","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}","collectionId":"2","id":"2-13-82","method":"DELETE"},{"name":"Export application history to PDF","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"}],"description":"Parameters:
application_id: The unique identifier of the application
start_date: States starting date to fetch history since. Date format expected: yyyy-mm-dd [optional]
end_date: Get history until this date. Date format expected: yyyy-mm-dd [optional]
count: History max rows [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?start_date=2015-07-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?start_date=2015-07-18&end_date=2015-12-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?start_date=2015-07-18&count=2

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?count=2

Response Messages:
403: Access is denied.
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
400: The date format must be: yyyy-mm-dd
400: Start date must be before End date","dataMode":"params","folder":"2-13","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/history/export_pdf","collectionId":"2","id":"2-13-83","method":"GET"},{"headers":"Accept: application/json\n","name":"Retrieve security policy violations from SecureTrack","description":"Parameters:
applicationId [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/compliance_violations

Response Messages:
400: No valid connections found in APPLICATION.
400: Security policy compliance check is not available because a security policy has not been defined.
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
503: Cannot connect to SecureTrack.
503: Timeout occurred while waiting for response from SecureTrack.
500: An error occurred in SecureTrack when running the security compliance check.","folder":"2-13","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/compliance_violations","collectionId":"2","id":"2-13-84","method":"GET"},{"headers":"Accept: application/json\n","name":"Retrieve application history","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
start_date: States starting date to fetch history since. Date format expected: yyyy-mm-dd [optional]
end_date: Get history until this date. Date format expected: yyyy-mm-dd [optional]
count: History list length [optional]
start: Offset the count starting point [optional]
type: States the history type to fetch [optional]
user: The username of the user made the changes [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start_date=2015-07-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start_date=2015-07-18&end_date=2015-12-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start_date=2015-07-18&count=1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start=0&count=1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?type=SERVER

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?user=Jack

Response Messages:
400: The date format must be: yyyy-mm-dd
400: Start date must be before End date
400: Count parameter must be a number
400: Start parameter must be a number
400: Start parameter must be less than total
400: Type parameter must be either server, server_group, connection, application, application_interface, connection_interface or connection_to_application
400: User not found
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.","dataMode":"params","folder":"2-13","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/history","collectionId":"2","id":"2-13-85","method":"GET"},{"name":"Export Impact Analysis to a CSV file.","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"}],"dataMode":"params","description":"To prevent a CSV injection attack when exporting Impact Analysis to a CSV file, if a special character ( = - + @ ) appears at the beginning of any field, a single quote (') is added before the character.

Parameters:
application_id: The unique identifier of the application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/impact_analysis_csv

Response Messages:
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
404: There is no application with the specified ID.","folder":"2-13","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/impact_analysis_csv","collectionId":"2","id":"2-13-86","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Create new applications","dataMode":"raw","description":"Parameters:
body: List all applications

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications
BODY<applications>
     <application>
         <name>AppName</name>
         <comment>Comment</comment>
         <owner>
             <id>3</id>
         </owner>
         <editors>
             <editor>
                 <id>4</id>
             </editor>
         </editors>
         <viewers>
             <viewer>
                 <id>5</id>
             </viewer>
         </viewers>
         <customer>
             <id>24</id>
         </customer>
     </application>
</applications>


Response Messages:
400: There are no items to add.
400: Application was already saved.
400: Application name must contain at least 2 and no more than 160 characters.
400: Owner cannot be empty.
400: The specified owner does not exist.
400: The owner NAME does not have permission to access applications.
400: There is an editor without an ID or name.
400: The application owner cannot also be an editor of the application.
400: There is a viewer without an ID or name.
400: The application owner cannot also be a viewer of the application.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application.
400: Application with NAME already exists.
400: Application owner is missing.
400: Reference to owner ID is invalid.
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to customer ID is invalid.
400: You must specify the name or ID of the customer.
400: The customer has no ID or name.
400: The specified customer does not exist.
400: There is an editor without an ID or name.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no editor with the name NAME.","folder":"2-13","rawModeData":"\n\t \n\t\t AppName\n\t\t Comment\n\t\t \n\t\t\t 3\n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 4\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 5\n\t\t\t \n\t\t \n\t\t \n\t\t\t 24\n\t\t \n\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/","collectionId":"2","id":"2-13-87","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Update applications","dataMode":"raw","description":"This API can be used to delete or decommission an application.
To decommission an application, send true in decommissioned tag.

Parameters:
body: List of applications

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications
BODY<applications>
     <application>
         <id>140</id>
         <name>App1</name>
         <decommissioned>true</decommissioned>
         <owner>
             <id>4</id>
         </owner>
     </application>
     <application>
         <id>139</id>
         <name>UpdatedAppName</name>
         <comment>Updated Comment</comment>
         <owner>
             <id>4</id>
         </owner>
         <editors>
             <editor>
                 <id>3</id>
             </editor>
         </editors>
         <viewers>
             <viewer>
                 <id>5</id>
             </viewer>
         </viewers>
     </application>
</applications>


Response Messages:
400: Application ID is missing.
400: Application ID is invalid
400: The application was already deleted.
400: You must include the owner field.
400: There is an editor without an ID or name.
400: The application owner cannot also be an editor of the application.
400: There is a viewer without an ID or name.
400: The application owner cannot also be a viewer of the application.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application.
403: Access is denied
403: You do not have permissions to change the owner of application ID.
403: You do not have permissions to change the editors and a viewer of application ID.
403: You do not have permissions to decommission this application.
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.","folder":"2-13","rawModeData":"\n\t \n\t\t 140\n\t\t App1\n\t\t true\n\t\t \n\t\t\t 4\n\t\t \n\t \n\t \n\t\t 139\n\t\t UpdatedAppName\n\t\t Updated Comment\n\t\t \n\t\t\t 4\n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 3\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 5\n\t\t\t \n\t\t \n\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/","collectionId":"2","id":"2-13-88","method":"PUT"},{"headers":"Accept: application/json\n","name":"List all applications","description":"Parameters:
userId: Applications by user ID, if not given the default is logged in user id [optional]
name: The name of the application [optional]
app_permissions: Filter applications by the given permissions (separated with commas):\napp_owner - returns applications where the user is the owner\napp_editor - returns applications where the user has been explicitly added as an editor\napp_viewer - returns applications where the user has been explicitly added as a viewer\napp_adminonly - returns applications where the user only has editor access because user has “edit all applications” permission, and does not include applications where this user is either the app_owner, app_editor, or app_viewer [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?name=App

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?userId=1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?app_permissions=app_owner,app_editor,app_viewer

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?name=App&app_permissions=app_adminonly

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications

Response Messages:
400: Invalid app_permissions value: 'appPermissions'.
403: Access is denied
403: You can't use the parameter 'userId' because you don't have 'View all applications' permission.
404: There are no applications matching your filter.
404: User with ID 'userId' was not found.","folder":"2-13","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/","collectionId":"2","id":"2-13-89","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Auto associate cloud servers from SecureTrack with an application","dataMode":"raw","description":"When auto-associate is enabled, user must enter key value

Parameters:
body: Auto association rule

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers/auto_association_rule
BODY<auto_association_rule>
    <key>Application</key>
    <enabled>true</enabled>
</auto_association_rule>


Response Messages:
200: Auto association rule is saved.
400: Enabled rule requires key value.
403: Access is denied
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to search for cloud servers.","folder":"2-14","rawModeData":"\n\tApplication\n\ttrue\n\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/cloud_console/servers/auto_association_rule","collectionId":"2","id":"2-14-90","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve cloud server listing from SecureTrack","data":[{"value":null,"type":"text","enabled":true,"key":"vendor"},{"value":null,"type":"text","enabled":true,"key":"search_string"}],"description":"Parameters:
customer_id: Customer ID to be filtered by. [optional]
vendor: Vendor to be filtered by.
search_string: Search text.
start: Returning matching result starting from this element in the array (0-based). [optional]
count: Total number of matching servers to return. [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers?vendor=Amazon&search_string=WebServe

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers?vendor=Amazon&search_string=\"WebServer1\"

Response Messages:
403: Access is denied
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to search for cloud servers.
400: Illegal search string.
400: Start is bigger then possible result count.
400: Start and count cannot hold negative values.
400: Vendor query param is required.
400: Vendor should be one of the following: Amazon.
400: Search string query param is required.
400: Customer with ID does not exist in SecureApp
400: Customer with ID was decommissioned.","dataMode":"params","folder":"2-14","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/cloud_console/servers/","collectionId":"2","id":"2-14-91","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Associate cloud servers from SecureTrack with an application","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"}],"description":"Parameters:
application_id: The ID of the application
body: List of device IDs and cloud server UIDs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers?application_id=87
BODY<devices_to_uids>
    <device_to_uids>
        <device_id>9</device_id>
        <uids>
            <uid>{b503916e-4468-4dc8-981b-2ec534587352}</uid>
            <uid>{0cc947a5-276f-4a4a-9d12-df5284fce609}</uid>
        </uids>
    </device_to_uids>
</devices_to_uids>


Response Messages:
201: Servers were imported to SecureApp.
403: Access is denied
400: There is no application with the specified ID.
401: No available licenses. Ask your SecureApp administrator for assistance.
400: You do not have permissions to edit this application.
400: You cannot associate servers with this application, because the application has been decommissioned.
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to add cloud servers.
403: UID does not exist in device ID.
403: Device with ID does not exist.
403: Device with ID does not exist in DOMAIN.
403: The AWS instance with UID and device ID has already been imported to application NAME. You cannot import the same instance multiple times.","dataMode":"raw","folder":"2-14","rawModeData":"\n\t\n\t\t9\n\t\t\n\t\t\t{b503916e-4468-4dc8-981b-2ec534587352}\n\t\t\t{0cc947a5-276f-4a4a-9d12-df5284fce609}\n\t\t\n\t\n\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/cloud_console/servers/","collectionId":"2","id":"2-14-92","method":"POST"},{"headers":"Content-Type: application/xml\n","name":"import customers","dataMode":"raw","description":"Only users with 'Create new applications' and 'View all applications' permissions can run this API.

Parameters:
body: Customers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/customers/import
BODY<customers>
    <customer>
        <id>2</id>
    </customer>
    <customer>
        <id>3</id>
    </customer>
</customers>


Response Messages:
400: Not available in single-customer mode.
400: ID can not be empty.
400: There are some id's that doesn't exist.
403: Access is denied
503: Not connected to SecureTrack.","folder":"2-15","rawModeData":"\n\t\n\t\t2\n\t\n\t\n\t\t3\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/import","collectionId":"2","id":"2-15-93","method":"PUT"},{"headers":"Accept: application/json\n","name":"List all imported customers","description":"

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/imported

Response Messages:
400: Not available in single-customer mode.
403: Access is denied","folder":"2-15","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/imported","collectionId":"2","id":"2-15-94","method":"GET"},{"headers":"Accept: application/json\n","name":"List all non-imported customers","description":"Only users with 'Create new applications' and 'View all applications' permissions can run this API.



Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/not_imported

Response Messages:
400: Not available in single-customer mode.
403: Access is denied
503: Not connected to SecureTrack.","folder":"2-15","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/not_imported","collectionId":"2","id":"2-15-95","method":"GET"},{"headers":"Accept: application/json\n","name":"List all customers","description":"Parameters:
name: The name of the customer [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers?name=Customer 1

Response Messages:
400: Not available in single-customer mode.
404: There are no customers with the name NAME.","folder":"2-15","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/","collectionId":"2","id":"2-15-96","method":"GET"},{"headers":"Accept: application/json\n","name":"Retrieve existing applications for specific domain","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"}],"description":"Parameters:
customer_id: The ID of the customer

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/2/applications

Response Messages:
400: Not available in single-customer mode.
400: Customer with id ID was not found.
403: Access is denied","dataMode":"params","folder":"2-15","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/{{customer_id}}/applications","collectionId":"2","id":"2-15-97","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Update a customer","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"}],"description":"Parameters:
customer_id: The ID of the customer
body: Customers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/customers/2
BODY<customer>
    <usage_mode>NOT_IMPORTED</usage_mode>
</customer>


Response Messages:
400: Not available in single-customer mode.
400: Customer with id ID was not found.
400: Can not update Default customer.
400: This customer is already not imported.
400: USAGE_MODE is not a valid state. The valid values are: USAGE_MODES
403: Access is denied
500: This customer is not imported.
400: You cannot delete this customer because there are connection changes pending a ticket in another customer.You must decommission this customer first, and then delete it.","dataMode":"raw","folder":"2-15","rawModeData":"\n\tNOT_IMPORTED\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/{{customer_id}}","collectionId":"2","id":"2-15-98","method":"PUT"},{"headers":"Accept: application/json\n","name":"Fetches customer by ID","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"}],"description":"Parameters:
customer_id: The ID of the customer

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/1

Response Messages:
400: Not available in single-customer mode.
400: Customer with id ID was not found.","dataMode":"params","folder":"2-15","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/{{customer_id}}","collectionId":"2","id":"2-15-99","method":"GET"},{"headers":"Accept: application/json\n","name":"Fetches domain by ID","data":[{"value":null,"type":"text","enabled":true,"key":"domainId"}],"description":"Parameters:
domainId: The ID of the domain

Usage Example


Response Messages:
400: Domain with id ID was not found.","dataMode":"params","folder":"2-16","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/domains/{{domainId}}","collectionId":"2","id":"2-16-100","method":"GET"},{"collectionId":"2","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/domains/synchronize","name":"synchronize domains","method":"PUT","id":"2-16-101","description":"Retrieves all the domains lists in ST , for use by SC. If a domain was deleted in ST, then it will be removed from SC



Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/domains/synchronize

Response Messages:
500: Multi-Domain mode is disabled in SecureChange. Unable to synchronize with SecureTrack domains","folder":"2-16"},{"headers":"Accept: application/json\n","name":"List all domains","description":"Parameters:
name: The name of the domain [optional]

Usage Example


Response Messages:
404: There are no domains with the name NAME.","folder":"2-16","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/domains/","collectionId":"2","id":"2-16-102","method":"GET"},{"headers":"Accept: application/json\n","name":"Fetches virtual servers from SecureTrack","data":[{"value":null,"type":"text","enabled":true,"key":"ip"}],"dataMode":"params","description":"Find virtual servers matching a given IP address.
You can search for the virtual server itself of any of its members.

Parameters:
ip: ip
domainId: The unique identifier of a domain [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/external_resources/f5_virtual_servers?ip=2.2.2.2

Response Messages:
400: Invalid IP
400: Invalid Subnet
400: There is no domain with the specified ID.
403: Access is denied
503: Not connected to SecureTrack.","folder":"2-17","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/external_resources/f5_virtual_servers","collectionId":"2","id":"2-17-103","method":"GET"},{"name":"Run Update Metadata for given task","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"params","description":"A link to the rule recertification field will returned in the location field of the header, for example: /securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/fields/72

Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/rule_recertification/update_metadata

Response Messages:
400: Update Metadata is not defined for the requested field.
400: Update Metadata is not available for the current ticket status.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a rule recertification request field.
403: You do not have permission to update this task. Contact your administrator for assistance.","folder":"2-18","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/rule_recertification/update_metadata","collectionId":"2","id":"2-18-104","method":"PUT"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Get suggested targets for a given access request","data":[{"value":null,"type":"text","enabled":true,"key":"domain_name"},{"value":null,"type":"text","enabled":true,"key":"workflow_name"}],"dataMode":"raw","description":"Returns a list of suggested targets for a given access request, based on topology calculations.

Parameters:
body [optional]
domain_name: Domain Name
workflow_name: Workflow Name

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/suggest_target?domain_name=Default&workflow_name=AR
BODY{
    \"access_request\":{
        \"users\":{
            \"user\":[
                \"Any\"
            ]
        },
        \"sources\":{
            \"source\":[
                {
                    \"@type\":\"IP\",
                    \"ip_address\":\"10.100.1.1\",
                    \"netmask\":\"255.255.255.255\",
                    \"cidr\":32
                }
            ]
        },
        \"destinations\":{
            \"destination\":[
                {
                    \"@type\":\"IP\",
                    \"ip_address\":\"10.100.20.2\",
                    \"netmask\":\"255.255.255.255\",
                    \"cidr\":32
                }
            ]
        },
        \"services\":{
            \"service\":[
                {
                    \"@type\":\"ANY\",
                }
            ]
        },
        \"action\":\"Accept\",
    }
}
OUTPUT{
    \"multi_target\": {
        \"target\": {
            \"@type\": \"Object\",
            \"object_name\": \"Device-1\",
            \"object_type\": \"firewall\",
            \"object_details\": \"10.100.40.1\",
            \"management_id\": 250,
            \"management_name\": \"Panorama/Domain1\"
        }
    }
}


Response Messages:
200: Targets returned successfully
400: User does not have permissions to domain or domain does not exist
403: Access is denied","folder":"2-19","rawModeData":"{\n\t\"access_request\":{\n\t\t\"users\":{\n\t\t\t\"user\":[\n\t\t\t\t\"Any\"\n\t\t\t]\n\t\t},\n\t\t\"sources\":{\n\t\t\t\"source\":[\n\t\t\t\t{\n\t\t\t\t\t\"@type\":\"IP\",\n\t\t\t\t\t\"ip_address\":\"10.100.1.1\",\n\t\t\t\t\t\"netmask\":\"255.255.255.255\",\n\t\t\t\t\t\"cidr\":32\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"destinations\":{\n\t\t\t\"destination\":[\n\t\t\t\t{\n\t\t\t\t\t\"@type\":\"IP\",\n\t\t\t\t\t\"ip_address\":\"10.100.20.2\",\n\t\t\t\t\t\"netmask\":\"255.255.255.255\",\n\t\t\t\t\t\"cidr\":32\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"services\":{\n\t\t\t\"service\":[\n\t\t\t\t{\n\t\t\t\t\t\"@type\":\"ANY\",\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"action\":\"Accept\",\n\t}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/suggest_target","collectionId":"2","id":"2-19-105","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Update the whole list of excluded devices in SecureChange","dataMode":"raw","description":"Parameters:
body [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded
BODY<device_ids>
    <id>1</id>
    <id>12</id>
</device_ids>

","folder":"2-19","rawModeData":"\n\t1\n\t12\n\n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/excluded","collectionId":"2","id":"2-19-106","method":"PUT"},{"headers":"Accept: application/json\n","name":"Returns IDs for specified list of excluded parent management devices and child firewalls in SecureChange","description":"For example on this Panorama hierarchy:
DG1 - Excluded
  DG1.1
    FW1
    FW2
    FW3

Calling this API with false value will return only DG1’s id.
Calling this API with true value will return DG1, FW1, FW2, FW3 id’s.


Parameters:
show_all: When set to true - Displays the specified devices and all their child firewalls in the hierarchy, which will be excluded implicitly.
When set to false - Displays only the devices which were explicitly excluded.
Default value is false.
[optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded
OUTPUT<device_ids>
    <id>10</id>
    <id>11</id>
</device_ids>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded?show_all=false
OUTPUT<device_ids>
    <id>10</id>
    <id>11</id>
</device_ids>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded?show_all=true
OUTPUT<device_ids>
    <id>33</id>
    <id>10</id>
    <id>11</id>
    <id>35</id>
    <id>29</id>
    <id>31</id>
</device_ids>

","folder":"2-19","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/excluded","collectionId":"2","id":"2-19-107","method":"GET"},{"headers":"Accept: application/json\n","name":"Returns the details of the devices that you can select as a target in SecureChange","description":"Parameters:
name: device name or part of a name [optional]
show_targets: show devices as targets [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/devices?name=asa&show_targets=true

Response Messages:
404: Devices not found","folder":"2-19","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/","collectionId":"2","id":"2-19-108","method":"GET"},{"headers":"Accept: application/json\n","name":"Get server decommission designer results","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"dataMode":"params","description":"Use this API to retrieve designer results generated in R17-1 and earlier.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Server Decommission Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/multi_server_decommission_request/261/designer

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.","folder":"2-20","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_server_decommission_request/{{fieldId}}/designer","collectionId":"2","id":"2-20-109","method":"GET"},{"headers":"Accept: application/json\n","name":"Get verifier results","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Server Decommission Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/multi_server_decommission_request/261/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.","dataMode":"params","folder":"2-20","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_server_decommission_request/{{fieldId}}/verifier","collectionId":"2","id":"2-20-110","method":"GET"},{"name":"Run Verifier for given task","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/multi_server_decommission_request/verifier

Response Messages:
400: Verifier is not defined for the requested field.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a decommission request field.
403: You do not have permission to update this task. Contact your administrator for assistance.","dataMode":"params","folder":"2-20","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/multi_server_decommission_request/verifier","collectionId":"2","id":"2-20-111","method":"PUT"},{"name":"Run Impact Analysis for given task","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/multi_server_decommission_request/impact_analysis

Response Messages:
400: Impact analysis is not defined for the requested field.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a decommission request field.
403: You do not have permission to update this task. Contact your administrator for assistance.","dataMode":"params","folder":"2-20","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/multi_server_decommission_request/impact_analysis","collectionId":"2","id":"2-20-112","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get impact analysis results","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Server Decommission Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/multi_server_decommission_request/261/impact_analysis

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.","dataMode":"params","folder":"2-20","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_server_decommission_request/{{fieldId}}/impact_analysis","collectionId":"2","id":"2-20-113","method":"GET"},{"name":"Run server decommission designer for given task","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/multi_server_decommission_request/designer

Response Messages:
400: Server decommission designer is not defined for the requested field.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a decommission request field.
403: You do not have permission to update this task. Contact your administrator for assistance.","dataMode":"params","folder":"2-20","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/multi_server_decommission_request/designer","collectionId":"2","id":"2-20-114","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve the SecureTrack connection settings and status","description":"

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/integration_with_secureTrack?testOnly=false
","folder":"2-21","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/integration_with_secureTrack/","collectionId":"2","id":"2-21-115","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Modify the SecureTrack connection settings and test the connection status","dataMode":"raw","description":"Parameters:
testOnly: Test the connection status using the specified settings. The new settings are not saved. The default value is false [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/integration_with_secureTrack
BODY    <secureTrack_settings>
        <host xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"remoteHost\">
            <IP_or_hostname>192.168.11.1</IP_or_hostname>
            <user_name>admin</user_name>
        </host>
        <show_link_to_secureTrack>false</show_link_to_secureTrack>
        <check_connection_interval>30</check_connection_interval>
        <internal_IP_of_secureChange_server>192.168.2.2</internal_IP_of_secureChange_server>
    </secureTrack_settings>


Response Messages:
400: Invalid host name or IP address.
400: show_link_to_secureTrack is invalid. It must be 'true', 'false' or empty.","folder":"2-21","rawModeData":"\t\n\t\t \n\t\t\t192.168.11.1\n\t\t\tadmin\n\t\t\n\t\tfalse\n\t\t30\n\t\t192.168.2.2\n\t","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/integration_with_secureTrack/","collectionId":"2","id":"2-21-116","method":"PUT"},{"collectionId":"2","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/","name":"Return the list of users","method":"GET","id":"2-22-117","description":"user_name: case insensitive, search mode: contains text
exact_name: when set to true, user_name search mode is case sensitive and exact text
email: case insentitive, search mode: exact match
Logical OR between user_name and email.

Parameters:
showIndirectRelation: Members that belong to the selected group only indirectly [optional]
user_name: The user's login name [optional]
email: The user's email [optional]
exact_name: Search user_name as exact match [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/users?email=bob@tufin.com&user_name=bob&exact_name=true
","folder":"2-22"},{"headers":"Content-Type: application/xml\n","name":"Import LDAP users to SecureChange by simulating login process","dataMode":"raw","description":"This API implicitly imports LDAP users to SecureChange by simulating their login.
To explicitly import LDAP entities- both users and groups, it is recommended to use /users/import API

Parameters:
body: partyDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/users
BODY<user xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"user\">
    <name>x</name>
    <origin_type>LDAP</origin_type>
        <ldap_configuration>
            <id>1</id>
        </ldap_configuration>
</user>


Response Messages:
403: Access is denied.
400: Name is missing.
400: Origin is missing.
400: User {login_name} already exists, with ID (id} and name {name}.
400: User {login_name} not found in LDAP.
400: Creating a user via REST API is available only if origin is LDAP.
400: Creating a user via REST API is available only if type is User.
400: Ldap configuration with ID {id} not found.","folder":"2-22","rawModeData":"\n\tx\n\tLDAP\n\t\t\n\t\t\t1\n\t\t\n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/","collectionId":"2","id":"2-22-118","method":"POST"},{"headers":"Content-Type: application/json\n","name":"Import user / group from LDAP","dataMode":"raw","description":"The imported user / group will be visible in SecureChange GUI under users section.
In multi domain mode, imported entity will be assigned with the domains of \"any user\" group.
Only users with 'view settings tab' permission can run this API.

Parameters:
body: ldapPartyDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/users/import
BODY{
    \"ldap_party\": {
        \"ldap_configuration_name\": \"ldap_name\",
        \"ldap_dn\": \"CN=alice,OU=Advertising,OU=Marketing,DC=testEnv,DC=com\"
    }
}


Response Messages:
400: The LDAP configuration name does not exist
400: The given ldap_dn does not exist
400: The given ldap_dn is already imported
400: Failed to create the selected user
400: Failed to create the selected group
400: Selected user already exists in SecureChange but is not synchronized with the LDAP server. Go to Settings > LDAP and synchronize with the LDAP
400: This group has a large number of users, and will not be expanded in the users console. To be able to configure roles and step participation for individual users from the group, add them explicitly.
400: Failed to update the selected group
400: Unsupported LDAP object class
400: Unable to establish a connection to server <SERVER_IP>:<SERVER_PORT> within the configured timeout of <TIMEOUT> milliseconds.
403: Access is denied","folder":"2-22","rawModeData":"{\n\t\"ldap_party\": {\n\t\t\"ldap_configuration_name\": \"ldap_name\",\n\t\t\"ldap_dn\": \"CN=alice,OU=Advertising,OU=Marketing,DC=testEnv,DC=com\"\n\t}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/import","collectionId":"2","id":"2-22-119","method":"POST"},{"headers":"Content-Type: application/json\n","name":"Change local group members","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"raw","description":"Only users with 'view settings tab' permission can run this API.

Parameters:
id: Group ID
body: groupChangeDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/users/group/1
BODY{
    \"group_change\":{
        \"member_ids_to_add\": [1,2],
        \"member_ids_to_remove\":[3,4]
    }
}    


Response Messages:
400: Exceeded limit of {MAXIMUM} group member changes
400: These user IDs do not exist: {IDs}
400: These user IDs do not exist or are not group members: {IDs}
400: Group ID {ID} is not a local group
400: Group ID {ID} does not exist
400: Cannot add a group to itself
400: Cannot add a group to a group that it already contains. Group {ID1} contains group {ID2}","folder":"2-22","rawModeData":"{\n\t\"group_change\":{\n\t\t\"member_ids_to_add\": [1,2],\n\t\t\"member_ids_to_remove\":[3,4]\n\t}\n}\t","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/group/{{id}}","collectionId":"2","id":"2-22-120","method":"PUT"},{"name":"Return the specified user","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
id: User ID
showIndirectRelation: Members that belong to the selected group only indirectly [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/users/5

Response Messages:
400: User or group was not found.","dataMode":"params","folder":"2-22","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/{{id}}","collectionId":"2","id":"2-22-121","method":"GET"},{"name":"Delete the specified User or Group","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
id: User ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/users/5

Response Messages:
400: User with id {id} does not exist","dataMode":"params","folder":"2-22","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/{{id}}","collectionId":"2","id":"2-22-122","method":"DELETE"},{"headers":"Content-Type: application/json\n","name":"Create local group","dataMode":"raw","description":"Only users with 'view settings tab' permission can run this API.

Parameters:
body: CreateGroupDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/users/group
BODY{
    \"group\": {
        \"name\": \"name1\",
        \"description\": \"description1\",
        \"email\": \"email1@tufin.com\"
    }
}    


Response Messages:
400: Input Validation Error : {field name}: {input validation error message}
400: Name already exists","folder":"2-22","rawModeData":"{\n\t\"group\": {\n\t\t\"name\": \"name1\",\n\t\t\"description\": \"description1\",\n\t\t\"email\": \"email1@tufin.com\"\n\t}\n}\t","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/group","collectionId":"2","id":"2-22-123","method":"POST"},{"headers":"Content-Type: application/xml\n","name":"Returns the specified ticket to the specified step","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"toStepId"}],"dataMode":"raw","description":"Values can only be updated for the current step.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
toStepId: To which step we the ticket will return
body: RedoCommentDto

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/redo/1
BODY<redo_step_comment>
    <comment>please fix source </comment>
</redo_step_comment>


Response Messages:
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Task <NAME> is no longer active
403: User has no permissions to redo ticket steps.
404: There is no ticket with ID.
404: No entity found for query","folder":"2-23","rawModeData":"\n\tplease fix source \n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/redo/{{toStepId}}","collectionId":"2","id":"2-23-124","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Change the requester of the specified ticket task to the specified user.","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"assigneeId"}],"description":"Parameters:
id: Ticket ID
assigneeId: The assignee ID
body: CommentDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/change_requester/4
BODY<comment>
    <comment>user was deleted moving tickets to Bob</comment>
</comment>


Response Messages:
400: The change requester comment must be set in order to change the requester the ticket.
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
404: There is no ticket with ID.
404: There is no requester (User) with ID.","dataMode":"raw","folder":"2-23","rawModeData":"\n\tuser was deleted moving tickets to Bob\n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/change_requester/{{assigneeId}}","collectionId":"2","id":"2-23-125","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Confirm the request","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
id: Ticket ID
requester_id: The user of the ticket's requester, when logged in user is confirm on behalf [optional]
body: Confirm comment

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/confirm?requester_id=5
BODY<confirm_comment>
    <comment>confirmed</comment>
</confirm_comment>


Response Messages:
400: User is trying to confirm a ticket that belongs to another user
400: User is not permitted to confirm this ticket on behalf another user
400: The user can not confirm the ticket, because he is not in the domain of the ticket
403: Access is denied.
404: There is no ticket with ID .","dataMode":"raw","folder":"2-23","rawModeData":"\n\tconfirmed\n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/confirm","collectionId":"2","id":"2-23-126","method":"PUT"},{"headers":"Accept: application/json\n","name":"Cancel a ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
id: The ID of the ticket as shown in SecureChange
requester_id: The user of the ticket's requester, when logged in user is canceling on behalf [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/cancel?requester_id=5

Response Messages:
403: Access is denied.
404: Ticket is already closed
404: Ticket ID was not found","dataMode":"params","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/cancel","collectionId":"2","id":"2-23-127","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Reassigns the specified ticket task to the specified user.","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"assigneeId"}],"dataMode":"raw","description":"Values can only be updated for the current step.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
assigneeId: The assignee ID
body: ReassignTaskCommentDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/reassign/4
BODY<reassign_task_comment>
    <comment>Please complete the AR</comment>
</reassign_task_comment>


Response Messages:
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Task <NAME> is no longer active
404: There is no ticket with ID.
404: No entity found for query","folder":"2-23","rawModeData":"\n\tPlease complete the AR\n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/reassign/{{assigneeId}}","collectionId":"2","id":"2-23-128","method":"PUT"},{"name":"Map rules to ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Maps the rules from the ticket to the relevant rules in SecureTrack.
Adds record set entries to the relevant rules metadata.
Link to history is found in the returned location header.
Applicable only for closed tickets in the following workflows: Access Request, Access Request and Modify Group, and Clone Server Policy.
Use handler_id for running on behalf of another user.
To get handler_id, use the System Users API.

Parameters:
id: The ID of the ticket as shown in SecureChange
handler_id: Run API on behalf of defined user id [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/map_rules

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/map_rules?handler_id=5

Response Messages:
201: Started asynchronous mapping of rules to ticket ID <ID>. Mapping status is displayed in ticket history.
400: Ticket's workflow type does not support this operation
403: Access is denied.
403: You do not have permission to access ticket <ID>
403: On behalf user do not have permission to access ticket <ID>
404: There is no ticket with ID <ID>.
404: There is no handler (User) with ID <ID>.
412: Ticket is not in closed status","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/map_rules","collectionId":"2","id":"2-23-129","method":"POST"},{"headers":"Accept: application/json\n","name":"Returns the history of the specified ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
id: Ticket ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/history

Response Messages:
403: User has no permissions to view ticket history
404: You do not have permission to view this task. Contact your administrator for assistance.
404: There is no ticket with ID.","dataMode":"params","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/history","collectionId":"2","id":"2-23-130","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Reject a ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
id: The ID of the ticket as shown in SecureChange
handler_id: The user id, when logged in user is rejecting on behalf [optional]
body: Reject comment

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/reject?handler_id=5
BODY<reject_comment>
    <comment>rejected</comment>
</reject_comment>


Response Messages:
400: Ticket status <STATUS> is incorrect to perform this action
400: User <NAME> has no permissions to perform this action
400: Comment cannot be empty
403: User is not permitted to reject this ticket on behalf another user
403: You do not have permission to access ticket <ID>
403: On behalf user do not have permission to access ticket <ID>
403: Access is denied.
404: There is no ticket with ID <ID>.
404: There is no handler (User) with ID <ID>.","dataMode":"raw","folder":"2-23","rawModeData":"\n\trejected\n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/reject","collectionId":"2","id":"2-23-131","method":"PUT"},{"headers":"Accept: application/json\n","name":"Returns a list of tickets by search parameters","description":"If the query is succesful but no results are found (for example, if there is no ticket for the specified Ticket ID) then the return code will be 200 and the results will be empty.

Parameters:
id: The ID number of the ticket as shown in SecureChange [optional]
subject: The subject of the ticket [optional]
requester: The requester of the ticket [optional]
group: The group handling the ticket [optional]
assigned_to: The user name of the person assigned to the ticket [optional]
priority: The priority of the ticket [optional]
status: The status of the ticket [optional]
sla_status: The SLA status of the ticket [optional]
field_name: Field name to search by [optional]
field_value: Field value to search by [optional]
current_step: Current step name [optional]
expiration_date_from: Search requests with expiration date from this date [optional]
expiration_date_to: Search requests with expiration date until this date [optional]
domain_name: The Domain of the ticket [optional]
start: Offset the count starting point [optional]
count: Ticket list length [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/search?id=1&status=IN_PROGRESS,REJECTED

Response Messages:
403: Access is denied.
400: Illegal ticket status entered. Permitted values are: IN_PROGRESS, REJECTED, CLOSED, CANCELLED, RESOLVED, WAITING_TO_BE_ASSIGNED, ASSIGNED, WAITING_FOR_MORE_INFO, DONE, INVALID, PENDING, PENDING_LICENS
400: Illegal ticket SLA status entered. Permitted values are: NA, OK, WARNING, ALERT, ESCALATION
400: Illegal ticket priority entered. Permitted values are: LOW, NORMAL, HIGH, CRITICAL
400: Illegal ticket expiration date entered. Permitted date format is: ddMMyyyy (ex. 20.11.2001)
400: Cannot find specified domain <DOMAIN_NAME>","folder":"2-24","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/search","collectionId":"2","id":"2-24-132","method":"GET"},{"headers":"Accept: application/json\n","name":"Returns the details of a specified ticket stages","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"}],"dataMode":"params","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2

Response Messages:
403: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.","folder":"2-24","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}","collectionId":"2","id":"2-24-133","method":"GET"},{"headers":"Accept: application/json\n","name":"Returns the details of the tasks","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"}],"dataMode":"params","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks

Response Messages:
403: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.","folder":"2-24","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks","collectionId":"2","id":"2-24-134","method":"GET"},{"headers":"Accept: application/json\n","name":"Get rule decommision verifier results","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/rule_decommission/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type <TYPE>.
404: Verifier results were not found in the request.","dataMode":"params","folder":"2-24","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/rule_decommission/verifier","collectionId":"2","id":"2-24-135","method":"GET"},{"headers":"Accept: application/json\n","name":"Returns the details of a the fields","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"params","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
taskId: The ID number of the task as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields

Response Messages:
403: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.
404: Task with ID was not found in Stage ID in ticket ID .","folder":"2-24","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields","collectionId":"2","id":"2-24-136","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Change multiple fields within a task of a ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"raw","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldListDTO
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/2/tasks/4/fields
BODY<fields>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_network_object\">
         <id>7885</id>
         <name>n_obj</name>
         <network_object type=\"Object\">
             <object_name>Host_10.1.1.1</object_name>
             <management_name>cp239</management_name>
         </network_object>
         <network_object type=\"Object\">
             <st_uid>{55908141-c341-4990-9cc6-a3fd2dfb49e1}</st_uid>
             <management_id>2</management_id>
         </network_object>
         <network_object type=\"DNS\">
             <host_name>tufin.com</host_name>
         </network_object>
     <field>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_service\">
         <id>7887</id>
         <name>service</name>
         <service type=\"PROTOCOL\">
             <protocol>TCP</protocol>
             <port>80</port>
         </service>
         <service type=\"Object\">
             <object_name>AOL</object_name>
             <management_name>cp239</management_name>
         </service>
     </field>
</fields>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/fields
BODY{
\"fields\": {
\"field\": {
\"@xsi.type\": \"rule_modification_field\",
\"id\": 746,
\"name\": \"rm\",
\"devices\": {
    \"device\": {
    \"revision_id\": 24,
    \"management_id\": 5,
    \"bindings\": {
    \"binding\": {
    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
    \"binding\": {
        \"@xsi.type\": \"policy__binding\",
        \"policy_name\": \"FortiGate-VM64-111-10_3\"
    },
    \"rules\": {
        \"rule\": {
        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
        \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
        }
    }
    }
    }
    }
},
\"rule_modifications\": {
    \"rule_modification\": {
    \"@xsi.type\": \"modify_rule_modification\",
    \"rule_key\": {
    \"device_id\": 5,
    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
    \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
    },
    \"source_modifications\": {
    \"network_object_cell_modifications\": {
    \"network_object_cell_modification\": [
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
            \"name\": \"NET_1\",
            \"comment\": \"\",
            \"ip\": \"3.3.3.3\",
            \"netmask\": \"255.255.255.255\"
        }
        ]
        }
        },
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
            \"name\": \"RANGE_1\",
            \"comment\": \"EXAMPLE_RANGE\",
            \"min_ip\": \"3.3.3.3\",
            \"max_ip\": \"5.5.5.5\"
        }
        ]
        }
        }
    ]
    }
    },
    \"destination_modifications\": {
    \"network_object_cell_modifications\": {
    \"network_object_cell_modification\": [
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
        }
        }
        },
        {
        \"action\": \"REMOVE\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
            \"name\": \"Host123\",
            \"comment\": \"cccHost\",
            \"ip\": \"1.2.3.4\",
            \"netmask\": \"255.255.255.255\"
        }
        ]
        }
        }
    ]
    }
    },
    \"service_modifications\": {
    \"service_object_cell_modifications\": {
    \"service_object_cell_modification\": [
        {
        \"action\": \"REMOVE\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:icmp_service\",
        \"name\": \"ICMP_1\",
        \"comment\": \"EXAMPLE_ICMP\",
        \"type\": {
            \"from\": 55,
            \"to\": 55
        }
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:transport_service\",
        \"name\": \"TCP_1\",
        \"comment\": \"EXAMPLE_TCP\",
        \"port\": {
            \"from\": 1234,
            \"to\": 1234
        },
        \"protocol\": \"TCP\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:transport_service\",
        \"name\": \"UDP_1\",
        \"comment\": \"EXAMPLE_UDP\",
        \"port\": {
            \"from\": 3,
            \"to\": 3
        },
        \"protocol\": \"UDP\"
        }
        }
        }
    ]
    }
    }
    }
}
}
}
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket step does not exist, or is not the current step
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: There are multiple objects with this name in the network)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
403: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (Network Object with device ID <DEVICE_ID> and ST UID <ST_UID> is not available for the action specified. Check the Knowledge Center or API Implementation Notes for more information
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: Invalid value for field: <FIELD_NAME> (a valid object comment can have up to <MAX> characters)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value
406: Invalid format detected: <name|binding_uid|rule_uid> - This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags
406: Invalid format detected: name - <VALUE> is invalid. Text must include <1-255> characters
406: Invalid format detected: <rule_uid|binding_uid> - <VALUE> is invalid. Text must include <1-4096> characters
406: Invalid format detected: comment - <VALUE> is invalid. Text must include <0-4096> characters
406: Invalid format detected: name - <VALUE> is invalid. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters + - , _ # @ . : = ! ^ ( )
406: Invalid format detected: <rule_uid|binding_uid|comment> - <VALUE> is invalid. Text includes invalid expressions such as HTML tags or command line operations
406: Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP","folder":"2-24","rawModeData":"{\n\"fields\": {\n\"field\": {\n\"@xsi.type\": \"rule_modification_field\",\n\"id\": 746,\n\"name\": \"rm\",\n\"devices\": {\n\t\"device\": {\n\t\"revision_id\": 24,\n\t\"management_id\": 5,\n\t\"bindings\": {\n\t\"binding\": {\n\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\"binding\": {\n\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t},\n\t\"rules\": {\n\t\t\"rule\": {\n\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t}\n\t}\n\t}\n\t}\n\t}\n},\n\"rule_modifications\": {\n\t\"rule_modification\": {\n\t\"@xsi.type\": \"modify_rule_modification\",\n\t\"rule_key\": {\n\t\"device_id\": 5,\n\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t},\n\t\"source_modifications\": {\n\t\"network_object_cell_modifications\": {\n\t\"network_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\"name\": \"NET_1\",\n\t\t\t\"comment\": \"\",\n\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t}\n\t\t]\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t}\n\t\t]\n\t\t}\n\t\t}\n\t]\n\t}\n\t},\n\t\"destination_modifications\": {\n\t\"network_object_cell_modifications\": {\n\t\"network_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"REMOVE\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\"name\": \"Host123\",\n\t\t\t\"comment\": \"cccHost\",\n\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t}\n\t\t]\n\t\t}\n\t\t}\n\t]\n\t}\n\t},\n\t\"service_modifications\": {\n\t\"service_object_cell_modifications\": {\n\t\"service_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"REMOVE\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\"name\": \"ICMP_1\",\n\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\"type\": {\n\t\t\t\"from\": 55,\n\t\t\t\"to\": 55\n\t\t}\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\"name\": \"TCP_1\",\n\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\"port\": {\n\t\t\t\"from\": 1234,\n\t\t\t\"to\": 1234\n\t\t},\n\t\t\"protocol\": \"TCP\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\"name\": \"UDP_1\",\n\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\"port\": {\n\t\t\t\"from\": 3,\n\t\t\t\"to\": 3\n\t\t},\n\t\t\"protocol\": \"UDP\"\n\t\t}\n\t\t}\n\t\t}\n\t]\n\t}\n\t}\n\t}\n}\n}\n}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields","collectionId":"2","id":"2-24-137","method":"PUT"},{"name":"Returns topology map image (png file) for specific verifier results","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/multi_access_request/2022/verifier/topology_map

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.
404: Verifier results were not found in the access request.
404: Toplogy map was not found for this field.","dataMode":"params","folder":"2-24","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_access_request/{{fieldId}}/verifier/topology_map","collectionId":"2","id":"2-24-138","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Change the ticket properties","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"raw","description":"Change the ticket properties listed in the TicketPropertiesDTO.
When specifying the notification_group property you must use the ID of the group or leave the ID empty to remove the group. This property can be updated on a closed ticket.
When specifying the referenced_ticket property you must use the ID of the ticket or leave the ID empty to remove the ticket.
When specifying the expiration_date property, you must use a yyyy-mm-dd format, or leave the value empty to remove the expiration date. To ignore the field, do not include it in the request. This property can be updated on a closed ticket.

Parameters:
body: ticketPropertiesDTO
id: The ID number of the ticket as shown in SecureChange

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/ticket_properties
BODY<ticket_properties>
    <referenced_ticket>
        <id>9</id>
    </referenced_ticket>
    <notification_group>
        <id>10</id>
    </notification_group>
    <expiration_date>2022-12-10</expiration_date>
</ticket_properties>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/ticket_properties
BODY<ticket_properties>
    <notification_group>
        <id/>
    </notification_group>
    <referenced_ticket>
        <id/>
    </referenced_ticket>
    <expiration_date/>
</ticket_properties>


Response Messages:
400: Notification Group <ID> is a user and not a user group
400: Notification Group <ID> exceeds the configured maximum allowed number of users for notifications
400: <ID> (“Any User”) is not allowed as a Notification Group
400: Notification Group <ID> does not have permission of 'Group members can perform actions on requests submitted by other members'
400: Notification Group <ID> is not a member in the first step of the workflow
400: Notification Group is not enabled in this workflow
403: You do not have permission to change the Notification Group
404: There is no group with ID <ID>.
404: There is no ticket with ID <ID>.
400: Referenced ticket id cannot be the same as ticket id
400: invalid id format for referenced ticket
400: Cannot update properties [<Property A>, <Property B>] for ticket with status <STATUS>
403: You do not have permission to update this ticket at this stage. Contact your administrator for assistance.
403: The user is not allowed to add the specified referenced ticket.
400: Workflow does not support referenced ticket
400: Cannot delete expiration date on this workflow due to it being a mandatory field
400: Invalid date. Cannot update expiration to a date that has passed
400: Invalid value for field: expiration_date (The date format must be: yyyy-mm-dd)
400: Invalid value for field: expiration_date (The date is not valid)
400: This workflow does not support expiration dates","folder":"2-24","rawModeData":"\n\t\n\t\t\n\t\n\t\n\t\t\n\t\n\t\n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/ticket_properties","collectionId":"2","id":"2-24-139","method":"PUT"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Modify the Designer suggestions for Access Request or Clone Server Policy","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"instructionId"}],"dataMode":"raw","description":" GENERAL USE
1. Create a ticket using UI/API.
2. Run the designer using UI/API.
3. Use relevent API to get the designer results.
4. Run this API to modify the required parameters.

*Note: you can modify one parameter at a time.

Change rule location use
a. Modifying the rule order places the new rule before the rule with the specified identifier (rule name or number).
b. Modifying the rule placement to \"last\" places the new rule as last rule or last pre-rule (depending on the vendor convention for the device).
c. For vendors that support \"after\" placement, modifying the rule placement allows positioning the new rule before or after the suggested rule location.
d. For Check Point R80 and above releases, the indented rule numbering format can be applied to globally assigned policies (for example, “rule_order”: “4.5”).

track level permitted values:
NONE, LOG, ACCOUNT, ALERT, SNMP, MAIL, USER_DEFINED, EMERGENCIES, ALERTS, CRITICAL, ERRORS, WARNINGS, NOTIFICATIONS, INFORMATIONAL, DEBUGGING, DISABLED, DEFAULT, FULL_LOG, NETWORK_LOG, USER_ALERT_1, USER_ALERT_2, USER_ALERT_3

rule placement permitted values:
BEFORE, AFTER, LAST

Parameters:
body: DesignerInstructionChangeDTO
id: Ticket ID
taskId: Task ID
instructionId: Instruction ID
force: force update when new revision available [optional]

Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"comment\": {\"new_value\":\"new comment\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196?force=true
BODY{
    \"comment\": {\"new_value\":\"new comment\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_name\": {\"new_value\":\"new rule name\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"track_level\": {\"new_value\":\"LOG\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"object_name\": {\"new_value\":\"new object name\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"log_forwarding_profile\": {\"new_value\":\"new log forwarding profile\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"security_profile_group\": {\"new_value\":\"new security profile group\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"object_replace\": {
             \"new_value\":\"new object uid\",
             \"old_value\":\"old object uid\"
    }
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_order\": {\"new_value\":\"8\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"tags\": {\"values\":[\"tag1\", \"tag2\"]}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"tags\": {\"values\":[]}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_placement\": {\"new_value\":\"last\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_placement\": {\"new_value\":\"before\"}
}


Response Messages:
200: New rule will be shadowed
200: New rule will be shadowed or break acceleration
400: Modify Designer Results API is only supported for Access Request and Clone Server Policy workflows
412: Current instruction cannot be modified because either the implementation was successful or failed irrevocably.
412: Current step does not support Designer modification action
404: A ticket with ID <ID> cannot be found.
400: Task ID <ID> cannot be found in the current step with ID <ID>.
403: Changing <TYPE> is not supported on this device
403: This Change is not supported for <INSTRUCTION TYPE> instruction type\"
403: You do not have permission to update this task. Contact your administrator for assistance.
403: New revision is available, cannot modify the Designer results
404: Specified instruction, id: <ID> was not found
404: Designer results were not found in the access request.
400: a valid object name must start with an alphanumeric character and can contain alphanumeric characters, underscore '_'. Hypen '-', dot '.' or spaces
400: For this device, the comment must be less than 100 characters per line.
400: For this device, this field must be less than <NUMBER OF CHARACTERS> characters
400: For this device, this field is required.
400: For this device, a valid object name cannot be <OBJECT NAME> because it is a reserved word
409: Rule name already exists for this device. Please give this rule a unique name.
409: Rule name <NAME> already exists in the device group hierarchy. Choose a unique name for this rule.
400: Comment contains invalid characters.
400: <DEVICE> does not support tracking level <TRACKING LEVEL>
400: <TRACKING LEVEL> is not a valid rule track level value
400: a valid object name cannot contain any of the following characters: <CHARACTERS>
400: a valid object name must be less than <NUMBER OF CHARACTERS> characters
400: a valid object name cannot be empty
400: a valid object name must conform to the following pattern: <STRING PATTERN>
409: Object already exists
400: A security profile group cannot be empty.
404: The security profile group <SECURITY PROFILE GROUP> was not found.
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to validate the security profile group.
400: A log forwarding profile cannot be empty.
400: Tag list is longer than 20 items.
400: Tag list contains the same tag more than once.
400: These tags don't exist or aren't relevant to the rule on its DG location : <Tags>
404: The log forwarding profile <LOG FORWARDING PROFILE> was not found.
500: An error occurred in SecureTrack while trying to validate the log forwarding profile.
400: Object UID <OLD OBJECT UID> not found in the rule for this instruction.
400: Values of new object UID <NEW OBJECT UID> and old object UID <OLD OBJECT UID> do not match.
400: Rule placement can only be: \"before\", \"after\" or \"last\".
400: You can't change rule placement when there is no rule order. please add rule order first.
400: You can't change rule placement to \"After\" for this type of device.
400: You can't change rule placement to \"Last\" for this type of device.","folder":"2-24","rawModeData":"{\n\t\"rule_placement\": {\"new_value\":\"before\"}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/tasks/{{taskId}}/designer/instruction/{{instructionId}}","collectionId":"2","id":"2-24-140","method":"PUT"},{"headers":"Accept: application/json\n","name":"Returns the details of a specified tickets (max 100 tickets in a single query)","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
status: The status of the tickets [optional]
count: Tickets list max pagination length (max value is 100) [optional]
start: Offset the count starting point [optional]
desc: Get the list in descending order [optional]
expand_links: See expanded view of the objects [optional]
showStepsDetails: Include steps' details in the response [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets?status=In Progress&count=10&start=3&expand_links=false

Response Messages:
400: Status is not a valid. The valid values are: TICKET_STATUSES
400: Can not fetch more than 100 tickets in 1 time
403: Access is denied","folder":"2-24","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/","collectionId":"2","id":"2-24-141","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Submit a new ticket to Secure Change","dataMode":"raw","description":" GENERAL USE
When posting a Modify Group ticket, group scope must be configured for FortiManager advanced and Juniper SRX devices.
Juniper SRX devices:
Global address-book will be used unless an existing address-book is given.
Ticket validation will fail in case given Address Book is not configured on the device.
FortiManager advanced devices:
'Any' zone will be used unless an existing zone is given.
Ticket validation will fail in case given zone is not configured on the device.
*Note: Zones and address-books must not be configured for other devices.

Using newly created objects from a different group in the same ticket
The user can add a newly created object from a different group to the selected group, with object_UID equal to the name of the newly created object.
For management devices with hierarchies, the newly created object does not populate other levels of the hierarchies.

Permitted values for @type
Allowed values for @type property included in DestinationDTO and SourceDTO are:
ANY
IP
DNS
Object - Device's existing object
INTERNET
LDAP (SourceDTO only) - LDAP entity

To use a service object in a new request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id
2. Both object_name and management_name

To use a network object in a new request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both object_UID and object_name are defined, object_UID takes precedence over object_name

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: ticketDTO
closed: Cannot be done from the API [optional]
count [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY<ticket>
    <subject>topology mode_AR1-with topology_AR2-no topology</subject>
    <requester>u1</requester>
    <priority>Normal</priority>
    <domain_name>Default</domain_name>
    <workflow>
         <id>7</id>
         <name>Workflow with topology</name>
    </workflow>
    <steps>
         <step>
             <name>Open request</name>
             <tasks>
                 <task>
                     <fields>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_access_request\">
                             <name>Required Access</name>
                             <access_request>
                                 <use_topology>true</use_topology>
                                 <targets>
                                     <target type=\"Object\">
                                         <object_name>ASA</object_name>
                                         <management_name>ASA</management_name>
                                     </target>
                                 </targets>
                                 <users>
                                     <user>Any</user>
                                 </users>
                                 <sources>
                                     <source type=\"Object\">
                                         <object_name>host_10.100.10.140</object_name>
                                         <management_name>NetScreen</management_name>
                                     </source>
                                 <sources>
                                     <source type=\"Object\">
                                         <object_UID>{55908141-c341-4990-9cc6-a3fd2dfb49e1}</object_UID>
                                         <management_id>13</management_id>
                                     </source>
                                 </sources>
                                 <destinations>
                                     <destination type=\"Object\">
                                         <object_name>h_10.10.10.10</object_name>
                                         <management_name>ASA</management_name>
                                     </destination>
                                 </destinations>
                                 <services>
                                     <service type=\"PROTOCOL\">
                                         <protocol>TCP</protocol>
                                         <port>80</port>
                                     </service>
                                     <service type=\"APPLICATION_IDENTITY\">
                                         <application_name>Gmail</application_name>
                                     </service>
                                 </services>
                                 <action>Accept</action>
                                 <labels/>
                             </access_request>
                             <access_request>
                                 <use_topology>false</use_topology>
                                 <targets>
                                     <target type=\"Object\">
                                         <object_name>inside_access_in</object_name>
                                         <management_name>ASA</management_name>
                                     </target>
                                 </targets>
                                 <users>
                                     <user>Any</user>
                                 </users>
                                 <sources>
                                     <source type=\"Object\">
                                         <object_name>1.1.1.0</object_name>
                                         <management_name>NetScreen</management_name>
                                     </source>
                                 </sources>
                                 <destinations>
                                     <destination type=\"Object\">
                                         <object_name>network_regi3</object_name>
                                         <management_name>ASA</management_name>
                                     </destination>
                                 </destinations>
                                 <services>
                                     <service type=\"ANY\">
                                     </service>
                                 </services>
                                 <action>Accept</action>
                                 <labels/>
                             </access_request>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_area\">
                             <name>Business Justification</name>
                             <text>I need access to ftp </text>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_field\">
                             <name>Project Number</name>
                             <text>CR124560 </text>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"hyperlink\">
                             <name>Hyperlink</name>
                             <url>http://192.168.1.1/ticket</url>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"drop_down_list\">
                             <name>Change Window</name>
                             <selection>Monday</selection>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"manager\">
                             <name>manager email</name>
                             <text>manager@tufin.com</text>
                         </field>
                     </fields>
                 </task>
             </tasks>
        </step>
    </steps>
    <comments/>
</ticket>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY<ticket>
    <subject>New MG ticket</subject>
    <requester>a</requester>
    <requester_id>4</requester_id>
    <priority>Normal</priority>
    <status>In Progress</status>
    <domain_name/>
    <sla_status>NA</sla_status>
    <sla_outcome>NA</sla_outcome>
    <workflow>
        <id>6</id>
        <name>MG</name>
        <uses_topology>false</uses_topology>
    </workflow>
    <steps>
        <step>
            <id>72</id>
            <name>New step</name>
            <redone>false</redone>
            <skipped>false</skipped>
            <tasks>
                <task>
                    <id>72</id>
                    <assignee_id>4</assignee_id>
                    <assignee>a</assignee>
                    <status>ASSIGNED</status>
                    <fields>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_group_change\">
                            <id>262</id>
                            <name>MG</name>
                            <read_only>false</read_only>
                            <implementation_status>NOT_SUPPORTED</implementation_status>
                            <group_change>
                                <name>ExistingGroup</name>
                                <object_UID>{c862fb6f-1314-45da-9e01-56c9b85d001d}</object_UID>
                                <management_id>58</management_id>
                                <management_name>FMG/root</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>157</id>
                                        <name>10.100 net</name>
                                        <object_UID>{37cdc055-7aac-4385-b46b-cc54d95e4b6d}</object_UID>
                                        <object_type>Network</object_type>
                                        <object_details>10.100.0.0/255.255.0.0</object_details>
                                        <management_id>58</management_id>
                                        <management_name>FMG/root</management_name>
                                        <status>NOT_CHANGED</status>
                                        <object_updated_status>EXISTING_EDITED</object_updated_status>
                                        <comment>new_comment</comment>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                                <zone>
                                    <is_global>true</is_global>
                                    <name>any</name>
                                </zone>
                            </group_change>
                            <group_change>
                                <name>78.45.12.0</name>
                                <object_UID>{cac64d34-a05e-4a05-b271-64642eb976ff}</object_UID>
                                <management_id>28</management_id>
                                <management_name>SRX-root-lsys</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>158</id>
                                        <name>78.45.12.1</name>
                                        <object_UID>{7912c335-6dbe-47de-b872-1322f9015b2f}</object_UID>
                                        <object_type>Host</object_type>
                                        <object_details>78.45.12.1/255.255.255.255</object_details>
                                        <management_id>28</management_id>
                                        <management_name>SRX-root-lsys</management_name>
                                        <status>NOT_CHANGED</status>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                                <address_book>
                                    <name>global</name>
                                </address_book>
                            </group_change>
                            <group_change>
                                <name>10.10.0.0/16</name>
                                <object_UID>{5dff0bd8-51e4-4a83-8138-d54dd18ca52b}</object_UID>
                                <management_id>24</management_id>
                                <management_name>NSX-Distributed Firewall</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>161</id>
                                        <name>10.10.0.0/16</name>
                                        <object_UID>{5d7b826c-f053-40fd-81bd-7a6f44cf15ef}</object_UID>
                                        <object_type>Network</object_type>
                                        <object_details>10.10.0.0/255.255.0.0</object_details>
                                        <management_id>24</management_id>
                                        <management_name>NSX-Distributed Firewall</management_name>
                                        <status>NOT_CHANGED</status>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                            </group_change>
                        </field>
                    </fields>
                </task>
            </tasks>
        </step>
    </steps>
</ticket>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY<ticket>
    <subject>test API</subject>
    <requester>a</requester>
    <requester_id>4</requester_id>
    <priority>Normal</priority>
    <domain_name/>
    <sla_status>NA</sla_status>
    <sla_outcome>NA</sla_outcome>
    <workflow>
        <id>8</id>
        <name>Modify group</name>
        <uses_topology>false</uses_topology>
    </workflow>
    <steps>
        <step>
            <id>11</id>
            <name>Open request</name>
            <redone>false</redone>
            <skipped>false</skipped>
            <tasks>
                <task>
                    <id>11</id>
                    <assignee_id>4</assignee_id>
                    <assignee>a</assignee>                    <status>DONE</status>
                    <fields>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_group_change\">
                            <id>137</id>
                            <name>ff</name>
                            <read_only>false</read_only>
                            <implementation_status>NOT_SUPPORTED</implementation_status>
                            <group_change>
                                <name>port1Group</name>
                                <object_UID>{d5b4459b-6b27-4012-9924-b244c250520f}</object_UID>
                                <management_id>64</management_id>
                                <management_name>10.100.111.8/ADOM_5_2</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"HOST\">
                                        <id>69</id>
                                        <name>obj_1</name>
                                        <object_UID>obj_1</object_UID>
                                        <object_type>Host</object_type>
                                        <object_details>6.6.6.6/255.255.255.255</object_details>
                                        <management_id>64</management_id>
                                        <status>ADDED</status>
                                        <comment/>
                                        <object_updated_status>NEW</object_updated_status>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                            </group_change>
                            <group_change>
                                <name>gfd</name>
                                <management_id>64</management_id>
                                <management_name>10.100.111.8/ADOM_5_2</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>70</id>
                                        <name>obj_1</name>
                                        <object_UID>obj_1</object_UID>
                                        <object_type>Host</object_type>
                                        <object_details>6.6.6.6/255.255.255.255</object_details>
                                        <management_id>64</management_id>
                                        <management_name>10.100.111.8/ADOM_5_2</management_name>
                                        <status>ADDED</status>
                                        <object_updated_status>EXISTING_NOT_EDITED</object_updated_status>
                                    </member>
                                </members>
                                <change_action>CREATE</change_action>
                                <zone>
                                    <is_global>true</is_global>
                                    <name>any</name>
                                </zone>
                            </group_change>
                        </field>
                    </fields>
                </task>
            </tasks>
        </step>
    </steps>
    <current_step>
        <id>12</id>
        <name>Copy of Open request</name>
    </current_step>
    <comments/>
</ticket>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY{
    \"ticket\": {
        \"application_details\": { \"id\": \"1\" },
        \"referenced_ticket\": { \"id\": \"3\" },
        \"subject\": \"topology mode_AR1-with topology_AR2-no topology\",
        \"priority\": \"Normal\",
        \"workflow\": { \"name\": \"ar\" }
    }
}


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY{
    \"ticket\": {
        \"subject\": \"RM_EXAMPLE\",
        \"requester\": \"m\",
        \"requester_id\": 4,
        \"priority\": \"Normal\",
        \"domain_name\": \"\",
        \"workflow\": {
            \"name\": \"RM\",
        },
        \"steps\": {
            \"step\": [
                {
                    \"tasks\": {
                        \"task\": {
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"rule_modification_field\",
                                    \"devices\": {
                                        \"device\": {
                                            \"revision_id\": 24,
                                            \"management_id\": 5,
                                            \"bindings\": {
                                                \"binding\": {
                                                    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                                                    \"binding\": {
                                                        \"@xsi.type\": \"policy__binding\",
                                                        \"policy_name\": \"FortiGate-VM64-111-10_3\"
                                                    },
                                                    \"rules\": {
                                                        \"rule\": {
                                                            \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                                            \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    \"rule_modifications\": {
                                        \"rule_modification\": {
                                            \"@xsi.type\": \"modify_rule_modification\",
                                            \"rule_key\": {
                                                \"device_id\": 5,
                                                \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                                                \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                                            },
                                            \"source_modifications\": {
                                                \"network_object_cell_modifications\": {
                                                    \"network_object_cell_modification\": [
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"network_object\": [
                                                                    {
                                                                        \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                                        \"name\": \"RANGE_1\",
                                                                        \"comment\": \"EXAMPLE_RANGE\",
                                                                        \"min_ip\": \"3.3.3.3\",
                                                                        \"max_ip\": \"5.5.5.5\"
                                                                    }
                                                                ]
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"network_object\": [
                                                                    {
                                                                        \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                                        \"name\": \"NET_1\",
                                                                        \"comment\": \"\",
                                                                        \"ip\": \"3.3.3.3\",
                                                                        \"netmask\": \"255.255.255.255\"
                                                                    }
                                                                ]
                                                            }
                                                        }
                                                    ]
                                                }
                                            },
                                            \"destination_modifications\": {
                                                \"id\": 11,
                                                \"network_object_cell_modifications\": {
                                                    \"network_object_cell_modification\": [
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"existing\",
                                                                    \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"REMOVE\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"existing\",
                                                                    \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"network_object\": [
                                                                    {
                                                                        \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                                        \"name\": \"Host123\",
                                                                        \"comment\": \"cccHost\",
                                                                        \"ip\": \"1.2.3.4\",
                                                                        \"netmask\": \"255.255.255.255\"
                                                                    }
                                                                ]
                                                            }
                                                        }
                                                    ]
                                                }
                                            },
                                            \"service_modifications\": {
                                                \"id\": 9,
                                                \"service_object_cell_modifications\": {
                                                    \"service_object_cell_modification\": [
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"service_object\": {
                                                                    \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                                                    \"name\": \"ICMP_1\",
                                                                    \"comment\": \"EXAMPLE_ICMP\",
                                                                    \"type\": {
                                                                        \"from\": 55,
                                                                        \"to\": 55
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"service_object\": {
                                                                    \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                                    \"name\": \"UDP_1\",
                                                                    \"comment\": \"EXAMPLE_UDP\",
                                                                    \"port\": {
                                                                        \"from\": 3,
                                                                        \"to\": 3
                                                                    },
                                                                    \"protocol\": \"UDP\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"service_object\": {
                                                                    \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                                    \"name\": \"TCP_1\",
                                                                    \"comment\": \"EXAMPLE_TCP\",
                                                                    \"port\": {
                                                                        \"from\": 1234,
                                                                        \"to\": 1234
                                                                    },
                                                                    \"protocol\": \"TCP\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"existing\",
                                                                    \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"REMOVE\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"existing\",
                                                                    \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                                                }
                                                            }
                                                        }
                                                    ]
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            ]
        },
    }
}


Response Messages:
400: Application ID is missing.
400: Create closed ticket is enabled only from SecureApp application.
400: The application was already deleted.
400: The requester must be the currently logged in user.
400: Workflow was not found.
400: Workflow is not active.
400: Workflow configuration is not valid.
400: Workflow is not set
400: You cannot enter a status for a new ticket.
400: Requester cannot open a ticket in domain.
400: Invalid ticket priority.
400: You cannot open a new ticket with an empty subject.
400: Expiration field is required.
400: Submit ticket enabled only with the first step
400: First step can be only with one task
400: The specified workflow does not contain an access request field in the first step.
400: There are no changed connections that are ready for creating a ticket.
400: You cannot use an access request field to create a ticket from SecureApp.
400: The ticket fields do not match the fields in the current step of the workflow.
400: You cannot change the value of a field because it is read-only.
400: Managed tasks are not initialized or done
400: Application Change field cannot be managed via this REST API
400: Invalid value for field: <FIELD_NAME> (Rule Modification workflow is not supported for this device)
403: You do not have permissions to edit this application.
403: Logged in user: NAME do not have permission to perform on behalf actions
403: You are not a participant in the first step of this workflow
403: UNAUTHORIZED
404: There is no application with the specified ID
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (Network object cell modification missing action)
400: Invalid value for field: <FIELD_NAME> (Network object cell modification element cannot be empty)
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: Invalid value for field: <FIELD_NAME> (a valid object comment can have up to <MAX> characters)
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: There are multiple objects with this name in the network)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value
400: Workflow does not support referenced ticket
400: The referenced ticket cannot be the ticket itself
406: Invalid format detected: <subject|name|binding_uid|rule_uid> - This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags
406: Invalid format detected: <subject|name> - <VALUE> is invalid. Text must include <1-255> characters
406: Invalid format detected: <rule_uid|binding_uid> - <VALUE> is invalid. Text must include <1-4096> characters
406: Invalid format detected: comment - <VALUE> is invalid. Text must include <0-4096> characters
406: Invalid format detected: <subject|name> - <VALUE> is invalid. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters + - , _ # @ . : = ! ^ ( )
406: Invalid format detected: <rule_uid|binding_uid|comment> - <VALUE> is invalid. Text includes invalid expressions such as HTML tags or command line operations
406: Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP","folder":"2-24","rawModeData":"{\n\t\"ticket\": {\n\t\t\"subject\": \"RM_EXAMPLE\",\n\t\t\"requester\": \"m\",\n\t\t\"requester_id\": 4,\n\t\t\"priority\": \"Normal\",\n\t\t\"domain_name\": \"\",\n\t\t\"workflow\": {\n\t\t\t\"name\": \"RM\",\n\t\t},\n\t\t\"steps\": {\n\t\t\t\"step\": [\n\t\t\t\t{\n\t\t\t\t\t\"tasks\": {\n\t\t\t\t\t\t\"task\": {\n\t\t\t\t\t\t\t\"fields\": {\n\t\t\t\t\t\t\t\t\"field\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\t\t\t\t\t\t\"devices\": {\n\t\t\t\t\t\t\t\t\t\t\"device\": {\n\t\t\t\t\t\t\t\t\t\t\t\"revision_id\": 24,\n\t\t\t\t\t\t\t\t\t\t\t\"management_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"rule_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\t\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 11,\n\t\t\t\t\t\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 9,\n\t\t\t\t\t\t\t\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/","collectionId":"2","id":"2-24-142","method":"POST"},{"headers":"Content-Type: application/xml\n","name":"Change a field within a task of a ticket at the current step","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"dataMode":"raw","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldDTO
id: Ticket ID
taskId: Task ID
fieldId: Field ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields/7642
BODY<field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"approve_reject\">
         <id>7661</id>
         <name>approve access</name>
         <approved>true</approved>
         <reason>Request approved</reason>
    </field>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields/71
BODY{
    \"rule_modification_field\": {
        \"devices\": {
            \"device\": {
                \"management_id\": 5,
                \"bindings\": {
                    \"binding\": {
                        \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                        \"binding\": {
                            \"@xsi.type\": \"policy__binding\",
                            \"policy_name\": \"FortiGate-VM64-111-10_3\"
                        },
                        \"rules\": {
                            \"rule\": {
                                \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                            }
                        }
                    }
                }
            }
        },
        \"rule_modifications\": {
            \"rule_modification\": {
                \"@xsi.type\": \"modify_rule_modification\",
                \"rule_key\": {
                    \"device_id\": 5,
                    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                    \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                },
                \"source_modifications\": {
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                            \"name\": \"NET_1\",
                                            \"comment\": \"\",
                                            \"ip\": \"3.3.3.3\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                            \"name\": \"RANGE_1\",
                                            \"comment\": \"EXAMPLE_RANGE\",
                                            \"min_ip\": \"3.3.3.3\",
                                            \"max_ip\": \"5.5.5.5\"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                \"destination_modifications\": {
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"name\": \"Host123\",
                                            \"comment\": \"cccHost\",
                                            \"ip\": \"1.2.3.4\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"action\": \"REMOVE\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                    }
                                }
                            }
                        ]
                    }
                },
                \"service_modifications\": {
                    \"service_object_cell_modifications\": {
                        \"service_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                        \"name\": \"TCP_1\",
                                        \"comment\": \"EXAMPLE_TCP\",
                                        \"port\": {
                                            \"from\": 1234,
                                            \"to\": 1234
                                        },
                                        \"protocol\": \"TCP\"
                                    }
                                }
                            },
                            {
                                \"action\": \"REMOVE\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"uid\": \"551556da-22dc-46f4-9253-a7ceee70394b\",
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                        \"name\": \"UDP_1\",
                                        \"comment\": \"EXAMPLE_UDP\",
                                        \"port\": {
                                            \"from\": 3,
                                            \"to\": 3
                                        },
                                        \"protocol\": \"UDP\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                        \"name\": \"ICMP_1\",
                                        \"comment\": \"EXAMPLE_ICMP\",
                                        \"type\": {
                                            \"from\": 55,
                                            \"to\": 55
                                        }
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                    }
                                }
                            }
                        ]
                    }
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: There are multiple objects with this name in the network)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
403: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: Invalid value for field: <FIELD_NAME> (a valid object comment can have up to <MAX> characters)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value
406: Invalid format detected: <name|binding_uid|rule_uid> - This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags
406: Invalid format detected: name - <VALUE> is invalid. Text must include <1-255> characters
406: Invalid format detected: <rule_uid|binding_uid> - <VALUE> is invalid. Text must include <1-4096> characters
406: Invalid format detected: comment - <VALUE> is invalid. Text must include <0-4096> characters
406: Invalid format detected: name - <VALUE> is invalid. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters + - , _ # @ . : = ! ^ ( )
406: Invalid format detected: <rule_uid|binding_uid|comment> - <VALUE> is invalid. Text includes invalid expressions such as HTML tags or command line operations
406: Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP","folder":"2-24","rawModeData":"{\n\t\"rule_modification_field\": {\n\t\t\"devices\": {\n\t\t\t\"device\": {\n\t\t\t\t\"management_id\": 5,\n\t\t\t\t\"bindings\": {\n\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t\"rule_modifications\": {\n\t\t\t\"rule_modification\": {\n\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t},\n\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"uid\": \"551556da-22dc-46f4-9253-a7ceee70394b\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/fields/{{fieldId}}","collectionId":"2","id":"2-24-143","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Change a task of a ticket at the current step","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"raw","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: ticketTaskDTO
id: Ticket ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4
BODY<task>
    <status>DONE</status>
    <fields/>
</task>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4
BODY{
    \"task\": {
        \"status\": \"ASSIGNED\",
        \"fields\": {
            \"field\": {
                \"@xsi.type\": \"rule_modification_field\",
                \"id\": 743,
                \"devices\": {
                    \"device\": {
                        \"revision_id\": 24,
                        \"management_id\": 5,
                        \"bindings\": {
                            \"binding\": {
                                \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                                \"binding\": {
                                    \"@xsi.type\": \"policy__binding\",
                                    \"policy_name\": \"FortiGate-VM64-111-10_3\"
                                },
                                \"rules\": {
                                    \"rule\": {
                                        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                        \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                                    }
                                }
                            }
                        }
                    }
                },
                \"rule_modifications\": {
                    \"rule_modification\": {
                        \"@xsi.type\": \"modify_rule_modification\",
                        \"rule_key\": {
                            \"device_id\": 5,
                            \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                            \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                        },
                        \"source_modifications\": {
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                    \"name\": \"RANGE_1\",
                                                    \"comment\": \"EXAMPLE_RANGE\",
                                                    \"min_ip\": \"3.3.3.3\",
                                                    \"max_ip\": \"5.5.5.5\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                    \"name\": \"NET_1\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"3.3.3.3\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        },
                        \"destination_modifications\": {
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                    \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"name\": \"Host123\",
                                                    \"comment\": \"cccHost\",
                                                    \"ip\": \"1.2.3.4\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"REMOVE\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                            }
                                        }
                                    }
                                ]
                            }
                        },
                        \"service_modifications\": {
                            \"service_object_cell_modifications\": {
                                \"service_object_cell_modification\": [
                                    {
                                        \"action\": \"REMOVE\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                                \"name\": \"ICMP_1\",
                                                \"comment\": \"EXAMPLE_ICMP\",
                                                \"type\": {
                                                    \"from\": 55,
                                                    \"to\": 55
                                                }
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                \"name\": \"TCP_1\",
                                                \"comment\": \"EXAMPLE_TCP\",
                                                \"port\": {
                                                    \"from\": 1234,
                                                    \"to\": 1234
                                                },
                                                \"protocol\": \"TCP\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                \"name\": \"UDP_1\",
                                                \"comment\": \"EXAMPLE_UDP\",
                                                \"port\": {
                                                    \"from\": 3,
                                                    \"to\": 3
                                                },
                                                \"protocol\": \"UDP\"
                                            }
                                        }
                                    }
                                ]
                            }
                        }
                    }
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Task status does not exist.
400: Task status is not set to ASSIGNED or DONE.
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: There are multiple objects with this name in the network)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
403: You do not have permission to update this task. Contact your administrator for assistance.
403: Task can not be done because there are unlicensed devices for change automation
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: Invalid value for field: <FIELD_NAME> (a valid object comment can have up to <MAX> characters)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value
406: Invalid format detected: <name|binding_uid|rule_uid> - This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags
406: Invalid format detected: name - <VALUE> is invalid. Text must include <1-255> characters
406: Invalid format detected: <rule_uid|binding_uid> - <VALUE> is invalid. Text must include <1-4096> characters
406: Invalid format detected: comment - <VALUE> is invalid. Text must include <0-4096> characters
406: Invalid format detected: name - <VALUE> is invalid. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters + - , _ # @ . : = ! ^ ( )
406: Invalid format detected: <rule_uid|binding_uid|comment> - <VALUE> is invalid. Text includes invalid expressions such as HTML tags or command line operations
406: Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP","folder":"2-24","rawModeData":"{\n\t\"task\": {\n\t\t\"status\": \"ASSIGNED\",\n\t\t\"fields\": {\n\t\t\t\"field\": {\n\t\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\t\"id\": 743,\n\t\t\t\t\"devices\": {\n\t\t\t\t\t\"device\": {\n\t\t\t\t\t\t\"revision_id\": 24,\n\t\t\t\t\t\t\"management_id\": 5,\n\t\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"rule_modifications\": {\n\t\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}","collectionId":"2","id":"2-24-144","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Change multiple field within a task of a ticket in the current step","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"raw","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldListDTO
id: Ticket ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields
BODY<fields>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_server_decommission_request\">
         <id>7591</id>
         <name>sd</name>
         <server_decommission_request>
             <id>7596</id>
             <order>DR1</order>
             <servers>
                 <server type=\"IP\">
                     <id>7593</id>
                     <ip_address>2.2.2.2</ip_address>
                     <netmask>255.255.255.255</netmask>
                 </server>
             </servers>
             <targets>
                 <target type=\"ANY\">
                     <id>7595</id>
                 </target>
             </targets>
             <comment>change ip from 1.1.1.1 to 2.2.2.2</comment>
         </server_decommission_request>
     </field>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"date\">
         <id>7786</id>
         <name>date</name>
         <value>2015-12-15</value>
     </field>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"time\">
         <id>7787</id>
         <name>time</name>
         <value>12:00</value>
     </field>
</fields>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields
BODY{
\"fields\": {
\"field\": {
\"@xsi.type\": \"rule_modification_field\",
\"id\": 746,
\"name\": \"rm\",
\"devices\": {
    \"device\": {
    \"revision_id\": 24,
    \"management_id\": 5,
    \"bindings\": {
    \"binding\": {
    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
    \"binding\": {
        \"@xsi.type\": \"policy__binding\",
        \"policy_name\": \"FortiGate-VM64-111-10_3\"
    },
    \"rules\": {
        \"rule\": {
        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
        \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
        }
    }
    }
    }
    }
},
\"rule_modifications\": {
    \"rule_modification\": {
    \"@xsi.type\": \"modify_rule_modification\",
    \"rule_key\": {
    \"device_id\": 5,
    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
    \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
    },
    \"source_modifications\": {
    \"network_object_cell_modifications\": {
    \"network_object_cell_modification\": [
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
            \"name\": \"NET_1\",
            \"comment\": \"\",
            \"ip\": \"3.3.3.3\",
            \"netmask\": \"255.255.255.255\"
        }
        ]
        }
        },
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
            \"name\": \"RANGE_1\",
            \"comment\": \"EXAMPLE_RANGE\",
            \"min_ip\": \"3.3.3.3\",
            \"max_ip\": \"5.5.5.5\"
        }
        ]
        }
        }
    ]
    }
    },
    \"destination_modifications\": {
    \"network_object_cell_modifications\": {
    \"network_object_cell_modification\": [
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
        }
        }
        },
        {
        \"action\": \"REMOVE\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
            \"name\": \"Host123\",
            \"comment\": \"cccHost\",
            \"ip\": \"1.2.3.4\",
            \"netmask\": \"255.255.255.255\"
        }
        ]
        }
        }
    ]
    }
    },
    \"service_modifications\": {
    \"service_object_cell_modifications\": {
    \"service_object_cell_modification\": [
        {
        \"action\": \"REMOVE\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:icmp_service\",
        \"name\": \"ICMP_1\",
        \"comment\": \"EXAMPLE_ICMP\",
        \"type\": {
            \"from\": 55,
            \"to\": 55
        }
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:transport_service\",
        \"name\": \"TCP_1\",
        \"comment\": \"EXAMPLE_TCP\",
        \"port\": {
            \"from\": 1234,
            \"to\": 1234
        },
        \"protocol\": \"TCP\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:transport_service\",
        \"name\": \"UDP_1\",
        \"comment\": \"EXAMPLE_UDP\",
        \"port\": {
            \"from\": 3,
            \"to\": 3
        },
        \"protocol\": \"UDP\"
        }
        }
        }
    ]
    }
    }
    }
}
}
}
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object / device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (<device network object / device service object> is invalid: There are multiple objects with this name in the network)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
403: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: Invalid value for field: <FIELD_NAME> (a valid object comment can have up to <MAX> characters)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value
406: Invalid format detected: <name|binding_uid|rule_uid> - This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags
406: Invalid format detected: name - <VALUE> is invalid. Text must include <1-255> characters
406: Invalid format detected: <rule_uid|binding_uid> - <VALUE> is invalid. Text must include <1-4096> characters
406: Invalid format detected: comment - <VALUE> is invalid. Text must include <0-4096> characters
406: Invalid format detected: name - <VALUE> is invalid. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters + - , _ # @ . : = ! ^ ( )
406: Invalid format detected: <rule_uid|binding_uid|comment> - <VALUE> is invalid. Text includes invalid expressions such as HTML tags or command line operations
406: Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP","folder":"2-24","rawModeData":"{\n\"fields\": {\n\"field\": {\n\"@xsi.type\": \"rule_modification_field\",\n\"id\": 746,\n\"name\": \"rm\",\n\"devices\": {\n\t\"device\": {\n\t\"revision_id\": 24,\n\t\"management_id\": 5,\n\t\"bindings\": {\n\t\"binding\": {\n\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\"binding\": {\n\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t},\n\t\"rules\": {\n\t\t\"rule\": {\n\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t}\n\t}\n\t}\n\t}\n\t}\n},\n\"rule_modifications\": {\n\t\"rule_modification\": {\n\t\"@xsi.type\": \"modify_rule_modification\",\n\t\"rule_key\": {\n\t\"device_id\": 5,\n\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t},\n\t\"source_modifications\": {\n\t\"network_object_cell_modifications\": {\n\t\"network_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\"name\": \"NET_1\",\n\t\t\t\"comment\": \"\",\n\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t}\n\t\t]\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t}\n\t\t]\n\t\t}\n\t\t}\n\t]\n\t}\n\t},\n\t\"destination_modifications\": {\n\t\"network_object_cell_modifications\": {\n\t\"network_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"REMOVE\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\"name\": \"Host123\",\n\t\t\t\"comment\": \"cccHost\",\n\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t}\n\t\t]\n\t\t}\n\t\t}\n\t]\n\t}\n\t},\n\t\"service_modifications\": {\n\t\"service_object_cell_modifications\": {\n\t\"service_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"REMOVE\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\"name\": \"ICMP_1\",\n\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\"type\": {\n\t\t\t\"from\": 55,\n\t\t\t\"to\": 55\n\t\t}\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\"name\": \"TCP_1\",\n\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\"port\": {\n\t\t\t\"from\": 1234,\n\t\t\t\"to\": 1234\n\t\t},\n\t\t\"protocol\": \"TCP\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\"name\": \"UDP_1\",\n\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\"port\": {\n\t\t\t\"from\": 3,\n\t\t\t\"to\": 3\n\t\t},\n\t\t\"protocol\": \"UDP\"\n\t\t}\n\t\t}\n\t\t}\n\t]\n\t}\n\t}\n\t}\n}\n}\n}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/fields","collectionId":"2","id":"2-24-145","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get commands for device from designer results of a specific field id","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"deviceId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
deviceId: Device ID
fieldId: Field ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/designer/device/136/commands

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: Specified field, id: <ID> , name: <NAME>, cannot contain designer result
404: Designer results were not found in the access request.
404: Device with ID <ID> was not found in Designer result.
404: Device with ID <ID> does not support Commands feature.","dataMode":"params","folder":"2-24","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/designer/device/{{deviceId}}/commands","collectionId":"2","id":"2-24-146","method":"GET"},{"headers":"Accept: application/json\n","name":"Returns the details of a specified ticket stages","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps

Response Messages:
403: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found","folder":"2-24","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps","collectionId":"2","id":"2-24-147","method":"GET"},{"headers":"Accept: application/json\n","name":"Returns the results of the Commit action","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"},{"value":null,"type":"text","enabled":true,"key":"managementId"}],"dataMode":"params","description":"GENERAL USE
The report returns the Commit results for the device with the specified management ID and for the devices suggested in the Designer results. The report also includes results for devices that are in the related hierarchy of these devices.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID
managementId: Management ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/designer/commit_report/3
OUTPUT{
    \"commit_report\": {
        \"ticketId\": 27,
        \"statTime\": \"24-Oct-2018 08:55 AM\",
        \"endTime\": \"24-Oct-2018 08:56 AM\",
        \"duration\": \"00:00:30\",
        \"vendorName\": \"PALO ALTO NETWORKS\",
        \"managmentName\": \"pano211\",
        \"devices\": {
            \"device\": [
                {
                    \"name\": \"DG1.1\",
                    \"status\": \"success_with_warnings\",
                    \"warnings\": {
                        \"warning\": \"Commit not performed: This device had no policies to install on its managed firewalls\"
                    },
                    \"policies\": \"\"
                },
                {
                    \"name\": \"DG1\",
                    \"status\": \"success_with_warnings\",
                    \"warnings\": {
                        \"warning\": \"Commit not performed: This device had no policies to install on its managed firewalls\"
                    },
                    \"policies\": \"\"
                }
            ]
        }
    }
}


Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: Specified field, id: <ID> , name: <NAME>, cannot contain designer result
404: Designer results were not found in the request.","folder":"2-24","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/designer/commit_report/{{managementId}}","collectionId":"2","id":"2-24-148","method":"GET"},{"headers":"Accept: application/json\n","name":"Returns the details of a specified field","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"dataMode":"params","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
taskId: The ID number of the task as shown in SecureChange
fieldId: The ID number of the field as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/229

Response Messages:
403: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.
404: Task with ID was not found in Stage ID in ticket ID .
404: Field ID was not found in Task ID in Stage ID in ticket ID .","folder":"2-24","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}","collectionId":"2","id":"2-24-149","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Change a field within a task of a ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"dataMode":"raw","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldDTO
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/2/tasks/4/fields/7742
BODY<field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multiple_selection\">
     <id>7742</id>
     <name>filter type</name>
     <selected_options>
         <selected_option>
             <value>FTP</value>
         </selected_option>
     </selected_options>
</field>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/fields/71
BODY{
    \"rule_modification_field\": {
        \"devices\": {
            \"device\": {
                \"management_id\": 5,
                \"bindings\": {
                    \"binding\": {
                        \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                        \"binding\": {
                            \"@xsi.type\": \"policy__binding\",
                            \"policy_name\": \"FortiGate-VM64-111-10_3\"
                        },
                        \"rules\": {
                            \"rule\": {
                                \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                            }
                        }
                    }
                }
            }
        },
        \"rule_modifications\": {
            \"rule_modification\": {
                \"@xsi.type\": \"modify_rule_modification\",
                \"rule_key\": {
                    \"device_id\": 5,
                    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                    \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                },
                \"source_modifications\": {
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                            \"name\": \"NET_1\",
                                            \"comment\": \"\",
                                            \"ip\": \"3.3.3.3\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                            \"name\": \"RANGE_1\",
                                            \"comment\": \"EXAMPLE_RANGE\",
                                            \"min_ip\": \"3.3.3.3\",
                                            \"max_ip\": \"5.5.5.5\"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                \"destination_modifications\": {
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"name\": \"Host123\",
                                            \"comment\": \"cccHost\",
                                            \"ip\": \"1.2.3.4\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"action\": \"REMOVE\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                    }
                                }
                            }
                        ]
                    }
                },
                \"service_modifications\": {
                    \"service_object_cell_modifications\": {
                        \"service_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                        \"name\": \"TCP_1\",
                                        \"comment\": \"EXAMPLE_TCP\",
                                        \"port\": {
                                            \"from\": 1234,
                                            \"to\": 1234
                                        },
                                        \"protocol\": \"TCP\"
                                    }
                                }
                            },
                            {
                                \"action\": \"REMOVE\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"uid\": \"551556da-22dc-46f4-9253-a7ceee70394b\",
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                        \"name\": \"UDP_1\",
                                        \"comment\": \"EXAMPLE_UDP\",
                                        \"port\": {
                                            \"from\": 3,
                                            \"to\": 3
                                        },
                                        \"protocol\": \"UDP\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                        \"name\": \"ICMP_1\",
                                        \"comment\": \"EXAMPLE_ICMP\",
                                        \"type\": {
                                            \"from\": 55,
                                            \"to\": 55
                                        }
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                    }
                                }
                            }
                        ]
                    }
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket step does not exist, or is not the current step
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: Deleting rule recertification info is not allowed
400: Application Change field cannot be managed via this REST API
400: Rule associated with successfully updated recertification info cannot be removed
400: Rule was already updated
400: Rule does not exist
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: There are multiple objects with this name in the network)
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
403: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: Invalid value for field: <FIELD_NAME> (a valid object comment can have up to <MAX> characters)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value
406: Invalid format detected: <name|binding_uid|rule_uid> - This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags
406: Invalid format detected: name - <VALUE> is invalid. Text must include <1-255> characters
406: Invalid format detected: <rule_uid|binding_uid> - <VALUE> is invalid. Text must include <1-4096> characters
406: Invalid format detected: comment - <VALUE> is invalid. Text must include <0-4096> characters
406: Invalid format detected: name - <VALUE> is invalid. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters + - , _ # @ . : = ! ^ ( )
406: Invalid format detected: <rule_uid|binding_uid|comment> - <VALUE> is invalid. Text includes invalid expressions such as HTML tags or command line operations
406: Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP","folder":"2-24","rawModeData":"{\n\t\"rule_modification_field\": {\n\t\t\"devices\": {\n\t\t\t\"device\": {\n\t\t\t\t\"management_id\": 5,\n\t\t\t\t\"bindings\": {\n\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t\"rule_modifications\": {\n\t\t\t\"rule_modification\": {\n\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t},\n\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"uid\": \"551556da-22dc-46f4-9253-a7ceee70394b\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}","collectionId":"2","id":"2-24-150","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get server clone policy verifier results","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/clone_server_policy/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.
404: Verifier results were not found in the server clone policy request.","dataMode":"params","folder":"2-24","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/clone_server_policy/verifier","collectionId":"2","id":"2-24-151","method":"GET"},{"headers":"Accept: application/json\n","name":"Get designer results according to field id","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"dataMode":"params","description":"Use this API to retrieve designer results generated in R17-2 and later.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/designer

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: Specified field, id: <ID> , name: <NAME>, cannot contain designer result
404: Designer results were not found in the request.","folder":"2-24","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/designer","collectionId":"2","id":"2-24-152","method":"GET"},{"headers":"Accept: application/json\n","name":"Get security zones according to field id","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"dataMode":"params","description":"Use this API to retrieve security zones for multi access result field

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/security_zones

Response Messages:
404: There is no ticket with ID <ID>.
401: Cannot update ticket because it is either closed, rejected or waiting for requester confirmation
400: Task ID <ID> cannot be found in the current step with ID <ID>.
400: You can only update the current step of the ticket. Step ID <ID> does not match the current step ID <ID>.
400: The task with ID <ID> does not contain a field with ID <ID>.
400: The task with ID <ID> does not contain a field of type <ID>.
400: Security zones tool is not enabled for the requested field.
403: You do not have permission to view this task. Contact your administrator for assistance.","folder":"2-24","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/security_zones","collectionId":"2","id":"2-24-153","method":"GET"},{"headers":"Accept: application/json\n","name":"Get access request verifier results","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/multi_access_request/2022/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.
404: Verifier results were not found in the access request.","dataMode":"params","folder":"2-24","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_access_request/{{fieldId}}/verifier","collectionId":"2","id":"2-24-154","method":"GET"},{"headers":"Accept: application/json\n","name":"Returns the details of a specified ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
expand_links: See expanded view of the objects [optional]
showStepsDetails: Include steps' details in the response [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1
OUTPUT {
    \"ticket\": {
        \"id\": 1,
        \"subject\": \"AR-Ticket\",
        \"requester\": \"a\",
        \"requester_id\": 4,
        \"priority\": \"Normal\",
        \"status\": \"In Progress\",
        \"domain_name\": \"\",
        \"sla_status\": \"NA\",
        \"sla_outcome\": \"NA\",
        \"workflow\": {
            \"id\": 11,
            \"name\": \"AR & MG\",
            \"uses_topology\": true
        },
        \"steps\": {
            \"step\": [
                {
                    \"id\": 209,
                    \"name\": \"Open request\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 209,
                            \"assignee_id\": 4,
                            \"assignee\": \"a\",
                            \"status\": \"DONE\",
                            \"fields\": {
                                \"field\": [
                                    {
                                        \"@xsi.type\": \"multi_access_request\",
                                        \"id\": 1695,
                                        \"name\": \"AR\",
                                        \"read_only\": false,
                                        \"access_request\": {
                                            \"id\": 1706,
                                            \"order\": \"AR1\",
                                            \"risk_analysis_result\": {
                                                \"status\": \"not run\"
                                            },
                                            \"verifier_result\": {
                                                \"status\": \"not run\"
                                            },
                                            \"use_topology\": true,
                                            \"targets\": {
                                                \"target\": {
                                                    \"@type\": \"ANY\",
                                                    \"id\": 1705
                                                }
                                            },
                                            \"users\": {
                                                \"user\": [
                                                    \"Any\"
                                                ]
                                            },
                                            \"sources\": {
                                                \"source\": [
                                                    {
                                                        \"@type\": \"INTERNET\",
                                                        \"id\": 1701
                                                    },
                                                    {
                                                        \"@type\": \"DNS\",
                                                        \"id\": 1702,
                                                        \"host_name\": \"www.google.com\",
                                                        \"dns_ip_addresses\": {
                                                            \"ip_address\": \"216.58.214.100\"
                                                        }
                                                    },
                                                    {
                                                        \"@type\": \"IP\",
                                                        \"id\": 1703,
                                                        \"ip_address\": \"1.1.1.1\",
                                                        \"netmask\": \"255.255.255.255\",
                                                        \"nat_ip_address\": \"4.4.4.4\",
                                                        \"nat_netmask\": \"255.255.255.255\"
                                                    }
                                                ]
                                            },
                                            \"destinations\": {
                                                \"destination\": [
                                                    {
                                                        \"@type\": \"ANY\",
                                                        \"id\": 1697
                                                    }
                                                ]
                                            },
                                            \"services\": {
                                                \"service\": [
                                                    {
                                                        \"@type\": \"ANY\",
                                                        \"id\": 1699
                                                    }
                                                ]
                                            },
                                            \"action\": \"Accept\",
                                            \"labels\": \"\"
                                        }
                                    },
                                    {
                                        \"@xsi.type\": \"multi_group_change\",
                                        \"id\": 1707,
                                        \"name\": \"MG\",
                                        \"read_only\": false,
                                        \"implementation_status\": \"NOT_SUPPORTED\"
                                    }
                                ]
                            }
                        }
                    }
                },
                {
                    \"id\": 210,
                    \"name\": \"STEP2 - auto AR with designer /update /commit\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 210,
                            \"assignee_id\": 4,
                            \"assignee\": \"a\",
                            \"status\": \"ASSIGNED\",
                            \"unlicensed_devices_for_automation\": {
                                \"unlicensed_device_for_automation\": [
                                    {
                                        \"id\": \"2\",
                                        \"name\": \"asa\"
                                    }
                                ]
                            }
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"multi_access_request\",
                                    \"id\": 1709,
                                    \"name\": \"AR\",
                                    \"read_only\": false,
                                    \"access_request\": {
                                        \"id\": 1720,
                                        \"order\": \"AR1\",
                                        \"risk_analysis_result\": {
                                            \"status\": \"not run\"
                                        },
                                        \"verifier_result\": {
                                            \"status\": \"not run\"
                                        },
                                        \"use_topology\": true,
                                        \"targets\": {
                                            \"target\": {
                                                \"@type\": \"ANY\",
                                                \"id\": 1719
                                            }
                                        },
                                        \"users\": {
                                            \"user\": [
                                                \"Any\"
                                            ]
                                        },
                                        \"sources\": {
                                            \"source\": [
                                                {
                                                    \"@type\": \"INTERNET\",
                                                    \"id\": 1721
                                                },
                                                {
                                                    \"@type\": \"DNS\",
                                                    \"id\": 1722,
                                                    \"host_name\": \"www.google.com\",
                                                    \"dns_ip_addresses\": {
                                                        \"ip_address\": \"216.58.214.100\"
                                                    }
                                                },
                                                {
                                                    \"@type\": \"IP\",
                                                    \"id\": 1723,
                                                    \"ip_address\": \"1.1.1.1\",
                                                    \"netmask\": \"255.255.255.255\",
                                                    \"nat_ip_address\": \"4.4.4.4\",
                                                    \"nat_netmask\": \"255.255.255.255\"
                                                },
                                                {
                                                    \"@type\": \"RANGE\",
                                                    \"id\": 1724,
                                                    \"range_first_ip\": \"1.1.11.1\",
                                                    \"range_last_ip\": \"1.1.11.10\"
                                                }
                                            ]
                                        },
                                        \"destinations\": {
                                            \"destination\": [
                                                {
                                                    \"@type\": \"ANY\",
                                                    \"id\": 1711
                                                }
                                            ]
                                        },
                                        \"services\": {
                                            \"service\": [
                                                {
                                                    \"@type\": \"ANY\",
                                                    \"id\": 1713
                                                }
                                            ]
                                        },
                                        \"action\": \"Accept\",
                                        \"labels\": \"\"
                                    }
                                }
                            }
                        }
                    }
                }
            ]
        },
        \"current_step\": {
            \"id\": 210,
            \"name\": \"STEP2 - auto AR with designer /update /commit\"
        },
        \"comments\": \"\"
    }
}


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2
OUTPUT {
    \"ticket\": {
        \"id\": 2,
        \"subject\": \"Clone Server Policy Ticket\",
        \"requester\": \"a\",
        \"requester_id\": 12,
        \"priority\": \"Normal\",
        \"status\": \"In Progress\",
        \"referenced_ticket\": {
            \"id\": 1,
            \"name\": \"Ticket Subject Sample\",
            \"link\": {
                \"@href\": \"https://host/securechangeworkflow/api/securechange/tickets/1\"
            }
        },
        \"domain_name\": \"\",
        \"sla_status\": \"NA\",
        \"sla_outcome\": \"NA\",
        \"workflow\": {
            \"id\": 109,
            \"name\": \"sc_12705\",
            \"uses_topology\": false
        },
        \"steps\": {
            \"step\": [
                {
                    \"id\": 78,
                    \"name\": \"Open request\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 78,
                            \"assignee_id\": 12,
                            \"assignee\": \"a\",
                            \"status\": \"DONE\",
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"clone_server_policy_request\",
                                    \"id\": 872,
                                    \"name\": \"Clone Server Policy Field\",
                                    \"from_server\": {
                                        \"@type\": \"IP\",
                                        \"id\": 869,
                                        \"ip_address\": \"1.2.2.2\",
                                        \"cidr\": 32
                                    },
                                    \"to_servers\": {
                                        \"server\": {
                                            \"@type\": \"IP\",
                                            \"id\": 871,
                                            \"ip_address\": \"10.100.23.32\",
                                            \"netmask\": \"255.255.255.255\",
                                            \"cidr\": 32
                                        }
                                    },
                                    \"comment\": \"target servers to clone server policy to\"
                                }
                            }
                        }
                    }
                },
                {
                    \"id\": 79,
                    \"name\": \"Business Approval\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 79,
                            \"assignee_id\": 12,
                            \"assignee\": \"a\",
                            \"status\": \"ASSIGNED\",
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"clone_server_policy_request\",
                                    \"id\": 876,
                                    \"name\": \"Clone Server Policy Field\",
                                    \"from_server\": {
                                        \"@type\": \"IP\",
                                        \"id\": 873,
                                        \"ip_address\": \"1.2.2.2\",
                                        \"cidr\": 32
                                    },
                                    \"to_servers\": {
                                        \"server\": {
                                            \"@type\": \"IP\",
                                            \"id\": 875,
                                            \"ip_address\": \"10.100.23.32\",
                                            \"netmask\": \"255.255.255.255\",
                                            \"cidr\": 32
                                        }
                                    },
                                    \"comment\": \"target servers to clone server policy to\"
                                }
                            }
                        }
                    }
                }
            ]
        },
        \"current_step\": {
            \"id\": 79,
            \"name\": \"Business Approval\"
        },
        \"comments\": \"\"
    }
}


Response Messages:
403: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: No entity found for query","folder":"2-24","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}","collectionId":"2","id":"2-24-155","method":"GET"},{"headers":"Accept: application/json\n","name":"Returns a list of tickets by search parameters","description":"Parameters:
parameter: Free text search parameter (Search syntax details) [optional]
start: Offset the count starting point [optional]
count: Tickets list max length (max value is 1000) [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/free_text_search/?parameter=taskstatus:ASSIGNED AND priority:High

Response Messages:
400: Can not fetch more than 1000 tickets in 1 time
403: Access is denied.
404: Illegal ticket status entered. Permitted values are: IN_PROGRESS, REJECTED, CLOSED, CANCELLED, RESOLVED
404: Illegal ticket SLA status entered. Permitted values are: NA, OK, WARNING, ALERT, ESCALATION
404: Illegal ticket priority entered. Permitted values are: LOW, NORMAL, HIGH, CRITICAL
400: Illegal count value entered. Max value is 1000
404: Illegal ticket expiration date entered. Permitted date format is: ddMMyyyy (ex. 20.11.2001)
404: No entity found for query","folder":"2-24","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/free_text_search","collectionId":"2","id":"2-24-156","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Change a task of a ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"raw","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: ticketTaskDTO
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/2/tasks/4
BODY<task>
     <status>ASSIGNED</status>
     <fields>
         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_group_change\">
             <id>7599</id>
             <name>mf</name>
             <read_only>false</read_only>
             <implementation_status>NOT_STARTED</implementation_status>
             <group_change>
                        <name>ggg</name>
                        <st_uid>{A12AE330-0DBD-11E5-B841-7F0000010E0E}</st_uid>
                        <management_id>42</management_id>
                        <management_name>cp239</management_name>
                        <members>
                             <member type=\"Object\">
                                 <id>8</id>
                                 <name>yaakovs_host</name>
                                 <st_uid>{BDAA378C-C90B-4D12-B598-1AFED2D1DA14}</st_uid>
                                 <object_type>Host</object_type>
                                 <object_details>1.1.1.1/255.255.255.255</object_details>
                         <management_id>42</management_id>
                         <management_name>cp239</management_name>
                                 <status>NOT_CHANGED</status>
                             </member>
                             <member type=\"Object\">
                                 <id>9</id>
                                    <name>Avi_10.100.120.254</name>
                                    <st_uid>{8F195CDC-F426-47B6-9E8A-1FF14C17E54F}</st_uid>
                                     <object_type>Host</object_type>
                                     <object_details>10.100.120.254/255.255.255.255</object_details>
                                     <management_id>42</management_id>
                                     <management_name>cp239</management_name>
                                     <status>NOT_CHANGED</status>
                                 </member>
                                 <member type=\"HOST\">
                                     <id>10</id>
                                     <name>h22</name>
                                     <object_type>Host</object_type>
                                     <object_details>2.2.2.2/255.255.255.255</object_details>
                                     <status>ADDED</status>
                                     <comment/>
                                 </member>
                                 <member type=\"HOST\">
                                     <id>10</id>
                                     <name>h22</name>
                                     <object_type>Host</object_type>
                                     <object_details>3.3.3.3/255.255.255.255</object_details>
                                     <status>ADDED</status>
                                     <comment/>
                                 </member>
                 </members>
                 <change_implementation_status>NOT_RUN</change_implementation_status>
                    </group_change>
            </field>
     </fields>
</task>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4
BODY{
    \"task\": {
        \"status\": \"ASSIGNED\",
        \"fields\": {
            \"field\": {
                \"@xsi.type\": \"rule_modification_field\",
                \"id\": 743,
                \"devices\": {
                    \"device\": {
                        \"revision_id\": 24,
                        \"management_id\": 5,
                        \"bindings\": {
                            \"binding\": {
                                \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                                \"binding\": {
                                    \"@xsi.type\": \"policy__binding\",
                                    \"policy_name\": \"FortiGate-VM64-111-10_3\"
                                },
                                \"rules\": {
                                    \"rule\": {
                                        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                        \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                                    }
                                }
                            }
                        }
                    }
                },
                \"rule_modifications\": {
                    \"rule_modification\": {
                        \"@xsi.type\": \"modify_rule_modification\",
                        \"rule_key\": {
                            \"device_id\": 5,
                            \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                            \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                        },
                        \"source_modifications\": {
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                    \"name\": \"RANGE_1\",
                                                    \"comment\": \"EXAMPLE_RANGE\",
                                                    \"min_ip\": \"3.3.3.3\",
                                                    \"max_ip\": \"5.5.5.5\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                    \"name\": \"NET_1\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"3.3.3.3\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        },
                        \"destination_modifications\": {
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                    \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"name\": \"Host123\",
                                                    \"comment\": \"cccHost\",
                                                    \"ip\": \"1.2.3.4\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"REMOVE\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                            }
                                        }
                                    }
                                ]
                            }
                        },
                        \"service_modifications\": {
                            \"service_object_cell_modifications\": {
                                \"service_object_cell_modification\": [
                                    {
                                        \"action\": \"REMOVE\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                                \"name\": \"ICMP_1\",
                                                \"comment\": \"EXAMPLE_ICMP\",
                                                \"type\": {
                                                    \"from\": 55,
                                                    \"to\": 55
                                                }
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                \"name\": \"TCP_1\",
                                                \"comment\": \"EXAMPLE_TCP\",
                                                \"port\": {
                                                    \"from\": 1234,
                                                    \"to\": 1234
                                                },
                                                \"protocol\": \"TCP\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                \"name\": \"UDP_1\",
                                                \"comment\": \"EXAMPLE_UDP\",
                                                \"port\": {
                                                    \"from\": 3,
                                                    \"to\": 3
                                                },
                                                \"protocol\": \"UDP\"
                                            }
                                        }
                                    }
                                ]
                            }
                        }
                    }
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket step does not exist, or is not the current step
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Task status does not exist.
400: Task status is not set to ASSIGNED or DONE.
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: There are multiple objects with this name in the network)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
403: You do not have permission to update this task. Contact your administrator for assistance.
403: Task can not be done because there are unlicensed devices for change automation
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: Invalid value for field: <FIELD_NAME> (a valid object comment can have up to <MAX> characters)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value
406: Invalid format detected: <name|binding_uid|rule_uid> - This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags
406: Invalid format detected: name - <VALUE> is invalid. Text must include <1-255> characters
406: Invalid format detected: <rule_uid|binding_uid> - <VALUE> is invalid. Text must include <1-4096> characters
406: Invalid format detected: comment - <VALUE> is invalid. Text must include <0-4096> characters
406: Invalid format detected: name - <VALUE> is invalid. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters + - , _ # @ . : = ! ^ ( )
406: Invalid format detected: <rule_uid|binding_uid|comment> - <VALUE> is invalid. Text includes invalid expressions such as HTML tags or command line operations
406: Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP","folder":"2-24","rawModeData":"{\n\t\"task\": {\n\t\t\"status\": \"ASSIGNED\",\n\t\t\"fields\": {\n\t\t\t\"field\": {\n\t\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\t\"id\": 743,\n\t\t\t\t\"devices\": {\n\t\t\t\t\t\"device\": {\n\t\t\t\t\t\t\"revision_id\": 24,\n\t\t\t\t\t\t\"management_id\": 5,\n\t\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"rule_modifications\": {\n\t\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}","collectionId":"2","id":"2-24-157","method":"PUT"},{"headers":"Accept: application/json\n","name":"Returns the details of a specified task","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"params","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
taskId: The ID number of the task as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2?expand_links=true

Response Messages:
403: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.
404: Task with ID was not found in Stage ID in ticket ID .","folder":"2-24","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}","collectionId":"2","id":"2-24-158","method":"GET"}],"order":[],"name":"Tufin Tufin SecureChange/SecureApp R20-2-HF2","id":"2","description":"Tufin Orchestration Suite - Tufin SecureChange/SecureApp APIs.
For detailed information about the APIs please see the documentation at:
https://your-securetrack-server/securechangeworkflow/apidoc"} \ No newline at end of file diff --git a/Postman Format v1/R20-2 postman collection/securetrack_R20-2-HF2.json b/Postman Format v1/R20-2 postman collection/securetrack_R20-2-HF2.json new file mode 100644 index 0000000..298bbfd --- /dev/null +++ b/Postman Format v1/R20-2 postman collection/securetrack_R20-2-HF2.json @@ -0,0 +1 @@ +{"folders":[{"order":["1-1-1","1-1-2","1-1-3","1-1-4"],"collectionId":"1","name":"Additional Policy Fields","hasRequests":true,"id":"1-1"},{"order":["1-2-5","1-2-6","1-2-7","1-2-8"],"collectionId":"1","name":"Application IDs","hasRequests":true,"id":"1-2"},{"order":["1-3-9","1-3-10"],"collectionId":"1","name":"Change Authorization","hasRequests":true,"id":"1-3"},{"order":["1-4-11","1-4-12","1-4-13"],"collectionId":"1","name":"Change Windows","hasRequests":true,"id":"1-4"},{"order":["1-5-14","1-5-15","1-5-16","1-5-17","1-5-18"],"collectionId":"1","name":"Device Interfaces and Zones","hasRequests":true,"id":"1-5"},{"order":["1-6-19","1-6-20","1-6-21","1-6-22"],"collectionId":"1","name":"Domains","hasRequests":true,"id":"1-6"},{"order":["1-7-23"],"collectionId":"1","name":"General Properties","hasRequests":true,"id":"1-7"},{"order":["1-8-24","1-8-25","1-8-26","1-8-27"],"collectionId":"1","name":"IPsec VPN","hasRequests":true,"id":"1-8"},{"order":["1-9-28","1-9-29","1-9-30","1-9-31","1-9-32"],"collectionId":"1","name":"Internet Objects","hasRequests":true,"id":"1-9"},{"order":["1-10-33","1-10-34","1-10-35","1-10-36"],"collectionId":"1","name":"LDAP","hasRequests":true,"id":"1-10"},{"order":["1-11-37","1-11-38","1-11-39","1-11-40","1-11-41","1-11-42","1-11-43","1-11-44","1-11-45","1-11-46","1-11-47"],"collectionId":"1","name":"Monitored Devices","hasRequests":true,"id":"1-11"},{"order":["1-12-48","1-12-49","1-12-50"],"collectionId":"1","name":"NAT Policies","hasRequests":true,"id":"1-12"},{"order":["1-13-51","1-13-52","1-13-53","1-13-54","1-13-55","1-13-56","1-13-57"],"collectionId":"1","name":"Network Objects","hasRequests":true,"id":"1-13"},{"order":["1-14-58","1-14-59","1-14-60","1-14-61","1-14-62","1-14-63","1-14-64","1-14-65","1-14-66","1-14-67","1-14-68","1-14-69","1-14-70","1-14-71","1-14-72","1-14-73","1-14-74","1-14-75","1-14-76","1-14-77","1-14-78","1-14-79","1-14-80","1-14-81","1-14-82","1-14-83","1-14-84","1-14-85","1-14-86","1-14-87","1-14-88","1-14-89","1-14-90","1-14-91","1-14-92","1-14-93","1-14-94","1-14-95","1-14-96","1-14-97","1-14-98","1-14-99","1-14-100","1-14-101","1-14-102","1-14-103","1-14-104","1-14-105","1-14-106","1-14-107","1-14-108","1-14-109","1-14-110","1-14-111","1-14-112","1-14-113","1-14-114","1-14-115"],"collectionId":"1","name":"Network Topology","hasRequests":true,"id":"1-14"},{"order":["1-15-116","1-15-117","1-15-118"],"collectionId":"1","name":"Network Zone Manager - Patterns","hasRequests":true,"id":"1-15"},{"order":["1-16-119","1-16-120","1-16-121","1-16-122","1-16-123","1-16-124","1-16-125"],"collectionId":"1","name":"Network Zone Manager - Subnets","hasRequests":true,"id":"1-16"},{"order":["1-17-126","1-17-127","1-17-128","1-17-129","1-17-130","1-17-131","1-17-132","1-17-133","1-17-134","1-17-135","1-17-136","1-17-137","1-17-138","1-17-139","1-17-140","1-17-141"],"collectionId":"1","name":"Network Zone Manager - Zones","hasRequests":true,"id":"1-17"},{"order":["1-18-142","1-18-143","1-18-144","1-18-145","1-18-146","1-18-147"],"collectionId":"1","name":"Policies and Sub-Policies","hasRequests":true,"id":"1-18"},{"order":["1-19-148"],"collectionId":"1","name":"Policy Analysis","hasRequests":true,"id":"1-19"},{"order":["1-20-149","1-20-150","1-20-151","1-20-152","1-20-153","1-20-154"],"collectionId":"1","name":"Policy Browser (formerly Rule Documentation)","hasRequests":true,"id":"1-20"},{"order":["1-21-155","1-21-156","1-21-157","1-21-158","1-21-159","1-21-160","1-21-161","1-21-162"],"collectionId":"1","name":"Policy Optimization","hasRequests":true,"id":"1-21"},{"order":["1-22-163","1-22-164","1-22-165"],"collectionId":"1","name":"Revisions","hasRequests":true,"id":"1-22"},{"order":["1-23-166","1-23-167"],"collectionId":"1","name":"Rule Usage","hasRequests":true,"id":"1-23"},{"order":["1-24-168","1-24-169","1-24-170","1-24-171","1-24-172","1-24-173","1-24-174","1-24-175"],"collectionId":"1","name":"Security Rules","hasRequests":true,"id":"1-24"},{"order":["1-25-176","1-25-177","1-25-178","1-25-179","1-25-180","1-25-181","1-25-182"],"collectionId":"1","name":"Services and Ports","hasRequests":true,"id":"1-25"},{"order":["1-26-183","1-26-184","1-26-185"],"collectionId":"1","name":"Time Objects","hasRequests":true,"id":"1-26"},{"order":["1-27-186"],"collectionId":"1","name":"Traffic Policy Matcher","hasRequests":true,"id":"1-27"},{"order":["1-28-187","1-28-188","1-28-189","1-28-190","1-28-191"],"collectionId":"1","name":"Unified Security Policy - Access Request Violations","hasRequests":true,"id":"1-28"},{"order":["1-29-192","1-29-193","1-29-194","1-29-195","1-29-196"],"collectionId":"1","name":"Unified Security Policy - Alerts","hasRequests":true,"id":"1-29"},{"order":["1-30-197","1-30-198","1-30-199","1-30-200","1-30-201","1-30-202","1-30-203","1-30-204"],"collectionId":"1","name":"Unified Security Policy - Cloud Tag Policy","hasRequests":true,"id":"1-30"},{"order":["1-31-205","1-31-206","1-31-207","1-31-208","1-31-209","1-31-210","1-31-211","1-31-212"],"collectionId":"1","name":"Unified Security Policy - Exceptions","hasRequests":true,"id":"1-31"},{"order":["1-32-213","1-32-214","1-32-215","1-32-216","1-32-217","1-32-218"],"collectionId":"1","name":"Unified Security Policy - Security Zone Matrix","hasRequests":true,"id":"1-32"},{"order":["1-33-219","1-33-220"],"collectionId":"1","name":"Unified Security Policy - Violations","hasRequests":true,"id":"1-33"}],"requests":[{"headers":"Accept: application/json\n","name":"Get all URL Categories by revision.","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"}],"dataMode":"params","description":"Fetches list of URL Categories defined in a revision given by ID.
This API is supported for Panorama in advanced mode and Panorama Device Groups.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/762/url_categories
","folder":"1-1","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/url_categories","collectionId":"1","id":"1-1-1","method":"GET"},{"headers":"Accept: application/json\n","name":"Get additional parameters identities by revision","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"}],"dataMode":"params","description":"Some firewall vendors use special fields in their security policy.
For example: Palo Alto uses Tags, Security Profiles and Log Profiles and Fortinet uses NAT Pools and other NAT configurations.
SecureTrack refers to these fields as “Additional Parameters”.
The additional parameters API retrieves the possible values of these fields.
This API is currently supported for Palo Alto Networks firewalls and Fortinet devices managed by Fortimanager.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
type: Additional parameter type [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/162/additional_parameters?type=security_profile_group

Response Messages:
200: Successful
400: Invalid request","folder":"1-1","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/additional_parameters","collectionId":"1","id":"1-1-2","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific additional parameter identity","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Some firewall vendors use special fields in their security policy.
For example: Palo Alto uses Tags, Security Profiles and Log Profiles and Fortinet uses NAT Pools and other NAT configurations.
SecureTrack refers to these fields as “Additional Parameters”.
The additional parameters API retrieves the possible values of these fields.
This API is currently supported for Palo Alto Networks firewalls and Fortinet devices managed by Fortimanager.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Additional parameter IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/revisions/162/additional_parameters/242767,242768,242760
","folder":"1-1","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/additional_parameters/{{ids}}","collectionId":"1","id":"1-1-3","method":"GET"},{"headers":"Accept: application/json\n","name":"Get a URL Category.","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches one or more URL Categories.
This API is supported for Panorama in advanced mode and Panorama Device Groups.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Url Category IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/revisions/762/url_categories/242767,242768,242760
","folder":"1-1","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/url_categories/{{ids}}","collectionId":"1","id":"1-1-4","method":"GET"},{"headers":"Accept: application/json\n","name":"Get applications identities by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of applications defined in a revision given by ID.
This API is currently supported for Palo Alto Networks firewalls.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.
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.


Parameters:
context: Global MSSP context [optional]
id: Revision id
start: Starting page for query allowable value is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/762/applications?get_total=true
OUTPUT {
    \"applications\": {
        \"count\": 1,
        \"total\": 100,
        \"application\": [{
            \"@xsi.type\": \"singleApplicationDTO\",
            \"id\": 2095027,
            \"name\": \"any\",
            \"display_name\": \"any\",
            \"class_name\": \"application_object\",
            \"comment\": \"\",
            \"uid\": \"{61B7771C-8B0B-90D6-ED55-B6698691BEED}\",
            \"overrides\": false,
            \"service\": {
                \"id\": 5048925,
                \"uid\": \"{4BC8F8B5-7671-A61B-5DD2-8CA235955162}\",
                \"display_name\": \"any\",
                \"name\": \"any\"
            }
        }]
    }
}

","folder":"1-2","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/applications","collectionId":"1","id":"1-2-5","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific application identity","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches one or more applications defined by a revision ID and Application Id or comma separated applications ids list.
This API is currently supported for Palo Alto Networks firewalls.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.


Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Application IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/revisions/762/applications/242767,242768,242760
","folder":"1-2","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/applications/{{ids}}","collectionId":"1","id":"1-2-6","method":"GET"},{"headers":"Accept: application/json\n","name":"Get application identities by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of applications defined on device given by ID.
This API is currently supported for Palo Alto Networks firewalls.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.
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.


Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable values are numeric [optional]
count: Number of pages for query allowable values are numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/applications?get_total=true
OUTPUT {
    \"applications\": {
        \"count\": 50,
        \"total\": 100,
        \"application\": [{
            \"@xsi.type\": \"singleApplicationDTO\",
            \"id\": 2095027,
            \"name\": \"any\",
            \"display_name\": \"any\",
            \"class_name\": \"application_object\",
            \"comment\": \"\",
            \"uid\": \"{61B7771C-8B0B-90D6-ED55-B6698691BEED}\",
            \"overrides\": false,
            \"service\": {
                \"id\": 5048925,
                \"uid\": \"{4BC8F8B5-7671-A61B-5DD2-8CA235955162}\",
                \"display_name\": \"any\",
                \"name\": \"any\"
            }
        }]
    }
}

","folder":"1-2","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/applications","collectionId":"1","id":"1-2-7","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific application identity","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches one or more applications defined by a device ID and Application Id or comma separated applications ids list.
This API is currently supported for Palo Alto Networks firewalls.
Note: This API retrieves the information from the latest revision.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.


Parameters:
context: Global MSSP context [optional]
id: Device ID
ids: Application IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/devices/1/applications/701
","folder":"1-2","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/applications/{{ids}}","collectionId":"1","id":"1-2-8","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Compare revisions on two different devices in terms of traffic.","dataMode":"raw","description":"This API compares two arbitrary revisions from any devices. The comparison will be done in terms of allowed/denied traffic.
The API returns authorized if and only if there are no differences between the traffic allowed/denied by the rules in the two revisions.
The API returns unauthorized if there is at least one difference in terms of allowed/denied traffic between the two revisions.
Note 1: To map policies from one revision to the other use oldId2newIdMap and provide the UIDs of the policies to be compared.
Note 2: Parameter in the request body specifies if the result will return traffic difference details for all incompatible rules
Note 3: The format of the result is the same as the one returned by /change_authorization
Note 4: The API accepts in request body only one pair of oldId - newId map
Note 5: The request is valid only if the mapping ids are found in the active policies

Parameters:
body: Request parameter containing the versions of the revisions to be compared and the policy mapping between the revisions.

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_authorization/policyTrafficComparison
BODY{
    \"policy_traffic_comparison_request\": {
        \"oldVersionId\": \"234\",
        \"newVersionId\": \"179\",
        \"oldId2newIdMap\": [
            {
                \"oldId\": \"{037DEA62-A8D2-46F5-8DC9-DA404A60B96F}\",
                \"newId\" : \"{00-FACED0-00}\"
            }
        ],
        \"withTraffic\": true
    }
}


Response Messages:
200: Policies diff was successfully calculated
400: Could not find the requested revisions for comparison","folder":"1-3","rawModeData":"{\n\t\"policy_traffic_comparison_request\": {\n\t\t\"oldVersionId\": \"234\",\n\t\t\"newVersionId\": \"179\",\n\t\t\"oldId2newIdMap\": [\n\t\t\t{\n\t\t\t\t\"oldId\": \"{037DEA62-A8D2-46F5-8DC9-DA404A60B96F}\",\n\t\t\t\t\"newId\" : \"{00-FACED0-00}\"\n\t\t\t}\n\t\t],\n\t\t\"withTraffic\": true\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/change_authorization/policyTrafficComparison","collectionId":"1","id":"1-3-9","method":"POST"},{"headers":"Accept: application/json\n","name":"Determine if changes between two revisions are authorized","data":[{"value":null,"type":"text","enabled":true,"key":"new_version"},{"value":null,"type":"text","enabled":true,"key":"old_version"}],"dataMode":"params","description":"This API checks for unauthorized changes between any two versions of a firewall policy.
The API returns authorized if and only if all traffic changes between the two versions were authorized by SecureChange tickets.
The API returns unauthorized if there is at least one change that cannot be matched to a SecureChange ticket.

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).
The API returns the authorization status, the relevant tickets in SecureChange and the rules that implement unauthorized access changes.

Note 1: To use this API you must enable “Authorize Revisions with Tickets” in SecureTrack/Configuration/Ticketing.
Note 2: Use the ID returned by the /revisions API for new_version and old_version.
Note 3: The default value for traffic_details and ignore_tickets is false.
Note 4: Traffic that is handled by an implicit rule will not have a rule ID.

Parameters:
new_version: New version ID
old_version: Old version ID
traffic_details: Return unauthorized traffic change details for all modified rules [optional]
ignore_tickets: Ignore SecureChange tickets and consider all traffic changes unauthorized [optional]

Usage Example
https://192.168.1.1/securetrack/api/change_authorization?old_version=1&new_version=2

Usage Example
https://192.168.1.1/securetrack/api/change_authorization?old_version=1&new_version=2&traffic_details=true&ignore_tickets=true

Response Messages:
200: Change authorization has been successfully calculated
400: Input parameters are not valid
400: Could not find the requested revisions for comparison","folder":"1-3","url":"https://{{SecureTrack_IP}}/securetrack/api/change_authorization/","collectionId":"1","id":"1-3-10","method":"GET"},{"headers":"Accept: application/json\n","name":"Get scheduling and device details for a specific change window","data":[{"value":null,"type":"text","enabled":true,"key":"uid"},{"value":null,"type":"text","enabled":true,"key":"task_id"}],"dataMode":"params","description":"Retrieves scheduling and device details for a specific change window.

Parameters:
context: Global MSSP context [optional]
uid: Change window uuid
task_id: Task Id

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_windows/fc7b167c-29ea-49a1-9ee3-efb6d1351343/tasks/1
OUTPUT {
    \"commit_task\": {
        \"id\": 1,
        \"start_date\": \"04-Nov-2018 01:30:00PM +0200\",
        \"end_date\": \"04-Nov-2018 01:32:01PM +0200\",
        \"errors\": \"\",
        \"device_commits\": {
            \"device_commit\": [
                {
                    \"id\": 1,
                    \"result\": {
                        \"errors\": {
                            \"error\": \"got_error_from_dcs\"
                        },
                        \"device\": {
                            \"id\": 17,
                            \"status\": \"FAILURE\",
                            \"revision_id\": 1,
                            \"errors\": {
                                \"error\": \"Login error\"
                            }
                        }
                    }
                },
                {
                    \"id\": 2,
                    \"result\": {
                        \"errors\": \"\",
                        \"device\": {
                            \"id\": 19,
                            \"status\": \"SUCCESS_WITH_WARNINGS\",
                            \"revision_id\": 1,
                            \"warnings\": {
                                \"warning\": \"Commit not performed: This device had no policies to install on its managed firewalls\"
                            }
                        }
                    }
                }
            ]
        }
    }
}


Response Messages:
200: OK
400: For correct pagination provide a value for the start and count parameters
400: Start parameter must be a non-negative value
400: Count parameter must be a positive value
403: Not permitted to access this context
404: Change window with uuid was not found
404: Change window with uuid was not found in domain
404: Fail to find task for change window ","folder":"1-4","url":"https://{{SecureTrack_IP}}/securetrack/api/change_windows/{{uid}}/tasks/{{task_id}}","collectionId":"1","id":"1-4-11","method":"GET"},{"headers":"Accept: application/json\n","name":"Get a list of completed policy changes for a specific change window","data":[{"value":null,"type":"text","enabled":true,"key":"uid"}],"dataMode":"params","description":"Retrieves a list of completed policy changes for a specific change window.
For valid pagination, both start and count should be provided. Otherwise, pagination is turned off.
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.


Parameters:
context: Global MSSP context [optional]
uid: Change window uuid
start: Starting result for query allowable value is numeric [optional]
count: Number of tasks for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_windows/fc7b167c-29ea-49a1-9ee3-efb6d1351343/tasks?start=0&count=50&get_total=true
OUTPUT {
    \"commit_tasks\": {
        \"count\": 1,
        \"total\": 1,
        \"commit_task\": {
            \"id\": 1,
            \"start_date\": \"04-Nov-2018 01:30:00PM +0200\",
            \"end_date\": \"04-Nov-2018 01:32:01PM +0200\",
            \"errors\": \"\"
        }
    }
}


Response Messages:
200: OK
400: For correct pagination provide a value for the start and count parameters
400: Start parameter must be a non-negative value
400: Count parameter must be a positive value
403: Not permitted to access this context
404: Change window with uuid was not found
404: Change window with uuid was not found in domain ","folder":"1-4","url":"https://{{SecureTrack_IP}}/securetrack/api/change_windows/{{uid}}/tasks","collectionId":"1","id":"1-4-12","method":"GET"},{"headers":"Accept: application/json\n","name":"Get name and status for all change windows","description":"Retrieves a list of all change windows.
For valid pagination, both start and count should be provided. Otherwise, pagination is turned off.
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.


Parameters:
context: Global MSSP context [optional]
start: Starting result for query allowable value is numeric [optional]
count: Number of change windows for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_windows?start=0&count=50&get_total=true
OUTPUT {
    \"change_windows\": {
        \"count\": 2,
        \"total\": 2,
        \"change_window\": [
            {
                \"uuid\": \"6ae41504-a95c-4f23-98a2-f18b2efadb9d\",
                \"name\": \"cw1\",
                \"domain_id\": 1,
                \"enabled\": true
            },
            {
                \"uuid\": \"fc7b167c-29ea-49a1-9ee3-efb6d1351343\",
                \"name\": \"cw2\",
                \"domain_id\": 1,
                \"enabled\": true
            }
        ]
    }
}


Response Messages:
200: OK
400: For correct pagination provide a value for the start and count parameters
400: Start parameter must be a non-negative value
400: Count parameter must be a positive value
403: Not permitted to access this context ","folder":"1-4","url":"https://{{SecureTrack_IP}}/securetrack/api/change_windows/","collectionId":"1","id":"1-4-13","method":"GET"},{"headers":"Accept: application/json\n","name":"Get device zones by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns a list of the zones for the specified Juniper, Stonesoft, Fortinet or Palo Alto Networks device.
Note: this API returns device zones, not Tufin zones.

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/104/zones
","folder":"1-5","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/zones","collectionId":"1","id":"1-5-14","method":"GET"},{"headers":"Accept: application/json\n","name":"Get device zones by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns a list of the zones for the specified Juniper, Stonesoft, Fortinet or Palo Alto Networks revision.
Note: this API returns device zones, not Tufin zones.

Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/787/zones
","folder":"1-5","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/zones","collectionId":"1","id":"1-5-15","method":"GET"},{"headers":"Accept: application/json\n","name":"Get network interfaces by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Reflects static data from the running-config.
For dynamic information see the /topology_interfaces API.
This API is not applicable for Check Point.

Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/227/interfaces
","folder":"1-5","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/interfaces","collectionId":"1","id":"1-5-16","method":"GET"},{"headers":"Accept: application/json\n","name":"Get zones and network interfaces that participate in sub-policies","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/104/bindable_objects
","dataMode":"params","folder":"1-5","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/bindable_objects","collectionId":"1","id":"1-5-17","method":"GET"},{"headers":"Accept: application/json\n","name":"Get network interfaces by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Reflects static data from the running-config.
For dynamic information see the /topology_interfaces API.
This API is not applicable for Check Point.

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/10/interfaces
","folder":"1-5","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/interfaces","collectionId":"1","id":"1-5-18","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Add a domain","dataMode":"raw","description":"Parameters:
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/domains
BODY{
    \"domain\": {
        \"name\": \"domain1\",
        \"address\": \"address\",
        \"description\": \"description\"
    }
}


Response Messages:
403: User not permitted to access domains
400: Domain with this name already exists
400: Domain name is empty","folder":"1-6","rawModeData":"{\n\t\"domain\": {\n\t\t\"name\": \"domain1\",\n\t\t\"address\": \"address\",\n\t\t\"description\": \"description\"\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/domains/","collectionId":"1","id":"1-6-19","method":"POST"},{"headers":"Accept: application/json\n","name":"Get all domains","description":"

Usage Example
https://192.168.1.1/securetrack/api/domains

Response Messages:
403: User not permitted to access domains","folder":"1-6","url":"https://{{SecureTrack_IP}}/securetrack/api/domains/","collectionId":"1","id":"1-6-20","method":"GET"},{"headers":"Accept: application/json\n","name":"Get domain","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
context: Global MSSP context [optional]
id: Domain id

Usage Example
https://192.168.1.1/securetrack/api/domains/1

Response Messages:
403: User not permitted to access domains
400: Domain with ID was not found","dataMode":"params","folder":"1-6","url":"https://{{SecureTrack_IP}}/securetrack/api/domains/{{id}}","collectionId":"1","id":"1-6-21","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Update a domain","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
id: Domain id
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/domains/2
BODY{
    \"domain\": {
        \"name\": \"edited name\",
        \"address\": \"edited address\",
        \"description\": \"edited description\"
    }
}


Response Messages:
403: User not permitted to access domains
400: Domain with ID was not found
400: Domain with this name already exists
400: Domain name is empty
400: Default domain cannot be changed","dataMode":"raw","folder":"1-6","rawModeData":"{\n\t\"domain\": {\n\t\t\"name\": \"edited name\",\n\t\t\"address\": \"edited address\",\n\t\t\"description\": \"edited description\"\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/domains/{{id}}","collectionId":"1","id":"1-6-22","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get general properties","description":"This API requires 'Super admin' privileges



Usage Example
URLhttps://192.168.1.1/securetrack/api/properties
OUTPUT{
    \"properties\": {
        \"sc_addresses\": {
            \"sc_address\": [
                {
                    \"ip_address\": \"127.0.0.1\",
                    \"type\": \"external\"
                },
                {
                    \"ip_address\": \"127.0.0.1\",
                    \"type\": \"internal\"
                }
            ]
        }
    }
}


Response Messages:
403: User not permitted to view properties","folder":"1-7","url":"https://{{SecureTrack_IP}}/securetrack/api/properties/","collectionId":"1","id":"1-7-23","method":"GET"},{"headers":"Accept: application/json\n","name":"Get Check Point VPN (IPSec) communities and gateways","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"}],"dataMode":"params","description":"Get Check Point VPN (IPSec) Communities and gateways that partcipant in those communities.
Works on clusters and gateways, not on management servers.

Parameters:
device_id: The unique identifier of target device

Usage Example
https://192.168.1.1/securetrack/api/bindings/20/ipsec_communities
","folder":"1-8","url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/ipsec_communities","collectionId":"1","id":"1-8-24","method":"GET"},{"headers":"Accept: application/json\n","name":"Get Cisco IPsec policy and peers","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"outputInterfaceName"}],"dataMode":"params","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.
You can retrieve the interface names by calling the /devices/id/interfaces API.

Parameters:
device_id: The unique identifier of target device
outputInterfaceName: Interface name

Usage Example
https://192.168.1.1/securetrack/api/bindings/32/ipsec_tunnels?outputInterfaceName=GigabitEthernet1
","folder":"1-8","url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/ipsec_tunnels","collectionId":"1","id":"1-8-25","method":"GET"},{"headers":"Accept: application/json\n","name":"Get Cisco cryptographic maps by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://191.168.1.1/securetrack/api/revisions/18/crypto_maps
","dataMode":"params","folder":"1-8","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/crypto_maps","collectionId":"1","id":"1-8-26","method":"GET"},{"headers":"Accept: application/json\n","name":"Get Cisco cryptographic maps by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/19/crypto_maps
","dataMode":"params","folder":"1-8","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/crypto_maps","collectionId":"1","id":"1-8-27","method":"GET"},{"name":"Get resolved Internet representation for device","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"}],"dataMode":"params","description":"The order of precedence used to resolve the Internet object is:
Step 1: Identify the Internet referral:
Search for a defined Internet referral on the specified device.
If it is not found on the device, search the parent and grandparents (up the device tree) for a defined Internet referral.
If a defined Internet referral is found, then match the name in the Internet referral to a network object, as defined in Step 2.
If an Internet referral is not found, it resolves to “Any”.
Step 2: Resolve the object by name:
Search the specified device for a defined network object that matches the name returned in Step 1.
If a matching network object is not found, an error will be returned.

Parameters:
deviceId: SecureTrack Device ID

Usage Example
https://192.168.1.1/securetrack/api/internet_referral/2/object

Response Messages:
200: Resolved Internet referral object for device is returned
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
404: Configured object was not found on the device
403: Access is denied.","folder":"1-9","url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}/object","collectionId":"1","id":"1-9-28","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Update Internet representation for device","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"}],"dataMode":"raw","description":"Updates the Internet referral configuration for the device.
If there was no previous configuration, it will be created.

Parameters:
deviceId: SecureTrack Device ID
body: Internet referral configuration

Usage Example
URLhttps://192.168.1.1/securetrack/api/internet_referral
BODY{
    \"internet_referral\": {
        \"@xsi.type\": \"internetReferralObjectNameDTO\",
        \"device_id\": 2,
        \"object_name\": \"Host_10.11.73.1\"
    }
}


Response Messages:
200: Internet referral configuration was updated
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
400: Internet referral configuration was malformed
403: Access is denied.","folder":"1-9","rawModeData":"{\n\t\"internet_referral\": {\n\t\t\"@xsi.type\": \"internetReferralObjectNameDTO\",\n\t\t\"device_id\": 2,\n\t\t\"object_name\": \"Host_10.11.73.1\"\n\t}\n}\n","url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}","collectionId":"1","id":"1-9-29","method":"PUT"},{"name":"Get Internet representation for device","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"}],"description":"Parameters:
deviceId: SecureTrack Device ID

Usage Example
https://192.168.1.1/securetrack/api/internet_referral/2

Response Messages:
200: Internet referral configuration is returned
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
404: Internet referral configuration was not found for device ID
403: Access is denied.","dataMode":"params","folder":"1-9","url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}","collectionId":"1","id":"1-9-30","method":"GET"},{"name":"Delete Internet representation for device","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"}],"description":"Parameters:
deviceId: SecureTrack Device ID

Usage Example
https://192.168.1.1/securetrack/api/internet_referral/2

Response Messages:
200: Internet referral configuration was deleted
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
400: Internet referral configuration for device ID does not exist
403: Access is denied.","dataMode":"params","folder":"1-9","url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}","collectionId":"1","id":"1-9-31","method":"DELETE"},{"headers":"Content-Type: application/json\n","name":"Create new Internet representation for a device","dataMode":"raw","description":"The internet referral lets you represent the Internet as an object on a device.
See REST API: /internet_referral/{deviceId:[0-9]+}/object for a description of how internet referral is resolved.

Parameters:
body: Internet referral configuration

Usage Example
URLhttps://192.168.1.1/securetrack/api/internet_referral
BODY{
    \"internet_referral\": {
        \"@xsi.type\": \"internetReferralObjectNameDTO\",
        \"device_id\": 2,
        \"object_name\": \"Host_2.2.2.2\"
    }
}


Response Messages:
201: Internet referral configuration was created
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
400: Internet referral configuration was malformed
400: Internet referral configuration for given device ID already exists
403: Access is denied.","folder":"1-9","rawModeData":"{\n\t\"internet_referral\": {\n\t\t\"@xsi.type\": \"internetReferralObjectNameDTO\",\n\t\t\"device_id\": 2,\n\t\t\"object_name\": \"Host_2.2.2.2\"\n\t}\n}\n","url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/","collectionId":"1","id":"1-9-32","method":"POST"},{"headers":"Accept: application/json\n","name":"Get LDAP entry details by DN","data":[{"value":null,"type":"text","enabled":true,"key":"dn"}],"dataMode":"params","description":"Returns the UID, DN and Name of a LDAP entry specified by the DN.

Parameters:
dn: LDAP DN

Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/getEntryByDN?dn=CN=Manufacturing,OU=RSA_Demo,DC=tufintest,DC=com
OUTPUT{
    \"ldap_entry\": {
        \"uid\": \"mYbWQms7p0q5YinEyW5Byw==\",
        \"dn\": \"CN=Manufacturing,OU=RSA_Demo,DC=tufintest,DC=com\",
        \"name\": \"Manufacturing\"
    }
}


Response Messages:
200: OK
400: Invalid DN format
404: Entry matching the DN cannot be found
501: LDAP server is not configured
503: No connection to LDAP server","folder":"1-10","url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/getEntryByDN","collectionId":"1","id":"1-10-33","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Return LDAP entries which match the given search criteria","dataMode":"raw","description":"Return list of LDAP entries which match the given search criteria according to the search mode (EXACT, CONTAINS, STARTS_WITH, ENDS_WITH).
The search is case insensitive.
The limit of max_search_result is 1000.

Parameters:
body: Search criteria

Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/search
BODY{
    \"search_criteria\": {
        \"search_base_dn\": \"DC=tufintest,DC=com\",
        \"search_text\": \"test\",
        \"ldap_search_options\": {
            \"ldap_entry_types\": {
                \"ldap_entry_type\": [
                    \"OU\",
                    \"USER\"
                ]
            },
            \"search_mode\": \"CONTAINS\",
            \"max_search_result\": 3
        }
    }
}
OUTPUT{
    \"search_result\": {
        \"ldap_entries\": {
            \"ldap_entry\": [
            {
                \"dn\": \"CN=User15ATTesting1,OU=Testing1,OU=new OU,OU=SC_Users,DC=tufintest,DC=com\",
                \"uid\": \"ZRuKW3XqIEOIxCwlfgJQYA==\",
                \"displayName\": \"User15ATTesting1\"
            },
            {
                \"dn\": \"CN=IWAM_TEST2003,CN=Users,DC=tufintest,DC=com\",
                \"uid\": \"bYVqqcZXsUSF51hiP4W7Yw==\",
                \"displayName\": \"Testing1\"
            },
            {
                \"dn\": \"CN=User1ATTesting1,OU=Testing1,OU=new OU,OU=SC_Users,DC=tufintest,DC=com\",
                \"uid\": \"2ma3TrgeHEWQDITwvcRqlg==\",
                \"displayName\": \"test\"
            }
            ]
        },
            \"has_more_results_to_return\": \"true\"
        }
}


Response Messages:
200: OK
400: Bad request (one of the request fields has an illegal or invalid value)
501: LDAP server is not configured
503: No connection to LDAP server","folder":"1-10","rawModeData":"{\n\t\"search_criteria\": {\n\t\t\"search_base_dn\": \"DC=tufintest,DC=com\",\n\t\t\"search_text\": \"test\",\n\t\t\"ldap_search_options\": {\n\t\t\t\"ldap_entry_types\": {\n\t\t\t\t\"ldap_entry_type\": [\n\t\t\t\t\t\"OU\",\n\t\t\t\t\t\"USER\"\n\t\t\t\t]\n\t\t\t},\n\t\t\t\"search_mode\": \"CONTAINS\",\n\t\t\t\"max_search_result\": 3\n\t\t}\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/search","collectionId":"1","id":"1-10-34","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Return entries that exactly match one of the given strings","dataMode":"raw","description":"Return list of LDAP entries which match the exact given multiple search_text.

Parameters:
body: Names to search

Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/getEntriesByNames
BODY{
    \"search_by_name_criteria\": {
        \"search_texts\": {
            \"search_text\": [
                \"Finance\",
                \"Marketing\",
                \"Management\"
            ]
        },
        \"ldap_entry_types\": {
            \"ldap_entry_type\": [
                \"GROUP\"
            ]
        },
        \"max_search_result\": 20
    }
}
OUTPUT{
    \"search_result\": {
        \"ldap_entries\": {
            \"ldap_entry\": [
                {
                    \"@xsi.type\": \"LdapGroup\",
                    \"dn\": \"CN=Finance,OU=SecureTrack,DC=tufintest,DC=com\",
                    \"uid\": \"uOvJTpYRD0aTjEENA87N5A==\",
                    \"displayName\": \"Finance\"
                },
                {
                    \"@xsi.type\": \"LdapGroup\",
                    \"dn\": \"CN=Management,OU=SecureTrack,DC=tufintest,DC=com\",
                    \"uid\": \"jdf778skfsgs730fksdHHs==\",
                    \"displayName\": \"Management\"
                }
            ]
        },
        \"has_more_results_to_return\": false
    }
}


Response Messages:
200: OK
400: Bad request (one of the request fields has an illegal value)
501: LDAP server is not configured
503: No connection to LDAP server","folder":"1-10","rawModeData":"{\n\t\"search_by_name_criteria\": {\n\t\t\"search_texts\": {\n\t\t\t\"search_text\": [\n\t\t\t\t\"Finance\",\n\t\t\t\t\"Marketing\",\n\t\t\t\t\"Management\"\n\t\t\t]\n\t\t},\n\t\t\"ldap_entry_types\": {\n\t\t\t\"ldap_entry_type\": [\n\t\t\t\t\"GROUP\"\n\t\t\t]\n\t\t},\n\t\t\"max_search_result\": 20\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/getEntriesByNames","collectionId":"1","id":"1-10-35","method":"POST"},{"headers":"Accept: application/json\n","name":"Get the base DN entry details","description":"The returned \"base DN\" is used by GetEntriesByNames API as the search start entry.



Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/getBaseDNEntry
OUTPUT{
    \"ldap_entry\": {
        \"dn\": \"DC=tufintest,DC=com\",
        \"uid\": \"nABbRP/lPUKlteNRI4j6iA==\"
    }
}


Response Messages:
200: OK
404: Base Entry cannot be found
501: LDAP server is not configured
503: No connection to LDAP server","folder":"1-10","url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/getBaseDNEntry","collectionId":"1","id":"1-10-36","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Add devices to SecureTrack","dataMode":"raw","description":"Use this API to add a single device or a list of devices to SecureTrack.
The following devices can be added: Check Point CMA R77, CMA R80, SMC R77, SMC R80; Cisco ASA; Palo Alto Panorama NG; Fortinet FortiManager.
The API body should include a JSON file with the mandatory parameters for the operation.
String parameters contain only lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^().
Currently supported types: CMA, SMC, ASA, Panorama NG and FortiManager.

This API verifies connection to the provided device, before adding a device.
This is done by:
  Cisco - Connect with SSH and see that the credentials are correct.
  Check Point - Test OPSEC connectivity. For R80 devices, this also verifies the connectivity for API login.
  Panorama - Login through the API to check connectivity.
  Fortimanager - Login through the API to check connectivity.
If the connection test fails the device will not be added.
Only \"live\" device with correct credentials can be added using this API.
To add Checkpoint R77 devices, use \"r80_version\" : \"false\".


Parameters:
body: device_list

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/bulk
BODY{
     \"devices_list\":{
         \"devices\": [{
             \"model\":\"CMA\",
             \"vendor\":\"Checkpoint\",
             \"display_name\":\"Europe-CMA\",
             \"ip_address\":\"192.168.1.1\",
             \"enable_topology\": \"true\",
             \"securetrack_domain\":\"Default\",
             \"device_data\":{
                 \"lea_authentication_port\":\"65000\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"opsec_application\":\"ST-Opsec\",
                 \"activation_key\":\"ST-Activation\",
                 \"r80_version\":\"false\"
             }
         },
         {
             \"model\":\"CMA\",
             \"vendor\":\"Checkpoint\",
             \"display_name\":\"Europe-CMA\",
             \"ip_address\":\"192.168.1.1\",
             \"enable_topology\": \"true\",
             \"securetrack_domain\":\"Default\",
             \"device_data\":{
                 \"lea_authentication_port\":\"65000\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"opsec_application\":\"ST-Opsec\",
                 \"activation_key\":\"ST-Activation\",
                 \"user_name\":\"admin\",
                 \"password\":\"1234\",
                 \"r80_version\":\"true\"
             }
         },
         {
             \"model\":\"ASA\",
             \"vendor\":\"Cisco\",
             \"securetrack_domain\":\"Domain-A\",
             \"display_name\":\"Ireland-ASA\",
             \"ip_address\":\"172.16.1.1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
             \"enable_virtual_contexts\":\"true\",
             \"import_all\":\"false\",
             \"import_devices\":
                     [\"VC1\",\"VC2\"],
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"false\",
                 \"collect_dynamic_topology\":\"false\",
                 \"user_name\":\"St-Super-use\",
                 \"password\":\"st-super-password\",
                 \"enable_password\":\"st-enable-password\"
             }
         },
         {
             \"model\":\"Panorama\",
             \"vendor\":\"PaloAltoNetworks\",
             \"display_name\":\"First-Device-example\",
             \"ip_address\":\"172.16.1.1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"user_name\":\"St-Super-use\",
                 \"password\":\"st-super-password\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"collect_dynamic_topology\":\"false\",
                 \"import_devices\":[
                     {
                         \"name\":\"DG1\",
                         \"import_all\":\"false\",
                         \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"]
                     },
                     {
                         \"name\":\"DG2\",
                         \"import_all\":\"true\"
                     },
                     {
                         \"name\":\"DG3\",
                         \"import_all\":\"false\",
                         \"managed_devices\": []
                     }
                 ]
             }
         },
         {
             \"model\":\"FortiManager\",
             \"vendor\":\"Fortinet\",
             \"display_name\":\"Spain-FortiManager\",
             \"securetrack_server\":\"RemoteControlServerName\",
             \"ip_address\":\"172.16.1.1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"false\",
                 \"user_name\":\"St-Super-use\",
                 \"password\":\"st-super-password\",
                 \"collect_dynamic_topology\":\"false\",
                 \"import_all\": \"false\",
                 \"import_devices\": [
                         {
                 \"name\": \"AdomX\",
                 \"import_all\": \"false\",
                 \"managed_devices\": [\"FW1\"]
                        }
                    ]
                }
            }
        ]
    }
}


Response Messages:
202: Accepted
408: Request timed out
500: Internal server error
503: Task with UID already running","folder":"1-11","rawModeData":"{ \n \t \"devices_list\":{ \n \t\t \"devices\": [{ \n \t\t\t \"model\":\"CMA\",\n \t\t\t \"vendor\":\"Checkpoint\",\n \t\t\t \"display_name\":\"Europe-CMA\",\n \t\t\t \"ip_address\":\"192.168.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"securetrack_domain\":\"Default\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"lea_authentication_port\":\"65000\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"opsec_application\":\"ST-Opsec\",\n \t\t\t\t \"activation_key\":\"ST-Activation\",\n \t\t\t\t \"r80_version\":\"false\"\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"model\":\"CMA\",\n \t\t\t \"vendor\":\"Checkpoint\",\n \t\t\t \"display_name\":\"Europe-CMA\",\n \t\t\t \"ip_address\":\"192.168.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"securetrack_domain\":\"Default\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"lea_authentication_port\":\"65000\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"opsec_application\":\"ST-Opsec\",\n \t\t\t\t \"activation_key\":\"ST-Activation\",\n \t\t\t\t \"user_name\":\"admin\",\n \t\t\t\t \"password\":\"1234\",\n \t\t\t\t \"r80_version\":\"true\"\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"model\":\"ASA\",\n \t\t\t \"vendor\":\"Cisco\",\n \t\t\t \"securetrack_domain\":\"Domain-A\",\n \t\t\t \"display_name\":\"Ireland-ASA\",\n \t\t\t \"ip_address\":\"172.16.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t \"enable_virtual_contexts\":\"true\",\n \t\t\t \"import_all\":\"false\",\n \t\t\t \"import_devices\": \n \t\t\t\t\t [\"VC1\",\"VC2\"],\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"false\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"user_name\":\"St-Super-use\",\n \t\t\t\t \"password\":\"st-super-password\",\n \t\t\t\t \"enable_password\":\"st-enable-password\"\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"model\":\"Panorama\",\n \t\t\t \"vendor\":\"PaloAltoNetworks\",\n \t\t\t \"display_name\":\"First-Device-example\",\n \t\t\t \"ip_address\":\"172.16.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"user_name\":\"St-Super-use\",\n \t\t\t\t \"password\":\"st-super-password\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"import_devices\":[\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG1\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"] \n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG2\",\n \t\t\t\t\t\t \"import_all\":\"true\"\n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG3\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [] \n \t\t\t\t\t }\n \t\t\t\t ]\n \t\t\t }\n \t\t },\n \t\t {\n \t\t\t \"model\":\"FortiManager\",\n \t\t\t \"vendor\":\"Fortinet\",\n \t\t\t \"display_name\":\"Spain-FortiManager\",\n \t\t\t \"securetrack_server\":\"RemoteControlServerName\",\n \t\t\t \"ip_address\":\"172.16.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"false\",\n \t\t\t\t \"user_name\":\"St-Super-use\",\n \t\t\t\t \"password\":\"st-super-password\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"import_all\": \"false\",\n \t\t\t\t \"import_devices\": [\n \t\t\t\t\t\t { \n \t\t\t\t \"name\": \"AdomX\",\n \t\t\t\t \"import_all\": \"false\", \n \t\t\t\t \"managed_devices\": [\"FW1\"]\n \t\t\t\t\t\t}\n \t\t\t\t\t]\n \t\t\t\t}\n \t\t\t}\n \t\t]\n \t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/","collectionId":"1","id":"1-11-37","method":"POST"},{"headers":"Content-Type: application/json\n","name":"Edit Securetrack device","dataMode":"raw","description":"Use this API to edit the settings of a management device, including changing multiple parameters in the same call.
The API body should include a JSON file with the mandatory parameters for the operation.
String parameters contain only lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^().
The following devices can be added: Check Point CMA R77, CMA R80, SMC R77, SMC R80; Cisco ASA; Palo Alto Panorama NG; Fortinet FortiManager.
Note: This API cannot be used to edit SecureTrack Domains and SecureTrack Servers.
This API verifies connection to the provided device, before updating a device.
This is done by:
  Cisco - Connect with SSH and see that the credentials are correct.
  Check Point - Test OPSEC connectivity. For R80 devices, this also verifies the connectivity for API login.
  Panorama - Login through the API to check connectivity.
  Fortimanager - Login through the API to check connectivity.
If the connection test fails the device will not be updated.
Only \"live\" device with correct credentials can be updated using this API.

Parameters:
body: device_list

Usage Example
URL https://192.168.1.1/securetrack/api/devices/bulk
BODY{
     \"devices_list\":{
         \"devices\": [{
             \"device_id\": 1,
             \"display_name\": \"CheckPoint-R77-Device\",
             \"enable_topology\": \"true\",
             \"ip_address\": \"1.1.1.1\",
             \"device_data\": {
                 \"opsec_application\": \"ST-Opsec\",
                 \"activation_key\": \"ST-Activation\",
                 \"authentication_mode\": \"LEA\",
                 \"lea_authentication_mode\": \"ssl_opsec\",
                 \"lea_authentication_port\": \"2488\",
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\"
             }
         },
         {
             \"device_id\": 2,
             \"display_name\": \"CheckPoint-R80-Device\",
             \"enable_topology\": \"true\",
             \"ip_address\": \"1.1.1.2\",
             \"device_data\": {
                 \"opsec_application\": \"ST-Opsec\",
                 \"activation_key\": \"ST-Activation\",
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\",
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\"
             }
         },
         {
             \"device_id\": 3,
             \"display_name\": \"Cisco-Device\",
             \"enable_topology\": \"true\",
             \"ip_address\": \"2.2.2.2\",
             \"device_data\": {
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\",
                 \"enable_password\": \"st-super-password\",
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\"
             }
         },
         {
             \"device_id\": 4,
             \"display_name\": \"PaloAlto-PanoramaNg-Device\",
             \"ip_address\": \"2.2.2.2\",
             \"device_data\": {
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\"
             }
         },
         {
             \"device_id\": 5,
             \"display_name\": \"PaloAlto-DeviceGroup\"
         },
         {
             \"device_id\": 6,
             \"display_name\": \"PaloAlto-FireWall-Device\",
             \"enable_topology\": \"true\",
             \"device_data\": {
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\",
                 \"collect_dynamic_topology\": \"true\"
             }
         },
         {
             \"device_id\": 7,
             \"display_name\": \"Spain-FortiManager\",
             \"ip_address\": \"2.2.2.2\",
             \"device_data\": {
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\"
             }
         },
         {
             \"device_id\": 8,
             \"display_name\": \"FortiManager-Adom\"
         },
         {
             \"device_id\": 9,
             \"display_name\": \"FortiManager-FireWall\",
             \"enable_topology\": \"true\",
             \"device_data\": {
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\",
                 \"collect_dynamic_topology\": \"true\"
             }
         }
        ]
    }
}


Response Messages:
202: Accepted
408: Request timed out
500: Internal server error
503: Task with UID already running","folder":"1-11","rawModeData":"{ \n \t \"devices_list\":{ \n\t\t \"devices\": [{\n\t\t\t \"device_id\": 1,\n\t\t\t \"display_name\": \"CheckPoint-R77-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"ip_address\": \"1.1.1.1\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"opsec_application\": \"ST-Opsec\",\n\t\t\t\t \"activation_key\": \"ST-Activation\",\n\t\t\t\t \"authentication_mode\": \"LEA\",\n\t\t\t\t \"lea_authentication_mode\": \"ssl_opsec\",\n\t\t\t\t \"lea_authentication_port\": \"2488\",\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 2,\n\t\t\t \"display_name\": \"CheckPoint-R80-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"ip_address\": \"1.1.1.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"opsec_application\": \"ST-Opsec\",\n\t\t\t\t \"activation_key\": \"ST-Activation\",\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\",\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 3,\n\t\t\t \"display_name\": \"Cisco-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"ip_address\": \"2.2.2.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\",\n\t\t\t\t \"enable_password\": \"st-super-password\",\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 4,\n\t\t\t \"display_name\": \"PaloAlto-PanoramaNg-Device\",\n\t\t\t \"ip_address\": \"2.2.2.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 5,\n\t\t\t \"display_name\": \"PaloAlto-DeviceGroup\"\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 6,\n\t\t\t \"display_name\": \"PaloAlto-FireWall-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_dynamic_topology\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 7,\n\t\t\t \"display_name\": \"Spain-FortiManager\",\n\t\t\t \"ip_address\": \"2.2.2.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 8,\n\t\t\t \"display_name\": \"FortiManager-Adom\"\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 9,\n\t\t\t \"display_name\": \"FortiManager-FireWall\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_dynamic_topology\": \"true\"\n\t\t\t }\n\t\t }\n\t\t]\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/","collectionId":"1","id":"1-11-38","method":"PATCH"},{"headers":"Accept: application/json\n","name":"Get specific device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the vendor, model, name, domain and ID for the specified device.
For more information on supported devices, supported models and virtual types please refer to 'Device and Revision Resources' section in the Tufin Knowledge Center .

Parameters:
context: Global MSSP context [optional]
id: Device ID
show_os_version: Show os version as apart of the response [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/60

Usage Example
https://192.168.1.1/securetrack/api/devices/20?show_os_version=true
","folder":"1-11","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}","collectionId":"1","id":"1-11-39","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Add offline device","dataMode":"raw","description":"You can choose to select the domain either by name or id using the domain_id or domain_name tags.\nDevice name should contain only Lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^()

Parameters:
body: Device to be added

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices
BODY<device>
     <model>asa</model>
     <vendor>Cisco</vendor>
     <domain_id>1</domain_id>
     <domain_name>Default</domain_name>
     <name>API OFFLINE ASA1</name>
     <offline>true</offline>
     <topology>true</topology>
</device>

","folder":"1-11","rawModeData":"\n\t asa \n\t Cisco\n\t 1\n\t Default\n\t API OFFLINE ASA1\n\t true\n\t true\n","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/","collectionId":"1","id":"1-11-40","method":"POST"},{"headers":"Accept: application/json\n","name":"Get devices","description":"Returns the list of devices that are configured in SecureTrack, including the vendor, model, name, domain and device ID.
The results can be sorted by ip, name, vendor and model.
For more information on supported devices, supported models and virtual types please refer to 'Device and Revision Resources' section in the Tufin Knowledge Center .

Parameters:
context: Global MSSP context [optional]
name: Device name [optional]
ip: Device IP address [optional]
vendor: Device vendor [optional]
model: Device model [optional]
sort: Sort ascending or descending allowable types are: asc or desc [optional]
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query starting from starting page allowable type in numeric [optional]
show_os_version: Show os version as apart of the response [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices

Usage Example
https://192.168.1.1/securetrack/api/devices?vendor=VMware

Usage Example
https://192.168.1.1/securetrack/api/devices?sort=ip:asc

Usage Example
https://192.168.1.1/securetrack/api/devices?show_os_version=true
","folder":"1-11","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/","collectionId":"1","id":"1-11-41","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Import managed devices","dataMode":"raw","description":"Use this API to import more managed devices to SecureTrack.
The following devices can be added: Device Groups (for Panorama), Administrative Domains (for FortiManager).\nCurrently supported types: Panorama, FortiManager, Cisco ASA.
Please see examples below per device id: device id 1 for Panorama, device 2 for FortiManager, device id 3 for Cisco ASA.

Parameters:
body: device_list

Usage Example
URL https://192.168.1.1/securetrack/api/devices/bulk/import
BODY{
     \"devices_list\":{
         \"devices\":[
         {
             \"device_id\":\"1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"collect_dynamic_topology\":\"false\",
                 \"import_devices\":[
                     {
                         \"name\":\"DG1\",
                         \"import_all\":\"false\",
                         \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"]
                     },
                     {
                         \"name\":\"DG2\",
                         \"import_all\":\"true\"
                     },
                     {
                         \"name\":\"DG3\",
                         \"import_all\":\"false\",
                         \"managed_devices\": []
                     }
                 ]
             }
         },
         {
             \"device_id\":\"2\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"import_devices\": [
                     {
                         \"name\":\"Adom1\",
                         \"import_all\":\"false\",
                         \"managed_devices\": [\"firewall1\", \"firewall2\"]
                     },
                     {
                         \"name\":\"Adom2\",
                         \"import_all\":\"true\"
                     }
                 ]
             }
         },
         {
             \"device_id\":\"3\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"import_devices\": [\"wantedVirtualContext\", \"anotherWantedVirtualContext\"]
             }
         }
        ]
    }
}


Response Messages:
202: Accepted
408: Request timed out
500: Internal server error
503: Task with UID already running","folder":"1-11","rawModeData":"{ \n \t \"devices_list\":{ \n \t\t \"devices\":[ \n \t\t { \n \t\t\t \"device_id\":\"1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"import_devices\":[\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG1\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"] \n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG2\",\n \t\t\t\t\t\t \"import_all\":\"true\"\n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG3\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [] \n \t\t\t\t\t }\n \t\t\t\t ]\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"device_id\":\"2\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"import_devices\": [\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"Adom1\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [\"firewall1\", \"firewall2\"] \n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"Adom2\",\n \t\t\t\t\t\t \"import_all\":\"true\"\n \t\t\t\t\t }\n \t\t\t\t ]\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"device_id\":\"3\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"import_devices\": [\"wantedVirtualContext\", \"anotherWantedVirtualContext\"] \n \t\t\t }\n \t\t }\n \t\t]\n \t}\n} ","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/import","collectionId":"1","id":"1-11-42","method":"POST"},{"headers":"Accept: application/json\n","name":"Get specific task results of bulk operations on devices","data":[{"value":null,"type":"text","enabled":true,"key":"task_uid"}],"dataMode":"params","description":"Use this API to track and display the current progress of the devices being edited or added to\nSecureTrack for a specific Task ID.
For a list of devices, the status of each device is displayed.

A device that was not added due to some reason will be added to \"failed\" list with status element containing a description.
For example:
\"description\": \"No connection to device\".

Parameters:
task_uid: Task UID

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/bulk/tasks/d7e88799-a6e5-45da-8c72-c979a5dbe235
OUTPUT{
    \"task_result\":{
        \"total_succeeded\":\"0\",
        \"total_in_progress\":\"2\",
        \"total_failed\":\"0\",
        \"succeeded\":{
            \"count\":\"0\"
        },
        \"in_progress\":{
            \"count\":\"2\",
            \"devices\":[
                {
                    \"device_id\":\"1\",
                    \"display_name\":\"Europe-CMA\",
                    \"ip_address\":\"192.168.1.1\",
                    \"status\":{
                    }
                },
                {
                    \"device_id\":\"2\",
                    \"display_name\":\"Ireland-ASA\",
                    \"ip_address\":\"172.16.1.1\",
                    \"status\":{
                    }
                }
            ]
        },
        \"failed\":{
            \"count\":\"0\"
        }
    }
}


Response Messages:
404: The task with the given UID was not found
400: Bad request
200: Accepted
408: Request timed out
500: Internal server error","folder":"1-11","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/tasks/{{task_uid}}","collectionId":"1","id":"1-11-43","method":"GET"},{"headers":"Accept: application/json\n","name":"Get textual configuration by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Get latest revision of running configuration for a given device Id.


Parameters:
context: global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/111/config
","folder":"1-11","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/config","collectionId":"1","id":"1-11-44","method":"GET"},{"name":"Add configuration for offline device","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"configuration_file"}],"description":"Parameters:
device_id: Device ID
configuration_file: Configuration File

Usage Example
curl -X POST -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F \"configuration_file=@/tmp/config.txt;type=application/octet-stream\" -F \"device_id=1\" https://192.168.1.1/securetrack/api/tasks/add_device_config_task

Response Messages:
200: Configuration added successfully.","dataMode":"params","folder":"1-11","url":"https://{{SecureTrack_IP}}/securetrack/api/tasks/add_device_config_task","collectionId":"1","id":"1-11-45","method":"POST"},{"headers":"Content-Type: application/xml\n","name":"Update offline device","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"}],"dataMode":"raw","description":"Device name should contain only Lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^()

Parameters:
device_id: Device ID
body: Device to be updated

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/1
BODY<device>
     <name>API OFFLINE ASA2</name>
     <topology>true</topology>
</device>

","folder":"1-11","rawModeData":"\n\t API OFFLINE ASA2\n\t true\n","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}","collectionId":"1","id":"1-11-46","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get textual configuration by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns textual configuration for the specified revision Id.


Parameters:
context: Global MSSP context [optional]
id: Revision id

Usage Example
https://192.168.1.1/securetrack/api/revisions/227/config
","folder":"1-11","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/config","collectionId":"1","id":"1-11-47","method":"GET"},{"headers":"Accept: application/json\n","name":"Get NAT objects by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches a list of NAT objects for a given revision
Note: NAT objects are only relevant for Check Point management servers and Juniper Netscreen devices.
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.


Parameters:
context: Global MSSP context [optional]
id: Version ID
start: Starting page for query allowable value is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/nat_objects

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/nat_objects?get_total=true
","folder":"1-12","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/nat_objects","collectionId":"1","id":"1-12-48","method":"GET"},{"headers":"Accept: application/json\n","name":"Get NAT objects by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches a list of NAT objects defined on device given by device ID
Note: NAT objects are only relevant for Check Point management servers and Juniper Netscreen devices.
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.


Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable value is numeric [optional]
count: Starting page for query allowable value is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/nat_objects

Usage Example
https://192.168.1.1/securetrack/api/devices/20/nat_objects?get_total=true
","folder":"1-12","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/nat_objects","collectionId":"1","id":"1-12-49","method":"GET"},{"headers":"Accept: application/json\n","name":"Get NAT rules by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of NAT rules for device given by device ID

input_interface and output_interface are not supported for Panorama running in Advanced management mode
nat_stage is supported for Netscreen and JunOS
nat_type is supported for FortiManager
Note: For Check Point, NAT rules are available from the modules (not managements)
Note: For Palo Alto, filtering NAT rules by interface is only available for firewall devices

Parameters:
context: Global MSSP context [optional]
id: Device ID
input_interface: Input interface for NAT rules, \"any\" for all interfaces [optional]
output_interface: output interface for NAT rules, \"any\" for all interfaces [optional]
nat_stage: NAT stage for NAT rules allowable values: \"pre_policy\" , \"post_policy\" or \"both\" [optional]
nat_type: NAT stage for NAT rules allowable values: \"vip\" or \"reverse_vip\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/10/nat_rules/bindings?input_interface=Any
","folder":"1-12","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/nat_rules/bindings","collectionId":"1","id":"1-12-50","method":"GET"},{"headers":"Accept: application/json\n","name":"Get network groups containing specified network object","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns groups that contain the specified network object


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the network object.

Usage Example
https://192.168.1.1/securetrack/api/network_objects/69577/groups
","folder":"1-13","url":"https://{{SecureTrack_IP}}/securetrack/api/network_objects/{{id}}/groups","collectionId":"1","id":"1-13-51","method":"GET"},{"headers":"Accept: application/json\n","name":"Get rules containing specified network object","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the security rules that contain the specified network object


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the network object.
include_groups: You can add \"include_groups\" to find rules that include the network object and rules that include the groups that include the network object. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]

Usage Example
https://192.168.1.1/securetrack/api/network_objects/65078/rules?include_groups=true
","folder":"1-13","url":"https://{{SecureTrack_IP}}/securetrack/api/network_objects/{{id}}/rules","collectionId":"1","id":"1-13-52","method":"GET"},{"headers":"Accept: application/json\n","name":"Get network objects by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of network objects defined on device given by ID
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.
The show_members parameter is only relevant if type=group.
If type=group, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.

Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
name: Network object name [optional]
type: Network object type [optional]
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
contains_ip: Get only network objects containing this IP [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]
typeOnDevice: Get EDL groups [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/network_objects

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?get_total=true
OUTPUT {
    \"network_objects\": {
    \"count\": 1,
    \"total\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"hostNetworkObjectDTO\",
                \"id\": 499226,
                \"name\": \"1.1.1.2 not shared\",
                \"display_name\": \"1.1.1.2 not shared\",
                \"class_name\": \"host_plain\",
                \"type\": \"host\",
                \"comment\": \"\",
                \"uid\": \"{EFE8E61B-EE2A-2F55-4C5C-56508661EAA7}\",
                \"implicit\": false,
                \"management_domain\": \"Shared\",
                \"overrides\": false,
                \"ip\": \"1.1.1.2\"
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"count\": 1
        \"network_object\": [
            {
                \"@xsi.type\": \"identityAwarenessDTO\",
                \"id\": 169178,
                \"name\": \"Access_role\",
                \"display_name\": \"Access_role\",
                \"class_name\": \"access_role\",
                \"type\": \"identity_awareness\",
                \"global\": false,
                \"comment\": \"\",
                \"uid\": \"{FC267948-DA8C-4FB6-A736-76B5254BF825}\",
                \"implicit\": false,
                \"overrides\": false,
                \"type_on_device\": \"\",
                \"networks\": {
                    \"network\": {
                        \"@xsi.type\": \"basicNetworkObjectDTO\",
                        \"id\": 168419,
                        \"name\": \"Any\",
                        \"display_name\": \"Any\",
                        \"class_name\": \"any_object\",
                        \"type\": \"basic\",
                        \"global\": false,
                        \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                        \"implicit\": false,
                        \"overrides\": false
                    }
                },
                \"users\": {
                    \"user\": {
                        \"id\": 14320,
                        \"name\": \"ad_group_auto_30K_grp1\",
                        \"display_name\": \"auto_30K_grp1\",
                        \"class_name\": \"ad_group\",
                        \"global\": false,
                        \"comment\": \"\",
                        \"uid\": \"{CAB92DCC-CF63-4E47-B8E3-1E1231996D5E}\",
                        \"dn\": \"CN=auto_30K_grp1,OU=OU_30K_Groups,DC=rnd,DC=local\"
                    }
                }
            },
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?type=group&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 105934,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?typeOnDevice=edl_ip_list&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 1,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 123123,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"type_on_device\": edl_ip_list,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Response Messages:
400: The typeOnDevice value is not valid","folder":"1-13","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/network_objects","collectionId":"1","id":"1-13-53","method":"GET"},{"headers":"Accept: application/json\n","name":"Get network objects by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of network objects from specific revision
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.
The show_members parameter is only relevant if type=group.
If type=group, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.

Parameters:
context: Global MSSP context [optional]
id: Revision id
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
name: Network object name [optional]
type: Network object type [optional]
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
contains_ip: Get only network objects containing this IP [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]
typeOnDevice: Get EDL groups [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/779/network_objects

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?get_total=true
OUTPUT {
    \"network_objects\": {
    \"count\": 1,
    \"total\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"hostNetworkObjectDTO\",
                \"id\": 499226,
                \"name\": \"1.1.1.2 not shared\",
                \"display_name\": \"1.1.1.2 not shared\",
                \"class_name\": \"host_plain\",
                \"type\": \"host\",
                \"comment\": \"\",
                \"uid\": \"{EFE8E61B-EE2A-2F55-4C5C-56508661EAA7}\",
                \"implicit\": false,
                \"management_domain\": \"Shared\",
                \"overrides\": false,
                \"ip\": \"1.1.1.2\"
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/779/network_objects?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
    \"count\": 1,
        \"network_object\": [
            {
                \"@xsi.type\": \"identityAwarenessDTO\",
                \"id\": 169183,
                \"name\": \"Access role 1\",
                \"display_name\": \"Access role 1\",
                \"class_name\": \"access_role\",
                \"type\": \"identity_awareness\",
                \"global\": true,
                \"comment\": \"\",
                \"uid\": \"{1E4C35A0-1FE4-4101-8A38-FDE656BCDCFB}\",
                \"implicit\": false,
                \"overrides\": false,
                \"type_on_device\": \"\",
                \"networks\": {
                    \"network\": {
                        \"@xsi.type\": \"basicNetworkObjectDTO\",
                        \"id\": 168419,
                        \"name\": \"Any\",
                        \"display_name\": \"Any\",
                        \"class_name\": \"any_object\",
                        \"type\": \"basic\",
                        \"global\": false,
                        \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                        \"implicit\": false,
                        \"overrides\": false
                    }
                },
                \"users\": {
                    \"user\": {
                        \"id\": 14346,
                        \"name\": \"all identified\",
                        \"display_name\": \"all identified\",
                        \"class_name\": \"all_identified\",
                        \"global\": false,
                        \"comment\": \"\",
                        \"uid\": \"{17A972AC-4B4A-4715-859F-867128707F59}\",
                        \"dn\": \"\"
                    }
                }
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/31/network_objects?type=group&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 105934,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/31/network_objects?typeOnDevice=edl_ip_list&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 1,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 123123,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"type_on_device\": edl_ip_list,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Response Messages:
400: The typeOnDevice value is not valid","folder":"1-13","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/network_objects","collectionId":"1","id":"1-13-54","method":"GET"},{"headers":"Accept: application/json\n","name":"Get network objects matching specified criteria","data":[{"value":null,"type":"text","enabled":true,"key":"filter"}],"dataMode":"params","description":"You can search for network objects where the IP address, name or comment fields have a specified text string,
or you can search for network objects that have an IP address that matches, contains or is contained in a specified IP subnet,
or you can search for network objects by uid.

Parameters:
context: Returns results for the specified domain ID. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]
filter: “text” filter returns network objects where the IP address, name or comment fields have a specified text string. “subnet” filter returns network objects that have an IP address that matches, contains or is contained in a specified IP subnet. “uid“ filter returns network objects with the specified uid. If no filter is specified, the “text” filter is used.
device_id: Returns network objects belonging to the specified device_id. [optional]
ip: (For “text” filter) You can specify \"ip\" to find network objects with the specified text in the IP address field. [optional]
name: (For “text” filter) You can specify \"name\" to find network objects with the specified text in the name field. [optional]
comment: (For “text” filter) You can specify “comment” to find network objects with the specified text in the comment field. [optional]
any_field: (For “text” filter) You can specify \"any_field\" to find network objects with the specified text in the IP address, name or comment fields. [optional]
exact_match: (For “text” filter) You can add \"exact_match=true\" to find network objects with the specified text in the comment field. If this field is not specified, the query uses \"exact_match=false\". [optional]
contained_in: (For “subnet” filter) You can specify \"contained_in\" to find network objects that are contained in the specified IP subnet. For example, 10.1.0.0 is contained in 10.0.0.0. [optional]
contains: (For “subnet” filter) You can specify \"contains\" to find network objects that contain the specified IP subnet. For example, 10.0.0.0 contains 10.1.0.0. [optional]
exact_subnet: (For “subnet” filter) You can specify \"exact_subnet\" to find network objects that have the specified IP address. [optional]
uid: (for “uid“ filter) Returns network objects with the specified uid. [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]
typeOnDevice: You can specify \"typeOnDevice\" to find network object groups that are EDL. [optional]

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=text&name=host&exact_match=true

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=text&any_field=host&count=10&exact_match=true

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=subnet&contains=10.1.1.0

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=subnet&count=10&exact_subnet=1.1.1.1

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=uid&uid=24a8774d-24c1-4b3a-aae9-3c272a2b5191

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=uid&uid=24a8774d-24c1-4b3a-aae9-3c272a2b5191&device_id=4

Usage Example
URLhttps://192.168.1.1/securetrack/api/network_objects/search?filter=text&name=Access_Role&identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"count\": 1,
        \"total\": 1,
        \"network_object\": {
            \"@xsi.type\": \"identityAwarenessDTO\",
            \"id\": 169197,
            \"name\": \"Access_Role_aaa\",
            \"display_name\": \"Access_Role_aaa\",
            \"class_name\": \"access_role\",
            \"type\": \"identity_awareness\",
            \"global\": false,
            \"device_id\": 158,
            \"comment\": \"\",
            \"uid\": \"{9EDC2607-6BEC-43D7-A99D-B522BA694ADA}\",
            \"implicit\": false,
            \"overrides\": false,
            \"type_on_device\": \"\",
            \"networks\": {
                \"network\": {
                    \"@xsi.type\": \"basicNetworkObjectDTO\",
                    \"id\": 168419,
                    \"name\": \"Any\",
                    \"display_name\": \"Any\",
                    \"class_name\": \"any_object\",
                    \"type\": \"basic\",
                    \"global\": false,
                    \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                    \"implicit\": false,
                    \"overrides\": false
                }
            },
            \"users\": {
                \"user\": {
                    \"id\": 14317,
                    \"name\": \"ad_group_aaa\",
                    \"display_name\": \"aaa\",
                    \"class_name\": \"ad_group\",
                    \"global\": false,
                    \"comment\": \"\",
                    \"uid\": \"{5D16859C-0256-4673-A402-4254588B8F40}\",
                    \"dn\": \"CN=aaa,OU=SC_Users,DC=test,DC=com\"
                }
            }
        }
    }
}


Response Messages:
400: The typeOnDevice value is not valid.Use edl_ip_list as value to search EDL groups.","folder":"1-13","url":"https://{{SecureTrack_IP}}/securetrack/api/network_objects/search","collectionId":"1","id":"1-13-55","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific network objects by revision","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches a single or partial list of the network objects for a given revision.
For group network objects, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision id
ids: Network object IDs separated by commas
show_members: Set to false to return only the name and ID of the members [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/779/network_objects/69548

Usage Example
https://192.168.1.1/securetrack/api/revisions/779/network_objects/69547,69548,69550

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/779/network_objects/69547?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"network_object\": {
            \"@xsi.type\": \"identityAwarenessDTO\",
            \"id\": 169185,
            \"name\": \"Access_Role_Domain Controllers\",
            \"display_name\": \"Access_Role_Domain Controllers\",
            \"class_name\": \"access_role\",
            \"type\": \"identity_awareness\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{140B8F32-188D-414C-A7BE-F4A7D7E9A169}\",
            \"implicit\": false,
            \"overrides\": false,
            \"type_on_device\": \"\",
            \"networks\": {
                \"network\": {
                    \"@xsi.type\": \"basicNetworkObjectDTO\",
                    \"id\": 168419,
                    \"name\": \"Any\",
                    \"display_name\": \"Any\",
                    \"class_name\": \"any_object\",
                    \"type\": \"basic\",
                    \"global\": false,
                    \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                    \"implicit\": false,
                    \"overrides\": false
                }
            },
            \"users\": {
                \"user\": {
                    \"id\": 14237,
                    \"name\": \"ad_group_Domain_Controllers\",
                    \"display_name\": \"Domain Controllers\",
                    \"class_name\": \"ad_group\",
                    \"global\": false,
                    \"comment\": \"\",
                    \"uid\": \"{0A8A459E-58E8-45DC-981E-16BBF2BD1922}\",
                    \"dn\": \"CN=Domain Controllers,CN=Users,DC=rnd,DC=local\"
                }
            }
        }
    }
}

","folder":"1-13","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/network_objects/{{ids}}","collectionId":"1","id":"1-13-56","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific network object","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches a single or partial list of the network objects for a given device ID.
For group network objects, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.
Note: This API retrieves the information from the latest revision.

Parameters:
context: Global MSSP context [optional]
device_id: Device ID
ids: Network object IDs separated by commas
show_members: Set to false to return only the name and ID of the members [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/network_objects/69548

Usage Example
https://192.168.1.1/securetrack/api/devices/31/network_objects/69547,69548,69550

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects/169184?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"network_object\": {
            \"@xsi.type\": \"identityAwarenessDTO\",
            \"id\": 169184,
            \"name\": \"Access_Role_@grp\",
            \"display_name\": \"Access_Role_@grp\",
            \"class_name\": \"access_role\",
            \"type\": \"identity_awareness\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{1870612C-0922-4AEE-81FF-5472DB7C32E1}\",
            \"implicit\": false,
            \"overrides\": false,
            \"type_on_device\": \"\",
            \"networks\": {
                \"network\": {
                    \"@xsi.type\": \"basicNetworkObjectDTO\",
                    \"id\": 168419,
                    \"name\": \"Any\",
                    \"display_name\": \"Any\",
                    \"class_name\": \"any_object\",
                    \"type\": \"basic\",
                    \"global\": false,
                    \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                    \"implicit\": false,
                    \"overrides\": false
                }
            },
            \"users\": {
                \"user\": {
                    \"id\": 14338,
                    \"name\": \"ad_group_grp\",
                    \"display_name\": \"@grp\",
                    \"class_name\": \"ad_group\",
                    \"global\": false,
                    \"comment\": \"\",
                    \"uid\": \"{C5740C23-F36E-4D2E-8B17-1F99C239C12A}\",
                    \"dn\": \"CN=@grp,OU=SC_Users,DC=test,DC=com\"
                }
            }
        }
    }
}

","folder":"1-13","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/network_objects/{{ids}}","collectionId":"1","id":"1-13-57","method":"GET"},{"headers":"Accept: application/json\n","name":"Get generic devices that are configured in ST","description":"Returns a list of the generic devices included in all the domains that the user has permission to.
Use context and/or name optional parameters to get more specific results.
To get context optional parameter, you can call /domains/ API and use the id included within the returned domain DTO.

Parameters:
context: Global MSSP context [optional]
name: Generic device name [optional]

Usage Example
https://192.168.1.1/securetrack/api/generic_devices
","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/","collectionId":"1","id":"1-14-58","method":"GET"},{"name":"Add generic device to Topology model","data":[{"value":null,"type":"text","enabled":true,"key":"configuration_file"}],"dataMode":"params","description":"Upload a configuration file that will be used to add a generic device to the Topology model.
The context field is the domain ID to which the generic device is added: If not provided, the device is added to the global domain.
configuration_file must include a valid generic device configuration.
The specified path must point to a file on the computer being sue to make the REST API call.
If update update_topology = true, then the Topology model will be updated immediately after the device is added.
For maximum efficiency, if you are adding multiple generic devices in consecutive API calls, you can set update_topology = false on all API calls except for the last one. On the last call, set update_toplogy = true.Default value for update_topology = true.
For more information on input file formats, refer to Knowledge Center topic 'Adding and Updating a Generic Device'.

Parameters:
body: Generic device to be added
configuration_file: Configuration File for generic device
update_topology: Synchronize And Update Topology [optional]

Usage Example
curl -X POST -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F 'device_data={\"generic_device\":{\"name\": \"my_generic_device\", \"customer_id\": 1}};type=application/json' -F \"configuration_file=@/tmp/config.txt;type=application/octet-stream\" -F \"update_topology=true\" https://192.168.1.1/securetrack/api/generic_devices\n

Response Messages:
201: The generic device was created successfully
403: User is not permitted to access the specified domain
400: Failed to create generic device ","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/","collectionId":"1","id":"1-14-59","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Get cloud information","dataMode":"raw","description":"Returns information about all clouds in the topology.
This API includes the ID of the cloud, the number of routes that point to the cloud, and the relevant devices (including the management_id) that have routes that point to the cloud.
This information can be used to identify missing devices that may need to be added to the topology or to identify clouds that are candidates for being joined.

Parameters:
context: Global MSSP context [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/cloud_suggestions
BODY{
    \"suggested_clouds\": {
        \"count\": 2,
        \"total\": 2,
        \"cloud\": [
            {
                \"management_name\": \"FW1\",
                \"management_id\": 20,
                \"cloud_name\": \"Cloud 10.100.0.1\",
                \"cloud_id\": 120,
                \"vertex_id\": 250,
                \"ip\": \"10.100.0.1\",
                \"routes_count\": 5,
                \"is_parent\": false
            },
            {
                \"management_name\": \"FW2\",
                \"management_id\": 21,
                \"cloud_name\": \"Cloud 172.16.0.1\",
                \"cloud_id\": 125,
                \"vertex_id\": 270,
                \"ip\": \"172.16.0.1\",
                \"routes_count\": 7,
                \"is_parent\": false,
                \"parent_vertex_id\": 40
                \"parent_cloud_id\": 45
                \"parent_cloud_name\": \"Cloud 172.16.0.1\",
            }
        ]
    }
}


Response Messages:
202: Accepted
403: User is not permitted to access the specified domain","folder":"1-14","rawModeData":"{\n\t\"suggested_clouds\": {\n\t\t\"count\": 2,\n\t\t\"total\": 2,\n\t\t\"cloud\": [\n\t\t\t{\n\t\t\t\t\"management_name\": \"FW1\",\n\t\t\t\t\"management_id\": 20,\n\t\t\t\t\"cloud_name\": \"Cloud 10.100.0.1\",\n\t\t\t\t\"cloud_id\": 120,\n\t\t\t\t\"vertex_id\": 250,\n\t\t\t\t\"ip\": \"10.100.0.1\",\n\t\t\t\t\"routes_count\": 5,\n\t\t\t\t\"is_parent\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"management_name\": \"FW2\",\n\t\t\t\t\"management_id\": 21,\n\t\t\t\t\"cloud_name\": \"Cloud 172.16.0.1\",\n\t\t\t\t\"cloud_id\": 125,\n\t\t\t\t\"vertex_id\": 270,\n\t\t\t\t\"ip\": \"172.16.0.1\",\n\t\t\t\t\"routes_count\": 7,\n\t\t\t\t\"is_parent\": false,\n\t\t\t\t\"parent_vertex_id\": 40\n\t\t\t\t\"parent_cloud_id\": 45\n\t\t\t\t\"parent_cloud_name\": \"Cloud 172.16.0.1\",\n\t\t\t}\n\t\t]\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/cloud_suggestions","collectionId":"1","id":"1-14-60","method":"GET"},{"headers":"Accept: application/json\n","name":"Get topology network interfaces by device","data":[{"value":null,"type":"text","enabled":true,"key":"mgmtId"}],"dataMode":"params","description":"The returned interfaces are taken from the topology data and will include only devices that are topology enabled.
When adding a device, the user can can choose whether to use dynamic or static topology for the device,
this choice will determine which kind of data is stored in the topology graph and returned by this API.

The parameter mgmtId should be a cluster or a gateway, not a management server.
You may provide a generic device Id (see generic_devices API under 'Monitored Devices' category) -
in this case make sure you set 'is_generic' parameter to 'true'

Parameters:
context: Global MSSP context [optional]
mgmtId: Management Id or Generic Device Id to query
is_generic: Should be set to 'true' if the provided mgmtId is related to generic device [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_interfaces?mgmtId=10

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_interfaces?mgmtId=1&is_generic=true
","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/topology_interfaces","collectionId":"1","id":"1-14-61","method":"GET"},{"headers":"Accept: application/json\n","name":"Get most specific network interfaces from which a host IP is accessible","data":[{"value":null,"type":"text","enabled":true,"key":"host"}],"description":"Parameters:
context: Global MSSP context [optional]
host: IP address of device for a query

Usage Example
https://192.168.1.1/securetrack/api/devices/interfaces/last_hop?host=192.168.1.66
","dataMode":"params","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/interfaces/last_hop","collectionId":"1","id":"1-14-62","method":"GET"},{"headers":"Accept: application/json\n","name":"Get topology routing tables for a given device","data":[{"value":null,"type":"text","enabled":true,"key":"mgmtId"}],"dataMode":"params","description":"The returned routing tables are taken from the topology data and will include only devices that are topology enabled.
When adding a device, the user can can choose whether to use dynamic or static topology for the device,
this choice will determine which kind of data is stored in the topology graph and returned by this API.

The parameter mgmtId should be a cluster or a gateway, not a management server.
You may provide a generic device Id (see generic_devices API under 'Monitored Devices' category) -
in this case make sure you set 'is_generic' parameter to 'true'

Parameters:
mgmtId: Management Id or Generic Device Id to query
is_generic: Should be set to 'true' if the provided mgmtId is related to generic device [optional]
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query from starting page, allowable type is numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_routes?mgmtId=10

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_routes?mgmtId=1&is_generic=true
","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/topology_routes","collectionId":"1","id":"1-14-63","method":"GET"},{"headers":"Accept: application/json\n","name":"Get topology subnets","description":"Returns a list of the topology subnets for all the domains for which the user has permission to access.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
Use the optional name parameter to restrict the results to topology subnet names that match the search criteria provided, as follows:
1. If you provide only a mask, then an exact match search is done on the mask portion of the name
e.g. if name=/2, the results will include 1.2.3.4/2, but not 1.2.3.4/22
2. If you provide only a partial or complete IP address, then a contains search is done in the IPv4 block portion of the name
e.g. name=32, the results will include 192.168.205.32/24 and 55.192.32.22/16, but will not include 55.168.205.5/32
3. If you provide both an IPv4 address (either partial or complete) and a mask, then an exact match search is done
e.g. if name=23.4/2, then the results will include 192.168.23.4/2, but will not include 192.168.23.4/23 or 23.4.192.168/2

Use the optional ip parameter to restrict the results to topology subnets that contain this ip, see example below.

User can use ip or name parameter, not both.
The default pagination is start=0 and count=50.

Parameters:
context: Global MSSP context [optional]
name: Subnet name [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]
ip: Ip host [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/subnets?name=10.27
OUTPUT{
    \"topology_subnets\": {
        \"count\": 4,
        \"total\": 4,
        \"subnets\": [
            {
                \"id\": 615,
                \"name\": \"10.27.122.20/32\",
                \"ip\": \"10.27.122.20\",
                \"mask\": \"255.255.255.255\",
                \"domainIdTag\": 1
            },
            {
                \"id\": 616,
                \"name\": \"10.27.122.60/32\",
                \"ip\": \"10.27.122.60\",
                \"mask\": \"255.255.255.255\",
                \"domainIdTag\": 1
            },
            {
                \"id\": 619,
                \"name\": \"10.27.122.0/30\",
                \"ip\": \"10.27.122.0\",
                \"mask\": \"255.255.255.252\",
                \"domainIdTag\": 1
            },
            {
                \"id\": 620,
                \"name\": \"10.27.122.4/30\",
                \"ip\": \"10.27.122.4\",
                \"mask\": \"255.255.255.252\",
                \"domainIdTag\": 1
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/subnets?name=144/30
OUTPUT{
    \"topology_subnets\": {
        \"count\": 2,
        \"total\": 2,
        \"subnets\": [
            {
                \"id\": 773,
                \"name\": \"10.13.64.144/30\",
                \"ip\": \"10.13.64.144\",
                \"mask\": \"255.255.255.252\",
                \"domainIdTag\": 1
            },
            {
                \"id\": 825,
                \"name\": \"10.15.64.144/30\",
                \"ip\": \"10.15.64.144\",
                \"mask\": \"255.255.255.252\",
                \"domainIdTag\": 1
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/subnets?ip=10.27.122.3
OUTPUT{
    \"topology_subnets\": {
        \"count\": 4,
        \"total\": 4,
        \"subnets\": [
            {
                \"id\": 615,
                \"name\": \"10.27.122.0/24\",
                \"ip\": \"10.27.122.0\",
                \"mask\": \"255.255.255.0\",
                \"domainIdTag\": 1
            },
            {
                \"id\": 616,
                \"name\": \"10.27.0.0/16\",
                \"ip\": \"10.27.0.0\",
                \"mask\": \"255.255.0.0\",
                \"domainIdTag\": 1
            },
            {
                \"id\": 619,
                \"name\": \"10.0.0.0/8\",
                \"ip\": \"10.0.0.0\",
                \"mask\": \"255.0.0.0\",
                \"domainIdTag\": 1
            },
        ]
    }
}


Response Messages:
403: Access is denied
403: Only users with ‘Super admin’ permissions can access Global domain map
403: You do not have access permission to domain id: domainId
403: Using name and ip parameters is not allowed
403: Using Ipv6 in ip parameter is not supported
403: Ip parameter is not valid","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/subnets","collectionId":"1","id":"1-14-64","method":"GET"},{"headers":"Accept: application/json\n","name":"Delete Join Cloud","description":"Delete Join Cloud by Id.

Parameters:
cloudId [optional]
forceTopologyInit: Force Topology Init [optional]

Usage Example
https://{st_host}/securetrack/api/topology/join/clouds/67\n

Response Messages:
204: No Content.
400: Bad Request.
403: Access is denied.
404: Cloud Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/join/clouds/{{cloudId}}","collectionId":"1","id":"1-14-65","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get Join Cloud","description":"Get Join Cloud by Id.

Parameters:
cloudId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/join/clouds/67
OUTPUT{
    id: 67,
    name: \"Yami\",
    clouds: [
        1,
        2,
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Cloud Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/join/clouds/{{cloudId}}","collectionId":"1","id":"1-14-66","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Create generic Routes","dataMode":"raw","description":"Create generic Routes.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/route
BODY{
    \"GenericRoutes\": [
    {
        \"mgmtId\": 1,
        \"destination\": \"111.100.10.11\",
        \"mask\": \"255.255.0.0\",
        \"interfaceName\": \"YOLO3\",
        \"nextHop\": \"100.100.10.10\",
        \"nextHopType\": \"IP\",
        \"vrf\": \"V103-KO\"
    },
    {
        \"mgmtId\": 2,
        \"destination\": \"222.100.10.22\",
        \"mask\": \"255.255.0.0\",
        \"interfaceName\": \"catch22\",
        \"nextHop\": \"100.100.10.10\",
        \"nextHopType\": \"IP\",
        \"vrf\": \"V103-KO\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management Not Found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"GenericRoutes\": [\n\t{\n\t\t\"mgmtId\": 1,\n\t\t\"destination\": \"111.100.10.11\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"interfaceName\": \"YOLO3\",\n\t\t\"nextHop\": \"100.100.10.10\",\n\t\t\"nextHopType\": \"IP\",\n\t\t\"vrf\": \"V103-KO\"\n\t},\n\t{\n\t\t\"mgmtId\": 2,\n\t\t\"destination\": \"222.100.10.22\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"interfaceName\": \"catch22\",\n\t\t\"nextHop\": \"100.100.10.10\",\n\t\t\"nextHopType\": \"IP\",\n\t\t\"vrf\": \"V103-KO\"\n\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/","collectionId":"1","id":"1-14-67","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Update generic Routes","dataMode":"raw","description":"Update generic Routes.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/route
BODY{
    \"GenericRoutes\": [
    {
        \"id\": 29,
        \"mgmtId\": 3,
        \"destination\": \"111.100.10.11\",
        \"mask\": \"255.255.0.0\",
        \"interfaceName\": \"YOLO3\",
        \"nextHop\": \"100.100.10.10\",
        \"nextHopType\": \"IP\",
        \"vrf\": \"V103-KO\"
    },
    {
        \"id\": 30,
        \"mgmtId\": 3,
        \"destination\": \"222.100.10.22\",
        \"mask\": \"255.255.0.0\",
        \"interfaceName\": \"catch22\",
        \"nextHop\": \"100.100.10.10\",
        \"nextHopType\": \"IP\",
        \"vrf\": \"V103-KO\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Interface/Management Not Found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"GenericRoutes\": [\n\t{\n\t\t\"id\": 29,\n\t\t\"mgmtId\": 3,\n\t\t\"destination\": \"111.100.10.11\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"interfaceName\": \"YOLO3\",\n\t\t\"nextHop\": \"100.100.10.10\",\n\t\t\"nextHopType\": \"IP\",\n\t\t\"vrf\": \"V103-KO\"\n\t},\n\t{\n\t\t\"id\": 30,\n\t\t\"mgmtId\": 3,\n\t\t\"destination\": \"222.100.10.22\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"interfaceName\": \"catch22\",\n\t\t\"nextHop\": \"100.100.10.10\",\n\t\t\"nextHopType\": \"IP\",\n\t\t\"vrf\": \"V103-KO\"\n\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/","collectionId":"1","id":"1-14-68","method":"PUT"},{"headers":"Accept: application/json\n","name":"Delete generic Routes","description":"Delete all generic Routes from management Id.

Parameters:
mgmtId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/route/mgmt/2\n

Response Messages:
200: 11 Generic Routes were deleted from mgmtId 2.
400: Bad Request.
403: Access is denied.
404: Management Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/mgmt/{{mgmtId}}","collectionId":"1","id":"1-14-69","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get generic Routes","description":"Get generic Routes of management Id.

Parameters:
mgmtId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/route/mgmt/2
OUTPUT{
    GenericRoutes: [
    {
        id: 27,
        mgmtId: 2,
        destination: \"10.4.4.4\",
        mask: \"255.0.0.0\",
        interfaceName: \"\",
        nextHop: \"AA\",
        nextHopType: \"VR\",
        vrf: \"V102-YO\"
    },
    {
        id: 28,
        mgmtId: 2,
        destination: \"10.4.5.5\",
        mask: \"255.0.0.0\",
        interfaceName: \"eeee\",
        nextHop: \"\",
        nextHopType: \"IP\",
        vrf: \"V101-PA\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/mgmt/{{mgmtId}}","collectionId":"1","id":"1-14-70","method":"GET"},{"name":"Update an existing generic device in the Topology model","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Modify an existing generic device by uploading a new configuration file and/or specifying a new name.
If name field is specified, the generic device will be renamed.
configuration_file is optional, if provided it must include a valid generic device configuration.
The specified path points to a file in the client machine.
If a generic device name is changed and a new configuration file is not provided, topology will not be synchronized (update_topology flag is ignored).
Default value for update_topology = true.
To save time when there are several consecutive api calls: For the last call, set update_topology = true (for all other calls, update_topology = false).
For more information on input file formats, refer to Knowledge Center topic 'Adding and Updating a Generic Device'.

Parameters:
id: Generic device id
body: Generic device to be updated [optional]
configuration_file: Configuration File for generic device [optional]
update_topology: Synchronize And Update Topology [optional]

Usage Example
curl -X PUT -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F \"configuration_file=@/tmp/config.txt;type=application/octet-stream\" -F \"update_topology=true\" https://192.168.1.1/securetrack/api/generic_devices/24

Usage Example
curl -X PUT -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F 'device_data={\"generic_device\":{\"name\": \"new_generic_device_name\"}};type=application/json' -F \"update_topology=false\" https://192.168.1.1/securetrack/api/generic_devices/72

Response Messages:
204: The generic device was updated successfully.
400: A new name or a new configuration file must be indicated in order to update generic device with id {}
400: Failed to update generic device with id {}
404: A 'Generic Device' with the specified ID was not found","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/{{id}}","collectionId":"1","id":"1-14-71","method":"PUT"},{"name":"Delete generic device from Topology model","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Delete a generic device from the Topology model.
The ID must be for a valid generic device listed in the Topology Model.
If update update_topology = true, then the Topology model will be updated immediately after the device is deleted.
For maximum efficiency, if you are deleting multiple generic devices in consecutive API calls, you can set update_topology = false on all API calls except for the last one. On the last call, set update_toplogy = true.
Default value for update_topology = true.

Parameters:
id: Generic device id
update_topology: Synchronize And Update Topology [optional]

Usage Example
https://192.168.1.1/securetrack/api/generic_devices/1

Usage Example
https://192.168.1.1/securetrack/api/generic_devices/10?update_topology=false

Response Messages:
204: Generic Device deleted successfully.
400: Failed to delete generic device with id {}
404: A 'Generic Device' with the specified ID was not found","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/{{id}}","collectionId":"1","id":"1-14-72","method":"DELETE"},{"name":"Get path image for specified traffic","data":[{"value":null,"type":"text","enabled":true,"key":"src"},{"value":null,"type":"text","enabled":true,"key":"dst"},{"value":null,"type":"text","enabled":true,"key":"service"}],"dataMode":"params","description":"Returns an image containing one or more paths for the specified traffic.
src and dst parameters may contain multiple, comma separated values.
Service parameter can be a port (for example, “tcp:80”, “any”) or an application (for example, “Skype”, “Facebook”).
Application names are case sensitive.
Service parameter can also be a combination of ports and applications, for example “tcp:80, Skype, Facebook”
If sourceDomainIdTag is provided, the path starting points will be restricted to the specified domain ID. sourceDomainIdTag is valid only if overlapping IP mode is enabled.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is valid only if MSSP mode is enabled.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.
displayIncompletePaths parameter default value is false, if this parameter is set to true -
all nodes on the path will be displayed, even if the node cannot reach the destination, or if the source and destination are the same.
displayBlockedStatus parameter default value is false, if this parameter is set to true -
blocked traffic icons will be displayed next to devices blocking the traffic.
simulateNat parameter default value is true if this parameter is set to false - NAT simulation will not be used when calculating the path.
lastInstall parameter default value is true, which means simulation would use last installed policies. If this parameter is set to false - simulation would use last saved policies.
This API cannot be executed more than 10 times in parallel.

Parameters:
context: Global MSSP context [optional]
src: Source address/addresses
dst: Destination address/addresses
service: Service/services
sourceDomainIdTag: Path starting point Domain Id [optional]
displayIncompletePaths: Display incomplete paths [optional]
displayBlockedStatus: Display blocked traffic status icons [optional]
simulateNat: Simulate NAT [optional]
lastInstall: Last Installed [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/path_image?src=10.10.10.1&dst=3.3.3.3:32&service=any

Usage Example
https://192.168.1.1/securetrack/api/topology/path_image?src=10.10.10.1&dst=3.3.3.3:32&service=Facebook,tcp:80
","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/path_image","collectionId":"1","id":"1-14-73","method":"GET"},{"headers":"Accept: application/json\n","name":"Delete generic Interface","description":"Delete a generic Interface by Id.

Parameters:
inId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/interface/5\n

Response Messages:
204: No Content.
400: Bad Request.
403: Access is denied.
404: Generic Interface Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface/{{inId}}","collectionId":"1","id":"1-14-74","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get generic Interface","description":"Get a generic Interface by Id.

Parameters:
inId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interface/212
OUTPUT{
    GenericInterface: {
        id: 212,
        mgmtId: 1,
        name: \"newApo5\",
        ip: \"100.103.33.33\",
        mask: \"255.255.255.0\",
        vrf: \"V101-PAL\",
        mpls: false,
        unnumbered: false,
        type: \"external\"
    }
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Generic Interface Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface/{{inId}}","collectionId":"1","id":"1-14-75","method":"GET"},{"headers":"Accept: application/json\n","name":"Get generic Interfaces","description":"Get generic Interfaces of management Id.

Parameters:
mgmtId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interface/mgmt/1
OUTPUT{
    GenericInterfaces: [
    {
        id: 206,
        mgmtId: 1,
        name: \"newApo3\",
        ip: \"100.103.33.33\",
        mask: \"255.255.255.0\",
        vrf: \"V101-PA\",
        mpls: false,
        unnumbered: false,
        type: \"external\"
    },
    {
        id: 208,
        mgmtId: 1,
        name: \"newApo4\",
        ip: \"100.103.33.34\",
        mask: \"255.255.255.0\",
        vrf: \"V101-PA\",
        mpls: false,
        unnumbered: false,
        type: \"internal\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface/mgmt/{{mgmtId}}","collectionId":"1","id":"1-14-76","method":"GET"},{"headers":"Accept: application/json\n","name":"Delete generic Interfaces","description":"Delete all generic Interfaces from management Id.

Parameters:
mgmtId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/interface/mgmt/2\n

Response Messages:
200: 11 Generic Interfaces were deleted from mgmtId 2.
400: Bad Request.
403: Access is denied.
404: Management Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface/mgmt/{{mgmtId}}","collectionId":"1","id":"1-14-77","method":"DELETE"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Update manual Interface CustomerTags","dataMode":"raw","description":"Update manual Interface CustomerTags.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interfacecustomer
BODY{
    \"InterfaceCustomerTags\":
    [
        {
            \"id\": 73,
            \"generic\": false,
            \"deviceId\": 5,
            \"interfaceName\": \"port5\",
            \"customerId\": 2
        },
        {
            \"id\": 74,
            \"generic\": false,
            \"deviceId\": 5,
            \"interfaceName\": \"port3\",
            \"customerId\": 3
        }
    ]
}


Response Messages:
200: OK.
400: Interface CustomerTag already exist for deviceId-InterfaceName/Interface not found on deviceId
403: Access is denied.
404: Management/GenericDevice Not Found./Customer Id not found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"InterfaceCustomerTags\": \n\t[\n\t\t{\n\t\t\t\"id\": 73,\n\t\t\t\"generic\": false,\n\t\t\t\"deviceId\": 5,\n\t\t\t\"interfaceName\": \"port5\",\n\t\t\t\"customerId\": 2\n\t\t},\n\t\t{\n\t\t\t\"id\": 74,\n\t\t\t\"generic\": false,\n\t\t\t\"deviceId\": 5,\n\t\t\t\"interfaceName\": \"port3\",\n\t\t\t\"customerId\": 3\n\t\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/","collectionId":"1","id":"1-14-78","method":"PUT"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Create manual Interface CustomerTags","dataMode":"raw","description":"Create manual Interface CustomerTags.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interfacecustomer
BODY{
    \"InterfaceCustomerTags\":
    [
        {
            \"generic\": false,
            \"deviceId\": 5,
            \"interfaceName\": \"port4\",
            \"customerId\": 2
        },
        {
            \"generic\": false,
            \"deviceId\": 6,
            \"interfaceName\": \"port3\",
            \"customerId\": 3
        }
    ]
}


Response Messages:
200: OK.
400: Interface CustomerTag already exist for deviceId-InterfaceName/Interface not found on deviceId
403: Access is denied.
404: Management/GenericDevice Not Found./Customer Id not found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"InterfaceCustomerTags\": \n\t[\n\t\t{\n\t\t\t\"generic\": false,\n\t\t\t\"deviceId\": 5,\n\t\t\t\"interfaceName\": \"port4\",\n\t\t\t\"customerId\": 2\n\t\t},\n\t\t{\n\t\t\t\"generic\": false,\n\t\t\t\"deviceId\": 6,\n\t\t\t\"interfaceName\": \"port3\",\n\t\t\t\"customerId\": 3\n\t\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/","collectionId":"1","id":"1-14-79","method":"POST"},{"headers":"Accept: application/json\n","name":"Delete manual Interface CustomerTags","description":"Delete all manual Interface CustomerTags from management/genericDevice Id.

Parameters:
deviceId [optional]
generic [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/interfacecustomer/device/6?generic=false\n

Response Messages:
200: 2 Interface Customers were deleted from deviceId 6.
400: Bad Request.
403: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/device/{{deviceId}}","collectionId":"1","id":"1-14-80","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get manual Interface CustomerTags","description":"Get manual Interface CustomerTags of management/genericDevice Id.

Parameters:
deviceId [optional]
generic [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interfacecustomer/device/5?generic=false
OUTPUT{
    InterfaceCustomerTags: [
        {
            id: 73,
            generic: false,
            deviceId: 5,
            interfaceName: \"port4\",
            customerId: 2
        },
        {
            id: 74,
            generic: false,
            deviceId: 5,
            interfaceName: \"port4.1\",
            customerId: 3
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/device/{{deviceId}}","collectionId":"1","id":"1-14-81","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Update a cloud","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"raw","description":"Modify the name of a topology cloud, and add/remove members of a joined cloud.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
Multi-Domain user must have access permission to the domain context of the joined cloud, and any members specified in the body.
To change the name of a topology cloud, enter a value in the name field of the body.
To add/remove members of a joined cloud, specify the action and specify the clouds in the members list of the body.
The action is used only if the body contains a members list. If a members list is provided but no actions is specified, then the default action is ‘add’.
When adding cloud members, clouds included in the members list of the body must not be joined clouds or members of another joined cloud.
When removing cloud members, if only zero or one member remains in the joined cloud, it will be deleted from the Interactive Map.

Parameters:
id: cloud id
action: action [optional]
body: Cloud data
forceTopologyInit: Force Topology Init [optional]

Usage Example
URLfor renaming of any cloud - https://192.168.1.1/securetrack/api/topology/clouds/436
BODY{
    \"cloud_data\":{
        \"cloud_name\" : \"new cloud\"
    }
}


Usage Example
URLfor renaming and members updating of a joined cloud - https://192.168.1.1/securetrack/api/topology/clouds/436?action=remove
BODY{
    \"cloud_data\":{
        \"cloud_name\" : \"new cloud\",
        \"cloud_members\" : [118,179,258]
    }
}


Response Messages:
204: Cloud updated successfully
403: Access is denied
403: You do not have access permission to the domain for cloud with id ID
404: Cloud with id ID was not found in the provided MSSP domain
412: Cloud with id ID is a not joined cloud
412: Cloud id: cloudId does not belong to domain: Context
412: Provided clouds don't belongs to the same domain
412: Cloud with id ID is a joined cloud
412: Cloud with id ID is a member of a joined cloud
412: Member cloud with id ID cannot be removed - it is not a member of a joined cloud","folder":"1-14","rawModeData":"{\n\t\"cloud_data\":{\n\t\t\"cloud_name\" : \"new cloud\",\n\t\t\"cloud_members\" : [118,179,258]\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds/{{id}}","collectionId":"1","id":"1-14-82","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get Specific topology cloud","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the topology cloud data for the specified id.
This API requires 'Super admin' or 'Multi-Domain admin' privileges.
Multi-Domain user must have access permission to the domain where the cloud resides.

Parameters:
id: Cloud id

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds/48
OUTPUT{
    \"topology_cloud\": {
        \"id\": 48,
        \"name\": \"Cloud 69.70.120.155\",
        \"domain\": 1,
        \"type\": \"NON_JOINED\",
        \"ip\": \"69.70.120.155\"
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds/66
OUTPUT{
    \"topology_cloud\": {
        \"id\": 66,
        \"name\": \"Cloud 10.100.10.14\",
        \"domain\": 1,
        \"type\": \"JOINED\",
        \"members\": [
            {
                \"id\": 50,
                \"ip\": \"10.100.6.238\",
                \"name\": \"Cloud 10.100.6.238\"
            },
            {
                \"id\": 73,
                \"ip\": \"10.100.10.14\",
                \"name\": \"Cloud 10.100.10.14\"
            },
            {
                \"id\": 74,
                \"ip\": \"10.100.9.9\",
                \"name\": \"Cloud 10.100.9.9\"
            }
        ]
    }
}


Response Messages:
403: Access is denied
403: You do not have access permission to the domain for cloud with id ID
404: No cloud was found for the provided ID","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds/{{id}}","collectionId":"1","id":"1-14-83","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Update generic Interfaces","dataMode":"raw","description":"Update generic Interfaces.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interface
BODY{
    \"GenericInterfaces\": [
    {
        \"id\": 204,
        \"mgmtId\": 1,
        \"name\": \"NewBob1\",
        \"ip\": \"100.100.45.55\",
        \"mask\": \"255.255.0.0\",
        \"vrf\": \"V101-LV\",
        \"mpls\": false,
        \"unnumbered\": false,
        \"type\": null
    },
    {
        \"id\": 205,
        \"mgmtId\": 2,
        \"name\": \"NewBob2\",
        \"ip\": \"100.100.45.55\",
        \"mask\": \"255.255.255.0\",
        \"vrf\": \"V101-LV\",
        \"mpls\": false,
        \"unnumbered\": false,
        \"type\": \"external\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Interface/Management Not Found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"GenericInterfaces\": [\n\t{\n\t\t\"id\": 204,\n\t\t\"mgmtId\": 1,\n\t\t\"name\": \"NewBob1\",\n\t\t\"ip\": \"100.100.45.55\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"vrf\": \"V101-LV\",\n\t\t\"mpls\": false,\n\t\t\"unnumbered\": false,\n\t\t\"type\": null\n\t},\n\t{\n\t\t\"id\": 205,\n\t\t\"mgmtId\": 2,\n\t\t\"name\": \"NewBob2\",\n\t\t\"ip\": \"100.100.45.55\",\n\t\t\"mask\": \"255.255.255.0\",\n\t\t\"vrf\": \"V101-LV\",\n\t\t\"mpls\": false,\n\t\t\"unnumbered\": false,\n\t\t\"type\": \"external\"\n\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface","collectionId":"1","id":"1-14-84","method":"PUT"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Create generic Interfaces","dataMode":"raw","description":"Create generic Interfaces.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interface
BODY{
    \"GenericInterfaces\": [
    {
        \"mgmtId\": 1,
        \"name\": \"Bob1\",
        \"ip\": \"100.100.45.55\",
        \"mask\": \"255.255.0.0\",
        \"vrf\": \"V101-PA\",
        \"mpls\": false,
        \"unnumbered\": false,
        \"type\": \"external\"
    },
    {
        \"mgmtId\": 2,
        \"name\": \"Bob2\",
        \"ip\": \"100.100.45.66\",
        \"mask\": \"255.255.255.0\",
        \"vrf\": \"V101-BA\",
        \"mpls\": false,
        \"unnumbered\": false,
        \"type\": \"external\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management Not Found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"GenericInterfaces\": [\n\t{\n\t\t\"mgmtId\": 1,\n\t\t\"name\": \"Bob1\",\n\t\t\"ip\": \"100.100.45.55\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"vrf\": \"V101-PA\",\n\t\t\"mpls\": false,\n\t\t\"unnumbered\": false,\n\t\t\"type\": \"external\"\n\t},\n\t{\n\t\t\"mgmtId\": 2,\n\t\t\"name\": \"Bob2\",\n\t\t\"ip\": \"100.100.45.66\",\n\t\t\"mask\": \"255.255.255.0\",\n\t\t\"vrf\": \"V101-BA\",\n\t\t\"mpls\": false,\n\t\t\"unnumbered\": false,\n\t\t\"type\": \"external\"\n\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface","collectionId":"1","id":"1-14-85","method":"POST"},{"headers":"Accept: application/json\n","name":"Get path domains for specified traffic","data":[{"value":null,"type":"text","enabled":true,"key":"src"},{"value":null,"type":"text","enabled":true,"key":"dst"},{"value":null,"type":"text","enabled":true,"key":"service"}],"dataMode":"params","description":"Returns one or more domain entries for the specified traffic.
src and dst parameters may contain multiple, comma separated values.
Service parameter can be a port (for example, “tcp:80”, “any”) or an application (for example, “Skype”, “Facebook”).
Application names are case sensitive.
Service parameter can also be a combination of ports and applications, for example “tcp:80, Skype, Facebook”
If sourceDomainIdTag is provided, the path starting points will be restricted to the specified domain ID. sourceDomainIdTag is valid only if overlapping IP mode is enabled.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is valid only if MSSP mode is enabled.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.
includeIncompletePaths parameter default value is false, if this parameter is set to true -
all nodes on the path will be included, even if the node cannot reach the destination, or if the source and destination are the same.
simulateNat parameter default value is true if this parameter is set to false - NAT simulation will not be used when calculating the path.
lastInstall parameter default value is true, which means simulation would use last installed policies. If this parameter is set to false - simulation would use last saved policies.
This API cannot be executed more than 10 times in parallel.

Parameters:
context: Global MSSP context [optional]
src: Source address/addresses
dst: Destination address/addresses
service: Service/services
sourceDomainIdTag: Path starting point Domain Id [optional]
includeIncompletePaths: Include incomplete paths [optional]
simulateNat: Simulate NAT [optional]
lastInstall: Last Installed [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/path_domains?src=10.10.10.1&dst=3.3.3.3:32&service=any

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/path_domains?src=10.0.2.1&dst=10.0.1.1&service=Facebook,tcp:80
OUTPUT {
    \"path_domain_entries\": {
        \"path_domain_entry\": [
                {
                        \"domainId\": \"1\",
                        \"vertex\": \"Subnet 10.0.2.0/24\",
                        \"entryType\": \"STARTING_POINT\",
                }
                {
                        \"domainId\": \"1\",
                        \"vertex\": \"Subnet 10.0.1.0/24\",
                        \"entryType\": \"ENDING_POINT\",
                }
    ]
}

","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/path_domains","collectionId":"1","id":"1-14-86","method":"GET"},{"headers":"Accept: application/json\n","name":"Get manual Interface CustomerTag","description":"Get manual Interface CustomerTag by Id.

Parameters:
interfaceCustomerId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interfacecustomer/74
OUTPUT{
    InterfaceCustomerTag: {
        id: 74,
        generic: false,
        deviceId: 5,
        interfaceName: \"port4.1\",
        customerId: 3
    }
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: InterfaceCustomer Id 74 not found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/{{interfaceCustomerId}}","collectionId":"1","id":"1-14-87","method":"GET"},{"headers":"Accept: application/json\n","name":"Delete manual Interface CustomerTag","description":"Delete a manual Interface CustomerTag by Id.

Parameters:
interfaceCustomerId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/interfacecustomer/66\n

Response Messages:
204: No Content.
400: Bad Request.
403: Access is denied.
404: InterfaceCustomer Id 66 not found
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/{{interfaceCustomerId}}","collectionId":"1","id":"1-14-88","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get Ignored Interfaces.","description":"Get Ignored Interfaces by management id.

Parameters:
mgmtId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/ignoredinterface/mgmt/10
OUTPUT{
    IgnoredInterfaces: [
        {
            interfaceName: \"eth2\",
            mgmtId: 10,
            ip: \"0.0.0.0\"
        },
        {
            interfaceName: \"loopback100\",
            mgmtId: 10,
            ip: \"34.34.34.34\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/ignoredinterface/mgmt/{{mgmtId}}","collectionId":"1","id":"1-14-89","method":"GET"},{"headers":"Accept: application/json\n","name":"Delete Ignored Interfaces.","description":"Delete Ignored Interfaces by management id.

Parameters:
mgmtId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/ignoredinterface/mgmt/10\n

Response Messages:
200: 2 entries deleted where mgmtId = 10
400: Bad Request.
403: Access is denied.
404: Management Id 10 not found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/ignoredinterface/mgmt/{{mgmtId}}","collectionId":"1","id":"1-14-90","method":"DELETE"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Create Ignored Interfaces.","dataMode":"raw","description":"Create Ignored Interfaces.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/ignoredinterface
BODY{
    \"IgnoredInterfaces\":
    [
        {
            \"interfaceName\" : \"eth2\",
            \"mgmtId\" : 10,
            \"ip\" : \"0.0.0.0\"
        },
        {
            \"interfaceName\" : \"loopback100\",
            \"mgmtId\" : 10,
            \"ip\" : \"34.34.34.34\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management Id 10 not found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"IgnoredInterfaces\": \n\t[\n\t\t{\n\t\t\t\"interfaceName\" : \"eth2\",\n\t\t\t\"mgmtId\" : 10,\n\t\t\t\"ip\" : \"0.0.0.0\"\n\t\t},\n\t\t{\n\t\t\t\"interfaceName\" : \"loopback100\",\n\t\t\t\"mgmtId\" : 10,\n\t\t\t\"ip\" : \"34.34.34.34\"\n\t\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/ignoredinterface","collectionId":"1","id":"1-14-91","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Update generic Vpns","dataMode":"raw","description":"Update generic Vpns.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/vpn
BODY{
    \"GenericVpns\": [
    {
        \"id\": 24,
        \"generic\": true,
        \"deviceId\": 3,
        \"interfaceName\": \"new33\",
        \"vpnName\": null,
        \"tunnelSourceIpAddr\": \"3.3.3.33\",
        \"tunnelDestIpAddr\": \"1.1.1.11\"
    },
    {
        \"id\": 25,
        \"generic\": false,
        \"deviceId\": 1,
        \"interfaceName\": \"new111\",
        \"vpnName\": null,
        \"tunnelSourceIpAddr\": \"1.1.1.11\",
        \"tunnelDestIpAddr\": \"3.3.3.33\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Vpn/Management/GenericDevice Not Found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"GenericVpns\": [\n\t{\n\t\t\"id\": 24,\n\t\t\"generic\": true,\n\t\t\"deviceId\": 3,\n\t\t\"interfaceName\": \"new33\",\n\t\t\"vpnName\": null,\n\t\t\"tunnelSourceIpAddr\": \"3.3.3.33\",\n\t\t\"tunnelDestIpAddr\": \"1.1.1.11\"\n\t},\n\t{\n\t\t\"id\": 25,\n\t\t\"generic\": false,\n\t\t\"deviceId\": 1,\n\t\t\"interfaceName\": \"new111\",\n\t\t\"vpnName\": null,\n\t\t\"tunnelSourceIpAddr\": \"1.1.1.11\",\n\t\t\"tunnelDestIpAddr\": \"3.3.3.33\"\n\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/","collectionId":"1","id":"1-14-92","method":"PUT"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Create generic Vpns","dataMode":"raw","description":"Create generic Vpns.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/vpn
BODY{
    \"GenericVpns\": [
    {
        \"generic\": true,
        \"deviceId\": 3,
        \"interfaceName\": \"33\",
        \"vpnName\": null,
        \"tunnelSourceIpAddr\": \"3.3.3.33\",
        \"tunnelDestIpAddr\": \"1.1.1.11\"
    },
    {
        \"generic\": false,
        \"deviceId\": 1,
        \"interfaceName\": \"111\",
        \"vpnName\": null,
        \"tunnelSourceIpAddr\": \"1.1.1.11\",
        \"tunnelDestIpAddr\": \"3.3.3.33\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"GenericVpns\": [\n\t{\n\t\t\"generic\": true,\n\t\t\"deviceId\": 3,\n\t\t\"interfaceName\": \"33\",\n\t\t\"vpnName\": null,\n\t\t\"tunnelSourceIpAddr\": \"3.3.3.33\",\n\t\t\"tunnelDestIpAddr\": \"1.1.1.11\"\n\t},\n\t{\n\t\t\"generic\": false,\n\t\t\"deviceId\": 1,\n\t\t\"interfaceName\": \"111\",\n\t\t\"vpnName\": null,\n\t\t\"tunnelSourceIpAddr\": \"1.1.1.11\",\n\t\t\"tunnelDestIpAddr\": \"3.3.3.33\"\n\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/","collectionId":"1","id":"1-14-93","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Create Transparent Firewalls","dataMode":"raw","description":"Create Transparent Firewalls.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/transparentfw
BODY{
    \"TransparentFirewalls\":
    [
     {
            \"outputL3DeviceId\" : 22,
            \"outputL3IsGenericDevice\" : false,
            \"outputL3InterfaceName\" : \"FastEthernet0/0\",
            \"outputL3InterfaceIp\" : \"\",
            \"layer2DeviceId\" : 21,
            \"inputL2InterfaceName\" : \"inside\",
            \"outputL2InterfaceName\" : \"outside\",
            \"inputL3DeviceId\" : 20,
            \"inputL3IsGenericDevice\" : false,
            \"inputL3InterfaceName\" : \"Loopback0\",
            \"inputL3InterfaceIp\" : \"\"
        },
        {
            \"outputL3DeviceId\" : 23,
            \"outputL3IsGenericDevice\" : false,
            \"outputL3InterfaceName\" : \"FastEthernet2/0\",
            \"outputL3InterfaceIp\" : \"\",
            \"layer2DeviceId\" : 9,
            \"inputL2InterfaceName\" : \"inside\",
            \"outputL2InterfaceName\" : \"outside\",
            \"inputL3DeviceId\" : 17,
            \"inputL3IsGenericDevice\" : false,
            \"inputL3InterfaceName\" : \"mgmt\",
            \"inputL3InterfaceIp\" : \"\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Device Id 23 not found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"TransparentFirewalls\": \n\t[\n\t {\n\t\t\t\"outputL3DeviceId\" : 22,\n\t\t\t\"outputL3IsGenericDevice\" : false,\n\t\t\t\"outputL3InterfaceName\" : \"FastEthernet0/0\",\n\t\t\t\"outputL3InterfaceIp\" : \"\",\n\t\t\t\"layer2DeviceId\" : 21,\n\t\t\t\"inputL2InterfaceName\" : \"inside\",\n\t\t\t\"outputL2InterfaceName\" : \"outside\",\n\t\t\t\"inputL3DeviceId\" : 20,\n\t\t\t\"inputL3IsGenericDevice\" : false,\n\t\t\t\"inputL3InterfaceName\" : \"Loopback0\",\n\t\t\t\"inputL3InterfaceIp\" : \"\"\n\t\t},\n\t\t{\n\t\t\t\"outputL3DeviceId\" : 23,\n\t\t\t\"outputL3IsGenericDevice\" : false,\n\t\t\t\"outputL3InterfaceName\" : \"FastEthernet2/0\",\n\t\t\t\"outputL3InterfaceIp\" : \"\",\n\t\t\t\"layer2DeviceId\" : 9,\n\t\t\t\"inputL2InterfaceName\" : \"inside\",\n\t\t\t\"outputL2InterfaceName\" : \"outside\",\n\t\t\t\"inputL3DeviceId\" : 17,\n\t\t\t\"inputL3IsGenericDevice\" : false,\n\t\t\t\"inputL3InterfaceName\" : \"mgmt\",\n\t\t\t\"inputL3InterfaceIp\" : \"\"\n\t\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw","collectionId":"1","id":"1-14-94","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Update Transparent Firewalls","dataMode":"raw","description":"Update Transparent Firewalls.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/transparentfw
BODY{
    \"TransparentFirewalls\":
    [
     {
            \"id\" : 25,
            \"outputL3DeviceId\" : 22,
            \"outputL3IsGenericDevice\" : false,
            \"outputL3InterfaceName\" : \"FastEthernet0/0\",
            \"outputL3InterfaceIp\" : \"\",
            \"layer2DeviceId\" : 21,
            \"inputL2InterfaceName\" : \"inside\",
            \"outputL2InterfaceName\" : \"outside\",
            \"inputL3DeviceId\" : 20,
            \"inputL3IsGenericDevice\" : false,
            \"inputL3InterfaceName\" : \"Loopback2\",
            \"inputL3InterfaceIp\" : \"\"
        },
        {
            \"id\" : 27,
            \"outputL3DeviceId\" : 23,
            \"outputL3IsGenericDevice\" : false,
            \"outputL3InterfaceName\" : \"FastEthernet2/0\",
            \"outputL3InterfaceIp\" : \"\",
            \"layer2DeviceId\" : 9,
            \"inputL2InterfaceName\" : \"inside\",
            \"outputL2InterfaceName\" : \"outside\",
            \"inputL3DeviceId\" : 17,
            \"inputL3IsGenericDevice\" : false,
            \"inputL3InterfaceName\" : \"mgmt2\",
            \"inputL3InterfaceIp\" : \"\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Device Id 23 not found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"TransparentFirewalls\": \n\t[\n\t {\n\t\t\t\"id\" : 25,\n\t\t\t\"outputL3DeviceId\" : 22,\n\t\t\t\"outputL3IsGenericDevice\" : false,\n\t\t\t\"outputL3InterfaceName\" : \"FastEthernet0/0\",\n\t\t\t\"outputL3InterfaceIp\" : \"\",\n\t\t\t\"layer2DeviceId\" : 21,\n\t\t\t\"inputL2InterfaceName\" : \"inside\",\n\t\t\t\"outputL2InterfaceName\" : \"outside\",\n\t\t\t\"inputL3DeviceId\" : 20,\n\t\t\t\"inputL3IsGenericDevice\" : false,\n\t\t\t\"inputL3InterfaceName\" : \"Loopback2\",\n\t\t\t\"inputL3InterfaceIp\" : \"\"\n\t\t},\n\t\t{\n\t\t\t\"id\" : 27,\n\t\t\t\"outputL3DeviceId\" : 23,\n\t\t\t\"outputL3IsGenericDevice\" : false,\n\t\t\t\"outputL3InterfaceName\" : \"FastEthernet2/0\",\n\t\t\t\"outputL3InterfaceIp\" : \"\",\n\t\t\t\"layer2DeviceId\" : 9,\n\t\t\t\"inputL2InterfaceName\" : \"inside\",\n\t\t\t\"outputL2InterfaceName\" : \"outside\",\n\t\t\t\"inputL3DeviceId\" : 17,\n\t\t\t\"inputL3IsGenericDevice\" : false,\n\t\t\t\"inputL3InterfaceName\" : \"mgmt2\",\n\t\t\t\"inputL3InterfaceIp\" : \"\"\n\t\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw","collectionId":"1","id":"1-14-95","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get Transparent Firewalls","description":"Get Transparent Firewalls for participated managed/generic DeviceId

Parameters:
deviceId [optional]
generic [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/transparentfw/device/9?generic=false
OUTPUT{
    TransparentFirewalls: [
        {
            id: 17,
            outputL3DeviceId: 22,
            outputL3IsGenericDevice: false,
            outputL3InterfaceName: \"FastEthernet0/0\",
            layer2DeviceId: 9,
            inputL2InterfaceName: \"inside\",
            outputL2InterfaceName: \"outside\",
            inputL3DeviceId: 1,
            inputL3IsGenericDevice: true,
            inputL3InterfaceName: \"interface2\"
        },
        {
            id: 23,
            outputL3DeviceId: 23,
            outputL3IsGenericDevice: false,
            outputL3InterfaceName: \"FastEthernet2/0\",
            layer2DeviceId: 9,
            inputL2InterfaceName: \"inside\",
            outputL2InterfaceName: \"outside\",
            inputL3DeviceId: 17,
            inputL3IsGenericDevice: false,
            inputL3InterfaceName: \"mgmt\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw/device/{{deviceId}}","collectionId":"1","id":"1-14-96","method":"GET"},{"headers":"Accept: application/json\n","name":"Delete Transparent Firewalls.","description":"Delete Transparent Firewalls for participated layer 2 deviceId

Parameters:
deviceId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/transparentfw/device/9\n

Response Messages:
200: 4 entries deleted where layer2 deviceId = 9
400: Bad Request.
403: Access is denied.
404: DeviceId 9 not found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw/device/{{deviceId}}","collectionId":"1","id":"1-14-97","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Delete Transparent Firewall","description":"Delete Transparent Firewall by Id.

Parameters:
layer2DataId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/transparentfw/17\n

Response Messages:
200: layer2DataId 17 deleted.
400: Bad Request.
403: Access is denied.
404: Layer2Data Id 17 not found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw/{{layer2DataId}}","collectionId":"1","id":"1-14-98","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get Specific topology subnet","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the subnet for the specified id, including information regarding attached devices and join candidates.
This API requires 'Super admin' or 'Multi-Domain admin' privileges.
Multi-Domain user must have access permission to the domain where the subnet resides.

Parameters:
id: Subnet id

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/subnets/20
OUTPUT{
    \"subnet\": {
        \"id\": 18,
        \"name\": \"90.0.0.0/24\",
        \"ip\": \"90.0.0.0\",
        \"mask\": \"255.255.255.0\",
        \"attached_devices\": {
            \"attached_device\": [
                {
                    \"is_generic\": false,
                    \"id\": 10,
                    \"name\": \"srx\",
                    \"interface_id\": 4,
                    \"interface_name\": \"eth0\",
                    \"interface_ip\": \"90.0.0.1\"
                },
                {
                    \"is_generic\": false,
                    \"id\": 13,
                    \"name\": \"ZBFW\",
                    \"interface_id\": 5,
                    \"interface_name\": \"eth1\",
                    \"interface_ip\": \"90.0.0.124\"
                },
                {
                    \"is_generic\": false,
                    \"id\": 85,
                    \"name\": \"netscreen\",
                    \"interface_id\": 6,
                    \"interface_name\": \"eth2\",
                    \"interface_ip\": \"90.0.0.50\"
                }
            ]
        },
        \"join_candidates\": {
            \"join_candidate\": {
                \"is_generic\": false,
                \"id\": 72,
                \"name\": \"CP25\",
                \"interface_id\": 14,
                \"interface_name\": \"eth24/1\",
                \"interface_ip\": \"90.0.0.83\"
            }
        }
    }
}


Response Messages:
403: Access is denied
403: You do not have access permission to the domain for subnet with id ID
404: No subnet was found for the provided ID","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/subnets/{{id}}","collectionId":"1","id":"1-14-99","method":"GET"},{"headers":"Accept: application/json\n","name":"Get Cloud Internal Networks","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the internal networks for the specified Cloud management id.
This API requires 'Super admin' privileges.

Parameters:
id: Cloud management id

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/cloud_internal_networks/20
OUTPUT{
    \"network_list\":
    {
        \"count\": 3,
        \"total\": 3,
        \"network\":
        {
            \"ip\": \"10.27.122.20\",
            \"mask\": \"255.255.255.255\"
        },
        \"network\":
        {
            \"ip\": \"10.27.122.60\",
            \"mask\": \"255.255.255.255\"
        },
        \"network\":
        {
            \"ip\": \"10.27.122.4\",
            \"mask\": \"255.255.255.252\"
        }
    }
}


Response Messages:
403: Access is denied
403: You do not have access permission to the domain for NSX with id ID
403: Device ID specified is not supported
404: The specified device ID was not found
404: The specified device ID was not found in Topology","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/cloud_internal_networks/{{id}}","collectionId":"1","id":"1-14-100","method":"GET"},{"headers":"Accept: application/json\n","name":"Get topology clouds","description":"Returns a list of the topology clouds for all the domains for which the user has permission to access.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
Use the optional name parameter to restrict the results to topology clouds that contain the specified string.
The default pagination is start=0 and count=50.

Parameters:
context: Global MSSP context [optional]
type: Required clouds type [optional]
name: Cloud name [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds
OUTPUT{
    \"topology_clouds\": {
        \"count\": 3,
        \"total\": 3,
        \"topology_cloud\": [
            {
                \"id\": 48,
                \"name\": \"Cloud 69.70.120.155\",
                \"domain\": 1,
                \"type\": \"NON_JOINED\",
                \"ip\": \"69.70.120.155\"
            },
            {
                \"id\": 50,
                \"name\": \"Cloud 10.100.6.238\",
                \"domain\": 1,
                \"type\": \"MEMBER\",
                \"ip\": \"10.100.6.238\"
            },
            {
                \"id\": 66,
                \"name\": \"Cloud 10.100.10.14\",
                \"domain\": 1,
                \"type\": \"JOINED\",
                \"members\": [
                    {
                        \"id\": 50,
                        \"ip\": \"10.100.6.238\",
                        \"name\": \"Cloud 10.100.6.238\"
                    },
                    {
                        \"id\": 73,
                        \"ip\": \"10.100.10.14\",
                        \"name\": \"Cloud 10.100.10.14\"
                    },
                    {
                        \"id\": 74,
                        \"ip\": \"10.100.9.9\",
                        \"name\": \"Cloud 10.100.9.9\"
                    }
                ]
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds?type=non-joined
OUTPUT{
    \"topology_clouds\": {
        \"count\": 2,
        \"total\": 3,
        \"topology_cloud\": [
            {
                \"id\": 48,
                \"name\": \"Cloud 69.70.120.155\",
                \"domain\": 1,
                \"type\": \"NON_JOINED\",
                \"ip\": \"69.70.120.155\"
            },
            {
                \"id\": 50,
                \"name\": \"Cloud 10.100.6.238\",
                \"domain\": 1,
                \"type\": \"NON_JOINED\",
                \"ip\": \"10.100.6.238\"
            }
        ]
    }
}


Response Messages:
403: Access is denied
403: Only users with ‘Super admin’ permissions can access Global domain map
403: You do not have access permission to domain id: domainId
400: Wrong type provided - allowable values are: joined or non-joined","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds","collectionId":"1","id":"1-14-101","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Create a joined topology cloud","dataMode":"raw","description":"Create a new topology cloud in the Interactive Map by joining existing clouds together.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
The body must include at least two topology cloud ids that are on a single domain.
If the context parameter is not provided, then the API will use the context id of the first member of the members list in the body.
Clouds included in the members list of the body must not be joined clouds or members of another joined cloud.
If the provided body does not specify a joined cloud name, the newly created topology cloud will be given the name of the first member of the members list in the body.


Parameters:
context: Global MSSP context [optional]
body: Cloud data
forceTopologyInit: Force Topology Init [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds
BODY{
    \"cloud_data\":{
        \"cloud_name\" : \"optional new cloud name\",
        \"cloud_members\" : [118,179,258]
    }
}


Response Messages:
201: Joined cloud created successfully
403: Access is denied
403: You do not have access permission to the domain for cloud with id ID
404: Cloud with id ID was not found in the provided MSSP domain
412: You must provide 2 or more clouds
412: Cloud id: cloudId does not belong to domain: Context
412: Cloud with id ID is a joined cloud
412: Cloud with id ID is a member of a joined cloud","folder":"1-14","rawModeData":"{\n\t\"cloud_data\":{\n\t\t\"cloud_name\" : \"optional new cloud name\",\n\t\t\"cloud_members\" : [118,179,258]\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds","collectionId":"1","id":"1-14-102","method":"POST"},{"headers":"Accept: application/json\n","name":"Delete generic Route","description":"Delete a generic Route by Id.

Parameters:
routeId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/route/5\n

Response Messages:
204: No Content.
400: Bad Request.
403: Access is denied.
404: Generic Route Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/{{routeId}}","collectionId":"1","id":"1-14-103","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get generic Route","description":"Get a generic Route by Id.

Parameters:
routeId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/route/30
OUTPUT{
    GenericRoute: {
        id: 30,
        mgmtId: 2,
        destination: \"222.100.10.22\",
        mask: \"255.255.0.0\",
        interfaceName: \"catch22\",
        nextHop: \"100.100.10.10\",
        nextHopType: \"IP\",
        vrf: \"V102-YO\"
    }
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Generic Route Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/{{routeId}}","collectionId":"1","id":"1-14-104","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Create Join Cloud","dataMode":"raw","description":"Create Join Cloud.

Parameters:
body [optional]
forceTopologyInit: Force Topology Init [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/join/clouds
BODY{
    \"JoinCloud\" :
    {
        \"name\" : \"Yami\",
        \"clouds\" : [1, 2]
    }
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Cloud Not Found.
500: General error occurred.","folder":"1-14","rawModeData":"{ \n\t\"JoinCloud\" : \n\t{\n\t\t\"name\" : \"Yami\",\n\t\t\"clouds\" : [1, 2]\n\t}\n} ","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/join/clouds/","collectionId":"1","id":"1-14-105","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Update Join Cloud","dataMode":"raw","description":"Update Join Clouds.

Parameters:
body [optional]
forceTopologyInit: Force Topology Init [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/join/clouds
BODY{
    \"JoinCloud\" :
    {
        \"id\" : 67,
        \"name\" : \"Yamile\",
        \"clouds\" : [1, 2, 57]
    }
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Cloud Not Found.
500: General error occurred.","folder":"1-14","rawModeData":"{ \n\t\"JoinCloud\" : \n\t{\n\t\t\"id\" : 67,\n\t\t\"name\" : \"Yamile\",\n\t\t\"clouds\" : [1, 2, 57]\n\t}\n} ","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/join/clouds/","collectionId":"1","id":"1-14-106","method":"PUT"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Get cloud information","data":[{"value":null,"type":"text","enabled":true,"key":"cloud_id"}],"dataMode":"raw","description":"Returns information about a specific cloud in the topology.
This API includes the ID of the cloud, the number of routes that point to the cloud, and the relevant devices (including the management_id) that have routes that point to the cloud.
This information can be used to identify missing devices that may need to be added to the topology or to identify clouds that are candidates for being joined.

Parameters:
cloud_id: cloud id
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/cloud_suggestions/120
BODY{
    \"suggested_clouds\": {
        \"count\": 1,
        \"total\": 1,
        \"cloud\": {
            \"management_name\": \"FW1\",
            \"management_id\": 20,
            \"cloud_name\": \"Cloud 10.100.0.1\",
            \"cloud_id\": 120,
            \"vertex_id\": 250,
            \"ip\": \"10.100.0.1\",
            \"routes_count\": 5,
            \"is_parent\": false
        }
    }
}


Response Messages:
202: Accepted
403: User is not permitted to access the specified domain","folder":"1-14","rawModeData":"{\n\t\"suggested_clouds\": {\n\t\t\"count\": 1,\n\t\t\"total\": 1,\n\t\t\"cloud\": {\n\t\t\t\"management_name\": \"FW1\",\n\t\t\t\"management_id\": 20,\n\t\t\t\"cloud_name\": \"Cloud 10.100.0.1\",\n\t\t\t\"cloud_id\": 120,\n\t\t\t\"vertex_id\": 250,\n\t\t\t\"ip\": \"10.100.0.1\",\n\t\t\t\"routes_count\": 5,\n\t\t\t\"is_parent\": false\n\t\t}\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/cloud_suggestions/{{cloud_id}}","collectionId":"1","id":"1-14-107","method":"GET"},{"headers":"Accept: application/json\n","name":"Get Topology Synchronization status","description":"Returns the progress status of the Topology Model Synchronization.



Usage Example
https://192.168.1.1/securetrack/api/topology/synchronize/status

Response Messages:
200: The topology synchronization was invoked successfully.
403: Access is denied
500: Error getting synchronize progress","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/synchronize/status","collectionId":"1","id":"1-14-108","method":"GET"},{"headers":"Accept: application/json\n","name":"Get path for specified traffic","data":[{"value":null,"type":"text","enabled":true,"key":"src"},{"value":null,"type":"text","enabled":true,"key":"dst"},{"value":null,"type":"text","enabled":true,"key":"service"}],"dataMode":"params","description":"Returns one or more paths for the specified traffic.
src and dst parameters may contain multiple, comma separated values.
Service parameter can be a port (for example, “tcp:80”, “any”) or an application (for example, “Skype”, “Facebook”).
Application names are case sensitive.
Service parameter can also be a combination of ports and applications, for example “tcp:80, Skype, Facebook”
If sourceDomainIdTag is provided, the path starting points will be restricted to the specified domain ID. sourceDomainIdTag is valid only if overlapping IP mode is enabled.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is valid only if MSSP mode is enabled.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.
includeIncompletePaths parameter default value is false, if this parameter is set to true -
all nodes on the path will be included, even if the node cannot reach the destination, or if the source and destination are the same.
simulateNat parameter default value is true if this parameter is set to false - NAT simulation will not be used when calculating the path.
lastInstall parameter default value is true, which means simulation would use last installed policies. If this parameter is set to false - simulation would use last saved policies.
This API cannot be executed more than 10 times in parallel.

Parameters:
context: Global MSSP context [optional]
src: Source address/addresses
dst: Destination address/addresses
service: Service/services
sourceDomainIdTag: Path starting point Domain Id [optional]
includeIncompletePaths: Include incomplete paths [optional]
simulateNat: Simulate NAT [optional]
lastInstall: Last Installed [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/path?src=10.10.10.1&dst=3.3.3.3:32&service=any

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/path?src=29.29.29.1&dst=25.25.25.1&service=Facebook,tcp:80
OUTPUT {
    \"path_calc_results\": {
        \"traffic_allowed\": false,
        \"device_info\": {
            \"id\": \"17\",
            \"name\": \"PA-VM-111.6 (Cluster)\",
            \"type\": \"mgmt\",
            \"vendor\": \"Palo Alto Networks\",
            \"incomingInterfaces\": {
                \"incomingVrf\": \"default\",
                \"ip\": \"29.29.29.1/255.255.255.252\",
                \"name\": \"tunnel.11\"
            },
            \"nextDevices\": {
                \"name\": \"DIRECTLY_CONNECTED\",
                \"routes\": {
                    \"outgoingInterfaceName\": \"ethernet1/5\",
                    \"outgoingVrf\": \"default\",
                    \"routeDestination\": \"25.25.25.1/255.255.255.0\"
                }
            },
            \"bindings\": {
                \"name\": \"\",
                \"rules\": [
                    {
                        \"action\": \"Accept\",
                        \"applications\": \"facebook\",
                        \"destNegated\": false,
                        \"destinations\": \"Any\",
                        \"ruleIdentifier\": 43,
                        \"serviceNegated\": false,
                        \"services\": \"Any\",
                        \"sourceNegated\": false,
                        \"sources\": \"Any\",
                        \"users\": \"Any\"
                    },
                    {
                        \"action\": \"Deny\",
                        \"applications\": \"Any\",
                        \"destNegated\": false,
                        \"destinations\": \"Any\",
                        \"ruleIdentifier\": 62,
                        \"serviceNegated\": false,
                        \"services\": \"Any\",
                        \"sourceNegated\": false,
                        \"sources\": \"Any\",
                        \"users\": \"Any\"
                    }
                ]
            }
        }
    }
}

","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/path","collectionId":"1","id":"1-14-109","method":"GET"},{"headers":"Accept: application/json\n","name":"Get generic Vpn","description":"Get a generic Vpn by Id.

Parameters:
vpnId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/vpn/18
OUTPUT{
    GenericVpn: {
        id: 18,
        generic: false,
        deviceId: 2,
        interfaceName: \"777\",
        tunnelSourceIpAddr: \"1.1.1.77\",
        tunnelDestIpAddr: \"1.1.1.88\"
    }
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Generic Vpn Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/{{vpnId}}","collectionId":"1","id":"1-14-110","method":"GET"},{"headers":"Accept: application/json\n","name":"Delete generic Vpn","description":"Delete a generic Vpn by Id.

Parameters:
vpnId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/vpn/5\n

Response Messages:
204: No Content.
400: Bad Request.
403: Access is denied.
404: Generic Vpn Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/{{vpnId}}","collectionId":"1","id":"1-14-111","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get topology generic VPN connections","description":"Returns a list of the generic vpn connections in the Topology map, for all the domains for which the user has permission to access.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
Use the optional name parameter to restrict the results to topology generic vpn connections that contain the specified string.
The default pagination is start=0 and count=50.

Parameters:
context: Global MSSP context [optional]
is_generic: Get generic devices [optional]
device_id: Device id [optional]
name: VPN connection name (accepts '*', '?' as wildcards) [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/generic_vpns
OUTPUT{
    \"generic_vpns\": {
        \"count\": 3,
        \"total\": 3,
        \"generic_vpn\": [
            {
                \"device_id\": 222,
                \"generic\": false,
                \"id\": 3,
                \"interface_name\": \"tunnel.2\",
                \"tunnel_dest_ip\": \"54.239.63.155\",
                \"tunnel_src_ip\": \"84.200.6.1\",
                \"vpn_name\": \"Palo_to_AWS\"
            },
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 4,
                \"interface_name\": \"tunnel.1\",
                \"tunnel_dest_ip\": \"54.239.63.156\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 5,
                \"interface_name\": \"tunnel.2\",
                \"tunnel_dest_ip\": \"54.239.63.157\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/generic_vpns?is_generic=true
OUTPUT{
    \"generic_vpns\": {
        \"count\": 2,
        \"total\": 2,
        \"generic_vpn\": [
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 4,
                \"interface_name\": \"tunnel.1\",
                \"tunnel_dest_ip\": \"54.239.63.156\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 5,
                \"interface_name\": \"tunnel.2\",
                \"tunnel_dest_ip\": \"54.239.63.157\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
        ]
    }
}


Response Messages:
403: Access is denied
403: Only users with ‘Super admin’ permissions can access Global domain map
403: You do not have access permission to domain id: domainId
400: Wrong type provided - allowable values are: joined or non-joined","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic_vpns{device_id:(/device_id)?}","collectionId":"1","id":"1-14-112","method":"GET"},{"headers":"Accept: application/json\n","name":"Delete generic Vpns","description":"Delete all generic Vpns from management/genericDevice Id.

Parameters:
deviceId [optional]
generic [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/vpn/device/2?generic=false\n

Response Messages:
200: 4 Generic Vpns were deleted from mgmtId 2.
400: Bad Request.
403: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/device/{{deviceId}}","collectionId":"1","id":"1-14-113","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get generic Vpns","description":"Get generic Vpns of management/genericDevice Id.

Parameters:
deviceId [optional]
generic [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/vpn/device/3?generic=true
OUTPUT{
    GenericVpns: [
    {
        id: 17,
        generic: true,
        deviceId: 3,
        interfaceName: \"777\",
        tunnelSourceIpAddr: \"1.1.1.177\",
        tunnelDestIpAddr: \"1.1.1.188\"
    },
    {
        id: 22,
        generic: true,
        deviceId: 3,
        interfaceName: \"111\",
        tunnelSourceIpAddr: \"1.1.1.188\",
        tunnelDestIpAddr: \"1.1.1.177\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/device/{{deviceId}}","collectionId":"1","id":"1-14-114","method":"GET"},{"headers":"Accept: application/json\n","name":"Synchronize the Topology model","description":"Invoke of the Topology Model Synchronization.
full_sync=false - Builds the topology model from the information stored in the Tufin database.
full_sync=true - Retrieves the current data from devices and builds the topology model.
Default value for full_sync = false.

Parameters:
full_sync: Perform full sync [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/synchronize

Usage Example
https://192.168.1.1/securetrack/api/topology/synchronize?full_sync=true

Response Messages:
200: The topology synchronization was invoked successfully.
403: Access is denied
500: Error Synchronizing Topology Model
503: Service unavailable, Graph builder is currently running","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/synchronize","collectionId":"1","id":"1-14-115","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Get all pattern entries for specific zones","dataMode":"raw","description":"Get the list of zone pattern entries for specific zones by identifiers

Parameters:
context: Global MSSP context. [optional]
ids: Filter by IDs for the pattern entry results. [optional]
pattern: Filter by pattern string for the zone entry results. [optional]
name: Filter by zone name for the pattern entry results. [optional]
comment: Filter by comment for the pattern entry results. [optional]
sort: Sort ascending or descending. [optional]
start: Starting page number for query results. [optional]
count: Number of pages to return for the query, starting from the specified starting page. [optional]
children: Include child zones in the results. [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/1,2/pattern-entries
BODY<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<pattern_match_entries_find_result>
    <paging_info>
        <start>0</start>
        <count>2</count>
        <total>2</total>
    </paging_info>
    <pattern_match_entries>
        <pattern_match_entry>
            <id>2</id>
            <type>security_group_by_name</type>
            <comment>This is a comment</comment>
            <pattern>WEB</pattern>
            <zone_id>1</zone_id>
        </pattern_match_entry>
        <pattern_match_entry>
            <id>3</id>
            <type>security_group_by_name</type>
            <comment>This is a comment</comment>
            <pattern>WEo</pattern>
            <zone_id>2</zone_id>
        </pattern_match_entry>
    </pattern_match_entries>
</pattern_match_entries_find_result>


Response Messages:
200: The zone pattern entries were successfully retrieved.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-15","rawModeData":"\n\n\t\n\t\t0\n\t\t2\n\t\t2\n\t\n\t\n\t\t\n\t\t\t2\n\t\t\tsecurity_group_by_name\n\t\t\tThis is a comment\n\t\t\tWEB\n\t\t\t1\n\t\t\n\t\t\n\t\t\t3\n\t\t\tsecurity_group_by_name\n\t\t\tThis is a comment\n\t\t\tWEo\n\t\t\t2\n\t\t\n\t\n\n","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/pattern-entries","collectionId":"1","id":"1-15-116","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Get a specific zone pattern entry for a specific zone","data":[{"value":null,"type":"text","enabled":true,"key":"zone_id"},{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"raw","description":"Get a specific zone pattern entry for a specific zone by identifier

Parameters:
context: Global MSSP context. [optional]
zone_id: Identifier of the zone containing the zone entry.
id: Identifier of the zone pattern entry.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/75/pattern-entries/2
BODY<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<pattern_match_entry>
    <id>2</id>    <type>security_group_by_name</type>
    <comment>This is a comment</comment>
    <pattern>WEB</pattern>
    <zone_id>75</zone_id>
    <zone_name>Zone_10_0_0_1</zone_name>
    <domain>
        <address>koko</address>
        <description>bobo</description>
        <id>1</id>
        <name>Default</name>
    </domain>
</pattern_match_entry>


Response Messages:
200: The zone pattern entry was successfully retrieved.
403: User is not permitted to access the specified domain
404: A zone with the specified identifier was not found.
404: A zone pattern entry with the specified identifier was not found.","folder":"1-15","rawModeData":"\n\n\t2\tsecurity_group_by_name\n\tThis is a comment\n\tWEB\n\t75\n\tZone_10_0_0_1\n\t\n\t\t
koko
\n\t\tbobo\n\t\t1\n\t\tDefault\n\t\n\n","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/pattern-entries/{{id}}","collectionId":"1","id":"1-15-117","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create a zone pattern entry in a specific zone","data":[{"value":null,"type":"text","enabled":true,"key":"zone_id"}],"dataMode":"raw","description":"Create a zone pattern entry in a specific zone by identifier

Parameters:
context: Global MSSP context. [optional]
zone_id: Identifier of the zone containing the zone pattern entry.
body: The zone pattern entry to create.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/pattern-entries
BODY<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<create_pattern_match_entry>
    <pattern_match_entry>
        <id>1</id>
        <zone_id>2</zone_id>
        <domain>
            <id>1</id>
            <name>Default</name>
        </domain>
        <pattern>WEB</pattern>
        <type>security_group_by_name</type>
        <comment>This is a comment</comment>
    </pattern_match_entry>
</create_pattern_match_entry>


Response Messages:
201: The zone pattern entry was created successfully.
403: User is not permitted to access the specified domain
400: Some of pattern entry parameters were invalid or missing
404: A zone with the specified identifier was not found.","folder":"1-15","rawModeData":"\n\n\t\n\t\t1\n\t\t2\n\t\t\n\t\t\t1\n\t\t\tDefault\n\t\t\n\t\tWEB\n\t\tsecurity_group_by_name\n\t\tThis is a comment\n\t\n","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/pattern-entries","collectionId":"1","id":"1-15-118","method":"POST"},{"headers":"Accept: application/json\n","name":"Get entries for a zone","description":"Get the list of zone entries for a zone.

Parameters:
context: Global MSSP context. [optional]
ids: Filter by IDs for the zone entry results. [optional]
name: Filter by name for the zone entry results. [optional]
ip: Filter by IP for the zone entry results. [optional]
netmask: Filter by netmask for the zone entry results. [optional]
prefix: Filter by prefix for the zone entry results. [optional]
comment: Filter by comment for the zone entry results. [optional]
group: Filter by device group for the zone entry results. [optional]
sort: Sort ascending or descending. [optional]
start: Starting page number for query results. [optional]
count: Number of pages to return for the query, starting from the specified starting page. [optional]
children: Include child zones in the results. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/2/entries

Response Messages:
200: The zone entries were successfully retrieved.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-16","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/entries","collectionId":"1","id":"1-16-119","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Modify a zone entry","data":[{"value":null,"type":"text","enabled":true,"key":"zone_id"},{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"raw","description":"For IPv4 entry provide IP and netmask/prefix (see Usage Example #1 and #2).
For IPv6 provide IP and prefix only, netmask is not allowed(see Usage Example #3).

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
id: The ID of the zone entry.
body: The modified zone entry.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries/1
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"netmask\": \"255.255.255.0\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries/1
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"prefix\": \"24\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries/1
BODY{
\"zone_entry\": {
    \"ip\": \"1b98:c72:1f00:0000::\",
    \"prefix\": \"52\"
    }
}


Response Messages:
200: The zone entry was modified successfully.
403: User is not permitted to access the specified domain
400: The zone entry parameters were invalid
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found.","folder":"1-16","rawModeData":"{\n\"zone_entry\": {\n\t\"ip\": \"1b98:c72:1f00:0000::\",\n\t\"prefix\": \"52\"\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries/{{id}}","collectionId":"1","id":"1-16-120","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get a specific zone entry","data":[{"value":null,"type":"text","enabled":true,"key":"zone_id"},{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Get a specific zone entry by ID for a zone.

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
id: The ID of the zone entry.

Usage Example
https://192.168.1.1/securetrack/api/zones/2/entries/123

Response Messages:
200: The zone entry was successfully retrieved.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found.","folder":"1-16","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries/{{id}}","collectionId":"1","id":"1-16-121","method":"GET"},{"name":"Delete zone entries","data":[{"value":null,"type":"text","enabled":true,"key":"zone_id"},{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Delete existing zone entries.

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
id: The ID of the zone entry to delete.

Usage Example
https://192.168.1.1/securetrack/api/zones/2/entries/10

Response Messages:
200: The zone entry was deleted successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found.","folder":"1-16","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries/{{id}}","collectionId":"1","id":"1-16-122","method":"DELETE"},{"headers":"Content-Type: application/json\n","name":"Modify multiple existing zone entries","data":[{"value":null,"type":"text","enabled":true,"key":"zone_ids"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"raw","description":"For IPv4 entry provide IP and netmask/prefix.
For IPv6 provide IP and prefix only, netmask is not allowed.
new_zone_id is not optional, it may be the same as the present zoneId.

Parameters:
context: Global MSSP context. [optional]
zone_ids: The ID(s) of the zones containing the zone entries.
ids: The ID(s) of the zone entries to modify.
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/85,98/entries/120,139
BODY{
\"zone_entries\" : {
        \"zone_entry\": [
            {
                \"id\": 120,
                \"ip\": \"3.3.3.3\",
                \"prefix\": 32,
                \"new_zone_id\": 85
            },
            {
                \"id\": 139,
                \"ip\": \"1b98:c72:1f00:0001::\",
                \"prefix\": \"52\",
                \"new_zone_id\": 98
            }
        ]
}
}


Response Messages:
200: The zone entry was modified successfully.
403: User is not permitted to access the specified domain
400: The zone entry parameters were invalid
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found.","folder":"1-16","rawModeData":"{\n\"zone_entries\" : {\n\t\t\"zone_entry\": [\n\t\t\t{\n\t\t\t\t\"id\": 120,\n\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\"prefix\": 32,\n\t\t\t\t\"new_zone_id\": 85\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": 139,\n\t\t\t\t\"ip\": \"1b98:c72:1f00:0001::\",\n\t\t\t\t\"prefix\": \"52\",\n\t\t\t\t\"new_zone_id\": 98\n\t\t\t}\n\t\t]\n}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_ids}}/entries/{{ids}}","collectionId":"1","id":"1-16-123","method":"PUT"},{"headers":"Content-Type: application/json\n","name":"Create a zone entry","data":[{"value":null,"type":"text","enabled":true,"key":"zone_id"}],"dataMode":"raw","description":"For IPv4 entry provide IP and netmask/prefix (see Usage Example #1 and #2).
For IPv6 provide IP and prefix only, netmask is not allowed(see Usage Example #3).

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
body: The zone entry to create.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"netmask\": \"255.255.255.0\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"prefix\": \"24\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries
BODY{
\"zone_entry\": {
    \"ip\": \"1b98:c72:1f00:0000::\",
    \"prefix\": \"52\"
    }
}


Response Messages:
201: The zone entry was created successfully.
403: User is not permitted to access the specified domain
400: The zone entry parameters were invalid
404: A zone with the specified ID was not found.","folder":"1-16","rawModeData":"{\n\"zone_entry\": {\n\t\"ip\": \"1b98:c72:1f00:0000::\",\n\t\"prefix\": \"52\"\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries","collectionId":"1","id":"1-16-124","method":"POST"},{"name":"Modify a zone entry","data":[{"value":null,"type":"text","enabled":true,"key":"zone_ids"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Modify an existing zone entry.

Parameters:
context: Global MSSP context. [optional]
zone_ids: The ID(s) of the zones containing the zone entry.
ids: The ID(s) of the zone entries to delete.

Usage Example
https://192.168.1.1/securetrack/api/zones/2,3/entries/10,20

Response Messages:
200: The zone entry was deleted successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found.","folder":"1-16","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_ids}}/entries/{{ids}}","collectionId":"1","id":"1-16-125","method":"DELETE"},{"headers":"Content-Type: application/xml\n","name":"Create a zone","dataMode":"raw","description":"Create a zone.

Parameters:
context: Global MSSP context. [optional]
body: The zone to add.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones
BODY<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<zone>
    <name>DMZ</name>
    <comment>All DMZ addresses</comment>
    <shared>false</shared>
</zone>


Response Messages:
201: The zone was created successfully.
403: User is not permitted to access the specified domain
400: The zone parameters were invalid","folder":"1-17","rawModeData":"\n\n\tDMZ\n\tAll DMZ addresses\n\tfalse\n","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/","collectionId":"1","id":"1-17-126","method":"POST"},{"headers":"Accept: application/json\n","name":"Get all zones","description":"Gets a list of all zones.

Parameters:
context: Global MSSP context. [optional]
name: Filter by zone name for the zone results. [optional]
comment: Filter by zone comment for the zone results. [optional]
imported: List domains that imported zones. [optional]
includeInternet: Include the Internet zone. [optional]
includeImported: Include imported zones. [optional]
sort: Sort ascending or descending. [optional]
start: Starting page number for query results. [optional]
count: Number of pages to return for the query, starting from the specified starting page. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones

Response Messages:
200: The zones were retrieved successfully.
403: User is not permitted to access the specified domain","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/","collectionId":"1","id":"1-17-127","method":"GET"},{"collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/","name":"Delete all zones","method":"DELETE","id":"1-17-128","description":"Delete all existing zones.

Parameters:
context: Global MSSP context. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones

Response Messages:
204: All zones were successfully deleted.
403: User is not permitted to access the specified domain","folder":"1-17"},{"headers":"Accept: application/json\n","name":"Get descendant zones for a zone","data":[{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Get a list of zones descended from the specified zone(s).

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones for which to look for descendant zones.

Usage Example
https://192.168.1.1/securetrack/api/zones/10,20/descendants

Response Messages:
200: The zone descendants were retrieved successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/descendants","collectionId":"1","id":"1-17-129","method":"GET"},{"name":"Add a zone as a descendant to a zone","data":[{"value":null,"type":"text","enabled":true,"key":"parent_id"},{"value":null,"type":"text","enabled":true,"key":"child_ids"}],"dataMode":"params","description":"Add a zone(s) as a descendant to a existing zone.

Parameters:
context: Global MSSP context. [optional]
parent_id: The ID of the zone for which to add descendant zone(s).
child_ids: The ID(s) of the zones to add as descendants.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/descendants/10,20

Response Messages:
200: The zone was added as an descendant successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{parent_id}}/descendants/{{child_ids}}","collectionId":"1","id":"1-17-130","method":"PUT"},{"name":"Remove a zone as an descendants to a zone","data":[{"value":null,"type":"text","enabled":true,"key":"parent_id"},{"value":null,"type":"text","enabled":true,"key":"child_ids"}],"dataMode":"params","description":"Remove a zone(s) as an descendants to a existing zone.

Parameters:
context: Global MSSP context. [optional]
parent_id: The ID of the zone for which to remove descendant zone(s).
child_ids: The ID(s) of the zone to remove as a descendant.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/descendants/10,20

Response Messages:
200: The zone was removed as an descendant successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{parent_id}}/descendants/{{child_ids}}","collectionId":"1","id":"1-17-131","method":"DELETE"},{"name":"Remove a zone as an ancestor to a zone","data":[{"value":null,"type":"text","enabled":true,"key":"child_id"},{"value":null,"type":"text","enabled":true,"key":"parent_ids"}],"dataMode":"params","description":"Remove a zone(s) as an ancestor to a existing zone.

Parameters:
context: Global MSSP context. [optional]
child_id: The ID of the zone for which to remove ancestors zone(s).
parent_ids: The ID(s) of the zones to remove as ancestors.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/ancestors/10,20

Response Messages:
200: The zone was removed as an ancestor successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{child_id}}/ancestors/{{parent_ids}}","collectionId":"1","id":"1-17-132","method":"DELETE"},{"name":"Add a zone as an ancestor to a zone","data":[{"value":null,"type":"text","enabled":true,"key":"child_id"},{"value":null,"type":"text","enabled":true,"key":"parent_ids"}],"dataMode":"params","description":"Add a zone(s) as an ancestor to a existing zone.

Parameters:
context: Global MSSP context. [optional]
child_id: The ID of the zone for which to add ancestors zone(s).
parent_ids: The ID(s) of the zones to add as ancestors.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/ancestors/10,20

Response Messages:
200: The zone was added as an ancestor successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{child_id}}/ancestors/{{parent_ids}}","collectionId":"1","id":"1-17-133","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get shared zones","description":"Get a list of shared zones.

Parameters:
context: Global MSSP context. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/shared

Response Messages:
200: The list of shared zones was retrieved successfully.
403: User is not permitted to access the specified domain","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/shared","collectionId":"1","id":"1-17-134","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Map network elements to security zones","dataMode":"raw","description":"This API maps each network element in the AccessRequestNetworkListDTO (such as IP address, IP address range, object, or group) to all matching Tufin security zones. If the network element is a group, then each zone also identifies all matching group members. The internet referral object can be included in the list, and will always map to the predefined Internet security zone. If the 'Any' element is included in the list it will map to all zones.
Note: if multi-domain mode is enabled, the API calls only checks zones that are in the “Default” domain.

Parameters:
body: AccessRequestNetworkListDTO

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_zones
BODY<network_objects>
     <network_object xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"ip_network\">
         <network xsi:type=\"raw_network_subnet\">
         <ip>10.8.8.0</ip>
         <mask>255.255.255.0</mask>
         </network>
     </network_object>
</network_objects>


Response Messages:
200: Returns mapping of network elements to security zones
400: Access Request Network List is malformed.
403: Access is denied.","folder":"1-17","rawModeData":"\n\t \n\t\t \n\t\t 10.8.8.0\n\t\t 255.255.255.0\n\t\t \n\t \n","url":"https://{{SecureTrack_IP}}/securetrack/api/security_zones/","collectionId":"1","id":"1-17-135","method":"POST"},{"name":"Delete a zone","data":[{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Delete an existing zone.

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zone to delete.

Usage Example
https://192.168.1.1/securetrack/api/zones/1,2

Response Messages:
204: The specified zone was successfully deleted.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}","collectionId":"1","id":"1-17-136","method":"DELETE"},{"headers":"Content-Type: application/xml\n","name":"Modify a zone","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"raw","description":"Modify an existing zone.

Parameters:
context: Global MSSP context. [optional]
id: The ID of the zone to modify.
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2
BODY<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<zone>
    <id>2</id>
    <name>DMZ</name>
    <comment>All DMZ hosts</comment>
    <shared>false</shared>
    <internet>false</internet>
    <user_networks>false</user_networks>
    <unassociated_networks>false</unassociated_networks>
</zone>


Response Messages:
204: The specified zone was successfully modified.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
400: The zone parameters were invalid","folder":"1-17","rawModeData":"\n\n\t2\n\tDMZ\n\tAll DMZ hosts\n\tfalse\n\tfalse\n\tfalse\n\tfalse\n","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{id}}","collectionId":"1","id":"1-17-137","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get a specific zone","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Get the zone with the specified ID.

Parameters:
context: Global MSSP context. [optional]
id: The ID of the zone to get.
imported: List domains that imported zones. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/2

Response Messages:
200: The zone was retrieved successfully.
403: User is not permitted to access the specified domain
403: A zone with the specified ID does not exist.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{id}}","collectionId":"1","id":"1-17-138","method":"GET"},{"headers":"Accept: application/json\n","name":"Get configuration usages for a zone","data":[{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Get a list of configuration usages for the specified zone(s).

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones for which to look for configuration dependencies.

Usage Example
https://192.168.1.1/securetrack/api/zones/2,3/dependencies

Response Messages:
200: The zone dependencies were retrieved successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/dependencies","collectionId":"1","id":"1-17-139","method":"GET"},{"collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/import/{{ids}}","name":"Import a zone","method":"POST","id":"1-17-140","description":"Import a shared zone into the specified domain

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones to import. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/import/10,20

Response Messages:
200: The zone was imported successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17"},{"headers":"Accept: application/json\n","name":"Get ancestor zones for a zone","data":[{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Get a list of ancestor zones for the specified zone(s).

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones for which to look for ancestor zones.

Usage Example
https://192.168.1.1/securetrack/api/zones/123,234/ancestors

Response Messages:
200: The zone ancestors were retrieved successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/ancestors","collectionId":"1","id":"1-17-141","method":"GET"},{"headers":"Accept: application/json\n","name":"Get rules by input and output interfaces","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"}],"description":"Parameters:
device_id: The unique identifier of target device
inputInterfaceName: Input interface name [optional]
outputInterfaceName: Output interface name [optional]
isIpv6: Is ipv6 policy [optional]

Usage Example
https://192.168.1.1/securetrack/api/bindings/2/topology_interfaces?inputInterfaceName=ethernet1/1&outputInterfaceName=ethernet1/2
","dataMode":"params","folder":"1-18","url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/topology_interfaces","collectionId":"1","id":"1-18-142","method":"GET"},{"headers":"Accept: application/json\n","name":"Get sub-policies (bindings) by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns a list of all of the subpolicies (bindings) for a given revision.
The definition of subpolicy is different for each vendor:
Check Point - policy package and inline layer (inline layer will be returned only when the optional include_subpolicy parameter is set to true)
Cisco - ACL
Juniper/Fortinet/Palo Alto/Stonesoft - zone-to-zone policy
Cloud platforms - Security Groups


Parameters:
context: Global MSSP context [optional]
id: Revision ID
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
include_subpolicy: when set to true, includes sub policies in the returned result, supported only for Checkpoint [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/bindings

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/bindings? include_subpolicy=true
","folder":"1-18","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/bindings","collectionId":"1","id":"1-18-143","method":"GET"},{"headers":"Accept: application/json\n","name":"Get policies by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of policies defined on a given revision ID

Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/policies
","folder":"1-18","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/policies","collectionId":"1","id":"1-18-144","method":"GET"},{"headers":"Accept: application/json\n","name":"Get sub-policies (bindings) by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns a list of all of the subpolicies (bindings) for a given device.
The definition of subpolicy is different for each vendor:
Check Point - policy package and inline layer (inline layer will be returned only when the optional include_subpolicy parameter is set to true)
Cisco - ACL
Juniper/Fortinet/Palo Alto/Stonesoft - zone-to-zone policy
Cloud platforms - Security Groups


Parameters:
context: Global MSSP context [optional]
id: Device ID
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
include_subpolicy: when set to true, includes sub policies in the returned result, supported only for Checkpoint [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/bindings

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/bindings? include_subpolicy=true
","folder":"1-18","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/bindings","collectionId":"1","id":"1-18-145","method":"GET"},{"headers":"Accept: application/json\n","name":"Get policies by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of policies defined on a given device ID.
Supported devices: CheckPoint, Panorama Advanced, FortiManager Basic and Advanced, FMC and NSX.

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/20/policies
","folder":"1-18","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/policies","collectionId":"1","id":"1-18-146","method":"GET"},{"headers":"Accept: application/json\n","name":"Get list of sub-policies (bindings) with input and/or output interfaces","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"supremum_version_id"},{"value":null,"type":"text","enabled":true,"key":"inputInterfaceName"},{"value":null,"type":"text","enabled":true,"key":"outputInterfaceName"}],"dataMode":"params","description":"Retrieve list of bindings of input and/or output interfaces

Parameters:
device_id: The unique identifier of target device
supremum_version_id: The unique identifier of target revision
inputInterfaceName: Input interface name
outputInterfaceName: Output interface name

Usage Example
https://192.168.1.1/securetrack/api/bindings/20/binding_query?supremum_version_id=785&inputInterfaceName=Any&outputInterfaceName=Any
","folder":"1-18","url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/binding_query","collectionId":"1","id":"1-18-147","method":"GET"},{"headers":"Accept: application/json\n","name":"Run Policy Analysis query","data":[{"value":null,"type":"text","enabled":true,"key":"device_ids"},{"value":null,"type":"text","enabled":true,"key":"sources"},{"value":null,"type":"text","enabled":true,"key":"destinations"},{"value":null,"type":"text","enabled":true,"key":"services"}],"description":"Parameters:
device_ids: Device ids
sources: Source list
destinations: Destination list
services: Service list
exclude_any: Exclude any in the specified, comma-separated fields of source, destination or service. For example: exclude_any = destination,service [optional]
action: Action [optional]

Usage Example
https://192.168.1.1/securetrack/api/policy_analysis/query/matching_rules?device_ids=41&sources=33.33.33.0:24,113.113.113.100&destinations=114.1.1.0:24&services=tcp:80&exclude_any=source,destination

Response Messages:
200: Returns request results.
400: Error in request syntax.","dataMode":"params","folder":"1-19","url":"https://{{SecureTrack_IP}}/securetrack/api/policy_analysis/query/matching_rules","collectionId":"1","id":"1-19-148","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific rule documentation","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"rule_id"}],"dataMode":"params","description":"Fetches rule documentation for a single rule given by revision ID and rule ID.

Parameters:
context: Global MSSP context [optional]
id: Revision id
rule_id: Id of the requested rule

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules/16373/documentation
","folder":"1-20","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules/{{rule_id}}/documentation","collectionId":"1","id":"1-20-149","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Modify specific rule documentation","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"rule_id"}],"dataMode":"raw","description":"Modify rule documentation for a single rule identified by revision ID and rule ID.
A single rule can be set as either a stealth rule or legacy rule. If both flags are set, an error will be returned (error 400, Bad request).
If no rule documentation exists for the rule, the specified documentation is added to the rule and the response code is: 201 Created.
If rule documentation already exists for the rule, the specified documentation replaces the existing documentation and the response code is: 204 No Content.
Record set entries that are automatically created or calculated, for example automatic mapping to a SecureChange ticket, cannot be modified.
The following fields are automatically calculated, and cannot be modified:
Permissiveness, Violations, Last Hit, Last Modified, Shadowing Status, Certification Status, Certification Date, Certification Expiration Date, Application Name, Application Owner

Parameters:
context: Global MSSP context [optional]
id: Revision id
rule_id: Id of the changed rule
body: RuleDocumentationDTO

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/173/rules/3373/documentation
BODY<rule_documentation>
     <tech_owner>admin</tech_owner>
     <comment>Comment text</comment>
     <legacy_rule>false</legacy_rule>
     <stealth_rule>true</stealth_rule>
     <record_set>
         <businessOwnerEmail>user@company.com</businessOwnerEmail>
         <businessOwnerName>Business Owner</businessOwnerName>
         <expireDate>2013-01-08T00:00:00+02:00</expireDate>
         <id>172</id>
         <ticketCr>789111</ticketCr>
     </record_set>
</rule_documentation>

","folder":"1-20","rawModeData":"\n\t admin\n\t Comment text\n\t false\n\t true\n\t \n\t\t user@company.com\n\t\t Business Owner\n\t\t 2013-01-08T00:00:00+02:00\n\t\t 172\n\t\t 789111\n\t \n","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules/{{rule_id}}/documentation","collectionId":"1","id":"1-20-150","method":"PUT"},{"name":"Delete specific rule documentation","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"rule_id"}],"dataMode":"params","description":"Delete rule documentation for a single rule given by revision ID and rule ID.
If the rule has automatic mapping to a ticket, the record is not deleted.

Parameters:
context: Global MSSP context [optional]
id: Revision id
rule_id: Rule id

Usage Example
https://192.168.1.1/securetrack/api/revisions/173/rules/3373/documentation
","folder":"1-20","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules/{{rule_id}}/documentation","collectionId":"1","id":"1-20-151","method":"DELETE"},{"headers":"Content-Type: application/xml\n","name":"Modify specific rule documentation","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"rule_id"}],"dataMode":"raw","description":"Modify rule documentation for a single rule given by device ID and rule ID
A single rule can be set as either a stealth rule or legacy rule. If both flags are set, an error will be returned (error 400, Bad request).
If there is no existing rule documentation for the rule, the specified documentation is added to the rule and the response code is: 201 Created.
If there is existing rule documentation for the rule, the specified documentation replaces the existing documentation and the response code is: 204 No Content.

Parameters:
context: Global MSSP context [optional]
id: Device ID
rule_id: Rule ID
body: RuleDocumentationDTO

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/20/rules/3040/documentation
BODY<rule_documentation>
     <tech_owner>admin</tech_owner>
     <comment>Comment text</comment>
     <legacy_rule>false</legacy_rule>
     <stealth_rule>true</stealth_rule>
     <record_set>
         <businessOwnerEmail>user@company.com</businessOwnerEmail>
         <businessOwnerName>Business Owner</businessOwnerName>
         <expireDate>2013-01-08T00:00:00+02:00</expireDate>
         <id>173</id>
         <ticketCr>789112</ticketCr>
     </record_set>
</rule_documentation>

","folder":"1-20","rawModeData":"\n\t admin\n\t Comment text\n\t false\n\t true\n\t \n\t\t user@company.com\n\t\t Business Owner\n\t\t 2013-01-08T00:00:00+02:00\n\t\t 173\n\t\t 789112\n\t \n\n","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules/{{rule_id}}/documentation","collectionId":"1","id":"1-20-152","method":"PUT"},{"name":"Delete specific rule documentation","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"rule_id"}],"dataMode":"params","description":"Delete rule documentation for a single rule given by device ID and rule ID

Parameters:
context: Global MSSP context [optional]
id: Device ID
rule_id: Rule ID

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules/3040/documentation
","folder":"1-20","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules/{{rule_id}}/documentation","collectionId":"1","id":"1-20-153","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get specific rule documentation","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"rule_id"}],"dataMode":"params","description":"Fetches rule documentation for a single rule given by device ID and rule ID

Parameters:
context: Global MSSP context [optional]
id: Device ID
rule_id: Rule ID

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules/16373/documentation
","folder":"1-20","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules/{{rule_id}}/documentation","collectionId":"1","id":"1-20-154","method":"GET"},{"headers":"Accept: application/json\n","name":"Get cleanups results","description":"Parameters:
context: Global MSSP context [optional]
devices: Devices ids [optional]

Usage Example
https://192.168.1.1/securetrack/api/cleanup
","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/cleanup/","collectionId":"1","id":"1-21-155","method":"GET"},{"headers":"Accept: application/json\n","name":"Get shadowing rules by device","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"shadowed_uids"}],"dataMode":"params","description":"Find shadowing rules for given shadowed rules of a specific device

Parameters:
device_id: Device ID
shadowed_uids: UIDs of shadowed rules separated by commas

Usage Example
https://192.168.1.1/securetrack/api/devices/31/shadowing_rules?shadowed_uids=78786a0d-b9cc-478e-b7a2-dea953c976c7
","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/shadowing_rules","collectionId":"1","id":"1-21-156","method":"GET"},{"headers":"Accept: application/json\n","name":"Get the specific objects or rules identified for the cleanup results","data":[{"value":null,"type":"text","enabled":true,"key":"cleanup_id"}],"description":"Parameters:
context: Global MSSP context [optional]
cleanup_id: Cleanup id
devices: Devices ids [optional]
start: Start [optional]
count: Results count [optional]

Usage Example
https://192.168.1.1/securetrack/api/cleanup/1/instances
","dataMode":"params","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/cleanup/{{cleanup_id}}/instances","collectionId":"1","id":"1-21-157","method":"GET"},{"headers":"Accept: application/json\n","name":"Get devices in cleanup results","data":[{"value":null,"type":"text","enabled":true,"key":"cleanup_id"}],"description":"Parameters:
context: Global MSSP context [optional]
cleanup_id: Cleanup id

Usage Example
https://192.168.1.1/securetrack/api/cleanup/1/devices
","dataMode":"params","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/cleanup/{{cleanup_id}}/devices","collectionId":"1","id":"1-21-158","method":"GET"},{"headers":"Accept: application/json\n","name":"Get devices in risk results","data":[{"value":null,"type":"text","enabled":true,"key":"risk_id"}],"description":"Parameters:
context: Global MSSP context [optional]
risk_id: Risk id

Usage Example
https://192.168.1.1/securetrack/api/risk/1/devices
","dataMode":"params","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/risk/{{risk_id}}/devices","collectionId":"1","id":"1-21-159","method":"GET"},{"headers":"Accept: application/json\n","name":"Get the specific objects or rules identified for the risk results","data":[{"value":null,"type":"text","enabled":true,"key":"risk_id"}],"description":"Parameters:
context: Global MSSP context [optional]
risk_id: Risk id
devices: Devices ids [optional]
start: Start [optional]
count: Results count [optional]

Usage Example
https://192.168.1.1/securetrack/api/risk/1/instances
","dataMode":"params","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/risk/{{risk_id}}/instances","collectionId":"1","id":"1-21-160","method":"GET"},{"headers":"Accept: application/json\n","name":"Get risks results","description":"Parameters:
context: Global MSSP context [optional]
devices: Devices ids [optional]

Usage Example
https://192.168.1.1/securetrack/api/risk
","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/risk/","collectionId":"1","id":"1-21-161","method":"GET"},{"headers":"Accept: application/json\n","name":"Get cleanups by device","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"code"}],"dataMode":"params","description":"Fetches set of Cleanup calculation results for a device given by ID.
Only fully shadowed rules (cleanup code C01) are supported.

Parameters:
context: Global MSSP context [optional]
device_id: Device ID
code: Cleanup category code
start: Starting page for query allowable values are numeric [optional]
count: Number of pages for query result allowable values are numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/cleanups?code=C01
","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/cleanups","collectionId":"1","id":"1-21-162","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific revision","data":[{"value":null,"type":"text","enabled":true,"key":"revId"}],"dataMode":"params","description":"Fetches a revision specified by revision Id.
To get revId for this API, use the 'id' property of RevisionDTO that is returned by 'Get revisions by device' or 'Get latest revision by device' APIs

Parameters:
context: Global MSSP context [optional]
revId: Id of fetched revision

Usage Example
https://192.168.1.1/securetrack/api/revisions/785
","folder":"1-22","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revId}}","collectionId":"1","id":"1-22-163","method":"GET"},{"headers":"Accept: application/json\n","name":"Get latest revision by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches latest revision for a given device

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/105/latest_revision
","folder":"1-22","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/latest_revision","collectionId":"1","id":"1-22-164","method":"GET"},{"headers":"Accept: application/json\n","name":"Get revisions by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches revisions for a given device

Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query starting from starting page allowable type is numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/105/revisions
","folder":"1-22","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/revisions","collectionId":"1","id":"1-22-165","method":"GET"},{"headers":"Accept: application/json\n","name":"Get last hits for all rules by device","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"}],"dataMode":"params","description":"Get last hit dates for all rules in a given device.
For Palo Alto firewalls, this also returns last hits for users and applications in the rule.

Parameters:
device_id: device id

Usage Example
https://192.168.1.1/securetrack/api/rule_last_usage/find_all/20
","folder":"1-23","url":"https://{{SecureTrack_IP}}/securetrack/api/rule_last_usage/find_all/{{device_id}}","collectionId":"1","id":"1-23-166","method":"GET"},{"headers":"Accept: application/json\n","name":"Get last hit for a specific rule","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"rule_uid"}],"dataMode":"params","description":"Get last hit dates for all rules in a given device.
For Palo Alto firewalls, this also returns last hits for users and applications in the rule.
The rule_uid is the value from the uid field returned by the /rules API: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Parameters:
device_id: device_id
rule_uid: rule_uid

Usage Example
https://192.168.1.1/securetrack/api/rule_last_usage/find/20/ea9db13e-d058-45c6-a2f0-cd731027c22b
","folder":"1-23","url":"https://{{SecureTrack_IP}}/securetrack/api/rule_last_usage/find/{{device_id}}/{{rule_uid}}","collectionId":"1","id":"1-23-167","method":"GET"},{"collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/rule_search/export","name":"Create a CSV file for rules search results","method":"GET","id":"1-24-168","description":"The search_text parameter provides the same capabilities as the Policy Browser feature in SecureTrack.
You can search for a string across all rule fields, or you can search for a combination of specific strings in specific fields.
The text format is for a field is : for example uid:9259f6ee-47a0-4996-a214-ab7edc14a916.
See the search info documentation in Securetrack Policy Browser page for more information.
This API exports the results data as a CSV file in the SecureTrack Reports Repository.

Parameters:
context: Global MSSP context [optional]
search_text: Search text [optional]

Usage Example
https://192.168.1.1/securetrack/api/rule_search/export

Usage Example
https://192.168.1.1/securetrack/api/rule_search/export?search_text=shadowed:true
","folder":"1-24"},{"headers":"Accept: application/json\n","name":"Get a specific rule","data":[{"value":null,"type":"text","enabled":true,"key":"ruleId"}],"description":"Parameters:
ruleId: Rule ID

Usage Example
https://192.168.1.1/securetrack/api/rules/60
","dataMode":"params","folder":"1-24","url":"https://{{SecureTrack_IP}}/securetrack/api/rules/{{ruleId}}","collectionId":"1","id":"1-24-169","method":"GET"},{"headers":"Accept: application/json\n","name":"Get rules by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns a list of all of the security rules for the specified device.
Use add=documentation to retrieve rule documentation.
The is_global parameter is device dependent. For ACL devices, only global rules are returned when set to true. For Check Point R80, only global layers are returned when set to true, and specify a layer name in the subpolicy_name parameter This parameter is ignored for all other vendors. The default value is false.
The subpolicy_name parameter is device dependent. For Check Point R80, only rules that use the specified layer are returned. You can only specify the name of a single layer. This parameter is ignored for all other vendors.
For Cisco ASA devices, when applying a filter you must also add the direction.


Parameters:
context: Global MSSP context [optional]
id: Device ID
policyId: Policy ID [optional]
policy: Policy Name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules (Only for: ACL devices) [optional]
add: If set to \"documentation\" result will include rule documentation [optional]
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
groupBy: Show rules grouping criteria. Can be set only to \"bindings\". Output will be grouped by bindings and section header for Check Point devices, ACL for Cisco devices, and Zones for Juniper, Palo Alto, and Fortinet device [optional]
with_zb: Include zone based rules, values can be 'true' or 'false' [optional]
uid: Binding UID [optional]
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
subpolicy_name: Filter by sub policy name (see implementation notes) [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules?subpolicy_name=layer1&is_global=true

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules?interface=Loopback99:INSIDE
","folder":"1-24","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules","collectionId":"1","id":"1-24-170","method":"GET"},{"headers":"Accept: application/json\n","name":"Find rules","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"}],"dataMode":"params","description":"The search_text parameter provides the same capabilities as the Policy Browser feature in SecureTrack.
You can search for a string across all rule fields, or you can search for a combination of specific strings in specific fields.
The text format is for a field is <fieldname>:<text> for example uid:9259f6ee-47a0-4996-a214-ab7edc14a916.
See the search info documentation in Securetrack Policy Browser page for more information.To get more information regarding objects included in the returned rules (like src_network or dst_network) use their uid, as the objects’ ID might change.
\n By default, if there are less than 3,000 rules - the API will return all the rules.\nIn case there are more than 3,000 rules the API will return an error code 413 with the error message “There are more than 3000 rules, you must use pagination”
“display_rule_number” should return only for Check Point R80 and higher devices.

Parameters:
context: Global MSSP context [optional]
search_text: Search text [optional]
device_id: Device id
start: The starting rule to include in the returned results [optional]
count: Number of rules to include in the results [optional]

Usage Example
https://192.168.1.1/securetrack/api/rule_search/31?search_text=source:Sales_192.168.2.60 fromzone:sales tozone:External

Usage Example
https://192.168.1.1/securetrack/api/rule_search/20?search_text=Mobile Access hascomment:false

Usage Example
https://192.168.1.1/securetrack/api/rule_search/87?search_text=web_server&start=0&count=10

Usage Example
URLhttps://192.168.1.1/securetrack/api/rule_search/59?search_text=uid:9259f6ee-47a0-4996-a214-ab7edc14a916
OUTPUT {
    \"rules\":{
        \"count\":1,
        \"total\":1,
        \"rule\":{
            \"@xsi.type\":\"securityRuleDTO\",
            \"id\":21,
            \"cp_uid\":\"\",
            \"uid\":\"{9259f6ee-47a0-4996-a214-ab7edc14a916}\",
            \"order\":2,
            \"binding\":{
                \"default\":true,
                \"policy\":{
                    \"@xsi.type\":\"managementDomainPolicyDTO\",
                    \"id\":2,
                    \"name\":\"Standard\",
                    \"installable_targets\":\"\"
                },
                \"rule_count\":19,
                \"security_rule_count\":19,
                \"uid\":\"{00-FACED0-00}\"
                },
            \"acceleration_breaker\":false,
            \"action\":\"Accept\",
            \"application\":{
                \"id\":4735,
                \"display_name\":\"ssh\",
                \"name\":\"ssh\"
            },
            \"authentication_rule\":false,
            \"comment\":\"DO NOT DELETE OR EDIT\",
            \"dst_network\":{
                \"id\":39,
                \"display_name\":\"Net_10.110.65.0\",
                \"name\":\"Net_10.110.65.0\"
                \"uid\":\"{1290f6ee-47a1-4996-a214-ab2edc26a916}\"
            },
            \"dest_networks_negated\":false,
            \"dst_service\":{
                \"id\":7420,
                \"display_name\":\"ssh\",
                \"name\":\"ssh\"
                \"uid\":\"{2904f6ee-47a1-4996-a214-ab2edc26a916}\"
            },
            \"dest_services_negated\":false,
            \"dst_zone\":\"any\",
            \"disabled\":false,
            \"external\":false,
            \"implicit\":false,
            \"dst_zone_any\":true,
            \"src_zone_any\":true,
            \"name\":\"Accept SSHG\",
            \"option\":\"LOG_SESSION\",
            \"documentation\":{
                \"permissiveness_level\":\"LOW\",
                \"shadowed\":\"Not shadowed\",
                \"last_modified\":\"Today\",
                \"last_hit\":\"N/A\",
                \"violations\":\"\"
            },
            \"rule_location\":\"Shared\",
            \"rule_location_display\":\"Shared - Pre Rule\",
            \"rule_number\":2,
            \"display_rule_number\":\"2.1\",
            \"rule_type\":\"universal\",
            \"src_zone\":\"any\",
            \"src_network\":{
                \"id\":38,
                \"display_name\":\"Net_10.110.64.0\",
                \"name\":\"Net_10.110.64.0\"
                \"uid\":\"{4934f6ee-47a1-4996-a214-ab2edc26a916}\"
            },
            \"src_networks_negated\":false,
            \"src_services_negated\":false,
            \"track\":{
                \"level\":\"LOG\"
            },
            \"type\":\"rule\",
            \"users\":{
                \"id\":5,
                \"display_name\":\"tufin\\\\regina\",
                \"name\":\"tufin\\\\regina@ldap\"
            }
        }
    }
}


Response Messages:
400: Value for start parameter is missing or not valid
400: Value for count parameter is missing or not valid
413: Max supported count is 3000
413: There are more than 3000 rules, you must use pagination","folder":"1-24","url":"https://{{SecureTrack_IP}}/securetrack/api/rule_search/{{device_id}}","collectionId":"1","id":"1-24-171","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific rule","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Returns a list of rules by revision ID, rule IDs and additional criteria

Parameters:
context: Global MSSP context [optional]
revision_id: Revision id
ids: Rule IDs
policy: Policy name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules (Only for: ACL devices) [optional]
add: If set to \\\"documentation\\\" result will include rule documentation [optional]
groupBy: Rules grouping criteria, can be set only to \\\"bindings\\\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules/16370
","folder":"1-24","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/rules/{{ids}}","collectionId":"1","id":"1-24-172","method":"GET"},{"headers":"Accept: application/json\n","name":"Get rules by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns a list of all of the security rules for the specified revision.
Use add=documentation to retrieve rule documentation.
The is_global parameter is device dependent. For ACL devices, only global rules are returned when set to true. For Check Point R80, only global layers are returned when set to true, and specify a layer name in the subpolicy_name parameter This parameter is ignored for all other vendors. The default value is false.
The subpolicy_name parameter is device dependent. For Check Point R80, only rules that use the specified layer are returned. You can only specify the name of a single layer. This parameter is ignored for all other vendors.
For Cisco ASA devices, when applying a filter you must also add the direction.


Parameters:
context: Global MSSP context [optional]
id: Revision id
policyId: Policy id [optional]
policy: Policy name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules only(device dependent, see implementation Notes) [optional]
add: If set to \"documentation\" result will include rule documentation [optional]
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
groupBy: Rules grouping criteria, can be set only to \"bindings\" [optional]
with_zb: Include zone-based rules [optional]
uid: Binding UID [optional]
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
subpolicy_name: Filter by sub policy name (see implementation notes) [optional]
is_alternate_order: OrderBy alternate order, for display Aci rules by contracts [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules?subpolicy_name=layer1&is_global=true

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules?interface=Loopback99:INSIDE
","folder":"1-24","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules","collectionId":"1","id":"1-24-173","method":"GET"},{"headers":"Accept: application/json\n","name":"Get rule count per device","description":"The search_text parameter provides the same capabilities as the Policy Browser feature in SecureTrack.
You can search for a string across all rule fields, or you can search for a combination of specific strings in specific fields.
The text format is for a field is <fieldname>:<text> for example uid:9259f6ee-47a0-4996-a214-ab7edc14a916.
See the search info documentation in Securetrack Policy Browser page for more information.
This API will return a list of all the devices, the devices that has rules that match the search criteria will have rule_count that is bigger than 0

Parameters:
context: Global MSSP context [optional]
search_text: Search text [optional]
devices: Devices ids [optional]

Usage Example
https://192.168.1.1/securetrack/api/rule_search/87

Usage Example
https://192.168.1.1/securetrack/api/rule_search/87?search_text=ICMP application:facebook

Usage Example
URLhttps://192.168.1.1/securetrack/api/rule_search?search_text=uid:9259f6ee-47a0-4996-a214-ab7edc14a916
OUTPUT{
    \"device_list\":{
        \"device\":[
            {
                \"device_id\":512,
                \"revision_id\":6864,
                \"rule_count\":1
            },
            {
                \"device_id\":59,
                \"revision_id\":543,
                \"rule_count\":0
            }
        ]
    }
}

","folder":"1-24","url":"https://{{SecureTrack_IP}}/securetrack/api/rule_search/","collectionId":"1","id":"1-24-174","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific rule","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Returns a list of rules by device ID, rule IDs and additional criteria.
Note: This API retrieves the information from the latest revision.


Parameters:
context: Global MSSP context [optional]
device_id: Device ID
ids: Rule IDs
policy: Policy Name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules only(device dependent, see implementation Notes) [optional]
add: If set to \"documentation\" result will include rule documentation [optional]
groupBy: Rules grouping criteria, can be set only to \"bindings\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules/16370
","folder":"1-24","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/rules/{{ids}}","collectionId":"1","id":"1-24-175","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific service","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches list of specific service objects defined in revision given by revision ID and specified by their IDs

Parameters:
context: Global MSSP context [optional]
revision_id: Revision id
ids: Rule IDs
show_members: Set to false to return only the name and ID of the members [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/services/959888
","folder":"1-25","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/services/{{ids}}","collectionId":"1","id":"1-25-176","method":"GET"},{"headers":"Accept: application/json\n","name":"Get service groups containing specified service objects","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns groups that contain the specified service objects


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the service object.

Usage Example
https://192.168.1.1/securetrack/api/services/69577/groups
","folder":"1-25","url":"https://{{SecureTrack_IP}}/securetrack/api/services/{{id}}/groups","collectionId":"1","id":"1-25-177","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific service","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches list of specific service objects defined in device given by device ID and specified by their IDs.
Note: This API retrieves the information from the latest revision.

Parameters:
context: Global MSSP context [optional]
device_id: Device ID
ids: Service object IDs separated by commas
show_members: Set to false to return only the name and ID of the members [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/services/959888,959966
","folder":"1-25","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/services/{{ids}}","collectionId":"1","id":"1-25-178","method":"GET"},{"headers":"Accept: application/json\n","name":"Get rules containing specified service object","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the security rules that contain the specified service object


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the service object.
include_groups: You can add \"include_groups\" to find rules that include the service object and rules that include the groups that include the service object. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]

Usage Example
https://192.168.1.1/securetrack/api/services/65078/rules?include_groups=true
","folder":"1-25","url":"https://{{SecureTrack_IP}}/securetrack/api/services/{{id}}/rules","collectionId":"1","id":"1-25-179","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Get services objects matching specified criteria","data":[{"value":null,"type":"text","enabled":true,"key":"filter"}],"dataMode":"raw","description":"You can search for service objects where the name or comment fields have a specified text string,
or you can search for service objects that have an Port or protocol that matches,
or you can search for service objects by uid.

Parameters:
context: Returns results for the specified domain ID. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]
filter: “text” filter returns service objects where the name or comment fields have a specified text string. \n“protocol” filter returns service objects that have a protocol that matches specified IP protocol number.\n“port” filter returns service objects that have a port that matches specified port number.\n “uid“ filter returns service objects with the specified uid.\n If no filter is specified, the “text” filter is used.
device_id: Returns service objects belonging to the specified device_id. [optional]
name: (For “text” filter) You can specify \"name\" to find service objects with the specified text in the name field. [optional]
comment: (For “text” filter) You can specify “comment” to find service objects with the specified text in the comment field. [optional]
protocol: Specify Protocolto find service objects that have the specified IP Protocol. [optional]
port: Specify Portto find service objects that have the specified Port. [optional]
uid: (for “uid“ filter) Returns service objects with the specified uid. [optional]

Usage Example
https://192.168.1.1/securetrack/api/services/search?filter=protocol&protocol=6&device_id=68

Usage Example
https://192.168.1.1/securetrack/api/services/search?filter=port&port=80

Usage Example
https://192.168.1.1/securetrack/api/services/search?filter=uid&uid=24a8774d-24c1-4b3a-aae9-3c272a2b5191

Usage Example
URLhttps://192.168.1.1/securetrack/api/services/search?filter=text&name=tcp_10
BODY{
    \"services\": {
        \"count\": 1,
        \"total\": 1,
        \"service:\": {
            \"id\": 169197,
            \"name\": \"tcp_10\",
            \"display_name\": \"tcp_10\",
            \"class_name\": \"access_role\",
            \"global\": false,
            \"device_id\": 158,
            \"comment\": \"\",
            \"uid\": \"{9EDC2607-6BEC-43D7-A99D-B522BA694ADA}\",
            \"implicit\": false,
            \"max\": false,
            \"min\": false,
            \"protocol\": 6,
            \"timeout\": \"\",
            \"type\": \"tcp_service\",
            }
        }
    }
}

","folder":"1-25","rawModeData":"{\n\t\"services\": {\n\t\t\"count\": 1,\n\t\t\"total\": 1,\n\t\t\"service:\": {\n\t\t\t\"id\": 169197,\n\t\t\t\"name\": \"tcp_10\",\n\t\t\t\"display_name\": \"tcp_10\",\n\t\t\t\"class_name\": \"access_role\",\n\t\t\t\"global\": false,\n\t\t\t\"device_id\": 158,\n\t\t\t\"comment\": \"\",\n\t\t\t\"uid\": \"{9EDC2607-6BEC-43D7-A99D-B522BA694ADA}\",\n\t\t\t\"implicit\": false,\n\t\t\t\"max\": false,\n\t\t\t\"min\": false,\n\t\t\t\"protocol\": 6,\n\t\t\t\"timeout\": \"\",\n\t\t\t\"type\": \"tcp_service\",\n\t\t\t}\n\t\t}\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/services/search","collectionId":"1","id":"1-25-180","method":"GET"},{"headers":"Accept: application/json\n","name":"Get services by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of service objects defined on device given by device ID.
The default value for get_total is false. For APIF 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.


Parameters:
context: Global MSSP context [optional]
id: Device ID
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
start: Starting page for query allowable types are numeric [optional]
count: Number of pages for query allowable values are numeric [optional]
name: Service name [optional]
type: Service type, allowable values are: tcp, udp, ip or icmp [optional]
port: Service port [optional]
icmp_type: Service ICMP type allowable values are numeric between 0 to 40 [optional]
protocol: Service protocol, allowable values are numeric between 0 to 255 [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/20/services?get_total=true
OUTPUT {
    \"services\": {
        \"count\": 50,
        \"total\": 100,
        \"service\": [{
            \"@xsi.type\": \"singleServiceDTO\",
            \"id\": 5129479,
            \"name\": \"Tcp30025\",
            \"display_name\": \"Tcp30025\",
            \"class_name\": \"tcp_service\",
            \"type\": \"tcp_service\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{079F15A5-009E-7E47-BBD0-E65973646562}\",
            \"implicit\": false,
            \"overrides\": false,
            \"max\": 30025,
            \"min\": 30025,
            \"negate\": false,
            \"protocol\": 6,
            \"timeout\": 0
        }]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/services?type=group&show_members=false
OUTPUT{
    \"services\": {
    \"count\": 100,
        \"service\": [
            {
                \"@xsi.type\": \"serviceGroupDTO\",
                \"id\": 1359066,
                \"name\": \"#Shared Domain@DNS\",
                \"display_name\": \"DNS\",
                \"class_name\": \"service_group\",
                \"type\": \"group\",
                \"global\": \"false\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": false,
                \"overrides\": \"false\",
                \"type_on_device\": gen_service_group,
                \"is_device_predefined\": true,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"DNS\",
                    \"name\": \"#Shared Domain@DNS\",
            }
        ]
    }
}

","folder":"1-25","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/services","collectionId":"1","id":"1-25-181","method":"GET"},{"headers":"Accept: application/json\n","name":"Get services by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of service objects defined in revision given by revision ID
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.


Parameters:
context: Global MSSP context [optional]
id: Revision id
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
start: Starting page for query allowable types are numeric [optional]
count: Number of pages for query allowable values are numeric [optional]
name: Service name [optional]
type: Service type, allowable values are: tcp, udp, ip or icmp [optional]
port: Service port [optional]
icmp_type: Service ICMP type allowable values are numeric between 0 to 40 [optional]
protocol: Service protocol, allowable values are numeric betweenm 0 to 255 [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/785/services?get_total=true
OUTPUT {
    \"services\": {
        \"count\": 50,
        \"total\": 100,
        \"service\": [{
            \"@xsi.type\": \"singleServiceDTO\",
            \"id\": 5129479,
            \"name\": \"Tcp30025\",
            \"display_name\": \"Tcp30025\",
            \"class_name\": \"tcp_service\",
            \"type\": \"tcp_service\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{079F15A5-009E-7E47-BBD0-E65973646562}\",
            \"implicit\": false,
            \"overrides\": false,
            \"max\": 30025,
            \"min\": 30025,
            \"negate\": false,
            \"protocol\": 6,
            \"timeout\": 0
        }]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/31/services?type=group&show_members=false
OUTPUT{
    \"services\": {
    \"count\": 100,
        \"service\": [
            {
                \"@xsi.type\": \"serviceGroupDTO\",
                \"id\": 1359066,
                \"name\": \"#Shared Domain@DNS\",
                \"display_name\": \"DNS\",
                \"class_name\": \"service_group\",
                \"type\": \"group\",
                \"global\": \"false\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": false,
                \"overrides\": \"false\",
                \"type_on_device\": gen_service_group,
                \"is_device_predefined\": true,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"DNS\",
                    \"name\": \"#Shared Domain@DNS\",
            }
        ]
    }
}

","folder":"1-25","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/services","collectionId":"1","id":"1-25-182","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific time object","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches list of time objects by revision ID and rule ID

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Rule IDs

Usage Example
https://192.168.1.1/securetrack/api/revisions/7/time_objects/9
","folder":"1-26","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/time_objects/{{ids}}","collectionId":"1","id":"1-26-183","method":"GET"},{"headers":"Accept: application/json\n","name":"Get time objects by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the time objects used in the specified revision.

Parameters:
context: Global MSSP context [optional]
id: Revision ID
start: Starting page for query allowable value is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/time_objects
","folder":"1-26","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/time_objects","collectionId":"1","id":"1-26-184","method":"GET"},{"headers":"Accept: application/json\n","name":"Get time objects by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the time objects used in the specified device.

Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable values are numeric [optional]
count: Starting page for query allowable values are numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/time_objects
","folder":"1-26","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/time_objects","collectionId":"1","id":"1-26-185","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Get policy relevance metrics for traffic","dataMode":"raw","description":"The response lists all the relevant security groups, tags, relevant instances, and count of unrelated instances for each Amazon VPC in the specified traffic path.
A relevant security group contains at least one instance including either the source or destination IP address.
An unrelated instance is included in the security group but not part of the specified traffic path.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is used only if MSSP mode is enabled. If MSSP mode is disabled context is ignored.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.

Parameters:
context: Global MSSP context [optional]
body: Relevance metrics request

Usage Example
URLhttps://192.168.1.1/securetrack/api/traffic_policy
BODY{
    \"relevance_metrics\": {
        \"source_ips\": {
            \"source\":[\"10.10.253.0/24\", \"172.31.50.99/32\"]
        },
        \"dest_ips\": {
            \"dest\": [\"172.31.150.0/24\", \"172.31.50.99/32\"]
        },
        \"targets\": {
            \"target\": [4, 10]
        }
    }
}


Response Messages:
200: Successful
403: Insufficient user permissions
404: Device not found
400: Invalid parameters","folder":"1-27","rawModeData":"{\n\t\"relevance_metrics\": {\n\t\t\"source_ips\": {\n\t\t\t\"source\":[\"10.10.253.0/24\", \"172.31.50.99/32\"]\n\t\t},\n\t\t\"dest_ips\": {\n\t\t\t\"dest\": [\"172.31.150.0/24\", \"172.31.50.99/32\"]\n\t\t},\n\t\t\"targets\": {\n\t\t\t\"target\": [4, 10]\n\t\t}\n\t}\n}\n","url":"https://{{SecureTrack_IP}}/securetrack/api/traffic_policy/","collectionId":"1","id":"1-27-186","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Get violations for an access request","dataMode":"raw","description":"Calculate the violations for the given access request.
Note: this API may take a while to complete.
See the asynchronous API /violations/access_request/task as an alternative.

Parameters:
body: AccessRequestListDTO
use_topology: Use topology to determine access request domains. [optional]
ar_domain_mode: The access request supports multiple domains. [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/violations/access_requests/sync?use_topology=false&ar_domain_mode=false
BODY<access_requests>
    <access_request>
     <use_topology>false</use_topology>
     <access_request_order>0</access_request_order>
     <access_request_source xsi:type=\"internet\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"/>
     <access_request_destination xsi:type=\"ip_network\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <network xsi:type=\"raw_network_subnet\">
         <negate>false</negate>
         <ip>10.100.0.1</ip>
         <mask>255.255.255.255</mask>
         </network>
     </access_request_destination>
     <access_request_service xsi:type=\"implicit_service\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <name>ssh</name>
         <service>
             <predefined>true</predefined>
             <min_protocol>6</min_protocol>
             <max_protocol>6</max_protocol>
             <min_port>22</min_port>
             <max_port>22</max_port>
             <negate>false</negate>
         </service>
     </access_request_service>
     <action>ACCEPT</action>
    </access_request>
</access_requests>


Response Messages:
200: Access request violations were calculated.
400: Access request order is not unique.
400: Domain cannot be specified when domain mode is false.
400: Cannot specify both ticket domain id and source and destination domains.
400: No domain specified in MSSP mode.
400: Domain does not exist.
400: Access request is malformed.
400: No valid access requests (Access requests cannot have topology enabled and the Internet object in the Source/Destination).
403: Access is denied.","folder":"1-28","rawModeData":"\n\t\n\t false\n\t 0\n\t \n\t \n\t\t \n\t\t false\n\t\t 10.100.0.1\n\t\t 255.255.255.255\n\t\t \n\t \n\t \n\t\t ssh\n\t\t \n\t\t\t true\n\t\t\t 6\n\t\t\t 6\n\t\t\t 22\n\t\t\t 22\n\t\t\t false\n\t\t \n\t \n\t ACCEPT\n\t\n\n","url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/sync","collectionId":"1","id":"1-28-187","method":"POST"},{"headers":"Accept: application/json\n","name":"Get violation task results","data":[{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"params","description":"Get result of access requests violations task.

Parameters:
taskId: The unique identifier of the access request violations task.

Usage Example
https://192.168.1.1/securetrack/api/violations/access_requests/result/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Access request violations task results were received.
403: Access is denied.
404: An error occurred during the calculation.
404: The calculation for the task has not finished yet.","folder":"1-28","url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/result/{{taskId}}","collectionId":"1","id":"1-28-188","method":"GET"},{"name":"Cancel violation task","data":[{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"params","description":"Delete an access request violations task.

Parameters:
taskId: The unique identifier of the access request violations task.

Usage Example
https://192.168.1.1/securetrack/api/violations/access_requests/task/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
204: Access request violations task has been aborted successfully.
403: Access is denied.
404: Access request violations task was not found.","folder":"1-28","url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/task/{{taskId}}","collectionId":"1","id":"1-28-189","method":"DELETE"},{"headers":"Content-Type: application/xml\n","name":"Start a task to calculate violations for an access request","dataMode":"raw","description":"Create a calculation task to find access requests violations.
Returns a task Id that can be used to check the task status and get the task results

Parameters:
body [optional]
use_topology: Use topology to determine access request domains. [optional]
ar_domain_mode: The access request uses resources from multiple domains. [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/violations/access_requests/task?use_topology=false&ar_domain_mode=false
BODY<access_requests>
    <access_request>
     <use_topology>false</use_topology>
     <access_request_order>0</access_request_order>
     <access_request_source xsi:type=\"internet\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"/>
     <access_request_destination xsi:type=\"ip_network\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <network xsi:type=\"raw_network_subnet\">
         <negate>false</negate>
         <ip>10.100.0.1</ip>
         <mask>255.255.255.255</mask>
         </network>
     </access_request_destination>
     <access_request_service xsi:type=\"implicit_service\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <name>ssh</name>
         <service>
             <predefined>true</predefined>
             <min_protocol>6</min_protocol>
             <max_protocol>6</max_protocol>
             <min_port>22</min_port>
             <max_port>22</max_port>
             <negate>false</negate>
         </service>
     </access_request_service>
     <action>ACCEPT</action>
    </access_request>
</access_requests>


Response Messages:
202: Access request violations task was accepted.
400: Access request order is not unique.
400: Domain cannot be specified when domain mode is false.
400: Cannot specify both ticket domain id and source and destination domains.
400: No domain specified in MSSP mode.
400: Domain does not exist.
400: Access request is malformed.
400: No valid access requests (Access requests cannot have topology enabled and the Internet object in the Source/Destination)
400: No network source were specified.
400: No network destination were specified.
403: Access is denied.
503: Access request violations task was rejected.","folder":"1-28","rawModeData":"\n\t\n\t false\n\t 0\n\t \n\t \n\t\t \n\t\t false\n\t\t 10.100.0.1\n\t\t 255.255.255.255\n\t\t \n\t \n\t \n\t\t ssh\n\t\t \n\t\t\t true\n\t\t\t 6\n\t\t\t 6\n\t\t\t 22\n\t\t\t 22\n\t\t\t false\n\t\t \n\t \n\t ACCEPT\n\t\n\n","url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/task","collectionId":"1","id":"1-28-190","method":"POST"},{"headers":"Accept: application/json\n","name":"Get violation task status","data":[{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"params","description":"Get access requests violations task status.

Parameters:
taskId: The unique identifier of the access request violations task.

Usage Example
https://192.168.1.1/securetrack/api/violations/access_requests/status/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Access request violations task status was received.
403: Access is denied.
404: Access request violations task status was not found.","folder":"1-28","url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/status/{{taskId}}","collectionId":"1","id":"1-28-191","method":"GET"},{"headers":"Accept: application/json\n","name":"Get alerts","data":[{"value":null,"type":"text","enabled":true,"key":"start"},{"value":null,"type":"text","enabled":true,"key":"count"}],"dataMode":"params","description":"Returns a list of all alerts. If an empty list is returned, it implies that there are no configured alerts for that context.
You must set start and count parameters to limit the number of returned alerts.
Start is zero based - to start from the second rule use start=1, to get rules 51-60 use start=50 and count=10.

Parameters:
context: MSSP context [optional]
start: Returns the results beginning with the specified result number
count: Returns the specified number of results

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts?start=10&count=25

Response Messages:
400: Value for start parameter is missing or not valid
400: Value for count parameter is missing or not valid","folder":"1-29","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/","collectionId":"1","id":"1-29-192","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Create an alert","dataMode":"raw","description":"Create an alert for unified security policies.
Returns location with the alert id to get the alert.
Alerts can be defined for all devices (all_devices:true) or for specified device IDs.
An email and/or user name must be defined. For multiple entries of emails or user names, use a semicolon to separate values. For SecureTrack, users in the collection are populated with \"user_ids\". The alert will be sent to the users (according to the addresses configured in SecureTrack) and to the emails.
To get the domain_id (optional parameter), call /domains/ API and use the ID included within the returned domain DTO.
At least one severity should be marked as 'true'.
There are no default values

Parameters:
context: Global MSSP context [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_policies/alerts
BODY{
    \"usp_alert_configuration\": {
        \"name\": \"uspAlert\",
        \"description\": \"description\",
        \"status\": \"ACTIVE\",
        \"domain_id\": 6,
        \"all_devices\": false,
        \"device_ids\": {
            \"device_id\": [
                1,
                2,
                3,
                4
            ]
        },
        \"low_severity\": true,
        \"medium_severity\": true,
        \"high_severity\": true,
        \"critical_severity\": false,
        \"user_ids\": {
            \"user_id\": [
                \"moshe\",
                \"admin\"
                ]
        },
        \"emails\": \"user@doamin.com\",
        \"send_syslog\": true
    }
}


Response Messages:
201: Security policy alert id :|'alertId'| , name : 'alertName'
412: Alert name not specified
409: Alert name specified already exists
412: Status not specified
412: Domain not specified
404: Domain specified does not exist
403: User is not authorized to configure alerts for domain 'domainId'
412: Device not specified
404: Device ID specified does not exist or belongs to a different domain
403: Device: 'deviceId' not supported for USP
412: Severity not specified
412: No recipient details entered for alert
412: Invalid email address. Format must be name@domain.com
404: Username: 'userName' does not exist
403: User is not authorized to configure alerts for Super Admin user: 'userName'
403: Username: 'userName' not valid for the specified domain","folder":"1-29","rawModeData":"{\n\t\"usp_alert_configuration\": {\n\t\t\"name\": \"uspAlert\",\n\t\t\"description\": \"description\",\n\t\t\"status\": \"ACTIVE\",\n\t\t\"domain_id\": 6,\n\t\t\"all_devices\": false,\n\t\t\"device_ids\": {\n\t\t\t\"device_id\": [\n\t\t\t\t1,\n\t\t\t\t2,\n\t\t\t\t3,\n\t\t\t\t4\n\t\t\t]\n\t\t},\n\t\t\"low_severity\": true,\n\t\t\"medium_severity\": true,\n\t\t\"high_severity\": true,\n\t\t\"critical_severity\": false,\n\t\t\"user_ids\": {\n\t\t\t\"user_id\": [\n\t\t\t\t\"moshe\",\n\t\t\t\t\"admin\"\n\t\t\t\t]\n\t\t},\n\t\t\"emails\": \"user@doamin.com\",\n\t\t\"send_syslog\": true\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/","collectionId":"1","id":"1-29-193","method":"POST"},{"name":"Delete alerts by ids","data":[{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Delete specified alerts by IDs
To delete multiple alert_ids, use a comma between each ID

Parameters:
context: Delete alerts in the specified domain ID. [optional]
ids: The alert Ids for deletion

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts/87

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts/86,87,88

Response Messages:
200:
403: Security Policy Alert Ids: :|'alert ids'| don't exist","folder":"1-29","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/{{ids}}","collectionId":"1","id":"1-29-194","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get a specific alert","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns a specified alert.
If the alert_id does not exist, an error message is returned.

Parameters:
context: MSSP context [optional]
id: The alert Id

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts/1

Response Messages:
403: Alert ID does not exist","folder":"1-29","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/{{id}}","collectionId":"1","id":"1-29-195","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Update an alert","dataMode":"raw","description":"Update an alert for unified security policies.
Alerts can be defined for all devices (all_devices:true) or for specified device IDs.
An email and/or user name must be defined. For multiple entries of emails or user names, use a semicolon to separate values. For SecureTrack, users in the collection are populated with \"user_ids\". The alert will be sent to the users (according to the addresses configured in SecureTrack) and to the emails.
To get the domain_id (optional parameter), call /domains/ API and use the ID included within the returned domain DTO.
At least one severity should be marked as 'true'.
There are no default values

Parameters:
context: Global MSSP context [optional]
id: The alert ID for updating [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_policies/alerts/1
BODY{
    \"usp_alert_configuration\": {
        \"name\": \"uspAlert\",
        \"description\": \"description\",
        \"status\": \"ACTIVE\",
        \"domain_id\": 6,
        \"all_devices\": false,
        \"device_ids\": {
            \"device_id\": [
                1,
                2,
                3,
                4
            ]
        },
        \"low_severity\": true,
        \"medium_severity\": true,
        \"high_severity\": true,
        \"critical_severity\": false,
        \"user_ids\": {
            \"user_id\": [
                \"moshe\",
                \"admin\"
                ]
        },
        \"emails\": \"user@doamin.com\",
        \"send_syslog\": true
    }
}


Response Messages:
204: Alert ID: 'alertId' was updated successfully
404: Alert ID: 'alertId' does not exist
412: Alert name not specified
409: Alert name specified already exists
412: Status not specified
412: Domain not specified
404: Domain specified does not exist
403: User is not authorized to configure alerts for domain 'domainId'
412: Device not specified
404: Device ID specified does not exist or belongs to a different domain
403: Device: 'deviceId' not supported for USP
412: Severity not specified
412: No recipient details entered for alert
412: Invalid email address. Format must be name@domain.com
404: Username: 'userName' does not exist
403: User is not authorized to configure alerts for Super Admin user: 'userName'
403: Username: 'userName' not valid for the specified domain","folder":"1-29","rawModeData":"{\n\t\"usp_alert_configuration\": {\n\t\t\"name\": \"uspAlert\",\n\t\t\"description\": \"description\",\n\t\t\"status\": \"ACTIVE\",\n\t\t\"domain_id\": 6,\n\t\t\"all_devices\": false,\n\t\t\"device_ids\": {\n\t\t\t\"device_id\": [\n\t\t\t\t1,\n\t\t\t\t2,\n\t\t\t\t3,\n\t\t\t\t4\n\t\t\t]\n\t\t},\n\t\t\"low_severity\": true,\n\t\t\"medium_severity\": true,\n\t\t\"high_severity\": true,\n\t\t\"critical_severity\": false,\n\t\t\"user_ids\": {\n\t\t\t\"user_id\": [\n\t\t\t\t\"moshe\",\n\t\t\t\t\"admin\"\n\t\t\t\t]\n\t\t},\n\t\t\"emails\": \"user@doamin.com\",\n\t\t\"send_syslog\": true\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/{{id}}","collectionId":"1","id":"1-29-196","method":"PUT"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Check if tags are compliant with cloud tag policies","data":[{"value":null,"type":"text","enabled":true,"key":"policy_external_id"}],"dataMode":"raw","description":"Check if the tags of a cloud resource are compliant with the specified cloud tag policy. Specify the tag policy to validate in the TagPolicyViolationsCheckRequestDTO. The tags of a cloud resource are specified as a json object with the attribute 'tags' at the root level. 'tags' attributes can be a list of tag names or a map including both the tag name and value. If no tags are specified or if the tag is specified incorrectly, The compliance check will treat the resource as if it has no tags. If no cloud tag policy violations are found the API returns an empty violations list.

Parameters:
context: Returns results for the specified domain ID [optional]
policy_external_id: Tag policy external identifier
body: Tag policy violation check request

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/violation_check?policy_external_id=policyId
BODY {
    \"type\": \"vm\",
    \"name\": \"CRM-FE\",
    \"os\": \"ubuntu14.4\",
    \"image\": \"AMI-12345\",
    \"tags\": {
        \"Role\": \"webserver\",
        \"Budget\": \"corporate\",
        \"Owner\": \"Steve.Smith\"
    }
}


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions
404: Resource not found","folder":"1-30","rawModeData":" {\n\t\"type\": \"vm\",\n\t\"name\": \"CRM-FE\",\n\t\"os\": \"ubuntu14.4\",\n\t\"image\": \"AMI-12345\",\n\t\"tags\": {\n\t\t\"Role\": \"webserver\",\n\t\t\"Budget\": \"corporate\",\n\t\t\"Owner\": \"Steve.Smith\"\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/violation_check/","collectionId":"1","id":"1-30-197","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Replace a cloud tag policy","dataMode":"raw","description":"Replace the cloud tag policy specified by policyID with the new policy attributes.

Use PATCH in order to partially modify a policy. If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Replace policy of the specified domain ID [optional]
policyId: cloud tag policy id [optional]
body: cloud tag policy dTO [optional]

Usage Example
URLhttps://{ip}/securetrack/api/tagpolicy/policies/policyId
BODY{
    \"policy_name\": \"myPolicyName\",
    \"requirements\": [
        {
            \"requirement_type\": \"mandatory_tags\",
            \"requirement_name\": \"mandatory_requirement1\",
            \"requirement_severity\": \"CRTICAL\",
            \"tags\": [
                \"Owner\",
                \"Role\"
            ]
        }
    ]
}
OUTPUT{
        \"status\": \"OK\",
        \"policy_id\": \"tp-123\"
}

","folder":"1-30","rawModeData":"{\n\t\"policy_name\": \"myPolicyName\",\n\t\"requirements\": [\n\t\t{\n\t\t\t\"requirement_type\": \"mandatory_tags\",\n\t\t\t\"requirement_name\": \"mandatory_requirement1\",\n\t\t\t\"requirement_severity\": \"CRTICAL\",\n\t\t\t\"tags\": [\n\t\t\t\t\"Owner\",\n\t\t\t\t\"Role\"\n\t\t\t]\n\t\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","collectionId":"1","id":"1-30-198","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get cloud tag policy","description":"This API retrieves the details of the cloud tag policy specified by policyId.

User must have admin permissions to the policy affiliated domain. If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Returns results for the specified domain ID [optional]
policyId: cloud tag policy id [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/policyId
OUTPUT{
        \"status\": \"OK\",
        \"result\": [
                {
                        \"policy_id\": \"tp-101\",
                        \"policy_name\": \"myPolicyName\",
                        \"requirements\": [
                                {
                                        \"requirement_type\": \"mandatory_tags\",
                                        \"requirement_name\": \"myMandatoryTagsRequirement\",
                                    \"requirement_severity\": \"CRTICAL\",
                                        \"tags\": [
                                                \"Owner\",
                                                \"Name\"
                                        ]
                                },
                                {
                                        \"requirement_type\": \"valid_values\",
                                        \"requirement_name\": \"myValidValueRequirement\",
                                    \"requirement_severity\": \"CRTICAL\",
                                        \"tag\": \"Budget\",
                                        \"values\": [
                                                \"R&D\",
                                                \"HR\"
                                        ]
                                }
                        ]
                }
        ]
}


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions
404: Resource not found","folder":"1-30","url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","collectionId":"1","id":"1-30-199","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Modify a cloud tag policy","dataMode":"raw","description":"Partially modify a cloud tag policy by stating the modified attributes. Providing requirements replaces the entire list.

Specifying an empty requirement list is not permitted. Modify some attributes of the cloud tag policy specified by policyID with the attributes provided. If one or more \"requirement\" objects is provided, the exsiting \"requirement\" objects will be deleted and replaced with the new objetcs. Specifying an empty requirement list is not permitted.If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Rename policy of the specified domain ID [optional]
policyId: cloud tag policy id [optional]
body: cloud tag policy dTO [optional]

Usage Example
URLhttps://{ip}/securetrack/api/tagpolicy/policies/policyId
BODY{
    \"policy_name\": \"myPolicyName\",
    \"requirements\": [
        {
            \"requirement_type\": \"mandatory_tags\",
            \"requirement_name\": \"mandatory_requirement1\",
            \"requirement_severity\": \"CRTICAL\",
            \"tags\": [
                \"Owner\",
                \"Role\"
            ]
        }
    ]
}
OUTPUT{
        \"status\": \"OK\",
        \"policy_id\": \"tp-123\"
}


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions
404: Resource not found","folder":"1-30","rawModeData":"{\n\t\"policy_name\": \"myPolicyName\",\n\t\"requirements\": [\n\t\t{\n\t\t\t\"requirement_type\": \"mandatory_tags\",\n\t\t\t\"requirement_name\": \"mandatory_requirement1\",\n\t\t\t\"requirement_severity\": \"CRTICAL\",\n\t\t\t\"tags\": [\n\t\t\t\t\"Owner\",\n\t\t\t\t\"Role\"\n\t\t\t]\n\t\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","collectionId":"1","id":"1-30-200","method":"PATCH"},{"headers":"Accept: application/json\n","name":"Delete cloud tag policy","description":"Delete the cloud tag policy specified by policyId.

If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Delete policy of the specified domain ID [optional]
policyId: cloud tag policy id [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/policyId
OUTPUT {
        \"status\": \"OK\",
        \"policy_name\": \"myPolicyName\"
}


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions
404: Resource not found","folder":"1-30","url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","collectionId":"1","id":"1-30-201","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get all cloud tag policies","description":"This API returns the details of all the tag policies.

Results are filtered according to user domain permissions and request context. If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Returns results for the specified domain ID [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/
OUTPUT{
        \"status\": \"OK\",
        \"result\": [
                {
                        \"policy_id\": \"tp-101\",
                        \"policy_name\": \"myPolicy1\",
                        \"requirements\": [
                                {
                                        \"requirement_type\": \"mandatory_tags\",
                                        \"requirement_name\": \"myMandatoryRequirement\",
                                        \"requirement_severity\": \"HIGH\",
                                        \"tags\": [
                                                \"Owner\",
                                                \"Name\"
                                        ]
                                },
                                {
                                        \"requirement_type\": \"valid_values\",
                                        \"requirement_name\": \"myValidValueRequirement\",
                                        \"requirement_severity\": \"CRTICAL\",
                                        \"tag\": \"Budget\",
                                        \"values\": [
                                                \"R&D\",
                                                \"HR\"
                                        ]
                                }
                        ]
                },
                {
                        \"policy_id\": \"tp-102\",
                        \"policy_name\": \"myPolicy2\",
                        \"requirements\": [
                                {
                                        \"requirement_type\": \"mandatory_tags\",
                                        \"requirement_name\": \"myMandatoryRequirement\",
                                        \"requirement_severity\": \"HIGH\",
                                        \"tags\": [
                                                \"Owner\"
                                        ]
                                },
                                {
                                        \"requirement_type\": \"valid_values\",
                                        \"requirement_name\": \"myValidValueRequirement\",
                                        \"requirement_severity\": \"CRTICAL\",
                                        \"tag\": \"Budget\",
                                        \"values\": [
                                                \"R&D\",
                                                \"HR\"
                                        ]
                                }
                        ]
                }
        ]
}


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions","folder":"1-30","url":"https://{{SecureTrack_IP}}/securetrack/api/policies/","collectionId":"1","id":"1-30-202","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Create a cloud tag policy","dataMode":"raw","description":"Create a new cloud tag policy. The policyName field specified in the TagPolicyDTO must be unique. Define the requirements enforced by the cloud tag policy in the requirements field of the TagPolicyDTO. The supported value for the \"requirement_type\" field are \"mandatory_tags\" and \"valid_values\"If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Create policy for the specified domain ID [optional]
body: cloud tag policy DTO [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/
BODY {
    \"policy_name\": \"Production-VPC-Tag-Policy\",
    \"policy_description\": \"Instances tags in production\",
    \"requirements\": [
        {
            \"requirement_type\": \"mandatory_tags\",
            \"requirement_name\": \"mandatory_financial_tags\",
            \"requirement_severity\": \"HIGH\",
            \"tags\": [
                \"Owner\",
                \"Budget\"
            ]
        },
        {
            \"requirement_type\": \"valid_values\",
            \"requirement_name\": \"budget_valid_values\",
            \"requirement_severity\": \"CRITICAL\",
            \"tag\": \"Budget\",
            \"values\": [
                \"Corporate\",
                \"Dev\"
            ]
        }
    ]
}
OUTPUT{
        \"status\": \"OK\",
        \"policy_id\": \"tp-123\"
}


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions
409: Policy name already exists","folder":"1-30","rawModeData":" {\n\t\"policy_name\": \"Production-VPC-Tag-Policy\",\n\t\"policy_description\": \"Instances tags in production\",\n\t\"requirements\": [\n\t\t{\n\t\t\t\"requirement_type\": \"mandatory_tags\",\n\t\t\t\"requirement_name\": \"mandatory_financial_tags\",\n\t\t\t\"requirement_severity\": \"HIGH\",\n\t\t\t\"tags\": [\n\t\t\t\t\"Owner\",\n\t\t\t\t\"Budget\"\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"requirement_type\": \"valid_values\",\n\t\t\t\"requirement_name\": \"budget_valid_values\",\n\t\t\t\"requirement_severity\": \"CRITICAL\",\n\t\t\t\"tag\": \"Budget\",\n\t\t\t\"values\": [\n\t\t\t\t\"Corporate\",\n\t\t\t\t\"Dev\"\n\t\t\t]\n\t\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/policies/","collectionId":"1","id":"1-30-203","method":"POST"},{"headers":"Accept: application/json\n","name":"Get all cloud tag policy violations for a VPC","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"},{"value":null,"type":"text","enabled":true,"key":"severity"}],"dataMode":"params","description":"Retrieve all cloud tag policy violations for the specified VPC and severity level.

Parameters:
context: Global MSSP context. [optional]
deviceId: The device ID for which to get violations
severity: Return only violations of this severity
resourceId: The id of the VM instance [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses \"count=100\". [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tag_violations?deviceId=123&severity=CRITICAL
OUTPUT<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<tag_policy_device_violations>
    <violating_resources_count>2</violating_resources_count>
    <device_name>Amazon Test VPC </device_name>
    <severity>critical</severity>
    <violating_resources>
        <violating_resource>
            <tag_violations>
                <tag_violation>
                    <violation_message>Tag 'Name' value 'email server' is not valid. Valid values are [R&D, HR]</violation_message>
                    <policy_id>tp-100</policy_id>
                    <policy_name>Tag policy 1</policy_name>
                    <requirement_name>validValue_constraint2</requirement_name>
                    <requirement_severity>high</requirement_severity>
                    <violation_attributes xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"valid_values\">
                        <tag>Name</tag>
                        <valid_values>
                            <valid_value>R&D</valid_value>
                            <valid_value>HR</valid_value>
                        </valid_values>
                        <invalid_value>email server</invalid_value>
                    </violation_attributes>
                </tag_violation>
            </tag_violations>
            <resource_id>i-abc12345</resource_id>
            <resource_name>email server</resource_name>
        </violating_resource>
        <violating_resource>
            <tag_violations>
                <tag_violation>
                    <violation_message>Tag 'Application' is missing</violation_message>
                    <policy_id>tp-105</policy_id>
                    <policy_name>Tag policy 1</policy_name>
                    <requirement_name>mandatory_constraint1</requirement_name>
                    <requirement_severity>critical</requirement_severity>
                    <violation_attributes xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"mandatory_tags\">
                        <missing_tag>Application</missing_tag>
                    </violation_attributes>
                </tag_violation>
            </tag_violations>
            <resource_id>i-12345678</resource_id>
            <resource_name>Violations tests server</resource_name>
        </violating_resource>
    </violating_resources>
</tag_policy_device_violations>


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions
404: A device with the specified ID was not found","folder":"1-30","url":"https://{{SecureTrack_IP}}/securetrack/api/tag_violations/","collectionId":"1","id":"1-30-204","method":"GET"},{"headers":"Accept: application/json\n","name":"Get a specific exception","data":[{"value":null,"type":"text","enabled":true,"key":"exceptionId"}],"dataMode":"params","description":"Gets a specific exception for unified security policies.

Parameters:
exceptionId: The ID of the exception to get.
context: Global MSSP context [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/14

Response Messages:
403: User not permitted to access the specified domain
404: A security policy exception with the specified ID was not found.","folder":"1-31","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/{{exceptionId}}","collectionId":"1","id":"1-31-205","method":"GET"},{"headers":"Accept: application/json\n","name":"Delete an exception","data":[{"value":null,"type":"text","enabled":true,"key":"exceptionId"}],"dataMode":"params","description":"Delete the specific unified security policy exceptions

Parameters:
exceptionId: The ID of the exception to delete.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/14

Response Messages:
404: The security policy with the specified ID does not exist
403: User not permitted to access the specified domain.","folder":"1-31","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/{{exceptionId}}","collectionId":"1","id":"1-31-206","method":"DELETE"},{"name":"Start a task to calculate matching rules for an exception","data":[{"value":null,"type":"text","enabled":true,"key":"exceptionId"}],"dataMode":"params","description":"Create a calculation task to find matching rules.
The results will be on the relevant devices for each access.
Returns a task Id that can be used to check the task status and get the task results

Parameters:
exceptionId: Security policy Exception ID on which to run the API.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/1/matching_rules/start

Response Messages:
403: User not permitted to Security policy exceptions.
404: A security policy exception with the specified ID was not found.","folder":"1-31","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/{{exceptionId}}/matching_rules/start","collectionId":"1","id":"1-31-207","method":"POST"},{"headers":"Accept: application/json\n","name":"Get matching rules task status","data":[{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
taskId: The unique identifier of the matching rules task.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/matching_rules/status/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Matching rules task status was received.
403: User not permitted to Security policy exceptions.
404: Matching rules task status was not found.","dataMode":"params","folder":"1-31","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/matching_rules/status/{{taskId}}","collectionId":"1","id":"1-31-208","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create an exception","dataMode":"raw","description":"Create an exception for unified security policies.

Parameters:
context: Global MSSP context [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_policies/exceptions
BODY<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<security_policy_exception>
    <approved_by>admin</approved_by>
    <created_by>st_user</created_by>
    <creation_date>2015-01-01</creation_date>
    <description>Allow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321</description>
    <exempted_traffic_list>
        <exempted_traffic>
            <comment>Creating USP exception for ticket 123</comment>
            <dest_network_collection>
                <network_items>
                    <network_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"subnet\">
                        <ip>192.168.1.2</ip>
                        <netmask>255.255.255.255</netmask>
                    </network_item>
                </network_items>
            </dest_network_collection>
            <security_requirements>
                <zone_to_zone_security_requirement>
                    <from_zone>LAN</from_zone>
                    <policy_name>corporate security policy</policy_name>
                    <to_zone>DMZ</to_zone>
                </zone_to_zone_security_requirement>
            </security_requirements>
            <service_collection>
                <service_items>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"custom\">
                        <port>4321</port>
                        <protocol>tcp</protocol>
                    </service_item>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"device_service\">
                        <mgmt_id>1</mgmt_id>
                        <service_uid>{5aa1c104-bd4d-4635-a281-b3a5442639ba}</service_uid>
                    </service_item>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"predefined\">
                        <predefined_service_name>http</predefined_service_name>
                    </service_item>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"range_service\">
                        <minProtocol>10</minProtocol>
                        <maxProtocol>20</maxProtocol>
                    </service_item>
                </service_items>
            </service_collection>
            <source_network_collection>
                <network_items>
                    <network_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"subnet\">
                        <ip>192.168.1.1</ip>
                        <netmask>255.255.255.255</netmask>
                    </network_item>
                </network_items>
            </source_network_collection>
        </exempted_traffic>
    </exempted_traffic_list>
    <expiration_date>2025-01-01</expiration_date>
    <name>Allow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321</name>
    <requested_by>admin</requested_by>
    <ticket_id>123</ticket_id>
</security_policy_exception>


Response Messages:
400: The specified network item is not valid.
400: The specified zone name does not exist.
400: The security policy with the specified name does not exist
400: The security policy 'created by' user is not valid.
400: The security policy with the specified name already exists.
403: User not permitted to access the specified domain.","folder":"1-31","rawModeData":"\n\n\tadmin\n\tst_user\n\t2015-01-01\n\tAllow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321\n\t\n\t\t\n\t\t\tCreating USP exception for ticket 123\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t192.168.1.2\n\t\t\t\t\t\t255.255.255.255\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\tLAN\n\t\t\t\t\tcorporate security policy\n\t\t\t\t\tDMZ\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t4321\n\t\t\t\t\t\ttcp\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t1\n\t\t\t\t\t\t{5aa1c104-bd4d-4635-a281-b3a5442639ba}\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\thttp\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t10\n\t\t\t\t\t\t20\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t192.168.1.1\n\t\t\t\t\t\t255.255.255.255\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\t2025-01-01\n\tAllow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321\n\tadmin\n\t123\n","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/","collectionId":"1","id":"1-31-209","method":"POST"},{"headers":"Accept: application/json\n","name":"Get all exceptions","description":"Gets a list of all unified security policy exceptions.

Parameters:
context: Global MSSP context [optional]
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query starting from starting page allowable type in numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions

Response Messages:
403: User not permitted to access the specified domain","folder":"1-31","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/","collectionId":"1","id":"1-31-210","method":"GET"},{"headers":"Accept: application/json\n","name":"Get matching rules task results","data":[{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
taskId: The unique identifier of the matching rules task.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/matching_rules/result/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Matching rules task results were received.
403: User not permitted to Security policy exceptions.
404: An error occurred during the calculation.
404: The calculation for the task has not finished yet.","dataMode":"params","folder":"1-31","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/matching_rules/result/{{taskId}}","collectionId":"1","id":"1-31-211","method":"GET"},{"name":"Cancel Matching rules task","data":[{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
taskId: The unique identifier of the matching rules task.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/matching_rules/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
204: Matching rules task has been aborted successfully.
403: User not permitted to Security policy exceptions.
404: Matching rules task was not found.","dataMode":"params","folder":"1-31","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/matching_rules/{{taskId}}","collectionId":"1","id":"1-31-212","method":"DELETE"},{"name":"Delete unified security policy","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Delete a Security Policy Matrix

Parameters:
context: Returns results for the specified domain ID. [optional]
id: The unique identifier of the security policy matrix to delete

Usage Example
https://192.168.1.1/securetrack/api/security_policies/1
","folder":"1-32","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/{{id}}","collectionId":"1","id":"1-32-213","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get zone to interface mapping","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"}],"dataMode":"params","description":"Fetches mapping of SecureTrack zones to device interfaces

Parameters:
context: Global MSSP context [optional]
deviceId: Device ID

Usage Example
https://127.0.0.1/securetrack/api/security_policies/9/mapping

Response Messages:
200: Successful
400: This device does not support zone to interface mapping
403: User not permitted to access the specified domain
404: Device ID: <deviceId> does not exist
404: Access denied for device with ID: <deviceId>","folder":"1-32","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/{{deviceId}}/mapping","collectionId":"1","id":"1-32-214","method":"GET"},{"collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/{{id}}/export","name":"Get unified security policy as CSV","method":"GET","id":"1-32-215","description":"Exports a Security Policy in CSV format

Parameters:
context: Returns results for the specified domain ID. [optional]
id: ID of the security policy. [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies/1/export

Response Messages:
403: User not permitted to access the specified domain
404: Security Policy does not exist","folder":"1-32"},{"headers":"Accept: application/json\n","name":"Get unified security policies","description":"Fetches the security zone matrices defined under Unified Security Policy.

Parameters:
context: Returns results for the specified domain ID. [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies

Response Messages:
403: User not permitted to access the specified domain","folder":"1-32","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/","collectionId":"1","id":"1-32-216","method":"GET"},{"headers":"Accept: application/json\n","name":"Get global unified security policies","description":"Fetches the global security zone matrices defined under Unified Security Policy.



Usage Example
https://192.168.1.1/securetrack/api/security_policies/global

Response Messages:
403: User not permitted to access global security policies","folder":"1-32","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/global","collectionId":"1","id":"1-32-217","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Set manual device mapping","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"}],"dataMode":"raw","description":"Add or remove a zone on a device interface

Parameters:
context: Global MSSP context [optional]
deviceId: Device ID
body: InterfacesManualMappingsDTO

Usage Example
URLhttps://127.0.0.1/securetrack/api/security_policies/10/manual_mapping
BODY<interfaces_manual_mappings>
<interface_manual_mapping>
<interface_name>Vlan_30</interface_name>
<zones_user_actions>
<zone_user_action>
<zoneId>10</zoneId>
<action>add</action>
</zone_user_action>
</zones_user_actions>
</interface_manual_mapping>
</interfaces_manual_mappings>


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions
404: Not found error
404: User action not valid (only add/remove)
404: No interface with name for device with id
404: No zone with id
404: No revision for device with id
404: Device ID: <deviceId> does not exist
404: Access denied for device with ID: <deviceId>
404: InterfacesManualMappingsDTO is empty
404: Error on updating security_policy_interface_zone_mapping_user_action table for device with ID","folder":"1-32","rawModeData":"\n \n Vlan_30\n \n \n 10\n add\n \n \n \n\n ","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/{{deviceId}}/manual_mapping","collectionId":"1","id":"1-32-218","method":"POST"},{"headers":"Accept: application/json\n","name":"Get the amount of violating rules for the specified device.","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"}],"description":"Parameters:
deviceId: The device ID for which to get violations.

Usage Example
https://192.168.1.1/securetrack/api/violating_rules/1/count

Response Messages:
200: The violation count was successfully retrieved
404: Device with id: <deviceId> doesn't exist","dataMode":"params","folder":"1-33","url":"https://{{SecureTrack_IP}}/securetrack/api/violating_rules/{{deviceId}}/count","collectionId":"1","id":"1-33-219","method":"GET"},{"headers":"Accept: application/json\n","name":"Get the violating rules for the specified device.","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"},{"value":null,"type":"text","enabled":true,"key":"severity"},{"value":null,"type":"text","enabled":true,"key":"type"}],"dataMode":"params","description":"policyName is supported for management devices running in Advanced management mode.

Parameters:
deviceId: The device ID for which to get violations
policyName: Return only violations that match this policy [optional]
severity: Return only violations of this severity
type: Return only violations of this type

Usage Example
https://192.168.1.1/securetrack/api/violating_rules/1/device_violations?policy=policy_name&type=SECURITY_POLICY&severity=MEDIUM

Response Messages:
200: The violations were successfully retrieved
400: The specified value for the violation severity is invalid
400: The specified value for the violation type is invalid
400: You cannot specify a policyName because the device is not running in Advanced management mode
404: A device with the specified ID was not found
404: A policy with the specified policyName was not found for this device","folder":"1-33","url":"https://{{SecureTrack_IP}}/securetrack/api/violating_rules/{{deviceId}}/device_violations","collectionId":"1","id":"1-33-220","method":"GET"}],"order":[],"name":"Tufin Tufin SecureTrack R20-2-HF2","id":"1","description":"Tufin Orchestration Suite - Tufin SecureTrack APIs.
For detailed information about the APIs please see the documentation at:
https://your-securetrack-server/securetrack/apidoc"} \ No newline at end of file diff --git a/Postman Format v1/R20-2 postman collection/tufin.postman_environment b/Postman Format v1/R20-2 postman collection/tufin.postman_environment new file mode 100644 index 0000000..c031d2b --- /dev/null +++ b/Postman Format v1/R20-2 postman collection/tufin.postman_environment @@ -0,0 +1 @@ +{"name":"Tufin environment","values":[{"type":"text","key":"SecureApp_IP"},{"type":"text","key":"SecureChange_IP"},{"type":"text","key":"SecureTrack_IP"},{"type":"text","key":"applicationId"},{"type":"text","key":"applicationInterfaceId"},{"type":"text","key":"application_id"},{"type":"text","key":"application_pack_id"},{"type":"text","key":"assigneeId"},{"type":"text","key":"child_id"},{"type":"text","key":"child_ids"},{"type":"text","key":"cleanup_id"},{"type":"text","key":"cloudId"},{"type":"text","key":"cloud_id"},{"type":"text","key":"connectionId"},{"type":"text","key":"connectionInterfaceId"},{"type":"text","key":"connectionToApplicationId"},{"type":"text","key":"connection_id"},{"type":"text","key":"connection_to_application_pack_id"},{"type":"text","key":"customer_id"},{"type":"text","key":"deviceId"},{"type":"text","key":"device_id"},{"type":"text","key":"domainId"},{"type":"text","key":"exceptionId"},{"type":"text","key":"fieldId"},{"type":"text","key":"id"},{"type":"text","key":"ids"},{"type":"text","key":"inId"},{"type":"text","key":"instructionId"},{"type":"text","key":"interfaceCustomerId"},{"type":"text","key":"layer2DataId"},{"type":"text","key":"managementId"},{"type":"text","key":"mgmtId"},{"type":"text","key":"parent_id"},{"type":"text","key":"parent_ids"},{"type":"text","key":"policyId"},{"type":"text","key":"requestId"},{"type":"text","key":"revId"},{"type":"text","key":"revision_id"},{"type":"text","key":"risk_id"},{"type":"text","key":"routeId"},{"type":"text","key":"ruleId"},{"type":"text","key":"rule_id"},{"type":"text","key":"rule_uid"},{"type":"text","key":"serverId"},{"type":"text","key":"serviceId"},{"type":"text","key":"sourceApplicationId"},{"type":"text","key":"stepId"},{"type":"text","key":"tag_id"},{"type":"text","key":"targetApplicationId"},{"type":"text","key":"taskId"},{"type":"text","key":"task_id"},{"type":"text","key":"task_uid"},{"type":"text","key":"toStepId"},{"type":"text","key":"uid"},{"type":"text","key":"userId"},{"type":"text","key":"vpnId"},{"type":"text","key":"zone_id"},{"type":"text","key":"zone_ids"}]} \ No newline at end of file diff --git a/Postman Format v1/R21-1 postman collection/securechangeworkflow_R21-1-RC1.json b/Postman Format v1/R21-1 postman collection/securechangeworkflow_R21-1-RC1.json new file mode 100644 index 0000000..73276e3 --- /dev/null +++ b/Postman Format v1/R21-1 postman collection/securechangeworkflow_R21-1-RC1.json @@ -0,0 +1 @@ +{"folders":[{"order":["2-1-1","2-1-2","2-1-3","2-1-4","2-1-5"],"collectionId":"2","name":"Access Portal","hasRequests":true,"id":"2-1"},{"order":["2-2-6","2-2-7","2-2-8","2-2-9","2-2-10","2-2-11","2-2-12","2-2-13"],"collectionId":"2","name":"Application Connections","hasRequests":true,"id":"2-2"},{"order":["2-3-14"],"collectionId":"2","name":"Application Identities","hasRequests":true,"id":"2-3"},{"order":["2-4-15","2-4-16","2-4-17","2-4-18","2-4-19","2-4-20","2-4-21","2-4-22","2-4-23","2-4-24","2-4-25","2-4-26","2-4-27","2-4-28","2-4-29"],"collectionId":"2","name":"Application Interfaces","hasRequests":true,"id":"2-4"},{"order":["2-5-30","2-5-31","2-5-32","2-5-33","2-5-34"],"collectionId":"2","name":"Application Migration","hasRequests":true,"id":"2-5"},{"order":["2-6-35","2-6-36","2-6-37","2-6-38","2-6-39","2-6-40","2-6-41","2-6-42","2-6-43","2-6-44","2-6-45","2-6-46","2-6-47","2-6-48","2-6-49","2-6-50","2-6-51","2-6-52"],"collectionId":"2","name":"Application Packs","hasRequests":true,"id":"2-6"},{"order":["2-7-53"],"collectionId":"2","name":"Application Pending Changes","hasRequests":true,"id":"2-7"},{"order":["2-8-54","2-8-55"],"collectionId":"2","name":"Application Servers (across all applications)","hasRequests":true,"id":"2-8"},{"order":["2-9-56","2-9-57","2-9-58","2-9-59","2-9-60","2-9-61","2-9-62","2-9-63"],"collectionId":"2","name":"Application Servers (by application)","hasRequests":true,"id":"2-9"},{"order":["2-10-64","2-10-65","2-10-66","2-10-67","2-10-68","2-10-69"],"collectionId":"2","name":"Application Services (global)","hasRequests":true,"id":"2-10"},{"order":["2-11-70","2-11-71","2-11-72","2-11-73","2-11-74"],"collectionId":"2","name":"Application Services (local)","hasRequests":true,"id":"2-11"},{"order":["2-12-75","2-12-76","2-12-77","2-12-78"],"collectionId":"2","name":"Application Users","hasRequests":true,"id":"2-12"},{"order":["2-13-79","2-13-80","2-13-81","2-13-82","2-13-83","2-13-84","2-13-85","2-13-86","2-13-87","2-13-88","2-13-89"],"collectionId":"2","name":"Applications","hasRequests":true,"id":"2-13"},{"order":["2-14-90","2-14-91","2-14-92"],"collectionId":"2","name":"Cloud Console","hasRequests":true,"id":"2-14"},{"order":["2-15-93","2-15-94","2-15-95","2-15-96","2-15-97","2-15-98","2-15-99"],"collectionId":"2","name":"Customers","hasRequests":true,"id":"2-15"},{"order":["2-16-100","2-16-101","2-16-102"],"collectionId":"2","name":"Domains","hasRequests":true,"id":"2-16"},{"order":["2-17-103"],"collectionId":"2","name":"External Provider","hasRequests":true,"id":"2-17"},{"order":["2-18-104"],"collectionId":"2","name":"Load Balancers","hasRequests":true,"id":"2-18"},{"order":["2-19-105"],"collectionId":"2","name":"Rule Recertification","hasRequests":true,"id":"2-19"},{"order":["2-20-106","2-20-107","2-20-108","2-20-109"],"collectionId":"2","name":"SecureChange Devices","hasRequests":true,"id":"2-20"},{"order":["2-21-110","2-21-111","2-21-112","2-21-113","2-21-114","2-21-115"],"collectionId":"2","name":"Server Decommissioning","hasRequests":true,"id":"2-21"},{"order":["2-22-116","2-22-117"],"collectionId":"2","name":"System Configuration","hasRequests":true,"id":"2-22"},{"order":["2-23-118","2-23-119","2-23-120","2-23-121","2-23-122","2-23-123","2-23-124"],"collectionId":"2","name":"System Users","hasRequests":true,"id":"2-23"},{"order":["2-24-125","2-24-126","2-24-127","2-24-128","2-24-129","2-24-130","2-24-131","2-24-132"],"collectionId":"2","name":"Ticket Lifecycle","hasRequests":true,"id":"2-24"},{"order":["2-25-133","2-25-134","2-25-135","2-25-136","2-25-137","2-25-138","2-25-139","2-25-140","2-25-141","2-25-142","2-25-143","2-25-144","2-25-145","2-25-146","2-25-147","2-25-148","2-25-149","2-25-150","2-25-151","2-25-152","2-25-153","2-25-154","2-25-155","2-25-156","2-25-157","2-25-158","2-25-159"],"collectionId":"2","name":"Tickets","hasRequests":true,"id":"2-25"}],"requests":[{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Update application access requests","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"dataMode":"raw","description":"Use this API to approve or reject application access requests

Parameters:
applicationId: The unique identifier of the application
body: application access requests

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests
BODY<application_access_requests>
    <application_access_request>
        <id>1</id>
        <action>APPROVE</action>
    </application_access_request>
    <application_access_request>
        <id>2</id>
        <action>REJECT</action>
    </application_access_request>
</application_access_requests>


Response Messages:
200: Application access requests were updated.
400: The application was already deleted.
400: Invalid ID for access request
400: Cannot update access request with id ID
400: Action cannot be empty in request with id ID
400: Invalid action in request with id ID
400: The Server group is lock for discovery
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","folder":"2-1","rawModeData":"\n\t\n\t\t1\n\t\tAPPROVE\n\t\n\t\n\t\t2\n\t\tREJECT\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests","collectionId":"2","id":"2-1-1","method":"PUT"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Create application access request","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: application access request

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests
BODY<application_access_request>
    <server_group_id>1</server_group_id>
    <server_ip>1.1.1.1</server_ip>
    <comment>Request to join the WebServers server group</comment>
</application_access_request>


Response Messages:
201: Application access request was submitted.
400: The application was already deleted.
400: Server id cannot be empty.
400: Hostname or IP cannot be empty.
400: The provided server does not exist in application.
400: The provided server is not allowed to access.
400: Request already created
400: Requester cannot be null
400: Group cannot be empty
400: Invalid ip
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","dataMode":"raw","folder":"2-1","rawModeData":"\n\t1\n\t1.1.1.1\n\tRequest to join the WebServers server group\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests","collectionId":"2","id":"2-1-2","method":"POST"},{"headers":"Accept: application/json\n","name":"Retrieve existing application access requests","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests

Response Messages:
400: The application was already deleted.
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.","dataMode":"params","folder":"2-1","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests","collectionId":"2","id":"2-1-3","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Update an application access request","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"requestId"}],"dataMode":"raw","description":"Use this API to approve or reject application access requests

Parameters:
applicationId: The unique identifier of the application
requestId: The unique identifier of the application access request
body: application access request

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests/1
BODY<application_access_request>
    <action>APPROVE</action>
</application_access_request>


Response Messages:
200: Application access request was updated.
400: The application was already deleted.
400: Invalid ID for access request
400: Cannot update access request with id ID
400: Action cannot be empty in request with id ID
400: Invalid action in request with id ID
400: The Server group is lock for discovery
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","folder":"2-1","rawModeData":"\n\tAPPROVE\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests/{{requestId}}","collectionId":"2","id":"2-1-4","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve an existing application access request by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"requestId"}],"description":"Parameters:
applicationId: The unique identifier of the application
requestId: The unique identifier of the application access request

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests/1

Response Messages:
400: The application was already deleted.
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Access request with id ID was not found in application with id ID","dataMode":"params","folder":"2-1","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests/{{requestId}}","collectionId":"2","id":"2-1-5","method":"GET"},{"headers":"Accept: application/json\n","name":"Retrieve existing connections, with extended resources information","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the connection [optional]
start: Return results starting only from the specified index; 0-based index; default value = 0 [optional]
count: Return the specified number of results. Returns all results if no value specified [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended?name=Connection Name

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended?name=Connection Name&start=50&count=100

Response Messages:
400: Start value cannot be a negative number.
400: Count value must be greater than 0.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: Access is denied.
404: There is no application with the specified ID.
404: There are no connections with the name NAME.","dataMode":"params","folder":"2-2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_extended","collectionId":"2","id":"2-2-6","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Create a ticket to repair a connection","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"},{"value":null,"type":"text","enabled":true,"key":"connection_id"}],"description":"Parameters:
application_id: The application ID
connection_id: The connection ID
body: Ticket

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/2/repair
BODY<ticket>
    <subject>Repair connection 2</subject>
    <requester>u1</requester>
    <priority>Normal</priority>
    <workflow>
        <name>Workflow with topology</name>
    </workflow>
    <steps>
        <step>
            <name>Open request</name>
            <tasks>
                <task>
                    <fields>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_area\">
                            <name>Business Justification</name>
                            <text>I need access to ftp </text>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_field\">
                            <name>Project Number</name>
                            <text>CR124560</text>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"hyperlink\">
                            <name>Hyperlink</name>
                            <url>http://192.168.1.1/ticket</url>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"drop_down_list\">
                            <name>Change Window</name>
                            <selection>Monday</selection>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"manager\">
                            <name>manager email</name>
                            <text>manager@tufin.com</text>
                        </field>
                    </fields>
                </task>
            </tasks>
        </step>
    </steps>
    <comments/>
</ticket>


Response Messages:
201: Ticket was created.
400: The requester must be the currently logged in user.
400: Workflow was not found.
400: Workflow is not active.
400: Workflow configuration is not valid.
400: Workflow is not set.
400: You cannot enter a status for a new ticket.
400: Requester cannot open a ticket in domain.
400: Invalid ticket priority.
400: Expiration field is required.
400: Submit ticket enabled only with the first step.
400: First step can be only with one task.
400: The specified workflow does not contain an access request field in the first step.
400: You cannot use an access request field to create a ticket from SecureApp.
400: The ticket fields do not match the fields in the current step of the workflow.
400: You cannot change the value of a field because it is read-only.
403: Logged in user: NAME do not have permission to perform on behalf actions.
403: You are not a participant in the first step of this workflow.
403: Access is denied.
403: To create a ticket you must purchase a valid SecureChange license.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: Cannot create a ticket to repair this connection because the connection status is not disconnected.
403: Cannot create a ticket to repair this connection because the connection was edited but a ticket has not been created yet.
403: Cannot create a ticket to repair this connection because there are other open tickets for an application that includes this connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID.","dataMode":"raw","folder":"2-2","rawModeData":"\n\tRepair connection 2\n\tu1\n\tNormal\n\t\n\t\tWorkflow with topology\n\t\n\t\n\t\t\n\t\t\tOpen request\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tBusiness Justification\n\t\t\t\t\t\t\tI need access to ftp \n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tProject Number\n\t\t\t\t\t\t\tCR124560\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tHyperlink\n\t\t\t\t\t\t\thttp://192.168.1.1/ticket\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tChange Window\n\t\t\t\t\t\t\tMonday\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tmanager email\n\t\t\t\t\t\t\tmanager@tufin.com\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connections/{{connection_id}}/repair","collectionId":"2","id":"2-2-7","method":"POST"},{"headers":"Content-Type: application/xml\n","name":"Update a connection","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"connectionId"}],"description":"Parameters:
applicationId: The unique identifier of the application
connectionId: The unique identifier of the connection
body: Connection

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections/1
BODY <connection>
     <name>Connection A</name>
     <comment>Connection A comment</comment>
     <sources>
         <source>
             <id>2</id>
         </source>
         <source>
             <id>3</id>
         </source>
     </sources>
     <services>
         <service>
             <id>1</id>
         </service>
     </services>
     <destinations>
         <destination>
             <id>1</id>
         </destination>
     </destinations>
</connection>


Response Messages:
200: Connection was modified.
400: Reference to service ID is invalid.
400: Reference to source/destination with ID is invalid.
400: Connection name cannot be empty.
400: Connection name already exists.
400: Connection NAME contains duplicate destinations.
400: Destination cannot contain users.
400: Resource cannot contain other objects along with Any.
400: Connection NAME contains duplicate sources.
400: You cannot add external resources to interface connections.
400: You cannot have Any in both the source and destination.
400: You cannot add external resources to interface connections.
400: Source cannot contain both users and servers.
400: Connection NAME contains duplicate services.
400: Cannot contain other services along with ANY.
400: Connections can only include objects within the same customer.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permission to access application that contains the server ID
403: You do not have permissions to edit this application.
403: Access is denied
403: You cannot edit or delete an external connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID.","dataMode":"raw","folder":"2-2","rawModeData":" \n\t Connection A\n\t Connection A comment\n\t \n\t\t \n\t\t\t 2\n\t\t \n\t\t \n\t\t\t 3\n\t\t \n\t \n\t \n\t\t \n\t\t\t 1\n\t\t \n\t \n\t \n\t\t \n\t\t\t 1\n\t\t \n\t \n ","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}","collectionId":"2","id":"2-2-8","method":"PUT"},{"name":"Delete connection","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"connectionId"}],"description":"Parameters:
applicationId: The unique identifier of the application
connectionId: The unique identifier of the connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/1

Response Messages:
200: Connection was deleted.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: Access is denied
403: You cannot edit or delete an external connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID.","dataMode":"params","folder":"2-2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}","collectionId":"2","id":"2-2-9","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Retrieve an existing connection by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"connectionId"}],"description":"Parameters:
applicationId: The unique identifier of the application
connectionId: The unique identifier of the connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/1

Response Messages:
401: No available licenses. Ask your SecureApp administrator for assistance.
403: Access is denied
403: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID.","dataMode":"params","folder":"2-2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}","collectionId":"2","id":"2-2-10","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Update connections","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: List of connections

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections
BODY<connections>
     <connection>
         <id>1</id>
         <name>Connection A</name>
         <comment>Connection A comment</comment>
         <sources>
             <source>
                 <id>2</id>
             </source>
             <source>
                 <id>3</id>
             </source>
         </sources>
         <services>
             <service>
                 <id>1</id>
             </service>
         </services>
         <destinations>
             <destination>
                 <id>1</id>
             </destination>
         </destinations>
     </connection>
     <connection>
         <id>2</id>
         <name>Connection B</name>
     </connection>
     <connection>
         <id>3</id>
         <name>Connection C</name>
         <sources>
             <source>
                 <id>2</id>
             </source>
         </sources>
     </connection>
</connections>


Response Messages:
200: Connections were modified.
400: Reference to service ID is invalid.
400: Reference to source/destination with ID is invalid.
400: Connection name cannot be empty.
400: Connection name already exists.
400: Connection NAME contains duplicate destinations.
400: Destination cannot contain users.
400: Resource cannot contain other objects along with Any.
400: Connection NAME contains duplicate sources.
400: You cannot add external resources to interface connections.
400: You cannot have Any in both the source and destination.
400: You cannot add external resources to interface connections.
400: Source cannot contain both users and servers.
400: Connection NAME contains duplicate services.
400: Cannot contain other services along with ANY.
400: Connections can only include objects within the same customer.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permission to access application that contains the server ID
403: You do not have permissions to edit this application.
403: Access is denied
403: You cannot edit or delete an external connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID.","dataMode":"raw","folder":"2-2","rawModeData":"\n\t \n\t\t 1\n\t\t Connection A\n\t\t Connection A comment\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t\t \n\t\t\t\t 3\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t \n\t \n\t\t 2\n\t\t Connection B\n\t \n\t \n\t\t 3\n\t\t Connection C\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t \n\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections","collectionId":"2","id":"2-2-11","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve existing connections","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the connection [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections?name=Connection Name

Response Messages:
401: No available licenses. Ask your SecureApp administrator for assistance.
403: Access is denied
403: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: There are no connections with the name NAME.","dataMode":"params","folder":"2-2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections","collectionId":"2","id":"2-2-12","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create connections","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: The list of the connections

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections
BODY<connections>
     <connection>
         <name>Connection A</name>
         <comment>Connection A comment</comment>
         <sources>
             <source>
                 <id>2</id>
             </source>
             <source>
                 <id>3</id>
             </source>
         </sources>
         <services>
             <service>
                 <id>1</id>
             </service>
         </services>
         <destinations>
             <destination>
                 <id>1</id>
             </destination>
         </destinations>
     </connection>
     <connection>
         <name>Connection B</name>
     </connection>
     <connection>
         <name>Connection C</name>
         <sources>
             <source>
                 <id>2</id>
             </source>
         </sources>
     </connection>
</connections>


Response Messages:
200: Connections were created.
201: Connection was created.
400: There are no items to add.
400: You cannot add to application NAME because it was decommissioned.
400: Connection name already exists.
400: Reference to service ID is invalid.
400: Reference to source/destination with ID is invalid.
400: Connection NAME contains duplicate destinations.
400: Destination cannot contain users.
400: Resource cannot contain other objects along with Any.
400: Connection NAME contains duplicate sources.
400: You cannot add external resources to interface connections.
400: You cannot have Any in both the source and destination.
400: You cannot add external resources to interface connections.
400: Source cannot contain both users and servers.
400: Connection NAME contains duplicate services.
400: Cannot contain other services along with ANY.
400: Connections can only include objects within the same customer.
403: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: Access is denied
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","dataMode":"raw","folder":"2-2","rawModeData":"\n\t \n\t\t Connection A\n\t\t Connection A comment\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t\t \n\t\t\t\t 3\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t \n\t \n\t\t Connection B\n\t \n\t \n\t\t Connection C\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t \n\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections","collectionId":"2","id":"2-2-13","method":"POST"},{"headers":"Accept: application/json\n","name":"Fetches application identities","description":"Fetches the list of pre-defined application identities (like facebook) that can be used in a connection.

Parameters:
name: The name of the service [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/application_identities

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/application_identities?name=facebook

Response Messages:
404: There are no application identities with the name NAME.
403: Access is denied.","folder":"2-3","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/application_identities","collectionId":"2","id":"2-3-14","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create interface connections","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
body: The interface connections

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections
BODY<interface_connections>
    <interface_connection>
        <name>Connection 1</name>
        <sources>
            <source>
                <id>3</id>
            </source>
        </sources>
        <services>
            <service>
                <id>3</id>
            </service>
            <service>
                <id>Facebook</id>
            </service>
        </services>
        <comment>New connection</comment>
    </interface_connection>
</interface_connections>


Response Messages:
200: Interface connections were created.
201: Interface connection was created.
400: There are no items to add.
400: Cannot create interface connection without a name.
400: Connection name already exists.
400: You cannot add user to connection interface.
400: You cannot add Any to connection interface.
400: You cannot add Internet to connection interface.
400: Cannot have external servers.
400: Cannot have both sources and destinations.
400: Connection NAME contains duplicate sources.
400: Connection NAME contains duplicate services.
400: Connection NAME contains duplicate destinations.
400: Reference to source/destination with ID is invalid.
400: Reference to service ID is invalid.
403: Access is denied.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.","dataMode":"raw","folder":"2-4","rawModeData":"\n\t\n\t\tConnection 1\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\t\n\t\t\t\tFacebook\n\t\t\t\n\t\t\n\t\tNew connection\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections","collectionId":"2","id":"2-4-15","method":"POST"},{"headers":"Accept: application/json\n","name":"Retrieve existing interface connections","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
name: The name of the interface connection [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections?name=Connection 1

Response Messages:
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There are no connection interfaces with the name NAME.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections","collectionId":"2","id":"2-4-16","method":"GET"},{"headers":"Accept: application/json\n","name":"Retrieve existing application interfaces","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"dataMode":"params","description":"To improve response time, set 'calculateIsPublished = false' to avoid calculating 'is_published'.

Parameters:
applicationId: The unique identifier of the application
name: The name of the application interface [optional]
calculateIsPublished: Should calculate is_published value [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces?name=Interface to Application 1

Response Messages:
400: There is no application with the specified ID.
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There are no application interfaces with the name NAME.","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces","collectionId":"2","id":"2-4-17","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create application interface","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: The application interface

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces
BODY<application_interface>
    <name>Interface to Application 1</name>
    <comment>New application interface</comment>
</application_interface>


Response Messages:
201: Application interface was created.
400: You cannot add to application NAME because it was decommissioned.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.","dataMode":"raw","folder":"2-4","rawModeData":"\n\tInterface to Application 1\n\tNew application interface\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces","collectionId":"2","id":"2-4-18","method":"POST"},{"name":"Delete interface connection","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"},{"value":null,"type":"text","enabled":true,"key":"connectionInterfaceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
connectionInterfaceId: The unique identifier of the interface connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections/1

Response Messages:
200: Interface connection was deleted.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}","collectionId":"2","id":"2-4-19","method":"DELETE"},{"headers":"Content-Type: application/xml\n","name":"Update an interface connection","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"},{"value":null,"type":"text","enabled":true,"key":"connectionInterfaceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
connectionInterfaceId: The unique identifier of the interface connection
body: The interface connection

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections/1
BODY<interface_connection>
    <name>Updated name</name>
    <sources>
        <source>
            <id>19</id>
        </source>
    </sources>
    <services>
        <service>
            <id>9</id>
        </service>
    </services>
    <comment>Updated connection</comment>
</interface_connection>


Response Messages:
200: Interface connection was modified.
400: Interface connection name cannot be empty.
400: Connection name already exists.
400: You cannot add user to connection interface.
400: You cannot add Any to connection interface.
400: You cannot add Internet to connection interface.
400: Cannot have external servers.
400: Cannot have both sources and destinations.
400: Connection NAME contains duplicate sources.
400: Connection NAME contains duplicate services.
400: Connection NAME contains duplicate destinations.
400: Reference to source/destination with ID is invalid.
400: Reference to service ID is invalid.
403: Access is denied.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID.","dataMode":"raw","folder":"2-4","rawModeData":"\n\tUpdated name\n\t\n\t\t\n\t\t\t19\n\t\t\n\t\n\t\n\t\t\n\t\t\t9\n\t\t\n\t\n\tUpdated connection\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}","collectionId":"2","id":"2-4-20","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve an existing interface connection by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"},{"value":null,"type":"text","enabled":true,"key":"connectionInterfaceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
connectionInterfaceId: The unique identifier of the interface connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections/1

Response Messages:
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}","collectionId":"2","id":"2-4-21","method":"GET"},{"headers":"Accept: application/json\n","name":"Retrieve an existing connection to application by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"connectionToApplicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
connectionToApplicationId: The unique identifier of the connection to application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications/1

Response Messages:
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Connection to application with ID was not found for application interface with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications/{{connectionToApplicationId}}","collectionId":"2","id":"2-4-22","method":"GET"},{"name":"Delete connection to application","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"connectionToApplicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
connectionToApplicationId: The unique identifier of the connection to application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications/1

Response Messages:
200: Connection to application was deleted.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection to application with ID was not found for application interface with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications/{{connectionToApplicationId}}","collectionId":"2","id":"2-4-23","method":"DELETE"},{"headers":"Content-Type: application/xml\n","name":"Update a connection to application","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"connectionToApplicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
connectionToApplicationId: The unique identifier of the connection to application
body: The connection to application

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications/1
BODY<connection_to_application>
    <name>Updated name</name>
    <comment>Updated connection to application</comment>
    <servers>
        <server>
            <id>4</id>
        </server>
    </servers>
</connection_to_application>


Response Messages:
200: Connection to application was modified.
400: Name cannot be empty.
400: Name already exists.
400: Reference to source/destination with ID is invalid.
400: You cannot add ANY to connection to application.
400: You cannot add user to connection to application.
400: You cannot add Internet to connection to application.
403: Access is denied
403: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection to application with ID was not found for application interface with ID.","dataMode":"raw","folder":"2-4","rawModeData":"\n\tUpdated name\n\tUpdated connection to application\n\t\n\t\t\n\t\t\t4\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications/{{connectionToApplicationId}}","collectionId":"2","id":"2-4-24","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve existing connections to application","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the connection to application [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications?name=Connection to Application 1

Response Messages:
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications","collectionId":"2","id":"2-4-25","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create connection to application","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"dataMode":"raw","description":"Create a connection from this application to an application interface.

Parameters:
applicationId: The unique identifier of the application
body: The connection to application

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications
BODY<connection_to_application>
    <name>Connection to Application 1</name>
    <comment>New connection to application</comment>
    <application_interface_id>1</application_interface_id>
    <servers>
        <server>
            <id>3</id>
        </server>
    </servers>
</connection_to_application>


Response Messages:
201: Connection to application was created.
400: You cannot add to application NAME because it was decommissioned.
400: The selected interface cannot be used more than once in the application.
400: Name cannot be empty.
400: Cannot create from local interface.
400: ApplicationInterface didn't got published.
400: Name already exists.
400: Cannot create connection to application without servers, there should be at least one server.
400: Reference to source/destination with ID is invalid.
400: You can use only interface from the same customer.
400: You cannot add ANY to connection to application.
400: You cannot add user to connection to application.
400: You cannot add Internet to connection to application.
403: Access is denied
403: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found.","folder":"2-4","rawModeData":"\n\tConnection to Application 1\n\tNew connection to application\n\t1\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications","collectionId":"2","id":"2-4-26","method":"POST"},{"headers":"Content-Type: application/xml\n","name":"Update an application interface","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"}],"dataMode":"raw","description":"Update the application interface properties. If is_published is set to true, the application interface is published for use by other users.

Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of The application interface
body: The application interface

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1
BODY<application_interface>
    <name>updated name</name>
    <comment>Updated application interface</comment>
    <is_published>true</is_published>
</application_interface>


Response Messages:
200: Application interface was modified.
400: Application interface is not complete for publish.
400: Name cannot be empty.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.","folder":"2-4","rawModeData":"\n\tupdated name\n\tUpdated application interface\n\ttrue\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}","collectionId":"2","id":"2-4-27","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve an existing application interface by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1

Response Messages:
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}","collectionId":"2","id":"2-4-28","method":"GET"},{"name":"Delete application interface","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"applicationInterfaceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1

Response Messages:
200: Application interface was deleted.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.","dataMode":"params","folder":"2-4","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}","collectionId":"2","id":"2-4-29","method":"DELETE"},{"headers":"Content-Type: application/xml\n","name":"Update server mappings for source and target applications","data":[{"value":null,"type":"text","enabled":true,"key":"sourceApplicationId"},{"value":null,"type":"text","enabled":true,"key":"targetApplicationId"}],"dataMode":"raw","description":"Use id=-1 for target_network_object if new mapping is ���Not Needed���.
If the source is specified and the target is empty, the mapping that is currently configured will be deleted.

Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application
body: The server mapping list [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/servers_mapping
BODY<servers_mapping>
    <server_mapping>
        <source_network_object>
            <id>3</id>
        </source_network_object>
        <target_network_object>
            <id>4</id>
        </target_network_object>
    </server_mapping>
    <server_mapping>
        <source_network_object>
            <id>5</id>
        </source_network_object>
        <target_network_object>
            <id>-1</id>
        </target_network_object>
    </server_mapping>
    <server_mapping>
        <source_network_object>
            <id>6</id>
        </source_network_object>
    </server_mapping>
</servers_mapping>


Response Messages:
200: Server mappings were modified.
400: Source network object cannot be empty.
400: Source network object is not valid
400: Target network object is not valid
400: Source and target network objects must be internal or external both.
400: Cannot use DEVICE application resources as external network objects.
400: Source network object with ID must be used by any connection.
400: Cannot remove mapping of network object with ID because it has never been mapped.
400: Cannot migrate application to itself.
400: Cannot map to ANY network object.
400: Cannot map Internet network object.
400: Cannot map to Internet network object.
400: Target network object ID must be in the same customer as the target application.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Server with ID was not found.","folder":"2-5","rawModeData":"\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n\t\n\t\t\n\t\t\t5\n\t\t\n\t\t\n\t\t\t-1\n\t\t\n\t\n\t\n\t\t\n\t\t\t6\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/servers_mapping","collectionId":"2","id":"2-5-30","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve server mappings for source and target applications","data":[{"value":null,"type":"text","enabled":true,"key":"sourceApplicationId"},{"value":null,"type":"text","enabled":true,"key":"targetApplicationId"}],"description":"Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application
search_servers_type: Search server type [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/servers_mapping

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/servers_mapping?search_servers_type=EXTERNAL

Response Messages:
400: Search migrated servers type parameter must be either internal, external or both.
400: Cannot get mappings between application to itself.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permission to access application with ID
403: You do not have permissions to edit this application.
404: There is no application with the specified ID.","dataMode":"params","folder":"2-5","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/servers_mapping","collectionId":"2","id":"2-5-31","method":"GET"},{"name":"Copy application servers and connections to another application.","data":[{"value":null,"type":"text","enabled":true,"key":"sourceApplicationId"},{"value":null,"type":"text","enabled":true,"key":"targetApplicationId"}],"dataMode":"params","description":"This API can be used to:
1. Create applications based on a blueprint (template).
2. Copy applications between environments (dev, test, prod).
3. Migrate applications between data-centers.

Before migrating make sure to map servers and connections to applications (if any exist).\nThis migration uses the configuration specified in the other API calls.

Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2

Response Messages:
200: Application was migrated.
400: Cannot migrate a decommissioned application.
400: Cannot migrate to a decommissioned application.
400: Cannot migrate an application to itself.
400: Cannot edit target DEVICE application.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
400: The source application has no connections to migrate.
409: You cannot migrate the application because not all servers are mapped.
409: You cannot migrate the application because not all connections to application are mapped.
409: You cannot migrate the application because one of the interfaces in the original application has been changed and has not been published.","folder":"2-5","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}","collectionId":"2","id":"2-5-32","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Update connection to application mappings for source and target applications","data":[{"value":null,"type":"text","enabled":true,"key":"sourceApplicationId"},{"value":null,"type":"text","enabled":true,"key":"targetApplicationId"}],"dataMode":"raw","description":"Use id=-1 for target_application_interface if new mapping is ���Not Needed���.
If the source is specified and the target is empty, the mapping that is currently configured will be deleted.

Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application
body: The interface instance mapping list [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/connections_to_applications_mapping
BODY<connections_to_applications_mapping>
    <connection_to_application_mapping>
        <source_connection_to_application>
            <id>1</id>
        </source_connection_to_application>
        <target_application_interface>
            <id>4</id>
        </target_application_interface>
    </connection_to_application_mapping>
    <connection_to_application_mapping>
        <source_connection_to_application>
            <id>2</id>
        </source_connection_to_application>
        <target_application_interface>
            <id>-1</id>
        </target_application_interface>
    </connection_to_application_mapping>
    <connection_to_application_mapping>
        <source_connection_to_application>
            <id>3</id>
        </source_connection_to_application>
    </connection_to_application_mapping>
</connections_to_applications_mapping>


Response Messages:
200: Connection to application mappings were modified.
400: Source interface instance cannot be empty.
400: Source interface instance object is not valid
400: Target application interface is not valid
400: Connection to application with ID: ID was not found.
400: Interface with ID: ID was not found.
400: Cannot remove mapping of instance with ID because it has never been mapped.
400: Cannot migrate application to itself.
400: Cannot map instance to interface with ID ID because the interface exists in target application.
400: Cannot map to duplicate application interfaces
400: Application interface didn't got published
400: Connection to application with id: ID must used by source application
400: You cannot map connection to application ID, because it is contained in a connection to application pack.
400: Application interface ID must be in the same customer as the target application.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","folder":"2-5","rawModeData":"\n\t\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n\t\n\t\t\n\t\t\t2\n\t\t\n\t\t\n\t\t\t-1\n\t\t\n\t\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/connections_to_applications_mapping","collectionId":"2","id":"2-5-33","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve connection to application mappings for source and target applications","data":[{"value":null,"type":"text","enabled":true,"key":"sourceApplicationId"},{"value":null,"type":"text","enabled":true,"key":"targetApplicationId"}],"description":"Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/connections_to_applications_mapping

Response Messages:
400: Cannot get mappings between application to itself.
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.","dataMode":"params","folder":"2-5","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/connections_to_applications_mapping","collectionId":"2","id":"2-5-34","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Update application interfaces and tag mapping","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"}],"dataMode":"raw","description":"Add application interfaces to application pack, and map a tag to the application interface. If a tag is not specified for the interface, the tag will be set to ���No Tag���.

Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
body: List of interface tag mapping to be added or modified

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/application_interfaces
BODY<application_interface_tags>
    <application_interface_tag>
        <application_interface>
            <id>1</id>
        </application_interface>
        <tag>
            <id>3</id>
        </tag>
    </application_interface_tag>
    <application_interface_tag>
        <application_interface>
            <id>2</id>
        </application_interface>
    </application_interface_tag>
</application_interface_tags>


Response Messages:
403: Access is denied
404: There are no application packs with the NAME in customer with ID.
403: You do not have permissions to edit this application pack.
403: You do not have permission to access application that contains the interface ID
400: You cannot edit APPLICATION PACK because it was decommissioned.
400: Application Interface can't be null.
400: Empty interface ID is not valid.","folder":"2-6","rawModeData":"\n\t\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t3\n\t\t\n\t\n\t\n\t\t\n\t\t\t2\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/application_interfaces","collectionId":"2","id":"2-6-35","method":"PUT"},{"name":"Remove application interfaces from application pack","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"},{"value":null,"type":"text","enabled":true,"key":"application_interface_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
application_interface_id: IDs of application interfaces to remove

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/application_interfaces?application_interface_id=1&application_interface_id=2

Response Messages:
200: Application Interface was deleted.
403: Access is denied
403: You do not have permissions to edit this application pack.
404: There are no application packs with the ID in customer with ID.
404: Application Package ID was not found.
404: Application interface ID was not found in application pack ID.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/application_interfaces","collectionId":"2","id":"2-6-36","method":"DELETE"},{"name":"Delete tags from application pack","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"},{"value":null,"type":"text","enabled":true,"key":"tag_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
tag_id: IDs of tags to remove

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/21/tags?tag_id=1&tag_id=2

Response Messages:
200: Tags were deleted.
403: Access is denied
403: You do not have permissions to edit this application pack.
404: There are no application packs with the ID in customer with ID.
404: Application Package ID was not found.
404: Tag ID was not found in application pack ID.
404: Tag ID is in use so can't be deleted.
404: Removed tag ID can't be empty.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","collectionId":"2","id":"2-6-37","method":"DELETE"},{"headers":"Accept: application/json\n","name":"List all application pack tags","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags

Response Messages:
403: Access is denied
404: There is no application pack with the ID.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","collectionId":"2","id":"2-6-38","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Modify tags of an application pack","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
body: Tags to modify

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags
BODY<tags>
    <tag>
        <id>1</id>
        <name>Tag 1</name>
    </tag>
    <tag>
        <id>2</id>    
        <name>Tag 2</name>
    </tag>
</tags>


Response Messages:
403: Access is denied
403: You do not have permissions to edit this application pack.
404: Customer with ID was not found.
404: There is no application pack with the ID in customer with ID.
400: Tag with NAME already exists in application pack ID.
400: Updated tag ID can't be empty
400: Updated Tag ID doesn't exist on application pack ID.","dataMode":"raw","folder":"2-6","rawModeData":"\n\t\n\t\t1\n\t\tTag 1\n\t\n\t\n\t\t2\t\n\t\tTag 2\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","collectionId":"2","id":"2-6-39","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Create new Tag under an application pack ","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack
body: List of tags

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags
BODY<tags>
    <tag>
        <name>Tag 1</name>
    </tag>
    <tag>
        <name>Tag 2</name>
    </tag>
</tags>


Response Messages:
403: Access is denied
404: There is no application pack with the ID in customer with ID.
400: You cannot edit APPLICATION PACK because it was decommissioned.
400: Tag name must contain at least 2 and no more than 160 characters.
400: Tag with NAME already exists in application pack ID.","dataMode":"raw","folder":"2-6","rawModeData":"\n\t\n\t\tTag 1\n\t\n\t\n\t\tTag 2\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","collectionId":"2","id":"2-6-40","method":"POST"},{"headers":"Accept: application/json\n","name":"Retrieve a list of all connection to application pack by application ID.","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"}],"description":"Parameters:
application_id: The unique identifier of application
name: The name of the connection to application pack [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs?name=Connection to application pack 1

Response Messages:
403: Access is denied
403: You do not have permission to access application with ID
404: There are no connection to application pack with the NAME in application with ID.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/","collectionId":"2","id":"2-6-41","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create new connection to application packs","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"}],"description":"Parameters:
application_id: The unique identifier of application
body: List of connection to application packs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs
BODY<connection_to_application_packs>
    <connection_to_application_pack>
        <name>Connection to application pack 1</name>
        <comment>New Connection to application pack</comment>
        <application_pack>
            <id>1</id>
        </application_pack>
        <tags_servers>
            <tag_servers>
                <tag>
                    <id>1</id>
                </tag>
                <servers>
                    <server>
                        <id>3</id>
                    </server>
                </servers>
            </tag_servers>
            <tag_servers>
                <tag>
                    <name>Tag 1</name>
                </tag>
                <servers>
                    <server>
                        <id>4</id>
                    </server>
                </servers>
            </tag_servers>
        </tags_servers>
    </connection_to_application_pack>
</connection_to_application_packs>


Response Messages:
400: There are no connection to application packs to add.
400: Application pack ID cannot be empty.
400: Application with ID was not found.
400: There is no application with the specified ID.
400: There is no application pack with the specified ID.
400: Application pack with ID was decommissioned.
400: Application pack with ID was not published.
400: Connection to application pack cannot be created in the domain of the application pack.
400: The application pack cannot be used more than once in the application.
400: Name cannot be empty.
400: Name must contain at least 2 and no more than 160 characters.
400: Name already exists.
400: Tag cannot be empty.
400: Tag ID or name is missing.
400: Tag ID does not exist.
400: Server ID does not exist.
400: Tag ID is not in use in connection to application pack ID, so it cannot be updated.
400: Servers cannot be null.
400: You cannot add ANY to connection to application pack.
400: You cannot add user to connection to application pack.
400: You cannot add Internet to connection to application pack.
403: Access is denied.
403: You do not have permission to access application that contains the server ID
403: You do not have permission to access application pack with ID
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Tag with NAME was not found.","dataMode":"raw","folder":"2-6","rawModeData":"\n\t\n\t\tConnection to application pack 1\n\t\tNew Connection to application pack\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t1\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t3\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\tTag 1\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t4\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/","collectionId":"2","id":"2-6-42","method":"POST"},{"headers":"Accept: application/json\n","name":"List all application packs","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
name: The name of the application pack [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs?name=Application pack 1

Response Messages:
403: Access is denied
404: There are no application packs with the NAME in customer with ID.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/","collectionId":"2","id":"2-6-43","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Update application packs","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"}],"dataMode":"raw","description":"Update the application packs properties. If is_published is set to true, the application pack is published for use by other users.

Parameters:
customer_id: The unique identifier of customer
body: List of application packs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs
BODY<application_packs>
    <application_pack>
        <id>1</id>
        <name>Updated name</name>
        <comment>Updated application pack</comment>
        <owner>
            <id>4</id>
        </owner>
        <editors>
            <editor>
                <id>3</id>
            </editor>
        </editors>
        <is_published>false</is_published>
    </application_pack>
</application_packs>


Response Messages:
400: There are no application packs to edit.
400: Application pack ID cannot be empty.
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to owner ID is invalid.
400: The owner NAME does not have permission to access applications.
400: There is an editor without an ID or name.
400: The application pack owner cannot also be an editor of the application pack.
400: There is a viewer without an ID or name.
400: The application pack owner cannot also be a viewer of the application pack.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application pack.
400: Application pack NAME already exists.
400: Application pack name must contain at least 2 and no more than 160 characters.
400: Customer NAME is not imported to SecureApp.
400: Customer NAME was decommissioned.
400: Application pack with ID is not ready for publish, or has no changes from the last publish.
403: Access is denied
403: You do not have permission to access application that contains the interface ID
403: You do not have permissions to edit this application pack.
403: You do not have permissions to change the owner of application pack ID.
403: You do not have permissions to change the editors and viewers of application pack ID.
404: There are no application packs with the NAME in customer with ID.","folder":"2-6","rawModeData":"\n\t\n\t\t1\n\t\tUpdated name\n\t\tUpdated application pack\n\t\t\n\t\t\t4\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\n\t\tfalse\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/","collectionId":"2","id":"2-6-44","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Create new application packs","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
body: List of application packs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs
BODY<application_packs>
    <application_pack>
        <name>Application pack 1</name>
        <comment>New application pack</comment>
        <owner>
            <id>4</id>
        </owner>
        <editors>
            <editor>
                <id>3</id>
            </editor>
        </editors>
        <viewers>
            <viewer>
                <id>5</id>
            </viewer>
        </viewers>
    </application_pack>
</application_packs>


Response Messages:
403: Access is denied
403: You do not have permission to access application that contains the interface ID
400: There are no application packs to add.
400: Application pack can be created only in meshed domain mode.
404: Customer with ID was not found.
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to owner ID is invalid.
400: There is an editor without an ID or name.
400: The application pack owner cannot also be an editor of the application pack.
400: There is a viewer without an ID or name.
400: The application pack owner cannot also be a viewer of the application pack.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application pack.
400: The owner NAME does not have permission to access applications.
400: Application pack was already saved.
400: Application pack NAME already exists.
400: Application pack name must contain at least 2 and no more than 160 characters.
400: Customer NAME is not imported to SecureApp.
400: Customer NAME was decommissioned.","dataMode":"raw","folder":"2-6","rawModeData":"\n\t\n\t\tApplication pack 1\n\t\tNew application pack\n\t\t\n\t\t\t4\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t5\n\t\t\t\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/","collectionId":"2","id":"2-6-45","method":"POST"},{"headers":"Accept: application/json\n","name":"Retrieve an existing application pack by ID","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to retrieve

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1

Response Messages:
403: Access is denied
403: You do not have permission to access application pack with ID
404: Application pack with ID was not found for customer with ID.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}","collectionId":"2","id":"2-6-46","method":"GET"},{"name":"Delete application pack","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1

Response Messages:
200: Application pack wes deleted.
403: You do not have permissions to delete this application pack.
400: There is no application pack with the specified ID.
400: Customer with ID doesn't own an application pack with ID.
400: Application Pack ID cannot be deleted. It is in use by applications IDs.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}","collectionId":"2","id":"2-6-47","method":"DELETE"},{"headers":"Content-Type: application/xml\n","name":"Update an application pack","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"}],"dataMode":"raw","description":"Update the application pack properties. If is_published is set to true, the application pack is published for use by other users.

Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
body: Application pack

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1
BODY<application_pack>
    <name>Updated name</name>
    <comment>Updated application pack</comment>
    <owner>
        <id>4</id>
    </owner>
    <editors>
        <editor>
            <id>3</id>
        </editor>
    </editors>
    <viewers>
        <viewer>
            <id>5</id>
        </viewer>
    </viewers>
    <is_published>true</is_published>
</application_pack>


Response Messages:
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to owner ID is invalid.
400: The owner NAME does not have permission to access applications.
400: There is an editor without an ID or name.
400: The application pack owner cannot also be an editor of the application pack.
400: There is a viewer without an ID or name.
400: The application pack owner cannot also be a viewer of the application pack.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application pack.
400: Application pack NAME already exists.
400: Application pack name must contain at least 2 and no more than 160 characters.
400: Customer NAME is not imported to SecureApp.
400: Customer NAME was decommissioned.
400: Application pack with ID is not ready for publish, or has no changes from the last publish.
403: Access is denied
403: You do not have permission to access application that contains the interface ID
403: You do not have permissions to edit this application pack.
403: You do not have permissions to change the owner of application pack ID.
403: You do not have permissions to change the editors and viewers of application pack ID.
404: There are no application packs with the NAME in customer with ID.","folder":"2-6","rawModeData":"\n\tUpdated name\n\tUpdated application pack\n\t\n\t\t4\n\t\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\n\t\n\t\t\n\t\t\t5\n\t\t\n\t\n\ttrue\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}","collectionId":"2","id":"2-6-48","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get tag by ID","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"},{"value":null,"type":"text","enabled":true,"key":"application_pack_id"},{"value":null,"type":"text","enabled":true,"key":"tag_id"}],"description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack
tag_id: The unique identifier of a tag

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags/1

Response Messages:
403: Access is denied
404: There is no tag with ID.
404: Customer with ID doesn't own a tag with ID.
404: Application Pack with ID doesn't own a tag with ID.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags/{{tag_id}}","collectionId":"2","id":"2-6-49","method":"GET"},{"name":"Delete a connection to application pack","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"},{"value":null,"type":"text","enabled":true,"key":"connection_to_application_pack_id"}],"description":"Parameters:
application_id: The unique identifier of application
connection_to_application_pack_id: The unique identifier of the connection to application pack to delete

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs/1

Response Messages:
400: Connection to application pack with ID was not found for application with ID.
400: The connection to application pack was already deleted.
403: Access is denied.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/{{connection_to_application_pack_id}}","collectionId":"2","id":"2-6-50","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Retrieve an existing connection to application pack by ID.","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"},{"value":null,"type":"text","enabled":true,"key":"connection_to_application_pack_id"}],"description":"Parameters:
application_id: The unique identifier of application
connection_to_application_pack_id: The unique identifier of the connection to application pack

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs/1

Response Messages:
403: Access is denied
403: You do not have permission to access application with ID
404: There is no connection to application pack with the specified ID.
400: Application with ID doesn't own a connection to application pack with ID.","dataMode":"params","folder":"2-6","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/{{connection_to_application_pack_id}}","collectionId":"2","id":"2-6-51","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Update an application pack","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"},{"value":null,"type":"text","enabled":true,"key":"connection_to_application_pack_id"}],"description":"Parameters:
application_id: The unique identifier of application
connection_to_application_pack_id: The unique identifier of the connection to application pack to update
body: Connection to application pack

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs/1
BODY<connection_to_application_pack>
    <name>Updated name</name>
    <comment>Updated Connection to application pack</comment>
    <tags_servers>
        <tag_servers>
            <tag>
                <id>1</id>
            </tag>
            <servers>
                <server>
                    <id>3</id>
                </server>
            </servers>
        </tag_servers>
        <tag_servers>
            <tag>
                <name>Tag 1</name>
            </tag>
            <servers>
            </servers>
        </tag_servers>
    </tags_servers>
</connection_to_application_pack>


Response Messages:
400: There is no application with the specified ID.
400: There is no connection to application pack with the specified ID.
400: Application with ID doesn't own a connection to application pack with ID.
400: Name cannot be empty.
400: Name must contain at least 2 and no more than 160 characters.
400: Name already exists.
400: Tag cannot be empty.
400: Tag ID or name is required.
400: Tag with Name was not found.
400: Server ID cannot be empty.
400: Servers cannot be null.
400: You cannot add ANY to connection to application pack.
400: You cannot add user to connection to application pack.
400: You cannot add Internet to connection to application pack.
403: Access is denied.
403: You do not have permission to access application that contains the server ID
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.","dataMode":"raw","folder":"2-6","rawModeData":"\n\tUpdated name\n\tUpdated Connection to application pack\n\t\n\t\t\n\t\t\t\n\t\t\t\t1\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t3\n\t\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\tTag 1\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/{{connection_to_application_pack_id}}","collectionId":"2","id":"2-6-52","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve existing access rules","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/87/access_requests

Response Messages:
400: The application was already deleted.
400: There are no changed connections that are ready for creating a ticket.
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
400: Application with ID ID was not found.","dataMode":"params","folder":"2-7","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/access_requests","collectionId":"2","id":"2-7-53","method":"GET"},{"headers":"Accept: application/json\n","name":"Fetches server by ID","data":[{"value":null,"type":"text","enabled":true,"key":"serverId"}],"description":"Parameters:
serverId: The ID of the server

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects/87

Response Messages:
400: Server with id ID was not found.
400: Application with ID ID was not found.
400: The application was already deleted.
403: Access is denied
403: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.","dataMode":"params","folder":"2-8","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/network_objects/{{serverId}}","collectionId":"2","id":"2-8-54","method":"GET"},{"headers":"Accept: application/json\n","name":"Fetches servers","description":"Parameters:
name: The name of the servers [optional]
typeOnDevice: The typeOnDevice of the servers [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects?name=server1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects?typeOnDevice=edl_ip_list

Response Messages:
400: Server with name NAME was not found.
400: Parameter typeOnDevice is not valid.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There are no servers with the name NAME
404: There are no servers with the typeOnDevice TYPEONDEVICE ","folder":"2-8","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/network_objects","collectionId":"2","id":"2-8-55","method":"GET"},{"name":"Move server","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"},{"value":null,"type":"text","enabled":true,"key":"server_id"},{"value":null,"type":"text","enabled":true,"key":"target_application_id"}],"description":"Parameters:
application_id: The unique identifier of the application
server_id: The unique identifier of the server
target_application_id: The unique identifier of the target application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/move_server?server_id=5&target_application_id=3

Response Messages:
400: Server ID is missing.
400: Target application ID is missing.
400: You cannot move a predefined object.
400: Server with ID is already associated to application with ID.
400: Cannot move server to a different customer.
400: The application was already deleted.
400: You cannot add to application APPLICATION_NAME because it was decommissioned.
400: Group/Server cannot be moved because there is no other application to move it to.
400: Group/Server cannot be moved because it or at least one of its group members is part of these groups: GROUPS_NAME.
400: Group/Server cannot be moved because it or at least one of its group members is locked for discovery.
400: Group/Server cannot be moved because it or at least one of its group members is used in these application interfaces: APPLICATION_INTERFACE_NAME.
400: Group/Server cannot be moved because it or at least one of its group members is used in these connections with another external resource: CONNECTION_NAME
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","dataMode":"params","folder":"2-9","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/move_server","collectionId":"2","id":"2-9-56","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Create servers","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: List of servers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects
BODY<network_objects xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
     <network_object xsi:type=\"hostNetworkObjectDTO\">
         <comment>host comment</comment>
         <name>host1</name>
         <ip>1.1.1.1</ip>
     </network_object>
     <network_object xsi:type=\"rangeNetworkObjectDTO\">
         <comment>range comment</comment>
         <name>range1</name>
         <first_ip>2.2.2.2</first_ip>
         <last_ip>2.2.2.22</last_ip>
     </network_object>
     <network_object xsi:type=\"subnetNetworkObjectDTO\">
         <comment>subnet comment</comment>
         <name>subnet1</name>
         <ip>3.3.3.3</ip>
         <netmask>255.255.255.0</netmask>
     </network_object>
     <network_object xsi:type=\"networkObjectVirtualServerDTO\">
         <comment>virtual server comment</comment>
         <uid>{e1a7722f-e92e-48f2-9087-9cb1711eb8b9}</uid>
         <device_id>12</device_id>
     </network_object>
     <network_object xsi:type=\"networkObjectGroupDTO\">
         <comment>group comment</comment>
         <name>group1</name>
         <access_allowed>true</access_allowed>
         <member>
             <id>3</id>
         </member>
        <type_on_device>edl_ip_list</type_on_device>     </network_object>
</network_objects>


Response Messages:
400: There are no items to add.
400: The application was already deleted.
400: You cannot add to application NAME because it was decommissioned.
400: Network object was already saved
400: Name cannot be empty
400: Server with NAME already exists.
400: IP is missing
400: Mask is missing
400: Invalid IP
400: Invalid mask
400: Max IP is missing
400: Min IP is missing
400: Invalid min IP
400: Invalid max IP
400: Min IP cannot be larger than max IP
400: Invalid network object type CLASS_NAME.
400: Invalid uid
400: Invalid device ID
400: Virtual server does not exist in SecureTrack
400: The virtual server already exists in SecureApp as resource NAME: VIRTUAL SERVER NAME VIRTUAL SERVER DEVICE NAME.
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Internet cannot be a member of a group.
400: Cannot save the server because the virtual server does not exist.
400: Cannot save the server because an error occurred
400: The type_on_device value is not valid
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID.
404: Virtual server was not found in SecureTrack.
503: Not connected to SecureTrack.","dataMode":"raw","folder":"2-9","rawModeData":"\n\t \n\t\t host comment\n\t\t host1\n\t\t 1.1.1.1\n\t \n\t \n\t\t range comment\n\t\t range1\n\t\t 2.2.2.2\n \t\t 2.2.2.22\n\t \n\t \n\t\t subnet comment\n\t\t subnet1\n\t\t 3.3.3.3\n\t\t 255.255.255.0\n\t \n\t \n\t\t virtual server comment\n\t\t {e1a7722f-e92e-48f2-9087-9cb1711eb8b9}\n\t\t 12\n\t \n\t \n\t\t group comment\n\t\t group1\n\t\t true\n\t\t \n\t\t\t 3\n\t\t \n\t\tedl_ip_list\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects","collectionId":"2","id":"2-9-57","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Update servers","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: List of servers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects
BODY<network_objects xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
     <network_object xsi:type=\"hostNetworkObjectDTO\">
         <id>1</id>
         <comment>host comment</comment>
         <name>host1</name>
         <ip>1.1.1.1</ip>
         <type>host</type>
     </network_object>
     <network_object xsi:type=\"rangeNetworkObjectDTO\">
         <id>2</id>
         <comment>range comment</comment>
         <name>range1</name>
         <first_ip>2.2.2.2</first_ip>
         <last_ip>2.2.2.22</last_ip>
         <type>range</type>
     </network_object>
     <network_object xsi:type=\"subnetNetworkObjectDTO\">
         <id>3</id>
         <comment>subnet comment</comment>
         <name>subnet1</name>
         <ip>3.3.3.3</ip>
         <netmask>255.255.255.0</netmask>
         <type>subnet</type>
     </network_object>
     <network_object xsi:type=\"networkObjectVirtualServerDTO\">
         <id>4</id>
         <comment>virtual server comment</comment>
         <uid>{e1a7722f-e92e-48f2-9087-9cb1711eb8b9}</uid>
         <device_id>12</device_id>
         <type>virtual-server</type>
     </network_object>
     <network_object xsi:type=\"vmInstanceDTO\">
         <id>5</id>
         <name>vm1</name>
         <comment>vm instance comment</comment>
         <type>vm_instance</type>
     </network_object>
     <network_object xsi:type=\"networkObjectGroupDTO\">
         <id>6</id>
         <comment>group comment</comment>
         <name>group1</name>
         <access_allowed>true</access_allowed>
         <type>group</type>
         <member>
             <id>3</id>
         </member>
        <type_on_device>edl_ip_list</type_on_device>     </network_object>
</network_objects>


Response Messages:
400: The application was already deleted.
400: You cannot update a predefined object.
400: Invalid type in server with id ID.
400: Invalid member with id ID
400: Invalid ID
400: Invalid uid
400: Invalid network object type NAME
400: Cannot update user
400: Network object is new
400: Name cannot be empty
400: Server is in discovery
400: Ip is missing
400: Mask is missing
400: Invalid ip
400: Invalid mask
400: Max ip is missing
400: Min ip is missing
400: Invalid min ip
400: Invalid max ip
400: Min ip cannot be larger than max ip
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Internet cannot be a member of a group.
400: Server with NAME already exists.
400: Invalid device ID
400: The type_on_device value is not valid
400: An EDL group can not be modified to a regular group
400: The virtual server already exists in SecureApp as resource NAME: VIRTUAL SERVER NAME VIRTUAL SERVER DEVICE NAME.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: DTO type used for server id ID is incompatible with this vendor.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Virtual server was not found in ST.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID.
503: Not connected to SecureTrack.","dataMode":"raw","folder":"2-9","rawModeData":"\n\t \n\t\t 1\n\t\t host comment\n\t\t host1\n\t\t 1.1.1.1\n\t\t host\n\t \n\t \n\t\t 2\n\t\t range comment\n\t\t range1\n\t\t 2.2.2.2\n\t\t 2.2.2.22\n\t\t range\n\t \n\t \n\t\t 3\n\t\t subnet comment\n\t\t subnet1\n\t\t 3.3.3.3\n\t\t 255.255.255.0\n\t\t subnet\n\t \n\t \n\t\t 4\n\t\t virtual server comment\n\t\t {e1a7722f-e92e-48f2-9087-9cb1711eb8b9}\n\t\t 12\n\t\t virtual-server\n\t \n\t \n\t\t 5\n\t\t vm1\n\t\t vm instance comment\n\t\t vm_instance\n\t \n\t \n\t\t 6\n\t\t group comment\n\t\t group1\n\t\t true\n\t\t group\n\t\t \n\t\t\t 3\n\t\t \n\t\tedl_ip_list\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects","collectionId":"2","id":"2-9-58","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve existing servers","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the server [optional]
typeOnDevice: The typeOnDevice of the servers [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects?name=ServerName

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects?typeOnDevice=edl_ip_list

Response Messages:
400: The application was already deleted.
400: Parameter typeOnDevice is not valid.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: There are no servers with the name NAME.
404: There are no servers with the typeOnDevice TYPEONDEVICE ","dataMode":"params","folder":"2-9","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects","collectionId":"2","id":"2-9-59","method":"GET"},{"collectionId":"2","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}/impact_analysis_csv","name":"Export Server Impact Analysis to a CSV file.","method":"GET","id":"2-9-60","description":"Parameters:
applicationId [optional]
serverId [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/6/impact_analysis_csv

Response Messages:
400: Server with ID was not found.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
404: There is no application with the specified ID.","folder":"2-9"},{"headers":"Accept: application/json\n","name":"If the identified server is a group, return a list of its members. When the media type is 'text/plain' (default), print each member on a separate line.","description":"Parameters:
applicationId [optional]
serverId [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/6/members

Response Messages:
400: Server with ID is not of type group
403: Access is denied
403: You do not have permissions to view this application
403: No available licenses. Ask your SecureApp administrator for assistance
404: There is no application with the specified ID
404: Server with ID was not found","folder":"2-9","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}/members","collectionId":"2","id":"2-9-61","method":"GET"},{"headers":"Accept: application/json\n","name":"Retrieve an existing server by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"serverId"}],"description":"Parameters:
applicationId: The unique identifier of the application
serverId: The unique identifier of the server

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/3

Response Messages:
400: The application was already deleted.
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID.","dataMode":"params","folder":"2-9","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}","collectionId":"2","id":"2-9-62","method":"GET"},{"name":"Delete server","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"serverId"}],"dataMode":"params","description":"To decommission a serer use force=true.

Parameters:
applicationId: The unique identifier of the application
serverId: The unique identifier of the server
force: Force delete [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/4

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/4?force=true

Response Messages:
400: The application was already deleted.
400: You cannot delete a predefined object.
400: Cannot delete an object that is being referenced by other objects
400: Cannot delete a predefined object.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID.","folder":"2-9","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}","collectionId":"2","id":"2-9-63","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Fetches service by ID","data":[{"value":null,"type":"text","enabled":true,"key":"serviceId"}],"description":"Parameters:
serviceId: The ID of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services/2

Response Messages:
404: Service with ID <ID> was not found.
403: Access is denied.","dataMode":"params","folder":"2-10","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services/{{serviceId}}","collectionId":"2","id":"2-10-64","method":"GET"},{"name":"Delete unused and non predefined global service","data":[{"value":null,"type":"text","enabled":true,"key":"serviceId"}],"description":"Parameters:
serviceId: The ID of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services/260

Response Messages:
200: Service was deleted.
404: Global Service with ID was not found.
400: Cannot delete an object that is being referenced by other objects.
400: You cannot delete a predefined object.
403: Access is denied.","dataMode":"params","folder":"2-10","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services/{{serviceId}}","collectionId":"2","id":"2-10-65","method":"DELETE"},{"headers":"Content-Type: application/xml\n","name":"Modify unused and non predefined global services","dataMode":"raw","description":"Parameters:
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>250</id>
        <name>icmp service updated</name>
        <comment>Updated comment</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>251</id>
        <name>ip service updated</name>
        <comment>Updated comment</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>252</id>
        <name>tcp service updated</name>
        <comment>Updated comment</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>253</id>
        <name>udp service updated</name>
        <comment>Updated comment</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <id>254</id>
        <name>Service Group 1 updated</name>
        <comment>Updated comment</comment>
        <type>group</type>
        <member>
            <id>3</id>
        </member>
        <member>
            <id>4</id>
        </member>
    </service>
</services>


Response Messages:
200: Services were modified.
400: Members IDs cannot be empty.
404: Service with ID <ID> was not found.
400: Service type must be either SingleServiceDTO or ServiceMemberDTO.
400: Service is new.
400: You cannot update a predefined object.
400: Name <NAME> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: Invalid protocol
400: Global Service cannot be associated with an application.
400: Cannot update a global service that is being referenced by other objects.
400: Cannot update an empty global group.
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Cannot have a local member in global group.
400: Group cannot contain itself as a member.
400: Application identity cannot be a member of a group.
403: Access is denied.","folder":"2-10","rawModeData":"\n\t\n\t\t250\n\t\ticmp service updated\n\t\tUpdated comment\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\t251\n\t\tip service updated\n\t\tUpdated comment\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\t252\n\t\ttcp service updated\n\t\tUpdated comment\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t253\n\t\tudp service updated\n\t\tUpdated comment\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t254\n\t\tService Group 1 updated\n\t\tUpdated comment\n\t\tgroup\n\t\t\n\t\t\t3\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services/","collectionId":"2","id":"2-10-66","method":"PUT"},{"headers":"Accept: application/json\n","name":"Fetches services","description":"Parameters:
globals_only: get only globals [optional]
name: The name of the service [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?name=AH

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?globals_only=true

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?globals_only=true&name=AH

Response Messages:
404: There are no services with the name NAME.
403: Access is denied.","folder":"2-10","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services","collectionId":"2","id":"2-10-67","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create global services","dataMode":"raw","description":"Parameters:
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>icmp service</name>
        <comment>New service</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>ip service</name>
        <comment>IPSEC Authentication Header Protocol</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>tcp service</name>
        <comment>Discard Server Protocol (TCP)</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>udp service</name>
        <comment>Discard Server Protocol (UDP)</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <name>Service Group 1</name>
        <comment>New Service group</comment>
        <type>group</type>
        <member>
            <id>1</id>
        </member>
        <member>
            <id>2</id>
        </member>
    </service>
</services>


Response Messages:
201: Service was created.
200: Services were created.
400: There are no items to add.
400: Members IDs cannot be empty.
404: Service with ID <ID> was not found.
400: Invalid service type <TYPE>
400: Name <NAME> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: Global Service cannot be associated with an application.
400: Cannot create an empty global group.
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Cannot have a local member in global group.
400: Application identity cannot be a member of a group.
403: Access is denied.","folder":"2-10","rawModeData":"\n\t\n\t\ticmp service\n\t\tNew service\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\tip service\n\t\tIPSEC Authentication Header Protocol\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\ttcp service\n\t\tDiscard Server Protocol (TCP)\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tudp service\n\t\tDiscard Server Protocol (UDP)\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tService Group 1\n\t\tNew Service group\n\t\tgroup\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t2\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services","collectionId":"2","id":"2-10-68","method":"POST"},{"name":"Delete unused and non predefined global service by name","data":[{"value":null,"type":"text","enabled":true,"key":"name"}],"description":"Parameters:
name: The name of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?name=Global service

Response Messages:
200: Service was deleted.
404: Service name has not been provided.
404: There are no services with the name NAME.
400: Cannot delete ANY.
400: Cannot delete an object that is being referenced by other objects.
400: Cannot delete a predefined object.
403: Access is denied.","dataMode":"params","folder":"2-10","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services","collectionId":"2","id":"2-10-69","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Retrieve existing services","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the service [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services?name=Local service

Response Messages:
400: The application was already deleted.
403: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: There are no services with the name NAME.","dataMode":"params","folder":"2-11","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services","collectionId":"2","id":"2-11-70","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Create services","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>icmp service</name>
        <comment>New service</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>ip service</name>
        <comment>IPSEC Authentication Header Protocol</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>tcp service</name>
        <comment>Discard Server Protocol (TCP)</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>udp service</name>
        <comment>Discard Server Protocol (UDP)</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <name>Service Group 1</name>
        <comment>New Service group</comment>
        <type>group</type>
        <member>
            <id>1</id>
        </member>
        <member>
            <id>2</id>
        </member>
    </service>
</services>


Response Messages:
201: Service was created.
200: Services were created.
400: There are no items to add.
400: Members IDs cannot be empty.
400: Invalid service type <TYPE>
400: Name <NAME> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: Cannot create an empty global group.
400: The group contains duplicate members.
400: ANY cannot be a member of a group.
400: Cannot have members from different applications.
400: Can not have application identity in group
403: Access is denied
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Service with ID <ID> was not found.
404: There is no application with the specified ID.","dataMode":"raw","folder":"2-11","rawModeData":"\n\t\n\t\ticmp service\n\t\tNew service\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\tip service\n\t\tIPSEC Authentication Header Protocol\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\ttcp service\n\t\tDiscard Server Protocol (TCP)\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tudp service\n\t\tDiscard Server Protocol (UDP)\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tService Group 1\n\t\tNew Service group\n\t\tgroup\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t2\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services","collectionId":"2","id":"2-11-71","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Update services","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>250</id>
        <name>icmp service updated</name>
        <comment>Updated comment</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>251</id>
        <name>ip service updated</name>
        <comment>Updated comment</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>252</id>
        <name>tcp service updated</name>
        <comment>Updated comment</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>253</id>
        <name>udp service updated</name>
        <comment>Updated comment</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <id>254</id>
        <name>Service Group 1 updated</name>
        <comment>Updated comment</comment>
        <type>group</type>
        <member>
            <id>3</id>
        </member>
        <member>
            <id>4</id>
        </member>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <id>255</id>
        <name>Service Group 2 updated</name>
        <comment>Updated comment</comment>
        <type>group</type>
    </service>
</services>


Response Messages:
200: Services were modified.
400: Members IDs cannot be empty.
400: Service type must be either SingleServiceDTO or ServiceMemberDTO.
400: Local service must be associated with an application.
400: Service is locked for discovery.
400: Service is new.
400: Name <NAME> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: The group contains duplicate members.
400: ANY cannot be a member of a group.
400: Application identity cannot be a member of a group.
403: Access is denied
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Service with ID <ID> was not found.","dataMode":"raw","folder":"2-11","rawModeData":"\n\t\n\t\t250\n\t\ticmp service updated\n\t\tUpdated comment\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\t251\n\t\tip service updated\n\t\tUpdated comment\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\t252\n\t\ttcp service updated\n\t\tUpdated comment\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t253\n\t\tudp service updated\n\t\tUpdated comment\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t254\n\t\tService Group 1 updated\n\t\tUpdated comment\n\t\tgroup\n\t\t\n\t\t\t3\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n\t\n\t\t255\n\t\tService Group 2 updated\n\t\tUpdated comment\n\t\tgroup\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services","collectionId":"2","id":"2-11-72","method":"PUT"},{"name":"Delete service","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"serviceId"}],"dataMode":"params","description":"Use force=true to delete a service with decommission.

Parameters:
applicationId: The unique identifier of the application
serviceId: The unique identifier of the service
force: Force delete [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services/250

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services/250?force=true

Response Messages:
400: The application was already deleted.
400: Cannot delete an object that is being referenced by other objects.
400: Cannot delete a predefined object.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Service with ID <SERVICE_ID> was not found in application with id <APPLICATION_ID>","folder":"2-11","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services/{{serviceId}}","collectionId":"2","id":"2-11-73","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Retrieve an existing service by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"},{"value":null,"type":"text","enabled":true,"key":"serviceId"}],"description":"Parameters:
applicationId: The unique identifier of the application
serviceId: The unique identifier of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services/250

Response Messages:
400: The application was already deleted.
403: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: Service with ID was not found.","dataMode":"params","folder":"2-11","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services/{{serviceId}}","collectionId":"2","id":"2-11-74","method":"GET"},{"name":"Delete unused user","data":[{"value":null,"type":"text","enabled":true,"key":"userId"}],"description":"Parameters:
userId: The ID of the user

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users/10

Response Messages:
200: User was deleted.
404: User with ID <ID> was not found.
400: Cannot delete an object that is being referenced by other objects.
403: Access is denied.","dataMode":"params","folder":"2-12","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users/{{userId}}","collectionId":"2","id":"2-12-75","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Fetches user by ID","data":[{"value":null,"type":"text","enabled":true,"key":"userId"}],"description":"Parameters:
userId: The ID of the user

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users/10

Response Messages:
404: User with ID <ID> was not found.
403: Access is denied.","dataMode":"params","folder":"2-12","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users/{{userId}}","collectionId":"2","id":"2-12-76","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create users","dataMode":"raw","description":"Parameters:
body: List of users

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/users
BODY<users>
    <user>
        <name>Local user 1</name>
        <comment>New local user</comment>
        <ip>8.8.8.8</ip>
    </user>
    <user>
        <name>Ldap user 1</name>
        <comment>New ldap user</comment>
    </user>
    <user xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"userObjectGroupDTO\">
        <name>User group 1</name>
        <comment>New user group</comment>
        <member>
            <id>14</id>
        </member>
        <member>
            <id>15</id>
        </member>
    </user>
</users>


Response Messages:
201: User was created.
200: Users were created.
400: There are no items to add.
400: Members IDs cannot be empty.
404: User with id <ID> was not found.
400: Invalid user type <TYPE>
400: Name cannot be empty.
400: User with name <NAME> already exists.
400: Invalid ip
403: Access is denied.","folder":"2-12","rawModeData":"\n\t\n\t\tLocal user 1\n\t\tNew local user\n\t\t8.8.8.8\n\t\n\t\n\t\tLdap user 1\n\t\tNew ldap user\n\t\n\t\n\t\tUser group 1\n\t\tNew user group\n\t\t\n\t\t\t14\n\t\t\n\t\t\n\t\t\t15\n\t\t\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users","collectionId":"2","id":"2-12-77","method":"POST"},{"headers":"Accept: application/json\n","name":"Fetches users","description":"Parameters:
name: The name of the user [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users?name=Local user 1

Response Messages:
404: There are no users with the name NAME.
403: Access is denied.","folder":"2-12","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users","collectionId":"2","id":"2-12-78","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Move applications to another customer","dataMode":"raw","description":"Parameters:
body: List of applications and customers [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/move_applications
BODY<move_applications>
     <move_application>
         <application>
            <id>1</id>
         </application>
         <customer>
             <id>2</id>
         </customer>
     </move_application>
     <move_application>
         <application>
            <id>2</id>
         </application>
         <customer>
            <name>Default</name>
         </customer>
     </move_application>
</move_applications>


Response Messages:
200: Applications were moved successfully.
400: Multi-Customer mode is not enabled.
400: You cannot move an application pack to a different customer.
400: Reference to application is invalid.
400: APPLICATION already exists in CUSTOMER.
400: You must specify the name or ID of the customer.
400: The customer has no ID or name.
400: Reference to CUSTOMER is invalid.
400: CUSTOMER is not imported to SecureApp.
400: CUSTOMER was decommissioned.
400: You must delete virtual servers from CUSTOMER before you move APPLICATION to another customer.
400: You must remove virtual servers from the INTERFACE and publish it before you move APPLICATION to another customer.
400: You cannot move APPLICATION to CUSTOMER because the connection to application pack and the application pack cannot be in the same customer.
400: You cannot move APPLICATION to a different customer because the application interface and the application pack must be in the same customer.
400: You must remove INTERFACE from APPLICATION PACK and publish it before you can move APPLICATION to another customer.
400: CONNECTION TO APPLICATION from APPLICATION must use interface from CUSTOMER.
400: Sources in CONNECTION from APPLICATION must all be from applications in the same customer.
400: Destinations in CONNECTION in APPLICATION must all be from applications in the same customer.
400: Servers in CONNECTION from APPLICATION must all be from CUSTOMER.
400: Servers in CONNECTION TO APPLICATION from APPLICATION must be from applications in the same customer.
400: Servers in CONNECTION TO APPLICATION from APPLICATION must be from CUSTOMER.
400: Application or application pack with NAME already exists in CUSTOMER.
400: There are no applications to move.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","folder":"2-13","rawModeData":"\n\t \n\t\t \n\t\t\t1\n\t\t \n\t\t \n\t\t\t 2\n\t\t \n\t \n\t \n\t\t \n\t\t\t2\n\t\t \n\t\t \n\t\t\tDefault\n\t\t \n\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/move_applications","collectionId":"2","id":"2-13-79","method":"PUT"},{"name":"Export Impact Analysis to a CSV file.","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"}],"dataMode":"params","description":"To prevent a CSV injection attack when exporting Impact Analysis to a CSV file, if a special character ( = - + @ ) appears at the beginning of any field, a single quote (') is added before the character.

Parameters:
application_id: The unique identifier of the application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/impact_analysis_csv

Response Messages:
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
404: There is no application with the specified ID.","folder":"2-13","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/impact_analysis_csv","collectionId":"2","id":"2-13-80","method":"GET"},{"headers":"Accept: application/json\n","name":"Retrieve security policy violations from SecureTrack","description":"Parameters:
applicationId [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/compliance_violations

Response Messages:
400: No valid connections found in APPLICATION.
400: Security policy compliance check is not available because a security policy has not been defined.
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
503: Cannot connect to SecureTrack.
503: Timeout occurred while waiting for response from SecureTrack.
500: An error occurred in SecureTrack when running the security compliance check.","folder":"2-13","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/compliance_violations","collectionId":"2","id":"2-13-81","method":"GET"},{"name":"Export application history to PDF","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"}],"description":"Parameters:
application_id: The unique identifier of the application
start_date: States starting date to fetch history since. Date format expected: yyyy-mm-dd [optional]
end_date: Get history until this date. Date format expected: yyyy-mm-dd [optional]
count: History max rows [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?start_date=2015-07-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?start_date=2015-07-18&end_date=2015-12-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?start_date=2015-07-18&count=2

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?count=2

Response Messages:
403: Access is denied.
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
400: The date format must be: yyyy-mm-dd
400: Start date must be before End date","dataMode":"params","folder":"2-13","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/history/export_pdf","collectionId":"2","id":"2-13-82","method":"GET"},{"headers":"Accept: application/json\n","name":"Retrieve application history","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application
start_date: States starting date to fetch history since. Date format expected: yyyy-mm-dd [optional]
end_date: Get history until this date. Date format expected: yyyy-mm-dd [optional]
count: History list length [optional]
start: Offset the count starting point [optional]
type: States the history type to fetch [optional]
user: The username of the user made the changes [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start_date=2015-07-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start_date=2015-07-18&end_date=2015-12-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start_date=2015-07-18&count=1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start=0&count=1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?type=SERVER

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?user=Jack

Response Messages:
400: The date format must be: yyyy-mm-dd
400: Start date must be before End date
400: Count parameter must be a number
400: Start parameter must be a number
400: Start parameter must be less than total
400: Type parameter must be either server, server_group, connection, application, application_interface, connection_interface or connection_to_application
400: User not found
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.","dataMode":"params","folder":"2-13","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/history","collectionId":"2","id":"2-13-83","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Change an application","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"dataMode":"raw","description":"This API can be used to delete or decommission an application.
To decommission an application, send true in decommissioned tag.

Parameters:
applicationId: The unique identifier of an application to change
body: Application

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/139
BODY<application>
     <id>139</id>
     <name>UpdatedAppName</name>
     <comment>UpdatedComment</comment>
     <decommissioned>false</decommissioned>
     <owner>
         <id>4</id>
     </owner>
     <editors>
         <editor>
             <id>3</id>
         </editor>
     </editors>
     <viewers>
         <viewer>
             <id>5</id>
         </viewer>
     </viewers>
</application>


Response Messages:
400: The application was already deleted.
400: Application owner is missing.
400: Owner cannot be empty.
400: Reference to owner ID is invalid.
400: There is an editor without an ID or name.
400: The application owner cannot also be an editor of the application.
400: There is a viewer without an ID or name.
400: The application owner cannot also be a viewer of the application.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application.
403: Access is denied
403: You do not have permissions to change the owner of application ID.
403: You do not have permissions to change the editors and a viewer of application ID.
403: You do not have permissions to decommission this application.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.","folder":"2-13","rawModeData":"\n\t 139\n\t UpdatedAppName\n\t UpdatedComment\n\t false\n\t \n\t\t 4\n\t \n\t \n\t\t \n\t\t\t 3\n\t\t \n\t \n\t \n\t\t \n\t\t\t 5\n\t\t \n\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}","collectionId":"2","id":"2-13-84","method":"PUT"},{"name":"Delete an application","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of the application to delete

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1

Response Messages:
400: The application was already deleted.
400: The resources of application NAME are used in connections for other applications.
400: You cannot delete application NAME because its application interfaces are used in other applications.
400: You cannot delete application NAME because its application interfaces are used in other application packs.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
400: Application with ID ID was not found.
400: You cannot delete application NAME because there are connection changes pending a ticket in other application.","dataMode":"params","folder":"2-13","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}","collectionId":"2","id":"2-13-85","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Retrieve an existing application by ID","data":[{"value":null,"type":"text","enabled":true,"key":"applicationId"}],"description":"Parameters:
applicationId: The unique identifier of an application to retrieve

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1

Response Messages:
400: The application was already deleted.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: Access is denied
403: You do not have permission to access application with ID
404: There is no application with the specified ID.","dataMode":"params","folder":"2-13","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}","collectionId":"2","id":"2-13-86","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Create new applications","dataMode":"raw","description":"Parameters:
body: List all applications

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications
BODY<applications>
     <application>
         <name>AppName</name>
         <comment>Comment</comment>
         <owner>
             <id>3</id>
         </owner>
         <editors>
             <editor>
                 <id>4</id>
             </editor>
         </editors>
         <viewers>
             <viewer>
                 <id>5</id>
             </viewer>
         </viewers>
         <customer>
             <id>24</id>
         </customer>
     </application>
</applications>


Response Messages:
400: There are no items to add.
400: Application was already saved.
400: Application name must contain at least 2 and no more than 160 characters.
400: Owner cannot be empty.
400: The specified owner does not exist.
400: The owner NAME does not have permission to access applications.
400: There is an editor without an ID or name.
400: The application owner cannot also be an editor of the application.
400: There is a viewer without an ID or name.
400: The application owner cannot also be a viewer of the application.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application.
400: Application with NAME already exists.
400: Application owner is missing.
400: Reference to owner ID is invalid.
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to customer ID is invalid.
400: You must specify the name or ID of the customer.
400: The customer has no ID or name.
400: The specified customer does not exist.
400: There is an editor without an ID or name.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no editor with the name NAME.","folder":"2-13","rawModeData":"\n\t \n\t\t AppName\n\t\t Comment\n\t\t \n\t\t\t 3\n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 4\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 5\n\t\t\t \n\t\t \n\t\t \n\t\t\t 24\n\t\t \n\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/","collectionId":"2","id":"2-13-87","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Update applications","dataMode":"raw","description":"This API can be used to delete or decommission an application.
To decommission an application, send true in decommissioned tag.

Parameters:
body: List of applications

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications
BODY<applications>
     <application>
         <id>140</id>
         <name>App1</name>
         <decommissioned>true</decommissioned>
         <owner>
             <id>4</id>
         </owner>
     </application>
     <application>
         <id>139</id>
         <name>UpdatedAppName</name>
         <comment>Updated Comment</comment>
         <owner>
             <id>4</id>
         </owner>
         <editors>
             <editor>
                 <id>3</id>
             </editor>
         </editors>
         <viewers>
             <viewer>
                 <id>5</id>
             </viewer>
         </viewers>
     </application>
</applications>


Response Messages:
400: Application ID is missing.
400: Application ID is invalid
400: The application was already deleted.
400: You must include the owner field.
400: There is an editor without an ID or name.
400: The application owner cannot also be an editor of the application.
400: There is a viewer without an ID or name.
400: The application owner cannot also be a viewer of the application.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application.
403: Access is denied
403: You do not have permissions to change the owner of application ID.
403: You do not have permissions to change the editors and a viewer of application ID.
403: You do not have permissions to decommission this application.
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.","folder":"2-13","rawModeData":"\n\t \n\t\t 140\n\t\t App1\n\t\t true\n\t\t \n\t\t\t 4\n\t\t \n\t \n\t \n\t\t 139\n\t\t UpdatedAppName\n\t\t Updated Comment\n\t\t \n\t\t\t 4\n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 3\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 5\n\t\t\t \n\t\t \n\t \n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/","collectionId":"2","id":"2-13-88","method":"PUT"},{"headers":"Accept: application/json\n","name":"List all applications","description":"Parameters:
userId: Applications by user ID, if not given the default is logged in user id [optional]
name: The name of the application [optional]
app_permissions: Filter applications by the given permissions (separated with commas):\napp_owner - returns applications where the user is the owner\napp_editor - returns applications where the user has been explicitly added as an editor\napp_viewer - returns applications where the user has been explicitly added as a viewer\napp_adminonly - returns applications where the user only has editor access because user has ���edit all applications��� permission, and does not include applications where this user is either the app_owner, app_editor, or app_viewer [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?name=App

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?userId=1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?app_permissions=app_owner,app_editor,app_viewer

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?name=App&app_permissions=app_adminonly

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications

Response Messages:
400: Invalid app_permissions value: 'appPermissions'.
403: Access is denied
403: You can't use the parameter 'userId' because you don't have 'View all applications' permission.
404: There are no applications matching your filter.
404: User with ID 'userId' was not found.","folder":"2-13","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/","collectionId":"2","id":"2-13-89","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Auto associate cloud servers from SecureTrack with an application","dataMode":"raw","description":"When auto-associate is enabled, user must enter key value

Parameters:
body: Auto association rule

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers/auto_association_rule
BODY<auto_association_rule>
    <key>Application</key>
    <enabled>true</enabled>
</auto_association_rule>


Response Messages:
200: Auto association rule is saved.
400: Enabled rule requires key value.
403: Access is denied
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to search for cloud servers.","folder":"2-14","rawModeData":"\n\tApplication\n\ttrue\n\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/cloud_console/servers/auto_association_rule","collectionId":"2","id":"2-14-90","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Associate cloud servers from SecureTrack with an application","data":[{"value":null,"type":"text","enabled":true,"key":"application_id"}],"description":"Parameters:
application_id: The ID of the application
body: List of device IDs and cloud server UIDs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers?application_id=87
BODY<devices_to_uids>
    <device_to_uids>
        <device_id>9</device_id>
        <uids>
            <uid>{b503916e-4468-4dc8-981b-2ec534587352}</uid>
            <uid>{0cc947a5-276f-4a4a-9d12-df5284fce609}</uid>
        </uids>
    </device_to_uids>
</devices_to_uids>


Response Messages:
201: Servers were imported to SecureApp.
403: Access is denied
400: There is no application with the specified ID.
401: No available licenses. Ask your SecureApp administrator for assistance.
400: You do not have permissions to edit this application.
400: You cannot associate servers with this application, because the application has been decommissioned.
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to add cloud servers.
403: UID does not exist in device ID.
403: Device with ID does not exist.
403: Device with ID does not exist in DOMAIN.
403: The AWS instance with UID and device ID has already been imported to application NAME. You cannot import the same instance multiple times.","dataMode":"raw","folder":"2-14","rawModeData":"\n\t\n\t\t9\n\t\t\n\t\t\t{b503916e-4468-4dc8-981b-2ec534587352}\n\t\t\t{0cc947a5-276f-4a4a-9d12-df5284fce609}\n\t\t\n\t\n\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/cloud_console/servers/","collectionId":"2","id":"2-14-91","method":"POST"},{"headers":"Accept: application/json\n","name":"Retrieve cloud server listing from SecureTrack","data":[{"value":null,"type":"text","enabled":true,"key":"vendor"},{"value":null,"type":"text","enabled":true,"key":"search_string"}],"description":"Parameters:
customer_id: Customer ID to be filtered by. [optional]
vendor: Vendor to be filtered by.
search_string: Search text.
start: Returning matching result starting from this element in the array (0-based). [optional]
count: Total number of matching servers to return. [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers?vendor=Amazon&search_string=WebServe

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers?vendor=Amazon&search_string=\"WebServer1\"

Response Messages:
403: Access is denied
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to search for cloud servers.
400: Illegal search string.
400: Start is bigger then possible result count.
400: Start and count cannot hold negative values.
400: Vendor query param is required.
400: Vendor should be one of the following: Amazon.
400: Search string query param is required.
400: Customer with ID does not exist in SecureApp
400: Customer with ID was decommissioned.","dataMode":"params","folder":"2-14","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/cloud_console/servers/","collectionId":"2","id":"2-14-92","method":"GET"},{"headers":"Accept: application/json\n","name":"List all customers","description":"Parameters:
name: The name of the customer [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers?name=Customer 1

Response Messages:
400: Not available in single-customer mode.
404: There are no customers with the name NAME.","folder":"2-15","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/","collectionId":"2","id":"2-15-93","method":"GET"},{"headers":"Accept: application/json\n","name":"List all imported customers","description":"

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/imported

Response Messages:
400: Not available in single-customer mode.
403: Access is denied","folder":"2-15","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/imported","collectionId":"2","id":"2-15-94","method":"GET"},{"headers":"Accept: application/json\n","name":"Retrieve existing applications for specific domain","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"}],"description":"Parameters:
customer_id: The ID of the customer

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/2/applications

Response Messages:
400: Not available in single-customer mode.
400: Customer with id ID was not found.
403: Access is denied","dataMode":"params","folder":"2-15","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/{{customer_id}}/applications","collectionId":"2","id":"2-15-95","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"import customers","dataMode":"raw","description":"Only users with 'Create new applications' and 'View all applications' permissions can run this API.

Parameters:
body: Customers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/customers/import
BODY<customers>
    <customer>
        <id>2</id>
    </customer>
    <customer>
        <id>3</id>
    </customer>
</customers>


Response Messages:
400: Not available in single-customer mode.
400: ID can not be empty.
400: There are some id's that doesn't exist.
403: Access is denied
503: Not connected to SecureTrack.","folder":"2-15","rawModeData":"\n\t\n\t\t2\n\t\n\t\n\t\t3\n\t\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/import","collectionId":"2","id":"2-15-96","method":"PUT"},{"headers":"Accept: application/json\n","name":"Fetches customer by ID","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"}],"description":"Parameters:
customer_id: The ID of the customer

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/1

Response Messages:
400: Not available in single-customer mode.
400: Customer with id ID was not found.","dataMode":"params","folder":"2-15","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/{{customer_id}}","collectionId":"2","id":"2-15-97","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Update a customer","data":[{"value":null,"type":"text","enabled":true,"key":"customer_id"}],"description":"Parameters:
customer_id: The ID of the customer
body: Customers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/customers/2
BODY<customer>
    <usage_mode>NOT_IMPORTED</usage_mode>
</customer>


Response Messages:
400: Not available in single-customer mode.
400: Customer with id ID was not found.
400: Can not update Default customer.
400: This customer is already not imported.
400: USAGE_MODE is not a valid state. The valid values are: USAGE_MODES
403: Access is denied
500: This customer is not imported.
400: You cannot delete this customer because there are connection changes pending a ticket in another customer.You must decommission this customer first, and then delete it.","dataMode":"raw","folder":"2-15","rawModeData":"\n\tNOT_IMPORTED\n","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/{{customer_id}}","collectionId":"2","id":"2-15-98","method":"PUT"},{"headers":"Accept: application/json\n","name":"List all non-imported customers","description":"Only users with 'Create new applications' and 'View all applications' permissions can run this API.



Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/not_imported

Response Messages:
400: Not available in single-customer mode.
403: Access is denied
503: Not connected to SecureTrack.","folder":"2-15","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/not_imported","collectionId":"2","id":"2-15-99","method":"GET"},{"headers":"Accept: application/json\n","name":"List all domains","description":"Parameters:
name: The name of the domain [optional]

Usage Example


Response Messages:
404: There are no domains with the name NAME.","folder":"2-16","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/domains/","collectionId":"2","id":"2-16-100","method":"GET"},{"collectionId":"2","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/domains/synchronize","name":"synchronize domains","method":"PUT","id":"2-16-101","description":"Retrieves all the domains lists in ST , for use by SC. If a domain was deleted in ST, then it will be removed from SC



Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/domains/synchronize

Response Messages:
500: Multi-Domain mode is disabled in SecureChange. Unable to synchronize with SecureTrack domains","folder":"2-16"},{"headers":"Accept: application/json\n","name":"Fetches domain by ID","data":[{"value":null,"type":"text","enabled":true,"key":"domainId"}],"description":"Parameters:
domainId: The ID of the domain

Usage Example


Response Messages:
400: Domain with id ID was not found.","dataMode":"params","folder":"2-16","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/domains/{{domainId}}","collectionId":"2","id":"2-16-102","method":"GET"},{"headers":"Accept: application/json\n","name":"Returns a detailed list of the external network resources available to SeucreChange from external provider (SecureCloud or alternate)","description":"Parameters:
name: Filter by name (substring, case insensitive) [optional]
uid: Filter by resource ref ID (exact match, case sensitive) [optional]
count: Limit number of results (default is 100) [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/externalprovider/resources?count=2
OUTPUT{
\"external_resources\":{
    \"external_resource\":[
     {
         \"resource_ref\":{
             \"id\":\"df67af5c-87b3-3e7a-bd50-371f76e9bdf5\",
             \"name\":\"ASG1\",
             \"type\":\"APPLICATION_SECURITY_GROUP\"
         },
         \"ips\":[
             \"2.0.0.0/15\",
             \"3.0.0.0/15\"
         ],
         \"account_ref\":{
             \"id\":\"5fcf0c94-6789-4fae-adb3-6e4226389069\",
             \"name\":\"app-group-prod-account\",
             \"cloud_vendor\":\"AZURE\"
         }
    },
    {
         \"resource_ref\":{
             \"id\":\"1cb7accb-f947-3e7f-b9b0-0b63973b2220\",
             \"name\":\"PM_ASG\",
             \"type\":\"APPLICATION_SECURITY_GROUP\"
         },
         \"ips\":[
             \"2.2.0.0/16\",
             \"3.5.0.0/16\"
         ],
         \"account_ref\":{
             \"id\":\"5fcf0c94-6789-4fae-adb3-6e4226389069\",
             \"name\":\"app-group-prod-account\",
             \"cloud_vendor\":\"AZURE\"
         }
    }
    ]
}}


Response Messages:
403: User has no permissions to view SecureCloud/Alternate provider resources
404: SecureCloud/Alternate provider disabled. Contact your administrator for assistance.
400: name and uid parameters cannot be used in same query.","folder":"2-17","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/externalprovider/resources","collectionId":"2","id":"2-17-103","method":"GET"},{"headers":"Accept: application/json\n","name":"Fetches virtual servers from SecureTrack","data":[{"value":null,"type":"text","enabled":true,"key":"ip"}],"dataMode":"params","description":"Find virtual servers matching a given IP address.
You can search for the virtual server itself of any of its members.

Parameters:
ip: ip
domainId: The unique identifier of a domain [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/external_resources/f5_virtual_servers?ip=2.2.2.2

Response Messages:
400: Invalid IP
400: Invalid Subnet
400: There is no domain with the specified ID.
403: Access is denied
503: Not connected to SecureTrack.","folder":"2-18","url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/external_resources/f5_virtual_servers","collectionId":"2","id":"2-18-104","method":"GET"},{"name":"Run Update Metadata for given task","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"params","description":"A link to the rule recertification field will returned in the location field of the header, for example: /securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/fields/72

Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/rule_recertification/update_metadata

Response Messages:
400: Update Metadata is not defined for the requested field.
400: Update Metadata is not available for the current ticket status.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a rule recertification request field.
403: You do not have permission to update this task. Contact your administrator for assistance.","folder":"2-19","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/rule_recertification/update_metadata","collectionId":"2","id":"2-19-105","method":"PUT"},{"headers":"Accept: application/json\n","name":"Returns IDs for specified list of excluded parent management devices and child firewalls in SecureChange","description":"For example on this Panorama hierarchy:
DG1 - Excluded
  DG1.1
    FW1
    FW2
    FW3

Calling this API with false value will return only DG1���s id.
Calling this API with true value will return DG1, FW1, FW2, FW3 id���s.


Parameters:
show_all: When set to true - Displays the specified devices and all their child firewalls in the hierarchy, which will be excluded implicitly.
When set to false - Displays only the devices which were explicitly excluded.
Default value is false.
[optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded
OUTPUT<device_ids>
    <id>10</id>
    <id>11</id>
</device_ids>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded?show_all=false
OUTPUT<device_ids>
    <id>10</id>
    <id>11</id>
</device_ids>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded?show_all=true
OUTPUT<device_ids>
    <id>33</id>
    <id>10</id>
    <id>11</id>
    <id>35</id>
    <id>29</id>
    <id>31</id>
</device_ids>

","folder":"2-20","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/excluded","collectionId":"2","id":"2-20-106","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Update the whole list of excluded devices in SecureChange","dataMode":"raw","description":"Parameters:
body [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded
BODY<device_ids>
    <id>1</id>
    <id>12</id>
</device_ids>

","folder":"2-20","rawModeData":"\n\t1\n\t12\n\n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/excluded","collectionId":"2","id":"2-20-107","method":"PUT"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Get suggested targets for a given access request","data":[{"value":null,"type":"text","enabled":true,"key":"domain_name"},{"value":null,"type":"text","enabled":true,"key":"workflow_name"}],"dataMode":"raw","description":"Returns a list of suggested targets for a given access request, based on topology calculations.

Parameters:
body [optional]
domain_name: Domain Name
workflow_name: Workflow Name

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/suggest_target?domain_name=Default&workflow_name=AR
BODY{
    \"access_request\":{
        \"users\":{
            \"user\":[
                \"Any\"
            ]
        },
        \"sources\":{
            \"source\":[
                {
                    \"@type\":\"IP\",
                    \"ip_address\":\"10.100.1.1\",
                    \"netmask\":\"255.255.255.255\",
                    \"cidr\":32
                }
            ]
        },
        \"destinations\":{
            \"destination\":[
                {
                    \"@type\":\"IP\",
                    \"ip_address\":\"10.100.20.2\",
                    \"netmask\":\"255.255.255.255\",
                    \"cidr\":32
                }
            ]
        },
        \"services\":{
            \"service\":[
                {
                    \"@type\":\"ANY\",
                }
            ]
        },
        \"action\":\"Accept\",
    }
}
OUTPUT{
    \"multi_target\": {
        \"target\": {
            \"@type\": \"Object\",
            \"object_name\": \"Device-1\",
            \"object_type\": \"firewall\",
            \"object_details\": \"10.100.40.1\",
            \"management_id\": 250,
            \"management_name\": \"Panorama/Domain1\"
        }
    }
}


Response Messages:
200: Targets returned successfully
400: User does not have permissions to domain or domain does not exist
403: Access is denied","folder":"2-20","rawModeData":"{\n\t\"access_request\":{\n\t\t\"users\":{\n\t\t\t\"user\":[\n\t\t\t\t\"Any\"\n\t\t\t]\n\t\t},\n\t\t\"sources\":{\n\t\t\t\"source\":[\n\t\t\t\t{\n\t\t\t\t\t\"@type\":\"IP\",\n\t\t\t\t\t\"ip_address\":\"10.100.1.1\",\n\t\t\t\t\t\"netmask\":\"255.255.255.255\",\n\t\t\t\t\t\"cidr\":32\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"destinations\":{\n\t\t\t\"destination\":[\n\t\t\t\t{\n\t\t\t\t\t\"@type\":\"IP\",\n\t\t\t\t\t\"ip_address\":\"10.100.20.2\",\n\t\t\t\t\t\"netmask\":\"255.255.255.255\",\n\t\t\t\t\t\"cidr\":32\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"services\":{\n\t\t\t\"service\":[\n\t\t\t\t{\n\t\t\t\t\t\"@type\":\"ANY\",\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"action\":\"Accept\",\n\t}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/suggest_target","collectionId":"2","id":"2-20-108","method":"POST"},{"headers":"Accept: application/json\n","name":"Get details of target devices","description":"Parameters:
name: device name or part of a name [optional]
show_targets: show_targets true: Returns the details of devices that can be selected as a target
show_targets false: Returns the details of devices with objects that can be used in tickets [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/devices?name=asa&show_targets=true

Response Messages:
404: Devices not found","folder":"2-20","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/","collectionId":"2","id":"2-20-109","method":"GET"},{"name":"Run Impact Analysis for given task","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/multi_server_decommission_request/impact_analysis

Response Messages:
400: Impact analysis is not defined for the requested field.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a decommission request field.
403: You do not have permission to update this task. Contact your administrator for assistance.","dataMode":"params","folder":"2-21","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/multi_server_decommission_request/impact_analysis","collectionId":"2","id":"2-21-110","method":"PUT"},{"name":"Run server decommission designer for given task","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/multi_server_decommission_request/designer

Response Messages:
400: Server decommission designer is not defined for the requested field.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a decommission request field.
403: You do not have permission to update this task. Contact your administrator for assistance.","dataMode":"params","folder":"2-21","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/multi_server_decommission_request/designer","collectionId":"2","id":"2-21-111","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get server decommission designer results","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"dataMode":"params","description":"Use this API to retrieve designer results generated in R17-1 and earlier.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Server Decommission Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/multi_server_decommission_request/261/designer

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.","folder":"2-21","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_server_decommission_request/{{fieldId}}/designer","collectionId":"2","id":"2-21-112","method":"GET"},{"headers":"Accept: application/json\n","name":"Get verifier results","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Server Decommission Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/multi_server_decommission_request/261/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.","dataMode":"params","folder":"2-21","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_server_decommission_request/{{fieldId}}/verifier","collectionId":"2","id":"2-21-113","method":"GET"},{"headers":"Accept: application/json\n","name":"Get impact analysis results","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Server Decommission Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/multi_server_decommission_request/261/impact_analysis

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.","dataMode":"params","folder":"2-21","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_server_decommission_request/{{fieldId}}/impact_analysis","collectionId":"2","id":"2-21-114","method":"GET"},{"name":"Run Verifier for given task","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/multi_server_decommission_request/verifier

Response Messages:
400: Verifier is not defined for the requested field.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a decommission request field.
403: You do not have permission to update this task. Contact your administrator for assistance.","dataMode":"params","folder":"2-21","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/multi_server_decommission_request/verifier","collectionId":"2","id":"2-21-115","method":"PUT"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Modify the SecureTrack connection settings and test the connection status","dataMode":"raw","description":"Parameters:
testOnly: Test the connection status using the specified settings. The new settings are not saved. The default value is false [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/integration_with_secureTrack
BODY    <secureTrack_settings>
        <host xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"remoteHost\">
            <IP_or_hostname>192.168.11.1</IP_or_hostname>
            <user_name>admin</user_name>
        </host>
        <show_link_to_secureTrack>false</show_link_to_secureTrack>
        <check_connection_interval>30</check_connection_interval>
        <internal_IP_of_secureChange_server>192.168.2.2</internal_IP_of_secureChange_server>
    </secureTrack_settings>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/integration_with_secureTrack
BODY    <secureTrack_settings>
        <host xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"localHost\">
            <user_name>admin</user_name>
        </host>
        <show_link_to_secureTrack>false</show_link_to_secureTrack>
        <check_connection_interval>30</check_connection_interval>
    </secureTrack_settings>


Response Messages:
400: Invalid host name or IP address.
400: show_link_to_secureTrack is invalid. It must be 'true', 'false' or empty.","folder":"2-22","rawModeData":"\t\n\t\t \n\t\t\tadmin\n\t\t\n\t\tfalse\n\t\t30\n\t","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/integration_with_secureTrack/","collectionId":"2","id":"2-22-116","method":"PUT"},{"headers":"Accept: application/json\n","name":"Retrieve the SecureTrack connection settings and status","description":"

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/integration_with_secureTrack?testOnly=false
","folder":"2-22","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/integration_with_secureTrack/","collectionId":"2","id":"2-22-117","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Import LDAP users to SecureChange by simulating login process","dataMode":"raw","description":"This API implicitly imports LDAP users to SecureChange by simulating their login.
To explicitly import LDAP entities- both users and groups, it is recommended to use /users/import API

Parameters:
body: partyDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/users
BODY<user xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"user\">
    <name>x</name>
    <origin_type>LDAP</origin_type>
        <ldap_configuration>
            <id>1</id>
        </ldap_configuration>
</user>


Response Messages:
403: Access is denied.
400: Name is missing.
400: Origin is missing.
400: User {login_name} already exists, with ID (id} and name {name}.
400: User {login_name} not found in LDAP.
400: Creating a user via REST API is available only if origin is LDAP.
400: Creating a user via REST API is available only if type is User.
400: Ldap configuration with ID {id} not found.","folder":"2-23","rawModeData":"\n\tx\n\tLDAP\n\t\t\n\t\t\t1\n\t\t\n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/","collectionId":"2","id":"2-23-118","method":"POST"},{"collectionId":"2","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/","name":"Return the list of users","method":"GET","id":"2-23-119","description":"user_name: case insensitive, search mode: contains text
exact_name: when set to true, user_name search mode is case sensitive and exact text
email: case insentitive, search mode: exact match
Logical OR between user_name and email.

Parameters:
showIndirectRelation: Members that belong to the selected group only indirectly [optional]
user_name: The user's login name [optional]
email: The user's email [optional]
exact_name: Search user_name as exact match [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/users?email=bob@tufin.com&user_name=bob&exact_name=true
","folder":"2-23"},{"headers":"Content-Type: application/json\n","name":"Import user / group from LDAP","dataMode":"raw","description":"The imported user / group will be visible in SecureChange GUI under users section.
In multi domain mode, imported entity will be assigned with the domains of \"any user\" group.
Only users with 'view settings tab' permission can run this API.

Parameters:
body: ldapPartyDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/users/import
BODY{
    \"ldap_party\": {
        \"ldap_configuration_name\": \"ldap_name\",
        \"ldap_dn\": \"CN=alice,OU=Advertising,OU=Marketing,DC=testEnv,DC=com\"
    }
}


Response Messages:
400: The LDAP configuration name does not exist
400: The given ldap_dn does not exist
400: The given ldap_dn is already imported
400: Failed to create the selected user
400: Failed to create the selected group
400: Selected user already exists in SecureChange but is not synchronized with the LDAP server. Go to Settings > LDAP and synchronize with the LDAP
400: This group has a large number of users, and will not be expanded in the users console. To be able to configure roles and step participation for individual users from the group, add them explicitly.
400: Failed to update the selected group
400: Unsupported LDAP object class
400: Unable to establish a connection to server <SERVER_IP>:<SERVER_PORT> within the configured timeout of <TIMEOUT> milliseconds.
403: Access is denied","folder":"2-23","rawModeData":"{\n\t\"ldap_party\": {\n\t\t\"ldap_configuration_name\": \"ldap_name\",\n\t\t\"ldap_dn\": \"CN=alice,OU=Advertising,OU=Marketing,DC=testEnv,DC=com\"\n\t}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/import","collectionId":"2","id":"2-23-120","method":"POST"},{"headers":"Content-Type: application/json\n","name":"Change local group members","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"raw","description":"Only users with 'view settings tab' permission can run this API.
Only local or imported LDAP users can be added to local groups.

Parameters:
id: Group ID
body: groupChangeDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/users/group/1
BODY{
    \"group_change\":{
        \"member_ids_to_add\": [1,2],
        \"member_ids_to_remove\":[3,4]
    }
}    


Response Messages:
400: Exceeded limit of {MAXIMUM} group member changes
400: These user IDs do not exist: {IDs}
400: These user IDs do not exist or are not group members: {IDs}
400: Group ID {ID} is not a local group
400: Group ID {ID} does not exist
400: Cannot add a group to itself
400: Cannot add a group to a group that it already contains. Group {ID1} contains group {ID2}","folder":"2-23","rawModeData":"{\n\t\"group_change\":{\n\t\t\"member_ids_to_add\": [1,2],\n\t\t\"member_ids_to_remove\":[3,4]\n\t}\n}\t","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/group/{{id}}","collectionId":"2","id":"2-23-121","method":"PUT"},{"name":"Delete the specified User or Group","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
id: User ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/users/5

Response Messages:
400: User with id {id} does not exist","dataMode":"params","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/{{id}}","collectionId":"2","id":"2-23-122","method":"DELETE"},{"name":"Return the specified user","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
id: User ID
showIndirectRelation: Members that belong to the selected group only indirectly [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/users/5

Response Messages:
400: User or group was not found.","dataMode":"params","folder":"2-23","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/{{id}}","collectionId":"2","id":"2-23-123","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Create local group","dataMode":"raw","description":"Only users with 'view settings tab' permission can run this API.

Parameters:
body: CreateGroupDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/users/group
BODY{
    \"group\": {
        \"name\": \"name1\",
        \"description\": \"description1\",
        \"email\": \"email1@tufin.com\"
    }
}    


Response Messages:
400: Input Validation Error : {field name}: {input validation error message}
400: Name already exists","folder":"2-23","rawModeData":"{\n\t\"group\": {\n\t\t\"name\": \"name1\",\n\t\t\"description\": \"description1\",\n\t\t\"email\": \"email1@tufin.com\"\n\t}\n}\t","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/group","collectionId":"2","id":"2-23-124","method":"POST"},{"headers":"Accept: application/json\n","name":"Cancel a ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
id: The ID of the ticket as shown in SecureChange
requester_id: The user of the ticket's requester, when logged in user is canceling on behalf [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/cancel?requester_id=5

Response Messages:
403: Access is denied.
404: Ticket is already closed
404: Ticket ID was not found","dataMode":"params","folder":"2-24","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/cancel","collectionId":"2","id":"2-24-125","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Returns the specified ticket to the specified step","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"toStepId"}],"dataMode":"raw","description":"Values can only be updated for the current step.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
toStepId: To which step we the ticket will return
body: RedoCommentDto

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/redo/1
BODY<redo_step_comment>
    <comment>please fix source </comment>
</redo_step_comment>


Response Messages:
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Task <NAME> is no longer active
403: User has no permissions to redo ticket steps.
404: There is no ticket with ID.
404: No entity found for query","folder":"2-24","rawModeData":"\n\tplease fix source \n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/redo/{{toStepId}}","collectionId":"2","id":"2-24-126","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Change the requester of the specified ticket task to the specified user.","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"assigneeId"}],"description":"Parameters:
id: Ticket ID
assigneeId: The assignee ID
body: CommentDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/change_requester/4
BODY<comment>
    <comment>user was deleted moving tickets to Bob</comment>
</comment>


Response Messages:
400: The change requester comment must be set in order to change the requester the ticket.
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
404: There is no ticket with ID.
404: There is no requester (User) with ID.","dataMode":"raw","folder":"2-24","rawModeData":"\n\tuser was deleted moving tickets to Bob\n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/change_requester/{{assigneeId}}","collectionId":"2","id":"2-24-127","method":"PUT"},{"headers":"Accept: application/json\n","name":"Returns the history of the specified ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
id: Ticket ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/history

Response Messages:
403: User has no permissions to view ticket history
404: You do not have permission to view this task. Contact your administrator for assistance.
404: There is no ticket with ID.","dataMode":"params","folder":"2-24","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/history","collectionId":"2","id":"2-24-128","method":"GET"},{"name":"Map rules to ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Maps the rules from the ticket to the relevant rules in SecureTrack.
Adds record set entries to the relevant rules metadata.
Link to history is found in the returned location header.
Applicable only for closed tickets in the following workflows: Access Request, Access Request and Modify Group, and Clone Server Policy.
Use handler_id for running on behalf of another user.
To get handler_id, use the System Users API.

Parameters:
id: The ID of the ticket as shown in SecureChange
handler_id: Run API on behalf of defined user id [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/map_rules

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/map_rules?handler_id=5

Response Messages:
201: Started asynchronous mapping of rules to ticket ID <ID>. Mapping status is displayed in ticket history.
400: Ticket's workflow type does not support this operation
403: Access is denied.
403: You do not have permission to access ticket <ID>
403: On behalf user do not have permission to access ticket <ID>
404: There is no ticket with ID <ID>.
404: There is no handler (User) with ID <ID>.
412: Ticket is not in closed status","folder":"2-24","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/map_rules","collectionId":"2","id":"2-24-129","method":"POST"},{"headers":"Content-Type: application/xml\n","name":"Confirm the request","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
id: Ticket ID
requester_id: The user of the ticket's requester, when logged in user is confirm on behalf [optional]
body: Confirm comment

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/confirm?requester_id=5
BODY<confirm_comment>
    <comment>confirmed</comment>
</confirm_comment>


Response Messages:
400: User is trying to confirm a ticket that belongs to another user
400: User is not permitted to confirm this ticket on behalf another user
400: The user can not confirm the ticket, because he is not in the domain of the ticket
403: Access is denied.
404: There is no ticket with ID .","dataMode":"raw","folder":"2-24","rawModeData":"\n\tconfirmed\n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/confirm","collectionId":"2","id":"2-24-130","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Reassigns the specified ticket task to the specified user.","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"assigneeId"}],"dataMode":"raw","description":"Values can only be updated for the current step.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
assigneeId: The assignee ID
body: ReassignTaskCommentDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/reassign/4
BODY<reassign_task_comment>
    <comment>Please complete the AR</comment>
</reassign_task_comment>


Response Messages:
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Task <NAME> is no longer active
404: There is no ticket with ID.
404: No entity found for query","folder":"2-24","rawModeData":"\n\tPlease complete the AR\n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/reassign/{{assigneeId}}","collectionId":"2","id":"2-24-131","method":"PUT"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Reject a ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
id: The ID of the ticket as shown in SecureChange
handler_id: The user id, when logged in user is rejecting on behalf [optional]
body: Reject comment

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/reject?handler_id=5
BODY<reject_comment>
    <comment>rejected</comment>
</reject_comment>


Response Messages:
400: Ticket status <STATUS> is incorrect to perform this action
400: User <NAME> has no permissions to perform this action
400: Comment cannot be empty
403: User is not permitted to reject this ticket on behalf another user
403: You do not have permission to access ticket <ID>
403: On behalf user do not have permission to access ticket <ID>
403: Access is denied.
404: There is no ticket with ID <ID>.
404: There is no handler (User) with ID <ID>.","dataMode":"raw","folder":"2-24","rawModeData":"\n\trejected\n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/reject","collectionId":"2","id":"2-24-132","method":"PUT"},{"name":"Returns topology map image (png file) for specific verifier results","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/multi_access_request/2022/verifier/topology_map

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.
404: Verifier results were not found in the access request.
404: Toplogy map was not found for this field.","dataMode":"params","folder":"2-25","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_access_request/{{fieldId}}/verifier/topology_map","collectionId":"2","id":"2-25-133","method":"GET"},{"headers":"Accept: application/json\n","name":"Get security zones according to field id","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"dataMode":"params","description":"Use this API to retrieve security zones for multi access result field

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/security_zones

Response Messages:
404: There is no ticket with ID <ID>.
401: Cannot update ticket because it is either closed, rejected or waiting for requester confirmation
400: Task ID <ID> cannot be found in the current step with ID <ID>.
400: You can only update the current step of the ticket. Step ID <ID> does not match the current step ID <ID>.
400: The task with ID <ID> does not contain a field with ID <ID>.
400: The task with ID <ID> does not contain a field of type <ID>.
400: Security zones tool is not enabled for the requested field.
403: You do not have permission to view this task. Contact your administrator for assistance.","folder":"2-25","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/security_zones","collectionId":"2","id":"2-25-134","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Modify the Designer suggestions for Access Request or Clone Server Policy","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"instructionId"}],"dataMode":"raw","description":" GENERAL USE
1. Create a ticket using UI/API.
2. Run the designer using UI/API.
3. Use relevent API to get the designer results.
4. Run this API to modify the required parameters.

*Note: you can modify one parameter at a time.

Change rule location use
a. Modifying the rule order places the new rule before the rule with the specified identifier (rule name or number).
b. Modifying the rule placement to \"last\" places the new rule as last rule or last pre-rule (depending on the vendor convention for the device).
c. For vendors that support \"after\" placement, modifying the rule placement allows positioning the new rule before or after the suggested rule location.
d. For Check Point R80 and above releases, the indented rule numbering format can be applied to globally assigned policies (for example, ���rule_order���: ���4.5���).

track level permitted values:
NONE, LOG, ACCOUNT, ALERT, SNMP, MAIL, USER_DEFINED, EMERGENCIES, ALERTS, CRITICAL, ERRORS, WARNINGS, NOTIFICATIONS, INFORMATIONAL, DEBUGGING, DISABLED, DEFAULT, FULL_LOG, NETWORK_LOG, USER_ALERT_1, USER_ALERT_2, USER_ALERT_3

rule placement permitted values:
BEFORE, AFTER, LAST

Parameters:
body: DesignerInstructionChangeDTO
id: Ticket ID
taskId: Task ID
instructionId: Instruction ID
force: force update when new revision available [optional]

Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"comment\": {\"new_value\":\"new comment\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196?force=true
BODY{
    \"comment\": {\"new_value\":\"new comment\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_name\": {\"new_value\":\"new rule name\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"track_level\": {\"new_value\":\"LOG\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"object_name\": {\"new_value\":\"new object name\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"log_forwarding_profile\": {\"new_value\":\"new log forwarding profile\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"security_profile_group\": {\"new_value\":\"new security profile group\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"object_replace\": {
             \"new_value\":\"new object uid\",
             \"old_value\":\"old object uid\"
    }
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_order\": {\"new_value\":\"8\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"tags\": {\"values\":[\"tag1\", \"tag2\"]}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"tags\": {\"values\":[]}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_placement\": {\"new_value\":\"last\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_placement\": {\"new_value\":\"before\"}
}


Response Messages:
200: New rule will be shadowed
200: New rule will be shadowed or break acceleration
400: Modify Designer Results API is only supported for Access Request and Clone Server Policy workflows
412: Current instruction cannot be modified because either the implementation was successful or failed irrevocably.
412: Current step does not support Designer modification action
404: A ticket with ID <ID> cannot be found.
400: Task ID <ID> cannot be found in the current step with ID <ID>.
403: Changing <TYPE> is not supported on this device
403: This Change is not supported for <INSTRUCTION TYPE> instruction type\"
403: You do not have permission to update this task. Contact your administrator for assistance.
403: New revision is available, cannot modify the Designer results
404: Specified instruction, id: <ID> was not found
404: Designer results were not found in the access request.
400: a valid object name must start with an alphanumeric character and can contain alphanumeric characters, underscore '_'. Hypen '-', dot '.' or spaces
400: For this device, the comment must be less than 100 characters per line.
400: For this device, this field must be less than <NUMBER OF CHARACTERS> characters
400: For this device, this field is required.
400: For this device, a valid object name cannot be <OBJECT NAME> because it is a reserved word
409: Rule name already exists for this device. Please give this rule a unique name.
409: Rule name <NAME> already exists in the device group hierarchy. Choose a unique name for this rule.
400: Comment contains invalid characters.
400: <DEVICE> does not support tracking level <TRACKING LEVEL>
400: <TRACKING LEVEL> is not a valid rule track level value
400: a valid object name cannot contain any of the following characters: <CHARACTERS>
400: a valid object name must be less than <NUMBER OF CHARACTERS> characters
400: a valid object name cannot be empty
400: a valid object name must conform to the following pattern: <STRING PATTERN>
409: Object already exists
400: A security profile group cannot be empty.
404: The security profile group <SECURITY PROFILE GROUP> was not found.
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to validate the security profile group.
400: A log forwarding profile cannot be empty.
400: Tag list is longer than 20 items.
400: Tag list contains the same tag more than once.
400: These tags don't exist or aren't relevant to the rule on its DG location : <Tags>
404: The log forwarding profile <LOG FORWARDING PROFILE> was not found.
500: An error occurred in SecureTrack while trying to validate the log forwarding profile.
400: Object UID <OLD OBJECT UID> not found in the rule for this instruction.
400: Values of new object UID <NEW OBJECT UID> and old object UID <OLD OBJECT UID> do not match.
400: Rule placement can only be: \"before\", \"after\" or \"last\".
400: You can't change rule placement when there is no rule order. please add rule order first.
400: You can't change rule placement to \"After\" for this type of device.
400: You can't change rule placement to \"Last\" for this type of device.","folder":"2-25","rawModeData":"{\n\t\"rule_placement\": {\"new_value\":\"before\"}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/tasks/{{taskId}}/designer/instruction/{{instructionId}}","collectionId":"2","id":"2-25-135","method":"PUT"},{"headers":"Accept: application/json\n","name":"Returns the details of a specified ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
expand_links: See expanded view of the objects [optional]
showStepsDetails: Include steps' details in the response [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1
OUTPUT {
    \"ticket\": {
        \"id\": 1,
        \"subject\": \"AR-Ticket\",
        \"requester\": \"a\",
        \"requester_id\": 4,
        \"priority\": \"Normal\",
        \"status\": \"In Progress\",
        \"domain_name\": \"\",
        \"sla_status\": \"NA\",
        \"sla_outcome\": \"NA\",
        \"workflow\": {
            \"id\": 11,
            \"name\": \"AR & MG\",
            \"uses_topology\": true
        },
        \"steps\": {
            \"step\": [
                {
                    \"id\": 209,
                    \"name\": \"Open request\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 209,
                            \"assignee_id\": 4,
                            \"assignee\": \"a\",
                            \"status\": \"DONE\",
                            \"fields\": {
                                \"field\": [
                                    {
                                        \"@xsi.type\": \"multi_access_request\",
                                        \"id\": 1695,
                                        \"name\": \"AR\",
                                        \"read_only\": false,
                                        \"access_request\": {
                                            \"id\": 1706,
                                            \"order\": \"AR1\",
                                            \"risk_analysis_result\": {
                                                \"status\": \"not run\"
                                            },
                                            \"verifier_result\": {
                                                \"status\": \"not run\"
                                            },
                                            \"use_topology\": true,
                                            \"targets\": {
                                                \"target\": {
                                                    \"@type\": \"ANY\",
                                                    \"id\": 1705
                                                }
                                            },
                                            \"users\": {
                                                \"user\": [
                                                    \"Any\"
                                                ]
                                            },
                                            \"sources\": {
                                                \"source\": [
                                                    {
                                                        \"@type\": \"INTERNET\",
                                                        \"id\": 1701
                                                    },
                                                    {
                                                        \"@type\": \"DNS\",
                                                        \"id\": 1702,
                                                        \"host_name\": \"www.google.com\",
                                                        \"dns_ip_addresses\": {
                                                            \"ip_address\": \"216.58.214.100\"
                                                        }
                                                    },
                                                    {
                                                        \"@type\": \"IP\",
                                                        \"id\": 1703,
                                                        \"ip_address\": \"1.1.1.1\",
                                                        \"netmask\": \"255.255.255.255\",
                                                        \"nat_ip_address\": \"4.4.4.4\",
                                                        \"nat_netmask\": \"255.255.255.255\"
                                                    }
                                                ]
                                            },
                                            \"destinations\": {
                                                \"destination\": [
                                                    {
                                                        \"@type\": \"ANY\",
                                                        \"id\": 1697
                                                    }
                                                ]
                                            },
                                            \"services\": {
                                                \"service\": [
                                                    {
                                                        \"@type\": \"ANY\",
                                                        \"id\": 1699
                                                    }
                                                ]
                                            },
                                            \"action\": \"Accept\",
                                            \"labels\": \"\"
                                        }
                                    },
                                    {
                                        \"@xsi.type\": \"multi_group_change\",
                                        \"id\": 1707,
                                        \"name\": \"MG\",
                                        \"read_only\": false,
                                        \"implementation_status\": \"NOT_SUPPORTED\"
                                    }
                                ]
                            }
                        }
                    }
                },
                {
                    \"id\": 210,
                    \"name\": \"STEP2 - auto AR with designer /update /commit\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 210,
                            \"assignee_id\": 4,
                            \"assignee\": \"a\",
                            \"status\": \"ASSIGNED\",
                            \"unlicensed_devices_for_automation\": {
                                \"unlicensed_device_for_automation\": [
                                    {
                                        \"id\": \"2\",
                                        \"name\": \"asa\"
                                    }
                                ]
                            }
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"multi_access_request\",
                                    \"id\": 1709,
                                    \"name\": \"AR\",
                                    \"read_only\": false,
                                    \"access_request\": {
                                        \"id\": 1720,
                                        \"order\": \"AR1\",
                                        \"risk_analysis_result\": {
                                            \"status\": \"not run\"
                                        },
                                        \"verifier_result\": {
                                            \"status\": \"not run\"
                                        },
                                        \"use_topology\": true,
                                        \"targets\": {
                                            \"target\": {
                                                \"@type\": \"ANY\",
                                                \"id\": 1719
                                            }
                                        },
                                        \"users\": {
                                            \"user\": [
                                                \"Any\"
                                            ]
                                        },
                                        \"sources\": {
                                            \"source\": [
                                                {
                                                    \"@type\": \"INTERNET\",
                                                    \"id\": 1721
                                                },
                                                {
                                                    \"@type\": \"DNS\",
                                                    \"id\": 1722,
                                                    \"host_name\": \"www.google.com\",
                                                    \"dns_ip_addresses\": {
                                                        \"ip_address\": \"216.58.214.100\"
                                                    }
                                                },
                                                {
                                                    \"@type\": \"IP\",
                                                    \"id\": 1723,
                                                    \"ip_address\": \"1.1.1.1\",
                                                    \"netmask\": \"255.255.255.255\",
                                                    \"nat_ip_address\": \"4.4.4.4\",
                                                    \"nat_netmask\": \"255.255.255.255\"
                                                },
                                                {
                                                    \"@type\": \"RANGE\",
                                                    \"id\": 1724,
                                                    \"range_first_ip\": \"1.1.11.1\",
                                                    \"range_last_ip\": \"1.1.11.10\"
                                                }
                                                {
                                                    \"@type\": \"EXTERNAL_RESOURCE\"\",
                                                    \"id\": 436,
                                                    \"resource_ref\": {
                                                        \"id\": \"4786115a-97c2-3a25-8e31-1d6166263fdd\",
                                                        \"name\": \"asg-web\",
                                                        \"type\": \"APPLICATION_SECURITY_GROUP\"
                                                    },
                                                    \"ips\": {
                                                        \"ip\": [
                                                            \"9.0.0.0/16\"
                                                        ]
                                                    },
                                                    \"account_ref\": {
                                                        \"cloud_vendor\": \"AZURE\",
                                                        \"id\": \"f0499890-708c-46a9-a44a-b7da0d433de3\",
                                                        \"name\": \"app-name\",
                                                    }
                                                }
                                            ]
                                        },
                                        \"destinations\": {
                                            \"destination\": [
                                                {
                                                    \"@type\": \"ANY\",
                                                    \"id\": 1711
                                                }
                                            ]
                                        },
                                        \"services\": {
                                            \"service\": [
                                                {
                                                    \"@type\": \"ANY\",
                                                    \"id\": 1713
                                                }
                                            ]
                                        },
                                        \"action\": \"Accept\",
                                        \"labels\": \"\"
                                    }
                                }
                            }
                        }
                    }
                }
            ]
        },
        \"current_step\": {
            \"id\": 210,
            \"name\": \"STEP2 - auto AR with designer /update /commit\"
        },
        \"comments\": \"\"
    }
}


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2
OUTPUT {
    \"ticket\": {
        \"id\": 2,
        \"subject\": \"Clone Server Policy Ticket\",
        \"requester\": \"a\",
        \"requester_id\": 12,
        \"priority\": \"Normal\",
        \"status\": \"In Progress\",
        \"referenced_ticket\": {
            \"id\": 1,
            \"name\": \"Ticket Subject Sample\",
            \"link\": {
                \"@href\": \"https://host/securechangeworkflow/api/securechange/tickets/1\"
            }
        },
        \"domain_name\": \"\",
        \"sla_status\": \"NA\",
        \"sla_outcome\": \"NA\",
        \"workflow\": {
            \"id\": 109,
            \"name\": \"sc_12705\",
            \"uses_topology\": false
        },
        \"steps\": {
            \"step\": [
                {
                    \"id\": 78,
                    \"name\": \"Open request\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 78,
                            \"assignee_id\": 12,
                            \"assignee\": \"a\",
                            \"status\": \"DONE\",
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"clone_server_policy_request\",
                                    \"id\": 872,
                                    \"name\": \"Clone Server Policy Field\",
                                    \"from_server\": {
                                        \"@type\": \"IP\",
                                        \"id\": 869,
                                        \"ip_address\": \"1.2.2.2\",
                                        \"cidr\": 32
                                    },
                                    \"to_servers\": {
                                        \"server\": {
                                            \"@type\": \"IP\",
                                            \"id\": 871,
                                            \"ip_address\": \"10.100.23.32\",
                                            \"netmask\": \"255.255.255.255\",
                                            \"cidr\": 32
                                        }
                                    },
                                    \"comment\": \"target servers to clone server policy to\"
                                }
                            }
                        }
                    }
                },
                {
                    \"id\": 79,
                    \"name\": \"Business Approval\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 79,
                            \"assignee_id\": 12,
                            \"assignee\": \"a\",
                            \"status\": \"ASSIGNED\",
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"clone_server_policy_request\",
                                    \"id\": 876,
                                    \"name\": \"Clone Server Policy Field\",
                                    \"from_server\": {
                                        \"@type\": \"IP\",
                                        \"id\": 873,
                                        \"ip_address\": \"1.2.2.2\",
                                        \"cidr\": 32
                                    },
                                    \"to_servers\": {
                                        \"server\": {
                                            \"@type\": \"IP\",
                                            \"id\": 875,
                                            \"ip_address\": \"10.100.23.32\",
                                            \"netmask\": \"255.255.255.255\",
                                            \"cidr\": 32
                                        }
                                    },
                                    \"comment\": \"target servers to clone server policy to\"
                                }
                            }
                        }
                    }
                }
            ]
        },
        \"current_step\": {
            \"id\": 79,
            \"name\": \"Business Approval\"
        },
        \"comments\": \"\"
    }
}


Response Messages:
403: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: No entity found for query","folder":"2-25","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}","collectionId":"2","id":"2-25-136","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Change multiple field within a task of a ticket in the current step","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"raw","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ���add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldListDTO
id: Ticket ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields
BODY<fields>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_server_decommission_request\">
         <id>7591</id>
         <name>sd</name>
         <server_decommission_request>
             <id>7596</id>
             <order>DR1</order>
             <servers>
                 <server type=\"IP\">
                     <id>7593</id>
                     <ip_address>2.2.2.2</ip_address>
                     <netmask>255.255.255.255</netmask>
                 </server>
             </servers>
             <targets>
                 <target type=\"ANY\">
                     <id>7595</id>
                 </target>
             </targets>
             <comment>change ip from 1.1.1.1 to 2.2.2.2</comment>
         </server_decommission_request>
     </field>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"date\">
         <id>7786</id>
         <name>date</name>
         <value>2015-12-15</value>
     </field>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"time\">
         <id>7787</id>
         <name>time</name>
         <value>12:00</value>
     </field>
</fields>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields
BODY{
\"fields\": {
\"field\": {
\"@xsi.type\": \"rule_modification_field\",
\"id\": 746,
\"name\": \"rm\",
\"devices\": {
    \"device\": {
    \"revision_id\": 24,
    \"management_id\": 5,
    \"bindings\": {
    \"binding\": {
    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
    \"binding\": {
        \"@xsi.type\": \"policy__binding\",
        \"policy_name\": \"FortiGate-VM64-111-10_3\"
    },
    \"rules\": {
        \"rule\": {
        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
        \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
        }
    }
    }
    }
    }
},
\"rule_modifications\": {
    \"rule_modification\": {
    \"@xsi.type\": \"modify_rule_modification\",
    \"rule_key\": {
    \"device_id\": 5,
    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
    \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
    },
    \"source_modifications\": {
    \"network_object_cell_modifications\": {
    \"network_object_cell_modification\": [
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
            \"name\": \"NET_1\",
            \"comment\": \"\",
            \"ip\": \"3.3.3.3\",
            \"netmask\": \"255.255.255.255\"
        }
        ]
        }
        },
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
            \"name\": \"RANGE_1\",
            \"comment\": \"EXAMPLE_RANGE\",
            \"min_ip\": \"3.3.3.3\",
            \"max_ip\": \"5.5.5.5\"
        }
        ]
        }
        }
    ]
    }
    },
    \"destination_modifications\": {
    \"network_object_cell_modifications\": {
    \"network_object_cell_modification\": [
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
        }
        }
        },
        {
        \"action\": \"REMOVE\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
            \"name\": \"Host123\",
            \"comment\": \"cccHost\",
            \"ip\": \"1.2.3.4\",
            \"netmask\": \"255.255.255.255\"
        }
        ]
        }
        }
    ]
    }
    },
    \"service_modifications\": {
    \"service_object_cell_modifications\": {
    \"service_object_cell_modification\": [
        {
        \"action\": \"REMOVE\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:icmp_service\",
        \"name\": \"ICMP_1\",
        \"comment\": \"EXAMPLE_ICMP\",
        \"type\": {
            \"from\": 55,
            \"to\": 55
        }
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:transport_service\",
        \"name\": \"TCP_1\",
        \"comment\": \"EXAMPLE_TCP\",
        \"port\": {
            \"from\": 1234,
            \"to\": 1234
        },
        \"protocol\": \"TCP\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:transport_service\",
        \"name\": \"UDP_1\",
        \"comment\": \"EXAMPLE_UDP\",
        \"port\": {
            \"from\": 3,
            \"to\": 3
        },
        \"protocol\": \"UDP\"
        }
        }
        }
    ]
    }
    }
    }
}
}
}
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object / device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (<device network object / device service object> is invalid: There are multiple objects with this name in the network)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
403: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: Invalid value for field: <FIELD_NAME> (a valid object comment can have up to <MAX> characters)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value
406: Invalid format detected: <name|binding_uid|rule_uid> - This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags
406: Invalid format detected: name - <VALUE> is invalid. Text must include <1-255> characters
406: Invalid format detected: <rule_uid|binding_uid> - <VALUE> is invalid. Text must include <1-4096> characters
406: Invalid format detected: comment - <VALUE> is invalid. Text must include <0-4096> characters
406: Invalid format detected: name - <VALUE> is invalid. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters + - , _ # @ . : = ! ^ ( )
406: Invalid format detected: <rule_uid|binding_uid|comment> - <VALUE> is invalid. Text includes invalid expressions such as HTML tags or command line operations
406: Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP","folder":"2-25","rawModeData":"{\n\"fields\": {\n\"field\": {\n\"@xsi.type\": \"rule_modification_field\",\n\"id\": 746,\n\"name\": \"rm\",\n\"devices\": {\n\t\"device\": {\n\t\"revision_id\": 24,\n\t\"management_id\": 5,\n\t\"bindings\": {\n\t\"binding\": {\n\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\"binding\": {\n\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t},\n\t\"rules\": {\n\t\t\"rule\": {\n\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t}\n\t}\n\t}\n\t}\n\t}\n},\n\"rule_modifications\": {\n\t\"rule_modification\": {\n\t\"@xsi.type\": \"modify_rule_modification\",\n\t\"rule_key\": {\n\t\"device_id\": 5,\n\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t},\n\t\"source_modifications\": {\n\t\"network_object_cell_modifications\": {\n\t\"network_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\"name\": \"NET_1\",\n\t\t\t\"comment\": \"\",\n\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t}\n\t\t]\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t}\n\t\t]\n\t\t}\n\t\t}\n\t]\n\t}\n\t},\n\t\"destination_modifications\": {\n\t\"network_object_cell_modifications\": {\n\t\"network_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"REMOVE\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\"name\": \"Host123\",\n\t\t\t\"comment\": \"cccHost\",\n\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t}\n\t\t]\n\t\t}\n\t\t}\n\t]\n\t}\n\t},\n\t\"service_modifications\": {\n\t\"service_object_cell_modifications\": {\n\t\"service_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"REMOVE\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\"name\": \"ICMP_1\",\n\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\"type\": {\n\t\t\t\"from\": 55,\n\t\t\t\"to\": 55\n\t\t}\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\"name\": \"TCP_1\",\n\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\"port\": {\n\t\t\t\"from\": 1234,\n\t\t\t\"to\": 1234\n\t\t},\n\t\t\"protocol\": \"TCP\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\"name\": \"UDP_1\",\n\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\"port\": {\n\t\t\t\"from\": 3,\n\t\t\t\"to\": 3\n\t\t},\n\t\t\"protocol\": \"UDP\"\n\t\t}\n\t\t}\n\t\t}\n\t]\n\t}\n\t}\n\t}\n}\n}\n}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/fields","collectionId":"2","id":"2-25-137","method":"PUT"},{"headers":"Accept: application/json\n","name":"Returns the details of a specified ticket stages","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"}],"dataMode":"params","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2

Response Messages:
403: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.","folder":"2-25","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}","collectionId":"2","id":"2-25-138","method":"GET"},{"headers":"Accept: application/json\n","name":"Get designer results according to field id","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"dataMode":"params","description":"Use this API to retrieve designer results generated in R17-2 and later.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/designer

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: Specified field, id: <ID> , name: <NAME>, cannot contain designer result
404: Designer results were not found in the request.","folder":"2-25","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/designer","collectionId":"2","id":"2-25-139","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Submit a new ticket to Secure Change","dataMode":"raw","description":" GENERAL USE
When posting a Modify Group ticket, group scope must be configured for FortiManager advanced and Juniper SRX devices.
Juniper SRX devices:
Global address-book will be used unless an existing address-book is given.
Ticket validation will fail in case given Address Book is not configured on the device.
FortiManager advanced devices:
'Any' zone will be used unless an existing zone is given.
Ticket validation will fail in case given zone is not configured on the device.
*Note: Zones and address-books must not be configured for other devices.

Using newly created objects from a different group in the same ticket
The user can add a newly created object from a different group to the selected group, with object_UID equal to the name of the newly created object.
For management devices with hierarchies, the newly created object does not populate other levels of the hierarchies.

Permitted values for @type
Allowed values for @type property included in DestinationDTO and SourceDTO are:
ANY
IP
DNS
Object - Device's existing object
INTERNET
LDAP (SourceDTO only) - LDAP entity

To use a service object in a new request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id
2. Both object_name and management_name

To use a network object in a new request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both object_UID and object_name are defined, object_UID takes precedence over object_name

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ���add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: ticketDTO
closed: Cannot be done from the API [optional]
count [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY<ticket>
    <subject>topology mode_AR1-with topology_AR2-no topology</subject>
    <requester>u1</requester>
    <priority>Normal</priority>
    <domain_name>Default</domain_name>
    <workflow>
         <id>7</id>
         <name>Workflow with topology</name>
    </workflow>
    <steps>
         <step>
             <name>Open request</name>
             <tasks>
                 <task>
                     <fields>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_access_request\">
                             <name>Required Access</name>
                             <access_request>
                                 <use_topology>true</use_topology>
                                 <targets>
                                     <target type=\"Object\">
                                         <object_name>ASA</object_name>
                                         <management_name>ASA</management_name>
                                     </target>
                                 </targets>
                                 <users>
                                     <user>Any</user>
                                 </users>
                                 <sources>
                                     <source type=\"Object\">
                                         <object_name>host_10.100.10.140</object_name>
                                         <management_name>NetScreen</management_name>
                                     </source>
                                 <sources>
                                     <source type=\"Object\">
                                         <object_UID>{55908141-c341-4990-9cc6-a3fd2dfb49e1}</object_UID>
                                         <management_id>13</management_id>
                                     </source>
                                 </sources>
                                 <destinations>
                                     <destination type=\"Object\">
                                         <object_name>h_10.10.10.10</object_name>
                                         <management_name>ASA</management_name>
                                     </destination>
                                 </destinations>
                                 <services>
                                     <service type=\"PROTOCOL\">
                                         <protocol>TCP</protocol>
                                         <port>80</port>
                                     </service>
                                     <service type=\"APPLICATION_IDENTITY\">
                                         <application_name>Gmail</application_name>
                                     </service>
                                 </services>
                                 <action>Accept</action>
                                 <labels/>
                             </access_request>
                             <access_request>
                                 <use_topology>false</use_topology>
                                 <targets>
                                     <target type=\"Object\">
                                         <object_name>inside_access_in</object_name>
                                         <management_name>ASA</management_name>
                                     </target>
                                 </targets>
                                 <users>
                                     <user>Any</user>
                                 </users>
                                 <sources>
                                     <source type=\"Object\">
                                         <object_name>1.1.1.0</object_name>
                                         <management_name>NetScreen</management_name>
                                     </source>
                                     <source type=\"EXTERNAL_RESOURCE\">
                                         <resource_ref>
                                             <name>asg15-api-test</name>
                                         </resource_ref>
                                     </source>
                                 </sources>
                                 <destinations>
                                     <destination type=\"Object\">
                                         <object_name>network_regi3</object_name>
                                         <management_name>ASA</management_name>
                                     </destination>
                                     <destination type=\"EXTERNAL_RESOURCE\">
                                         <resource_ref>
                                             <id>916ca6a9-76e2-3d9f-a35c-134f0981791a</id>
                                         </resource_ref>
                                     </destination>
                                 </destinations>
                                 <services>
                                     <service type=\"ANY\">
                                     </service>
                                 </services>
                                 <action>Accept</action>
                                 <labels/>
                             </access_request>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_area\">
                             <name>Business Justification</name>
                             <text>I need access to ftp </text>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_field\">
                             <name>Project Number</name>
                             <text>CR124560 </text>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"hyperlink\">
                             <name>Hyperlink</name>
                             <url>http://192.168.1.1/ticket</url>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"drop_down_list\">
                             <name>Change Window</name>
                             <selection>Monday</selection>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"manager\">
                             <name>manager email</name>
                             <text>manager@tufin.com</text>
                         </field>
                     </fields>
                 </task>
             </tasks>
        </step>
    </steps>
    <comments/>
</ticket>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY<ticket>
    <subject>New MG ticket</subject>
    <requester>a</requester>
    <requester_id>4</requester_id>
    <priority>Normal</priority>
    <status>In Progress</status>
    <domain_name/>
    <sla_status>NA</sla_status>
    <sla_outcome>NA</sla_outcome>
    <workflow>
        <id>6</id>
        <name>MG</name>
        <uses_topology>false</uses_topology>
    </workflow>
    <steps>
        <step>
            <id>72</id>
            <name>New step</name>
            <redone>false</redone>
            <skipped>false</skipped>
            <tasks>
                <task>
                    <id>72</id>
                    <assignee_id>4</assignee_id>
                    <assignee>a</assignee>
                    <status>ASSIGNED</status>
                    <fields>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_group_change\">
                            <id>262</id>
                            <name>MG</name>
                            <read_only>false</read_only>
                            <implementation_status>NOT_SUPPORTED</implementation_status>
                            <group_change>
                                <name>ExistingGroup</name>
                                <object_UID>{c862fb6f-1314-45da-9e01-56c9b85d001d}</object_UID>
                                <management_id>58</management_id>
                                <management_name>FMG/root</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>157</id>
                                        <name>10.100 net</name>
                                        <object_UID>{37cdc055-7aac-4385-b46b-cc54d95e4b6d}</object_UID>
                                        <object_type>Network</object_type>
                                        <object_details>10.100.0.0/255.255.0.0</object_details>
                                        <management_id>58</management_id>
                                        <management_name>FMG/root</management_name>
                                        <status>NOT_CHANGED</status>
                                        <object_updated_status>EXISTING_EDITED</object_updated_status>
                                        <comment>new_comment</comment>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                                <zone>
                                    <is_global>true</is_global>
                                    <name>any</name>
                                </zone>
                            </group_change>
                            <group_change>
                                <name>78.45.12.0</name>
                                <object_UID>{cac64d34-a05e-4a05-b271-64642eb976ff}</object_UID>
                                <management_id>28</management_id>
                                <management_name>SRX-root-lsys</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>158</id>
                                        <name>78.45.12.1</name>
                                        <object_UID>{7912c335-6dbe-47de-b872-1322f9015b2f}</object_UID>
                                        <object_type>Host</object_type>
                                        <object_details>78.45.12.1/255.255.255.255</object_details>
                                        <management_id>28</management_id>
                                        <management_name>SRX-root-lsys</management_name>
                                        <status>NOT_CHANGED</status>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                                <address_book>
                                    <name>global</name>
                                </address_book>
                            </group_change>
                            <group_change>
                                <name>10.10.0.0/16</name>
                                <object_UID>{5dff0bd8-51e4-4a83-8138-d54dd18ca52b}</object_UID>
                                <management_id>24</management_id>
                                <management_name>NSX-Distributed Firewall</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>161</id>
                                        <name>10.10.0.0/16</name>
                                        <object_UID>{5d7b826c-f053-40fd-81bd-7a6f44cf15ef}</object_UID>
                                        <object_type>Network</object_type>
                                        <object_details>10.10.0.0/255.255.0.0</object_details>
                                        <management_id>24</management_id>
                                        <management_name>NSX-Distributed Firewall</management_name>
                                        <status>NOT_CHANGED</status>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                            </group_change>
                        </field>
                    </fields>
                </task>
            </tasks>
        </step>
    </steps>
</ticket>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY<ticket>
    <subject>test API</subject>
    <requester>a</requester>
    <requester_id>4</requester_id>
    <priority>Normal</priority>
    <domain_name/>
    <sla_status>NA</sla_status>
    <sla_outcome>NA</sla_outcome>
    <workflow>
        <id>8</id>
        <name>Modify group</name>
        <uses_topology>false</uses_topology>
    </workflow>
    <steps>
        <step>
            <id>11</id>
            <name>Open request</name>
            <redone>false</redone>
            <skipped>false</skipped>
            <tasks>
                <task>
                    <id>11</id>
                    <assignee_id>4</assignee_id>
                    <assignee>a</assignee>                    <status>DONE</status>
                    <fields>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_group_change\">
                            <id>137</id>
                            <name>ff</name>
                            <read_only>false</read_only>
                            <implementation_status>NOT_SUPPORTED</implementation_status>
                            <group_change>
                                <name>port1Group</name>
                                <object_UID>{d5b4459b-6b27-4012-9924-b244c250520f}</object_UID>
                                <management_id>64</management_id>
                                <management_name>10.100.111.8/ADOM_5_2</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"HOST\">
                                        <id>69</id>
                                        <name>obj_1</name>
                                        <object_UID>obj_1</object_UID>
                                        <object_type>Host</object_type>
                                        <object_details>6.6.6.6/255.255.255.255</object_details>
                                        <management_id>64</management_id>
                                        <status>ADDED</status>
                                        <comment/>
                                        <object_updated_status>NEW</object_updated_status>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                            </group_change>
                            <group_change>
                                <name>gfd</name>
                                <management_id>64</management_id>
                                <management_name>10.100.111.8/ADOM_5_2</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>70</id>
                                        <name>obj_1</name>
                                        <object_UID>obj_1</object_UID>
                                        <object_type>Host</object_type>
                                        <object_details>6.6.6.6/255.255.255.255</object_details>
                                        <management_id>64</management_id>
                                        <management_name>10.100.111.8/ADOM_5_2</management_name>
                                        <status>ADDED</status>
                                        <object_updated_status>EXISTING_NOT_EDITED</object_updated_status>
                                    </member>
                                </members>
                                <change_action>CREATE</change_action>
                                <zone>
                                    <is_global>true</is_global>
                                    <name>any</name>
                                </zone>
                            </group_change>
                        </field>
                    </fields>
                </task>
            </tasks>
        </step>
    </steps>
    <current_step>
        <id>12</id>
        <name>Copy of Open request</name>
    </current_step>
    <comments/>
</ticket>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY{
    \"ticket\": {
        \"application_details\": { \"id\": \"1\" },
        \"referenced_ticket\": { \"id\": \"3\" },
        \"subject\": \"topology mode_AR1-with topology_AR2-no topology\",
        \"priority\": \"Normal\",
        \"workflow\": { \"name\": \"ar\" }
    }
}


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY{
    \"ticket\": {
        \"subject\": \"RM_EXAMPLE\",
        \"requester\": \"m\",
        \"requester_id\": 4,
        \"priority\": \"Normal\",
        \"domain_name\": \"\",
        \"workflow\": {
            \"name\": \"RM\",
        },
        \"steps\": {
            \"step\": [
                {
                    \"tasks\": {
                        \"task\": {
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"rule_modification_field\",
                                    \"devices\": {
                                        \"device\": {
                                            \"revision_id\": 24,
                                            \"management_id\": 5,
                                            \"bindings\": {
                                                \"binding\": {
                                                    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                                                    \"binding\": {
                                                        \"@xsi.type\": \"policy__binding\",
                                                        \"policy_name\": \"FortiGate-VM64-111-10_3\"
                                                    },
                                                    \"rules\": {
                                                        \"rule\": {
                                                            \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                                            \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    \"rule_modifications\": {
                                        \"rule_modification\": {
                                            \"@xsi.type\": \"modify_rule_modification\",
                                            \"rule_key\": {
                                                \"device_id\": 5,
                                                \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                                                \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                                            },
                                            \"source_modifications\": {
                                                \"network_object_cell_modifications\": {
                                                    \"network_object_cell_modification\": [
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"network_object\": [
                                                                    {
                                                                        \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                                        \"name\": \"RANGE_1\",
                                                                        \"comment\": \"EXAMPLE_RANGE\",
                                                                        \"min_ip\": \"3.3.3.3\",
                                                                        \"max_ip\": \"5.5.5.5\"
                                                                    }
                                                                ]
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"network_object\": [
                                                                    {
                                                                        \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                                        \"name\": \"NET_1\",
                                                                        \"comment\": \"\",
                                                                        \"ip\": \"3.3.3.3\",
                                                                        \"netmask\": \"255.255.255.255\"
                                                                    }
                                                                ]
                                                            }
                                                        }
                                                    ]
                                                }
                                            },
                                            \"destination_modifications\": {
                                                \"id\": 11,
                                                \"network_object_cell_modifications\": {
                                                    \"network_object_cell_modification\": [
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"existing\",
                                                                    \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"REMOVE\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"existing\",
                                                                    \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"network_object\": [
                                                                    {
                                                                        \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                                        \"name\": \"Host123\",
                                                                        \"comment\": \"cccHost\",
                                                                        \"ip\": \"1.2.3.4\",
                                                                        \"netmask\": \"255.255.255.255\"
                                                                    }
                                                                ]
                                                            }
                                                        }
                                                    ]
                                                }
                                            },
                                            \"service_modifications\": {
                                                \"id\": 9,
                                                \"service_object_cell_modifications\": {
                                                    \"service_object_cell_modification\": [
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"service_object\": {
                                                                    \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                                                    \"name\": \"ICMP_1\",
                                                                    \"comment\": \"EXAMPLE_ICMP\",
                                                                    \"type\": {
                                                                        \"from\": 55,
                                                                        \"to\": 55
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"service_object\": {
                                                                    \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                                    \"name\": \"UDP_1\",
                                                                    \"comment\": \"EXAMPLE_UDP\",
                                                                    \"port\": {
                                                                        \"from\": 3,
                                                                        \"to\": 3
                                                                    },
                                                                    \"protocol\": \"UDP\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"service_object\": {
                                                                    \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                                    \"name\": \"TCP_1\",
                                                                    \"comment\": \"EXAMPLE_TCP\",
                                                                    \"port\": {
                                                                        \"from\": 1234,
                                                                        \"to\": 1234
                                                                    },
                                                                    \"protocol\": \"TCP\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"existing\",
                                                                    \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"REMOVE\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"existing\",
                                                                    \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                                                }
                                                            }
                                                        }
                                                    ]
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            ]
        },
    }
}


Response Messages:
400: Application ID is missing.
400: Create closed ticket is enabled only from SecureApp application.
400: The application was already deleted.
400: The requester must be the currently logged in user.
400: Workflow was not found.
400: Workflow is not active.
400: Workflow configuration is not valid.
400: Workflow is not set
400: You cannot enter a status for a new ticket.
400: Requester cannot open a ticket in domain.
400: Invalid ticket priority.
400: You cannot open a new ticket with an empty subject.
400: Expiration field is required.
400: Submit ticket enabled only with the first step
400: First step can be only with one task
400: The specified workflow does not contain an access request field in the first step.
400: There are no changed connections that are ready for creating a ticket.
400: You cannot use an access request field to create a ticket from SecureApp.
400: The ticket fields do not match the fields in the current step of the workflow.
400: You cannot change the value of a field because it is read-only.
400: Managed tasks are not initialized or done
400: Application Change field cannot be managed via this REST API
400: Invalid value for field: <FIELD_NAME> (Rule Modification workflow is not supported for this device)
403: You do not have permissions to edit this application.
403: Logged in user: NAME do not have permission to perform on behalf actions
403: You are not a participant in the first step of this workflow
403: UNAUTHORIZED
404: There is no application with the specified ID
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (Network object cell modification missing action)
400: Invalid value for field: <FIELD_NAME> (Network object cell modification element cannot be empty)
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: Invalid value for field: <FIELD_NAME> (a valid object comment can have up to <MAX> characters)
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: There are multiple objects with this name in the network)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value
400: Workflow does not support referenced ticket
400: The referenced ticket cannot be the ticket itself
406: Invalid format detected: <subject|name|binding_uid|rule_uid> - This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags
406: Invalid format detected: <subject|name> - <VALUE> is invalid. Text must include <1-255> characters
406: Invalid format detected: <rule_uid|binding_uid> - <VALUE> is invalid. Text must include <1-4096> characters
406: Invalid format detected: comment - <VALUE> is invalid. Text must include <0-4096> characters
406: Invalid format detected: <subject|name> - <VALUE> is invalid. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters + - , _ # @ . : = ! ^ ( )
406: Invalid format detected: <rule_uid|binding_uid|comment> - <VALUE> is invalid. Text includes invalid expressions such as HTML tags or command line operations
406: Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP","folder":"2-25","rawModeData":"{\n\t\"ticket\": {\n\t\t\"subject\": \"RM_EXAMPLE\",\n\t\t\"requester\": \"m\",\n\t\t\"requester_id\": 4,\n\t\t\"priority\": \"Normal\",\n\t\t\"domain_name\": \"\",\n\t\t\"workflow\": {\n\t\t\t\"name\": \"RM\",\n\t\t},\n\t\t\"steps\": {\n\t\t\t\"step\": [\n\t\t\t\t{\n\t\t\t\t\t\"tasks\": {\n\t\t\t\t\t\t\"task\": {\n\t\t\t\t\t\t\t\"fields\": {\n\t\t\t\t\t\t\t\t\"field\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\t\t\t\t\t\t\"devices\": {\n\t\t\t\t\t\t\t\t\t\t\"device\": {\n\t\t\t\t\t\t\t\t\t\t\t\"revision_id\": 24,\n\t\t\t\t\t\t\t\t\t\t\t\"management_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"rule_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\t\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 11,\n\t\t\t\t\t\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 9,\n\t\t\t\t\t\t\t\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/","collectionId":"2","id":"2-25-140","method":"POST"},{"headers":"Accept: application/json\n","name":"Returns the details of a specified tickets (max 100 tickets in a single query)","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
status: The status of the tickets [optional]
count: Tickets list max pagination length (max value is 100) [optional]
start: Offset the count starting point [optional]
desc: Get the list in descending order [optional]
expand_links: See expanded view of the objects [optional]
showStepsDetails: Include steps' details in the response [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets?status=In Progress&count=10&start=3&expand_links=false

Response Messages:
400: Status is not a valid. The valid values are: TICKET_STATUSES
400: Can not fetch more than 100 tickets in 1 time
403: Access is denied","folder":"2-25","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/","collectionId":"2","id":"2-25-141","method":"GET"},{"headers":"Accept: application/json\n","name":"Returns the details of a specified task","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"params","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
taskId: The ID number of the task as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2?expand_links=true

Response Messages:
403: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.
404: Task with ID was not found in Stage ID in ticket ID .","folder":"2-25","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}","collectionId":"2","id":"2-25-142","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Change a task of a ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"raw","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ���add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: ticketTaskDTO
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/2/tasks/4
BODY<task>
     <status>ASSIGNED</status>
     <fields>
         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_group_change\">
             <id>7599</id>
             <name>mf</name>
             <read_only>false</read_only>
             <implementation_status>NOT_STARTED</implementation_status>
             <group_change>
                        <name>ggg</name>
                        <st_uid>{A12AE330-0DBD-11E5-B841-7F0000010E0E}</st_uid>
                        <management_id>42</management_id>
                        <management_name>cp239</management_name>
                        <members>
                             <member type=\"Object\">
                                 <id>8</id>
                                 <name>yaakovs_host</name>
                                 <st_uid>{BDAA378C-C90B-4D12-B598-1AFED2D1DA14}</st_uid>
                                 <object_type>Host</object_type>
                                 <object_details>1.1.1.1/255.255.255.255</object_details>
                         <management_id>42</management_id>
                         <management_name>cp239</management_name>
                                 <status>NOT_CHANGED</status>
                             </member>
                             <member type=\"Object\">
                                 <id>9</id>
                                    <name>Avi_10.100.120.254</name>
                                    <st_uid>{8F195CDC-F426-47B6-9E8A-1FF14C17E54F}</st_uid>
                                     <object_type>Host</object_type>
                                     <object_details>10.100.120.254/255.255.255.255</object_details>
                                     <management_id>42</management_id>
                                     <management_name>cp239</management_name>
                                     <status>NOT_CHANGED</status>
                                 </member>
                                 <member type=\"HOST\">
                                     <id>10</id>
                                     <name>h22</name>
                                     <object_type>Host</object_type>
                                     <object_details>2.2.2.2/255.255.255.255</object_details>
                                     <status>ADDED</status>
                                     <comment/>
                                 </member>
                                 <member type=\"HOST\">
                                     <id>10</id>
                                     <name>h22</name>
                                     <object_type>Host</object_type>
                                     <object_details>3.3.3.3/255.255.255.255</object_details>
                                     <status>ADDED</status>
                                     <comment/>
                                 </member>
                 </members>
                 <change_implementation_status>NOT_RUN</change_implementation_status>
                    </group_change>
            </field>
     </fields>
</task>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4
BODY{
    \"task\": {
        \"status\": \"ASSIGNED\",
        \"fields\": {
            \"field\": {
                \"@xsi.type\": \"rule_modification_field\",
                \"id\": 743,
                \"devices\": {
                    \"device\": {
                        \"revision_id\": 24,
                        \"management_id\": 5,
                        \"bindings\": {
                            \"binding\": {
                                \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                                \"binding\": {
                                    \"@xsi.type\": \"policy__binding\",
                                    \"policy_name\": \"FortiGate-VM64-111-10_3\"
                                },
                                \"rules\": {
                                    \"rule\": {
                                        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                        \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                                    }
                                }
                            }
                        }
                    }
                },
                \"rule_modifications\": {
                    \"rule_modification\": {
                        \"@xsi.type\": \"modify_rule_modification\",
                        \"rule_key\": {
                            \"device_id\": 5,
                            \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                            \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                        },
                        \"source_modifications\": {
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                    \"name\": \"RANGE_1\",
                                                    \"comment\": \"EXAMPLE_RANGE\",
                                                    \"min_ip\": \"3.3.3.3\",
                                                    \"max_ip\": \"5.5.5.5\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                    \"name\": \"NET_1\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"3.3.3.3\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        },
                        \"destination_modifications\": {
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                    \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"name\": \"Host123\",
                                                    \"comment\": \"cccHost\",
                                                    \"ip\": \"1.2.3.4\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"REMOVE\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                            }
                                        }
                                    }
                                ]
                            }
                        },
                        \"service_modifications\": {
                            \"service_object_cell_modifications\": {
                                \"service_object_cell_modification\": [
                                    {
                                        \"action\": \"REMOVE\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                                \"name\": \"ICMP_1\",
                                                \"comment\": \"EXAMPLE_ICMP\",
                                                \"type\": {
                                                    \"from\": 55,
                                                    \"to\": 55
                                                }
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                \"name\": \"TCP_1\",
                                                \"comment\": \"EXAMPLE_TCP\",
                                                \"port\": {
                                                    \"from\": 1234,
                                                    \"to\": 1234
                                                },
                                                \"protocol\": \"TCP\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                \"name\": \"UDP_1\",
                                                \"comment\": \"EXAMPLE_UDP\",
                                                \"port\": {
                                                    \"from\": 3,
                                                    \"to\": 3
                                                },
                                                \"protocol\": \"UDP\"
                                            }
                                        }
                                    }
                                ]
                            }
                        }
                    }
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket step does not exist, or is not the current step
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Task status does not exist.
400: Task status is not set to ASSIGNED or DONE.
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: There are multiple objects with this name in the network)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
403: You do not have permission to update this task. Contact your administrator for assistance.
403: Task can not be done because there are unlicensed devices for change automation
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: Invalid value for field: <FIELD_NAME> (a valid object comment can have up to <MAX> characters)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value
406: Invalid format detected: <name|binding_uid|rule_uid> - This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags
406: Invalid format detected: name - <VALUE> is invalid. Text must include <1-255> characters
406: Invalid format detected: <rule_uid|binding_uid> - <VALUE> is invalid. Text must include <1-4096> characters
406: Invalid format detected: comment - <VALUE> is invalid. Text must include <0-4096> characters
406: Invalid format detected: name - <VALUE> is invalid. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters + - , _ # @ . : = ! ^ ( )
406: Invalid format detected: <rule_uid|binding_uid|comment> - <VALUE> is invalid. Text includes invalid expressions such as HTML tags or command line operations
406: Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP","folder":"2-25","rawModeData":"{\n\t\"task\": {\n\t\t\"status\": \"ASSIGNED\",\n\t\t\"fields\": {\n\t\t\t\"field\": {\n\t\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\t\"id\": 743,\n\t\t\t\t\"devices\": {\n\t\t\t\t\t\"device\": {\n\t\t\t\t\t\t\"revision_id\": 24,\n\t\t\t\t\t\t\"management_id\": 5,\n\t\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"rule_modifications\": {\n\t\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}","collectionId":"2","id":"2-25-143","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Change a field within a task of a ticket at the current step","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"dataMode":"raw","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ���add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldDTO
id: Ticket ID
taskId: Task ID
fieldId: Field ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields/7642
BODY<field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"approve_reject\">
         <id>7661</id>
         <name>approve access</name>
         <approved>true</approved>
         <reason>Request approved</reason>
    </field>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields/71
BODY{
    \"rule_modification_field\": {
        \"devices\": {
            \"device\": {
                \"management_id\": 5,
                \"bindings\": {
                    \"binding\": {
                        \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                        \"binding\": {
                            \"@xsi.type\": \"policy__binding\",
                            \"policy_name\": \"FortiGate-VM64-111-10_3\"
                        },
                        \"rules\": {
                            \"rule\": {
                                \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                            }
                        }
                    }
                }
            }
        },
        \"rule_modifications\": {
            \"rule_modification\": {
                \"@xsi.type\": \"modify_rule_modification\",
                \"rule_key\": {
                    \"device_id\": 5,
                    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                    \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                },
                \"source_modifications\": {
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                            \"name\": \"NET_1\",
                                            \"comment\": \"\",
                                            \"ip\": \"3.3.3.3\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                            \"name\": \"RANGE_1\",
                                            \"comment\": \"EXAMPLE_RANGE\",
                                            \"min_ip\": \"3.3.3.3\",
                                            \"max_ip\": \"5.5.5.5\"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                \"destination_modifications\": {
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"name\": \"Host123\",
                                            \"comment\": \"cccHost\",
                                            \"ip\": \"1.2.3.4\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"action\": \"REMOVE\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                    }
                                }
                            }
                        ]
                    }
                },
                \"service_modifications\": {
                    \"service_object_cell_modifications\": {
                        \"service_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                        \"name\": \"TCP_1\",
                                        \"comment\": \"EXAMPLE_TCP\",
                                        \"port\": {
                                            \"from\": 1234,
                                            \"to\": 1234
                                        },
                                        \"protocol\": \"TCP\"
                                    }
                                }
                            },
                            {
                                \"action\": \"REMOVE\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"uid\": \"551556da-22dc-46f4-9253-a7ceee70394b\",
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                        \"name\": \"UDP_1\",
                                        \"comment\": \"EXAMPLE_UDP\",
                                        \"port\": {
                                            \"from\": 3,
                                            \"to\": 3
                                        },
                                        \"protocol\": \"UDP\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                        \"name\": \"ICMP_1\",
                                        \"comment\": \"EXAMPLE_ICMP\",
                                        \"type\": {
                                            \"from\": 55,
                                            \"to\": 55
                                        }
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                    }
                                }
                            }
                        ]
                    }
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: There are multiple objects with this name in the network)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
403: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: Invalid value for field: <FIELD_NAME> (a valid object comment can have up to <MAX> characters)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value
406: Invalid format detected: <name|binding_uid|rule_uid> - This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags
406: Invalid format detected: name - <VALUE> is invalid. Text must include <1-255> characters
406: Invalid format detected: <rule_uid|binding_uid> - <VALUE> is invalid. Text must include <1-4096> characters
406: Invalid format detected: comment - <VALUE> is invalid. Text must include <0-4096> characters
406: Invalid format detected: name - <VALUE> is invalid. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters + - , _ # @ . : = ! ^ ( )
406: Invalid format detected: <rule_uid|binding_uid|comment> - <VALUE> is invalid. Text includes invalid expressions such as HTML tags or command line operations
406: Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP","folder":"2-25","rawModeData":"{\n\t\"rule_modification_field\": {\n\t\t\"devices\": {\n\t\t\t\"device\": {\n\t\t\t\t\"management_id\": 5,\n\t\t\t\t\"bindings\": {\n\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t\"rule_modifications\": {\n\t\t\t\"rule_modification\": {\n\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t},\n\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"uid\": \"551556da-22dc-46f4-9253-a7ceee70394b\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/fields/{{fieldId}}","collectionId":"2","id":"2-25-144","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Change a task of a ticket at the current step","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"raw","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ���add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: ticketTaskDTO
id: Ticket ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4
BODY<task>
    <status>DONE</status>
    <fields/>
</task>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4
BODY{
    \"task\": {
        \"status\": \"ASSIGNED\",
        \"fields\": {
            \"field\": {
                \"@xsi.type\": \"rule_modification_field\",
                \"id\": 743,
                \"devices\": {
                    \"device\": {
                        \"revision_id\": 24,
                        \"management_id\": 5,
                        \"bindings\": {
                            \"binding\": {
                                \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                                \"binding\": {
                                    \"@xsi.type\": \"policy__binding\",
                                    \"policy_name\": \"FortiGate-VM64-111-10_3\"
                                },
                                \"rules\": {
                                    \"rule\": {
                                        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                        \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                                    }
                                }
                            }
                        }
                    }
                },
                \"rule_modifications\": {
                    \"rule_modification\": {
                        \"@xsi.type\": \"modify_rule_modification\",
                        \"rule_key\": {
                            \"device_id\": 5,
                            \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                            \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                        },
                        \"source_modifications\": {
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                    \"name\": \"RANGE_1\",
                                                    \"comment\": \"EXAMPLE_RANGE\",
                                                    \"min_ip\": \"3.3.3.3\",
                                                    \"max_ip\": \"5.5.5.5\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                    \"name\": \"NET_1\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"3.3.3.3\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        },
                        \"destination_modifications\": {
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                    \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"name\": \"Host123\",
                                                    \"comment\": \"cccHost\",
                                                    \"ip\": \"1.2.3.4\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"REMOVE\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                            }
                                        }
                                    }
                                ]
                            }
                        },
                        \"service_modifications\": {
                            \"service_object_cell_modifications\": {
                                \"service_object_cell_modification\": [
                                    {
                                        \"action\": \"REMOVE\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                                \"name\": \"ICMP_1\",
                                                \"comment\": \"EXAMPLE_ICMP\",
                                                \"type\": {
                                                    \"from\": 55,
                                                    \"to\": 55
                                                }
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                \"name\": \"TCP_1\",
                                                \"comment\": \"EXAMPLE_TCP\",
                                                \"port\": {
                                                    \"from\": 1234,
                                                    \"to\": 1234
                                                },
                                                \"protocol\": \"TCP\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                \"name\": \"UDP_1\",
                                                \"comment\": \"EXAMPLE_UDP\",
                                                \"port\": {
                                                    \"from\": 3,
                                                    \"to\": 3
                                                },
                                                \"protocol\": \"UDP\"
                                            }
                                        }
                                    }
                                ]
                            }
                        }
                    }
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Task status does not exist.
400: Task status is not set to ASSIGNED or DONE.
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: There are multiple objects with this name in the network)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
403: You do not have permission to update this task. Contact your administrator for assistance.
403: Task can not be done because there are unlicensed devices for change automation
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: Invalid value for field: <FIELD_NAME> (a valid object comment can have up to <MAX> characters)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value
406: Invalid format detected: <name|binding_uid|rule_uid> - This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags
406: Invalid format detected: name - <VALUE> is invalid. Text must include <1-255> characters
406: Invalid format detected: <rule_uid|binding_uid> - <VALUE> is invalid. Text must include <1-4096> characters
406: Invalid format detected: comment - <VALUE> is invalid. Text must include <0-4096> characters
406: Invalid format detected: name - <VALUE> is invalid. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters + - , _ # @ . : = ! ^ ( )
406: Invalid format detected: <rule_uid|binding_uid|comment> - <VALUE> is invalid. Text includes invalid expressions such as HTML tags or command line operations
406: Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP","folder":"2-25","rawModeData":"{\n\t\"task\": {\n\t\t\"status\": \"ASSIGNED\",\n\t\t\"fields\": {\n\t\t\t\"field\": {\n\t\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\t\"id\": 743,\n\t\t\t\t\"devices\": {\n\t\t\t\t\t\"device\": {\n\t\t\t\t\t\t\"revision_id\": 24,\n\t\t\t\t\t\t\"management_id\": 5,\n\t\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"rule_modifications\": {\n\t\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}","collectionId":"2","id":"2-25-145","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get commands for device from designer results of a specific field id","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"deviceId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
deviceId: Device ID
fieldId: Field ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/designer/device/136/commands

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: Specified field, id: <ID> , name: <NAME>, cannot contain designer result
404: Designer results were not found in the access request.
404: Device with ID <ID> was not found in Designer result.
404: Device with ID <ID> does not support Commands feature.","dataMode":"params","folder":"2-25","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/designer/device/{{deviceId}}/commands","collectionId":"2","id":"2-25-146","method":"GET"},{"headers":"Accept: application/json\n","name":"Returns the details of the tasks","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"}],"dataMode":"params","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks

Response Messages:
403: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.","folder":"2-25","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks","collectionId":"2","id":"2-25-147","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Change multiple fields within a task of a ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"raw","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ���add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldListDTO
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/2/tasks/4/fields
BODY<fields>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_network_object\">
         <id>7885</id>
         <name>n_obj</name>
         <network_object type=\"Object\">
             <object_name>Host_10.1.1.1</object_name>
             <management_name>cp239</management_name>
         </network_object>
         <network_object type=\"Object\">
             <st_uid>{55908141-c341-4990-9cc6-a3fd2dfb49e1}</st_uid>
             <management_id>2</management_id>
         </network_object>
         <network_object type=\"DNS\">
             <host_name>tufin.com</host_name>
         </network_object>
     <field>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_service\">
         <id>7887</id>
         <name>service</name>
         <service type=\"PROTOCOL\">
             <protocol>TCP</protocol>
             <port>80</port>
         </service>
         <service type=\"Object\">
             <object_name>AOL</object_name>
             <management_name>cp239</management_name>
         </service>
     </field>
</fields>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/fields
BODY{
\"fields\": {
\"field\": {
\"@xsi.type\": \"rule_modification_field\",
\"id\": 746,
\"name\": \"rm\",
\"devices\": {
    \"device\": {
    \"revision_id\": 24,
    \"management_id\": 5,
    \"bindings\": {
    \"binding\": {
    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
    \"binding\": {
        \"@xsi.type\": \"policy__binding\",
        \"policy_name\": \"FortiGate-VM64-111-10_3\"
    },
    \"rules\": {
        \"rule\": {
        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
        \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
        }
    }
    }
    }
    }
},
\"rule_modifications\": {
    \"rule_modification\": {
    \"@xsi.type\": \"modify_rule_modification\",
    \"rule_key\": {
    \"device_id\": 5,
    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
    \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
    },
    \"source_modifications\": {
    \"network_object_cell_modifications\": {
    \"network_object_cell_modification\": [
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
            \"name\": \"NET_1\",
            \"comment\": \"\",
            \"ip\": \"3.3.3.3\",
            \"netmask\": \"255.255.255.255\"
        }
        ]
        }
        },
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
            \"name\": \"RANGE_1\",
            \"comment\": \"EXAMPLE_RANGE\",
            \"min_ip\": \"3.3.3.3\",
            \"max_ip\": \"5.5.5.5\"
        }
        ]
        }
        }
    ]
    }
    },
    \"destination_modifications\": {
    \"network_object_cell_modifications\": {
    \"network_object_cell_modification\": [
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
        }
        }
        },
        {
        \"action\": \"REMOVE\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
            \"name\": \"Host123\",
            \"comment\": \"cccHost\",
            \"ip\": \"1.2.3.4\",
            \"netmask\": \"255.255.255.255\"
        }
        ]
        }
        }
    ]
    }
    },
    \"service_modifications\": {
    \"service_object_cell_modifications\": {
    \"service_object_cell_modification\": [
        {
        \"action\": \"REMOVE\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:icmp_service\",
        \"name\": \"ICMP_1\",
        \"comment\": \"EXAMPLE_ICMP\",
        \"type\": {
            \"from\": 55,
            \"to\": 55
        }
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:transport_service\",
        \"name\": \"TCP_1\",
        \"comment\": \"EXAMPLE_TCP\",
        \"port\": {
            \"from\": 1234,
            \"to\": 1234
        },
        \"protocol\": \"TCP\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:transport_service\",
        \"name\": \"UDP_1\",
        \"comment\": \"EXAMPLE_UDP\",
        \"port\": {
            \"from\": 3,
            \"to\": 3
        },
        \"protocol\": \"UDP\"
        }
        }
        }
    ]
    }
    }
    }
}
}
}
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket step does not exist, or is not the current step
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: There are multiple objects with this name in the network)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
403: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (Network Object with device ID <DEVICE_ID> and ST UID <ST_UID> is not available for the action specified. Check the Knowledge Center or API Implementation Notes for more information
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: Invalid value for field: <FIELD_NAME> (a valid object comment can have up to <MAX> characters)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value
406: Invalid format detected: <name|binding_uid|rule_uid> - This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags
406: Invalid format detected: name - <VALUE> is invalid. Text must include <1-255> characters
406: Invalid format detected: <rule_uid|binding_uid> - <VALUE> is invalid. Text must include <1-4096> characters
406: Invalid format detected: comment - <VALUE> is invalid. Text must include <0-4096> characters
406: Invalid format detected: name - <VALUE> is invalid. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters + - , _ # @ . : = ! ^ ( )
406: Invalid format detected: <rule_uid|binding_uid|comment> - <VALUE> is invalid. Text includes invalid expressions such as HTML tags or command line operations
406: Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP","folder":"2-25","rawModeData":"{\n\"fields\": {\n\"field\": {\n\"@xsi.type\": \"rule_modification_field\",\n\"id\": 746,\n\"name\": \"rm\",\n\"devices\": {\n\t\"device\": {\n\t\"revision_id\": 24,\n\t\"management_id\": 5,\n\t\"bindings\": {\n\t\"binding\": {\n\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\"binding\": {\n\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t},\n\t\"rules\": {\n\t\t\"rule\": {\n\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t}\n\t}\n\t}\n\t}\n\t}\n},\n\"rule_modifications\": {\n\t\"rule_modification\": {\n\t\"@xsi.type\": \"modify_rule_modification\",\n\t\"rule_key\": {\n\t\"device_id\": 5,\n\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t},\n\t\"source_modifications\": {\n\t\"network_object_cell_modifications\": {\n\t\"network_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\"name\": \"NET_1\",\n\t\t\t\"comment\": \"\",\n\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t}\n\t\t]\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t}\n\t\t]\n\t\t}\n\t\t}\n\t]\n\t}\n\t},\n\t\"destination_modifications\": {\n\t\"network_object_cell_modifications\": {\n\t\"network_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"REMOVE\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\"name\": \"Host123\",\n\t\t\t\"comment\": \"cccHost\",\n\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t}\n\t\t]\n\t\t}\n\t\t}\n\t]\n\t}\n\t},\n\t\"service_modifications\": {\n\t\"service_object_cell_modifications\": {\n\t\"service_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"REMOVE\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\"name\": \"ICMP_1\",\n\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\"type\": {\n\t\t\t\"from\": 55,\n\t\t\t\"to\": 55\n\t\t}\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\"name\": \"TCP_1\",\n\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\"port\": {\n\t\t\t\"from\": 1234,\n\t\t\t\"to\": 1234\n\t\t},\n\t\t\"protocol\": \"TCP\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\"name\": \"UDP_1\",\n\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\"port\": {\n\t\t\t\"from\": 3,\n\t\t\t\"to\": 3\n\t\t},\n\t\t\"protocol\": \"UDP\"\n\t\t}\n\t\t}\n\t\t}\n\t]\n\t}\n\t}\n\t}\n}\n}\n}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields","collectionId":"2","id":"2-25-148","method":"PUT"},{"headers":"Accept: application/json\n","name":"Returns the details of a the fields","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"params","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
taskId: The ID number of the task as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields

Response Messages:
403: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.
404: Task with ID was not found in Stage ID in ticket ID .","folder":"2-25","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields","collectionId":"2","id":"2-25-149","method":"GET"},{"headers":"Accept: application/json\n","name":"Returns a list of tickets by search parameters","description":"Parameters:
parameter: Free text search parameter (Search syntax details) [optional]
start: Offset the count starting point [optional]
count: Tickets list max length (max value is 1000) [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/free_text_search/?parameter=taskstatus:ASSIGNED AND priority:High

Response Messages:
400: Can not fetch more than 1000 tickets in 1 time
403: Access is denied.
404: Illegal ticket status entered. Permitted values are: IN_PROGRESS, REJECTED, CLOSED, CANCELLED, RESOLVED
404: Illegal ticket SLA status entered. Permitted values are: NA, OK, WARNING, ALERT, ESCALATION
404: Illegal ticket priority entered. Permitted values are: LOW, NORMAL, HIGH, CRITICAL
400: Illegal count value entered. Max value is 1000
404: Illegal ticket expiration date entered. Permitted date format is: ddMMyyyy (ex. 20.11.2001)
404: No entity found for query","folder":"2-25","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/free_text_search","collectionId":"2","id":"2-25-150","method":"GET"},{"headers":"Accept: application/json\n","name":"Get access request verifier results","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/multi_access_request/2022/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.
404: Verifier results were not found in the access request.","dataMode":"params","folder":"2-25","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_access_request/{{fieldId}}/verifier","collectionId":"2","id":"2-25-151","method":"GET"},{"headers":"Accept: application/json\n","name":"Get rule decommision verifier results","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/rule_decommission/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type <TYPE>.
404: Verifier results were not found in the request.","dataMode":"params","folder":"2-25","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/rule_decommission/verifier","collectionId":"2","id":"2-25-152","method":"GET"},{"headers":"Accept: application/json\n","name":"Get server clone policy verifier results","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/clone_server_policy/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.
404: Verifier results were not found in the server clone policy request.","dataMode":"params","folder":"2-25","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/clone_server_policy/verifier","collectionId":"2","id":"2-25-153","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Change the ticket properties","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"raw","description":"Change the ticket properties listed in the TicketPropertiesDTO.
When specifying the notification_group property you must use the ID of the group or leave the ID empty to remove the group. This property can be updated on a closed ticket.
When specifying the referenced_ticket property you must use the ID of the ticket or leave the ID empty to remove the ticket.
When specifying the expiration_date property, you must use a yyyy-mm-dd format, or leave the value empty to remove the expiration date. To ignore the field, do not include it in the request. This property can be updated on a closed ticket.

Parameters:
body: ticketPropertiesDTO
id: The ID number of the ticket as shown in SecureChange

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/ticket_properties
BODY<ticket_properties>
    <referenced_ticket>
        <id>9</id>
    </referenced_ticket>
    <notification_group>
        <id>10</id>
    </notification_group>
    <expiration_date>2022-12-10</expiration_date>
</ticket_properties>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/ticket_properties
BODY<ticket_properties>
    <notification_group>
        <id/>
    </notification_group>
    <referenced_ticket>
        <id/>
    </referenced_ticket>
    <expiration_date/>
</ticket_properties>


Response Messages:
400: Notification Group <ID> is a user and not a user group
400: Notification Group <ID> exceeds the configured maximum allowed number of users for notifications
400: <ID> (���Any User���) is not allowed as a Notification Group
400: Notification Group <ID> does not have permission of 'Group members can perform actions on requests submitted by other members'
400: Notification Group <ID> is not a member in the first step of the workflow
400: Notification Group is not enabled in this workflow
403: You do not have permission to change the Notification Group
404: There is no group with ID <ID>.
404: There is no ticket with ID <ID>.
400: Referenced ticket id cannot be the same as ticket id
400: invalid id format for referenced ticket
400: Cannot update properties [<Property A>, <Property B>] for ticket with status <STATUS>
403: You do not have permission to update this ticket at this stage. Contact your administrator for assistance.
403: The user is not allowed to add the specified referenced ticket.
400: Workflow does not support referenced ticket
400: Cannot delete expiration date on this workflow due to it being a mandatory field
400: Invalid date. Cannot update expiration to a date that has passed
400: Invalid value for field: expiration_date (The date format must be: yyyy-mm-dd)
400: Invalid value for field: expiration_date (The date is not valid)
400: This workflow does not support expiration dates","folder":"2-25","rawModeData":"\n\t\n\t\t\n\t\n\t\n\t\t\n\t\n\t\n","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/ticket_properties","collectionId":"2","id":"2-25-154","method":"PUT"},{"headers":"Content-Type: application/xml\n","name":"Change a field within a task of a ticket","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"dataMode":"raw","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ���add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldDTO
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/2/tasks/4/fields/7742
BODY<field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multiple_selection\">
     <id>7742</id>
     <name>filter type</name>
     <selected_options>
         <selected_option>
             <value>FTP</value>
         </selected_option>
     </selected_options>
</field>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/fields/71
BODY{
    \"rule_modification_field\": {
        \"devices\": {
            \"device\": {
                \"management_id\": 5,
                \"bindings\": {
                    \"binding\": {
                        \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                        \"binding\": {
                            \"@xsi.type\": \"policy__binding\",
                            \"policy_name\": \"FortiGate-VM64-111-10_3\"
                        },
                        \"rules\": {
                            \"rule\": {
                                \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                            }
                        }
                    }
                }
            }
        },
        \"rule_modifications\": {
            \"rule_modification\": {
                \"@xsi.type\": \"modify_rule_modification\",
                \"rule_key\": {
                    \"device_id\": 5,
                    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                    \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                },
                \"source_modifications\": {
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                            \"name\": \"NET_1\",
                                            \"comment\": \"\",
                                            \"ip\": \"3.3.3.3\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                            \"name\": \"RANGE_1\",
                                            \"comment\": \"EXAMPLE_RANGE\",
                                            \"min_ip\": \"3.3.3.3\",
                                            \"max_ip\": \"5.5.5.5\"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                \"destination_modifications\": {
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"name\": \"Host123\",
                                            \"comment\": \"cccHost\",
                                            \"ip\": \"1.2.3.4\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"action\": \"REMOVE\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                    }
                                }
                            }
                        ]
                    }
                },
                \"service_modifications\": {
                    \"service_object_cell_modifications\": {
                        \"service_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                        \"name\": \"TCP_1\",
                                        \"comment\": \"EXAMPLE_TCP\",
                                        \"port\": {
                                            \"from\": 1234,
                                            \"to\": 1234
                                        },
                                        \"protocol\": \"TCP\"
                                    }
                                }
                            },
                            {
                                \"action\": \"REMOVE\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"uid\": \"551556da-22dc-46f4-9253-a7ceee70394b\",
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                        \"name\": \"UDP_1\",
                                        \"comment\": \"EXAMPLE_UDP\",
                                        \"port\": {
                                            \"from\": 3,
                                            \"to\": 3
                                        },
                                        \"protocol\": \"UDP\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                        \"name\": \"ICMP_1\",
                                        \"comment\": \"EXAMPLE_ICMP\",
                                        \"type\": {
                                            \"from\": 55,
                                            \"to\": 55
                                        }
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                    }
                                }
                            }
                        ]
                    }
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket step does not exist, or is not the current step
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: Deleting rule recertification info is not allowed
400: Application Change field cannot be managed via this REST API
400: Rule associated with successfully updated recertification info cannot be removed
400: Rule was already updated
400: Rule does not exist
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: There are multiple objects with this name in the network)
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
403: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: Invalid value for field: <FIELD_NAME> (a valid object comment can have up to <MAX> characters)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value
406: Invalid format detected: <name|binding_uid|rule_uid> - This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags
406: Invalid format detected: name - <VALUE> is invalid. Text must include <1-255> characters
406: Invalid format detected: <rule_uid|binding_uid> - <VALUE> is invalid. Text must include <1-4096> characters
406: Invalid format detected: comment - <VALUE> is invalid. Text must include <0-4096> characters
406: Invalid format detected: name - <VALUE> is invalid. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters + - , _ # @ . : = ! ^ ( )
406: Invalid format detected: <rule_uid|binding_uid|comment> - <VALUE> is invalid. Text includes invalid expressions such as HTML tags or command line operations
406: Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP","folder":"2-25","rawModeData":"{\n\t\"rule_modification_field\": {\n\t\t\"devices\": {\n\t\t\t\"device\": {\n\t\t\t\t\"management_id\": 5,\n\t\t\t\t\"bindings\": {\n\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t\"rule_modifications\": {\n\t\t\t\"rule_modification\": {\n\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t},\n\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"uid\": \"551556da-22dc-46f4-9253-a7ceee70394b\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}","collectionId":"2","id":"2-25-155","method":"PUT"},{"headers":"Accept: application/json\n","name":"Returns the details of a specified field","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"}],"dataMode":"params","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
taskId: The ID number of the task as shown in SecureChange
fieldId: The ID number of the field as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/229

Response Messages:
403: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.
404: Task with ID was not found in Stage ID in ticket ID .
404: Field ID was not found in Task ID in Stage ID in ticket ID .","folder":"2-25","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}","collectionId":"2","id":"2-25-156","method":"GET"},{"headers":"Accept: application/json\n","name":"Returns a list of tickets by search parameters","description":"If the query is succesful but no results are found (for example, if there is no ticket for the specified Ticket ID) then the return code will be 200 and the results will be empty.

Parameters:
id: The ID number of the ticket as shown in SecureChange [optional]
subject: The subject of the ticket [optional]
requester: The requester of the ticket [optional]
group: The group handling the ticket [optional]
assigned_to: The user name of the person assigned to the ticket [optional]
priority: The priority of the ticket [optional]
status: The status of the ticket [optional]
sla_status: The SLA status of the ticket [optional]
field_name: Field name to search by [optional]
field_value: Field value to search by [optional]
current_step: Current step name [optional]
expiration_date_from: Search requests with expiration date from this date [optional]
expiration_date_to: Search requests with expiration date until this date [optional]
domain_name: The Domain of the ticket [optional]
start: Offset the count starting point [optional]
count: Ticket list length [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/search?id=1&status=IN_PROGRESS,REJECTED

Response Messages:
403: Access is denied.
400: Illegal ticket status entered. Permitted values are: IN_PROGRESS, REJECTED, CLOSED, CANCELLED, RESOLVED, WAITING_TO_BE_ASSIGNED, ASSIGNED, WAITING_FOR_MORE_INFO, DONE, INVALID, PENDING, PENDING_LICENS
400: Illegal ticket SLA status entered. Permitted values are: NA, OK, WARNING, ALERT, ESCALATION
400: Illegal ticket priority entered. Permitted values are: LOW, NORMAL, HIGH, CRITICAL
400: Illegal ticket expiration date entered. Permitted date format is: ddMMyyyy (ex. 20.11.2001)
400: Cannot find specified domain <DOMAIN_NAME>","folder":"2-25","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/search","collectionId":"2","id":"2-25-157","method":"GET"},{"headers":"Accept: application/json\n","name":"Returns the results of the Commit action","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"stepId"},{"value":null,"type":"text","enabled":true,"key":"taskId"},{"value":null,"type":"text","enabled":true,"key":"fieldId"},{"value":null,"type":"text","enabled":true,"key":"managementId"}],"dataMode":"params","description":"GENERAL USE
The report returns the Commit results for the device with the specified management ID and for the devices suggested in the Designer results. The report also includes results for devices that are in the related hierarchy of these devices.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID
managementId: Management ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/designer/commit_report/3
OUTPUT{
    \"commit_report\": {
        \"ticketId\": 27,
        \"statTime\": \"24-Oct-2018 08:55 AM\",
        \"endTime\": \"24-Oct-2018 08:56 AM\",
        \"duration\": \"00:00:30\",
        \"vendorName\": \"PALO ALTO NETWORKS\",
        \"managmentName\": \"pano211\",
        \"devices\": {
            \"device\": [
                {
                    \"name\": \"DG1.1\",
                    \"status\": \"success_with_warnings\",
                    \"warnings\": {
                        \"warning\": \"Commit not performed: This device had no policies to install on its managed firewalls\"
                    },
                    \"policies\": \"\"
                },
                {
                    \"name\": \"DG1\",
                    \"status\": \"success_with_warnings\",
                    \"warnings\": {
                        \"warning\": \"Commit not performed: This device had no policies to install on its managed firewalls\"
                    },
                    \"policies\": \"\"
                }
            ]
        }
    }
}


Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: Specified field, id: <ID> , name: <NAME>, cannot contain designer result
404: Designer results were not found in the request.","folder":"2-25","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/designer/commit_report/{{managementId}}","collectionId":"2","id":"2-25-158","method":"GET"},{"headers":"Accept: application/json\n","name":"Returns the details of a specified ticket stages","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps

Response Messages:
403: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found","folder":"2-25","url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps","collectionId":"2","id":"2-25-159","method":"GET"}],"order":[],"name":"Tufin Tufin SecureChange/SecureApp R21-1-RC1","id":"2","description":"Tufin Orchestration Suite - Tufin SecureChange/SecureApp APIs.
For detailed information about the APIs please see the documentation at:
https://your-securetrack-server/securechangeworkflow/apidoc"} \ No newline at end of file diff --git a/Postman Format v1/R21-1 postman collection/securetrack_R21-1-RC1.json b/Postman Format v1/R21-1 postman collection/securetrack_R21-1-RC1.json new file mode 100644 index 0000000..8a24167 --- /dev/null +++ b/Postman Format v1/R21-1 postman collection/securetrack_R21-1-RC1.json @@ -0,0 +1 @@ +{"folders":[{"order":["1-1-1","1-1-2","1-1-3","1-1-4"],"collectionId":"1","name":"Additional Policy Fields","hasRequests":true,"id":"1-1"},{"order":["1-2-5","1-2-6","1-2-7","1-2-8"],"collectionId":"1","name":"Application IDs","hasRequests":true,"id":"1-2"},{"order":["1-3-9","1-3-10"],"collectionId":"1","name":"Change Authorization","hasRequests":true,"id":"1-3"},{"order":["1-4-11","1-4-12","1-4-13"],"collectionId":"1","name":"Change Windows","hasRequests":true,"id":"1-4"},{"order":["1-5-14","1-5-15","1-5-16","1-5-17","1-5-18"],"collectionId":"1","name":"Device Interfaces and Zones","hasRequests":true,"id":"1-5"},{"order":["1-6-19","1-6-20","1-6-21","1-6-22"],"collectionId":"1","name":"Domains","hasRequests":true,"id":"1-6"},{"order":["1-7-23"],"collectionId":"1","name":"General Properties","hasRequests":true,"id":"1-7"},{"order":["1-8-24","1-8-25","1-8-26","1-8-27"],"collectionId":"1","name":"IPsec VPN","hasRequests":true,"id":"1-8"},{"order":["1-9-28","1-9-29","1-9-30","1-9-31","1-9-32"],"collectionId":"1","name":"Internet Objects","hasRequests":true,"id":"1-9"},{"order":["1-10-33","1-10-34","1-10-35","1-10-36"],"collectionId":"1","name":"LDAP","hasRequests":true,"id":"1-10"},{"order":["1-11-37","1-11-38","1-11-39","1-11-40","1-11-41","1-11-42","1-11-43","1-11-44","1-11-45","1-11-46","1-11-47"],"collectionId":"1","name":"Monitored Devices","hasRequests":true,"id":"1-11"},{"order":["1-12-48","1-12-49","1-12-50"],"collectionId":"1","name":"NAT Policies","hasRequests":true,"id":"1-12"},{"order":["1-13-51","1-13-52","1-13-53","1-13-54","1-13-55","1-13-56","1-13-57"],"collectionId":"1","name":"Network Objects","hasRequests":true,"id":"1-13"},{"order":["1-14-58","1-14-59","1-14-60","1-14-61","1-14-62","1-14-63","1-14-64","1-14-65","1-14-66","1-14-67","1-14-68","1-14-69","1-14-70","1-14-71","1-14-72","1-14-73","1-14-74","1-14-75","1-14-76","1-14-77","1-14-78","1-14-79","1-14-80","1-14-81","1-14-82","1-14-83","1-14-84","1-14-85","1-14-86","1-14-87","1-14-88","1-14-89","1-14-90","1-14-91","1-14-92","1-14-93","1-14-94","1-14-95","1-14-96","1-14-97","1-14-98","1-14-99","1-14-100","1-14-101","1-14-102","1-14-103","1-14-104","1-14-105","1-14-106","1-14-107","1-14-108","1-14-109","1-14-110","1-14-111","1-14-112","1-14-113","1-14-114","1-14-115","1-14-116"],"collectionId":"1","name":"Network Topology","hasRequests":true,"id":"1-14"},{"order":["1-15-117","1-15-118","1-15-119"],"collectionId":"1","name":"Network Zone Manager - Patterns","hasRequests":true,"id":"1-15"},{"order":["1-16-120","1-16-121","1-16-122","1-16-123","1-16-124","1-16-125","1-16-126"],"collectionId":"1","name":"Network Zone Manager - Subnets","hasRequests":true,"id":"1-16"},{"order":["1-17-127","1-17-128","1-17-129","1-17-130","1-17-131","1-17-132","1-17-133","1-17-134","1-17-135","1-17-136","1-17-137","1-17-138","1-17-139","1-17-140","1-17-141","1-17-142"],"collectionId":"1","name":"Network Zone Manager - Zones","hasRequests":true,"id":"1-17"},{"order":["1-18-143","1-18-144","1-18-145","1-18-146","1-18-147","1-18-148"],"collectionId":"1","name":"Policies and Sub-Policies","hasRequests":true,"id":"1-18"},{"order":["1-19-149"],"collectionId":"1","name":"Policy Analysis","hasRequests":true,"id":"1-19"},{"order":["1-20-150","1-20-151","1-20-152","1-20-153","1-20-154","1-20-155"],"collectionId":"1","name":"Policy Browser (formerly Rule Documentation)","hasRequests":true,"id":"1-20"},{"order":["1-21-156","1-21-157","1-21-158","1-21-159","1-21-160","1-21-161","1-21-162","1-21-163"],"collectionId":"1","name":"Policy Optimization","hasRequests":true,"id":"1-21"},{"order":["1-22-164","1-22-165","1-22-166"],"collectionId":"1","name":"Revisions","hasRequests":true,"id":"1-22"},{"order":["1-23-167","1-23-168"],"collectionId":"1","name":"Rule Usage","hasRequests":true,"id":"1-23"},{"order":["1-24-169","1-24-170","1-24-171","1-24-172","1-24-173","1-24-174","1-24-175","1-24-176"],"collectionId":"1","name":"Security Rules","hasRequests":true,"id":"1-24"},{"order":["1-25-177","1-25-178","1-25-179","1-25-180","1-25-181","1-25-182","1-25-183"],"collectionId":"1","name":"Services and Ports","hasRequests":true,"id":"1-25"},{"order":["1-26-184","1-26-185","1-26-186"],"collectionId":"1","name":"Time Objects","hasRequests":true,"id":"1-26"},{"order":["1-27-187"],"collectionId":"1","name":"Traffic Policy Matcher","hasRequests":true,"id":"1-27"},{"order":["1-28-188","1-28-189","1-28-190","1-28-191","1-28-192"],"collectionId":"1","name":"Unified Security Policy - Access Request Violations","hasRequests":true,"id":"1-28"},{"order":["1-29-193","1-29-194","1-29-195","1-29-196","1-29-197"],"collectionId":"1","name":"Unified Security Policy - Alerts","hasRequests":true,"id":"1-29"},{"order":["1-30-198","1-30-199","1-30-200","1-30-201","1-30-202","1-30-203","1-30-204","1-30-205"],"collectionId":"1","name":"Unified Security Policy - Cloud Tag Policy","hasRequests":true,"id":"1-30"},{"order":["1-31-206","1-31-207","1-31-208","1-31-209","1-31-210","1-31-211","1-31-212","1-31-213"],"collectionId":"1","name":"Unified Security Policy - Exceptions","hasRequests":true,"id":"1-31"},{"order":["1-32-214","1-32-215","1-32-216","1-32-217","1-32-218","1-32-219"],"collectionId":"1","name":"Unified Security Policy - Security Zone Matrix","hasRequests":true,"id":"1-32"},{"order":["1-33-220","1-33-221"],"collectionId":"1","name":"Unified Security Policy - Violations","hasRequests":true,"id":"1-33"}],"requests":[{"headers":"Accept: application/json\n","name":"Get all URL Categories by revision.","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"}],"dataMode":"params","description":"Fetches list of URL Categories defined in a revision given by ID.
This API is supported for Panorama in advanced mode and Panorama Device Groups.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/762/url_categories
","folder":"1-1","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/url_categories","collectionId":"1","id":"1-1-1","method":"GET"},{"headers":"Accept: application/json\n","name":"Get additional parameters identities by revision","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"}],"dataMode":"params","description":"Some firewall vendors use special fields in their security policy.
For example: Palo Alto uses Tags, Security Profiles and Log Profiles and Fortinet uses NAT Pools and other NAT configurations.
SecureTrack refers to these fields as “Additional Parameters”.
The additional parameters API retrieves the possible values of these fields.
This API is currently supported for Palo Alto Networks firewalls and Fortinet devices managed by Fortimanager.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
type: Additional parameter type [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/162/additional_parameters?type=security_profile_group

Response Messages:
200: Successful
400: Invalid request","folder":"1-1","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/additional_parameters","collectionId":"1","id":"1-1-2","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific additional parameter identity","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Some firewall vendors use special fields in their security policy.
For example: Palo Alto uses Tags, Security Profiles and Log Profiles and Fortinet uses NAT Pools and other NAT configurations.
SecureTrack refers to these fields as “Additional Parameters”.
The additional parameters API retrieves the possible values of these fields.
This API is currently supported for Palo Alto Networks firewalls and Fortinet devices managed by Fortimanager.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Additional parameter IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/revisions/162/additional_parameters/242767,242768,242760
","folder":"1-1","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/additional_parameters/{{ids}}","collectionId":"1","id":"1-1-3","method":"GET"},{"headers":"Accept: application/json\n","name":"Get a URL Category.","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches one or more URL Categories.
This API is supported for Panorama in advanced mode and Panorama Device Groups.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Url Category IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/revisions/762/url_categories/242767,242768,242760
","folder":"1-1","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/url_categories/{{ids}}","collectionId":"1","id":"1-1-4","method":"GET"},{"headers":"Accept: application/json\n","name":"Get applications identities by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of applications defined in a revision given by ID.
This API is currently supported for Palo Alto Networks firewalls.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.
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.


Parameters:
context: Global MSSP context [optional]
id: Revision id
start: Starting page for query allowable value is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/762/applications?get_total=true
OUTPUT {
    \"applications\": {
        \"count\": 1,
        \"total\": 100,
        \"application\": [{
            \"@xsi.type\": \"singleApplicationDTO\",
            \"id\": 2095027,
            \"name\": \"any\",
            \"display_name\": \"any\",
            \"class_name\": \"application_object\",
            \"comment\": \"\",
            \"uid\": \"{61B7771C-8B0B-90D6-ED55-B6698691BEED}\",
            \"overrides\": false,
            \"service\": {
                \"id\": 5048925,
                \"uid\": \"{4BC8F8B5-7671-A61B-5DD2-8CA235955162}\",
                \"display_name\": \"any\",
                \"name\": \"any\"
            }
        }]
    }
}

","folder":"1-2","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/applications","collectionId":"1","id":"1-2-5","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific application identity","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches one or more applications defined by a revision ID and Application Id or comma separated applications ids list.
This API is currently supported for Palo Alto Networks firewalls.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.


Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Application IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/revisions/762/applications/242767,242768,242760
","folder":"1-2","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/applications/{{ids}}","collectionId":"1","id":"1-2-6","method":"GET"},{"headers":"Accept: application/json\n","name":"Get application identities by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of applications defined on device given by ID.
This API is currently supported for Palo Alto Networks firewalls.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.
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.


Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable values are numeric [optional]
count: Number of pages for query allowable values are numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/applications?get_total=true
OUTPUT {
    \"applications\": {
        \"count\": 50,
        \"total\": 100,
        \"application\": [{
            \"@xsi.type\": \"singleApplicationDTO\",
            \"id\": 2095027,
            \"name\": \"any\",
            \"display_name\": \"any\",
            \"class_name\": \"application_object\",
            \"comment\": \"\",
            \"uid\": \"{61B7771C-8B0B-90D6-ED55-B6698691BEED}\",
            \"overrides\": false,
            \"service\": {
                \"id\": 5048925,
                \"uid\": \"{4BC8F8B5-7671-A61B-5DD2-8CA235955162}\",
                \"display_name\": \"any\",
                \"name\": \"any\"
            }
        }]
    }
}

","folder":"1-2","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/applications","collectionId":"1","id":"1-2-7","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific application identity","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches one or more applications defined by a device ID and Application Id or comma separated applications ids list.
This API is currently supported for Palo Alto Networks firewalls.
Note: This API retrieves the information from the latest revision.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.


Parameters:
context: Global MSSP context [optional]
id: Device ID
ids: Application IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/devices/1/applications/701
","folder":"1-2","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/applications/{{ids}}","collectionId":"1","id":"1-2-8","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Compare revisions on two different devices in terms of traffic.","dataMode":"raw","description":"This API compares two arbitrary revisions from any devices. The comparison will be done in terms of allowed/denied traffic.
The API returns authorized if and only if there are no differences between the traffic allowed/denied by the rules in the two revisions.
The API returns unauthorized if there is at least one difference in terms of allowed/denied traffic between the two revisions.
Note 1: To map policies from one revision to the other use oldId2newIdMap and provide the UIDs of the policies to be compared.
Note 2: Parameter in the request body specifies if the result will return traffic difference details for all incompatible rules
Note 3: The format of the result is the same as the one returned by /change_authorization
Note 4: The API accepts in request body only one pair of oldId - newId map
Note 5: The request is valid only if the mapping ids are found in the active policies

Parameters:
body: Request parameter containing the versions of the revisions to be compared and the policy mapping between the revisions.

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_authorization/policyTrafficComparison
BODY{
    \"policy_traffic_comparison_request\": {
        \"oldVersionId\": \"234\",
        \"newVersionId\": \"179\",
        \"oldId2newIdMap\": [
            {
                \"oldId\": \"{037DEA62-A8D2-46F5-8DC9-DA404A60B96F}\",
                \"newId\" : \"{00-FACED0-00}\"
            }
        ],
        \"withTraffic\": true
    }
}


Response Messages:
200: Policies diff was successfully calculated
400: Could not find the requested revisions for comparison","folder":"1-3","rawModeData":"{\n\t\"policy_traffic_comparison_request\": {\n\t\t\"oldVersionId\": \"234\",\n\t\t\"newVersionId\": \"179\",\n\t\t\"oldId2newIdMap\": [\n\t\t\t{\n\t\t\t\t\"oldId\": \"{037DEA62-A8D2-46F5-8DC9-DA404A60B96F}\",\n\t\t\t\t\"newId\" : \"{00-FACED0-00}\"\n\t\t\t}\n\t\t],\n\t\t\"withTraffic\": true\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/change_authorization/policyTrafficComparison","collectionId":"1","id":"1-3-9","method":"POST"},{"headers":"Accept: application/json\n","name":"Determine if changes between two revisions are authorized","data":[{"value":null,"type":"text","enabled":true,"key":"new_version"},{"value":null,"type":"text","enabled":true,"key":"old_version"}],"dataMode":"params","description":"This API checks for unauthorized changes between any two versions of a firewall policy.
The API returns authorized if and only if all traffic changes between the two versions were authorized by SecureChange tickets.
The API returns unauthorized if there is at least one change that cannot be matched to a SecureChange ticket.

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).
The API returns the authorization status, the relevant tickets in SecureChange and the rules that implement unauthorized access changes.

Note 1: To use this API you must enable “Authorize Revisions with Tickets” in SecureTrack/Configuration/Ticketing.
Note 2: Use the ID returned by the /revisions API for new_version and old_version.
Note 3: The default value for traffic_details and ignore_tickets is false.
Note 4: Traffic that is handled by an implicit rule will not have a rule ID.

Parameters:
new_version: New version ID
old_version: Old version ID
traffic_details: Return unauthorized traffic change details for all modified rules [optional]
ignore_tickets: Ignore SecureChange tickets and consider all traffic changes unauthorized [optional]

Usage Example
https://192.168.1.1/securetrack/api/change_authorization?old_version=1&new_version=2

Usage Example
https://192.168.1.1/securetrack/api/change_authorization?old_version=1&new_version=2&traffic_details=true&ignore_tickets=true

Response Messages:
200: Change authorization has been successfully calculated
400: Input parameters are not valid
400: Could not find the requested revisions for comparison","folder":"1-3","url":"https://{{SecureTrack_IP}}/securetrack/api/change_authorization/","collectionId":"1","id":"1-3-10","method":"GET"},{"headers":"Accept: application/json\n","name":"Get scheduling and device details for a specific change window","data":[{"value":null,"type":"text","enabled":true,"key":"uid"},{"value":null,"type":"text","enabled":true,"key":"task_id"}],"dataMode":"params","description":"Retrieves scheduling and device details for a specific change window.

Parameters:
context: Global MSSP context [optional]
uid: Change window uuid
task_id: Task Id

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_windows/fc7b167c-29ea-49a1-9ee3-efb6d1351343/tasks/1
OUTPUT {
    \"commit_task\": {
        \"id\": 1,
        \"start_date\": \"04-Nov-2018 01:30:00PM +0200\",
        \"end_date\": \"04-Nov-2018 01:32:01PM +0200\",
        \"errors\": \"\",
        \"device_commits\": {
            \"device_commit\": [
                {
                    \"id\": 1,
                    \"result\": {
                        \"errors\": {
                            \"error\": \"got_error_from_dcs\"
                        },
                        \"device\": {
                            \"id\": 17,
                            \"status\": \"FAILURE\",
                            \"revision_id\": 1,
                            \"errors\": {
                                \"error\": \"Login error\"
                            }
                        }
                    }
                },
                {
                    \"id\": 2,
                    \"result\": {
                        \"errors\": \"\",
                        \"device\": {
                            \"id\": 19,
                            \"status\": \"SUCCESS_WITH_WARNINGS\",
                            \"revision_id\": 1,
                            \"warnings\": {
                                \"warning\": \"Commit not performed: This device had no policies to install on its managed firewalls\"
                            }
                        }
                    }
                }
            ]
        }
    }
}


Response Messages:
200: OK
400: For correct pagination provide a value for the start and count parameters
400: Start parameter must be a non-negative value
400: Count parameter must be a positive value
403: Not permitted to access this context
404: Change window with uuid was not found
404: Change window with uuid was not found in domain
404: Fail to find task for change window ","folder":"1-4","url":"https://{{SecureTrack_IP}}/securetrack/api/change_windows/{{uid}}/tasks/{{task_id}}","collectionId":"1","id":"1-4-11","method":"GET"},{"headers":"Accept: application/json\n","name":"Get a list of completed policy changes for a specific change window","data":[{"value":null,"type":"text","enabled":true,"key":"uid"}],"dataMode":"params","description":"Retrieves a list of completed policy changes for a specific change window.
For valid pagination, both start and count should be provided. Otherwise, pagination is turned off.
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.


Parameters:
context: Global MSSP context [optional]
uid: Change window uuid
start: Starting result for query allowable value is numeric [optional]
count: Number of tasks for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_windows/fc7b167c-29ea-49a1-9ee3-efb6d1351343/tasks?start=0&count=50&get_total=true
OUTPUT {
    \"commit_tasks\": {
        \"count\": 1,
        \"total\": 1,
        \"commit_task\": {
            \"id\": 1,
            \"start_date\": \"04-Nov-2018 01:30:00PM +0200\",
            \"end_date\": \"04-Nov-2018 01:32:01PM +0200\",
            \"errors\": \"\"
        }
    }
}


Response Messages:
200: OK
400: For correct pagination provide a value for the start and count parameters
400: Start parameter must be a non-negative value
400: Count parameter must be a positive value
403: Not permitted to access this context
404: Change window with uuid was not found
404: Change window with uuid was not found in domain ","folder":"1-4","url":"https://{{SecureTrack_IP}}/securetrack/api/change_windows/{{uid}}/tasks","collectionId":"1","id":"1-4-12","method":"GET"},{"headers":"Accept: application/json\n","name":"Get name and status for all change windows","description":"Retrieves a list of all change windows.
For valid pagination, both start and count should be provided. Otherwise, pagination is turned off.
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.


Parameters:
context: Global MSSP context [optional]
start: Starting result for query allowable value is numeric [optional]
count: Number of change windows for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_windows?start=0&count=50&get_total=true
OUTPUT {
    \"change_windows\": {
        \"count\": 2,
        \"total\": 2,
        \"change_window\": [
            {
                \"uuid\": \"6ae41504-a95c-4f23-98a2-f18b2efadb9d\",
                \"name\": \"cw1\",
                \"domain_id\": 1,
                \"enabled\": true
            },
            {
                \"uuid\": \"fc7b167c-29ea-49a1-9ee3-efb6d1351343\",
                \"name\": \"cw2\",
                \"domain_id\": 1,
                \"enabled\": true
            }
        ]
    }
}


Response Messages:
200: OK
400: For correct pagination provide a value for the start and count parameters
400: Start parameter must be a non-negative value
400: Count parameter must be a positive value
403: Not permitted to access this context ","folder":"1-4","url":"https://{{SecureTrack_IP}}/securetrack/api/change_windows/","collectionId":"1","id":"1-4-13","method":"GET"},{"headers":"Accept: application/json\n","name":"Get device zones by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns a list of the zones for the specified Juniper, Stonesoft, Fortinet or Palo Alto Networks device.
Note: this API returns device zones, not Tufin zones.

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/104/zones
","folder":"1-5","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/zones","collectionId":"1","id":"1-5-14","method":"GET"},{"headers":"Accept: application/json\n","name":"Get device zones by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns a list of the zones for the specified Juniper, Stonesoft, Fortinet or Palo Alto Networks revision.
Note: this API returns device zones, not Tufin zones.

Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/787/zones
","folder":"1-5","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/zones","collectionId":"1","id":"1-5-15","method":"GET"},{"headers":"Accept: application/json\n","name":"Get network interfaces by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Reflects static data from the running-config.
For dynamic information see the /topology_interfaces API.
This API is not applicable for Check Point.

Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/227/interfaces
","folder":"1-5","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/interfaces","collectionId":"1","id":"1-5-16","method":"GET"},{"headers":"Accept: application/json\n","name":"Get zones and network interfaces that participate in sub-policies","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/104/bindable_objects
","dataMode":"params","folder":"1-5","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/bindable_objects","collectionId":"1","id":"1-5-17","method":"GET"},{"headers":"Accept: application/json\n","name":"Get network interfaces by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Reflects static data from the running-config.
For dynamic information see the /topology_interfaces API.
This API is not applicable for Check Point.

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/10/interfaces
","folder":"1-5","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/interfaces","collectionId":"1","id":"1-5-18","method":"GET"},{"headers":"Accept: application/json\n","name":"Get all domains","description":"

Usage Example
https://192.168.1.1/securetrack/api/domains

Response Messages:
403: User not permitted to access domains","folder":"1-6","url":"https://{{SecureTrack_IP}}/securetrack/api/domains/","collectionId":"1","id":"1-6-19","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Add a domain","dataMode":"raw","description":"Parameters:
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/domains
BODY{
    \"domain\": {
        \"name\": \"domain1\",
        \"address\": \"address\",
        \"description\": \"description\"
    }
}


Response Messages:
403: User not permitted to access domains
400: Domain with this name already exists
400: Domain name is empty","folder":"1-6","rawModeData":"{\n\t\"domain\": {\n\t\t\"name\": \"domain1\",\n\t\t\"address\": \"address\",\n\t\t\"description\": \"description\"\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/domains/","collectionId":"1","id":"1-6-20","method":"POST"},{"headers":"Accept: application/json\n","name":"Get domain","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
context: Global MSSP context [optional]
id: Domain id

Usage Example
https://192.168.1.1/securetrack/api/domains/1

Response Messages:
403: User not permitted to access domains
400: Domain with ID was not found","dataMode":"params","folder":"1-6","url":"https://{{SecureTrack_IP}}/securetrack/api/domains/{{id}}","collectionId":"1","id":"1-6-21","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Update a domain","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
id: Domain id
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/domains/2
BODY{
    \"domain\": {
        \"name\": \"edited name\",
        \"address\": \"edited address\",
        \"description\": \"edited description\"
    }
}


Response Messages:
403: User not permitted to access domains
400: Domain with ID was not found
400: Domain with this name already exists
400: Domain name is empty
400: Default domain cannot be changed","dataMode":"raw","folder":"1-6","rawModeData":"{\n\t\"domain\": {\n\t\t\"name\": \"edited name\",\n\t\t\"address\": \"edited address\",\n\t\t\"description\": \"edited description\"\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/domains/{{id}}","collectionId":"1","id":"1-6-22","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get general properties","description":"This API requires 'Super admin' privileges



Usage Example
URLhttps://192.168.1.1/securetrack/api/properties
OUTPUT{
    \"properties\": {
        \"sc_addresses\": {
            \"sc_address\": [
                {
                    \"ip_address\": \"127.0.0.1\",
                    \"type\": \"external\"
                },
                {
                    \"ip_address\": \"127.0.0.1\",
                    \"type\": \"internal\"
                }
            ]
        }
    }
}


Response Messages:
403: User not permitted to view properties","folder":"1-7","url":"https://{{SecureTrack_IP}}/securetrack/api/properties/","collectionId":"1","id":"1-7-23","method":"GET"},{"headers":"Accept: application/json\n","name":"Get Check Point VPN (IPSec) communities and gateways","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"}],"dataMode":"params","description":"Get Check Point VPN (IPSec) Communities and gateways that partcipant in those communities.
Works on clusters and gateways, not on management servers.

Parameters:
device_id: The unique identifier of target device

Usage Example
https://192.168.1.1/securetrack/api/bindings/20/ipsec_communities
","folder":"1-8","url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/ipsec_communities","collectionId":"1","id":"1-8-24","method":"GET"},{"headers":"Accept: application/json\n","name":"Get Cisco IPsec policy and peers","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"outputInterfaceName"}],"dataMode":"params","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.
You can retrieve the interface names by calling the /devices/id/interfaces API.

Parameters:
device_id: The unique identifier of target device
outputInterfaceName: Interface name

Usage Example
https://192.168.1.1/securetrack/api/bindings/32/ipsec_tunnels?outputInterfaceName=GigabitEthernet1
","folder":"1-8","url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/ipsec_tunnels","collectionId":"1","id":"1-8-25","method":"GET"},{"headers":"Accept: application/json\n","name":"Get Cisco cryptographic maps by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://191.168.1.1/securetrack/api/revisions/18/crypto_maps
","dataMode":"params","folder":"1-8","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/crypto_maps","collectionId":"1","id":"1-8-26","method":"GET"},{"headers":"Accept: application/json\n","name":"Get Cisco cryptographic maps by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"description":"Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/19/crypto_maps
","dataMode":"params","folder":"1-8","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/crypto_maps","collectionId":"1","id":"1-8-27","method":"GET"},{"name":"Get resolved Internet representation for device","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"}],"dataMode":"params","description":"The order of precedence used to resolve the Internet object is:
Step 1: Identify the Internet referral:
Search for a defined Internet referral on the specified device.
If it is not found on the device, search the parent and grandparents (up the device tree) for a defined Internet referral.
If a defined Internet referral is found, then match the name in the Internet referral to a network object, as defined in Step 2.
If an Internet referral is not found, it resolves to “Any”.
Step 2: Resolve the object by name:
Search the specified device for a defined network object that matches the name returned in Step 1.
If a matching network object is not found, an error will be returned.

Parameters:
deviceId: SecureTrack Device ID

Usage Example
https://192.168.1.1/securetrack/api/internet_referral/2/object

Response Messages:
200: Resolved Internet referral object for device is returned
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
404: Configured object was not found on the device
403: Access is denied.","folder":"1-9","url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}/object","collectionId":"1","id":"1-9-28","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Update Internet representation for device","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"}],"dataMode":"raw","description":"Updates the Internet referral configuration for the device.
If there was no previous configuration, it will be created.

Parameters:
deviceId: SecureTrack Device ID
body: Internet referral configuration

Usage Example
URLhttps://192.168.1.1/securetrack/api/internet_referral
BODY{
    \"internet_referral\": {
        \"@xsi.type\": \"internetReferralObjectNameDTO\",
        \"device_id\": 2,
        \"object_name\": \"Host_10.11.73.1\"
    }
}


Response Messages:
200: Internet referral configuration was updated
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
400: Internet referral configuration was malformed
403: Access is denied.","folder":"1-9","rawModeData":"{\n\t\"internet_referral\": {\n\t\t\"@xsi.type\": \"internetReferralObjectNameDTO\",\n\t\t\"device_id\": 2,\n\t\t\"object_name\": \"Host_10.11.73.1\"\n\t}\n}\n","url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}","collectionId":"1","id":"1-9-29","method":"PUT"},{"name":"Get Internet representation for device","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"}],"description":"Parameters:
deviceId: SecureTrack Device ID

Usage Example
https://192.168.1.1/securetrack/api/internet_referral/2

Response Messages:
200: Internet referral configuration is returned
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
404: Internet referral configuration was not found for device ID
403: Access is denied.","dataMode":"params","folder":"1-9","url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}","collectionId":"1","id":"1-9-30","method":"GET"},{"name":"Delete Internet representation for device","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"}],"description":"Parameters:
deviceId: SecureTrack Device ID

Usage Example
https://192.168.1.1/securetrack/api/internet_referral/2

Response Messages:
200: Internet referral configuration was deleted
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
400: Internet referral configuration for device ID does not exist
403: Access is denied.","dataMode":"params","folder":"1-9","url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}","collectionId":"1","id":"1-9-31","method":"DELETE"},{"headers":"Content-Type: application/json\n","name":"Create new Internet representation for a device","dataMode":"raw","description":"The internet referral lets you represent the Internet as an object on a device.
See REST API: /internet_referral/{deviceId:[0-9]+}/object for a description of how internet referral is resolved.

Parameters:
body: Internet referral configuration

Usage Example
URLhttps://192.168.1.1/securetrack/api/internet_referral
BODY{
    \"internet_referral\": {
        \"@xsi.type\": \"internetReferralObjectNameDTO\",
        \"device_id\": 2,
        \"object_name\": \"Host_2.2.2.2\"
    }
}


Response Messages:
201: Internet referral configuration was created
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
400: Internet referral configuration was malformed
400: Internet referral configuration for given device ID already exists
403: Access is denied.","folder":"1-9","rawModeData":"{\n\t\"internet_referral\": {\n\t\t\"@xsi.type\": \"internetReferralObjectNameDTO\",\n\t\t\"device_id\": 2,\n\t\t\"object_name\": \"Host_2.2.2.2\"\n\t}\n}\n","url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/","collectionId":"1","id":"1-9-32","method":"POST"},{"headers":"Accept: application/json\n","name":"Get LDAP entry details by DN","data":[{"value":null,"type":"text","enabled":true,"key":"dn"}],"dataMode":"params","description":"Returns the UID, DN and Name of a LDAP entry specified by the DN.

Parameters:
dn: LDAP DN

Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/getEntryByDN?dn=CN=Manufacturing,OU=RSA_Demo,DC=tufintest,DC=com
OUTPUT{
    \"ldap_entry\": {
        \"uid\": \"mYbWQms7p0q5YinEyW5Byw==\",
        \"dn\": \"CN=Manufacturing,OU=RSA_Demo,DC=tufintest,DC=com\",
        \"name\": \"Manufacturing\"
    }
}


Response Messages:
200: OK
400: Invalid DN format
404: Entry matching the DN cannot be found
501: LDAP server is not configured
503: No connection to LDAP server","folder":"1-10","url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/getEntryByDN","collectionId":"1","id":"1-10-33","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Return entries that exactly match one of the given strings","dataMode":"raw","description":"Return list of LDAP entries which match the exact given multiple search_text.

Parameters:
body: Names to search

Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/getEntriesByNames
BODY{
    \"search_by_name_criteria\": {
        \"search_texts\": {
            \"search_text\": [
                \"Finance\",
                \"Marketing\",
                \"Management\"
            ]
        },
        \"ldap_entry_types\": {
            \"ldap_entry_type\": [
                \"GROUP\"
            ]
        },
        \"max_search_result\": 20
    }
}
OUTPUT{
    \"search_result\": {
        \"ldap_entries\": {
            \"ldap_entry\": [
                {
                    \"@xsi.type\": \"LdapGroup\",
                    \"dn\": \"CN=Finance,OU=SecureTrack,DC=tufintest,DC=com\",
                    \"uid\": \"uOvJTpYRD0aTjEENA87N5A==\",
                    \"displayName\": \"Finance\"
                },
                {
                    \"@xsi.type\": \"LdapGroup\",
                    \"dn\": \"CN=Management,OU=SecureTrack,DC=tufintest,DC=com\",
                    \"uid\": \"jdf778skfsgs730fksdHHs==\",
                    \"displayName\": \"Management\"
                }
            ]
        },
        \"has_more_results_to_return\": false
    }
}


Response Messages:
200: OK
400: Bad request (one of the request fields has an illegal value)
501: LDAP server is not configured
503: No connection to LDAP server","folder":"1-10","rawModeData":"{\n\t\"search_by_name_criteria\": {\n\t\t\"search_texts\": {\n\t\t\t\"search_text\": [\n\t\t\t\t\"Finance\",\n\t\t\t\t\"Marketing\",\n\t\t\t\t\"Management\"\n\t\t\t]\n\t\t},\n\t\t\"ldap_entry_types\": {\n\t\t\t\"ldap_entry_type\": [\n\t\t\t\t\"GROUP\"\n\t\t\t]\n\t\t},\n\t\t\"max_search_result\": 20\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/getEntriesByNames","collectionId":"1","id":"1-10-34","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Return LDAP entries which match the given search criteria","dataMode":"raw","description":"Return list of LDAP entries which match the given search criteria according to the search mode (EXACT, CONTAINS, STARTS_WITH, ENDS_WITH).
The search is case insensitive.
The limit of max_search_result is 1000.

Parameters:
body: Search criteria

Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/search
BODY{
    \"search_criteria\": {
        \"search_base_dn\": \"DC=tufintest,DC=com\",
        \"search_text\": \"test\",
        \"ldap_search_options\": {
            \"ldap_entry_types\": {
                \"ldap_entry_type\": [
                    \"OU\",
                    \"USER\"
                ]
            },
            \"search_mode\": \"CONTAINS\",
            \"max_search_result\": 3
        }
    }
}
OUTPUT{
    \"search_result\": {
        \"ldap_entries\": {
            \"ldap_entry\": [
            {
                \"dn\": \"CN=User15ATTesting1,OU=Testing1,OU=new OU,OU=SC_Users,DC=tufintest,DC=com\",
                \"uid\": \"ZRuKW3XqIEOIxCwlfgJQYA==\",
                \"displayName\": \"User15ATTesting1\"
            },
            {
                \"dn\": \"CN=IWAM_TEST2003,CN=Users,DC=tufintest,DC=com\",
                \"uid\": \"bYVqqcZXsUSF51hiP4W7Yw==\",
                \"displayName\": \"Testing1\"
            },
            {
                \"dn\": \"CN=User1ATTesting1,OU=Testing1,OU=new OU,OU=SC_Users,DC=tufintest,DC=com\",
                \"uid\": \"2ma3TrgeHEWQDITwvcRqlg==\",
                \"displayName\": \"test\"
            }
            ]
        },
            \"has_more_results_to_return\": \"true\"
        }
}


Response Messages:
200: OK
400: Bad request (one of the request fields has an illegal or invalid value)
501: LDAP server is not configured
503: No connection to LDAP server","folder":"1-10","rawModeData":"{\n\t\"search_criteria\": {\n\t\t\"search_base_dn\": \"DC=tufintest,DC=com\",\n\t\t\"search_text\": \"test\",\n\t\t\"ldap_search_options\": {\n\t\t\t\"ldap_entry_types\": {\n\t\t\t\t\"ldap_entry_type\": [\n\t\t\t\t\t\"OU\",\n\t\t\t\t\t\"USER\"\n\t\t\t\t]\n\t\t\t},\n\t\t\t\"search_mode\": \"CONTAINS\",\n\t\t\t\"max_search_result\": 3\n\t\t}\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/search","collectionId":"1","id":"1-10-35","method":"POST"},{"headers":"Accept: application/json\n","name":"Get the base DN entry details","description":"The returned \"base DN\" is used by GetEntriesByNames API as the search start entry.



Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/getBaseDNEntry
OUTPUT{
    \"ldap_entry\": {
        \"dn\": \"DC=tufintest,DC=com\",
        \"uid\": \"nABbRP/lPUKlteNRI4j6iA==\"
    }
}


Response Messages:
200: OK
404: Base Entry cannot be found
501: LDAP server is not configured
503: No connection to LDAP server","folder":"1-10","url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/getBaseDNEntry","collectionId":"1","id":"1-10-36","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Add devices to SecureTrack","dataMode":"raw","description":"Use this API to add a single device or a list of devices to SecureTrack.
The following devices can be added: Check Point CMA R77, CMA R80, SMC R77, SMC R80; Cisco ASA; Palo Alto Panorama NG; Fortinet FortiManager.
The API body should include a JSON file with the mandatory parameters for the operation.
String parameters contain only lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^().
Currently supported types: CMA, SMC, ASA, Panorama NG and FortiManager.

This API verifies connection to the provided device, before adding a device.
This is done by:
  Cisco - Connect with SSH and see that the credentials are correct.
  Check Point - Test OPSEC connectivity. For R80 devices, this also verifies the connectivity for API login.
  Panorama - Login through the API to check connectivity.
  Fortimanager - Login through the API to check connectivity.
If the connection test fails the device will not be added.
Only \"live\" device with correct credentials can be added using this API.
To add Checkpoint R77 devices, use \"r80_version\" : \"false\".


Parameters:
body: device_list

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/bulk
BODY{
     \"devices_list\":{
         \"devices\": [{
             \"model\":\"CMA\",
             \"vendor\":\"Checkpoint\",
             \"display_name\":\"Europe-CMA\",
             \"ip_address\":\"192.168.1.1\",
             \"enable_topology\": \"true\",
             \"securetrack_domain\":\"Default\",
             \"device_data\":{
                 \"lea_authentication_port\":\"65000\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"opsec_application\":\"ST-Opsec\",
                 \"activation_key\":\"ST-Activation\",
                 \"r80_version\":\"false\"
             }
         },
         {
             \"model\":\"CMA\",
             \"vendor\":\"Checkpoint\",
             \"display_name\":\"Europe-CMA\",
             \"ip_address\":\"192.168.1.1\",
             \"enable_topology\": \"true\",
             \"securetrack_domain\":\"Default\",
             \"device_data\":{
                 \"lea_authentication_port\":\"65000\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"opsec_application\":\"ST-Opsec\",
                 \"activation_key\":\"ST-Activation\",
                 \"user_name\":\"admin\",
                 \"password\":\"1234\",
                 \"r80_version\":\"true\"
             }
         },
         {
             \"model\":\"ASA\",
             \"vendor\":\"Cisco\",
             \"securetrack_domain\":\"Domain-A\",
             \"display_name\":\"Ireland-ASA\",
             \"ip_address\":\"172.16.1.1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
             \"enable_virtual_contexts\":\"true\",
             \"import_all\":\"false\",
             \"import_devices\":
                     [\"VC1\",\"VC2\"],
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"false\",
                 \"collect_dynamic_topology\":\"false\",
                 \"user_name\":\"St-Super-use\",
                 \"password\":\"st-super-password\",
                 \"enable_password\":\"st-enable-password\"
             }
         },
         {
             \"model\":\"Panorama\",
             \"vendor\":\"PaloAltoNetworks\",
             \"display_name\":\"First-Device-example\",
             \"ip_address\":\"172.16.1.1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"user_name\":\"St-Super-use\",
                 \"password\":\"st-super-password\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"collect_dynamic_topology\":\"false\",
                 \"import_devices\":[
                     {
                         \"name\":\"DG1\",
                         \"import_all\":\"false\",
                         \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"]
                     },
                     {
                         \"name\":\"DG2\",
                         \"import_all\":\"true\"
                     },
                     {
                         \"name\":\"DG3\",
                         \"import_all\":\"false\",
                         \"managed_devices\": []
                     }
                 ]
             }
         },
         {
             \"model\":\"FortiManager\",
             \"vendor\":\"Fortinet\",
             \"display_name\":\"Spain-FortiManager\",
             \"securetrack_server\":\"RemoteControlServerName\",
             \"ip_address\":\"172.16.1.1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"false\",
                 \"user_name\":\"St-Super-use\",
                 \"password\":\"st-super-password\",
                 \"collect_dynamic_topology\":\"false\",
                 \"import_all\": \"false\",
                 \"import_devices\": [
                         {
                 \"name\": \"AdomX\",
                 \"import_all\": \"false\",
                 \"managed_devices\": [\"FW1\"]
                        }
                    ]
                }
            }
        ]
    }
}


Response Messages:
202: Accepted
408: Request timed out
500: Internal server error
503: Task with UID already running","folder":"1-11","rawModeData":"{ \n \t \"devices_list\":{ \n \t\t \"devices\": [{ \n \t\t\t \"model\":\"CMA\",\n \t\t\t \"vendor\":\"Checkpoint\",\n \t\t\t \"display_name\":\"Europe-CMA\",\n \t\t\t \"ip_address\":\"192.168.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"securetrack_domain\":\"Default\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"lea_authentication_port\":\"65000\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"opsec_application\":\"ST-Opsec\",\n \t\t\t\t \"activation_key\":\"ST-Activation\",\n \t\t\t\t \"r80_version\":\"false\"\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"model\":\"CMA\",\n \t\t\t \"vendor\":\"Checkpoint\",\n \t\t\t \"display_name\":\"Europe-CMA\",\n \t\t\t \"ip_address\":\"192.168.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"securetrack_domain\":\"Default\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"lea_authentication_port\":\"65000\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"opsec_application\":\"ST-Opsec\",\n \t\t\t\t \"activation_key\":\"ST-Activation\",\n \t\t\t\t \"user_name\":\"admin\",\n \t\t\t\t \"password\":\"1234\",\n \t\t\t\t \"r80_version\":\"true\"\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"model\":\"ASA\",\n \t\t\t \"vendor\":\"Cisco\",\n \t\t\t \"securetrack_domain\":\"Domain-A\",\n \t\t\t \"display_name\":\"Ireland-ASA\",\n \t\t\t \"ip_address\":\"172.16.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t \"enable_virtual_contexts\":\"true\",\n \t\t\t \"import_all\":\"false\",\n \t\t\t \"import_devices\": \n \t\t\t\t\t [\"VC1\",\"VC2\"],\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"false\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"user_name\":\"St-Super-use\",\n \t\t\t\t \"password\":\"st-super-password\",\n \t\t\t\t \"enable_password\":\"st-enable-password\"\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"model\":\"Panorama\",\n \t\t\t \"vendor\":\"PaloAltoNetworks\",\n \t\t\t \"display_name\":\"First-Device-example\",\n \t\t\t \"ip_address\":\"172.16.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"user_name\":\"St-Super-use\",\n \t\t\t\t \"password\":\"st-super-password\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"import_devices\":[\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG1\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"] \n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG2\",\n \t\t\t\t\t\t \"import_all\":\"true\"\n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG3\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [] \n \t\t\t\t\t }\n \t\t\t\t ]\n \t\t\t }\n \t\t },\n \t\t {\n \t\t\t \"model\":\"FortiManager\",\n \t\t\t \"vendor\":\"Fortinet\",\n \t\t\t \"display_name\":\"Spain-FortiManager\",\n \t\t\t \"securetrack_server\":\"RemoteControlServerName\",\n \t\t\t \"ip_address\":\"172.16.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"false\",\n \t\t\t\t \"user_name\":\"St-Super-use\",\n \t\t\t\t \"password\":\"st-super-password\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"import_all\": \"false\",\n \t\t\t\t \"import_devices\": [\n \t\t\t\t\t\t { \n \t\t\t\t \"name\": \"AdomX\",\n \t\t\t\t \"import_all\": \"false\", \n \t\t\t\t \"managed_devices\": [\"FW1\"]\n \t\t\t\t\t\t}\n \t\t\t\t\t]\n \t\t\t\t}\n \t\t\t}\n \t\t]\n \t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/","collectionId":"1","id":"1-11-37","method":"POST"},{"headers":"Content-Type: application/json\n","name":"Edit Securetrack device","dataMode":"raw","description":"Use this API to edit the settings of a management device, including changing multiple parameters in the same call.
The API body should include a JSON file with the mandatory parameters for the operation.
String parameters contain only lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^().
The following devices can be edited: Check Point CMA R77, Check Point SMC R77, Cisco ASA, Panorama NG and FortiManager.
Note: This API cannot be used to edit SecureTrack Domains and SecureTrack Servers.
This API verifies connection to the provided device, before updating a device.
This is done by:
  Cisco - Connect with SSH and see that the credentials are correct.
  Check Point - Test OPSEC connectivity. For R80 devices, this also verifies the connectivity for API login.
  Panorama - Login through the API to check connectivity.
  Fortimanager - Login through the API to check connectivity.
If the connection test fails the device will not be updated.
Only \"live\" device with correct credentials can be updated using this API.

Parameters:
body: device_list

Usage Example
URL https://192.168.1.1/securetrack/api/devices/bulk
BODY{
     \"devices_list\":{
         \"devices\": [{
             \"device_id\": 1,
             \"display_name\": \"CheckPoint-R77-Device\",
             \"enable_topology\": \"true\",
             \"ip_address\": \"1.1.1.1\",
             \"device_data\": {
                 \"opsec_application\": \"ST-Opsec\",
                 \"activation_key\": \"ST-Activation\",
                 \"authentication_mode\": \"LEA\",
                 \"lea_authentication_mode\": \"ssl_opsec\",
                 \"lea_authentication_port\": \"2488\",
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\"
             }
         },
         {
             \"device_id\": 2,
             \"display_name\": \"CheckPoint-R80-Device\",
             \"enable_topology\": \"true\",
             \"ip_address\": \"1.1.1.2\",
             \"device_data\": {
                 \"opsec_application\": \"ST-Opsec\",
                 \"activation_key\": \"ST-Activation\",
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\",
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\"
             }
         },
         {
             \"device_id\": 3,
             \"display_name\": \"Cisco-Device\",
             \"enable_topology\": \"true\",
             \"ip_address\": \"2.2.2.2\",
             \"device_data\": {
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\",
                 \"enable_password\": \"st-super-password\",
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\"
             }
         },
         {
             \"device_id\": 4,
             \"display_name\": \"PaloAlto-PanoramaNg-Device\",
             \"ip_address\": \"2.2.2.2\",
             \"device_data\": {
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\"
             }
         },
         {
             \"device_id\": 5,
             \"display_name\": \"PaloAlto-DeviceGroup\"
         },
         {
             \"device_id\": 6,
             \"display_name\": \"PaloAlto-FireWall-Device\",
             \"enable_topology\": \"true\",
             \"device_data\": {
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\",
                 \"collect_dynamic_topology\": \"true\"
             }
         },
         {
             \"device_id\": 7,
             \"display_name\": \"Spain-FortiManager\",
             \"ip_address\": \"2.2.2.2\",
             \"device_data\": {
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\"
             }
         },
         {
             \"device_id\": 8,
             \"display_name\": \"FortiManager-Adom\"
         },
         {
             \"device_id\": 9,
             \"display_name\": \"FortiManager-FireWall\",
             \"enable_topology\": \"true\",
             \"device_data\": {
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\",
                 \"collect_dynamic_topology\": \"true\"
             }
         }
        ]
    }
}


Response Messages:
202: Accepted
408: Request timed out
500: Internal server error
503: Task with UID already running","folder":"1-11","rawModeData":"{ \n \t \"devices_list\":{ \n\t\t \"devices\": [{\n\t\t\t \"device_id\": 1,\n\t\t\t \"display_name\": \"CheckPoint-R77-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"ip_address\": \"1.1.1.1\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"opsec_application\": \"ST-Opsec\",\n\t\t\t\t \"activation_key\": \"ST-Activation\",\n\t\t\t\t \"authentication_mode\": \"LEA\",\n\t\t\t\t \"lea_authentication_mode\": \"ssl_opsec\",\n\t\t\t\t \"lea_authentication_port\": \"2488\",\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 2,\n\t\t\t \"display_name\": \"CheckPoint-R80-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"ip_address\": \"1.1.1.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"opsec_application\": \"ST-Opsec\",\n\t\t\t\t \"activation_key\": \"ST-Activation\",\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\",\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 3,\n\t\t\t \"display_name\": \"Cisco-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"ip_address\": \"2.2.2.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\",\n\t\t\t\t \"enable_password\": \"st-super-password\",\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 4,\n\t\t\t \"display_name\": \"PaloAlto-PanoramaNg-Device\",\n\t\t\t \"ip_address\": \"2.2.2.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 5,\n\t\t\t \"display_name\": \"PaloAlto-DeviceGroup\"\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 6,\n\t\t\t \"display_name\": \"PaloAlto-FireWall-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_dynamic_topology\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 7,\n\t\t\t \"display_name\": \"Spain-FortiManager\",\n\t\t\t \"ip_address\": \"2.2.2.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 8,\n\t\t\t \"display_name\": \"FortiManager-Adom\"\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 9,\n\t\t\t \"display_name\": \"FortiManager-FireWall\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_dynamic_topology\": \"true\"\n\t\t\t }\n\t\t }\n\t\t]\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/","collectionId":"1","id":"1-11-38","method":"PATCH"},{"headers":"Accept: application/json\n","name":"Get specific device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the vendor, model, name, domain and ID for the specified device.
For more information on supported devices, supported models and virtual types please refer to 'Device and Revision Resources' section in the Tufin Knowledge Center .

Parameters:
context: Global MSSP context [optional]
id: Device ID
show_os_version: Show os version as apart of the response [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/60

Usage Example
https://192.168.1.1/securetrack/api/devices/20?show_os_version=true
","folder":"1-11","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}","collectionId":"1","id":"1-11-39","method":"GET"},{"headers":"Accept: application/json\n","name":"Get textual configuration by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Get latest revision of running configuration for a given device Id.


Parameters:
context: global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/111/config
","folder":"1-11","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/config","collectionId":"1","id":"1-11-40","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Import managed devices","dataMode":"raw","description":"Use this API to import more managed devices to SecureTrack.
The following devices can be added: Device Groups (for Panorama), Administrative Domains (for FortiManager).\nCurrently supported types: Panorama, FortiManager, Cisco ASA.
Please see examples below per device id: device id 1 for Panorama, device 2 for FortiManager, device id 3 for Cisco ASA.

Parameters:
body: device_list

Usage Example
URL https://192.168.1.1/securetrack/api/devices/bulk/import
BODY{
     \"devices_list\":{
         \"devices\":[
         {
             \"device_id\":\"1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"collect_dynamic_topology\":\"false\",
                 \"import_devices\":[
                     {
                         \"name\":\"DG1\",
                         \"import_all\":\"false\",
                         \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"]
                     },
                     {
                         \"name\":\"DG2\",
                         \"import_all\":\"true\"
                     },
                     {
                         \"name\":\"DG3\",
                         \"import_all\":\"false\",
                         \"managed_devices\": []
                     }
                 ]
             }
         },
         {
             \"device_id\":\"2\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"import_devices\": [
                     {
                         \"name\":\"Adom1\",
                         \"import_all\":\"false\",
                         \"managed_devices\": [\"firewall1\", \"firewall2\"]
                     },
                     {
                         \"name\":\"Adom2\",
                         \"import_all\":\"true\"
                     }
                 ]
             }
         },
         {
             \"device_id\":\"3\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"import_devices\": [\"wantedVirtualContext\", \"anotherWantedVirtualContext\"]
             }
         }
        ]
    }
}


Response Messages:
202: Accepted
408: Request timed out
500: Internal server error
503: Task with UID already running","folder":"1-11","rawModeData":"{ \n \t \"devices_list\":{ \n \t\t \"devices\":[ \n \t\t { \n \t\t\t \"device_id\":\"1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"import_devices\":[\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG1\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"] \n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG2\",\n \t\t\t\t\t\t \"import_all\":\"true\"\n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG3\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [] \n \t\t\t\t\t }\n \t\t\t\t ]\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"device_id\":\"2\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"import_devices\": [\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"Adom1\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [\"firewall1\", \"firewall2\"] \n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"Adom2\",\n \t\t\t\t\t\t \"import_all\":\"true\"\n \t\t\t\t\t }\n \t\t\t\t ]\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"device_id\":\"3\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"import_devices\": [\"wantedVirtualContext\", \"anotherWantedVirtualContext\"] \n \t\t\t }\n \t\t }\n \t\t]\n \t}\n} ","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/import","collectionId":"1","id":"1-11-41","method":"POST"},{"headers":"Accept: application/json\n","name":"Get specific task results of bulk operations on devices","data":[{"value":null,"type":"text","enabled":true,"key":"task_uid"}],"dataMode":"params","description":"Use this API to track and display the current progress of the devices being edited or added to\nSecureTrack for a specific Task ID.
For a list of devices, the status of each device is displayed.

A device that was not added due to some reason will be added to \"failed\" list with status element containing a description.
For example:
\"description\": \"No connection to device\".

Parameters:
task_uid: Task UID

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/bulk/tasks/d7e88799-a6e5-45da-8c72-c979a5dbe235
OUTPUT{
    \"task_result\":{
        \"total_succeeded\":\"0\",
        \"total_in_progress\":\"2\",
        \"total_failed\":\"0\",
        \"succeeded\":{
            \"count\":\"0\"
        },
        \"in_progress\":{
            \"count\":\"2\",
            \"devices\":[
                {
                    \"device_id\":\"1\",
                    \"display_name\":\"Europe-CMA\",
                    \"ip_address\":\"192.168.1.1\",
                    \"status\":{
                    }
                },
                {
                    \"device_id\":\"2\",
                    \"display_name\":\"Ireland-ASA\",
                    \"ip_address\":\"172.16.1.1\",
                    \"status\":{
                    }
                }
            ]
        },
        \"failed\":{
            \"count\":\"0\"
        }
    }
}


Response Messages:
404: The task with the given UID was not found
400: Bad request
200: Accepted
408: Request timed out
500: Internal server error","folder":"1-11","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/tasks/{{task_uid}}","collectionId":"1","id":"1-11-42","method":"GET"},{"name":"Add configuration for offline device","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"configuration_file"}],"description":"Parameters:
device_id: Device ID
configuration_file: Configuration File

Usage Example
curl -X POST -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F \"configuration_file=@/tmp/config.txt;type=application/octet-stream\" -F \"device_id=1\" https://192.168.1.1/securetrack/api/tasks/add_device_config_task

Response Messages:
200: Configuration added successfully.","dataMode":"params","folder":"1-11","url":"https://{{SecureTrack_IP}}/securetrack/api/tasks/add_device_config_task","collectionId":"1","id":"1-11-43","method":"POST"},{"headers":"Content-Type: application/xml\n","name":"Update offline device","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"}],"dataMode":"raw","description":"Device name should contain only Lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^()

Parameters:
device_id: Device ID
body: Device to be updated

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/1
BODY<device>
     <name>API OFFLINE ASA2</name>
     <topology>true</topology>
</device>

","folder":"1-11","rawModeData":"\n\t API OFFLINE ASA2\n\t true\n","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}","collectionId":"1","id":"1-11-44","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get devices","description":"Returns the list of devices that are configured in SecureTrack, including the vendor, model, name, domain and device ID.
The results can be sorted by ip, name, vendor and model.
For more information on supported devices, supported models and virtual types please refer to 'Device and Revision Resources' section in the Tufin Knowledge Center .

Parameters:
context: Global MSSP context [optional]
name: Device name [optional]
ip: Device IP address [optional]
vendor: Device vendor [optional]
model: Device model [optional]
sort: Sort ascending or descending allowable types are: asc or desc [optional]
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query starting from starting page allowable type in numeric [optional]
show_os_version: Show os version as apart of the response [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices

Usage Example
https://192.168.1.1/securetrack/api/devices?vendor=VMware

Usage Example
https://192.168.1.1/securetrack/api/devices?sort=ip:asc

Usage Example
https://192.168.1.1/securetrack/api/devices?show_os_version=true
","folder":"1-11","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/","collectionId":"1","id":"1-11-45","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Add offline device","dataMode":"raw","description":"You can choose to select the domain either by name or id using the domain_id or domain_name tags.\nDevice name should contain only Lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^()

Parameters:
body: Device to be added

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices
BODY<device>
     <model>asa</model>
     <vendor>Cisco</vendor>
     <domain_id>1</domain_id>
     <domain_name>Default</domain_name>
     <name>API OFFLINE ASA1</name>
     <offline>true</offline>
     <topology>true</topology>
</device>

","folder":"1-11","rawModeData":"\n\t asa \n\t Cisco\n\t 1\n\t Default\n\t API OFFLINE ASA1\n\t true\n\t true\n","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/","collectionId":"1","id":"1-11-46","method":"POST"},{"headers":"Accept: application/json\n","name":"Get textual configuration by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns textual configuration for the specified revision Id.


Parameters:
context: Global MSSP context [optional]
id: Revision id

Usage Example
https://192.168.1.1/securetrack/api/revisions/227/config
","folder":"1-11","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/config","collectionId":"1","id":"1-11-47","method":"GET"},{"headers":"Accept: application/json\n","name":"Get NAT objects by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches a list of NAT objects for a given revision
Note: NAT objects are only relevant for Check Point management servers and Juniper Netscreen devices.
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.


Parameters:
context: Global MSSP context [optional]
id: Version ID
start: Starting page for query allowable value is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/nat_objects

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/nat_objects?get_total=true
","folder":"1-12","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/nat_objects","collectionId":"1","id":"1-12-48","method":"GET"},{"headers":"Accept: application/json\n","name":"Get NAT objects by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches a list of NAT objects defined on device given by device ID
Note: NAT objects are only relevant for Check Point management servers and Juniper Netscreen devices.
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.


Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable value is numeric [optional]
count: Starting page for query allowable value is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/nat_objects

Usage Example
https://192.168.1.1/securetrack/api/devices/20/nat_objects?get_total=true
","folder":"1-12","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/nat_objects","collectionId":"1","id":"1-12-49","method":"GET"},{"headers":"Accept: application/json\n","name":"Get NAT rules by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of NAT rules for device given by device ID

input_interface and output_interface are not supported for Panorama running in Advanced management mode
nat_stage is supported for Netscreen and JunOS
nat_type is supported for FortiManager
Note: For Check Point, NAT rules are available from the modules (not managements)
Note: For Palo Alto, filtering NAT rules by interface is only available for firewall devices

Parameters:
context: Global MSSP context [optional]
id: Device ID
input_interface: Input interface for NAT rules, \"any\" for all interfaces [optional]
output_interface: output interface for NAT rules, \"any\" for all interfaces [optional]
nat_stage: NAT stage for NAT rules allowable values: \"pre_policy\" , \"post_policy\" or \"both\" [optional]
nat_type: NAT stage for NAT rules allowable values: \"vip\" or \"reverse_vip\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/10/nat_rules/bindings?input_interface=Any
","folder":"1-12","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/nat_rules/bindings","collectionId":"1","id":"1-12-50","method":"GET"},{"headers":"Accept: application/json\n","name":"Get network groups containing specified network object","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns groups that contain the specified network object


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the network object.

Usage Example
https://192.168.1.1/securetrack/api/network_objects/69577/groups
","folder":"1-13","url":"https://{{SecureTrack_IP}}/securetrack/api/network_objects/{{id}}/groups","collectionId":"1","id":"1-13-51","method":"GET"},{"headers":"Accept: application/json\n","name":"Get rules containing specified network object","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the security rules that contain the specified network object


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the network object.
include_groups: You can add \"include_groups\" to find rules that include the network object and rules that include the groups that include the network object. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]

Usage Example
https://192.168.1.1/securetrack/api/network_objects/65078/rules?include_groups=true
","folder":"1-13","url":"https://{{SecureTrack_IP}}/securetrack/api/network_objects/{{id}}/rules","collectionId":"1","id":"1-13-52","method":"GET"},{"headers":"Accept: application/json\n","name":"Get network objects by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of network objects defined on device given by ID
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.
The show_members parameter is only relevant if type=group.
If type=group, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.

Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
name: Network object name [optional]
type: Network object type [optional]
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
contains_ip: Get only network objects containing this IP [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]
typeOnDevice: Get EDL groups [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]
add_parent_objects: Panorama only: Get objects from parent DGs (default true) [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/network_objects

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?get_total=true
OUTPUT {
    \"network_objects\": {
    \"count\": 1,
    \"total\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"hostNetworkObjectDTO\",
                \"id\": 499226,
                \"name\": \"1.1.1.2 not shared\",
                \"display_name\": \"1.1.1.2 not shared\",
                \"class_name\": \"host_plain\",
                \"type\": \"host\",
                \"comment\": \"\",
                \"uid\": \"{EFE8E61B-EE2A-2F55-4C5C-56508661EAA7}\",
                \"implicit\": false,
                \"management_domain\": \"Shared\",
                \"overrides\": false,
                \"ip\": \"1.1.1.2\"
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"count\": 1
        \"network_object\": [
            {
                \"@xsi.type\": \"identityAwarenessDTO\",
                \"id\": 169178,
                \"name\": \"Access_role\",
                \"display_name\": \"Access_role\",
                \"class_name\": \"access_role\",
                \"type\": \"identity_awareness\",
                \"global\": false,
                \"comment\": \"\",
                \"uid\": \"{FC267948-DA8C-4FB6-A736-76B5254BF825}\",
                \"implicit\": false,
                \"overrides\": false,
                \"type_on_device\": \"\",
                \"networks\": {
                    \"network\": {
                        \"@xsi.type\": \"basicNetworkObjectDTO\",
                        \"id\": 168419,
                        \"name\": \"Any\",
                        \"display_name\": \"Any\",
                        \"class_name\": \"any_object\",
                        \"type\": \"basic\",
                        \"global\": false,
                        \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                        \"implicit\": false,
                        \"overrides\": false
                    }
                },
                \"users\": {
                    \"user\": {
                        \"id\": 14320,
                        \"name\": \"ad_group_auto_30K_grp1\",
                        \"display_name\": \"auto_30K_grp1\",
                        \"class_name\": \"ad_group\",
                        \"global\": false,
                        \"comment\": \"\",
                        \"uid\": \"{CAB92DCC-CF63-4E47-B8E3-1E1231996D5E}\",
                        \"dn\": \"CN=auto_30K_grp1,OU=OU_30K_Groups,DC=rnd,DC=local\"
                    }
                }
            },
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?type=group&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 105934,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?typeOnDevice=edl_ip_list&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 1,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 123123,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"type_on_device\": edl_ip_list,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Response Messages:
400: The typeOnDevice value is not valid","folder":"1-13","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/network_objects","collectionId":"1","id":"1-13-53","method":"GET"},{"headers":"Accept: application/json\n","name":"Get network objects by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of network objects from specific revision
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.
The show_members parameter is only relevant if type=group.
If type=group, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.

Parameters:
context: Global MSSP context [optional]
id: Revision id
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
name: Network object name [optional]
type: Network object type [optional]
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
contains_ip: Get only network objects containing this IP [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]
typeOnDevice: Get EDL groups [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]
add_parent_objects: Panorama only: Get objects from parent DGs (default true) [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/779/network_objects

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?get_total=true
OUTPUT {
    \"network_objects\": {
    \"count\": 1,
    \"total\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"hostNetworkObjectDTO\",
                \"id\": 499226,
                \"name\": \"1.1.1.2 not shared\",
                \"display_name\": \"1.1.1.2 not shared\",
                \"class_name\": \"host_plain\",
                \"type\": \"host\",
                \"comment\": \"\",
                \"uid\": \"{EFE8E61B-EE2A-2F55-4C5C-56508661EAA7}\",
                \"implicit\": false,
                \"management_domain\": \"Shared\",
                \"overrides\": false,
                \"ip\": \"1.1.1.2\"
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/779/network_objects?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
    \"count\": 1,
        \"network_object\": [
            {
                \"@xsi.type\": \"identityAwarenessDTO\",
                \"id\": 169183,
                \"name\": \"Access role 1\",
                \"display_name\": \"Access role 1\",
                \"class_name\": \"access_role\",
                \"type\": \"identity_awareness\",
                \"global\": true,
                \"comment\": \"\",
                \"uid\": \"{1E4C35A0-1FE4-4101-8A38-FDE656BCDCFB}\",
                \"implicit\": false,
                \"overrides\": false,
                \"type_on_device\": \"\",
                \"networks\": {
                    \"network\": {
                        \"@xsi.type\": \"basicNetworkObjectDTO\",
                        \"id\": 168419,
                        \"name\": \"Any\",
                        \"display_name\": \"Any\",
                        \"class_name\": \"any_object\",
                        \"type\": \"basic\",
                        \"global\": false,
                        \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                        \"implicit\": false,
                        \"overrides\": false
                    }
                },
                \"users\": {
                    \"user\": {
                        \"id\": 14346,
                        \"name\": \"all identified\",
                        \"display_name\": \"all identified\",
                        \"class_name\": \"all_identified\",
                        \"global\": false,
                        \"comment\": \"\",
                        \"uid\": \"{17A972AC-4B4A-4715-859F-867128707F59}\",
                        \"dn\": \"\"
                    }
                }
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/31/network_objects?type=group&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 105934,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/31/network_objects?typeOnDevice=edl_ip_list&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 1,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 123123,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"type_on_device\": edl_ip_list,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Response Messages:
400: The typeOnDevice value is not valid","folder":"1-13","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/network_objects","collectionId":"1","id":"1-13-54","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific network objects by revision","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches a single or partial list of the network objects for a given revision.
For group network objects, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision id
ids: Network object IDs separated by commas
show_members: Set to false to return only the name and ID of the members [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/779/network_objects/69548

Usage Example
https://192.168.1.1/securetrack/api/revisions/779/network_objects/69547,69548,69550

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/779/network_objects/69547?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"network_object\": {
            \"@xsi.type\": \"identityAwarenessDTO\",
            \"id\": 169185,
            \"name\": \"Access_Role_Domain Controllers\",
            \"display_name\": \"Access_Role_Domain Controllers\",
            \"class_name\": \"access_role\",
            \"type\": \"identity_awareness\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{140B8F32-188D-414C-A7BE-F4A7D7E9A169}\",
            \"implicit\": false,
            \"overrides\": false,
            \"type_on_device\": \"\",
            \"networks\": {
                \"network\": {
                    \"@xsi.type\": \"basicNetworkObjectDTO\",
                    \"id\": 168419,
                    \"name\": \"Any\",
                    \"display_name\": \"Any\",
                    \"class_name\": \"any_object\",
                    \"type\": \"basic\",
                    \"global\": false,
                    \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                    \"implicit\": false,
                    \"overrides\": false
                }
            },
            \"users\": {
                \"user\": {
                    \"id\": 14237,
                    \"name\": \"ad_group_Domain_Controllers\",
                    \"display_name\": \"Domain Controllers\",
                    \"class_name\": \"ad_group\",
                    \"global\": false,
                    \"comment\": \"\",
                    \"uid\": \"{0A8A459E-58E8-45DC-981E-16BBF2BD1922}\",
                    \"dn\": \"CN=Domain Controllers,CN=Users,DC=rnd,DC=local\"
                }
            }
        }
    }
}

","folder":"1-13","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/network_objects/{{ids}}","collectionId":"1","id":"1-13-55","method":"GET"},{"headers":"Accept: application/json\n","name":"Get network objects matching specified criteria","data":[{"value":null,"type":"text","enabled":true,"key":"filter"}],"dataMode":"params","description":"You can search for network objects where the IP address, name or comment fields have a specified text string,
or you can search for network objects that have an IP address that matches, contains or is contained in a specified IP subnet,
or you can search for network objects by uid.

Parameters:
context: Returns results for the specified domain ID. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]
filter: “text” filter returns network objects where the IP address, name or comment fields have a specified text string. “subnet” filter returns network objects that have an IP address that matches, contains or is contained in a specified IP subnet. “uid“ filter returns network objects with the specified uid. If no filter is specified, the “text” filter is used.
device_id: Returns network objects belonging to the specified device_id. [optional]
ip: (For “text” filter) You can specify \"ip\" to find network objects with the specified text in the IP address field. [optional]
name: (For “text” filter) You can specify \"name\" to find network objects with the specified text in the name field. [optional]
comment: (For “text” filter) You can specify “comment” to find network objects with the specified text in the comment field. [optional]
any_field: (For “text” filter) You can specify \"any_field\" to find network objects with the specified text in the IP address, name or comment fields. [optional]
exact_match: (For “text” filter) You can add \"exact_match=true\" to find network objects with the specified text in the comment field. If this field is not specified, the query uses \"exact_match=false\". [optional]
contained_in: (For “subnet” filter) You can specify \"contained_in\" to find network objects that are contained in the specified IP subnet. For example, 10.1.0.0 is contained in 10.0.0.0. [optional]
contains: (For “subnet” filter) You can specify \"contains\" to find network objects that contain the specified IP subnet. For example, 10.0.0.0 contains 10.1.0.0. [optional]
exact_subnet: (For “subnet” filter) You can specify \"exact_subnet\" to find network objects that have the specified IP address. [optional]
uid: (for “uid“ filter) Returns network objects with the specified uid. [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]
typeOnDevice: You can specify \"typeOnDevice\" to find network object groups that are EDL. [optional]

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=text&name=host&exact_match=true

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=text&any_field=host&count=10&exact_match=true

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=subnet&contains=10.1.1.0

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=subnet&count=10&exact_subnet=1.1.1.1

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=uid&uid=24a8774d-24c1-4b3a-aae9-3c272a2b5191

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=uid&uid=24a8774d-24c1-4b3a-aae9-3c272a2b5191&device_id=4

Usage Example
URLhttps://192.168.1.1/securetrack/api/network_objects/search?filter=text&name=Access_Role&identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"count\": 1,
        \"total\": 1,
        \"network_object\": {
            \"@xsi.type\": \"identityAwarenessDTO\",
            \"id\": 169197,
            \"name\": \"Access_Role_aaa\",
            \"display_name\": \"Access_Role_aaa\",
            \"class_name\": \"access_role\",
            \"type\": \"identity_awareness\",
            \"global\": false,
            \"device_id\": 158,
            \"comment\": \"\",
            \"uid\": \"{9EDC2607-6BEC-43D7-A99D-B522BA694ADA}\",
            \"implicit\": false,
            \"overrides\": false,
            \"type_on_device\": \"\",
            \"networks\": {
                \"network\": {
                    \"@xsi.type\": \"basicNetworkObjectDTO\",
                    \"id\": 168419,
                    \"name\": \"Any\",
                    \"display_name\": \"Any\",
                    \"class_name\": \"any_object\",
                    \"type\": \"basic\",
                    \"global\": false,
                    \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                    \"implicit\": false,
                    \"overrides\": false
                }
            },
            \"users\": {
                \"user\": {
                    \"id\": 14317,
                    \"name\": \"ad_group_aaa\",
                    \"display_name\": \"aaa\",
                    \"class_name\": \"ad_group\",
                    \"global\": false,
                    \"comment\": \"\",
                    \"uid\": \"{5D16859C-0256-4673-A402-4254588B8F40}\",
                    \"dn\": \"CN=aaa,OU=SC_Users,DC=test,DC=com\"
                }
            }
        }
    }
}


Response Messages:
400: The typeOnDevice value is not valid.Use edl_ip_list as value to search EDL groups.","folder":"1-13","url":"https://{{SecureTrack_IP}}/securetrack/api/network_objects/search","collectionId":"1","id":"1-13-56","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific network object","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches a single or partial list of the network objects for a given device ID.
For group network objects, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.
Note: This API retrieves the information from the latest revision.

Parameters:
context: Global MSSP context [optional]
device_id: Device ID
ids: Network object IDs separated by commas
show_members: Set to false to return only the name and ID of the members [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/network_objects/69548

Usage Example
https://192.168.1.1/securetrack/api/devices/31/network_objects/69547,69548,69550

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects/169184?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"network_object\": {
            \"@xsi.type\": \"identityAwarenessDTO\",
            \"id\": 169184,
            \"name\": \"Access_Role_@grp\",
            \"display_name\": \"Access_Role_@grp\",
            \"class_name\": \"access_role\",
            \"type\": \"identity_awareness\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{1870612C-0922-4AEE-81FF-5472DB7C32E1}\",
            \"implicit\": false,
            \"overrides\": false,
            \"type_on_device\": \"\",
            \"networks\": {
                \"network\": {
                    \"@xsi.type\": \"basicNetworkObjectDTO\",
                    \"id\": 168419,
                    \"name\": \"Any\",
                    \"display_name\": \"Any\",
                    \"class_name\": \"any_object\",
                    \"type\": \"basic\",
                    \"global\": false,
                    \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                    \"implicit\": false,
                    \"overrides\": false
                }
            },
            \"users\": {
                \"user\": {
                    \"id\": 14338,
                    \"name\": \"ad_group_grp\",
                    \"display_name\": \"@grp\",
                    \"class_name\": \"ad_group\",
                    \"global\": false,
                    \"comment\": \"\",
                    \"uid\": \"{C5740C23-F36E-4D2E-8B17-1F99C239C12A}\",
                    \"dn\": \"CN=@grp,OU=SC_Users,DC=test,DC=com\"
                }
            }
        }
    }
}

","folder":"1-13","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/network_objects/{{ids}}","collectionId":"1","id":"1-13-57","method":"GET"},{"headers":"Accept: application/json\n","name":"Get generic devices that are configured in ST","description":"Returns a list of the generic devices included in all the domains that the user has permission to.
Use context and/or name optional parameters to get more specific results.
To get context optional parameter, you can call /domains/ API and use the id included within the returned domain DTO.

Parameters:
context: Global MSSP context [optional]
name: Generic device name [optional]

Usage Example
https://192.168.1.1/securetrack/api/generic_devices
","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/","collectionId":"1","id":"1-14-58","method":"GET"},{"name":"Add generic device to Topology model","data":[{"value":null,"type":"text","enabled":true,"key":"configuration_file"}],"dataMode":"params","description":"Upload a configuration file that will be used to add a generic device to the Topology model.
The context field is the domain ID to which the generic device is added: If not provided, the device is added to the global domain.
configuration_file must include a valid generic device configuration.
The specified path must point to a file on the computer being sue to make the REST API call.
If update update_topology = true, then the Topology model will be updated immediately after the device is added.
For maximum efficiency, if you are adding multiple generic devices in consecutive API calls, you can set update_topology = false on all API calls except for the last one. On the last call, set update_toplogy = true.Default value for update_topology = true.
For more information on input file formats, refer to Knowledge Center topic 'Adding and Updating a Generic Device'.

Parameters:
body: Generic device to be added
configuration_file: Configuration File for generic device
update_topology: Synchronize And Update Topology [optional]

Usage Example
curl -X POST -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F 'device_data={\"generic_device\":{\"name\": \"my_generic_device\", \"customer_id\": 1}};type=application/json' -F \"configuration_file=@/tmp/config.txt;type=application/octet-stream\" -F \"update_topology=true\" https://192.168.1.1/securetrack/api/generic_devices\n

Response Messages:
201: The generic device was created successfully
403: User is not permitted to access the specified domain
400: Failed to create generic device ","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/","collectionId":"1","id":"1-14-59","method":"POST"},{"headers":"Accept: application/json\n","name":"Get topology subnets","description":"Returns a list of the topology subnets for all the domains for which the user has permission to access.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
Use the optional name parameter to restrict the results to topology subnet names that match the search criteria provided, as follows:
1. If you provide only a mask, then an exact match search is done on the mask portion of the name
e.g. if name=/2, the results will include 1.2.3.4/2, but not 1.2.3.4/22
2. If you provide only a partial or complete IP address, then a contains search is done in the IPv4 block portion of the name
e.g. name=32, the results will include 192.168.205.32/24 and 55.192.32.22/16, but will not include 55.168.205.5/32
3. If you provide both an IPv4 address (either partial or complete) and a mask, then an exact match search is done
e.g. if name=23.4/2, then the results will include 192.168.23.4/2, but will not include 192.168.23.4/23 or 23.4.192.168/2

Use the optional ip parameter to restrict the results to topology subnets that contain this ip, see example below.

User can use ip or name parameter, not both.
The default pagination is start=0 and count=50.

Parameters:
context: Global MSSP context [optional]
name: Subnet name [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]
ip: Ip host [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/subnets?name=10.27
OUTPUT{
    \"topology_subnets\": {
        \"count\": 4,
        \"total\": 4,
        \"subnets\": [
            {
                \"id\": 615,
                \"name\": \"10.27.122.20/32\",
                \"ip\": \"10.27.122.20\",
                \"mask\": \"255.255.255.255\",
                \"domainIdTag\": 1
            },
            {
                \"id\": 616,
                \"name\": \"10.27.122.60/32\",
                \"ip\": \"10.27.122.60\",
                \"mask\": \"255.255.255.255\",
                \"domainIdTag\": 1
            },
            {
                \"id\": 619,
                \"name\": \"10.27.122.0/30\",
                \"ip\": \"10.27.122.0\",
                \"mask\": \"255.255.255.252\",
                \"domainIdTag\": 1
            },
            {
                \"id\": 620,
                \"name\": \"10.27.122.4/30\",
                \"ip\": \"10.27.122.4\",
                \"mask\": \"255.255.255.252\",
                \"domainIdTag\": 1
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/subnets?name=144/30
OUTPUT{
    \"topology_subnets\": {
        \"count\": 2,
        \"total\": 2,
        \"subnets\": [
            {
                \"id\": 773,
                \"name\": \"10.13.64.144/30\",
                \"ip\": \"10.13.64.144\",
                \"mask\": \"255.255.255.252\",
                \"domainIdTag\": 1
            },
            {
                \"id\": 825,
                \"name\": \"10.15.64.144/30\",
                \"ip\": \"10.15.64.144\",
                \"mask\": \"255.255.255.252\",
                \"domainIdTag\": 1
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/subnets?ip=10.27.122.3
OUTPUT{
    \"topology_subnets\": {
        \"count\": 4,
        \"total\": 4,
        \"subnets\": [
            {
                \"id\": 615,
                \"name\": \"10.27.122.0/24\",
                \"ip\": \"10.27.122.0\",
                \"mask\": \"255.255.255.0\",
                \"domainIdTag\": 1
            },
            {
                \"id\": 616,
                \"name\": \"10.27.0.0/16\",
                \"ip\": \"10.27.0.0\",
                \"mask\": \"255.255.0.0\",
                \"domainIdTag\": 1
            },
            {
                \"id\": 619,
                \"name\": \"10.0.0.0/8\",
                \"ip\": \"10.0.0.0\",
                \"mask\": \"255.0.0.0\",
                \"domainIdTag\": 1
            },
        ]
    }
}


Response Messages:
403: Access is denied
403: Only users with ‘Super admin’ permissions can access Global domain map
403: You do not have access permission to domain id: domainId
403: Using name and ip parameters is not allowed
403: Using Ipv6 in ip parameter is not supported
403: Ip parameter is not valid","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/subnets","collectionId":"1","id":"1-14-60","method":"GET"},{"headers":"Accept: application/json\n","name":"Get topology generic VPN connections","description":"Returns a list of the generic vpn connections in the Topology map, for all the domains for which the user has permission to access.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
Use the optional name parameter to restrict the results to topology generic vpn connections that contain the specified string.
The default pagination is start=0 and count=50.

Parameters:
context: Global MSSP context [optional]
is_generic: Get generic devices [optional]
device_id: Device id [optional]
name: VPN connection name (accepts '*', '?' as wildcards) [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/generic_vpns
OUTPUT{
    \"generic_vpns\": {
        \"count\": 3,
        \"total\": 3,
        \"generic_vpn\": [
            {
                \"device_id\": 222,
                \"generic\": false,
                \"id\": 3,
                \"interface_name\": \"tunnel.2\",
                \"tunnel_dest_ip\": \"54.239.63.155\",
                \"tunnel_src_ip\": \"84.200.6.1\",
                \"vpn_name\": \"Palo_to_AWS\"
            },
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 4,
                \"interface_name\": \"tunnel.1\",
                \"tunnel_dest_ip\": \"54.239.63.156\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 5,
                \"interface_name\": \"tunnel.2\",
                \"tunnel_dest_ip\": \"54.239.63.157\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/generic_vpns?is_generic=true
OUTPUT{
    \"generic_vpns\": {
        \"count\": 2,
        \"total\": 2,
        \"generic_vpn\": [
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 4,
                \"interface_name\": \"tunnel.1\",
                \"tunnel_dest_ip\": \"54.239.63.156\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 5,
                \"interface_name\": \"tunnel.2\",
                \"tunnel_dest_ip\": \"54.239.63.157\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
        ]
    }
}


Response Messages:
403: Access is denied
403: Only users with ‘Super admin’ permissions can access Global domain map
403: You do not have access permission to domain id: domainId
400: Wrong type provided - allowable values are: joined or non-joined","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic_vpns{device_id:(/device_id)?}","collectionId":"1","id":"1-14-61","method":"GET"},{"headers":"Accept: application/json\n","name":"Get Cloud Internal Networks","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the internal networks for the specified Cloud management id.
This API requires 'Super admin' privileges.

Parameters:
id: Cloud management id

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/cloud_internal_networks/20
OUTPUT{
    \"network_list\":
    {
        \"count\": 3,
        \"total\": 3,
        \"network\":
        {
            \"ip\": \"10.27.122.20\",
            \"mask\": \"255.255.255.255\"
        },
        \"network\":
        {
            \"ip\": \"10.27.122.60\",
            \"mask\": \"255.255.255.255\"
        },
        \"network\":
        {
            \"ip\": \"10.27.122.4\",
            \"mask\": \"255.255.255.252\"
        }
    }
}


Response Messages:
403: Access is denied
403: You do not have access permission to the domain for NSX with id ID
403: Device ID specified is not supported
404: The specified device ID was not found
404: The specified device ID was not found in Topology","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/cloud_internal_networks/{{id}}","collectionId":"1","id":"1-14-62","method":"GET"},{"headers":"Accept: application/json\n","name":"Get most specific network interfaces from which a host IP is accessible","data":[{"value":null,"type":"text","enabled":true,"key":"host"}],"description":"Parameters:
context: Global MSSP context [optional]
host: IP address of device for a query

Usage Example
https://192.168.1.1/securetrack/api/devices/interfaces/last_hop?host=192.168.1.66
","dataMode":"params","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/interfaces/last_hop","collectionId":"1","id":"1-14-63","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Create generic Vpns","dataMode":"raw","description":"Create generic Vpns.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/vpn
BODY{
    \"GenericVpns\": [
    {
        \"generic\": true,
        \"deviceId\": 3,
        \"interfaceName\": \"33\",
        \"vpnName\": null,
        \"tunnelSourceIpAddr\": \"3.3.3.33\",
        \"tunnelDestIpAddr\": \"1.1.1.11\"
    },
    {
        \"generic\": false,
        \"deviceId\": 1,
        \"interfaceName\": \"111\",
        \"vpnName\": null,
        \"tunnelSourceIpAddr\": \"1.1.1.11\",
        \"tunnelDestIpAddr\": \"3.3.3.33\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"GenericVpns\": [\n\t{\n\t\t\"generic\": true,\n\t\t\"deviceId\": 3,\n\t\t\"interfaceName\": \"33\",\n\t\t\"vpnName\": null,\n\t\t\"tunnelSourceIpAddr\": \"3.3.3.33\",\n\t\t\"tunnelDestIpAddr\": \"1.1.1.11\"\n\t},\n\t{\n\t\t\"generic\": false,\n\t\t\"deviceId\": 1,\n\t\t\"interfaceName\": \"111\",\n\t\t\"vpnName\": null,\n\t\t\"tunnelSourceIpAddr\": \"1.1.1.11\",\n\t\t\"tunnelDestIpAddr\": \"3.3.3.33\"\n\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/","collectionId":"1","id":"1-14-64","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Update generic Vpns","dataMode":"raw","description":"Update generic Vpns.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/vpn
BODY{
    \"GenericVpns\": [
    {
        \"id\": 24,
        \"generic\": true,
        \"deviceId\": 3,
        \"interfaceName\": \"new33\",
        \"vpnName\": null,
        \"tunnelSourceIpAddr\": \"3.3.3.33\",
        \"tunnelDestIpAddr\": \"1.1.1.11\"
    },
    {
        \"id\": 25,
        \"generic\": false,
        \"deviceId\": 1,
        \"interfaceName\": \"new111\",
        \"vpnName\": null,
        \"tunnelSourceIpAddr\": \"1.1.1.11\",
        \"tunnelDestIpAddr\": \"3.3.3.33\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Vpn/Management/GenericDevice Not Found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"GenericVpns\": [\n\t{\n\t\t\"id\": 24,\n\t\t\"generic\": true,\n\t\t\"deviceId\": 3,\n\t\t\"interfaceName\": \"new33\",\n\t\t\"vpnName\": null,\n\t\t\"tunnelSourceIpAddr\": \"3.3.3.33\",\n\t\t\"tunnelDestIpAddr\": \"1.1.1.11\"\n\t},\n\t{\n\t\t\"id\": 25,\n\t\t\"generic\": false,\n\t\t\"deviceId\": 1,\n\t\t\"interfaceName\": \"new111\",\n\t\t\"vpnName\": null,\n\t\t\"tunnelSourceIpAddr\": \"1.1.1.11\",\n\t\t\"tunnelDestIpAddr\": \"3.3.3.33\"\n\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/","collectionId":"1","id":"1-14-65","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get Specific topology subnet","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the subnet for the specified id, including information regarding attached devices and join candidates.
This API requires 'Super admin' or 'Multi-Domain admin' privileges.
Multi-Domain user must have access permission to the domain where the subnet resides.

Parameters:
id: Subnet id

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/subnets/20
OUTPUT{
    \"subnet\": {
        \"id\": 18,
        \"name\": \"90.0.0.0/24\",
        \"ip\": \"90.0.0.0\",
        \"mask\": \"255.255.255.0\",
        \"attached_devices\": {
            \"attached_device\": [
                {
                    \"is_generic\": false,
                    \"id\": 10,
                    \"name\": \"srx\",
                    \"interface_id\": 4,
                    \"interface_name\": \"eth0\",
                    \"interface_ip\": \"90.0.0.1\"
                },
                {
                    \"is_generic\": false,
                    \"id\": 13,
                    \"name\": \"ZBFW\",
                    \"interface_id\": 5,
                    \"interface_name\": \"eth1\",
                    \"interface_ip\": \"90.0.0.124\"
                },
                {
                    \"is_generic\": false,
                    \"id\": 85,
                    \"name\": \"netscreen\",
                    \"interface_id\": 6,
                    \"interface_name\": \"eth2\",
                    \"interface_ip\": \"90.0.0.50\"
                }
            ]
        },
        \"join_candidates\": {
            \"join_candidate\": {
                \"is_generic\": false,
                \"id\": 72,
                \"name\": \"CP25\",
                \"interface_id\": 14,
                \"interface_name\": \"eth24/1\",
                \"interface_ip\": \"90.0.0.83\"
            }
        }
    }
}


Response Messages:
403: Access is denied
403: You do not have access permission to the domain for subnet with id ID
404: No subnet was found for the provided ID","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/subnets/{{id}}","collectionId":"1","id":"1-14-66","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Create generic Routes","dataMode":"raw","description":"Create generic Routes.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/route
BODY{
    \"GenericRoutes\": [
    {
        \"mgmtId\": 1,
        \"destination\": \"111.100.10.11\",
        \"mask\": \"255.255.0.0\",
        \"interfaceName\": \"YOLO3\",
        \"nextHop\": \"100.100.10.10\",
        \"nextHopType\": \"IP\",
        \"vrf\": \"V103-KO\"
    },
    {
        \"mgmtId\": 2,
        \"destination\": \"222.100.10.22\",
        \"mask\": \"255.255.0.0\",
        \"interfaceName\": \"catch22\",
        \"nextHop\": \"100.100.10.10\",
        \"nextHopType\": \"IP\",
        \"vrf\": \"V103-KO\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management Not Found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"GenericRoutes\": [\n\t{\n\t\t\"mgmtId\": 1,\n\t\t\"destination\": \"111.100.10.11\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"interfaceName\": \"YOLO3\",\n\t\t\"nextHop\": \"100.100.10.10\",\n\t\t\"nextHopType\": \"IP\",\n\t\t\"vrf\": \"V103-KO\"\n\t},\n\t{\n\t\t\"mgmtId\": 2,\n\t\t\"destination\": \"222.100.10.22\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"interfaceName\": \"catch22\",\n\t\t\"nextHop\": \"100.100.10.10\",\n\t\t\"nextHopType\": \"IP\",\n\t\t\"vrf\": \"V103-KO\"\n\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/","collectionId":"1","id":"1-14-67","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Update generic Routes","dataMode":"raw","description":"Update generic Routes.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/route
BODY{
    \"GenericRoutes\": [
    {
        \"id\": 29,
        \"mgmtId\": 3,
        \"destination\": \"111.100.10.11\",
        \"mask\": \"255.255.0.0\",
        \"interfaceName\": \"YOLO3\",
        \"nextHop\": \"100.100.10.10\",
        \"nextHopType\": \"IP\",
        \"vrf\": \"V103-KO\"
    },
    {
        \"id\": 30,
        \"mgmtId\": 3,
        \"destination\": \"222.100.10.22\",
        \"mask\": \"255.255.0.0\",
        \"interfaceName\": \"catch22\",
        \"nextHop\": \"100.100.10.10\",
        \"nextHopType\": \"IP\",
        \"vrf\": \"V103-KO\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Interface/Management Not Found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"GenericRoutes\": [\n\t{\n\t\t\"id\": 29,\n\t\t\"mgmtId\": 3,\n\t\t\"destination\": \"111.100.10.11\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"interfaceName\": \"YOLO3\",\n\t\t\"nextHop\": \"100.100.10.10\",\n\t\t\"nextHopType\": \"IP\",\n\t\t\"vrf\": \"V103-KO\"\n\t},\n\t{\n\t\t\"id\": 30,\n\t\t\"mgmtId\": 3,\n\t\t\"destination\": \"222.100.10.22\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"interfaceName\": \"catch22\",\n\t\t\"nextHop\": \"100.100.10.10\",\n\t\t\"nextHopType\": \"IP\",\n\t\t\"vrf\": \"V103-KO\"\n\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/","collectionId":"1","id":"1-14-68","method":"PUT"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Get cloud information","dataMode":"raw","description":"Returns information about all clouds in the topology.
This API includes the ID of the cloud, the number of routes that point to the cloud, and the relevant devices (including the management_id) that have routes that point to the cloud.
This information can be used to identify missing devices that may need to be added to the topology or to identify clouds that are candidates for being joined.

Parameters:
context: Global MSSP context [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/cloud_suggestions
BODY{
    \"suggested_clouds\": {
        \"count\": 2,
        \"total\": 2,
        \"cloud\": [
            {
                \"management_name\": \"FW1\",
                \"management_id\": 20,
                \"cloud_name\": \"Cloud 10.100.0.1\",
                \"cloud_id\": 120,
                \"vertex_id\": 250,
                \"ip\": \"10.100.0.1\",
                \"routes_count\": 5,
                \"is_parent\": false
            },
            {
                \"management_name\": \"FW2\",
                \"management_id\": 21,
                \"cloud_name\": \"Cloud 172.16.0.1\",
                \"cloud_id\": 125,
                \"vertex_id\": 270,
                \"ip\": \"172.16.0.1\",
                \"routes_count\": 7,
                \"is_parent\": false,
                \"parent_vertex_id\": 40
                \"parent_cloud_id\": 45
                \"parent_cloud_name\": \"Cloud 172.16.0.1\",
            }
        ]
    }
}


Response Messages:
202: Accepted
403: User is not permitted to access the specified domain","folder":"1-14","rawModeData":"{\n\t\"suggested_clouds\": {\n\t\t\"count\": 2,\n\t\t\"total\": 2,\n\t\t\"cloud\": [\n\t\t\t{\n\t\t\t\t\"management_name\": \"FW1\",\n\t\t\t\t\"management_id\": 20,\n\t\t\t\t\"cloud_name\": \"Cloud 10.100.0.1\",\n\t\t\t\t\"cloud_id\": 120,\n\t\t\t\t\"vertex_id\": 250,\n\t\t\t\t\"ip\": \"10.100.0.1\",\n\t\t\t\t\"routes_count\": 5,\n\t\t\t\t\"is_parent\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"management_name\": \"FW2\",\n\t\t\t\t\"management_id\": 21,\n\t\t\t\t\"cloud_name\": \"Cloud 172.16.0.1\",\n\t\t\t\t\"cloud_id\": 125,\n\t\t\t\t\"vertex_id\": 270,\n\t\t\t\t\"ip\": \"172.16.0.1\",\n\t\t\t\t\"routes_count\": 7,\n\t\t\t\t\"is_parent\": false,\n\t\t\t\t\"parent_vertex_id\": 40\n\t\t\t\t\"parent_cloud_id\": 45\n\t\t\t\t\"parent_cloud_name\": \"Cloud 172.16.0.1\",\n\t\t\t}\n\t\t]\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/cloud_suggestions","collectionId":"1","id":"1-14-69","method":"GET"},{"name":"Update an existing generic device in the Topology model","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Modify an existing generic device by uploading a new configuration file and/or specifying a new name.
If name field is specified, the generic device will be renamed.
configuration_file is optional, if provided it must include a valid generic device configuration.
The specified path points to a file in the client machine.
If a generic device name is changed and a new configuration file is not provided, topology will not be synchronized (update_topology flag is ignored).
Default value for update_topology = true.
To save time when there are several consecutive api calls: For the last call, set update_topology = true (for all other calls, update_topology = false).
For more information on input file formats, refer to Knowledge Center topic 'Adding and Updating a Generic Device'.

Parameters:
id: Generic device id
body: Generic device to be updated [optional]
configuration_file: Configuration File for generic device [optional]
update_topology: Synchronize And Update Topology [optional]

Usage Example
curl -X PUT -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F \"configuration_file=@/tmp/config.txt;type=application/octet-stream\" -F \"update_topology=true\" https://192.168.1.1/securetrack/api/generic_devices/24

Usage Example
curl -X PUT -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F 'device_data={\"generic_device\":{\"name\": \"new_generic_device_name\"}};type=application/json' -F \"update_topology=false\" https://192.168.1.1/securetrack/api/generic_devices/72

Response Messages:
204: The generic device was updated successfully.
400: A new name or a new configuration file must be indicated in order to update generic device with id {}
400: Failed to update generic device with id {}
404: A 'Generic Device' with the specified ID was not found","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/{{id}}","collectionId":"1","id":"1-14-70","method":"PUT"},{"name":"Delete generic device from Topology model","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Delete a generic device from the Topology model.
The ID must be for a valid generic device listed in the Topology Model.
If update update_topology = true, then the Topology model will be updated immediately after the device is deleted.
For maximum efficiency, if you are deleting multiple generic devices in consecutive API calls, you can set update_topology = false on all API calls except for the last one. On the last call, set update_toplogy = true.
Default value for update_topology = true.

Parameters:
id: Generic device id
update_topology: Synchronize And Update Topology [optional]

Usage Example
https://192.168.1.1/securetrack/api/generic_devices/1

Usage Example
https://192.168.1.1/securetrack/api/generic_devices/10?update_topology=false

Response Messages:
204: Generic Device deleted successfully.
400: Failed to delete generic device with id {}
404: A 'Generic Device' with the specified ID was not found","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/{{id}}","collectionId":"1","id":"1-14-71","method":"DELETE"},{"name":"Get path image for specified traffic","data":[{"value":null,"type":"text","enabled":true,"key":"src"},{"value":null,"type":"text","enabled":true,"key":"dst"},{"value":null,"type":"text","enabled":true,"key":"service"}],"dataMode":"params","description":"Returns an image containing one or more paths for the specified traffic.
src and dst parameters may contain multiple, comma separated values.
Service parameter can be a port (for example, “tcp:80”, “any”) or an application (for example, “Skype”, “Facebook”).
Application names are case sensitive.
Service parameter can also be a combination of ports and applications, for example “tcp:80, Skype, Facebook”
If sourceDomainIdTag is provided, the path starting points will be restricted to the specified domain ID. sourceDomainIdTag is valid only if overlapping IP mode is enabled.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is valid only if MSSP mode is enabled.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.
displayIncompletePaths parameter default value is false, if this parameter is set to true -
all nodes on the path will be displayed, even if the node cannot reach the destination, or if the source and destination are the same.
displayBlockedStatus parameter default value is false, if this parameter is set to true -
blocked traffic icons will be displayed next to devices blocking the traffic.
simulateNat parameter default value is true if this parameter is set to false - NAT simulation will not be used when calculating the path.
lastInstall parameter default value is true, which means simulation would use last installed policies. If this parameter is set to false - simulation would use last saved policies.
This API cannot be executed more than 10 times in parallel.

Parameters:
context: Global MSSP context [optional]
src: Source address/addresses
dst: Destination address/addresses
service: Service/services
sourceDomainIdTag: Path starting point Domain Id [optional]
displayIncompletePaths: Display incomplete paths [optional]
displayBlockedStatus: Display blocked traffic status icons [optional]
simulateNat: Simulate NAT [optional]
lastInstall: Last Installed [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/path_image?src=10.10.10.1&dst=3.3.3.3:32&service=any

Usage Example
https://192.168.1.1/securetrack/api/topology/path_image?src=10.10.10.1&dst=3.3.3.3:32&service=Facebook,tcp:80

Usage Example
https://192.168.1.1/securetrack/api/topology/path_image?src=netobj:422:GW_123.120&dst=netobj:483:uni/tn-common/out-CommonL3Out/lnodep-LNP&service=any
","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/path_image","collectionId":"1","id":"1-14-72","method":"GET"},{"headers":"Accept: application/json\n","name":"Get generic Route","description":"Get a generic Route by Id.

Parameters:
routeId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/route/30
OUTPUT{
    GenericRoute: {
        id: 30,
        mgmtId: 2,
        destination: \"222.100.10.22\",
        mask: \"255.255.0.0\",
        interfaceName: \"catch22\",
        nextHop: \"100.100.10.10\",
        nextHopType: \"IP\",
        vrf: \"V102-YO\"
    }
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Generic Route Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/{{routeId}}","collectionId":"1","id":"1-14-73","method":"GET"},{"headers":"Accept: application/json\n","name":"Delete generic Route","description":"Delete a generic Route by Id.

Parameters:
routeId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/route/5\n

Response Messages:
204: No Content.
400: Bad Request.
403: Access is denied.
404: Generic Route Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/{{routeId}}","collectionId":"1","id":"1-14-74","method":"DELETE"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Create generic Interfaces","dataMode":"raw","description":"Create generic Interfaces.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interface
BODY{
    \"GenericInterfaces\": [
    {
        \"mgmtId\": 1,
        \"name\": \"Bob1\",
        \"ip\": \"100.100.45.55\",
        \"mask\": \"255.255.0.0\",
        \"vrf\": \"V101-PA\",
        \"mpls\": false,
        \"unnumbered\": false,
        \"type\": \"external\"
    },
    {
        \"mgmtId\": 2,
        \"name\": \"Bob2\",
        \"ip\": \"100.100.45.66\",
        \"mask\": \"255.255.255.0\",
        \"vrf\": \"V101-BA\",
        \"mpls\": false,
        \"unnumbered\": false,
        \"type\": \"external\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management Not Found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"GenericInterfaces\": [\n\t{\n\t\t\"mgmtId\": 1,\n\t\t\"name\": \"Bob1\",\n\t\t\"ip\": \"100.100.45.55\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"vrf\": \"V101-PA\",\n\t\t\"mpls\": false,\n\t\t\"unnumbered\": false,\n\t\t\"type\": \"external\"\n\t},\n\t{\n\t\t\"mgmtId\": 2,\n\t\t\"name\": \"Bob2\",\n\t\t\"ip\": \"100.100.45.66\",\n\t\t\"mask\": \"255.255.255.0\",\n\t\t\"vrf\": \"V101-BA\",\n\t\t\"mpls\": false,\n\t\t\"unnumbered\": false,\n\t\t\"type\": \"external\"\n\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface","collectionId":"1","id":"1-14-75","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Update generic Interfaces","dataMode":"raw","description":"Update generic Interfaces.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interface
BODY{
    \"GenericInterfaces\": [
    {
        \"id\": 204,
        \"mgmtId\": 1,
        \"name\": \"NewBob1\",
        \"ip\": \"100.100.45.55\",
        \"mask\": \"255.255.0.0\",
        \"vrf\": \"V101-LV\",
        \"mpls\": false,
        \"unnumbered\": false,
        \"type\": null
    },
    {
        \"id\": 205,
        \"mgmtId\": 2,
        \"name\": \"NewBob2\",
        \"ip\": \"100.100.45.55\",
        \"mask\": \"255.255.255.0\",
        \"vrf\": \"V101-LV\",
        \"mpls\": false,
        \"unnumbered\": false,
        \"type\": \"external\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Interface/Management Not Found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"GenericInterfaces\": [\n\t{\n\t\t\"id\": 204,\n\t\t\"mgmtId\": 1,\n\t\t\"name\": \"NewBob1\",\n\t\t\"ip\": \"100.100.45.55\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"vrf\": \"V101-LV\",\n\t\t\"mpls\": false,\n\t\t\"unnumbered\": false,\n\t\t\"type\": null\n\t},\n\t{\n\t\t\"id\": 205,\n\t\t\"mgmtId\": 2,\n\t\t\"name\": \"NewBob2\",\n\t\t\"ip\": \"100.100.45.55\",\n\t\t\"mask\": \"255.255.255.0\",\n\t\t\"vrf\": \"V101-LV\",\n\t\t\"mpls\": false,\n\t\t\"unnumbered\": false,\n\t\t\"type\": \"external\"\n\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface","collectionId":"1","id":"1-14-76","method":"PUT"},{"headers":"Accept: application/json\n","name":"Delete generic Interfaces","description":"Delete all generic Interfaces from management Id.

Parameters:
mgmtId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/interface/mgmt/2\n

Response Messages:
200: 11 Generic Interfaces were deleted from mgmtId 2.
400: Bad Request.
403: Access is denied.
404: Management Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface/mgmt/{{mgmtId}}","collectionId":"1","id":"1-14-77","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get generic Interfaces","description":"Get generic Interfaces of management Id.

Parameters:
mgmtId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interface/mgmt/1
OUTPUT{
    GenericInterfaces: [
    {
        id: 206,
        mgmtId: 1,
        name: \"newApo3\",
        ip: \"100.103.33.33\",
        mask: \"255.255.255.0\",
        vrf: \"V101-PA\",
        mpls: false,
        unnumbered: false,
        type: \"external\"
    },
    {
        id: 208,
        mgmtId: 1,
        name: \"newApo4\",
        ip: \"100.103.33.34\",
        mask: \"255.255.255.0\",
        vrf: \"V101-PA\",
        mpls: false,
        unnumbered: false,
        type: \"internal\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface/mgmt/{{mgmtId}}","collectionId":"1","id":"1-14-78","method":"GET"},{"headers":"Accept: application/json\n","name":"Get generic Interface","description":"Get a generic Interface by Id.

Parameters:
inId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interface/212
OUTPUT{
    GenericInterface: {
        id: 212,
        mgmtId: 1,
        name: \"newApo5\",
        ip: \"100.103.33.33\",
        mask: \"255.255.255.0\",
        vrf: \"V101-PAL\",
        mpls: false,
        unnumbered: false,
        type: \"external\"
    }
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Generic Interface Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface/{{inId}}","collectionId":"1","id":"1-14-79","method":"GET"},{"headers":"Accept: application/json\n","name":"Delete generic Interface","description":"Delete a generic Interface by Id.

Parameters:
inId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/interface/5\n

Response Messages:
204: No Content.
400: Bad Request.
403: Access is denied.
404: Generic Interface Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface/{{inId}}","collectionId":"1","id":"1-14-80","method":"DELETE"},{"headers":"Content-Type: application/json\n","name":"Update a cloud","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"raw","description":"Modify the name of a topology cloud, and add/remove members of a joined cloud.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
Multi-Domain user must have access permission to the domain context of the joined cloud, and any members specified in the body.
To change the name of a topology cloud, enter a value in the name field of the body.
To add/remove members of a joined cloud, specify the action and specify the clouds in the members list of the body.
The action is used only if the body contains a members list. If a members list is provided but no actions is specified, then the default action is ‘add’.
When adding cloud members, clouds included in the members list of the body must not be joined clouds or members of another joined cloud.
When removing cloud members, if only zero or one member remains in the joined cloud, it will be deleted from the Interactive Map.

Parameters:
id: cloud id
action: action [optional]
body: Cloud data
forceTopologyInit: Force Topology Init [optional]

Usage Example
URLfor renaming of any cloud - https://192.168.1.1/securetrack/api/topology/clouds/436
BODY{
    \"cloud_data\":{
        \"cloud_name\" : \"new cloud\"
    }
}


Usage Example
URLfor renaming and members updating of a joined cloud - https://192.168.1.1/securetrack/api/topology/clouds/436?action=remove
BODY{
    \"cloud_data\":{
        \"cloud_name\" : \"new cloud\",
        \"cloud_members\" : [118,179,258]
    }
}


Response Messages:
204: Cloud updated successfully
403: Access is denied
403: You do not have access permission to the domain for cloud with id ID
404: Cloud with id ID was not found in the provided MSSP domain
412: Cloud with id ID is a not joined cloud
412: Cloud id: cloudId does not belong to domain: Context
412: Provided clouds don't belongs to the same domain
412: Cloud with id ID is a joined cloud
412: Cloud with id ID is a member of a joined cloud
412: Member cloud with id ID cannot be removed - it is not a member of a joined cloud","folder":"1-14","rawModeData":"{\n\t\"cloud_data\":{\n\t\t\"cloud_name\" : \"new cloud\",\n\t\t\"cloud_members\" : [118,179,258]\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds/{{id}}","collectionId":"1","id":"1-14-81","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get Specific topology cloud","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the topology cloud data for the specified id.
This API requires 'Super admin' or 'Multi-Domain admin' privileges.
Multi-Domain user must have access permission to the domain where the cloud resides.

Parameters:
id: Cloud id

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds/48
OUTPUT{
    \"topology_cloud\": {
        \"id\": 48,
        \"name\": \"Cloud 69.70.120.155\",
        \"domain\": 1,
        \"type\": \"NON_JOINED\",
        \"ip\": \"69.70.120.155\"
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds/66
OUTPUT{
    \"topology_cloud\": {
        \"id\": 66,
        \"name\": \"Cloud 10.100.10.14\",
        \"domain\": 1,
        \"type\": \"JOINED\",
        \"members\": [
            {
                \"id\": 50,
                \"ip\": \"10.100.6.238\",
                \"name\": \"Cloud 10.100.6.238\"
            },
            {
                \"id\": 73,
                \"ip\": \"10.100.10.14\",
                \"name\": \"Cloud 10.100.10.14\"
            },
            {
                \"id\": 74,
                \"ip\": \"10.100.9.9\",
                \"name\": \"Cloud 10.100.9.9\"
            }
        ]
    }
}


Response Messages:
403: Access is denied
403: You do not have access permission to the domain for cloud with id ID
404: No cloud was found for the provided ID","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds/{{id}}","collectionId":"1","id":"1-14-82","method":"GET"},{"headers":"Accept: application/json\n","name":"Get generic Routes","description":"Get generic Routes of management Id.

Parameters:
mgmtId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/route/mgmt/2
OUTPUT{
    GenericRoutes: [
    {
        id: 27,
        mgmtId: 2,
        destination: \"10.4.4.4\",
        mask: \"255.0.0.0\",
        interfaceName: \"\",
        nextHop: \"AA\",
        nextHopType: \"VR\",
        vrf: \"V102-YO\"
    },
    {
        id: 28,
        mgmtId: 2,
        destination: \"10.4.5.5\",
        mask: \"255.0.0.0\",
        interfaceName: \"eeee\",
        nextHop: \"\",
        nextHopType: \"IP\",
        vrf: \"V101-PA\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/mgmt/{{mgmtId}}","collectionId":"1","id":"1-14-83","method":"GET"},{"headers":"Accept: application/json\n","name":"Delete generic Routes","description":"Delete all generic Routes from management Id.

Parameters:
mgmtId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/route/mgmt/2\n

Response Messages:
200: 11 Generic Routes were deleted from mgmtId 2.
400: Bad Request.
403: Access is denied.
404: Management Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/mgmt/{{mgmtId}}","collectionId":"1","id":"1-14-84","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get path domains for specified traffic","data":[{"value":null,"type":"text","enabled":true,"key":"src"},{"value":null,"type":"text","enabled":true,"key":"dst"},{"value":null,"type":"text","enabled":true,"key":"service"}],"dataMode":"params","description":"Returns one or more domain entries for the specified traffic.
src and dst parameters may contain multiple, comma separated values.
Service parameter can be a port (for example, “tcp:80”, “any”) or an application (for example, “Skype”, “Facebook”).
Application names are case sensitive.
Service parameter can also be a combination of ports and applications, for example “tcp:80, Skype, Facebook”
If sourceDomainIdTag is provided, the path starting points will be restricted to the specified domain ID. sourceDomainIdTag is valid only if overlapping IP mode is enabled.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is valid only if MSSP mode is enabled.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.
includeIncompletePaths parameter default value is false, if this parameter is set to true -
all nodes on the path will be included, even if the node cannot reach the destination, or if the source and destination are the same.
simulateNat parameter default value is true if this parameter is set to false - NAT simulation will not be used when calculating the path.
lastInstall parameter default value is true, which means simulation would use last installed policies. If this parameter is set to false - simulation would use last saved policies.
This API cannot be executed more than 10 times in parallel.

Parameters:
context: Global MSSP context [optional]
src: Source address/addresses
dst: Destination address/addresses
service: Service/services
sourceDomainIdTag: Path starting point Domain Id [optional]
includeIncompletePaths: Include incomplete paths [optional]
simulateNat: Simulate NAT [optional]
lastInstall: Last Installed [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/path_domains?src=10.10.10.1&dst=3.3.3.3:32&service=any

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/path_domains?src=10.0.2.1&dst=10.0.1.1&service=Facebook,tcp:80
OUTPUT {
    \"path_domain_entries\": {
        \"path_domain_entry\": [
                {
                        \"domainId\": \"1\",
                        \"vertex\": \"Subnet 10.0.2.0/24\",
                        \"entryType\": \"STARTING_POINT\",
                }
                {
                        \"domainId\": \"1\",
                        \"vertex\": \"Subnet 10.0.1.0/24\",
                        \"entryType\": \"ENDING_POINT\",
                }
    ]
}

","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/path_domains","collectionId":"1","id":"1-14-85","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Update manual Interface CustomerTags","dataMode":"raw","description":"Update manual Interface CustomerTags.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interfacecustomer
BODY{
    \"InterfaceCustomerTags\":
    [
        {
            \"id\": 73,
            \"generic\": false,
            \"deviceId\": 5,
            \"interfaceName\": \"port5\",
            \"customerId\": 2
        },
        {
            \"id\": 74,
            \"generic\": false,
            \"deviceId\": 5,
            \"interfaceName\": \"port3\",
            \"customerId\": 3
        }
    ]
}


Response Messages:
200: OK.
400: Interface CustomerTag already exist for deviceId-InterfaceName/Interface not found on deviceId
403: Access is denied.
404: Management/GenericDevice Not Found./Customer Id not found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"InterfaceCustomerTags\": \n\t[\n\t\t{\n\t\t\t\"id\": 73,\n\t\t\t\"generic\": false,\n\t\t\t\"deviceId\": 5,\n\t\t\t\"interfaceName\": \"port5\",\n\t\t\t\"customerId\": 2\n\t\t},\n\t\t{\n\t\t\t\"id\": 74,\n\t\t\t\"generic\": false,\n\t\t\t\"deviceId\": 5,\n\t\t\t\"interfaceName\": \"port3\",\n\t\t\t\"customerId\": 3\n\t\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/","collectionId":"1","id":"1-14-86","method":"PUT"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Create manual Interface CustomerTags","dataMode":"raw","description":"Create manual Interface CustomerTags.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interfacecustomer
BODY{
    \"InterfaceCustomerTags\":
    [
        {
            \"generic\": false,
            \"deviceId\": 5,
            \"interfaceName\": \"port4\",
            \"customerId\": 2
        },
        {
            \"generic\": false,
            \"deviceId\": 6,
            \"interfaceName\": \"port3\",
            \"customerId\": 3
        }
    ]
}


Response Messages:
200: OK.
400: Interface CustomerTag already exist for deviceId-InterfaceName/Interface not found on deviceId
403: Access is denied.
404: Management/GenericDevice Not Found./Customer Id not found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"InterfaceCustomerTags\": \n\t[\n\t\t{\n\t\t\t\"generic\": false,\n\t\t\t\"deviceId\": 5,\n\t\t\t\"interfaceName\": \"port4\",\n\t\t\t\"customerId\": 2\n\t\t},\n\t\t{\n\t\t\t\"generic\": false,\n\t\t\t\"deviceId\": 6,\n\t\t\t\"interfaceName\": \"port3\",\n\t\t\t\"customerId\": 3\n\t\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/","collectionId":"1","id":"1-14-87","method":"POST"},{"headers":"Accept: application/json\n","name":"Delete Transparent Firewall","description":"Delete Transparent Firewall by Id.

Parameters:
layer2DataId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/transparentfw/17\n

Response Messages:
200: layer2DataId 17 deleted.
400: Bad Request.
403: Access is denied.
404: Layer2Data Id 17 not found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw/{{layer2DataId}}","collectionId":"1","id":"1-14-88","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Delete Ignored Interfaces.","description":"Delete Ignored Interfaces by management id.

Parameters:
mgmtId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/ignoredinterface/mgmt/10\n

Response Messages:
200: 2 entries deleted where mgmtId = 10
400: Bad Request.
403: Access is denied.
404: Management Id 10 not found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/ignoredinterface/mgmt/{{mgmtId}}","collectionId":"1","id":"1-14-89","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get Ignored Interfaces.","description":"Get Ignored Interfaces by management id.

Parameters:
mgmtId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/ignoredinterface/mgmt/10
OUTPUT{
    IgnoredInterfaces: [
        {
            interfaceName: \"eth2\",
            mgmtId: 10,
            ip: \"0.0.0.0\"
        },
        {
            interfaceName: \"loopback100\",
            mgmtId: 10,
            ip: \"34.34.34.34\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/ignoredinterface/mgmt/{{mgmtId}}","collectionId":"1","id":"1-14-90","method":"GET"},{"headers":"Accept: application/json\n","name":"Delete manual Interface CustomerTags","description":"Delete all manual Interface CustomerTags from management/genericDevice Id.

Parameters:
deviceId [optional]
generic [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/interfacecustomer/device/6?generic=false\n

Response Messages:
200: 2 Interface Customers were deleted from deviceId 6.
400: Bad Request.
403: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/device/{{deviceId}}","collectionId":"1","id":"1-14-91","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get manual Interface CustomerTags","description":"Get manual Interface CustomerTags of management/genericDevice Id.

Parameters:
deviceId [optional]
generic [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interfacecustomer/device/5?generic=false
OUTPUT{
    InterfaceCustomerTags: [
        {
            id: 73,
            generic: false,
            deviceId: 5,
            interfaceName: \"port4\",
            customerId: 2
        },
        {
            id: 74,
            generic: false,
            deviceId: 5,
            interfaceName: \"port4.1\",
            customerId: 3
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/device/{{deviceId}}","collectionId":"1","id":"1-14-92","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Create Transparent Firewalls","dataMode":"raw","description":"Create Transparent Firewalls.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/transparentfw
BODY{
    \"TransparentFirewalls\":
    [
     {
            \"outputL3DeviceId\" : 22,
            \"outputL3IsGenericDevice\" : false,
            \"outputL3InterfaceName\" : \"FastEthernet0/0\",
            \"outputL3InterfaceIp\" : \"\",
            \"layer2DeviceId\" : 21,
            \"inputL2InterfaceName\" : \"inside\",
            \"outputL2InterfaceName\" : \"outside\",
            \"inputL3DeviceId\" : 20,
            \"inputL3IsGenericDevice\" : false,
            \"inputL3InterfaceName\" : \"Loopback0\",
            \"inputL3InterfaceIp\" : \"\"
        },
        {
            \"outputL3DeviceId\" : 23,
            \"outputL3IsGenericDevice\" : false,
            \"outputL3InterfaceName\" : \"FastEthernet2/0\",
            \"outputL3InterfaceIp\" : \"\",
            \"layer2DeviceId\" : 9,
            \"inputL2InterfaceName\" : \"inside\",
            \"outputL2InterfaceName\" : \"outside\",
            \"inputL3DeviceId\" : 17,
            \"inputL3IsGenericDevice\" : false,
            \"inputL3InterfaceName\" : \"mgmt\",
            \"inputL3InterfaceIp\" : \"\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Device Id 23 not found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"TransparentFirewalls\": \n\t[\n\t {\n\t\t\t\"outputL3DeviceId\" : 22,\n\t\t\t\"outputL3IsGenericDevice\" : false,\n\t\t\t\"outputL3InterfaceName\" : \"FastEthernet0/0\",\n\t\t\t\"outputL3InterfaceIp\" : \"\",\n\t\t\t\"layer2DeviceId\" : 21,\n\t\t\t\"inputL2InterfaceName\" : \"inside\",\n\t\t\t\"outputL2InterfaceName\" : \"outside\",\n\t\t\t\"inputL3DeviceId\" : 20,\n\t\t\t\"inputL3IsGenericDevice\" : false,\n\t\t\t\"inputL3InterfaceName\" : \"Loopback0\",\n\t\t\t\"inputL3InterfaceIp\" : \"\"\n\t\t},\n\t\t{\n\t\t\t\"outputL3DeviceId\" : 23,\n\t\t\t\"outputL3IsGenericDevice\" : false,\n\t\t\t\"outputL3InterfaceName\" : \"FastEthernet2/0\",\n\t\t\t\"outputL3InterfaceIp\" : \"\",\n\t\t\t\"layer2DeviceId\" : 9,\n\t\t\t\"inputL2InterfaceName\" : \"inside\",\n\t\t\t\"outputL2InterfaceName\" : \"outside\",\n\t\t\t\"inputL3DeviceId\" : 17,\n\t\t\t\"inputL3IsGenericDevice\" : false,\n\t\t\t\"inputL3InterfaceName\" : \"mgmt\",\n\t\t\t\"inputL3InterfaceIp\" : \"\"\n\t\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw","collectionId":"1","id":"1-14-93","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Update Transparent Firewalls","dataMode":"raw","description":"Update Transparent Firewalls.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/transparentfw
BODY{
    \"TransparentFirewalls\":
    [
     {
            \"id\" : 25,
            \"outputL3DeviceId\" : 22,
            \"outputL3IsGenericDevice\" : false,
            \"outputL3InterfaceName\" : \"FastEthernet0/0\",
            \"outputL3InterfaceIp\" : \"\",
            \"layer2DeviceId\" : 21,
            \"inputL2InterfaceName\" : \"inside\",
            \"outputL2InterfaceName\" : \"outside\",
            \"inputL3DeviceId\" : 20,
            \"inputL3IsGenericDevice\" : false,
            \"inputL3InterfaceName\" : \"Loopback2\",
            \"inputL3InterfaceIp\" : \"\"
        },
        {
            \"id\" : 27,
            \"outputL3DeviceId\" : 23,
            \"outputL3IsGenericDevice\" : false,
            \"outputL3InterfaceName\" : \"FastEthernet2/0\",
            \"outputL3InterfaceIp\" : \"\",
            \"layer2DeviceId\" : 9,
            \"inputL2InterfaceName\" : \"inside\",
            \"outputL2InterfaceName\" : \"outside\",
            \"inputL3DeviceId\" : 17,
            \"inputL3IsGenericDevice\" : false,
            \"inputL3InterfaceName\" : \"mgmt2\",
            \"inputL3InterfaceIp\" : \"\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Device Id 23 not found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"TransparentFirewalls\": \n\t[\n\t {\n\t\t\t\"id\" : 25,\n\t\t\t\"outputL3DeviceId\" : 22,\n\t\t\t\"outputL3IsGenericDevice\" : false,\n\t\t\t\"outputL3InterfaceName\" : \"FastEthernet0/0\",\n\t\t\t\"outputL3InterfaceIp\" : \"\",\n\t\t\t\"layer2DeviceId\" : 21,\n\t\t\t\"inputL2InterfaceName\" : \"inside\",\n\t\t\t\"outputL2InterfaceName\" : \"outside\",\n\t\t\t\"inputL3DeviceId\" : 20,\n\t\t\t\"inputL3IsGenericDevice\" : false,\n\t\t\t\"inputL3InterfaceName\" : \"Loopback2\",\n\t\t\t\"inputL3InterfaceIp\" : \"\"\n\t\t},\n\t\t{\n\t\t\t\"id\" : 27,\n\t\t\t\"outputL3DeviceId\" : 23,\n\t\t\t\"outputL3IsGenericDevice\" : false,\n\t\t\t\"outputL3InterfaceName\" : \"FastEthernet2/0\",\n\t\t\t\"outputL3InterfaceIp\" : \"\",\n\t\t\t\"layer2DeviceId\" : 9,\n\t\t\t\"inputL2InterfaceName\" : \"inside\",\n\t\t\t\"outputL2InterfaceName\" : \"outside\",\n\t\t\t\"inputL3DeviceId\" : 17,\n\t\t\t\"inputL3IsGenericDevice\" : false,\n\t\t\t\"inputL3InterfaceName\" : \"mgmt2\",\n\t\t\t\"inputL3InterfaceIp\" : \"\"\n\t\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw","collectionId":"1","id":"1-14-94","method":"PUT"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Create Ignored Interfaces.","dataMode":"raw","description":"Create Ignored Interfaces.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/ignoredinterface
BODY{
    \"IgnoredInterfaces\":
    [
        {
            \"interfaceName\" : \"eth2\",
            \"mgmtId\" : 10,
            \"ip\" : \"0.0.0.0\"
        },
        {
            \"interfaceName\" : \"loopback100\",
            \"mgmtId\" : 10,
            \"ip\" : \"34.34.34.34\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management Id 10 not found.
500: General error occurred.","folder":"1-14","rawModeData":"{\n\t\"IgnoredInterfaces\": \n\t[\n\t\t{\n\t\t\t\"interfaceName\" : \"eth2\",\n\t\t\t\"mgmtId\" : 10,\n\t\t\t\"ip\" : \"0.0.0.0\"\n\t\t},\n\t\t{\n\t\t\t\"interfaceName\" : \"loopback100\",\n\t\t\t\"mgmtId\" : 10,\n\t\t\t\"ip\" : \"34.34.34.34\"\n\t\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/ignoredinterface","collectionId":"1","id":"1-14-95","method":"POST"},{"headers":"Accept: application/json\n","name":"Delete manual Interface CustomerTag","description":"Delete a manual Interface CustomerTag by Id.

Parameters:
interfaceCustomerId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/interfacecustomer/66\n

Response Messages:
204: No Content.
400: Bad Request.
403: Access is denied.
404: InterfaceCustomer Id 66 not found
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/{{interfaceCustomerId}}","collectionId":"1","id":"1-14-96","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get manual Interface CustomerTag","description":"Get manual Interface CustomerTag by Id.

Parameters:
interfaceCustomerId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interfacecustomer/74
OUTPUT{
    InterfaceCustomerTag: {
        id: 74,
        generic: false,
        deviceId: 5,
        interfaceName: \"port4.1\",
        customerId: 3
    }
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: InterfaceCustomer Id 74 not found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/{{interfaceCustomerId}}","collectionId":"1","id":"1-14-97","method":"GET"},{"headers":"Accept: application/json\n","name":"Get topology routing tables for a given device","data":[{"value":null,"type":"text","enabled":true,"key":"mgmtId"}],"dataMode":"params","description":"The returned routing tables are taken from the topology data and will include only devices that are topology enabled.
When adding a device, the user can can choose whether to use dynamic or static topology for the device,
this choice will determine which kind of data is stored in the topology graph and returned by this API.

The parameter mgmtId should be a cluster or a gateway, not a management server.
You may provide a generic device Id (see generic_devices API under 'Monitored Devices' category) -
in this case make sure you set 'is_generic' parameter to 'true'

Parameters:
mgmtId: Management Id or Generic Device Id to query
is_generic: Should be set to 'true' if the provided mgmtId is related to generic device [optional]
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query from starting page, allowable type is numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_routes?mgmtId=10

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_routes?mgmtId=1&is_generic=true
","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/topology_routes","collectionId":"1","id":"1-14-98","method":"GET"},{"headers":"Accept: application/json\n","name":"Get topology network interfaces by device","data":[{"value":null,"type":"text","enabled":true,"key":"mgmtId"}],"dataMode":"params","description":"The returned interfaces are taken from the topology data and will include only devices that are topology enabled.
When adding a device, the user can can choose whether to use dynamic or static topology for the device,
this choice will determine which kind of data is stored in the topology graph and returned by this API.

The parameter mgmtId should be a cluster or a gateway, not a management server.
You may provide a generic device Id (see generic_devices API under 'Monitored Devices' category) -
in this case make sure you set 'is_generic' parameter to 'true'

Parameters:
context: Global MSSP context [optional]
mgmtId: Management Id or Generic Device Id to query
is_generic: Should be set to 'true' if the provided mgmtId is related to generic device [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_interfaces?mgmtId=10

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_interfaces?mgmtId=1&is_generic=true
","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/topology_interfaces","collectionId":"1","id":"1-14-99","method":"GET"},{"headers":"Accept: application/json\n","name":"Get path for specified traffic","data":[{"value":null,"type":"text","enabled":true,"key":"src"},{"value":null,"type":"text","enabled":true,"key":"dst"},{"value":null,"type":"text","enabled":true,"key":"service"}],"dataMode":"params","description":"Returns one or more paths for the specified traffic.
src and dst parameters may contain multiple, comma separated values.
Service parameter can be a port (for example, “tcp:80”, “any”) or an application (for example, “Skype”, “Facebook”).
Application names are case sensitive.
Service parameter can also be a combination of ports and applications, for example “tcp:80, Skype, Facebook”
If sourceDomainIdTag is provided, the path starting points will be restricted to the specified domain ID. sourceDomainIdTag is valid only if overlapping IP mode is enabled.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is valid only if MSSP mode is enabled.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.
includeIncompletePaths parameter default value is false, if this parameter is set to true -
all nodes on the path will be included, even if the node cannot reach the destination, or if the source and destination are the same.
simulateNat parameter default value is true if this parameter is set to false - NAT simulation will not be used when calculating the path.
lastInstall parameter default value is true, which means simulation would use last installed policies. If this parameter is set to false - simulation would use last saved policies.
This API cannot be executed more than 10 times in parallel.

Parameters:
context: Global MSSP context [optional]
src: Source address/addresses
dst: Destination address/addresses
service: Service/services
sourceDomainIdTag: Path starting point Domain Id [optional]
includeIncompletePaths: Include incomplete paths [optional]
simulateNat: Simulate NAT [optional]
lastInstall: Last Installed [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/path?src=10.10.10.1&dst=3.3.3.3:32&service=any

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/path?src=29.29.29.1&dst=25.25.25.1&service=Facebook,tcp:80
OUTPUT {
    \"path_calc_results\": {
        \"traffic_allowed\": false,
        \"device_info\": {
            \"id\": \"17\",
            \"name\": \"PA-VM-111.6 (Cluster)\",
            \"type\": \"mgmt\",
            \"vendor\": \"Palo Alto Networks\",
            \"incomingInterfaces\": {
                \"incomingVrf\": \"default\",
                \"ip\": \"29.29.29.1/255.255.255.252\",
                \"name\": \"tunnel.11\"
            },
            \"nextDevices\": {
                \"name\": \"DIRECTLY_CONNECTED\",
                \"routes\": {
                    \"outgoingInterfaceName\": \"ethernet1/5\",
                    \"outgoingVrf\": \"default\",
                    \"routeDestination\": \"25.25.25.1/255.255.255.0\"
                }
            },
            \"bindings\": {
                \"name\": \"\",
                \"rules\": [
                    {
                        \"action\": \"Accept\",
                        \"applications\": \"facebook\",
                        \"destNegated\": false,
                        \"destinations\": \"Any\",
                        \"ruleIdentifier\": 43,
                        \"serviceNegated\": false,
                        \"services\": \"Any\",
                        \"sourceNegated\": false,
                        \"sources\": \"Any\",
                        \"users\": \"Any\"
                    },
                    {
                        \"action\": \"Deny\",
                        \"applications\": \"Any\",
                        \"destNegated\": false,
                        \"destinations\": \"Any\",
                        \"ruleIdentifier\": 62,
                        \"serviceNegated\": false,
                        \"services\": \"Any\",
                        \"sourceNegated\": false,
                        \"sources\": \"Any\",
                        \"users\": \"Any\"
                    }
                ]
            }
        }
    }
}


Usage Example
https://192.168.1.1/securetrack/api/topology/path?src=netobj:422:GW_123.120&dst=netobj:483:uni/tn-common/out-CommonL3Out/lnodep-LNP&service=any
","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/path","collectionId":"1","id":"1-14-100","method":"GET"},{"headers":"Accept: application/json\n","name":"Get Join Cloud","description":"Get Join Cloud by Id.

Parameters:
cloudId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/join/clouds/67
OUTPUT{
    id: 67,
    name: \"Yami\",
    clouds: [
        1,
        2,
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Cloud Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/join/clouds/{{cloudId}}","collectionId":"1","id":"1-14-101","method":"GET"},{"headers":"Accept: application/json\n","name":"Delete Join Cloud","description":"Delete Join Cloud by Id.

Parameters:
cloudId [optional]
forceTopologyInit: Force Topology Init [optional]

Usage Example
https://{st_host}/securetrack/api/topology/join/clouds/67\n

Response Messages:
204: No Content.
400: Bad Request.
403: Access is denied.
404: Cloud Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/join/clouds/{{cloudId}}","collectionId":"1","id":"1-14-102","method":"DELETE"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Get cloud information","data":[{"value":null,"type":"text","enabled":true,"key":"cloud_id"}],"dataMode":"raw","description":"Returns information about a specific cloud in the topology.
This API includes the ID of the cloud, the number of routes that point to the cloud, and the relevant devices (including the management_id) that have routes that point to the cloud.
This information can be used to identify missing devices that may need to be added to the topology or to identify clouds that are candidates for being joined.

Parameters:
cloud_id: cloud id
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/cloud_suggestions/120
BODY{
    \"suggested_clouds\": {
        \"count\": 1,
        \"total\": 1,
        \"cloud\": {
            \"management_name\": \"FW1\",
            \"management_id\": 20,
            \"cloud_name\": \"Cloud 10.100.0.1\",
            \"cloud_id\": 120,
            \"vertex_id\": 250,
            \"ip\": \"10.100.0.1\",
            \"routes_count\": 5,
            \"is_parent\": false
        }
    }
}


Response Messages:
202: Accepted
403: User is not permitted to access the specified domain","folder":"1-14","rawModeData":"{\n\t\"suggested_clouds\": {\n\t\t\"count\": 1,\n\t\t\"total\": 1,\n\t\t\"cloud\": {\n\t\t\t\"management_name\": \"FW1\",\n\t\t\t\"management_id\": 20,\n\t\t\t\"cloud_name\": \"Cloud 10.100.0.1\",\n\t\t\t\"cloud_id\": 120,\n\t\t\t\"vertex_id\": 250,\n\t\t\t\"ip\": \"10.100.0.1\",\n\t\t\t\"routes_count\": 5,\n\t\t\t\"is_parent\": false\n\t\t}\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/cloud_suggestions/{{cloud_id}}","collectionId":"1","id":"1-14-103","method":"GET"},{"name":"Get path pdf report for specified traffic","data":[{"value":null,"type":"text","enabled":true,"key":"src"},{"value":null,"type":"text","enabled":true,"key":"dst"},{"value":null,"type":"text","enabled":true,"key":"service"}],"dataMode":"params","description":"Returns an pdf report containing one or more paths for the specified traffic.
src and dst parameters may contain multiple, comma separated values.
Service parameter can be a port (for example, “tcp:80”, “any”) or an application (for example, “Skype”, “Facebook”).
Application names are case sensitive.
Service parameter can also be a combination of ports and applications, for example “tcp:80, Skype, Facebook”
If sourceDomainIdTag is provided, the path starting points will be restricted to the specified domain ID. sourceDomainIdTag is valid only if overlapping IP mode is enabled.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is valid only if MSSP mode is enabled.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.
displayIncompletePaths parameter default value is false, if this parameter is set to true -
all nodes on the path will be displayed, even if the node cannot reach the destination, or if the source and destination are the same.
displayBlockedStatus parameter default value is false, if this parameter is set to true -
blocked traffic icons will be displayed next to devices blocking the traffic.
simulateNat parameter default value is true if this parameter is set to false - NAT simulation will not be used when calculating the path.
lastInstall parameter default value is true, which means simulation would use last installed policies. If this parameter is set to false - simulation would use last saved policies.
pathIds parameter default value is empty, which means that all paths would be exported to the report.
This API cannot be executed more than 10 times in parallel.

Parameters:
context: Global MSSP context [optional]
src: Source address/addresses
dst: Destination address/addresses
service: Service/services
sourceDomainIdTag: Path starting point Domain Id [optional]
displayIncompletePaths: Display incomplete paths [optional]
displayBlockedStatus: Display blocked traffic status icons [optional]
simulateNat: Simulate NAT [optional]
lastInstall: Last Installed [optional]
pathIds: Path Ids [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/export_path_results.pdf?src=10.10.10.1&dst=3.3.3.3:32&service=any

Usage Example
https://192.168.1.1/securetrack/api/topology/export_path_results.pdf?src=10.10.10.1&dst=3.3.3.3:32&service=Facebook,tcp:80&pathIds=1,3

Usage Example
https://192.168.1.1/securetrack/api/topology/export_path_results.pdf?src=10.10.10.1&dst=3.3.3.3:32&service=Facebook,tcp:80&pathIds=3

Usage Example
https://192.168.1.1/securetrack/api/topology/export_path_results.pdf?src=netobj:422:GW_123.120&dst=netobj:483:uni/tn-common/out-CommonL3Out/lnodep-LNP&service=any
","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/export_path_results.pdf","collectionId":"1","id":"1-14-104","method":"GET"},{"headers":"Accept: application/json\n","name":"Delete Transparent Firewalls.","description":"Delete Transparent Firewalls for participated layer 2 deviceId

Parameters:
deviceId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/transparentfw/device/9\n

Response Messages:
200: 4 entries deleted where layer2 deviceId = 9
400: Bad Request.
403: Access is denied.
404: DeviceId 9 not found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw/device/{{deviceId}}","collectionId":"1","id":"1-14-105","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get Transparent Firewalls","description":"Get Transparent Firewalls for participated managed/generic DeviceId

Parameters:
deviceId [optional]
generic [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/transparentfw/device/9?generic=false
OUTPUT{
    TransparentFirewalls: [
        {
            id: 17,
            outputL3DeviceId: 22,
            outputL3IsGenericDevice: false,
            outputL3InterfaceName: \"FastEthernet0/0\",
            layer2DeviceId: 9,
            inputL2InterfaceName: \"inside\",
            outputL2InterfaceName: \"outside\",
            inputL3DeviceId: 1,
            inputL3IsGenericDevice: true,
            inputL3InterfaceName: \"interface2\"
        },
        {
            id: 23,
            outputL3DeviceId: 23,
            outputL3IsGenericDevice: false,
            outputL3InterfaceName: \"FastEthernet2/0\",
            layer2DeviceId: 9,
            inputL2InterfaceName: \"inside\",
            outputL2InterfaceName: \"outside\",
            inputL3DeviceId: 17,
            inputL3IsGenericDevice: false,
            inputL3InterfaceName: \"mgmt\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw/device/{{deviceId}}","collectionId":"1","id":"1-14-106","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Create a joined topology cloud","dataMode":"raw","description":"Create a new topology cloud in the Interactive Map by joining existing clouds together.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
The body must include at least two topology cloud ids that are on a single domain.
If the context parameter is not provided, then the API will use the context id of the first member of the members list in the body.
Clouds included in the members list of the body must not be joined clouds or members of another joined cloud.
If the provided body does not specify a joined cloud name, the newly created topology cloud will be given the name of the first member of the members list in the body.


Parameters:
context: Global MSSP context [optional]
body: Cloud data
forceTopologyInit: Force Topology Init [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds
BODY{
    \"cloud_data\":{
        \"cloud_name\" : \"optional new cloud name\",
        \"cloud_members\" : [118,179,258]
    }
}


Response Messages:
201: Joined cloud created successfully
403: Access is denied
403: You do not have access permission to the domain for cloud with id ID
404: Cloud with id ID was not found in the provided MSSP domain
412: You must provide 2 or more clouds
412: Cloud id: cloudId does not belong to domain: Context
412: Cloud with id ID is a joined cloud
412: Cloud with id ID is a member of a joined cloud","folder":"1-14","rawModeData":"{\n\t\"cloud_data\":{\n\t\t\"cloud_name\" : \"optional new cloud name\",\n\t\t\"cloud_members\" : [118,179,258]\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds","collectionId":"1","id":"1-14-107","method":"POST"},{"headers":"Accept: application/json\n","name":"Get topology clouds","description":"Returns a list of the topology clouds for all the domains for which the user has permission to access.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
Use the optional name parameter to restrict the results to topology clouds that contain the specified string.
The default pagination is start=0 and count=50.

Parameters:
context: Global MSSP context [optional]
type: Required clouds type [optional]
name: Cloud name [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds
OUTPUT{
    \"topology_clouds\": {
        \"count\": 3,
        \"total\": 3,
        \"topology_cloud\": [
            {
                \"id\": 48,
                \"name\": \"Cloud 69.70.120.155\",
                \"domain\": 1,
                \"type\": \"NON_JOINED\",
                \"ip\": \"69.70.120.155\"
            },
            {
                \"id\": 50,
                \"name\": \"Cloud 10.100.6.238\",
                \"domain\": 1,
                \"type\": \"MEMBER\",
                \"ip\": \"10.100.6.238\"
            },
            {
                \"id\": 66,
                \"name\": \"Cloud 10.100.10.14\",
                \"domain\": 1,
                \"type\": \"JOINED\",
                \"members\": [
                    {
                        \"id\": 50,
                        \"ip\": \"10.100.6.238\",
                        \"name\": \"Cloud 10.100.6.238\"
                    },
                    {
                        \"id\": 73,
                        \"ip\": \"10.100.10.14\",
                        \"name\": \"Cloud 10.100.10.14\"
                    },
                    {
                        \"id\": 74,
                        \"ip\": \"10.100.9.9\",
                        \"name\": \"Cloud 10.100.9.9\"
                    }
                ]
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds?type=non-joined
OUTPUT{
    \"topology_clouds\": {
        \"count\": 2,
        \"total\": 3,
        \"topology_cloud\": [
            {
                \"id\": 48,
                \"name\": \"Cloud 69.70.120.155\",
                \"domain\": 1,
                \"type\": \"NON_JOINED\",
                \"ip\": \"69.70.120.155\"
            },
            {
                \"id\": 50,
                \"name\": \"Cloud 10.100.6.238\",
                \"domain\": 1,
                \"type\": \"NON_JOINED\",
                \"ip\": \"10.100.6.238\"
            }
        ]
    }
}


Response Messages:
403: Access is denied
403: Only users with ‘Super admin’ permissions can access Global domain map
403: You do not have access permission to domain id: domainId
400: Wrong type provided - allowable values are: joined or non-joined","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds","collectionId":"1","id":"1-14-108","method":"GET"},{"headers":"Accept: application/json\n","name":"Synchronize the Topology model","description":"Invoke of the Topology Model Synchronization.
full_sync=false - Builds the topology model from the information stored in the Tufin database.
full_sync=true - Retrieves the current data from devices and builds the topology model.
Default value for full_sync = false.

Parameters:
full_sync: Perform full sync [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/synchronize

Usage Example
https://192.168.1.1/securetrack/api/topology/synchronize?full_sync=true

Response Messages:
200: The topology synchronization was invoked successfully.
403: Access is denied
500: Error Synchronizing Topology Model
503: Service unavailable, Graph builder is currently running","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/synchronize","collectionId":"1","id":"1-14-109","method":"POST"},{"headers":"Accept: application/json\n","name":"Get Topology Synchronization status","description":"Returns the progress status of the Topology Model Synchronization.



Usage Example
https://192.168.1.1/securetrack/api/topology/synchronize/status

Response Messages:
200: The topology synchronization was invoked successfully.
403: Access is denied
500: Error getting synchronize progress","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/synchronize/status","collectionId":"1","id":"1-14-110","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Create Join Cloud","dataMode":"raw","description":"Create Join Cloud.

Parameters:
body [optional]
forceTopologyInit: Force Topology Init [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/join/clouds
BODY{
    \"JoinCloud\" :
    {
        \"name\" : \"Yami\",
        \"clouds\" : [1, 2]
    }
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Cloud Not Found.
500: General error occurred.","folder":"1-14","rawModeData":"{ \n\t\"JoinCloud\" : \n\t{\n\t\t\"name\" : \"Yami\",\n\t\t\"clouds\" : [1, 2]\n\t}\n} ","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/join/clouds/","collectionId":"1","id":"1-14-111","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Update Join Cloud","dataMode":"raw","description":"Update Join Clouds.

Parameters:
body [optional]
forceTopologyInit: Force Topology Init [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/join/clouds
BODY{
    \"JoinCloud\" :
    {
        \"id\" : 67,
        \"name\" : \"Yamile\",
        \"clouds\" : [1, 2, 57]
    }
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Cloud Not Found.
500: General error occurred.","folder":"1-14","rawModeData":"{ \n\t\"JoinCloud\" : \n\t{\n\t\t\"id\" : 67,\n\t\t\"name\" : \"Yamile\",\n\t\t\"clouds\" : [1, 2, 57]\n\t}\n} ","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/join/clouds/","collectionId":"1","id":"1-14-112","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get generic Vpn","description":"Get a generic Vpn by Id.

Parameters:
vpnId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/vpn/18
OUTPUT{
    GenericVpn: {
        id: 18,
        generic: false,
        deviceId: 2,
        interfaceName: \"777\",
        tunnelSourceIpAddr: \"1.1.1.77\",
        tunnelDestIpAddr: \"1.1.1.88\"
    }
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Generic Vpn Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/{{vpnId}}","collectionId":"1","id":"1-14-113","method":"GET"},{"headers":"Accept: application/json\n","name":"Delete generic Vpn","description":"Delete a generic Vpn by Id.

Parameters:
vpnId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/vpn/5\n

Response Messages:
204: No Content.
400: Bad Request.
403: Access is denied.
404: Generic Vpn Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/{{vpnId}}","collectionId":"1","id":"1-14-114","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Delete generic Vpns","description":"Delete all generic Vpns from management/genericDevice Id.

Parameters:
deviceId [optional]
generic [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/vpn/device/2?generic=false\n

Response Messages:
200: 4 Generic Vpns were deleted from mgmtId 2.
400: Bad Request.
403: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/device/{{deviceId}}","collectionId":"1","id":"1-14-115","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get generic Vpns","description":"Get generic Vpns of management/genericDevice Id.

Parameters:
deviceId [optional]
generic [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/vpn/device/3?generic=true
OUTPUT{
    GenericVpns: [
    {
        id: 17,
        generic: true,
        deviceId: 3,
        interfaceName: \"777\",
        tunnelSourceIpAddr: \"1.1.1.177\",
        tunnelDestIpAddr: \"1.1.1.188\"
    },
    {
        id: 22,
        generic: true,
        deviceId: 3,
        interfaceName: \"111\",
        tunnelSourceIpAddr: \"1.1.1.188\",
        tunnelDestIpAddr: \"1.1.1.177\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred.","folder":"1-14","url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/device/{{deviceId}}","collectionId":"1","id":"1-14-116","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create a zone pattern entry in a specific zone","data":[{"value":null,"type":"text","enabled":true,"key":"zone_id"}],"dataMode":"raw","description":"Create a zone pattern entry in a specific zone by identifier

Parameters:
context: Global MSSP context. [optional]
zone_id: Identifier of the zone containing the zone pattern entry.
body: The zone pattern entry to create.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/pattern-entries
BODY<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<create_pattern_match_entry>
    <pattern_match_entry>
        <id>1</id>
        <zone_id>2</zone_id>
        <domain>
            <id>1</id>
            <name>Default</name>
        </domain>
        <pattern>WEB</pattern>
        <type>security_group_by_name</type>
        <comment>This is a comment</comment>
    </pattern_match_entry>
</create_pattern_match_entry>


Response Messages:
201: The zone pattern entry was created successfully.
403: User is not permitted to access the specified domain
400: Some of pattern entry parameters were invalid or missing
404: A zone with the specified identifier was not found.","folder":"1-15","rawModeData":"\n\n\t\n\t\t1\n\t\t2\n\t\t\n\t\t\t1\n\t\t\tDefault\n\t\t\n\t\tWEB\n\t\tsecurity_group_by_name\n\t\tThis is a comment\n\t\n","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/pattern-entries","collectionId":"1","id":"1-15-117","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Get all pattern entries for specific zones","dataMode":"raw","description":"Get the list of zone pattern entries for specific zones by identifiers

Parameters:
context: Global MSSP context. [optional]
ids: Filter by IDs for the pattern entry results. [optional]
pattern: Filter by pattern string for the zone entry results. [optional]
name: Filter by zone name for the pattern entry results. [optional]
comment: Filter by comment for the pattern entry results. [optional]
sort: Sort ascending or descending. [optional]
start: Starting page number for query results. [optional]
count: Number of pages to return for the query, starting from the specified starting page. [optional]
children: Include child zones in the results. [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/1,2/pattern-entries
BODY<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<pattern_match_entries_find_result>
    <paging_info>
        <start>0</start>
        <count>2</count>
        <total>2</total>
    </paging_info>
    <pattern_match_entries>
        <pattern_match_entry>
            <id>2</id>
            <type>security_group_by_name</type>
            <comment>This is a comment</comment>
            <pattern>WEB</pattern>
            <zone_id>1</zone_id>
        </pattern_match_entry>
        <pattern_match_entry>
            <id>3</id>
            <type>security_group_by_name</type>
            <comment>This is a comment</comment>
            <pattern>WEo</pattern>
            <zone_id>2</zone_id>
        </pattern_match_entry>
    </pattern_match_entries>
</pattern_match_entries_find_result>


Response Messages:
200: The zone pattern entries were successfully retrieved.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-15","rawModeData":"\n\n\t\n\t\t0\n\t\t2\n\t\t2\n\t\n\t\n\t\t\n\t\t\t2\n\t\t\tsecurity_group_by_name\n\t\t\tThis is a comment\n\t\t\tWEB\n\t\t\t1\n\t\t\n\t\t\n\t\t\t3\n\t\t\tsecurity_group_by_name\n\t\t\tThis is a comment\n\t\t\tWEo\n\t\t\t2\n\t\t\n\t\n\n","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/pattern-entries","collectionId":"1","id":"1-15-118","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Get a specific zone pattern entry for a specific zone","data":[{"value":null,"type":"text","enabled":true,"key":"zone_id"},{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"raw","description":"Get a specific zone pattern entry for a specific zone by identifier

Parameters:
context: Global MSSP context. [optional]
zone_id: Identifier of the zone containing the zone entry.
id: Identifier of the zone pattern entry.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/75/pattern-entries/2
BODY<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<pattern_match_entry>
    <id>2</id>    <type>security_group_by_name</type>
    <comment>This is a comment</comment>
    <pattern>WEB</pattern>
    <zone_id>75</zone_id>
    <zone_name>Zone_10_0_0_1</zone_name>
    <domain>
        <address>koko</address>
        <description>bobo</description>
        <id>1</id>
        <name>Default</name>
    </domain>
</pattern_match_entry>


Response Messages:
200: The zone pattern entry was successfully retrieved.
403: User is not permitted to access the specified domain
404: A zone with the specified identifier was not found.
404: A zone pattern entry with the specified identifier was not found.","folder":"1-15","rawModeData":"\n\n\t2\tsecurity_group_by_name\n\tThis is a comment\n\tWEB\n\t75\n\tZone_10_0_0_1\n\t\n\t\t
koko
\n\t\tbobo\n\t\t1\n\t\tDefault\n\t\n\n","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/pattern-entries/{{id}}","collectionId":"1","id":"1-15-119","method":"GET"},{"headers":"Accept: application/json\n","name":"Get entries for a zone","description":"Get the list of zone entries for a zone.

Parameters:
context: Global MSSP context. [optional]
ids: Filter by IDs for the zone entry results. [optional]
name: Filter by name for the zone entry results. [optional]
ip: Filter by IP for the zone entry results. [optional]
netmask: Filter by netmask for the zone entry results. [optional]
prefix: Filter by prefix for the zone entry results. [optional]
comment: Filter by comment for the zone entry results. [optional]
group: Filter by device group for the zone entry results. [optional]
sort: Sort ascending or descending. [optional]
start: Starting page number for query results. [optional]
count: Number of pages to return for the query, starting from the specified starting page. [optional]
children: Include child zones in the results. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/2/entries

Response Messages:
200: The zone entries were successfully retrieved.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-16","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/entries","collectionId":"1","id":"1-16-120","method":"GET"},{"headers":"Accept: application/json\n","name":"Get a specific zone entry","data":[{"value":null,"type":"text","enabled":true,"key":"zone_id"},{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Get a specific zone entry by ID for a zone.

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
id: The ID of the zone entry.

Usage Example
https://192.168.1.1/securetrack/api/zones/2/entries/123

Response Messages:
200: The zone entry was successfully retrieved.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found.","folder":"1-16","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries/{{id}}","collectionId":"1","id":"1-16-121","method":"GET"},{"name":"Delete zone entries","data":[{"value":null,"type":"text","enabled":true,"key":"zone_id"},{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Delete existing zone entries.

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
id: The ID of the zone entry to delete.

Usage Example
https://192.168.1.1/securetrack/api/zones/2/entries/10

Response Messages:
200: The zone entry was deleted successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found.","folder":"1-16","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries/{{id}}","collectionId":"1","id":"1-16-122","method":"DELETE"},{"headers":"Content-Type: application/json\n","name":"Create a zone entry","data":[{"value":null,"type":"text","enabled":true,"key":"zone_id"}],"dataMode":"raw","description":"For IPv4 entry provide IP and netmask/prefix (see Usage Example #1 and #2).
For IPv6 provide IP and prefix only, netmask is not allowed(see Usage Example #3).

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
body: The zone entry to create.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"netmask\": \"255.255.255.0\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"prefix\": \"24\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries
BODY{
\"zone_entry\": {
    \"ip\": \"1b98:c72:1f00:0000::\",
    \"prefix\": \"52\"
    }
}


Response Messages:
201: The zone entry was created successfully.
403: User is not permitted to access the specified domain
400: The zone entry parameters were invalid
404: A zone with the specified ID was not found.","folder":"1-16","rawModeData":"{\n\"zone_entry\": {\n\t\"ip\": \"1b98:c72:1f00:0000::\",\n\t\"prefix\": \"52\"\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries","collectionId":"1","id":"1-16-123","method":"POST"},{"headers":"Content-Type: application/json\n","name":"Modify multiple existing zone entries","data":[{"value":null,"type":"text","enabled":true,"key":"zone_ids"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"raw","description":"For IPv4 entry provide IP and netmask/prefix.
For IPv6 provide IP and prefix only, netmask is not allowed.
new_zone_id is not optional, it may be the same as the present zoneId.

Parameters:
context: Global MSSP context. [optional]
zone_ids: The ID(s) of the zones containing the zone entries.
ids: The ID(s) of the zone entries to modify.
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/85,98/entries/120,139
BODY{
\"zone_entries\" : {
        \"zone_entry\": [
            {
                \"id\": 120,
                \"ip\": \"3.3.3.3\",
                \"prefix\": 32,
                \"new_zone_id\": 85
            },
            {
                \"id\": 139,
                \"ip\": \"1b98:c72:1f00:0001::\",
                \"prefix\": \"52\",
                \"new_zone_id\": 98
            }
        ]
}
}


Response Messages:
200: The zone entry was modified successfully.
403: User is not permitted to access the specified domain
400: The zone entry parameters were invalid
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found.","folder":"1-16","rawModeData":"{\n\"zone_entries\" : {\n\t\t\"zone_entry\": [\n\t\t\t{\n\t\t\t\t\"id\": 120,\n\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\"prefix\": 32,\n\t\t\t\t\"new_zone_id\": 85\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": 139,\n\t\t\t\t\"ip\": \"1b98:c72:1f00:0001::\",\n\t\t\t\t\"prefix\": \"52\",\n\t\t\t\t\"new_zone_id\": 98\n\t\t\t}\n\t\t]\n}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_ids}}/entries/{{ids}}","collectionId":"1","id":"1-16-124","method":"PUT"},{"name":"Modify a zone entry","data":[{"value":null,"type":"text","enabled":true,"key":"zone_ids"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Modify an existing zone entry.

Parameters:
context: Global MSSP context. [optional]
zone_ids: The ID(s) of the zones containing the zone entry.
ids: The ID(s) of the zone entries to delete.

Usage Example
https://192.168.1.1/securetrack/api/zones/2,3/entries/10,20

Response Messages:
200: The zone entry was deleted successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found.","folder":"1-16","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_ids}}/entries/{{ids}}","collectionId":"1","id":"1-16-125","method":"DELETE"},{"headers":"Content-Type: application/json\n","name":"Modify a zone entry","data":[{"value":null,"type":"text","enabled":true,"key":"zone_id"},{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"raw","description":"For IPv4 entry provide IP and netmask/prefix (see Usage Example #1 and #2).
For IPv6 provide IP and prefix only, netmask is not allowed(see Usage Example #3).

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
id: The ID of the zone entry.
body: The modified zone entry.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries/1
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"netmask\": \"255.255.255.0\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries/1
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"prefix\": \"24\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries/1
BODY{
\"zone_entry\": {
    \"ip\": \"1b98:c72:1f00:0000::\",
    \"prefix\": \"52\"
    }
}


Response Messages:
200: The zone entry was modified successfully.
403: User is not permitted to access the specified domain
400: The zone entry parameters were invalid
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found.","folder":"1-16","rawModeData":"{\n\"zone_entry\": {\n\t\"ip\": \"1b98:c72:1f00:0000::\",\n\t\"prefix\": \"52\"\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries/{{id}}","collectionId":"1","id":"1-16-126","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get all zones","description":"Gets a list of all zones.

Parameters:
context: Global MSSP context. [optional]
name: Filter by zone name for the zone results. [optional]
comment: Filter by zone comment for the zone results. [optional]
imported: List domains that imported zones. [optional]
includeInternet: Include the Internet zone. [optional]
includeImported: Include imported zones. [optional]
sort: Sort ascending or descending. [optional]
start: Starting page number for query results. [optional]
count: Number of pages to return for the query, starting from the specified starting page. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones

Response Messages:
200: The zones were retrieved successfully.
403: User is not permitted to access the specified domain","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/","collectionId":"1","id":"1-17-127","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Create a zone","dataMode":"raw","description":"Create a zone.

Parameters:
context: Global MSSP context. [optional]
body: The zone to add.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones
BODY<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<zone>
    <name>DMZ</name>
    <comment>All DMZ addresses</comment>
    <shared>false</shared>
</zone>


Response Messages:
201: The zone was created successfully.
403: User is not permitted to access the specified domain
400: The zone parameters were invalid","folder":"1-17","rawModeData":"\n\n\tDMZ\n\tAll DMZ addresses\n\tfalse\n","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/","collectionId":"1","id":"1-17-128","method":"POST"},{"collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/","name":"Delete all zones","method":"DELETE","id":"1-17-129","description":"Delete all existing zones.

Parameters:
context: Global MSSP context. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones

Response Messages:
204: All zones were successfully deleted.
403: User is not permitted to access the specified domain","folder":"1-17"},{"headers":"Accept: application/json\n","name":"Get ancestor zones for a zone","data":[{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Get a list of ancestor zones for the specified zone(s).

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones for which to look for ancestor zones.

Usage Example
https://192.168.1.1/securetrack/api/zones/123,234/ancestors

Response Messages:
200: The zone ancestors were retrieved successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/ancestors","collectionId":"1","id":"1-17-130","method":"GET"},{"headers":"Accept: application/json\n","name":"Get configuration usages for a zone","data":[{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Get a list of configuration usages for the specified zone(s).

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones for which to look for configuration dependencies.

Usage Example
https://192.168.1.1/securetrack/api/zones/2,3/dependencies

Response Messages:
200: The zone dependencies were retrieved successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/dependencies","collectionId":"1","id":"1-17-131","method":"GET"},{"name":"Add a zone as an ancestor to a zone","data":[{"value":null,"type":"text","enabled":true,"key":"child_id"},{"value":null,"type":"text","enabled":true,"key":"parent_ids"}],"dataMode":"params","description":"Add a zone(s) as an ancestor to a existing zone.

Parameters:
context: Global MSSP context. [optional]
child_id: The ID of the zone for which to add ancestors zone(s).
parent_ids: The ID(s) of the zones to add as ancestors.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/ancestors/10,20

Response Messages:
200: The zone was added as an ancestor successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{child_id}}/ancestors/{{parent_ids}}","collectionId":"1","id":"1-17-132","method":"PUT"},{"name":"Remove a zone as an ancestor to a zone","data":[{"value":null,"type":"text","enabled":true,"key":"child_id"},{"value":null,"type":"text","enabled":true,"key":"parent_ids"}],"dataMode":"params","description":"Remove a zone(s) as an ancestor to a existing zone.

Parameters:
context: Global MSSP context. [optional]
child_id: The ID of the zone for which to remove ancestors zone(s).
parent_ids: The ID(s) of the zones to remove as ancestors.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/ancestors/10,20

Response Messages:
200: The zone was removed as an ancestor successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{child_id}}/ancestors/{{parent_ids}}","collectionId":"1","id":"1-17-133","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get shared zones","description":"Get a list of shared zones.

Parameters:
context: Global MSSP context. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/shared

Response Messages:
200: The list of shared zones was retrieved successfully.
403: User is not permitted to access the specified domain","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/shared","collectionId":"1","id":"1-17-134","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Map network elements to security zones","dataMode":"raw","description":"This API maps each network element in the AccessRequestNetworkListDTO (such as IP address, IP address range, object, or group) to all matching Tufin security zones. If the network element is a group, then each zone also identifies all matching group members. The internet referral object can be included in the list, and will always map to the predefined Internet security zone. If the 'Any' element is included in the list it will map to all zones.
Note: if multi-domain mode is enabled, the API calls only checks zones that are in the “Default” domain.

Parameters:
body: AccessRequestNetworkListDTO

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_zones
BODY<network_objects>
     <network_object xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"ip_network\">
         <network xsi:type=\"raw_network_subnet\">
         <ip>10.8.8.0</ip>
         <mask>255.255.255.0</mask>
         </network>
     </network_object>
</network_objects>


Response Messages:
200: Returns mapping of network elements to security zones
400: Access Request Network List is malformed.
403: Access is denied.","folder":"1-17","rawModeData":"\n\t \n\t\t \n\t\t 10.8.8.0\n\t\t 255.255.255.0\n\t\t \n\t \n","url":"https://{{SecureTrack_IP}}/securetrack/api/security_zones/","collectionId":"1","id":"1-17-135","method":"POST"},{"collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/import/{{ids}}","name":"Import a zone","method":"POST","id":"1-17-136","description":"Import a shared zone into the specified domain

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones to import. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/import/10,20

Response Messages:
200: The zone was imported successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17"},{"headers":"Content-Type: application/xml\n","name":"Modify a zone","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"raw","description":"Modify an existing zone.

Parameters:
context: Global MSSP context. [optional]
id: The ID of the zone to modify.
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2
BODY<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<zone>
    <id>2</id>
    <name>DMZ</name>
    <comment>All DMZ hosts</comment>
    <shared>false</shared>
    <internet>false</internet>
    <user_networks>false</user_networks>
    <unassociated_networks>false</unassociated_networks>
</zone>


Response Messages:
204: The specified zone was successfully modified.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
400: The zone parameters were invalid","folder":"1-17","rawModeData":"\n\n\t2\n\tDMZ\n\tAll DMZ hosts\n\tfalse\n\tfalse\n\tfalse\n\tfalse\n","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{id}}","collectionId":"1","id":"1-17-137","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get a specific zone","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Get the zone with the specified ID.

Parameters:
context: Global MSSP context. [optional]
id: The ID of the zone to get.
imported: List domains that imported zones. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/2

Response Messages:
200: The zone was retrieved successfully.
403: User is not permitted to access the specified domain
403: A zone with the specified ID does not exist.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{id}}","collectionId":"1","id":"1-17-138","method":"GET"},{"headers":"Accept: application/json\n","name":"Get descendant zones for a zone","data":[{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Get a list of zones descended from the specified zone(s).

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones for which to look for descendant zones.

Usage Example
https://192.168.1.1/securetrack/api/zones/10,20/descendants

Response Messages:
200: The zone descendants were retrieved successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/descendants","collectionId":"1","id":"1-17-139","method":"GET"},{"name":"Remove a zone as an descendants to a zone","data":[{"value":null,"type":"text","enabled":true,"key":"parent_id"},{"value":null,"type":"text","enabled":true,"key":"child_ids"}],"dataMode":"params","description":"Remove a zone(s) as an descendants to a existing zone.

Parameters:
context: Global MSSP context. [optional]
parent_id: The ID of the zone for which to remove descendant zone(s).
child_ids: The ID(s) of the zone to remove as a descendant.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/descendants/10,20

Response Messages:
200: The zone was removed as an descendant successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{parent_id}}/descendants/{{child_ids}}","collectionId":"1","id":"1-17-140","method":"DELETE"},{"name":"Add a zone as a descendant to a zone","data":[{"value":null,"type":"text","enabled":true,"key":"parent_id"},{"value":null,"type":"text","enabled":true,"key":"child_ids"}],"dataMode":"params","description":"Add a zone(s) as a descendant to a existing zone.

Parameters:
context: Global MSSP context. [optional]
parent_id: The ID of the zone for which to add descendant zone(s).
child_ids: The ID(s) of the zones to add as descendants.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/descendants/10,20

Response Messages:
200: The zone was added as an descendant successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{parent_id}}/descendants/{{child_ids}}","collectionId":"1","id":"1-17-141","method":"PUT"},{"name":"Delete a zone","data":[{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Delete an existing zone.

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zone to delete.

Usage Example
https://192.168.1.1/securetrack/api/zones/1,2

Response Messages:
204: The specified zone was successfully deleted.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.","folder":"1-17","url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}","collectionId":"1","id":"1-17-142","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get policies by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of policies defined on a given revision ID

Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/policies
","folder":"1-18","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/policies","collectionId":"1","id":"1-18-143","method":"GET"},{"headers":"Accept: application/json\n","name":"Get rules by input and output interfaces","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"}],"description":"Parameters:
device_id: The unique identifier of target device
inputInterfaceName: Input interface name [optional]
outputInterfaceName: Output interface name [optional]
isIpv6: Is ipv6 policy [optional]

Usage Example
https://192.168.1.1/securetrack/api/bindings/2/topology_interfaces?inputInterfaceName=ethernet1/1&outputInterfaceName=ethernet1/2
","dataMode":"params","folder":"1-18","url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/topology_interfaces","collectionId":"1","id":"1-18-144","method":"GET"},{"headers":"Accept: application/json\n","name":"Get policies by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of policies defined on a given device ID.
Supported devices: CheckPoint, Panorama Advanced, FortiManager Basic and Advanced, FMC and NSX.

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/20/policies
","folder":"1-18","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/policies","collectionId":"1","id":"1-18-145","method":"GET"},{"headers":"Accept: application/json\n","name":"Get list of sub-policies (bindings) with input and/or output interfaces","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"supremum_version_id"},{"value":null,"type":"text","enabled":true,"key":"inputInterfaceName"},{"value":null,"type":"text","enabled":true,"key":"outputInterfaceName"}],"dataMode":"params","description":"Retrieve list of bindings of input and/or output interfaces

Parameters:
device_id: The unique identifier of target device
supremum_version_id: The unique identifier of target revision
inputInterfaceName: Input interface name
outputInterfaceName: Output interface name

Usage Example
https://192.168.1.1/securetrack/api/bindings/20/binding_query?supremum_version_id=785&inputInterfaceName=Any&outputInterfaceName=Any
","folder":"1-18","url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/binding_query","collectionId":"1","id":"1-18-146","method":"GET"},{"headers":"Accept: application/json\n","name":"Get sub-policies (bindings) by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns a list of all of the subpolicies (bindings) for a given revision.
The definition of subpolicy is different for each vendor:
Check Point - policy package and inline layer (inline layer will be returned only when the optional include_subpolicy parameter is set to true)
Cisco - ACL
Juniper/Fortinet/Palo Alto/Stonesoft - zone-to-zone policy
Cloud platforms - Security Groups


Parameters:
context: Global MSSP context [optional]
id: Revision ID
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
include_subpolicy: when set to true, includes sub policies in the returned result, supported only for Checkpoint [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/bindings

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/bindings? include_subpolicy=true
","folder":"1-18","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/bindings","collectionId":"1","id":"1-18-147","method":"GET"},{"headers":"Accept: application/json\n","name":"Get sub-policies (bindings) by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns a list of all of the subpolicies (bindings) for a given device.
The definition of subpolicy is different for each vendor:
Check Point - policy package and inline layer (inline layer will be returned only when the optional include_subpolicy parameter is set to true)
Cisco - ACL
Juniper/Fortinet/Palo Alto/Stonesoft - zone-to-zone policy
Cloud platforms - Security Groups


Parameters:
context: Global MSSP context [optional]
id: Device ID
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
include_subpolicy: when set to true, includes sub policies in the returned result, supported only for Checkpoint [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/bindings

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/bindings? include_subpolicy=true
","folder":"1-18","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/bindings","collectionId":"1","id":"1-18-148","method":"GET"},{"headers":"Accept: application/json\n","name":"Run Policy Analysis query","data":[{"value":null,"type":"text","enabled":true,"key":"device_ids"},{"value":null,"type":"text","enabled":true,"key":"sources"},{"value":null,"type":"text","enabled":true,"key":"destinations"},{"value":null,"type":"text","enabled":true,"key":"services"}],"description":"Parameters:
device_ids: Device ids
sources: Source list
destinations: Destination list
services: Service list
exclude_any: Exclude any in the specified, comma-separated fields of source, destination or service. For example: exclude_any = destination,service [optional]
action: Action [optional]

Usage Example
https://192.168.1.1/securetrack/api/policy_analysis/query/matching_rules?device_ids=41&sources=33.33.33.0:24,113.113.113.100&destinations=114.1.1.0:24&services=tcp:80&exclude_any=source,destination

Response Messages:
200: Returns request results.
400: Error in request syntax.","dataMode":"params","folder":"1-19","url":"https://{{SecureTrack_IP}}/securetrack/api/policy_analysis/query/matching_rules","collectionId":"1","id":"1-19-149","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific rule documentation","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"rule_id"}],"dataMode":"params","description":"Fetches rule documentation for a single rule given by revision ID and rule ID.

Parameters:
context: Global MSSP context [optional]
id: Revision id
rule_id: Id of the requested rule

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules/16373/documentation
","folder":"1-20","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules/{{rule_id}}/documentation","collectionId":"1","id":"1-20-150","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Modify specific rule documentation","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"rule_id"}],"dataMode":"raw","description":"Modify rule documentation for a single rule identified by revision ID and rule ID.
A single rule can be set as either a stealth rule or legacy rule. If both flags are set, an error will be returned (error 400, Bad request).
If no rule documentation exists for the rule, the specified documentation is added to the rule and the response code is: 201 Created.
If rule documentation already exists for the rule, the specified documentation replaces the existing documentation and the response code is: 204 No Content.
Record set entries that are automatically created or calculated, for example automatic mapping to a SecureChange ticket, cannot be modified.
The following fields are automatically calculated, and cannot be modified:
Permissiveness, Violations, Last Hit, Last Modified, Shadowing Status, Certification Status, Certification Date, Certification Expiration Date, Application Name, Application Owner

Parameters:
context: Global MSSP context [optional]
id: Revision id
rule_id: Id of the changed rule
body: RuleDocumentationDTO

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/173/rules/3373/documentation
BODY<rule_documentation>
     <tech_owner>admin</tech_owner>
     <comment>Comment text</comment>
     <legacy_rule>false</legacy_rule>
     <stealth_rule>true</stealth_rule>
     <record_set>
         <businessOwnerEmail>user@company.com</businessOwnerEmail>
         <businessOwnerName>Business Owner</businessOwnerName>
         <expireDate>2013-01-08T00:00:00+02:00</expireDate>
         <id>172</id>
         <ticketCr>789111</ticketCr>
     </record_set>
</rule_documentation>

","folder":"1-20","rawModeData":"\n\t admin\n\t Comment text\n\t false\n\t true\n\t \n\t\t user@company.com\n\t\t Business Owner\n\t\t 2013-01-08T00:00:00+02:00\n\t\t 172\n\t\t 789111\n\t \n","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules/{{rule_id}}/documentation","collectionId":"1","id":"1-20-151","method":"PUT"},{"name":"Delete specific rule documentation","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"rule_id"}],"dataMode":"params","description":"Delete rule documentation for a single rule given by revision ID and rule ID.
If the rule has automatic mapping to a ticket, the record is not deleted.

Parameters:
context: Global MSSP context [optional]
id: Revision id
rule_id: Rule id

Usage Example
https://192.168.1.1/securetrack/api/revisions/173/rules/3373/documentation
","folder":"1-20","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules/{{rule_id}}/documentation","collectionId":"1","id":"1-20-152","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get specific rule documentation","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"rule_id"}],"dataMode":"params","description":"Fetches rule documentation for a single rule given by device ID and rule ID

Parameters:
context: Global MSSP context [optional]
id: Device ID
rule_id: Rule ID

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules/16373/documentation
","folder":"1-20","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules/{{rule_id}}/documentation","collectionId":"1","id":"1-20-153","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Modify specific rule documentation","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"rule_id"}],"dataMode":"raw","description":"Modify rule documentation for a single rule given by device ID and rule ID
A single rule can be set as either a stealth rule or legacy rule. If both flags are set, an error will be returned (error 400, Bad request).
If there is no existing rule documentation for the rule, the specified documentation is added to the rule and the response code is: 201 Created.
If there is existing rule documentation for the rule, the specified documentation replaces the existing documentation and the response code is: 204 No Content.

Parameters:
context: Global MSSP context [optional]
id: Device ID
rule_id: Rule ID
body: RuleDocumentationDTO

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/20/rules/3040/documentation
BODY<rule_documentation>
     <tech_owner>admin</tech_owner>
     <comment>Comment text</comment>
     <legacy_rule>false</legacy_rule>
     <stealth_rule>true</stealth_rule>
     <record_set>
         <businessOwnerEmail>user@company.com</businessOwnerEmail>
         <businessOwnerName>Business Owner</businessOwnerName>
         <expireDate>2013-01-08T00:00:00+02:00</expireDate>
         <id>173</id>
         <ticketCr>789112</ticketCr>
     </record_set>
</rule_documentation>

","folder":"1-20","rawModeData":"\n\t admin\n\t Comment text\n\t false\n\t true\n\t \n\t\t user@company.com\n\t\t Business Owner\n\t\t 2013-01-08T00:00:00+02:00\n\t\t 173\n\t\t 789112\n\t \n\n","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules/{{rule_id}}/documentation","collectionId":"1","id":"1-20-154","method":"PUT"},{"name":"Delete specific rule documentation","data":[{"value":null,"type":"text","enabled":true,"key":"id"},{"value":null,"type":"text","enabled":true,"key":"rule_id"}],"dataMode":"params","description":"Delete rule documentation for a single rule given by device ID and rule ID

Parameters:
context: Global MSSP context [optional]
id: Device ID
rule_id: Rule ID

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules/3040/documentation
","folder":"1-20","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules/{{rule_id}}/documentation","collectionId":"1","id":"1-20-155","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get cleanups results","description":"Parameters:
context: Global MSSP context [optional]
devices: Devices ids [optional]

Usage Example
https://192.168.1.1/securetrack/api/cleanup
","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/cleanup/","collectionId":"1","id":"1-21-156","method":"GET"},{"headers":"Accept: application/json\n","name":"Get the specific objects or rules identified for the cleanup results","data":[{"value":null,"type":"text","enabled":true,"key":"cleanup_id"}],"description":"Parameters:
context: Global MSSP context [optional]
cleanup_id: Cleanup id
devices: Devices ids [optional]
start: Start [optional]
count: Results count [optional]

Usage Example
https://192.168.1.1/securetrack/api/cleanup/1/instances
","dataMode":"params","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/cleanup/{{cleanup_id}}/instances","collectionId":"1","id":"1-21-157","method":"GET"},{"headers":"Accept: application/json\n","name":"Get risks results","description":"Parameters:
context: Global MSSP context [optional]
devices: Devices ids [optional]

Usage Example
https://192.168.1.1/securetrack/api/risk
","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/risk/","collectionId":"1","id":"1-21-158","method":"GET"},{"headers":"Accept: application/json\n","name":"Get cleanups by device","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"code"}],"dataMode":"params","description":"Fetches set of Cleanup calculation results for a device given by ID.
Only fully shadowed rules (cleanup code C01) are supported.

Parameters:
context: Global MSSP context [optional]
device_id: Device ID
code: Cleanup category code
start: Starting page for query allowable values are numeric [optional]
count: Number of pages for query result allowable values are numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/cleanups?code=C01
","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/cleanups","collectionId":"1","id":"1-21-159","method":"GET"},{"headers":"Accept: application/json\n","name":"Get devices in cleanup results","data":[{"value":null,"type":"text","enabled":true,"key":"cleanup_id"}],"description":"Parameters:
context: Global MSSP context [optional]
cleanup_id: Cleanup id

Usage Example
https://192.168.1.1/securetrack/api/cleanup/1/devices
","dataMode":"params","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/cleanup/{{cleanup_id}}/devices","collectionId":"1","id":"1-21-160","method":"GET"},{"headers":"Accept: application/json\n","name":"Get devices in risk results","data":[{"value":null,"type":"text","enabled":true,"key":"risk_id"}],"description":"Parameters:
context: Global MSSP context [optional]
risk_id: Risk id

Usage Example
https://192.168.1.1/securetrack/api/risk/1/devices
","dataMode":"params","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/risk/{{risk_id}}/devices","collectionId":"1","id":"1-21-161","method":"GET"},{"headers":"Accept: application/json\n","name":"Get shadowing rules by device","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"shadowed_uids"}],"dataMode":"params","description":"Find shadowing rules for given shadowed rules of a specific device

Parameters:
device_id: Device ID
shadowed_uids: UIDs of shadowed rules separated by commas

Usage Example
https://192.168.1.1/securetrack/api/devices/31/shadowing_rules?shadowed_uids=78786a0d-b9cc-478e-b7a2-dea953c976c7
","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/shadowing_rules","collectionId":"1","id":"1-21-162","method":"GET"},{"headers":"Accept: application/json\n","name":"Get the specific objects or rules identified for the risk results","data":[{"value":null,"type":"text","enabled":true,"key":"risk_id"}],"description":"Parameters:
context: Global MSSP context [optional]
risk_id: Risk id
devices: Devices ids [optional]
start: Start [optional]
count: Results count [optional]

Usage Example
https://192.168.1.1/securetrack/api/risk/1/instances
","dataMode":"params","folder":"1-21","url":"https://{{SecureTrack_IP}}/securetrack/api/risk/{{risk_id}}/instances","collectionId":"1","id":"1-21-163","method":"GET"},{"headers":"Accept: application/json\n","name":"Get revisions by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches revisions for a given device

Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query starting from starting page allowable type is numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/105/revisions
","folder":"1-22","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/revisions","collectionId":"1","id":"1-22-164","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific revision","data":[{"value":null,"type":"text","enabled":true,"key":"revId"}],"dataMode":"params","description":"Fetches a revision specified by revision Id.
To get revId for this API, use the 'id' property of RevisionDTO that is returned by 'Get revisions by device' or 'Get latest revision by device' APIs

Parameters:
context: Global MSSP context [optional]
revId: Id of fetched revision

Usage Example
https://192.168.1.1/securetrack/api/revisions/785
","folder":"1-22","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revId}}","collectionId":"1","id":"1-22-165","method":"GET"},{"headers":"Accept: application/json\n","name":"Get latest revision by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches latest revision for a given device

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/105/latest_revision
","folder":"1-22","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/latest_revision","collectionId":"1","id":"1-22-166","method":"GET"},{"headers":"Accept: application/json\n","name":"Get last hit for a specific rule","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"rule_uid"}],"dataMode":"params","description":"Get last hit dates for all rules in a given device.
For Palo Alto firewalls, this also returns last hits for users and applications in the rule.
The rule_uid is the value from the uid field returned by the /rules API: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Parameters:
device_id: device_id
rule_uid: rule_uid

Usage Example
https://192.168.1.1/securetrack/api/rule_last_usage/find/20/ea9db13e-d058-45c6-a2f0-cd731027c22b
","folder":"1-23","url":"https://{{SecureTrack_IP}}/securetrack/api/rule_last_usage/find/{{device_id}}/{{rule_uid}}","collectionId":"1","id":"1-23-167","method":"GET"},{"headers":"Accept: application/json\n","name":"Get last hits for all rules by device","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"}],"dataMode":"params","description":"Get last hit dates for all rules in a given device.
For Palo Alto firewalls, this also returns last hits for users and applications in the rule.

Parameters:
device_id: device id

Usage Example
https://192.168.1.1/securetrack/api/rule_last_usage/find_all/20
","folder":"1-23","url":"https://{{SecureTrack_IP}}/securetrack/api/rule_last_usage/find_all/{{device_id}}","collectionId":"1","id":"1-23-168","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific rule","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Returns a list of rules by device ID, rule IDs and additional criteria.
Note: This API retrieves the information from the latest revision.


Parameters:
context: Global MSSP context [optional]
device_id: Device ID
ids: Rule IDs
policy: Policy Name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules only(device dependent, see implementation Notes) [optional]
add: If set to \"documentation\" result will include rule documentation [optional]
groupBy: Rules grouping criteria, can be set only to \"bindings\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules/16370
","folder":"1-24","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/rules/{{ids}}","collectionId":"1","id":"1-24-169","method":"GET"},{"headers":"Accept: application/json\n","name":"Get rules by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns a list of all of the security rules for the specified device.
Use add=documentation to retrieve rule documentation.
The is_global parameter is device dependent. For ACL devices, only global rules are returned when set to true. For Check Point R80, only global layers are returned when set to true, and specify a layer name in the subpolicy_name parameter This parameter is ignored for all other vendors. The default value is false.
The subpolicy_name parameter is device dependent. For Check Point R80, only rules that use the specified layer are returned. You can only specify the name of a single layer. This parameter is ignored for all other vendors.
For Cisco ASA devices, when applying a filter you must also add the direction.


Parameters:
context: Global MSSP context [optional]
id: Device ID
policyId: Policy ID [optional]
policy: Policy Name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules (Only for: ACL devices) [optional]
add: If set to \"documentation\" result will include rule documentation [optional]
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
groupBy: Show rules grouping criteria. Can be set only to \"bindings\". Output will be grouped by bindings and section header for Check Point devices, ACL for Cisco devices, and Zones for Juniper, Palo Alto, and Fortinet device [optional]
with_zb: Include zone based rules, values can be 'true' or 'false' [optional]
uid: Binding UID [optional]
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
subpolicy_name: Filter by sub policy name (see implementation notes) [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules?subpolicy_name=layer1&is_global=true

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules?interface=Loopback99:INSIDE
","folder":"1-24","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules","collectionId":"1","id":"1-24-170","method":"GET"},{"headers":"Accept: application/json\n","name":"Get a specific rule","data":[{"value":null,"type":"text","enabled":true,"key":"ruleId"}],"description":"Parameters:
ruleId: Rule ID

Usage Example
https://192.168.1.1/securetrack/api/rules/60
","dataMode":"params","folder":"1-24","url":"https://{{SecureTrack_IP}}/securetrack/api/rules/{{ruleId}}","collectionId":"1","id":"1-24-171","method":"GET"},{"headers":"Accept: application/json\n","name":"Find rules","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"}],"dataMode":"params","description":"The search_text parameter provides the same capabilities as the Policy Browser feature in SecureTrack.
You can search for a string across all rule fields, or you can search for a combination of specific strings in specific fields.
The text format is for a field is <fieldname>:<text> for example uid:9259f6ee-47a0-4996-a214-ab7edc14a916.
See the search info documentation in Securetrack Policy Browser page for more information.To get more information regarding objects included in the returned rules (like src_network or dst_network) use their uid, as the objects’ ID might change.
\n By default, if there are less than 3,000 rules - the API will return all the rules.\nIn case there are more than 3,000 rules the API will return an error code 413 with the error message “There are more than 3000 rules, you must use pagination”
“display_rule_number” should return only for Check Point R80 and higher devices.

Parameters:
context: Global MSSP context [optional]
search_text: Search text [optional]
device_id: Device id
start: The starting rule to include in the returned results [optional]
count: Number of rules to include in the results [optional]

Usage Example
https://192.168.1.1/securetrack/api/rule_search/31?search_text=source:Sales_192.168.2.60 fromzone:sales tozone:External

Usage Example
https://192.168.1.1/securetrack/api/rule_search/20?search_text=Mobile Access hascomment:false

Usage Example
https://192.168.1.1/securetrack/api/rule_search/87?search_text=web_server&start=0&count=10

Usage Example
URLhttps://192.168.1.1/securetrack/api/rule_search/59?search_text=uid:9259f6ee-47a0-4996-a214-ab7edc14a916
OUTPUT {
    \"rules\":{
        \"count\":1,
        \"total\":1,
        \"rule\":{
            \"@xsi.type\":\"securityRuleDTO\",
            \"id\":21,
            \"cp_uid\":\"\",
            \"uid\":\"{9259f6ee-47a0-4996-a214-ab7edc14a916}\",
            \"order\":2,
            \"binding\":{
                \"default\":true,
                \"policy\":{
                    \"@xsi.type\":\"managementDomainPolicyDTO\",
                    \"id\":2,
                    \"name\":\"Standard\",
                    \"installable_targets\":\"\"
                },
                \"rule_count\":19,
                \"security_rule_count\":19,
                \"uid\":\"{00-FACED0-00}\"
                },
            \"acceleration_breaker\":false,
            \"action\":\"Accept\",
            \"application\":{
                \"id\":4735,
                \"display_name\":\"ssh\",
                \"name\":\"ssh\"
            },
            \"authentication_rule\":false,
            \"comment\":\"DO NOT DELETE OR EDIT\",
            \"dst_network\":{
                \"id\":39,
                \"display_name\":\"Net_10.110.65.0\",
                \"name\":\"Net_10.110.65.0\"
                \"uid\":\"{1290f6ee-47a1-4996-a214-ab2edc26a916}\"
            },
            \"dest_networks_negated\":false,
            \"dst_service\":{
                \"id\":7420,
                \"display_name\":\"ssh\",
                \"name\":\"ssh\"
                \"uid\":\"{2904f6ee-47a1-4996-a214-ab2edc26a916}\"
            },
            \"dest_services_negated\":false,
            \"dst_zone\":\"any\",
            \"disabled\":false,
            \"external\":false,
            \"implicit\":false,
            \"dst_zone_any\":true,
            \"src_zone_any\":true,
            \"name\":\"Accept SSHG\",
            \"option\":\"LOG_SESSION\",
            \"documentation\":{
                \"permissiveness_level\":\"LOW\",
                \"shadowed\":\"Not shadowed\",
                \"last_modified\":\"Today\",
                \"last_hit\":\"N/A\",
                \"violations\":\"\"
            },
            \"rule_location\":\"Shared\",
            \"rule_location_display\":\"Shared - Pre Rule\",
            \"rule_number\":2,
            \"display_rule_number\":\"2.1\",
            \"rule_type\":\"universal\",
            \"src_zone\":\"any\",
            \"src_network\":{
                \"id\":38,
                \"display_name\":\"Net_10.110.64.0\",
                \"name\":\"Net_10.110.64.0\"
                \"uid\":\"{4934f6ee-47a1-4996-a214-ab2edc26a916}\"
            },
            \"src_networks_negated\":false,
            \"src_services_negated\":false,
            \"track\":{
                \"level\":\"LOG\"
            },
            \"type\":\"rule\",
            \"users\":{
                \"id\":5,
                \"display_name\":\"tufin\\\\regina\",
                \"name\":\"tufin\\\\regina@ldap\"
            }
        }
    }
}


Response Messages:
400: Value for start parameter is missing or not valid
400: Value for count parameter is missing or not valid
413: Max supported count is 3000
413: There are more than 3000 rules, you must use pagination","folder":"1-24","url":"https://{{SecureTrack_IP}}/securetrack/api/rule_search/{{device_id}}","collectionId":"1","id":"1-24-172","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific rule","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Returns a list of rules by revision ID, rule IDs and additional criteria

Parameters:
context: Global MSSP context [optional]
revision_id: Revision id
ids: Rule IDs
policy: Policy name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules (Only for: ACL devices) [optional]
add: If set to \\\"documentation\\\" result will include rule documentation [optional]
groupBy: Rules grouping criteria, can be set only to \\\"bindings\\\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules/16370
","folder":"1-24","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/rules/{{ids}}","collectionId":"1","id":"1-24-173","method":"GET"},{"headers":"Accept: application/json\n","name":"Get rules by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns a list of all of the security rules for the specified revision.
Use add=documentation to retrieve rule documentation.
The is_global parameter is device dependent. For ACL devices, only global rules are returned when set to true. For Check Point R80, only global layers are returned when set to true, and specify a layer name in the subpolicy_name parameter This parameter is ignored for all other vendors. The default value is false.
The subpolicy_name parameter is device dependent. For Check Point R80, only rules that use the specified layer are returned. You can only specify the name of a single layer. This parameter is ignored for all other vendors.
For Cisco ASA devices, when applying a filter you must also add the direction.


Parameters:
context: Global MSSP context [optional]
id: Revision id
policyId: Policy id [optional]
policy: Policy name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules only(device dependent, see implementation Notes) [optional]
add: If set to \"documentation\" result will include rule documentation [optional]
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
groupBy: Rules grouping criteria, can be set only to \"bindings\" [optional]
with_zb: Include zone-based rules [optional]
uid: Binding UID [optional]
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
subpolicy_name: Filter by sub policy name (see implementation notes) [optional]
fetchMigratedCalculations [optional]
is_alternate_order: OrderBy alternate order, for display Aci rules by contracts [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules?subpolicy_name=layer1&is_global=true

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules?interface=Loopback99:INSIDE
","folder":"1-24","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules","collectionId":"1","id":"1-24-174","method":"GET"},{"collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/rule_search/export","name":"Create a CSV file for rules search results","method":"GET","id":"1-24-175","description":"The search_text parameter provides the same capabilities as the Policy Browser feature in SecureTrack.
You can search for a string across all rule fields, or you can search for a combination of specific strings in specific fields.
The text format is for a field is : for example uid:9259f6ee-47a0-4996-a214-ab7edc14a916.
See the search info documentation in Securetrack Policy Browser page for more information.
This API exports the results data as a CSV file in the SecureTrack Reports Repository.

Parameters:
context: Global MSSP context [optional]
search_text: Search text [optional]

Usage Example
https://192.168.1.1/securetrack/api/rule_search/export

Usage Example
https://192.168.1.1/securetrack/api/rule_search/export?search_text=shadowed:true
","folder":"1-24"},{"headers":"Accept: application/json\n","name":"Get rule count per device","description":"The search_text parameter provides the same capabilities as the Policy Browser feature in SecureTrack.
You can search for a string across all rule fields, or you can search for a combination of specific strings in specific fields.
The text format is for a field is <fieldname>:<text> for example uid:9259f6ee-47a0-4996-a214-ab7edc14a916.
See the search info documentation in Securetrack Policy Browser page for more information.
This API will return a list of all the devices, the devices that has rules that match the search criteria will have rule_count that is bigger than 0

Parameters:
context: Global MSSP context [optional]
search_text: Search text [optional]
devices: Devices ids [optional]

Usage Example
https://192.168.1.1/securetrack/api/rule_search/87

Usage Example
https://192.168.1.1/securetrack/api/rule_search/87?search_text=ICMP application:facebook

Usage Example
URLhttps://192.168.1.1/securetrack/api/rule_search?search_text=uid:9259f6ee-47a0-4996-a214-ab7edc14a916
OUTPUT{
    \"device_list\":{
        \"device\":[
            {
                \"device_id\":512,
                \"revision_id\":6864,
                \"rule_count\":1
            },
            {
                \"device_id\":59,
                \"revision_id\":543,
                \"rule_count\":0
            }
        ]
    }
}

","folder":"1-24","url":"https://{{SecureTrack_IP}}/securetrack/api/rule_search/","collectionId":"1","id":"1-24-176","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Get services objects matching specified criteria","data":[{"value":null,"type":"text","enabled":true,"key":"filter"}],"dataMode":"raw","description":"You can search for service objects where the name or comment fields have a specified text string,
or you can search for service objects that have an Port or protocol that matches,
or you can search for service objects by uid.

Parameters:
context: Returns results for the specified domain ID. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]
filter: “text” filter returns service objects where the name or comment fields have a specified text string. \n“protocol” filter returns service objects that have a protocol that matches specified IP protocol number.\n“port” filter returns service objects that have a port that matches specified port number.\n “uid“ filter returns service objects with the specified uid.\n If no filter is specified, the “text” filter is used.
device_id: Returns service objects belonging to the specified device_id. [optional]
name: (For “text” filter) You can specify \"name\" to find service objects with the specified text in the name field. [optional]
comment: (For “text” filter) You can specify “comment” to find service objects with the specified text in the comment field. [optional]
protocol: Specify Protocolto find service objects that have the specified IP Protocol. [optional]
port: Specify Portto find service objects that have the specified Port. [optional]
uid: (for “uid“ filter) Returns service objects with the specified uid. [optional]

Usage Example
https://192.168.1.1/securetrack/api/services/search?filter=protocol&protocol=6&device_id=68

Usage Example
https://192.168.1.1/securetrack/api/services/search?filter=port&port=80

Usage Example
https://192.168.1.1/securetrack/api/services/search?filter=uid&uid=24a8774d-24c1-4b3a-aae9-3c272a2b5191

Usage Example
URLhttps://192.168.1.1/securetrack/api/services/search?filter=text&name=tcp_10
BODY{
    \"services\": {
        \"count\": 1,
        \"total\": 1,
        \"service:\": {
            \"id\": 169197,
            \"name\": \"tcp_10\",
            \"display_name\": \"tcp_10\",
            \"class_name\": \"access_role\",
            \"global\": false,
            \"device_id\": 158,
            \"comment\": \"\",
            \"uid\": \"{9EDC2607-6BEC-43D7-A99D-B522BA694ADA}\",
            \"implicit\": false,
            \"max\": false,
            \"min\": false,
            \"protocol\": 6,
            \"timeout\": \"\",
            \"type\": \"tcp_service\",
            }
        }
    }
}

","folder":"1-25","rawModeData":"{\n\t\"services\": {\n\t\t\"count\": 1,\n\t\t\"total\": 1,\n\t\t\"service:\": {\n\t\t\t\"id\": 169197,\n\t\t\t\"name\": \"tcp_10\",\n\t\t\t\"display_name\": \"tcp_10\",\n\t\t\t\"class_name\": \"access_role\",\n\t\t\t\"global\": false,\n\t\t\t\"device_id\": 158,\n\t\t\t\"comment\": \"\",\n\t\t\t\"uid\": \"{9EDC2607-6BEC-43D7-A99D-B522BA694ADA}\",\n\t\t\t\"implicit\": false,\n\t\t\t\"max\": false,\n\t\t\t\"min\": false,\n\t\t\t\"protocol\": 6,\n\t\t\t\"timeout\": \"\",\n\t\t\t\"type\": \"tcp_service\",\n\t\t\t}\n\t\t}\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/services/search","collectionId":"1","id":"1-25-177","method":"GET"},{"headers":"Accept: application/json\n","name":"Get rules containing specified service object","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the security rules that contain the specified service object


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the service object.
include_groups: You can add \"include_groups\" to find rules that include the service object and rules that include the groups that include the service object. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]

Usage Example
https://192.168.1.1/securetrack/api/services/65078/rules?include_groups=true
","folder":"1-25","url":"https://{{SecureTrack_IP}}/securetrack/api/services/{{id}}/rules","collectionId":"1","id":"1-25-178","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific service","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches list of specific service objects defined in revision given by revision ID and specified by their IDs

Parameters:
context: Global MSSP context [optional]
revision_id: Revision id
ids: Rule IDs
show_members: Set to false to return only the name and ID of the members [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/services/959888
","folder":"1-25","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/services/{{ids}}","collectionId":"1","id":"1-25-179","method":"GET"},{"headers":"Accept: application/json\n","name":"Get service groups containing specified service objects","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns groups that contain the specified service objects


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the service object.

Usage Example
https://192.168.1.1/securetrack/api/services/69577/groups
","folder":"1-25","url":"https://{{SecureTrack_IP}}/securetrack/api/services/{{id}}/groups","collectionId":"1","id":"1-25-180","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific service","data":[{"value":null,"type":"text","enabled":true,"key":"device_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches list of specific service objects defined in device given by device ID and specified by their IDs.
Note: This API retrieves the information from the latest revision.

Parameters:
context: Global MSSP context [optional]
device_id: Device ID
ids: Service object IDs separated by commas
show_members: Set to false to return only the name and ID of the members [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/services/959888,959966
","folder":"1-25","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/services/{{ids}}","collectionId":"1","id":"1-25-181","method":"GET"},{"headers":"Accept: application/json\n","name":"Get services by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of service objects defined on device given by device ID.
The default value for get_total is false. For APIF 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.


Parameters:
context: Global MSSP context [optional]
id: Device ID
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
start: Starting page for query allowable types are numeric [optional]
count: Number of pages for query allowable values are numeric [optional]
name: Service name [optional]
type: Service type, allowable values are: tcp, udp, ip or icmp [optional]
port: Service port [optional]
icmp_type: Service ICMP type allowable values are numeric between 0 to 40 [optional]
protocol: Service protocol, allowable values are numeric between 0 to 255 [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]
add_parent_objects: Panorama only: Get objects from parent DGs (default true) [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/20/services?get_total=true
OUTPUT {
    \"services\": {
        \"count\": 50,
        \"total\": 100,
        \"service\": [{
            \"@xsi.type\": \"singleServiceDTO\",
            \"id\": 5129479,
            \"name\": \"Tcp30025\",
            \"display_name\": \"Tcp30025\",
            \"class_name\": \"tcp_service\",
            \"type\": \"tcp_service\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{079F15A5-009E-7E47-BBD0-E65973646562}\",
            \"implicit\": false,
            \"overrides\": false,
            \"max\": 30025,
            \"min\": 30025,
            \"negate\": false,
            \"protocol\": 6,
            \"timeout\": 0
        }]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/services?type=group&show_members=false
OUTPUT{
    \"services\": {
    \"count\": 100,
        \"service\": [
            {
                \"@xsi.type\": \"serviceGroupDTO\",
                \"id\": 1359066,
                \"name\": \"#Shared Domain@DNS\",
                \"display_name\": \"DNS\",
                \"class_name\": \"service_group\",
                \"type\": \"group\",
                \"global\": \"false\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": false,
                \"overrides\": \"false\",
                \"type_on_device\": gen_service_group,
                \"is_device_predefined\": true,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"DNS\",
                    \"name\": \"#Shared Domain@DNS\",
            }
        ]
    }
}

","folder":"1-25","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/services","collectionId":"1","id":"1-25-182","method":"GET"},{"headers":"Accept: application/json\n","name":"Get services by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Fetches list of service objects defined in revision given by revision ID
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.


Parameters:
context: Global MSSP context [optional]
id: Revision id
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
start: Starting page for query allowable types are numeric [optional]
count: Number of pages for query allowable values are numeric [optional]
name: Service name [optional]
type: Service type, allowable values are: tcp, udp, ip or icmp [optional]
port: Service port [optional]
icmp_type: Service ICMP type allowable values are numeric between 0 to 40 [optional]
protocol: Service protocol, allowable values are numeric betweenm 0 to 255 [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]
add_parent_objects: Panorama only: Get objects from parent DGs (default true) [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/785/services?get_total=true
OUTPUT {
    \"services\": {
        \"count\": 50,
        \"total\": 100,
        \"service\": [{
            \"@xsi.type\": \"singleServiceDTO\",
            \"id\": 5129479,
            \"name\": \"Tcp30025\",
            \"display_name\": \"Tcp30025\",
            \"class_name\": \"tcp_service\",
            \"type\": \"tcp_service\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{079F15A5-009E-7E47-BBD0-E65973646562}\",
            \"implicit\": false,
            \"overrides\": false,
            \"max\": 30025,
            \"min\": 30025,
            \"negate\": false,
            \"protocol\": 6,
            \"timeout\": 0
        }]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/31/services?type=group&show_members=false
OUTPUT{
    \"services\": {
    \"count\": 100,
        \"service\": [
            {
                \"@xsi.type\": \"serviceGroupDTO\",
                \"id\": 1359066,
                \"name\": \"#Shared Domain@DNS\",
                \"display_name\": \"DNS\",
                \"class_name\": \"service_group\",
                \"type\": \"group\",
                \"global\": \"false\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": false,
                \"overrides\": \"false\",
                \"type_on_device\": gen_service_group,
                \"is_device_predefined\": true,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"DNS\",
                    \"name\": \"#Shared Domain@DNS\",
            }
        ]
    }
}

","folder":"1-25","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/services","collectionId":"1","id":"1-25-183","method":"GET"},{"headers":"Accept: application/json\n","name":"Get specific time object","data":[{"value":null,"type":"text","enabled":true,"key":"revision_id"},{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Fetches list of time objects by revision ID and rule ID

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Rule IDs

Usage Example
https://192.168.1.1/securetrack/api/revisions/7/time_objects/9
","folder":"1-26","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/time_objects/{{ids}}","collectionId":"1","id":"1-26-184","method":"GET"},{"headers":"Accept: application/json\n","name":"Get time objects by device","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the time objects used in the specified device.

Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable values are numeric [optional]
count: Starting page for query allowable values are numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/time_objects
","folder":"1-26","url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/time_objects","collectionId":"1","id":"1-26-185","method":"GET"},{"headers":"Accept: application/json\n","name":"Get time objects by revision","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns the time objects used in the specified revision.

Parameters:
context: Global MSSP context [optional]
id: Revision ID
start: Starting page for query allowable value is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/time_objects
","folder":"1-26","url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/time_objects","collectionId":"1","id":"1-26-186","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Get policy relevance metrics for traffic","dataMode":"raw","description":"The response lists all the relevant security groups, tags, relevant instances, and count of unrelated instances for each Amazon VPC in the specified traffic path.
A relevant security group contains at least one instance including either the source or destination IP address.
An unrelated instance is included in the security group but not part of the specified traffic path.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is used only if MSSP mode is enabled. If MSSP mode is disabled context is ignored.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.

Parameters:
context: Global MSSP context [optional]
body: Relevance metrics request

Usage Example
URLhttps://192.168.1.1/securetrack/api/traffic_policy
BODY{
    \"relevance_metrics\": {
        \"source_ips\": {
            \"source\":[\"10.10.253.0/24\", \"172.31.50.99/32\"]
        },
        \"dest_ips\": {
            \"dest\": [\"172.31.150.0/24\", \"172.31.50.99/32\"]
        },
        \"targets\": {
            \"target\": [4, 10]
        }
    }
}


Response Messages:
200: Successful
403: Insufficient user permissions
404: Device not found
400: Invalid parameters","folder":"1-27","rawModeData":"{\n\t\"relevance_metrics\": {\n\t\t\"source_ips\": {\n\t\t\t\"source\":[\"10.10.253.0/24\", \"172.31.50.99/32\"]\n\t\t},\n\t\t\"dest_ips\": {\n\t\t\t\"dest\": [\"172.31.150.0/24\", \"172.31.50.99/32\"]\n\t\t},\n\t\t\"targets\": {\n\t\t\t\"target\": [4, 10]\n\t\t}\n\t}\n}\n","url":"https://{{SecureTrack_IP}}/securetrack/api/traffic_policy/","collectionId":"1","id":"1-27-187","method":"POST"},{"headers":"Accept: application/json\n","name":"Get violation task status","data":[{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"params","description":"Get access requests violations task status.

Parameters:
taskId: The unique identifier of the access request violations task.

Usage Example
https://192.168.1.1/securetrack/api/violations/access_requests/status/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Access request violations task status was received.
403: Access is denied.
404: Access request violations task status was not found.","folder":"1-28","url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/status/{{taskId}}","collectionId":"1","id":"1-28-188","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/xml\n","name":"Get violations for an access request","dataMode":"raw","description":"Calculate the violations for the given access request.
Note: this API may take a while to complete.
See the asynchronous API /violations/access_request/task as an alternative.

Parameters:
body: AccessRequestListDTO
use_topology: Use topology to determine access request domains. [optional]
ar_domain_mode: The access request supports multiple domains. [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/violations/access_requests/sync?use_topology=false&ar_domain_mode=false
BODY<access_requests>
    <access_request>
     <use_topology>false</use_topology>
     <access_request_order>0</access_request_order>
     <access_request_source xsi:type=\"internet\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"/>
     <access_request_destination xsi:type=\"ip_network\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <network xsi:type=\"raw_network_subnet\">
         <negate>false</negate>
         <ip>10.100.0.1</ip>
         <mask>255.255.255.255</mask>
         </network>
     </access_request_destination>
     <access_request_service xsi:type=\"implicit_service\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <name>ssh</name>
         <service>
         </service>
     </access_request_service>
     <access_request_service xsi:type=\"implicit_service\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <service>
             <predefined>false</predefined>
             <min_protocol>6</min_protocol>
             <max_protocol>6</max_protocol>
             <min_port>22</min_port>
             <max_port>22</max_port>
             <negate>false</negate>
         </service>
     </access_request_service>
     <access_request_application xsi:type=\"access_request_application_identity\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <name>Gmail</name>
     </access_request_application>
     <access_request_application xsi:type=\"access_request_application_identity\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <name>CustomApp</name>
         <application_service xsi:type=\"implicit_service\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
             <service>
                 <predefined>false</predefined>
                 <min_protocol>6</min_protocol>
                 <max_protocol>6</max_protocol>
                 <min_port>80</min_port>
                 <max_port>80</max_port>
                 <negate>false</negate>
             </service>
         </application_service>
     </access_request_application>
     <action>ACCEPT</action>
    </access_request>
</access_requests>


Response Messages:
200: Access request violations were calculated.
400: Access request order is not unique.
400: Domain cannot be specified when domain mode is false.
400: Cannot specify both ticket domain id and source and destination domains.
400: No domain specified in MSSP mode.
400: Domain does not exist.
400: Access request is malformed.
400: No valid access requests (Access requests cannot have topology enabled and the Internet object in the Source/Destination).
403: Access is denied.
400: Custom applications must have their services configured.","folder":"1-28","rawModeData":"\n\t\n\t false\n\t 0\n\t \n\t \n\t\t \n\t\t false\n\t\t 10.100.0.1\n\t\t 255.255.255.255\n\t\t \n\t \n\t \n\t\t ssh\n\t\t \n\t\t \n\t \n\t \n\t\t \n\t\t\t false\n\t\t\t 6\n\t\t\t 6\n\t\t\t 22\n\t\t\t 22\n\t\t\t false\n\t\t \n\t \n\t \n\t\t Gmail\n\t \n\t \n\t\t CustomApp\n\t\t \n\t\t\t \n\t\t\t\t false\n\t\t\t\t 6\n\t\t\t\t 6\n\t\t\t\t 80\n\t\t\t\t 80\n\t\t\t\t false\n\t\t\t \n\t\t \n\t \n\t ACCEPT\n\t\n\n","url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/sync","collectionId":"1","id":"1-28-189","method":"POST"},{"name":"Cancel violation task","data":[{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"params","description":"Delete an access request violations task.

Parameters:
taskId: The unique identifier of the access request violations task.

Usage Example
https://192.168.1.1/securetrack/api/violations/access_requests/task/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
204: Access request violations task has been aborted successfully.
403: Access is denied.
404: Access request violations task was not found.","folder":"1-28","url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/task/{{taskId}}","collectionId":"1","id":"1-28-190","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get violation task results","data":[{"value":null,"type":"text","enabled":true,"key":"taskId"}],"dataMode":"params","description":"Get result of access requests violations task.

Parameters:
taskId: The unique identifier of the access request violations task.

Usage Example
https://192.168.1.1/securetrack/api/violations/access_requests/result/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Access request violations task results were received.
403: Access is denied.
404: An error occurred during the calculation.
404: The calculation for the task has not finished yet.","folder":"1-28","url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/result/{{taskId}}","collectionId":"1","id":"1-28-191","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Start a task to calculate violations for an access request","dataMode":"raw","description":"Create a calculation task to find access requests violations.
Returns a task Id that can be used to check the task status and get the task results

Parameters:
body [optional]
use_topology: Use topology to determine access request domains. [optional]
ar_domain_mode: The access request uses resources from multiple domains. [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/violations/access_requests/task?use_topology=false&ar_domain_mode=false
BODY<access_requests>
    <access_request>
     <use_topology>false</use_topology>
     <access_request_order>0</access_request_order>
     <access_request_source xsi:type=\"internet\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"/>
     <access_request_destination xsi:type=\"ip_network\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <network xsi:type=\"raw_network_subnet\">
         <negate>false</negate>
         <ip>10.100.0.1</ip>
         <mask>255.255.255.255</mask>
         </network>
     </access_request_destination>
     <access_request_service xsi:type=\"implicit_service\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <name>ssh</name>
         <service>
         </service>
     </access_request_service>
     <access_request_service xsi:type=\"implicit_service\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <service>
             <predefined>false</predefined>
             <min_protocol>6</min_protocol>
             <max_protocol>6</max_protocol>
             <min_port>22</min_port>
             <max_port>22</max_port>
             <negate>false</negate>
         </service>
     </access_request_service>
     <access_request_application xsi:type=\"access_request_application_identity\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <name>Gmail</name>
     </access_request_application>
     <access_request_application xsi:type=\"access_request_application_identity\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <name>CustomApp</name>
         <application_service xsi:type=\"implicit_service\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
             <service>
                 <predefined>false</predefined>
                 <min_protocol>6</min_protocol>
                 <max_protocol>6</max_protocol>
                 <min_port>80</min_port>
                 <max_port>80</max_port>
                 <negate>false</negate>
             </service>
         </application_service>
     </access_request_application>
     <action>ACCEPT</action>
    </access_request>
</access_requests>


Response Messages:
202: Access request violations task was accepted.
400: Access request order is not unique.
400: Domain cannot be specified when domain mode is false.
400: Cannot specify both ticket domain id and source and destination domains.
400: No domain specified in MSSP mode.
400: Domain does not exist.
400: Access request is malformed.
400: No valid access requests (Access requests cannot have topology enabled and the Internet object in the Source/Destination)
400: No network source were specified.
400: No network destination were specified.
403: Access is denied.
503: Access request violations task was rejected.
400: Custom applications must have their services configured.","folder":"1-28","rawModeData":"\n\t\n\t false\n\t 0\n\t \n\t \n\t\t \n\t\t false\n\t\t 10.100.0.1\n\t\t 255.255.255.255\n\t\t \n\t \n\t \n\t\t ssh\n\t\t \n\t\t \n\t \n\t \n\t\t \n\t\t\t false\n\t\t\t 6\n\t\t\t 6\n\t\t\t 22\n\t\t\t 22\n\t\t\t false\n\t\t \n\t \n\t \n\t\t Gmail\n\t \n\t \n\t\t CustomApp\n\t\t \n\t\t\t \n\t\t\t\t false\n\t\t\t\t 6\n\t\t\t\t 6\n\t\t\t\t 80\n\t\t\t\t 80\n\t\t\t\t false\n\t\t\t \n\t\t \n\t \n\t ACCEPT\n\t\n\n","url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/task","collectionId":"1","id":"1-28-192","method":"POST"},{"headers":"Accept: application/json\n","name":"Get a specific alert","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Returns a specified alert.
If the alert_id does not exist, an error message is returned.

Parameters:
context: MSSP context [optional]
id: The alert Id

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts/1

Response Messages:
403: Alert ID does not exist","folder":"1-29","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/{{id}}","collectionId":"1","id":"1-29-193","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Update an alert","dataMode":"raw","description":"Update an alert for unified security policies.
Alerts can be defined for all devices (all_devices:true) or for specified device IDs.
An email and/or user name must be defined. For multiple entries of emails or user names, use a semicolon to separate values. For SecureTrack, users in the collection are populated with \"user_ids\". The alert will be sent to the users (according to the addresses configured in SecureTrack) and to the emails.
To get the domain_id (optional parameter), call /domains/ API and use the ID included within the returned domain DTO.
At least one severity should be marked as 'true'.
There are no default values

Parameters:
context: Global MSSP context [optional]
id: The alert ID for updating [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_policies/alerts/1
BODY{
    \"usp_alert_configuration\": {
        \"name\": \"uspAlert\",
        \"description\": \"description\",
        \"status\": \"ACTIVE\",
        \"domain_id\": 6,
        \"all_devices\": false,
        \"device_ids\": {
            \"device_id\": [
                1,
                2,
                3,
                4
            ]
        },
        \"low_severity\": true,
        \"medium_severity\": true,
        \"high_severity\": true,
        \"critical_severity\": false,
        \"user_ids\": {
            \"user_id\": [
                \"moshe\",
                \"admin\"
                ]
        },
        \"emails\": \"user@doamin.com\",
        \"send_syslog\": true
    }
}


Response Messages:
204: Alert ID: 'alertId' was updated successfully
404: Alert ID: 'alertId' does not exist
412: Alert name not specified
409: Alert name specified already exists
412: Status not specified
412: Domain not specified
404: Domain specified does not exist
403: User is not authorized to configure alerts for domain 'domainId'
412: Device not specified
404: Device ID specified does not exist or belongs to a different domain
403: Device: 'deviceId' not supported for USP
412: Severity not specified
412: No recipient details entered for alert
412: Invalid email address. Format must be name@domain.com
404: Username: 'userName' does not exist
403: User is not authorized to configure alerts for Super Admin user: 'userName'
403: Username: 'userName' not valid for the specified domain","folder":"1-29","rawModeData":"{\n\t\"usp_alert_configuration\": {\n\t\t\"name\": \"uspAlert\",\n\t\t\"description\": \"description\",\n\t\t\"status\": \"ACTIVE\",\n\t\t\"domain_id\": 6,\n\t\t\"all_devices\": false,\n\t\t\"device_ids\": {\n\t\t\t\"device_id\": [\n\t\t\t\t1,\n\t\t\t\t2,\n\t\t\t\t3,\n\t\t\t\t4\n\t\t\t]\n\t\t},\n\t\t\"low_severity\": true,\n\t\t\"medium_severity\": true,\n\t\t\"high_severity\": true,\n\t\t\"critical_severity\": false,\n\t\t\"user_ids\": {\n\t\t\t\"user_id\": [\n\t\t\t\t\"moshe\",\n\t\t\t\t\"admin\"\n\t\t\t\t]\n\t\t},\n\t\t\"emails\": \"user@doamin.com\",\n\t\t\"send_syslog\": true\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/{{id}}","collectionId":"1","id":"1-29-194","method":"PUT"},{"headers":"Accept: application/json\n","name":"Get alerts","data":[{"value":null,"type":"text","enabled":true,"key":"start"},{"value":null,"type":"text","enabled":true,"key":"count"}],"dataMode":"params","description":"Returns a list of all alerts. If an empty list is returned, it implies that there are no configured alerts for that context.
You must set start and count parameters to limit the number of returned alerts.
Start is zero based - to start from the second rule use start=1, to get rules 51-60 use start=50 and count=10.

Parameters:
context: MSSP context [optional]
start: Returns the results beginning with the specified result number
count: Returns the specified number of results

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts?start=10&count=25

Response Messages:
400: Value for start parameter is missing or not valid
400: Value for count parameter is missing or not valid","folder":"1-29","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/","collectionId":"1","id":"1-29-195","method":"GET"},{"headers":"Content-Type: application/json\n","name":"Create an alert","dataMode":"raw","description":"Create an alert for unified security policies.
Returns location with the alert id to get the alert.
Alerts can be defined for all devices (all_devices:true) or for specified device IDs.
An email and/or user name must be defined. For multiple entries of emails or user names, use a semicolon to separate values. For SecureTrack, users in the collection are populated with \"user_ids\". The alert will be sent to the users (according to the addresses configured in SecureTrack) and to the emails.
To get the domain_id (optional parameter), call /domains/ API and use the ID included within the returned domain DTO.
At least one severity should be marked as 'true'.
There are no default values

Parameters:
context: Global MSSP context [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_policies/alerts
BODY{
    \"usp_alert_configuration\": {
        \"name\": \"uspAlert\",
        \"description\": \"description\",
        \"status\": \"ACTIVE\",
        \"domain_id\": 6,
        \"all_devices\": false,
        \"device_ids\": {
            \"device_id\": [
                1,
                2,
                3,
                4
            ]
        },
        \"low_severity\": true,
        \"medium_severity\": true,
        \"high_severity\": true,
        \"critical_severity\": false,
        \"user_ids\": {
            \"user_id\": [
                \"moshe\",
                \"admin\"
                ]
        },
        \"emails\": \"user@doamin.com\",
        \"send_syslog\": true
    }
}


Response Messages:
201: Security policy alert id :|'alertId'| , name : 'alertName'
412: Alert name not specified
409: Alert name specified already exists
412: Status not specified
412: Domain not specified
404: Domain specified does not exist
403: User is not authorized to configure alerts for domain 'domainId'
412: Device not specified
404: Device ID specified does not exist or belongs to a different domain
403: Device: 'deviceId' not supported for USP
412: Severity not specified
412: No recipient details entered for alert
412: Invalid email address. Format must be name@domain.com
404: Username: 'userName' does not exist
403: User is not authorized to configure alerts for Super Admin user: 'userName'
403: Username: 'userName' not valid for the specified domain","folder":"1-29","rawModeData":"{\n\t\"usp_alert_configuration\": {\n\t\t\"name\": \"uspAlert\",\n\t\t\"description\": \"description\",\n\t\t\"status\": \"ACTIVE\",\n\t\t\"domain_id\": 6,\n\t\t\"all_devices\": false,\n\t\t\"device_ids\": {\n\t\t\t\"device_id\": [\n\t\t\t\t1,\n\t\t\t\t2,\n\t\t\t\t3,\n\t\t\t\t4\n\t\t\t]\n\t\t},\n\t\t\"low_severity\": true,\n\t\t\"medium_severity\": true,\n\t\t\"high_severity\": true,\n\t\t\"critical_severity\": false,\n\t\t\"user_ids\": {\n\t\t\t\"user_id\": [\n\t\t\t\t\"moshe\",\n\t\t\t\t\"admin\"\n\t\t\t\t]\n\t\t},\n\t\t\"emails\": \"user@doamin.com\",\n\t\t\"send_syslog\": true\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/","collectionId":"1","id":"1-29-196","method":"POST"},{"name":"Delete alerts by ids","data":[{"value":null,"type":"text","enabled":true,"key":"ids"}],"dataMode":"params","description":"Delete specified alerts by IDs
To delete multiple alert_ids, use a comma between each ID

Parameters:
context: Delete alerts in the specified domain ID. [optional]
ids: The alert Ids for deletion

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts/87

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts/86,87,88

Response Messages:
200:
403: Security Policy Alert Ids: :|'alert ids'| don't exist","folder":"1-29","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/{{ids}}","collectionId":"1","id":"1-29-197","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Delete cloud tag policy","description":"Delete the cloud tag policy specified by policyId.

If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Delete policy of the specified domain ID [optional]
policyId: cloud tag policy id [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/policyId
OUTPUT {
        \"status\": \"OK\",
        \"policy_name\": \"myPolicyName\"
}


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions
404: Resource not found","folder":"1-30","url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","collectionId":"1","id":"1-30-198","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get cloud tag policy","description":"This API retrieves the details of the cloud tag policy specified by policyId.

User must have admin permissions to the policy affiliated domain. If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Returns results for the specified domain ID [optional]
policyId: cloud tag policy id [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/policyId
OUTPUT{
        \"status\": \"OK\",
        \"result\": [
                {
                        \"policy_id\": \"tp-101\",
                        \"policy_name\": \"myPolicyName\",
                        \"requirements\": [
                                {
                                        \"requirement_type\": \"mandatory_tags\",
                                        \"requirement_name\": \"myMandatoryTagsRequirement\",
                                    \"requirement_severity\": \"CRTICAL\",
                                        \"tags\": [
                                                \"Owner\",
                                                \"Name\"
                                        ]
                                },
                                {
                                        \"requirement_type\": \"valid_values\",
                                        \"requirement_name\": \"myValidValueRequirement\",
                                    \"requirement_severity\": \"CRTICAL\",
                                        \"tag\": \"Budget\",
                                        \"values\": [
                                                \"R&D\",
                                                \"HR\"
                                        ]
                                }
                        ]
                }
        ]
}


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions
404: Resource not found","folder":"1-30","url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","collectionId":"1","id":"1-30-199","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Replace a cloud tag policy","dataMode":"raw","description":"Replace the cloud tag policy specified by policyID with the new policy attributes.

Use PATCH in order to partially modify a policy. If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Replace policy of the specified domain ID [optional]
policyId: cloud tag policy id [optional]
body: cloud tag policy dTO [optional]

Usage Example
URLhttps://{ip}/securetrack/api/tagpolicy/policies/policyId
BODY{
    \"policy_name\": \"myPolicyName\",
    \"requirements\": [
        {
            \"requirement_type\": \"mandatory_tags\",
            \"requirement_name\": \"mandatory_requirement1\",
            \"requirement_severity\": \"CRTICAL\",
            \"tags\": [
                \"Owner\",
                \"Role\"
            ]
        }
    ]
}
OUTPUT{
        \"status\": \"OK\",
        \"policy_id\": \"tp-123\"
}

","folder":"1-30","rawModeData":"{\n\t\"policy_name\": \"myPolicyName\",\n\t\"requirements\": [\n\t\t{\n\t\t\t\"requirement_type\": \"mandatory_tags\",\n\t\t\t\"requirement_name\": \"mandatory_requirement1\",\n\t\t\t\"requirement_severity\": \"CRTICAL\",\n\t\t\t\"tags\": [\n\t\t\t\t\"Owner\",\n\t\t\t\t\"Role\"\n\t\t\t]\n\t\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","collectionId":"1","id":"1-30-200","method":"PUT"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Modify a cloud tag policy","dataMode":"raw","description":"Partially modify a cloud tag policy by stating the modified attributes. Providing requirements replaces the entire list.

Specifying an empty requirement list is not permitted. Modify some attributes of the cloud tag policy specified by policyID with the attributes provided. If one or more \"requirement\" objects is provided, the exsiting \"requirement\" objects will be deleted and replaced with the new objetcs. Specifying an empty requirement list is not permitted.If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Rename policy of the specified domain ID [optional]
policyId: cloud tag policy id [optional]
body: cloud tag policy dTO [optional]

Usage Example
URLhttps://{ip}/securetrack/api/tagpolicy/policies/policyId
BODY{
    \"policy_name\": \"myPolicyName\",
    \"requirements\": [
        {
            \"requirement_type\": \"mandatory_tags\",
            \"requirement_name\": \"mandatory_requirement1\",
            \"requirement_severity\": \"CRTICAL\",
            \"tags\": [
                \"Owner\",
                \"Role\"
            ]
        }
    ]
}
OUTPUT{
        \"status\": \"OK\",
        \"policy_id\": \"tp-123\"
}


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions
404: Resource not found","folder":"1-30","rawModeData":"{\n\t\"policy_name\": \"myPolicyName\",\n\t\"requirements\": [\n\t\t{\n\t\t\t\"requirement_type\": \"mandatory_tags\",\n\t\t\t\"requirement_name\": \"mandatory_requirement1\",\n\t\t\t\"requirement_severity\": \"CRTICAL\",\n\t\t\t\"tags\": [\n\t\t\t\t\"Owner\",\n\t\t\t\t\"Role\"\n\t\t\t]\n\t\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","collectionId":"1","id":"1-30-201","method":"PATCH"},{"headers":"Accept: application/json\n","name":"Get all cloud tag policies","description":"This API returns the details of all the tag policies.

Results are filtered according to user domain permissions and request context. If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Returns results for the specified domain ID [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/
OUTPUT{
        \"status\": \"OK\",
        \"result\": [
                {
                        \"policy_id\": \"tp-101\",
                        \"policy_name\": \"myPolicy1\",
                        \"requirements\": [
                                {
                                        \"requirement_type\": \"mandatory_tags\",
                                        \"requirement_name\": \"myMandatoryRequirement\",
                                        \"requirement_severity\": \"HIGH\",
                                        \"tags\": [
                                                \"Owner\",
                                                \"Name\"
                                        ]
                                },
                                {
                                        \"requirement_type\": \"valid_values\",
                                        \"requirement_name\": \"myValidValueRequirement\",
                                        \"requirement_severity\": \"CRTICAL\",
                                        \"tag\": \"Budget\",
                                        \"values\": [
                                                \"R&D\",
                                                \"HR\"
                                        ]
                                }
                        ]
                },
                {
                        \"policy_id\": \"tp-102\",
                        \"policy_name\": \"myPolicy2\",
                        \"requirements\": [
                                {
                                        \"requirement_type\": \"mandatory_tags\",
                                        \"requirement_name\": \"myMandatoryRequirement\",
                                        \"requirement_severity\": \"HIGH\",
                                        \"tags\": [
                                                \"Owner\"
                                        ]
                                },
                                {
                                        \"requirement_type\": \"valid_values\",
                                        \"requirement_name\": \"myValidValueRequirement\",
                                        \"requirement_severity\": \"CRTICAL\",
                                        \"tag\": \"Budget\",
                                        \"values\": [
                                                \"R&D\",
                                                \"HR\"
                                        ]
                                }
                        ]
                }
        ]
}


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions","folder":"1-30","url":"https://{{SecureTrack_IP}}/securetrack/api/policies/","collectionId":"1","id":"1-30-202","method":"GET"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Create a cloud tag policy","dataMode":"raw","description":"Create a new cloud tag policy. The policyName field specified in the TagPolicyDTO must be unique. Define the requirements enforced by the cloud tag policy in the requirements field of the TagPolicyDTO. The supported value for the \"requirement_type\" field are \"mandatory_tags\" and \"valid_values\"If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Create policy for the specified domain ID [optional]
body: cloud tag policy DTO [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/
BODY {
    \"policy_name\": \"Production-VPC-Tag-Policy\",
    \"policy_description\": \"Instances tags in production\",
    \"requirements\": [
        {
            \"requirement_type\": \"mandatory_tags\",
            \"requirement_name\": \"mandatory_financial_tags\",
            \"requirement_severity\": \"HIGH\",
            \"tags\": [
                \"Owner\",
                \"Budget\"
            ]
        },
        {
            \"requirement_type\": \"valid_values\",
            \"requirement_name\": \"budget_valid_values\",
            \"requirement_severity\": \"CRITICAL\",
            \"tag\": \"Budget\",
            \"values\": [
                \"Corporate\",
                \"Dev\"
            ]
        }
    ]
}
OUTPUT{
        \"status\": \"OK\",
        \"policy_id\": \"tp-123\"
}


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions
409: Policy name already exists","folder":"1-30","rawModeData":" {\n\t\"policy_name\": \"Production-VPC-Tag-Policy\",\n\t\"policy_description\": \"Instances tags in production\",\n\t\"requirements\": [\n\t\t{\n\t\t\t\"requirement_type\": \"mandatory_tags\",\n\t\t\t\"requirement_name\": \"mandatory_financial_tags\",\n\t\t\t\"requirement_severity\": \"HIGH\",\n\t\t\t\"tags\": [\n\t\t\t\t\"Owner\",\n\t\t\t\t\"Budget\"\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"requirement_type\": \"valid_values\",\n\t\t\t\"requirement_name\": \"budget_valid_values\",\n\t\t\t\"requirement_severity\": \"CRITICAL\",\n\t\t\t\"tag\": \"Budget\",\n\t\t\t\"values\": [\n\t\t\t\t\"Corporate\",\n\t\t\t\t\"Dev\"\n\t\t\t]\n\t\t}\n\t]\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/policies/","collectionId":"1","id":"1-30-203","method":"POST"},{"headers":"Accept: application/json\nContent-Type: application/json\n","name":"Check if tags are compliant with cloud tag policies","data":[{"value":null,"type":"text","enabled":true,"key":"policy_external_id"}],"dataMode":"raw","description":"Check if the tags of a cloud resource are compliant with the specified cloud tag policy. Specify the tag policy to validate in the TagPolicyViolationsCheckRequestDTO. The tags of a cloud resource are specified as a json object with the attribute 'tags' at the root level. 'tags' attributes can be a list of tag names or a map including both the tag name and value. If no tags are specified or if the tag is specified incorrectly, The compliance check will treat the resource as if it has no tags. If no cloud tag policy violations are found the API returns an empty violations list.

Parameters:
context: Returns results for the specified domain ID [optional]
policy_external_id: Tag policy external identifier
body: Tag policy violation check request

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/violation_check?policy_external_id=policyId
BODY {
    \"type\": \"vm\",
    \"name\": \"CRM-FE\",
    \"os\": \"ubuntu14.4\",
    \"image\": \"AMI-12345\",
    \"tags\": {
        \"Role\": \"webserver\",
        \"Budget\": \"corporate\",
        \"Owner\": \"Steve.Smith\"
    }
}


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions
404: Resource not found","folder":"1-30","rawModeData":" {\n\t\"type\": \"vm\",\n\t\"name\": \"CRM-FE\",\n\t\"os\": \"ubuntu14.4\",\n\t\"image\": \"AMI-12345\",\n\t\"tags\": {\n\t\t\"Role\": \"webserver\",\n\t\t\"Budget\": \"corporate\",\n\t\t\"Owner\": \"Steve.Smith\"\n\t}\n}","url":"https://{{SecureTrack_IP}}/securetrack/api/violation_check/","collectionId":"1","id":"1-30-204","method":"POST"},{"headers":"Accept: application/json\n","name":"Get all cloud tag policy violations for a VPC","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"},{"value":null,"type":"text","enabled":true,"key":"severity"}],"dataMode":"params","description":"Retrieve all cloud tag policy violations for the specified VPC and severity level.

Parameters:
context: Global MSSP context. [optional]
deviceId: The device ID for which to get violations
severity: Return only violations of this severity
resourceId: The id of the VM instance [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses \"count=100\". [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tag_violations?deviceId=123&severity=CRITICAL
OUTPUT<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<tag_policy_device_violations>
    <violating_resources_count>2</violating_resources_count>
    <device_name>Amazon Test VPC </device_name>
    <severity>critical</severity>
    <violating_resources>
        <violating_resource>
            <tag_violations>
                <tag_violation>
                    <violation_message>Tag 'Name' value 'email server' is not valid. Valid values are [R&D, HR]</violation_message>
                    <policy_id>tp-100</policy_id>
                    <policy_name>Tag policy 1</policy_name>
                    <requirement_name>validValue_constraint2</requirement_name>
                    <requirement_severity>high</requirement_severity>
                    <violation_attributes xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"valid_values\">
                        <tag>Name</tag>
                        <valid_values>
                            <valid_value>R&D</valid_value>
                            <valid_value>HR</valid_value>
                        </valid_values>
                        <invalid_value>email server</invalid_value>
                    </violation_attributes>
                </tag_violation>
            </tag_violations>
            <resource_id>i-abc12345</resource_id>
            <resource_name>email server</resource_name>
        </violating_resource>
        <violating_resource>
            <tag_violations>
                <tag_violation>
                    <violation_message>Tag 'Application' is missing</violation_message>
                    <policy_id>tp-105</policy_id>
                    <policy_name>Tag policy 1</policy_name>
                    <requirement_name>mandatory_constraint1</requirement_name>
                    <requirement_severity>critical</requirement_severity>
                    <violation_attributes xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"mandatory_tags\">
                        <missing_tag>Application</missing_tag>
                    </violation_attributes>
                </tag_violation>
            </tag_violations>
            <resource_id>i-12345678</resource_id>
            <resource_name>Violations tests server</resource_name>
        </violating_resource>
    </violating_resources>
</tag_policy_device_violations>


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions
404: A device with the specified ID was not found","folder":"1-30","url":"https://{{SecureTrack_IP}}/securetrack/api/tag_violations/","collectionId":"1","id":"1-30-205","method":"GET"},{"headers":"Accept: application/json\n","name":"Delete an exception","data":[{"value":null,"type":"text","enabled":true,"key":"exceptionId"}],"dataMode":"params","description":"Delete the specific unified security policy exceptions

Parameters:
exceptionId: The ID of the exception to delete.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/14

Response Messages:
404: The security policy with the specified ID does not exist
403: Not permitted to access this context.","folder":"1-31","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/{{exceptionId}}","collectionId":"1","id":"1-31-206","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get a specific exception","data":[{"value":null,"type":"text","enabled":true,"key":"exceptionId"}],"dataMode":"params","description":"Gets a specific exception for unified security policies.

Parameters:
context: Global MSSP context [optional]
exceptionId: The ID of the exception to get.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/14

Response Messages:
403: Not permitted to access this context.
404: A security policy exception with the specified ID was not found.","folder":"1-31","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/{{exceptionId}}","collectionId":"1","id":"1-31-207","method":"GET"},{"headers":"Accept: application/json\n","name":"Get matching rules task status","data":[{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
taskId: The unique identifier of the matching rules task.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/matching_rules/status/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Matching rules task status was received.
403: Not permitted to Security policy exceptions.
404: Matching rules task status was not found.","dataMode":"params","folder":"1-31","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/matching_rules/status/{{taskId}}","collectionId":"1","id":"1-31-208","method":"GET"},{"name":"Start a task to calculate matching rules for an exception","data":[{"value":null,"type":"text","enabled":true,"key":"exceptionId"}],"dataMode":"params","description":"Create a calculation task to find matching rules.
The results will be on the relevant devices for each access.
Returns a task Id that can be used to check the task status and get the task results

Parameters:
exceptionId: Security policy Exception ID on which to run the API.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/1/matching_rules/start

Response Messages:
403: Not permitted to Security policy exceptions.
404: A security policy exception with the specified ID was not found.","folder":"1-31","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/{{exceptionId}}/matching_rules/start","collectionId":"1","id":"1-31-209","method":"POST"},{"headers":"Content-Type: application/xml\n","name":"Create an exception","dataMode":"raw","description":"Create an exception for unified security policies.

Parameters:
context: Global MSSP context [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_policies/exceptions
BODY<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<security_policy_exception>
    <approved_by>admin</approved_by>
    <created_by>st_user</created_by>
    <creation_date>2015-01-01</creation_date>
    <description>Allow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321</description>
    <exempted_traffic_list>
        <exempted_traffic>
            <comment>Creating USP exception for ticket 123</comment>
            <dest_network_collection>
                <network_items>
                    <network_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"subnet\">
                        <ip>192.168.1.2</ip>
                        <netmask>255.255.255.255</netmask>
                    </network_item>
                </network_items>
            </dest_network_collection>
            <security_requirements>
                <zone_to_zone_security_requirement>
                    <from_zone>LAN</from_zone>
                    <policy_name>corporate security policy</policy_name>
                    <to_zone>DMZ</to_zone>
                </zone_to_zone_security_requirement>
            </security_requirements>
            <service_collection>
                <service_items>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"custom\">
                        <port>4321</port>
                        <protocol>tcp</protocol>
                    </service_item>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"device_service\">
                        <mgmt_id>1</mgmt_id>
                        <service_uid>{5aa1c104-bd4d-4635-a281-b3a5442639ba}</service_uid>
                    </service_item>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"predefined\">
                        <predefined_service_name>http</predefined_service_name>
                    </service_item>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"range_service\">
                        <minProtocol>10</minProtocol>
                        <maxProtocol>20</maxProtocol>
                    </service_item>
                </service_items>
            </service_collection>
            <source_network_collection>
                <network_items>
                    <network_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"subnet\">
                        <ip>192.168.1.1</ip>
                        <netmask>255.255.255.255</netmask>
                    </network_item>
                </network_items>
            </source_network_collection>
        </exempted_traffic>
    </exempted_traffic_list>
    <expiration_date>2025-01-01</expiration_date>
    <name>Allow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321</name>
    <requested_by>admin</requested_by>
    <ticket_id>123</ticket_id>
</security_policy_exception>


Response Messages:
400: The specified network item is not valid.
400: The specified zone name does not exist.
400: The security policy with the specified name does not exist
400: The security policy 'created by' user is not valid.
400: The security policy with the specified name already exists.
400: Network Object of device id =|device_id| , with uid = |domain_id| does not exist
400: The from zone name = |from_zone_name| does not exist
400: The to zone name = |to_zone_name| does not exist
400: The security policy name = |security_policy_name| does not exist
400: The security policy 'created by' user = |user_name| is not valid
400: The security policy exception cannot be created
403: Not permitted to access this context.
401: The user does not have permission to this action.","folder":"1-31","rawModeData":"\n\n\tadmin\n\tst_user\n\t2015-01-01\n\tAllow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321\n\t\n\t\t\n\t\t\tCreating USP exception for ticket 123\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t192.168.1.2\n\t\t\t\t\t\t255.255.255.255\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\tLAN\n\t\t\t\t\tcorporate security policy\n\t\t\t\t\tDMZ\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t4321\n\t\t\t\t\t\ttcp\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t1\n\t\t\t\t\t\t{5aa1c104-bd4d-4635-a281-b3a5442639ba}\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\thttp\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t10\n\t\t\t\t\t\t20\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t192.168.1.1\n\t\t\t\t\t\t255.255.255.255\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\t2025-01-01\n\tAllow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321\n\tadmin\n\t123\n","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/","collectionId":"1","id":"1-31-210","method":"POST"},{"headers":"Accept: application/json\n","name":"Get all exceptions","description":"Gets a list of all unified security policy exceptions.

Parameters:
context: Global MSSP context [optional]
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query starting from starting page allowable type in numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions?context=1&start=0&count=1

Response Messages:
403: Not permitted to access this context.","folder":"1-31","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/","collectionId":"1","id":"1-31-211","method":"GET"},{"headers":"Accept: application/json\n","name":"Get matching rules task results","data":[{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
taskId: The unique identifier of the matching rules task.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/matching_rules/result/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Matching rules task results were received.
403: Not permitted to Security policy exceptions.
404: An error occurred during the calculation.
404: The calculation for the task has not finished yet.","dataMode":"params","folder":"1-31","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/matching_rules/result/{{taskId}}","collectionId":"1","id":"1-31-212","method":"GET"},{"name":"Cancel Matching rules task","data":[{"value":null,"type":"text","enabled":true,"key":"taskId"}],"description":"Parameters:
taskId: The unique identifier of the matching rules task.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/matching_rules/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
204: Matching rules task has been aborted successfully.
403: Not permitted to Security policy exceptions.
404: Matching rules task was not found.","dataMode":"params","folder":"1-31","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/matching_rules/{{taskId}}","collectionId":"1","id":"1-31-213","method":"DELETE"},{"name":"Delete unified security policy","data":[{"value":null,"type":"text","enabled":true,"key":"id"}],"dataMode":"params","description":"Delete a Security Policy Matrix

Parameters:
context: Returns results for the specified domain ID. [optional]
id: The unique identifier of the security policy matrix to delete
ignoreSecureTrack2Data [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies/1
","folder":"1-32","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/{{id}}","collectionId":"1","id":"1-32-214","method":"DELETE"},{"headers":"Accept: application/json\n","name":"Get global unified security policies","description":"Fetches the global security zone matrices defined under Unified Security Policy.

Parameters:
ignoreSecureTrack2Data [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies/global

Response Messages:
403: User not permitted to access global security policies","folder":"1-32","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/global","collectionId":"1","id":"1-32-215","method":"GET"},{"headers":"Accept: application/json\n","name":"Get zone to interface mapping","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"}],"dataMode":"params","description":"Fetches mapping of SecureTrack zones to device interfaces

Parameters:
context: Global MSSP context [optional]
deviceId: Device ID

Usage Example
https://127.0.0.1/securetrack/api/security_policies/9/mapping

Response Messages:
200: Successful
400: This device does not support zone to interface mapping
403: User not permitted to access the specified domain
404: Device ID: <deviceId> does not exist
404: Access denied for device with ID: <deviceId>","folder":"1-32","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/{{deviceId}}/mapping","collectionId":"1","id":"1-32-216","method":"GET"},{"headers":"Content-Type: application/xml\n","name":"Set manual device mapping","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"}],"dataMode":"raw","description":"Add or remove a zone on a device interface

Parameters:
context: Global MSSP context [optional]
deviceId: Device ID
body: InterfacesManualMappingsDTO

Usage Example
URLhttps://127.0.0.1/securetrack/api/security_policies/10/manual_mapping
BODY<interfaces_manual_mappings>
<interface_manual_mapping>
<interface_name>Vlan_30</interface_name>
<zones_user_actions>
<zone_user_action>
<zoneId>10</zoneId>
<action>add</action>
</zone_user_action>
</zones_user_actions>
</interface_manual_mapping>
</interfaces_manual_mappings>


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions
404: Not found error
404: User action not valid (only add/remove)
404: No interface with name for device with id
404: No zone with id
404: No revision for device with id
404: Device ID: <deviceId> does not exist
404: Access denied for device with ID: <deviceId>
404: InterfacesManualMappingsDTO is empty
404: Error on updating security_policy_interface_zone_mapping_user_action table for device with ID","folder":"1-32","rawModeData":"\n \n Vlan_30\n \n \n 10\n add\n \n \n \n\n ","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/{{deviceId}}/manual_mapping","collectionId":"1","id":"1-32-217","method":"POST"},{"collectionId":"1","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/{{id}}/export","name":"Get unified security policy as CSV","method":"GET","id":"1-32-218","description":"Exports a Security Policy in CSV format

Parameters:
context: Returns results for the specified domain ID. [optional]
id: ID of the security policy. [optional]
ignoreSecureTrack2Data [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies/1/export

Response Messages:
403: User not permitted to access the specified domain
404: Security Policy does not exist","folder":"1-32"},{"headers":"Accept: application/json\n","name":"Get unified security policies","description":"Fetches the security zone matrices defined under Unified Security Policy.

Parameters:
context: Returns results for the specified domain ID. [optional]
ignoreSecureTrack2Data [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies

Response Messages:
403: User not permitted to access the specified domain","folder":"1-32","url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/","collectionId":"1","id":"1-32-219","method":"GET"},{"headers":"Accept: application/json\n","name":"Get the violating rules for the specified device.","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"},{"value":null,"type":"text","enabled":true,"key":"severity"},{"value":null,"type":"text","enabled":true,"key":"type"}],"dataMode":"params","description":"policyName is supported for management devices running in Advanced management mode.

Parameters:
deviceId: The device ID for which to get violations
policyName: Return only violations that match this policy [optional]
severity: Return only violations of this severity
type: Return only violations of this type
ignoreSecureTrack2Data [optional]

Usage Example
https://192.168.1.1/securetrack/api/violating_rules/1/device_violations?policyName=policy_name&type=SECURITY_POLICY&severity=MEDIUM

Response Messages:
200: The violations were successfully retrieved
400: The specified value for the violation severity is invalid
400: The specified value for the violation type is invalid
400: You cannot specify a policyName because the device is not running in Advanced management mode
404: A device with the specified ID was not found
404: A policy with the specified policyName was not found for this device","folder":"1-33","url":"https://{{SecureTrack_IP}}/securetrack/api/violating_rules/{{deviceId}}/device_violations","collectionId":"1","id":"1-33-220","method":"GET"},{"headers":"Accept: application/json\n","name":"Get the amount of violating rules for the specified device.","data":[{"value":null,"type":"text","enabled":true,"key":"deviceId"}],"description":"Parameters:
deviceId: The device ID for which to get violations.
ignoreSecureTrack2Data [optional]

Usage Example
https://192.168.1.1/securetrack/api/violating_rules/1/count

Response Messages:
200: The violation count was successfully retrieved
404: Device with id: <deviceId> doesn't exist","dataMode":"params","folder":"1-33","url":"https://{{SecureTrack_IP}}/securetrack/api/violating_rules/{{deviceId}}/count","collectionId":"1","id":"1-33-221","method":"GET"}],"order":[],"name":"Tufin Tufin SecureTrack R21-1-RC1","id":"1","description":"Tufin Orchestration Suite - Tufin SecureTrack APIs.
For detailed information about the APIs please see the documentation at:
https://your-securetrack-server/securetrack/apidoc"} \ No newline at end of file diff --git a/Postman Format v1/R21-1 postman collection/tufin.postman_environment b/Postman Format v1/R21-1 postman collection/tufin.postman_environment new file mode 100644 index 0000000..c031d2b --- /dev/null +++ b/Postman Format v1/R21-1 postman collection/tufin.postman_environment @@ -0,0 +1 @@ +{"name":"Tufin environment","values":[{"type":"text","key":"SecureApp_IP"},{"type":"text","key":"SecureChange_IP"},{"type":"text","key":"SecureTrack_IP"},{"type":"text","key":"applicationId"},{"type":"text","key":"applicationInterfaceId"},{"type":"text","key":"application_id"},{"type":"text","key":"application_pack_id"},{"type":"text","key":"assigneeId"},{"type":"text","key":"child_id"},{"type":"text","key":"child_ids"},{"type":"text","key":"cleanup_id"},{"type":"text","key":"cloudId"},{"type":"text","key":"cloud_id"},{"type":"text","key":"connectionId"},{"type":"text","key":"connectionInterfaceId"},{"type":"text","key":"connectionToApplicationId"},{"type":"text","key":"connection_id"},{"type":"text","key":"connection_to_application_pack_id"},{"type":"text","key":"customer_id"},{"type":"text","key":"deviceId"},{"type":"text","key":"device_id"},{"type":"text","key":"domainId"},{"type":"text","key":"exceptionId"},{"type":"text","key":"fieldId"},{"type":"text","key":"id"},{"type":"text","key":"ids"},{"type":"text","key":"inId"},{"type":"text","key":"instructionId"},{"type":"text","key":"interfaceCustomerId"},{"type":"text","key":"layer2DataId"},{"type":"text","key":"managementId"},{"type":"text","key":"mgmtId"},{"type":"text","key":"parent_id"},{"type":"text","key":"parent_ids"},{"type":"text","key":"policyId"},{"type":"text","key":"requestId"},{"type":"text","key":"revId"},{"type":"text","key":"revision_id"},{"type":"text","key":"risk_id"},{"type":"text","key":"routeId"},{"type":"text","key":"ruleId"},{"type":"text","key":"rule_id"},{"type":"text","key":"rule_uid"},{"type":"text","key":"serverId"},{"type":"text","key":"serviceId"},{"type":"text","key":"sourceApplicationId"},{"type":"text","key":"stepId"},{"type":"text","key":"tag_id"},{"type":"text","key":"targetApplicationId"},{"type":"text","key":"taskId"},{"type":"text","key":"task_id"},{"type":"text","key":"task_uid"},{"type":"text","key":"toStepId"},{"type":"text","key":"uid"},{"type":"text","key":"userId"},{"type":"text","key":"vpnId"},{"type":"text","key":"zone_id"},{"type":"text","key":"zone_ids"}]} \ No newline at end of file diff --git a/Postman Format v2/R19-3 postman collection/securechangeworkflow_R19-3-GA-v2.json b/Postman Format v2/R19-3 postman collection/securechangeworkflow_R19-3-GA-v2.json new file mode 100644 index 0000000..5d24c19 --- /dev/null +++ b/Postman Format v2/R19-3 postman collection/securechangeworkflow_R19-3-GA-v2.json @@ -0,0 +1 @@ +{"info":{"_postman_id":"2","name":"Tufin Tufin SecureChange/SecureApp R19-3-GA","description":"Tufin Orchestration Suite - Tufin SecureChange/SecureApp APIs.
For detailed information about the APIs please see the documentation at:
https://your-securetrack-server/securechangeworkflow/apidoc","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json"},"item":[{"name":"Access Portal","item":[{"name":"Retrieve an existing application access request by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"requestId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests/{{requestId}}","description":"Parameters:
applicationId: The unique identifier of the application
requestId: The unique identifier of the application access request

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests/1

Response Messages:
400: The application was already deleted.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Access request with id ID was not found in application with id ID"},"response":[]},{"name":"Update an application access request","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tAPPROVE\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests/{{requestId}}","description":"Use this API to approve or reject application access requests

Parameters:
applicationId: The unique identifier of the application
requestId: The unique identifier of the application access request
body: application access request

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests/1
BODY<application_access_request>
    <action>APPROVE</action>
</application_access_request>


Response Messages:
200: Application access request was updated.
400: The application was already deleted.
400: Invalid ID for access request
400: Cannot update access request with id ID
400: Action cannot be empty in request with id ID
400: Invalid action in request with id ID
400: The Server group is lock for discovery
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]},{"name":"Retrieve existing application access requests","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests","description":"Parameters:
applicationId: The unique identifier of the application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests

Response Messages:
400: The application was already deleted.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID."},"response":[]},{"name":"Update application access requests","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t1\n\t\tAPPROVE\n\t\n\t\n\t\t2\n\t\tREJECT\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests","description":"Use this API to approve or reject application access requests

Parameters:
applicationId: The unique identifier of the application
body: application access requests

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests
BODY<application_access_requests>
    <application_access_request>
        <id>1</id>
        <action>APPROVE</action>
    </application_access_request>
    <application_access_request>
        <id>2</id>
        <action>REJECT</action>
    </application_access_request>
</application_access_requests>


Response Messages:
200: Application access requests were updated.
400: The application was already deleted.
400: Invalid ID for access request
400: Cannot update access request with id ID
400: Action cannot be empty in request with id ID
400: Invalid action in request with id ID
400: The Server group is lock for discovery
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]},{"name":"Create application access request","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t1\n\t1.1.1.1\n\tRequest to join the WebServers server group\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests","description":"Parameters:
applicationId: The unique identifier of the application
body: application access request

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests
BODY<application_access_request>
    <server_group_id>1</server_group_id>
    <server_ip>1.1.1.1</server_ip>
    <comment>Request to join the WebServers server group</comment>
</application_access_request>


Response Messages:
201: Application access request was submitted.
400: The application was already deleted.
400: Server id cannot be empty.
400: Hostname or IP cannot be empty.
400: The provided server does not exist in application.
400: The provided server is not allowed to access.
400: Request already created
400: Requester cannot be null
400: Group cannot be empty
400: Invalid ip
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]}]},{"name":"Application Connections","item":[{"name":"Retrieve existing connections, with extended resources information","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_extended","description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the connection [optional]
start: Return results starting only from the specified index; 0-based index; default value = 0 [optional]
count: Return the specified number of results. Returns all results if no value specified [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended?name=Connection Name

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended?name=Connection Name&start=50&count=100

Response Messages:
400: Start value cannot be a negative number.
400: Count value must be greater than 0.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: Access is denied.
404: There is no application with the specified ID.
404: There are no connections with the name NAME."},"response":[]},{"name":"Create a ticket to repair a connection","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tRepair connection 2\n\tu1\n\tNormal\n\t\n\t\tWorkflow with topology\n\t\n\t\n\t\t\n\t\t\tOpen request\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tBusiness Justification\n\t\t\t\t\t\t\tI need access to ftp \n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tProject Number\n\t\t\t\t\t\t\tCR124560\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tHyperlink\n\t\t\t\t\t\t\thttp://192.168.1.1/ticket\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tChange Window\n\t\t\t\t\t\t\tMonday\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tmanager email\n\t\t\t\t\t\t\tmanager@tufin.com\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connections/{{connection_id}}/repair","description":"Parameters:
application_id: The application ID
connection_id: The connection ID
body: Ticket

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/2/repair
BODY<ticket>
    <subject>Repair connection 2</subject>
    <requester>u1</requester>
    <priority>Normal</priority>
    <workflow>
        <name>Workflow with topology</name>
    </workflow>
    <steps>
        <step>
            <name>Open request</name>
            <tasks>
                <task>
                    <fields>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_area\">
                            <name>Business Justification</name>
                            <text>I need access to ftp </text>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_field\">
                            <name>Project Number</name>
                            <text>CR124560</text>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"hyperlink\">
                            <name>Hyperlink</name>
                            <url>http://192.168.1.1/ticket</url>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"drop_down_list\">
                            <name>Change Window</name>
                            <selection>Monday</selection>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"manager\">
                            <name>manager email</name>
                            <text>manager@tufin.com</text>
                        </field>
                    </fields>
                </task>
            </tasks>
        </step>
    </steps>
    <comments/>
</ticket>


Response Messages:
201: Ticket was created.
400: The requester must be the currently logged in user.
400: Workflow was not found.
400: Workflow is not active.
400: Workflow configuration is not valid.
400: Workflow is not set.
400: You cannot enter a status for a new ticket.
400: Requester cannot open a ticket in domain.
400: Invalid ticket priority.
400: Expiration field is required.
400: Submit ticket enabled only with the first step.
400: First step can be only with one task.
400: The specified workflow does not contain an access request field in the first step.
400: You cannot use an access request field to create a ticket from SecureApp.
400: The ticket fields do not match the fields in the current step of the workflow.
400: You cannot change the value of a field because it is read-only.
401: Logged in user: NAME do not have permission to perform on behalf actions.
401: You are not a participant in the first step of this workflow.
401: Access is denied.
401: To create a ticket you must purchase a valid SecureChange license.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: Cannot create a ticket to repair this connection because the connection status is not disconnected.
403: Cannot create a ticket to repair this connection because the connection was edited but a ticket has not been created yet.
403: Cannot create a ticket to repair this connection because there are other open tickets for an application that includes this connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID."},"response":[]},{"name":"Retrieve existing connections","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections","description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the connection [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections?name=Connection Name

Response Messages:
401: No available licenses. Ask your SecureApp administrator for assistance.
401: Access is denied
401: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: There are no connections with the name NAME."},"response":[]},{"name":"Create connections","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t Connection A\n\t\t Connection A comment\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t\t \n\t\t\t\t 3\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t \n\t \n\t\t Connection B\n\t \n\t \n\t\t Connection C\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t \n\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections","description":"Parameters:
applicationId: The unique identifier of the application
body: The list of the connections

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections
BODY<connections>
     <connection>
         <name>Connection A</name>
         <comment>Connection A comment</comment>
         <sources>
             <source>
                 <id>2</id>
             </source>
             <source>
                 <id>3</id>
             </source>
         </sources>
         <services>
             <service>
                 <id>1</id>
             </service>
         </services>
         <destinations>
             <destination>
                 <id>1</id>
             </destination>
         </destinations>
     </connection>
     <connection>
         <name>Connection B</name>
     </connection>
     <connection>
         <name>Connection C</name>
         <sources>
             <source>
                 <id>2</id>
             </source>
         </sources>
     </connection>
</connections>


Response Messages:
200: Connections were created.
201: Connection was created.
400: There are no items to add.
400: You cannot add to application NAME because it was decommissioned.
400: Connection name already exists.
400: Reference to service ID is invalid.
400: Reference to source/destination with ID is invalid.
400: Connection NAME contains duplicate destinations.
400: Destination cannot contain users.
400: Resource cannot contain other objects along with Any.
400: Connection NAME contains duplicate sources.
400: You cannot add external resources to interface connections.
400: You cannot have Any in both the source and destination.
400: You cannot add external resources to interface connections.
400: Source cannot contain both users and servers.
400: Connection NAME contains duplicate services.
400: Cannot contain other services along with ANY.
400: Connections can only include objects within the same customer.
401: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
401: Access is denied
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]},{"name":"Update connections","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t 1\n\t\t Connection A\n\t\t Connection A comment\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t\t \n\t\t\t\t 3\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t \n\t \n\t\t 2\n\t\t Connection B\n\t \n\t \n\t\t 3\n\t\t Connection C\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t \n\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections","description":"Parameters:
applicationId: The unique identifier of the application
body: List of connections

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections
BODY<connections>
     <connection>
         <id>1</id>
         <name>Connection A</name>
         <comment>Connection A comment</comment>
         <sources>
             <source>
                 <id>2</id>
             </source>
             <source>
                 <id>3</id>
             </source>
         </sources>
         <services>
             <service>
                 <id>1</id>
             </service>
         </services>
         <destinations>
             <destination>
                 <id>1</id>
             </destination>
         </destinations>
     </connection>
     <connection>
         <id>2</id>
         <name>Connection B</name>
     </connection>
     <connection>
         <id>3</id>
         <name>Connection C</name>
         <sources>
             <source>
                 <id>2</id>
             </source>
         </sources>
     </connection>
</connections>


Response Messages:
200: Connections were modified.
400: Reference to service ID is invalid.
400: Reference to source/destination with ID is invalid.
400: Connection name cannot be empty.
400: Connection name already exists.
400: Connection NAME contains duplicate destinations.
400: Destination cannot contain users.
400: Resource cannot contain other objects along with Any.
400: Connection NAME contains duplicate sources.
400: You cannot add external resources to interface connections.
400: You cannot have Any in both the source and destination.
400: You cannot add external resources to interface connections.
400: Source cannot contain both users and servers.
400: Connection NAME contains duplicate services.
400: Cannot contain other services along with ANY.
400: Connections can only include objects within the same customer.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permission to access application that contains the server ID
401: You do not have permissions to edit this application.
401: Access is denied
401: You cannot edit or delete an external connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID."},"response":[]},{"name":"Retrieve an existing connection by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"connectionId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}","description":"Parameters:
applicationId: The unique identifier of the application
connectionId: The unique identifier of the connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/1

Response Messages:
401: No available licenses. Ask your SecureApp administrator for assistance.
401: Access is denied
401: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID."},"response":[]},{"name":"Update a connection","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":" \n\t Connection A\n\t Connection A comment\n\t \n\t\t \n\t\t\t 2\n\t\t \n\t\t \n\t\t\t 3\n\t\t \n\t \n\t \n\t\t \n\t\t\t 1\n\t\t \n\t \n\t \n\t\t \n\t\t\t 1\n\t\t \n\t \n "},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}","description":"Parameters:
applicationId: The unique identifier of the application
connectionId: The unique identifier of the connection
body: Connection

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections/1
BODY <connection>
     <name>Connection A</name>
     <comment>Connection A comment</comment>
     <sources>
         <source>
             <id>2</id>
         </source>
         <source>
             <id>3</id>
         </source>
     </sources>
     <services>
         <service>
             <id>1</id>
         </service>
     </services>
     <destinations>
         <destination>
             <id>1</id>
         </destination>
     </destinations>
</connection>


Response Messages:
200: Connection was modified.
400: Reference to service ID is invalid.
400: Reference to source/destination with ID is invalid.
400: Connection name cannot be empty.
400: Connection name already exists.
400: Connection NAME contains duplicate destinations.
400: Destination cannot contain users.
400: Resource cannot contain other objects along with Any.
400: Connection NAME contains duplicate sources.
400: You cannot add external resources to interface connections.
400: You cannot have Any in both the source and destination.
400: You cannot add external resources to interface connections.
400: Source cannot contain both users and servers.
400: Connection NAME contains duplicate services.
400: Cannot contain other services along with ANY.
400: Connections can only include objects within the same customer.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permission to access application that contains the server ID
401: You do not have permissions to edit this application.
401: Access is denied
401: You cannot edit or delete an external connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID."},"response":[]},{"name":"Delete connection","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"connectionId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}","description":"Parameters:
applicationId: The unique identifier of the application
connectionId: The unique identifier of the connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/1

Response Messages:
200: Connection was deleted.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
401: Access is denied
401: You cannot edit or delete an external connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID."},"response":[]}]},{"name":"Application Identities","item":[{"name":"Fetches application identities","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/application_identities","description":"Fetches the list of pre-defined application identities (like facebook) that can be used in a connection.

Parameters:
name: The name of the service [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/application_identities

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/application_identities?name=facebook

Response Messages:
404: There are no application identities with the name NAME.
401: Access is denied."},"response":[]}]},{"name":"Application Interfaces","item":[{"name":"Retrieve existing interface connections","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"applicationInterfaceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections","description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
name: The name of the interface connection [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections?name=Connection 1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There are no connection interfaces with the name NAME.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID."},"response":[]},{"name":"Create interface connections","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\tConnection 1\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\t\n\t\t\t\tFacebook\n\t\t\t\n\t\t\n\t\tNew connection\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections","description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
body: The interface connections

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections
BODY<interface_connections>
    <interface_connection>
        <name>Connection 1</name>
        <sources>
            <source>
                <id>3</id>
            </source>
        </sources>
        <services>
            <service>
                <id>3</id>
            </service>
            <service>
                <id>Facebook</id>
            </service>
        </services>
        <comment>New connection</comment>
    </interface_connection>
</interface_connections>


Response Messages:
200: Interface connections were created.
201: Interface connection was created.
400: There are no items to add.
400: Cannot create interface connection without a name.
400: Connection name already exists.
400: You cannot add user to connection interface.
400: You cannot add Any to connection interface.
400: You cannot add Internet to connection interface.
400: Cannot have external servers.
400: Cannot have both sources and destinations.
400: Connection NAME contains duplicate sources.
400: Connection NAME contains duplicate services.
400: Connection NAME contains duplicate destinations.
400: Reference to source/destination with ID is invalid.
400: Reference to service ID is invalid.
401: Access is denied.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID."},"response":[]},{"name":"Retrieve an existing interface connection by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"applicationInterfaceId"},{"value":null,"type":"text","key":"connectionInterfaceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}","description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
connectionInterfaceId: The unique identifier of the interface connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections/1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID."},"response":[]},{"name":"Delete interface connection","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"applicationInterfaceId"},{"value":null,"type":"text","key":"connectionInterfaceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}","description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
connectionInterfaceId: The unique identifier of the interface connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections/1

Response Messages:
200: Interface connection was deleted.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID."},"response":[]},{"name":"Update an interface connection","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tUpdated name\n\t\n\t\t\n\t\t\t19\n\t\t\n\t\n\t\n\t\t\n\t\t\t9\n\t\t\n\t\n\tUpdated connection\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}","description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
connectionInterfaceId: The unique identifier of the interface connection
body: The interface connection

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections/1
BODY<interface_connection>
    <name>Updated name</name>
    <sources>
        <source>
            <id>19</id>
        </source>
    </sources>
    <services>
        <service>
            <id>9</id>
        </service>
    </services>
    <comment>Updated connection</comment>
</interface_connection>


Response Messages:
200: Interface connection was modified.
400: Interface connection name cannot be empty.
400: Connection name already exists.
400: You cannot add user to connection interface.
400: You cannot add Any to connection interface.
400: You cannot add Internet to connection interface.
400: Cannot have external servers.
400: Cannot have both sources and destinations.
400: Connection NAME contains duplicate sources.
400: Connection NAME contains duplicate services.
400: Connection NAME contains duplicate destinations.
400: Reference to source/destination with ID is invalid.
400: Reference to service ID is invalid.
401: Access is denied.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID."},"response":[]},{"name":"Update a connection to application","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tUpdated name\n\tUpdated connection to application\n\t\n\t\t\n\t\t\t4\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications/{{connectionToApplicationId}}","description":"Parameters:
applicationId: The unique identifier of the application
connectionToApplicationId: The unique identifier of the connection to application
body: The connection to application

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications/1
BODY<connection_to_application>
    <name>Updated name</name>
    <comment>Updated connection to application</comment>
    <servers>
        <server>
            <id>4</id>
        </server>
    </servers>
</connection_to_application>


Response Messages:
200: Connection to application was modified.
400: Name cannot be empty.
400: Name already exists.
400: Reference to source/destination with ID is invalid.
400: You cannot add ANY to connection to application.
400: You cannot add user to connection to application.
400: You cannot add Internet to connection to application.
401: Access is denied
401: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection to application with ID was not found for application interface with ID."},"response":[]},{"name":"Retrieve an existing connection to application by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"connectionToApplicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications/{{connectionToApplicationId}}","description":"Parameters:
applicationId: The unique identifier of the application
connectionToApplicationId: The unique identifier of the connection to application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications/1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Connection to application with ID was not found for application interface with ID."},"response":[]},{"name":"Delete connection to application","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"connectionToApplicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications/{{connectionToApplicationId}}","description":"Parameters:
applicationId: The unique identifier of the application
connectionToApplicationId: The unique identifier of the connection to application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications/1

Response Messages:
200: Connection to application was deleted.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection to application with ID was not found for application interface with ID."},"response":[]},{"name":"Create application interface","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tInterface to Application 1\n\tNew application interface\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces","description":"Parameters:
applicationId: The unique identifier of the application
body: The application interface

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces
BODY<application_interface>
    <name>Interface to Application 1</name>
    <comment>New application interface</comment>
</application_interface>


Response Messages:
201: Application interface was created.
400: You cannot add to application NAME because it was decommissioned.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID."},"response":[]},{"name":"Retrieve existing application interfaces","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces","description":"To improve response time, set 'calculateIsPublished = false' to avoid calculating 'is_published'.

Parameters:
applicationId: The unique identifier of the application
name: The name of the application interface [optional]
calculateIsPublished: Should calculate is_published value [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces?name=Interface to Application 1

Response Messages:
400: There is no application with the specified ID.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There are no application interfaces with the name NAME."},"response":[]},{"name":"Delete application interface","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"applicationInterfaceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}","description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1

Response Messages:
200: Application interface was deleted.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID."},"response":[]},{"name":"Update an application interface","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tupdated name\n\tUpdated application interface\n\ttrue\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}","description":"Update the application interface properties. If is_published is set to true, the application interface is published for use by other users.

Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of The application interface
body: The application interface

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1
BODY<application_interface>
    <name>updated name</name>
    <comment>Updated application interface</comment>
    <is_published>true</is_published>
</application_interface>


Response Messages:
200: Application interface was modified.
400: Application interface is not complete for publish.
400: Name cannot be empty.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID."},"response":[]},{"name":"Retrieve an existing application interface by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"applicationInterfaceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}","description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID."},"response":[]},{"name":"Retrieve existing connections to application","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications","description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the connection to application [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications?name=Connection to Application 1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID."},"response":[]},{"name":"Create connection to application","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tConnection to Application 1\n\tNew connection to application\n\t1\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications","description":"Create a connection from this application to an application interface.

Parameters:
applicationId: The unique identifier of the application
body: The connection to application

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications
BODY<connection_to_application>
    <name>Connection to Application 1</name>
    <comment>New connection to application</comment>
    <application_interface_id>1</application_interface_id>
    <servers>
        <server>
            <id>3</id>
        </server>
    </servers>
</connection_to_application>


Response Messages:
201: Connection to application was created.
400: You cannot add to application NAME because it was decommissioned.
400: The selected interface cannot be used more than once in the application.
400: Name cannot be empty.
400: Cannot create from local interface.
400: ApplicationInterface didn't got published.
400: Name already exists.
400: Cannot create connection to application without servers, there should be at least one server.
400: Reference to source/destination with ID is invalid.
400: You can use only interface from the same customer.
400: You cannot add ANY to connection to application.
400: You cannot add user to connection to application.
400: You cannot add Internet to connection to application.
401: Access is denied
401: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found."},"response":[]}]},{"name":"Application Migration","item":[{"name":"Update connection to application mappings for source and target applications","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n\t\n\t\t\n\t\t\t2\n\t\t\n\t\t\n\t\t\t-1\n\t\t\n\t\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/connections_to_applications_mapping","description":"Use id=-1 for target_application_interface if new mapping is “Not Needed”.
If the source is specified and the target is empty, the mapping that is currently configured will be deleted.

Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application
body: The interface instance mapping list [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/connections_to_applications_mapping
BODY<connections_to_applications_mapping>
    <connection_to_application_mapping>
        <source_connection_to_application>
            <id>1</id>
        </source_connection_to_application>
        <target_application_interface>
            <id>4</id>
        </target_application_interface>
    </connection_to_application_mapping>
    <connection_to_application_mapping>
        <source_connection_to_application>
            <id>2</id>
        </source_connection_to_application>
        <target_application_interface>
            <id>-1</id>
        </target_application_interface>
    </connection_to_application_mapping>
    <connection_to_application_mapping>
        <source_connection_to_application>
            <id>3</id>
        </source_connection_to_application>
    </connection_to_application_mapping>
</connections_to_applications_mapping>


Response Messages:
200: Connection to application mappings were modified.
400: Source interface instance cannot be empty.
400: Source interface instance object is not valid
400: Target application interface is not valid
400: Connection to application with ID: ID was not found.
400: Interface with ID: ID was not found.
400: Cannot remove mapping of instance with ID because it has never been mapped.
400: Cannot migrate application to itself.
400: Cannot map instance to interface with ID ID because the interface exists in target application.
400: Cannot map to duplicate application interfaces
400: Application interface didn't got published
400: Connection to application with id: ID must used by source application
400: You cannot map connection to application ID, because it is contained in a connection to application pack.
400: Application interface ID must be in the same customer as the target application.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]},{"name":"Retrieve connection to application mappings for source and target applications","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"sourceApplicationId"},{"value":null,"type":"text","key":"targetApplicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/connections_to_applications_mapping","description":"Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/connections_to_applications_mapping

Response Messages:
400: Cannot get mappings between application to itself.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID."},"response":[]},{"name":"Copy application servers and connections to another application.","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"sourceApplicationId"},{"value":null,"type":"text","key":"targetApplicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}","description":"This API can be used to:
1. Create applications based on a blueprint (template).
2. Copy applications between environments (dev, test, prod).
3. Migrate applications between data-centers.

Before migrating make sure to map servers and connections to applications (if any exist).\nThis migration uses the configuration specified in the other API calls.

Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2

Response Messages:
200: Application was migrated.
400: Cannot migrate a decommissioned application.
400: Cannot migrate to a decommissioned application.
400: Cannot migrate an application to itself.
400: Cannot edit target DEVICE application.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
400: The source application has no connections to migrate.
409: You cannot migrate the application because not all servers are mapped.
409: You cannot migrate the application because not all connections to application are mapped.
409: You cannot migrate the application because one of the interfaces in the original application has been changed and has not been published."},"response":[]},{"name":"Update server mappings for source and target applications","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n\t\n\t\t\n\t\t\t5\n\t\t\n\t\t\n\t\t\t-1\n\t\t\n\t\n\t\n\t\t\n\t\t\t6\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/servers_mapping","description":"Use id=-1 for target_network_object if new mapping is “Not Needed”.
If the source is specified and the target is empty, the mapping that is currently configured will be deleted.

Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application
body: The server mapping list [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/servers_mapping
BODY<servers_mapping>
    <server_mapping>
        <source_network_object>
            <id>3</id>
        </source_network_object>
        <target_network_object>
            <id>4</id>
        </target_network_object>
    </server_mapping>
    <server_mapping>
        <source_network_object>
            <id>5</id>
        </source_network_object>
        <target_network_object>
            <id>-1</id>
        </target_network_object>
    </server_mapping>
    <server_mapping>
        <source_network_object>
            <id>6</id>
        </source_network_object>
    </server_mapping>
</servers_mapping>


Response Messages:
200: Server mappings were modified.
400: Source network object cannot be empty.
400: Source network object is not valid
400: Target network object is not valid
400: Source and target network objects must be internal or external both.
400: Cannot use DEVICE application resources as external network objects.
400: Source network object with ID must be used by any connection.
400: Cannot remove mapping of network object with ID because it has never been mapped.
400: Cannot migrate application to itself.
400: Cannot map to ANY network object.
400: Cannot map Internet network object.
400: Cannot map to Internet network object.
400: Target network object ID must be in the same customer as the target application.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Server with ID was not found."},"response":[]},{"name":"Retrieve server mappings for source and target applications","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"sourceApplicationId"},{"value":null,"type":"text","key":"targetApplicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/servers_mapping","description":"Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application
search_servers_type: Search server type [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/servers_mapping

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/servers_mapping?search_servers_type=EXTERNAL

Response Messages:
400: Search migrated servers type parameter must be either internal, external or both.
400: Cannot get mappings between application to itself.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permission to access application with ID
401: You do not have permissions to edit this application.
404: There is no application with the specified ID."},"response":[]}]},{"name":"Application Packs","item":[{"name":"Update an application pack","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tUpdated name\n\tUpdated application pack\n\t\n\t\t4\n\t\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\n\t\n\t\t\n\t\t\t5\n\t\t\n\t\n\ttrue\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}","description":"Update the application pack properties. If is_published is set to true, the application pack is published for use by other users.

Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
body: Application pack

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1
BODY<application_pack>
    <name>Updated name</name>
    <comment>Updated application pack</comment>
    <owner>
        <id>4</id>
    </owner>
    <editors>
        <editor>
            <id>3</id>
        </editor>
    </editors>
    <viewers>
        <viewer>
            <id>5</id>
        </viewer>
    </viewers>
    <is_published>true</is_published>
</application_pack>


Response Messages:
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to owner ID is invalid.
400: The owner NAME does not have permission to access applications.
400: There is an editor without an ID or name.
400: The application pack owner cannot also be an editor of the application pack.
400: There is a viewer without an ID or name.
400: The application pack owner cannot also be a viewer of the application pack.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application pack.
400: Application pack NAME already exists.
400: Application pack name must contain at least 2 and no more than 160 characters.
400: Customer NAME is not imported to SecureApp.
400: Customer NAME was decommissioned.
400: Application pack with ID is not ready for publish, or has no changes from the last publish.
401: Access is denied
401: You do not have permission to access application that contains the interface ID
401: You do not have permissions to edit this application pack.
401: You do not have permissions to change the owner of application pack ID.
401: You do not have permissions to change the editors and viewers of application pack ID.
404: There are no application packs with the NAME in customer with ID."},"response":[]},{"name":"Delete application pack","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"},{"value":null,"type":"text","key":"application_pack_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1

Response Messages:
200: Application pack wes deleted.
401: You do not have permissions to delete this application pack.
400: There is no application pack with the specified ID.
400: Customer with ID doesn't own an application pack with ID.
400: Application Pack ID cannot be deleted. It is in use by applications IDs."},"response":[]},{"name":"Retrieve an existing application pack by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"},{"value":null,"type":"text","key":"application_pack_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to retrieve

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1

Response Messages:
401: Access is denied
401: You do not have permission to access application pack with ID
404: Application pack with ID was not found for customer with ID."},"response":[]},{"name":"Update application interfaces and tag mapping","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t3\n\t\t\n\t\n\t\n\t\t\n\t\t\t2\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/application_interfaces","description":"Add application interfaces to application pack, and map a tag to the application interface. If a tag is not specified for the interface, the tag will be set to “No Tag”.

Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
body: List of interface tag mapping to be added or modified

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/application_interfaces
BODY<application_interface_tags>
    <application_interface_tag>
        <application_interface>
            <id>1</id>
        </application_interface>
        <tag>
            <id>3</id>
        </tag>
    </application_interface_tag>
    <application_interface_tag>
        <application_interface>
            <id>2</id>
        </application_interface>
    </application_interface_tag>
</application_interface_tags>


Response Messages:
401: Access is denied
404: There are no application packs with the NAME in customer with ID.
401: You do not have permissions to edit this application pack.
401: You do not have permission to access application that contains the interface ID
400: You cannot edit APPLICATION PACK because it was decommissioned.
400: Application Interface can't be null.
400: Empty interface ID is not valid."},"response":[]},{"name":"Remove application interfaces from application pack","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"},{"value":null,"type":"text","key":"application_pack_id"},{"value":null,"type":"text","key":"application_interface_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/application_interfaces","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
application_interface_id: IDs of application interfaces to remove

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/application_interfaces?application_interface_id=1&application_interface_id=2

Response Messages:
200: Application Interface was deleted.
401: Access is denied
401: You do not have permissions to edit this application pack.
404: There are no application packs with the ID in customer with ID.
404: Application Package ID was not found.
404: Application interface ID was not found in application pack ID."},"response":[]},{"name":"List all application pack tags","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"},{"value":null,"type":"text","key":"application_pack_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags

Response Messages:
401: Access is denied
404: There is no application pack with the ID."},"response":[]},{"name":"Modify tags of an application pack","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t1\n\t\tTag 1\n\t\n\t\n\t\t2\t\n\t\tTag 2\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
body: Tags to modify

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags
BODY<tags>
    <tag>
        <id>1</id>
        <name>Tag 1</name>
    </tag>
    <tag>
        <id>2</id>    
        <name>Tag 2</name>
    </tag>
</tags>


Response Messages:
401: Access is denied
401: You do not have permissions to edit this application pack.
404: Customer with ID was not found.
404: There is no application pack with the ID in customer with ID.
400: Tag with NAME already exists in application pack ID.
400: Updated tag ID can't be empty
400: Updated Tag ID doesn't exist on application pack ID."},"response":[]},{"name":"Create new Tag under an application pack ","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\tTag 1\n\t\n\t\n\t\tTag 2\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack
body: List of tags

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags
BODY<tags>
    <tag>
        <name>Tag 1</name>
    </tag>
    <tag>
        <name>Tag 2</name>
    </tag>
</tags>


Response Messages:
401: Access is denied
404: There is no application pack with the ID in customer with ID.
400: You cannot edit APPLICATION PACK because it was decommissioned.
400: Tag name must contain at least 2 and no more than 160 characters.
400: Tag with NAME already exists in application pack ID."},"response":[]},{"name":"Delete tags from application pack","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"},{"value":null,"type":"text","key":"application_pack_id"},{"value":null,"type":"text","key":"tag_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
tag_id: IDs of tags to remove

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/21/tags?tag_id=1&tag_id=2

Response Messages:
200: Tags were deleted.
401: Access is denied
401: You do not have permissions to edit this application pack.
404: There are no application packs with the ID in customer with ID.
404: Application Package ID was not found.
404: Tag ID was not found in application pack ID.
404: Tag ID is in use so can't be deleted.
404: Removed tag ID can't be empty."},"response":[]},{"name":"Delete a connection to application pack","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"application_id"},{"value":null,"type":"text","key":"connection_to_application_pack_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/{{connection_to_application_pack_id}}","description":"Parameters:
application_id: The unique identifier of application
connection_to_application_pack_id: The unique identifier of the connection to application pack to delete

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs/1

Response Messages:
400: Connection to application pack with ID was not found for application with ID.
400: The connection to application pack was already deleted.
401: Access is denied.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed."},"response":[]},{"name":"Retrieve an existing connection to application pack by ID.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"application_id"},{"value":null,"type":"text","key":"connection_to_application_pack_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/{{connection_to_application_pack_id}}","description":"Parameters:
application_id: The unique identifier of application
connection_to_application_pack_id: The unique identifier of the connection to application pack

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs/1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
404: There is no connection to application pack with the specified ID.
400: Application with ID doesn't own a connection to application pack with ID."},"response":[]},{"name":"Update an application pack","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tUpdated name\n\tUpdated Connection to application pack\n\t\n\t\t\n\t\t\t\n\t\t\t\t1\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t3\n\t\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\tTag 1\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/{{connection_to_application_pack_id}}","description":"Parameters:
application_id: The unique identifier of application
connection_to_application_pack_id: The unique identifier of the connection to application pack to update
body: Connection to application pack

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs/1
BODY<connection_to_application_pack>
    <name>Updated name</name>
    <comment>Updated Connection to application pack</comment>
    <tags_servers>
        <tag_servers>
            <tag>
                <id>1</id>
            </tag>
            <servers>
                <server>
                    <id>3</id>
                </server>
            </servers>
        </tag_servers>
        <tag_servers>
            <tag>
                <name>Tag 1</name>
            </tag>
            <servers>
            </servers>
        </tag_servers>
    </tags_servers>
</connection_to_application_pack>


Response Messages:
400: There is no application with the specified ID.
400: There is no connection to application pack with the specified ID.
400: Application with ID doesn't own a connection to application pack with ID.
400: Name cannot be empty.
400: Name must contain at least 2 and no more than 160 characters.
400: Name already exists.
400: Tag cannot be empty.
400: Tag ID or name is required.
400: Tag with Name was not found.
400: Server ID cannot be empty.
400: Servers cannot be null.
400: You cannot add ANY to connection to application pack.
400: You cannot add user to connection to application pack.
400: You cannot add Internet to connection to application pack.
401: Access is denied.
401: You do not have permission to access application that contains the server ID
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed."},"response":[]},{"name":"Update application packs","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t1\n\t\tUpdated name\n\t\tUpdated application pack\n\t\t\n\t\t\t4\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\n\t\tfalse\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/","description":"Update the application packs properties. If is_published is set to true, the application pack is published for use by other users.

Parameters:
customer_id: The unique identifier of customer
body: List of application packs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs
BODY<application_packs>
    <application_pack>
        <id>1</id>
        <name>Updated name</name>
        <comment>Updated application pack</comment>
        <owner>
            <id>4</id>
        </owner>
        <editors>
            <editor>
                <id>3</id>
            </editor>
        </editors>
        <is_published>false</is_published>
    </application_pack>
</application_packs>


Response Messages:
400: There are no application packs to edit.
400: Application pack ID cannot be empty.
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to owner ID is invalid.
400: The owner NAME does not have permission to access applications.
400: There is an editor without an ID or name.
400: The application pack owner cannot also be an editor of the application pack.
400: There is a viewer without an ID or name.
400: The application pack owner cannot also be a viewer of the application pack.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application pack.
400: Application pack NAME already exists.
400: Application pack name must contain at least 2 and no more than 160 characters.
400: Customer NAME is not imported to SecureApp.
400: Customer NAME was decommissioned.
400: Application pack with ID is not ready for publish, or has no changes from the last publish.
401: Access is denied
401: You do not have permission to access application that contains the interface ID
401: You do not have permissions to edit this application pack.
401: You do not have permissions to change the owner of application pack ID.
401: You do not have permissions to change the editors and viewers of application pack ID.
404: There are no application packs with the NAME in customer with ID."},"response":[]},{"name":"List all application packs","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/","description":"Parameters:
customer_id: The unique identifier of customer
name: The name of the application pack [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs?name=Application pack 1

Response Messages:
401: Access is denied
404: There are no application packs with the NAME in customer with ID."},"response":[]},{"name":"Create new application packs","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\tApplication pack 1\n\t\tNew application pack\n\t\t\n\t\t\t4\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t5\n\t\t\t\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/","description":"Parameters:
customer_id: The unique identifier of customer
body: List of application packs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs
BODY<application_packs>
    <application_pack>
        <name>Application pack 1</name>
        <comment>New application pack</comment>
        <owner>
            <id>4</id>
        </owner>
        <editors>
            <editor>
                <id>3</id>
            </editor>
        </editors>
        <viewers>
            <viewer>
                <id>5</id>
            </viewer>
        </viewers>
    </application_pack>
</application_packs>


Response Messages:
401: Access is denied
401: You do not have permission to access application that contains the interface ID
400: There are no application packs to add.
400: Application pack can be created only in meshed domain mode.
404: Customer with ID was not found.
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to owner ID is invalid.
400: There is an editor without an ID or name.
400: The application pack owner cannot also be an editor of the application pack.
400: There is a viewer without an ID or name.
400: The application pack owner cannot also be a viewer of the application pack.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application pack.
400: The owner NAME does not have permission to access applications.
400: Application pack was already saved.
400: Application pack NAME already exists.
400: Application pack name must contain at least 2 and no more than 160 characters.
400: Customer NAME is not imported to SecureApp.
400: Customer NAME was decommissioned."},"response":[]},{"name":"Get tag by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"},{"value":null,"type":"text","key":"application_pack_id"},{"value":null,"type":"text","key":"tag_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags/{{tag_id}}","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack
tag_id: The unique identifier of a tag

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags/1

Response Messages:
401: Access is denied
404: There is no tag with ID.
404: Customer with ID doesn't own a tag with ID.
404: Application Pack with ID doesn't own a tag with ID."},"response":[]},{"name":"Create new connection to application packs","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\tConnection to application pack 1\n\t\tNew Connection to application pack\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t1\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t3\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\tTag 1\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t4\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/","description":"Parameters:
application_id: The unique identifier of application
body: List of connection to application packs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs
BODY<connection_to_application_packs>
    <connection_to_application_pack>
        <name>Connection to application pack 1</name>
        <comment>New Connection to application pack</comment>
        <application_pack>
            <id>1</id>
        </application_pack>
        <tags_servers>
            <tag_servers>
                <tag>
                    <id>1</id>
                </tag>
                <servers>
                    <server>
                        <id>3</id>
                    </server>
                </servers>
            </tag_servers>
            <tag_servers>
                <tag>
                    <name>Tag 1</name>
                </tag>
                <servers>
                    <server>
                        <id>4</id>
                    </server>
                </servers>
            </tag_servers>
        </tags_servers>
    </connection_to_application_pack>
</connection_to_application_packs>


Response Messages:
400: There are no connection to application packs to add.
400: Application pack ID cannot be empty.
400: Application with ID was not found.
400: There is no application with the specified ID.
400: There is no application pack with the specified ID.
400: Application pack with ID was decommissioned.
400: Application pack with ID was not published.
400: Connection to application pack cannot be created in the domain of the application pack.
400: The application pack cannot be used more than once in the application.
400: Name cannot be empty.
400: Name must contain at least 2 and no more than 160 characters.
400: Name already exists.
400: Tag cannot be empty.
400: Tag ID or name is missing.
400: Tag ID does not exist.
400: Server ID does not exist.
400: Tag ID is not in use in connection to application pack ID, so it cannot be updated.
400: Servers cannot be null.
400: You cannot add ANY to connection to application pack.
400: You cannot add user to connection to application pack.
400: You cannot add Internet to connection to application pack.
401: Access is denied.
401: You do not have permission to access application that contains the server ID
401: You do not have permission to access application pack with ID
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Tag with NAME was not found."},"response":[]},{"name":"Retrieve a list of all connection to application pack by application ID.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"application_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/","description":"Parameters:
application_id: The unique identifier of application
name: The name of the connection to application pack [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs?name=Connection to application pack 1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
404: There are no connection to application pack with the NAME in application with ID."},"response":[]}]},{"name":"Application Pending Changes","item":[{"name":"Retrieve existing access rules","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/access_requests","description":"Parameters:
applicationId: The unique identifier of the application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/87/access_requests

Response Messages:
400: The application was already deleted.
400: There are no changed connections that are ready for creating a ticket.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
400: Application with ID ID was not found."},"response":[]}]},{"name":"Application Servers (across all applications)","item":[{"name":"Fetches servers","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/network_objects","description":"Parameters:
name: The name of the servers [optional]
typeOnDevice: The typeOnDevice of the servers [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects?name=server1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects?typeOnDevice=edl_ip_list

Response Messages:
400: Server with name NAME was not found.
400: Parameter typeOnDevice is not valid.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There are no servers with the name NAME
404: There are no servers with the typeOnDevice TYPEONDEVICE "},"response":[]},{"name":"Fetches server by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"serverId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/network_objects/{{serverId}}","description":"Parameters:
serverId: The ID of the server

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects/87

Response Messages:
400: Server with id ID was not found.
400: Application with ID ID was not found.
400: The application was already deleted.
401: Access is denied
401: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance."},"response":[]}]},{"name":"Application Servers (by application)","item":[{"name":"Retrieve existing servers","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects","description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the server [optional]
typeOnDevice: The typeOnDevice of the servers [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects?name=ServerName

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects?typeOnDevice=edl_ip_list

Response Messages:
400: The application was already deleted.
400: Parameter typeOnDevice is not valid.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: There are no servers with the name NAME.
404: There are no servers with the typeOnDevice TYPEONDEVICE "},"response":[]},{"name":"Update servers","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t 1\n\t\t host comment\n\t\t host1\n\t\t 1.1.1.1\n\t\t host\n\t \n\t \n\t\t 2\n\t\t range comment\n\t\t range1\n\t\t 2.2.2.2\n\t\t 2.2.2.22\n\t\t range\n\t \n\t \n\t\t 3\n\t\t subnet comment\n\t\t subnet1\n\t\t 3.3.3.3\n\t\t 255.255.255.0\n\t\t subnet\n\t \n\t \n\t\t 4\n\t\t virtual server comment\n\t\t {e1a7722f-e92e-48f2-9087-9cb1711eb8b9}\n\t\t 12\n\t\t virtual-server\n\t \n\t \n\t\t 5\n\t\t vm1\n\t\t vm instance comment\n\t\t vm_instance\n\t \n\t \n\t\t 6\n\t\t group comment\n\t\t group1\n\t\t true\n\t\t group\n\t\t \n\t\t\t 3\n\t\t \n\t\tedl_ip_list\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects","description":"Parameters:
applicationId: The unique identifier of the application
body: List of servers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects
BODY<network_objects xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
     <network_object xsi:type=\"hostNetworkObjectDTO\">
         <id>1</id>
         <comment>host comment</comment>
         <name>host1</name>
         <ip>1.1.1.1</ip>
         <type>host</type>
     </network_object>
     <network_object xsi:type=\"rangeNetworkObjectDTO\">
         <id>2</id>
         <comment>range comment</comment>
         <name>range1</name>
         <first_ip>2.2.2.2</first_ip>
         <last_ip>2.2.2.22</last_ip>
         <type>range</type>
     </network_object>
     <network_object xsi:type=\"subnetNetworkObjectDTO\">
         <id>3</id>
         <comment>subnet comment</comment>
         <name>subnet1</name>
         <ip>3.3.3.3</ip>
         <netmask>255.255.255.0</netmask>
         <type>subnet</type>
     </network_object>
     <network_object xsi:type=\"networkObjectVirtualServerDTO\">
         <id>4</id>
         <comment>virtual server comment</comment>
         <uid>{e1a7722f-e92e-48f2-9087-9cb1711eb8b9}</uid>
         <device_id>12</device_id>
         <type>virtual-server</type>
     </network_object>
     <network_object xsi:type=\"vmInstanceDTO\">
         <id>5</id>
         <name>vm1</name>
         <comment>vm instance comment</comment>
         <type>vm_instance</type>
     </network_object>
     <network_object xsi:type=\"networkObjectGroupDTO\">
         <id>6</id>
         <comment>group comment</comment>
         <name>group1</name>
         <access_allowed>true</access_allowed>
         <type>group</type>
         <member>
             <id>3</id>
         </member>
        <type_on_device>edl_ip_list</type_on_device>     </network_object>
</network_objects>


Response Messages:
400: The application was already deleted.
400: You cannot update a predefined object.
400: Invalid type in server with id ID.
400: Invalid member with id ID
400: Invalid ID
400: Invalid uid
400: Invalid network object type NAME
400: Cannot update user
400: Network object is new
400: Name cannot be empty
400: Server is in discovery
400: Ip is missing
400: Mask is missing
400: Invalid ip
400: Invalid mask
400: Max ip is missing
400: Min ip is missing
400: Invalid min ip
400: Invalid max ip
400: Min ip cannot be larger than max ip
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Internet cannot be a member of a group.
400: Server with NAME already exists.
400: Invalid device ID
400: The type_on_device value is not valid
400: An EDL group can not be modified to a regular group
400: The virtual server already exists in SecureApp as resource NAME: VIRTUAL SERVER NAME VIRTUAL SERVER DEVICE NAME.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: DTO type used for server id ID is incompatible with this vendor.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Virtual server was not found in ST.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID.
503: Not connected to SecureTrack."},"response":[]},{"name":"Create servers","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t host comment\n\t\t host1\n\t\t 1.1.1.1\n\t \n\t \n\t\t range comment\n\t\t range1\n\t\t 2.2.2.2\n \t\t 2.2.2.22\n\t \n\t \n\t\t subnet comment\n\t\t subnet1\n\t\t 3.3.3.3\n\t\t 255.255.255.0\n\t \n\t \n\t\t virtual server comment\n\t\t {e1a7722f-e92e-48f2-9087-9cb1711eb8b9}\n\t\t 12\n\t \n\t \n\t\t group comment\n\t\t group1\n\t\t true\n\t\t \n\t\t\t 3\n\t\t \n\t\tedl_ip_list\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects","description":"Parameters:
applicationId: The unique identifier of the application
body: List of servers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects
BODY<network_objects xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
     <network_object xsi:type=\"hostNetworkObjectDTO\">
         <comment>host comment</comment>
         <name>host1</name>
         <ip>1.1.1.1</ip>
     </network_object>
     <network_object xsi:type=\"rangeNetworkObjectDTO\">
         <comment>range comment</comment>
         <name>range1</name>
         <first_ip>2.2.2.2</first_ip>
         <last_ip>2.2.2.22</last_ip>
     </network_object>
     <network_object xsi:type=\"subnetNetworkObjectDTO\">
         <comment>subnet comment</comment>
         <name>subnet1</name>
         <ip>3.3.3.3</ip>
         <netmask>255.255.255.0</netmask>
     </network_object>
     <network_object xsi:type=\"networkObjectVirtualServerDTO\">
         <comment>virtual server comment</comment>
         <uid>{e1a7722f-e92e-48f2-9087-9cb1711eb8b9}</uid>
         <device_id>12</device_id>
     </network_object>
     <network_object xsi:type=\"networkObjectGroupDTO\">
         <comment>group comment</comment>
         <name>group1</name>
         <access_allowed>true</access_allowed>
         <member>
             <id>3</id>
         </member>
        <type_on_device>edl_ip_list</type_on_device>     </network_object>
</network_objects>


Response Messages:
400: There are no items to add.
400: The application was already deleted.
400: You cannot add to application NAME because it was decommissioned.
400: Network object was already saved
400: Name cannot be empty
400: Server with NAME already exists.
400: IP is missing
400: Mask is missing
400: Invalid IP
400: Invalid mask
400: Max IP is missing
400: Min IP is missing
400: Invalid min IP
400: Invalid max IP
400: Min IP cannot be larger than max IP
400: Invalid network object type CLASS_NAME.
400: Invalid uid
400: Invalid device ID
400: Virtual server does not exist in SecureTrack
400: The virtual server already exists in SecureApp as resource NAME: VIRTUAL SERVER NAME VIRTUAL SERVER DEVICE NAME.
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Internet cannot be a member of a group.
400: Cannot save the server because the virtual server does not exist.
400: Cannot save the server because an error occurred
400: The type_on_device value is not valid
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID.
404: Virtual server was not found in SecureTrack.
503: Not connected to SecureTrack."},"response":[]},{"name":"Delete server","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"serverId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}","description":"To decommission a serer use force=true.

Parameters:
applicationId: The unique identifier of the application
serverId: The unique identifier of the server
force: Force delete [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/4

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/4?force=true

Response Messages:
400: The application was already deleted.
400: You cannot delete a predefined object.
400: Cannot delete an object that is being referenced by other objects
400: Cannot delete a predefined object.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID."},"response":[]},{"name":"Retrieve an existing server by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"serverId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}","description":"Parameters:
applicationId: The unique identifier of the application
serverId: The unique identifier of the server

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/3

Response Messages:
400: The application was already deleted.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID."},"response":[]},{"name":"If the identified server is a group, return a list of its members. When the media type is 'text/plain' (default), print each member on a separate line.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}/members","description":"Parameters:
applicationId [optional]
serverId [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/6/members

Response Messages:
400: Server with ID is not of type group
401: Access is denied
401: You do not have permissions to view this application
403: No available licenses. Ask your SecureApp administrator for assistance
404: There is no application with the specified ID
404: Server with ID was not found"},"response":[]},{"name":"Move server","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"application_id"},{"value":null,"type":"text","key":"server_id"},{"value":null,"type":"text","key":"target_application_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/move_server","description":"Parameters:
application_id: The unique identifier of the application
server_id: The unique identifier of the server
target_application_id: The unique identifier of the target application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/move_server?server_id=5&target_application_id=3

Response Messages:
400: Server ID is missing.
400: Target application ID is missing.
400: You cannot move a predefined object.
400: Server with ID is already associated to application with ID.
400: Cannot move server to a different customer.
400: The application was already deleted.
400: You cannot add to application APPLICATION_NAME because it was decommissioned.
400: Group/Server cannot be moved because there is no other application to move it to.
400: Group/Server cannot be moved because it or at least one of its group members is part of these groups: GROUPS_NAME.
400: Group/Server cannot be moved because it or at least one of its group members is locked for discovery.
400: Group/Server cannot be moved because it or at least one of its group members is used in these application interfaces: APPLICATION_INTERFACE_NAME.
400: Group/Server cannot be moved because it or at least one of its group members is used in these connections with another external resource: CONNECTION_NAME
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]},{"name":"Export Server Impact Analysis to a CSV file.","request":{"method":"GET","header":[],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}/impact_analysis_csv","description":"Parameters:
applicationId [optional]
serverId [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/6/impact_analysis_csv

Response Messages:
400: Server with ID was not found.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
404: There is no application with the specified ID."},"response":[]}]},{"name":"Application Services (global)","item":[{"name":"Modify unused and non predefined global services","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t250\n\t\ticmp service updated\n\t\tUpdated comment\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\t251\n\t\tip service updated\n\t\tUpdated comment\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\t252\n\t\ttcp service updated\n\t\tUpdated comment\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t253\n\t\tudp service updated\n\t\tUpdated comment\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t254\n\t\tService Group 1 updated\n\t\tUpdated comment\n\t\tgroup\n\t\t\n\t\t\t3\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services/","description":"Parameters:
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>250</id>
        <name>icmp service updated</name>
        <comment>Updated comment</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>251</id>
        <name>ip service updated</name>
        <comment>Updated comment</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>252</id>
        <name>tcp service updated</name>
        <comment>Updated comment</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>253</id>
        <name>udp service updated</name>
        <comment>Updated comment</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <id>254</id>
        <name>Service Group 1 updated</name>
        <comment>Updated comment</comment>
        <type>group</type>
        <member>
            <id>3</id>
        </member>
        <member>
            <id>4</id>
        </member>
    </service>
</services>


Response Messages:
200: Services were modified.
400: Members IDs cannot be empty.
404: Service with ID <span style=\"font-style: italic\">ID</span> was not found.
400: Service type must be either SingleServiceDTO or ServiceMemberDTO.
400: Service is new.
400: You cannot update a predefined object.
400: Name <span style=\"font-style: italic\">NAME</span> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: Invalid protocol
400: Global Service cannot be associated with an application.
400: Cannot update a global service that is being referenced by other objects.
400: Cannot update an empty global group.
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Cannot have a local member in global group.
400: Group cannot contain itself as a member.
400: Application identity cannot be a member of a group.
401: Access is denied."},"response":[]},{"name":"Delete unused and non predefined global service by name","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"name"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services","description":"Parameters:
name: The name of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?name=Global service

Response Messages:
200: Service was deleted.
404: Service name has not been provided.
404: There are no services with the name NAME.
400: Cannot delete ANY.
400: Cannot delete an object that is being referenced by other objects.
400: Cannot delete a predefined object.
401: Access is denied."},"response":[]},{"name":"Fetches services","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services","description":"Parameters:
globals_only: get only globals [optional]
name: The name of the service [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?name=AH

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?globals_only=true

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?globals_only=true&name=AH

Response Messages:
404: There are no services with the name NAME.
401: Access is denied."},"response":[]},{"name":"Create global services","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\ticmp service\n\t\tNew service\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\tip service\n\t\tIPSEC Authentication Header Protocol\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\ttcp service\n\t\tDiscard Server Protocol (TCP)\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tudp service\n\t\tDiscard Server Protocol (UDP)\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tService Group 1\n\t\tNew Service group\n\t\tgroup\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t2\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services","description":"Parameters:
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>icmp service</name>
        <comment>New service</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>ip service</name>
        <comment>IPSEC Authentication Header Protocol</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>tcp service</name>
        <comment>Discard Server Protocol (TCP)</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>udp service</name>
        <comment>Discard Server Protocol (UDP)</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <name>Service Group 1</name>
        <comment>New Service group</comment>
        <type>group</type>
        <member>
            <id>1</id>
        </member>
        <member>
            <id>2</id>
        </member>
    </service>
</services>


Response Messages:
201: Service was created.
200: Services were created.
400: There are no items to add.
400: Members IDs cannot be empty.
404: Service with ID <span style=\"font-style: italic\">ID</span> was not found.
400: Invalid service type <span style=\"font-style: italic\">TYPE</span>
400: Name <span style=\"font-style: italic\">NAME</span> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: Global Service cannot be associated with an application.
400: Cannot create an empty global group.
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Cannot have a local member in global group.
400: Application identity cannot be a member of a group.
401: Access is denied."},"response":[]},{"name":"Fetches service by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"serviceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services/{{serviceId}}","description":"Parameters:
serviceId: The ID of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services/2

Response Messages:
404: Service with ID <span style=\"font-style: italic\">ID</span> was not found.
401: Access is denied."},"response":[]},{"name":"Delete unused and non predefined global service","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"serviceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services/{{serviceId}}","description":"Parameters:
serviceId: The ID of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services/260

Response Messages:
200: Service was deleted.
404: Global Service with ID was not found.
400: Cannot delete an object that is being referenced by other objects.
400: You cannot delete a predefined object.
401: Access is denied."},"response":[]}]},{"name":"Application Services (local)","item":[{"name":"Retrieve existing services","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services","description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the service [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services?name=Local service

Response Messages:
400: The application was already deleted.
401: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: There are no services with the name NAME."},"response":[]},{"name":"Create services","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\ticmp service\n\t\tNew service\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\tip service\n\t\tIPSEC Authentication Header Protocol\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\ttcp service\n\t\tDiscard Server Protocol (TCP)\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tudp service\n\t\tDiscard Server Protocol (UDP)\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tService Group 1\n\t\tNew Service group\n\t\tgroup\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t2\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services","description":"Parameters:
applicationId: The unique identifier of the application
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>icmp service</name>
        <comment>New service</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>ip service</name>
        <comment>IPSEC Authentication Header Protocol</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>tcp service</name>
        <comment>Discard Server Protocol (TCP)</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>udp service</name>
        <comment>Discard Server Protocol (UDP)</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <name>Service Group 1</name>
        <comment>New Service group</comment>
        <type>group</type>
        <member>
            <id>1</id>
        </member>
        <member>
            <id>2</id>
        </member>
    </service>
</services>


Response Messages:
201: Service was created.
200: Services were created.
400: There are no items to add.
400: Members IDs cannot be empty.
400: Invalid service type <span style=\"font-style: italic\">TYPE</span>
400: Name <span style=\"font-style: italic\">NAME</span> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: Cannot create an empty global group.
400: The group contains duplicate members.
400: ANY cannot be a member of a group.
400: Cannot have members from different applications.
400: Can not have application identity in group
401: Access is denied
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Service with ID <span style=\"font-style: italic\">ID</span> was not found.
404: There is no application with the specified ID."},"response":[]},{"name":"Update services","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t250\n\t\ticmp service updated\n\t\tUpdated comment\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\t251\n\t\tip service updated\n\t\tUpdated comment\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\t252\n\t\ttcp service updated\n\t\tUpdated comment\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t253\n\t\tudp service updated\n\t\tUpdated comment\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t254\n\t\tService Group 1 updated\n\t\tUpdated comment\n\t\tgroup\n\t\t\n\t\t\t3\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n\t\n\t\t255\n\t\tService Group 2 updated\n\t\tUpdated comment\n\t\tgroup\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services","description":"Parameters:
applicationId: The unique identifier of the application
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>250</id>
        <name>icmp service updated</name>
        <comment>Updated comment</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>251</id>
        <name>ip service updated</name>
        <comment>Updated comment</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>252</id>
        <name>tcp service updated</name>
        <comment>Updated comment</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>253</id>
        <name>udp service updated</name>
        <comment>Updated comment</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <id>254</id>
        <name>Service Group 1 updated</name>
        <comment>Updated comment</comment>
        <type>group</type>
        <member>
            <id>3</id>
        </member>
        <member>
            <id>4</id>
        </member>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <id>255</id>
        <name>Service Group 2 updated</name>
        <comment>Updated comment</comment>
        <type>group</type>
    </service>
</services>


Response Messages:
200: Services were modified.
400: Members IDs cannot be empty.
400: Service type must be either SingleServiceDTO or ServiceMemberDTO.
400: Local service must be associated with an application.
400: Service is locked for discovery.
400: Service is new.
400: Name <span style=\"font-style: italic\">NAME</span> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: The group contains duplicate members.
400: ANY cannot be a member of a group.
400: Application identity cannot be a member of a group.
401: Access is denied
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Service with ID <span style=\"font-style: italic\">ID</span> was not found."},"response":[]},{"name":"Delete service","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"serviceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services/{{serviceId}}","description":"Use force=true to delete a service with decommission.

Parameters:
applicationId: The unique identifier of the application
serviceId: The unique identifier of the service
force: Force delete [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services/250

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services/250?force=true

Response Messages:
400: The application was already deleted.
400: Cannot delete an object that is being referenced by other objects.
400: Cannot delete a predefined object.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Service with ID <span style=\"font-style: italic\">SERVICE_ID</span> was not found in application with id <span style=\"font-style: italic\">APPLICATION_ID</span>"},"response":[]},{"name":"Retrieve an existing service by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"serviceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services/{{serviceId}}","description":"Parameters:
applicationId: The unique identifier of the application
serviceId: The unique identifier of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services/250

Response Messages:
400: The application was already deleted.
401: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: Service with ID was not found."},"response":[]}]},{"name":"Application Users","item":[{"name":"Fetches users","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users","description":"Parameters:
name: The name of the user [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users?name=Local user 1

Response Messages:
404: There are no users with the name NAME.
401: Access is denied."},"response":[]},{"name":"Create users","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\tLocal user 1\n\t\tNew local user\n\t\t8.8.8.8\n\t\n\t\n\t\tLdap user 1\n\t\tNew ldap user\n\t\n\t\n\t\tUser group 1\n\t\tNew user group\n\t\t\n\t\t\t14\n\t\t\n\t\t\n\t\t\t15\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users","description":"Parameters:
body: List of users

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/users
BODY<users>
    <user>
        <name>Local user 1</name>
        <comment>New local user</comment>
        <ip>8.8.8.8</ip>
    </user>
    <user>
        <name>Ldap user 1</name>
        <comment>New ldap user</comment>
    </user>
    <user xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"userObjectGroupDTO\">
        <name>User group 1</name>
        <comment>New user group</comment>
        <member>
            <id>14</id>
        </member>
        <member>
            <id>15</id>
        </member>
    </user>
</users>


Response Messages:
201: User was created.
200: Users were created.
400: There are no items to add.
400: Members IDs cannot be empty.
404: User with id <span style=\"font-style: italic\">ID</span> was not found.
400: Invalid user type <span style=\"font-style: italic\">TYPE</span>
400: Name cannot be empty.
400: User with name <span style=\"font-style: italic\">NAME</span> already exists.
400: Invalid ip
401: Access is denied."},"response":[]},{"name":"Fetches user by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"userId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users/{{userId}}","description":"Parameters:
userId: The ID of the user

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users/10

Response Messages:
404: User with ID <span style=\"font-style: italic\">ID</span> was not found.
401: Access is denied."},"response":[]},{"name":"Delete unused user","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"userId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users/{{userId}}","description":"Parameters:
userId: The ID of the user

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users/10

Response Messages:
200: User was deleted.
404: User with ID <span style=\"font-style: italic\">ID</span> was not found.
400: Cannot delete an object that is being referenced by other objects.
401: Access is denied."},"response":[]}]},{"name":"Applications","item":[{"name":"Retrieve security policy violations from SecureTrack","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/compliance_violations","description":"Parameters:
applicationId [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/compliance_violations

Response Messages:
400: No valid connections found in APPLICATION.
400: Security policy compliance check is not available because a security policy has not been defined.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
503: Cannot connect to SecureTrack.
503: Timeout occurred while waiting for response from SecureTrack.
500: An error occurred in SecureTrack when running the security compliance check."},"response":[]},{"name":"List all applications","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/","description":"Parameters:
userId: Applications by user ID, if not given the default is logged in user id [optional]
name: The name of the application [optional]
app_permissions: Filter applications by the given permissions (separated with commas):\napp_owner - returns applications where the user is the owner\napp_editor - returns applications where the user has been explicitly added as an editor\napp_viewer - returns applications where the user has been explicitly added as a viewer\napp_adminonly - returns applications where the user only has editor access because user has “edit all applications” permission [note: documentation needs to explain that this list does NOT include apps listed in app_editor] [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?name=App

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?userId=1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?app_permissions=app_owner,app_editor,app_viewer

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?name=App&app_permissions=app_adminonly

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications

Response Messages:
400: Invalid app_permissions value: 'appPermissions'.
401: Access is denied
401: You can't use the parameter 'userId' because you don't have 'View all applications' permission.
404: There are no applications matching your filter.
404: User with ID 'userId' was not found."},"response":[]},{"name":"Create new applications","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t AppName\n\t\t Comment\n\t\t \n\t\t\t 3\n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 4\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 5\n\t\t\t \n\t\t \n\t\t \n\t\t\t 24\n\t\t \n\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/","description":"Parameters:
body: List all applications

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications
BODY<applications>
     <application>
         <name>AppName</name>
         <comment>Comment</comment>
         <owner>
             <id>3</id>
         </owner>
         <editors>
             <editor>
                 <id>4</id>
             </editor>
         </editors>
         <viewers>
             <viewer>
                 <id>5</id>
             </viewer>
         </viewers>
         <customer>
             <id>24</id>
         </customer>
     </application>
</applications>


Response Messages:
400: There are no items to add.
400: Application was already saved.
400: Application name must contain at least 2 and no more than 160 characters.
400: Owner cannot be empty.
400: The specified owner does not exist.
400: The owner NAME does not have permission to access applications.
400: There is an editor without an ID or name.
400: The application owner cannot also be an editor of the application.
400: There is a viewer without an ID or name.
400: The application owner cannot also be a viewer of the application.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application.
400: Application with NAME already exists.
400: Application owner is missing.
400: Reference to owner ID is invalid.
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to customer ID is invalid.
400: You must specify the name or ID of the customer.
400: The customer has no ID or name.
400: The specified customer does not exist.
400: There is an editor without an ID or name.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no editor with the name NAME."},"response":[]},{"name":"Update applications","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t 140\n\t\t App1\n\t\t true\n\t\t \n\t\t\t 4\n\t\t \n\t \n\t \n\t\t 139\n\t\t UpdatedAppName\n\t\t Updated Comment\n\t\t \n\t\t\t 4\n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 3\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 5\n\t\t\t \n\t\t \n\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/","description":"This API can be used to delete or decommission an application.
To decommission an application, send true in decommissioned tag.

Parameters:
body: List of applications

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications
BODY<applications>
     <application>
         <id>140</id>
         <name>App1</name>
         <decommissioned>true</decommissioned>
         <owner>
             <id>4</id>
         </owner>
     </application>
     <application>
         <id>139</id>
         <name>UpdatedAppName</name>
         <comment>Updated Comment</comment>
         <owner>
             <id>4</id>
         </owner>
         <editors>
             <editor>
                 <id>3</id>
             </editor>
         </editors>
         <viewers>
             <viewer>
                 <id>5</id>
             </viewer>
         </viewers>
     </application>
</applications>


Response Messages:
400: Application ID is missing.
400: Application ID is invalid
400: The application was already deleted.
400: You must include the owner field.
400: There is an editor without an ID or name.
400: The application owner cannot also be an editor of the application.
400: There is a viewer without an ID or name.
400: The application owner cannot also be a viewer of the application.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application.
401: Access is denied
401: You do not have permissions to change the owner of application ID.
401: You do not have permissions to change the editors and a viewer of application ID.
401: You do not have permissions to decommission this application.
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID."},"response":[]},{"name":"Delete an application","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}","description":"Parameters:
applicationId: The unique identifier of the application to delete

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1

Response Messages:
400: The application was already deleted.
400: The resources of application NAME are used in connections for other applications.
400: You cannot delete application NAME because its application interfaces are used in other applications.
400: You cannot delete application NAME because its application interfaces are used in other application packs.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
400: Application with ID ID was not found.
400: You cannot delete application NAME because there are connection changes pending a ticket in other application."},"response":[]},{"name":"Retrieve an existing application by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}","description":"Parameters:
applicationId: The unique identifier of an application to retrieve

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1

Response Messages:
400: The application was already deleted.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: Access is denied
401: You do not have permission to access application with ID
404: There is no application with the specified ID."},"response":[]},{"name":"Change an application","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t 139\n\t UpdatedAppName\n\t UpdatedComment\n\t false\n\t \n\t\t 4\n\t \n\t \n\t\t \n\t\t\t 3\n\t\t \n\t \n\t \n\t\t \n\t\t\t 5\n\t\t \n\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}","description":"This API can be used to delete or decommission an application.
To decommission an application, send true in decommissioned tag.

Parameters:
applicationId: The unique identifier of an application to change
body: Application

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/139
BODY<application>
     <id>139</id>
     <name>UpdatedAppName</name>
     <comment>UpdatedComment</comment>
     <decommissioned>false</decommissioned>
     <owner>
         <id>4</id>
     </owner>
     <editors>
         <editor>
             <id>3</id>
         </editor>
     </editors>
     <viewers>
         <viewer>
             <id>5</id>
         </viewer>
     </viewers>
</application>


Response Messages:
400: The application was already deleted.
400: Application owner is missing.
400: Owner cannot be empty.
400: Reference to owner ID is invalid.
400: There is an editor without an ID or name.
400: The application owner cannot also be an editor of the application.
400: There is a viewer without an ID or name.
400: The application owner cannot also be a viewer of the application.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application.
401: Access is denied
401: You do not have permissions to change the owner of application ID.
401: You do not have permissions to change the editors and a viewer of application ID.
401: You do not have permissions to decommission this application.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]},{"name":"Export application history to PDF","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"application_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/history/export_pdf","description":"Parameters:
application_id: The unique identifier of the application
start_date: States starting date to fetch history since. Date format expected: yyyy-mm-dd [optional]
end_date: Get history until this date. Date format expected: yyyy-mm-dd [optional]
count: History max rows [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?start_date=2015-07-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?start_date=2015-07-18&end_date=2015-12-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?start_date=2015-07-18&count=2

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?count=2

Response Messages:
401: Access is denied.
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
400: The date format must be: yyyy-mm-dd
400: Start date must be before End date"},"response":[]},{"name":"Move applications to another customer","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t \n\t\t\t1\n\t\t \n\t\t \n\t\t\t 2\n\t\t \n\t \n\t \n\t\t \n\t\t\t2\n\t\t \n\t\t \n\t\t\tDefault\n\t\t \n\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/move_applications","description":"Parameters:
body: List of applications and customers [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/move_applications
BODY<move_applications>
     <move_application>
         <application>
            <id>1</id>
         </application>
         <customer>
             <id>2</id>
         </customer>
     </move_application>
     <move_application>
         <application>
            <id>2</id>
         </application>
         <customer>
            <name>Default</name>
         </customer>
     </move_application>
</move_applications>


Response Messages:
200: Applications were moved successfully.
400: Multi-Customer mode is not enabled.
400: You cannot move an application pack to a different customer.
400: Reference to application is invalid.
400: APPLICATION already exists in CUSTOMER.
400: You must specify the name or ID of the customer.
400: The customer has no ID or name.
400: Reference to CUSTOMER is invalid.
400: CUSTOMER is not imported to SecureApp.
400: CUSTOMER was decommissioned.
400: You must delete virtual servers from CUSTOMER before you move APPLICATION to another customer.
400: You must remove virtual servers from the INTERFACE and publish it before you move APPLICATION to another customer.
400: You cannot move APPLICATION to CUSTOMER because the connection to application pack and the application pack cannot be in the same customer.
400: You cannot move APPLICATION to a different customer because the application interface and the application pack must be in the same customer.
400: You must remove INTERFACE from APPLICATION PACK and publish it before you can move APPLICATION to another customer.
400: CONNECTION TO APPLICATION from APPLICATION must use interface from CUSTOMER.
400: Sources in CONNECTION from APPLICATION must all be from applications in the same customer.
400: Destinations in CONNECTION in APPLICATION must all be from applications in the same customer.
400: Servers in CONNECTION from APPLICATION must all be from CUSTOMER.
400: Servers in CONNECTION TO APPLICATION from APPLICATION must be from applications in the same customer.
400: Servers in CONNECTION TO APPLICATION from APPLICATION must be from CUSTOMER.
400: Application or application pack with NAME already exists in CUSTOMER.
400: There are no applications to move.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]},{"name":"Retrieve application history","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/history","description":"Parameters:
applicationId: The unique identifier of the application
start_date: States starting date to fetch history since. Date format expected: yyyy-mm-dd [optional]
end_date: Get history until this date. Date format expected: yyyy-mm-dd [optional]
count: History list length [optional]
start: Offset the count starting point [optional]
type: States the history type to fetch [optional]
user: The username of the user made the changes [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start_date=2015-07-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start_date=2015-07-18&end_date=2015-12-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start_date=2015-07-18&count=1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start=0&count=1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?type=SERVER

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?user=Jack

Response Messages:
400: The date format must be: yyyy-mm-dd
400: Start date must be before End date
400: Count parameter must be a number
400: Start parameter must be a number
400: Start parameter must be less than total
400: Type parameter must be either server, server_group, connection, application, application_interface, connection_interface or connection_to_application
400: User not found
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID."},"response":[]},{"name":"Export Impact Analysis to a CSV file.","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"application_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/impact_analysis_csv","description":"To prevent a CSV injection attack when exporting Impact Analysis to a CSV file, if a special character ( = - + @ ) appears at the beginning of any field, a single quote (') is added before the character.

Parameters:
application_id: The unique identifier of the application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/impact_analysis_csv

Response Messages:
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
404: There is no application with the specified ID."},"response":[]}]},{"name":"Cloud Console","item":[{"name":"Auto associate cloud servers from SecureTrack with an application","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tApplication\n\ttrue\n\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/cloud_console/servers/auto_association_rule","description":"When auto-associate is enabled, user must enter key value

Parameters:
body: Auto association rule

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers/auto_association_rule
BODY<auto_association_rule>
    <key>Application</key>
    <enabled>true</enabled>
</auto_association_rule>


Response Messages:
200: Auto association rule is saved.
400: Enabled rule requires key value.
401: Access is denied
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to search for cloud servers."},"response":[]},{"name":"Retrieve cloud server listing from SecureTrack","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"vendor"},{"value":null,"type":"text","key":"search_string"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/cloud_console/servers/","description":"Parameters:
customer_id: Customer ID to be filtered by. [optional]
vendor: Vendor to be filtered by.
search_string: Search text.
start: Returning matching result starting from this element in the array (0-based). [optional]
count: Total number of matching servers to return. [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers?vendor=Amazon&search_string=WebServe

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers?vendor=Amazon&search_string=\"WebServer1\"

Response Messages:
401: Access is denied
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to search for cloud servers.
400: Illegal search string.
400: Start is bigger then possible result count.
400: Start and count cannot hold negative values.
400: Vendor query param is required.
400: Vendor should be one of the following: Amazon.
400: Search string query param is required.
400: Customer with ID does not exist in SecureApp
400: Customer with ID was decommissioned."},"response":[]},{"name":"Associate cloud servers from SecureTrack with an application","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t9\n\t\t\n\t\t\t{b503916e-4468-4dc8-981b-2ec534587352}\n\t\t\t{0cc947a5-276f-4a4a-9d12-df5284fce609}\n\t\t\n\t\n\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/cloud_console/servers/","description":"Parameters:
application_id: The ID of the application
body: List of device IDs and cloud server UIDs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers?application_id=87
BODY<devices_to_uids>
    <device_to_uids>
        <device_id>9</device_id>
        <uids>
            <uid>{b503916e-4468-4dc8-981b-2ec534587352}</uid>
            <uid>{0cc947a5-276f-4a4a-9d12-df5284fce609}</uid>
        </uids>
    </device_to_uids>
</devices_to_uids>


Response Messages:
201: Servers were imported to SecureApp.
401: Access is denied
400: There is no application with the specified ID.
401: No available licenses. Ask your SecureApp administrator for assistance.
400: You do not have permissions to edit this application.
400: You cannot associate servers with this application, because the application has been decommissioned.
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to add cloud servers.
403: UID does not exist in device ID.
403: Device with ID does not exist.
403: Device with ID does not exist in DOMAIN.
403: The AWS instance with UID and device ID has already been imported to application NAME. You cannot import the same instance multiple times."},"response":[]}]},{"name":"Customers","item":[{"name":"import customers","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t2\n\t\n\t\n\t\t3\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/import","description":"Parameters:
body: Customers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/customers/import
BODY<customers>
    <customer>
        <id>2</id>
    </customer>
    <customer>
        <id>3</id>
    </customer>
</customers>


Response Messages:
400: Not available in single-customer mode.
400: ID can not be empty.
400: There are some id's that doesn't exist.
401: Access is denied
503: Not connected to SecureTrack."},"response":[]},{"name":"List all customers","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/","description":"Parameters:
name: The name of the customer [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers?name=Customer 1

Response Messages:
400: Not available in single-customer mode.
404: There are no customers with the name NAME."},"response":[]},{"name":"Retrieve existing applications for specific domain","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/{{customer_id}}/applications","description":"Parameters:
customer_id: The ID of the customer

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/2/applications

Response Messages:
400: Not available in single-customer mode.
400: Customer with id ID was not found.
401: Access is denied"},"response":[]},{"name":"List all imported customers","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/imported","description":"

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/imported

Response Messages:
400: Not available in single-customer mode."},"response":[]},{"name":"Fetches customer by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/{{customer_id}}","description":"Parameters:
customer_id: The ID of the customer

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/1

Response Messages:
400: Not available in single-customer mode.
400: Customer with id ID was not found."},"response":[]},{"name":"Update a customer","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tNOT_IMPORTED\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/{{customer_id}}","description":"Parameters:
customer_id: The ID of the customer
body: Customers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/customers/2
BODY<customer>
    <usage_mode>NOT_IMPORTED</usage_mode>
</customer>


Response Messages:
400: Not available in single-customer mode.
400: Customer with id ID was not found.
400: Can not update Default customer.
400: This customer is already not imported.
400: USAGE_MODE is not a valid state. The valid values are: USAGE_MODES
401: Access is denied
500: This customer is not imported.
400: You cannot delete this customer because there are connection changes pending a ticket in another customer.You must decommission this customer first, and then delete it."},"response":[]},{"name":"List all non-imported customers","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/not_imported","description":"

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/not_imported

Response Messages:
400: Not available in single-customer mode.
503: Not connected to SecureTrack."},"response":[]}]},{"name":"Domains","item":[{"name":"synchronize domains","request":{"method":"PUT","header":[],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/domains/synchronize","description":"Retrieves all the domains lists in ST , for use by SC. If a domain was deleted in ST, then it will be removed from SC



Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/domains/synchronize

Response Messages:
500: Multi-Domain mode is disabled in SecureChange. Unable to synchronize with SecureTrack domains"},"response":[]},{"name":"List all domains","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/domains/","description":"Parameters:
name: The name of the domain [optional]

Usage Example


Response Messages:
404: There are no domains with the name NAME."},"response":[]},{"name":"Fetches domain by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"domainId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/domains/{{domainId}}","description":"Parameters:
domainId: The ID of the domain

Usage Example


Response Messages:
400: Domain with id ID was not found."},"response":[]}]},{"name":"Load Balancers","item":[{"name":"Fetches virtual servers from SecureTrack","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"ip"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/external_resources/f5_virtual_servers","description":"Find virtual servers matching a given IP address.
You can search for the virtual server itself of any of its members.

Parameters:
ip: ip
domainId: The unique identifier of a domain [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/external_resources/f5_virtual_servers?ip=2.2.2.2

Response Messages:
400: Invalid IP
400: Invalid Subnet
400: There is no domain with the specified ID.
401: Access is denied
503: Not connected to SecureTrack."},"response":[]}]},{"name":"SecureChange Devices","item":[{"name":"Returns the details of the devices that you can select as a target in SecureChange","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/","description":"Parameters:
name: device name or part of a name [optional]
show_targets: show devices as targets [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/devices?name=asa&show_targets=true

Response Messages:
404: Devices not found"},"response":[]},{"name":"Get suggested targets for a given access request","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"access_request\":{\n\t\t\"users\":{\n\t\t\t\"user\":[\n\t\t\t\t\"Any\"\n\t\t\t]\n\t\t},\n\t\t\"sources\":{\n\t\t\t\"source\":[\n\t\t\t\t{\n\t\t\t\t\t\"@type\":\"IP\",\n\t\t\t\t\t\"ip_address\":\"10.100.1.1\",\n\t\t\t\t\t\"netmask\":\"255.255.255.255\",\n\t\t\t\t\t\"cidr\":32\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"destinations\":{\n\t\t\t\"destination\":[\n\t\t\t\t{\n\t\t\t\t\t\"@type\":\"IP\",\n\t\t\t\t\t\"ip_address\":\"10.100.20.2\",\n\t\t\t\t\t\"netmask\":\"255.255.255.255\",\n\t\t\t\t\t\"cidr\":32\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"services\":{\n\t\t\t\"service\":[\n\t\t\t\t{\n\t\t\t\t\t\"@type\":\"ANY\",\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"action\":\"Accept\",\n\t}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/suggest_target","description":"Returns a list of suggested targets for a given access request, based on topology calculations.

Parameters:
body [optional]
domain_name: Domain Name
workflow_name: Workflow Name

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/suggest_target?domain_name=Default&workflow_name=AR
BODY{
    \"access_request\":{
        \"users\":{
            \"user\":[
                \"Any\"
            ]
        },
        \"sources\":{
            \"source\":[
                {
                    \"@type\":\"IP\",
                    \"ip_address\":\"10.100.1.1\",
                    \"netmask\":\"255.255.255.255\",
                    \"cidr\":32
                }
            ]
        },
        \"destinations\":{
            \"destination\":[
                {
                    \"@type\":\"IP\",
                    \"ip_address\":\"10.100.20.2\",
                    \"netmask\":\"255.255.255.255\",
                    \"cidr\":32
                }
            ]
        },
        \"services\":{
            \"service\":[
                {
                    \"@type\":\"ANY\",
                }
            ]
        },
        \"action\":\"Accept\",
    }
}
OUTPUT{
    \"multi_target\": {
        \"target\": {
            \"@type\": \"Object\",
            \"object_name\": \"Device-1\",
            \"object_type\": \"firewall\",
            \"object_details\": \"10.100.40.1\",
            \"management_id\": 250,
            \"management_name\": \"Panorama/Domain1\"
        }
    }
}


Response Messages:
200: Targets returned successfully
400: User does not have permissions to domain or domain does not exist
401: Access is denied"},"response":[]},{"name":"Update the whole list of excluded devices in SecureChange","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t1\n\t12\n\n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/excluded","description":"Parameters:
body [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded
BODY<device_ids>
    <id>1</id>
    <id>12</id>
</device_ids>

"},"response":[]},{"name":"Returns IDs for specified list of excluded parent management devices and child firewalls in SecureChange","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/excluded","description":"For example on this Panorama hierarchy:
DG1 - Excluded
  DG1.1
    FW1
    FW2
    FW3

Calling this API with false value will return only DG1’s id.
Calling this API with true value will return DG1, FW1, FW2, FW3 id’s.


Parameters:
show_all: When set to true - Displays the specified devices and all their child firewalls in the hierarchy, which will be excluded implicitly.
When set to false - Displays only the devices which were explicitly excluded.
Default value is false.
[optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded
OUTPUT<device_ids>
    <id>10</id>
    <id>11</id>
</device_ids>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded?show_all=false
OUTPUT<device_ids>
    <id>10</id>
    <id>11</id>
</device_ids>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded?show_all=true
OUTPUT<device_ids>
    <id>33</id>
    <id>10</id>
    <id>11</id>
    <id>35</id>
    <id>29</id>
    <id>31</id>
</device_ids>

"},"response":[]}]},{"name":"Server Decommissioning","item":[{"name":"Run server decommission designer for given task","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/multi_server_decommission_request/designer","description":"Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/multi_server_decommission_request/designer

Response Messages:
400: Server decommission designer is not defined for the requested field.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a decommission request field.
401: You do not have permission to update this task. Contact your administrator for assistance."},"response":[]},{"name":"Run Impact Analysis for given task","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/multi_server_decommission_request/impact_analysis","description":"Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/multi_server_decommission_request/impact_analysis

Response Messages:
400: Impact analysis is not defined for the requested field.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a decommission request field.
401: You do not have permission to update this task. Contact your administrator for assistance."},"response":[]},{"name":"Get impact analysis results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_server_decommission_request/{{fieldId}}/impact_analysis","description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Server Decommission Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/multi_server_decommission_request/261/impact_analysis

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>."},"response":[]},{"name":"Run Verifier for given task","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/multi_server_decommission_request/verifier","description":"Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/multi_server_decommission_request/verifier

Response Messages:
400: Verifier is not defined for the requested field.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a decommission request field.
401: You do not have permission to update this task. Contact your administrator for assistance."},"response":[]},{"name":"Get verifier results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_server_decommission_request/{{fieldId}}/verifier","description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Server Decommission Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/multi_server_decommission_request/261/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>."},"response":[]},{"name":"Get server decommission designer results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_server_decommission_request/{{fieldId}}/designer","description":"Use this API to retrieve designer results generated in R17-1 and earlier.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Server Decommission Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/multi_server_decommission_request/261/designer

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>."},"response":[]}]},{"name":"System Configuration","item":[{"name":"Modify the SecureTrack connection settings and test the connection status","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\t\n\t\t \n\t\t\t192.168.11.1\n\t\t\tadmin\n\t\t\n\t\tfalse\n\t\t30\n\t\t192.168.2.2\n\t"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/integration_with_secureTrack/","description":"Parameters:
testOnly: Test the connection status using the specified settings. The new settings are not saved. The default value is false [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/integration_with_secureTrack
BODY    <secureTrack_settings>
        <host xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"remoteHost\">
            <IP_or_hostname>192.168.11.1</IP_or_hostname>
            <user_name>admin</user_name>
        </host>
        <show_link_to_secureTrack>false</show_link_to_secureTrack>
        <check_connection_interval>30</check_connection_interval>
        <internal_IP_of_secureChange_server>192.168.2.2</internal_IP_of_secureChange_server>
    </secureTrack_settings>


Response Messages:
400: Invalid host name or IP address.
400: show_link_to_secureTrack is invalid. It must be 'true', 'false' or empty."},"response":[]},{"name":"Retrieve the SecureTrack connection settings and status","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/integration_with_secureTrack/","description":"

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/integration_with_secureTrack?testOnly=false
"},"response":[]}]},{"name":"System Users","item":[{"name":"Import user from LDAP","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tx\n\tLDAP\n\t\t\n\t\t\t1\n\t\t\n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/","description":"Parameters:
body: partyDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/users
BODY<user xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"user\">
    <name>x</name>
    <origin_type>LDAP</origin_type>
        <ldap_configuration>
            <id>1</id>
        </ldap_configuration>
</user>


Response Messages:
401: Access is denied.
400: Name is missing.
400: Origin is missing.
400: User {login_name} already exists, with ID (id} and name {name}.
400: User {login_name} not found in LDAP.
400: Creating a user via REST API is available only if origin is LDAP.
400: Creating a user via REST API is available only if type is User.
400: Ldap configuration with ID {id} not found."},"response":[]},{"name":"Return the list of users","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/","description":"user_name: case insensitive, search mode: contains text
exact_name: when set to true, user_name search mode is case sensitive and exact text
email: case insentitive, search mode: exact match
Logical OR between user_name and email.

Parameters:
showIndirectRelation: Members that belong to the selected group only indirectly [optional]
user_name: The user's login name [optional]
email: The user's email [optional]
exact_name: Search user_name as exact match [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/users?email=bob@tufin.com&user_name=bob&exact_name=true
"},"response":[]},{"name":"Return the specified user","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/{{id}}","description":"Parameters:
id: The user's ID
showIndirectRelation: Members that belong to the selected group only indirectly [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/users/5

Response Messages:
400: User or group was not found."},"response":[]}]},{"name":"Ticket Lifecycle","item":[{"name":"Reject a ticket","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\trejected\n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/reject","description":"Parameters:
id: The ID of the ticket as shown in SecureChange
handler_id: The user id, when logged in user is rejecting on behalf [optional]
body: Reject comment

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/reject?handler_id=5
BODY<reject_comment>
    <comment>rejected</comment>
</reject_comment>


Response Messages:
400: Ticket status <STATUS> is incorrect to perform this action
400: User <NAME> has no permissions to perform this action
400: Comment cannot be empty
401: User is not permitted to reject this ticket on behalf another user
401: You do not have permission to access ticket <ID>
401: On behalf user do not have permission to access ticket <ID>
401: Access is denied.
404: There is no ticket with ID <ID>.
404: There is no handler (User) with ID <ID>."},"response":[]},{"name":"Map rules to ticket","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/map_rules","description":"Maps the rules from the ticket to the relevant rules in SecureTrack.
Adds record set entries to the relevant rules metadata.
Link to history is found in the returned location header.
Applicable only for closed tickets in the following workflows: Access Request, Access Request and Modify Group, and Clone Server Policy.
Use handler_id for running on behalf of another user.
To get handler_id, use the System Users API.

Parameters:
id: The ID of the ticket as shown in SecureChange
handler_id: Run API on behalf of defined user id [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/map_rules

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/map_rules?handler_id=5

Response Messages:
201: Started asynchronous mapping of rules to ticket ID <ID>. Mapping status is displayed in ticket history.
400: Ticket's workflow type does not support this operation
401: Access is denied.
401: You do not have permission to access ticket <ID>
401: On behalf user do not have permission to access ticket <ID>
404: There is no ticket with ID <ID>.
404: There is no handler (User) with ID <ID>.
412: Ticket is not in closed status"},"response":[]},{"name":"Reassigns the specified ticket task to the specified user.","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tPlease complete the AR\n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/reassign/{{assigneeId}}","description":"Values can only be updated for the current step.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
assigneeId: The assignee ID
body: ReassignTaskCommentDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/reassign/4
BODY<reassign_task_comment>
    <comment>Please complete the AR</comment>
</reassign_task_comment>


Response Messages:
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Task <NAME> is no longer active
404: There is no ticket with ID.
404: No entity found for query"},"response":[]},{"name":"Confirm the request","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tconfirmed\n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/confirm","description":"Parameters:
id: Ticket ID
requester_id: The user of the ticket's requester, when logged in user is confirm on behalf [optional]
body: Confirm comment

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/confirm?requester_id=5
BODY<confirm_comment>
    <comment>confirmed</comment>
</confirm_comment>


Response Messages:
400: User is trying to confirm a ticket that belongs to another user
400: User is not permitted to confirm this ticket on behalf another user
400: The user can not confirm the ticket, because he is not in the domain of the ticket
401: Access is denied.
404: There is no ticket with ID ."},"response":[]},{"name":"Change the requester of the specified ticket task to the specified user.","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tuser was deleted moving tickets to Bob\n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/change_requester/{{assigneeId}}","description":"Parameters:
id: Ticket ID
assigneeId: The assignee ID
body: CommentDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/change_requester/4
BODY<comment>
    <comment>user was deleted moving tickets to Bob</comment>
</comment>


Response Messages:
400: The change requester comment must be set in order to change the requester the ticket.
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
404: There is no ticket with ID.
404: There is no requester (User) with ID."},"response":[]},{"name":"Returns the specified ticket to the specified step","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tplease fix source \n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/redo/{{toStepId}}","description":"Values can only be updated for the current step.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
toStepId: To which step we the ticket will return
body: RedoCommentDto

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/redo/1
BODY<redo_step_comment>
    <comment>please fix source </comment>
</redo_step_comment>


Response Messages:
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Task <NAME> is no longer active
401: User has no permissions to redo ticket steps.
404: There is no ticket with ID.
404: No entity found for query"},"response":[]},{"name":"Returns the history of the specified ticket","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/history","description":"Parameters:
id: Ticket ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/history

Response Messages:
401: User has no permissions to view ticket history
404: You do not have permission to view this task. Contact your administrator for assistance.
404: There is no ticket with ID."},"response":[]},{"name":"Cancel a ticket","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/cancel","description":"Parameters:
id: The ID of the ticket as shown in SecureChange
requester_id: The user of the ticket's requester, when logged in user is canceling on behalf [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/cancel?requester_id=5

Response Messages:
401: Access is denied.
404: Ticket is already closed
404: Ticket ID was not found"},"response":[]}]},{"name":"Tickets","item":[{"name":"Returns the details of a the fields","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
taskId: The ID number of the task as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.
404: Task with ID was not found in Stage ID in ticket ID ."},"response":[]},{"name":"Change multiple fields within a task of a ticket","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\t\"fields\": {\n\t\t\"field\": {\n\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\"id\": 71,\n\t\t\t\"name\": \"Fire Wall Rule\",\n\t\t\t\"read_only\": false,\n\t\t\t\"devices\": {\n\t\t\t\t\"device\": {\n\t\t\t\t\t\"revision_id\": 4,\n\t\t\t\t\t\"management_name\": \"Panorama/DG_1\",\n\t\t\t\t\t\"management_id\": 4,\n\t\t\t\t\t\"management_ip\": \"10.100.111.120\",\n\t\t\t\t\t\"revision_number\": 1,\n\t\t\t\t\t\"number_of_rules\": 1,\n\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\"policy_name\": \"Standard\"\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"Application test\",\n\t\t\t\t\t\t\t\t\t\"is_disabled\": false,\n\t\t\t\t\t\t\t\t\t\"ruleNumber\": 13,\n\t\t\t\t\t\t\t\t\t\"from_zone\": \"any\",\n\t\t\t\t\t\t\t\t\t\"to_zone\": \"any\",\n\t\t\t\t\t\t\t\t\t\"sourceNetworks\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\"display_name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"comment\",\n\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a01a\",\n\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\t\"ip\": \"5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"destinationNetworks\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\"display_name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a016\",\n\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"destinationServices\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\"display_name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a018\",\n\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\"min_port\": 82,\n\t\t\t\t\t\t\t\t\t\t\"max_port\": 82\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"applications\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"single_application\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\"display_name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\"class_name\": \"application_object\",\n\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE_PREDEFINED\",\n\t\t\t\t\t\t\t\t\t\t\"global\": true,\n\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"service\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\"implicit\": true,\n\t\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a014\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\t\t\"min_port\": 80,\n\t\t\t\t\t\t\t\t\t\t\t\t\"max_port\": 80\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"action\": \"ACCEPT\",\n\t\t\t\t\t\t\t\t\t\"additional_parameters\": \"\",\n\t\t\t\t\t\t\t\t\t\"options\": {\n\t\t\t\t\t\t\t\t\t\t\"option\": \"LOG_SESSION\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"rule_location\": \"DG_1\",\n\t\t\t\t\t\t\t\t\t\"users\": {\n\t\t\t\t\t\t\t\t\t\t\"user\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Any\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"any_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"displayName\": \"Any\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"track\": {\n\t\t\t\t\t\t\t\t\t\t\"track_level\": \"LOG\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"install_ons\": \"\",\n\t\t\t\t\t\t\t\t\t\"communities\": \"\",\n\t\t\t\t\t\t\t\t\t\"times\": \"\",\n\t\t\t\t\t\t\t\t\t\"rule_metadata\": {\n\t\t\t\t\t\t\t\t\t\t\"permissiveness_level\": \"LOW\",\n\t\t\t\t\t\t\t\t\t\t\"violations\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"last_hit\": \"No hits\",\n\t\t\t\t\t\t\t\t\t\t\"shadowed_status\": \"FALSE\",\n\t\t\t\t\t\t\t\t\t\t\"ticket_ids\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"business_owners\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"expirations\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"applications\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"last_modified\": \"Today\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"rule_modifications\": {\n\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\"id\": 10,\n\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"\n\t\t\t\t\t},\n\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\"id\": 20,\n\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 69,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 65,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"9b9062a0-228a-4543-bbd4-9fda5c76573b\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 65,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Host\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 68,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 64,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"986c68ab-b5b5-478d-9300-bc0cacc06dfe\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 64,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Address Ragne\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"192.168.0.1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"192.168.0.254\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 70,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 68,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"1073dad5-4dc9-4392-8b42-f32de2937657\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 68,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Network\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t]\n\t\t\t\t\t\t}\n\t\t\t\t\t},\n\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\"id\": 19,\n\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 66,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 67,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"e52c07fc-dffb-4c77-a656-40d1b1322e77\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 67,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Range-Test\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"1.1.2.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"1.1.2.55\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 67,\n\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 66,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"fa681c9b-8c4f-449d-9b31-108a399902f5\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 66,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 65,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 70,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"2b8eaa1a-f4ea-4c39-b89e-361af89a308e\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 2,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 70,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Net_10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 64,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 69,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"88efeaad-cfb4-41c4-b14c-fff104c24e52\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 69,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host_10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t]\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"designer_result\": {\n\t\t\t\t\"status\": \"not run\"\n\t\t\t}\n\t\t}\n\t}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both object_UID and object_name are defined, object_UID takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldListDTO
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/2/tasks/4/fields
BODY<fields>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_network_object\">
         <id>7885</id>
         <name>n_obj</name>
         <network_object type=\"Object\">
             <object_name>Host_10.1.1.1</object_name>
             <management_name>cp239</management_name>
         </network_object>
         <network_object type=\"Object\">
             <object_UID>{55908141-c341-4990-9cc6-a3fd2dfb49e1}</object_UID>
             <management_id>2</management_id>
         </network_object>
         <network_object type=\"DNS\">
             <host_name>tufin.com</host_name>
         </network_object>
     <field>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_service\">
         <id>7887</id>
         <name>service</name>
         <service type=\"PROTOCOL\">
             <protocol>TCP</protocol>
             <port>80</port>
         </service>
         <service type=\"Object\">
             <object_name>AOL</object_name>
             <management_name>cp239</management_name>
         </service>
     </field>
</fields>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields
BODY{
    \"fields\": {
        \"field\": {
            \"@xsi.type\": \"rule_modification_field\",
            \"id\": 71,
            \"name\": \"Fire Wall Rule\",
            \"read_only\": false,
            \"devices\": {
                \"device\": {
                    \"revision_id\": 4,
                    \"management_name\": \"Panorama/DG_1\",
                    \"management_id\": 4,
                    \"management_ip\": \"10.100.111.120\",
                    \"revision_number\": 1,
                    \"number_of_rules\": 1,
                    \"bindings\": {
                        \"binding\": {
                            \"binding_uid\": \"{00-FACED0-00}\",
                            \"binding\": {
                                \"@xsi.type\": \"policy__binding\",
                                \"policy_name\": \"Standard\"
                            },
                            \"rules\": {
                                \"rule\": {
                                    \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                    \"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",
                                    \"name\": \"Application test\",
                                    \"is_disabled\": false,
                                    \"ruleNumber\": 13,
                                    \"from_zone\": \"any\",
                                    \"to_zone\": \"any\",
                                    \"sourceNetworks\": {
                                        \"@xsi.type\": \"host_network_object\",
                                        \"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",
                                        \"name\": \"H_5.3.2.5\",
                                        \"display_name\": \"H_5.3.2.5\",
                                        \"class_name\": \"host_plain\",
                                        \"origin\": \"DEVICE\",
                                        \"global\": false,
                                        \"implicit\": false,
                                        \"shared\": false,
                                        \"comment\": \"comment\",
                                        \"id\": \"5df1f2a5e9023c311ae4a01a\",
                                        \"version_id\": 4,
                                        \"device_type\": \"PaloAltoNetworks\",
                                        \"ip_type\": \"IPV4\",
                                        \"referenced\": \"UNKNOWN\",
                                        \"installable_target\": false,
                                        \"ip\": \"5.3.2.5\",
                                        \"subnet_mask\": \"255.255.255.255\"
                                    },
                                    \"destinationNetworks\": {
                                        \"@xsi.type\": \"host_network_object\",
                                        \"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",
                                        \"name\": \"22.22.2.2\",
                                        \"display_name\": \"22.22.2.2\",
                                        \"class_name\": \"host_plain\",
                                        \"origin\": \"DEVICE\",
                                        \"global\": false,
                                        \"implicit\": false,
                                        \"shared\": false,
                                        \"comment\": \"\",
                                        \"id\": \"5df1f2a5e9023c311ae4a016\",
                                        \"version_id\": 4,
                                        \"device_type\": \"PaloAltoNetworks\",
                                        \"ip_type\": \"IPV4\",
                                        \"referenced\": \"UNKNOWN\",
                                        \"installable_target\": false,
                                        \"ip\": \"22.22.2.2\",
                                        \"subnet_mask\": \"255.255.255.255\"
                                    },
                                    \"destinationServices\": {
                                        \"@xsi.type\": \"transport_service\",
                                        \"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",
                                        \"name\": \"TCP82\",
                                        \"display_name\": \"TCP82\",
                                        \"class_name\": \"tcp_service\",
                                        \"origin\": \"DEVICE\",
                                        \"global\": false,
                                        \"implicit\": false,
                                        \"shared\": false,
                                        \"comment\": \"TCP82\",
                                        \"id\": \"5df1f2a5e9023c311ae4a018\",
                                        \"version_id\": 4,
                                        \"referenced\": \"UNKNOWN\",
                                        \"type_on_device\": \"\",
                                        \"negate\": false,
                                        \"match_for_any\": false,
                                        \"timeout\": 0,
                                        \"protocol\": 6,
                                        \"min_port\": 82,
                                        \"max_port\": 82
                                    },
                                    \"applications\": {
                                        \"@xsi.type\": \"single_application\",
                                        \"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",
                                        \"name\": \"web-browsing\",
                                        \"display_name\": \"web-browsing\",
                                        \"class_name\": \"application_object\",
                                        \"origin\": \"DEVICE_PREDEFINED\",
                                        \"global\": true,
                                        \"implicit\": false,
                                        \"shared\": false,
                                        \"comment\": \"\",
                                        \"service\": [
                                            {
                                                \"@xsi.type\": \"transport_service\",
                                                \"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",
                                                \"name\": \"st_implicit_app_web-browsing\",
                                                \"display_name\": \"st_implicit_app_web-browsing\",
                                                \"class_name\": \"tcp_service\",
                                                \"origin\": \"DEVICE\",
                                                \"global\": false,
                                                \"implicit\": true,
                                                \"shared\": false,
                                                \"comment\": \"\",
                                                \"id\": \"5df1f2a5e9023c311ae4a014\",
                                                \"version_id\": 4,
                                                \"referenced\": \"UNKNOWN\",
                                                \"type_on_device\": \"\",
                                                \"negate\": false,
                                                \"match_for_any\": false,
                                                \"timeout\": 0,
                                                \"protocol\": 6,
                                                \"min_port\": 80,
                                                \"max_port\": 80
                                            }
                                        ]
                                    },
                                    \"action\": \"ACCEPT\",
                                    \"additional_parameters\": \"\",
                                    \"options\": {
                                        \"option\": \"LOG_SESSION\"
                                    },
                                    \"rule_location\": \"DG_1\",
                                    \"users\": {
                                        \"user\": [
                                            {
                                                \"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",
                                                \"name\": \"Any\",
                                                \"class_name\": \"any_object\",
                                                \"displayName\": \"Any\"
                                            }
                                        ]
                                    },
                                    \"track\": {
                                        \"track_level\": \"LOG\"
                                    },
                                    \"install_ons\": \"\",
                                    \"communities\": \"\",
                                    \"times\": \"\",
                                    \"rule_metadata\": {
                                        \"permissiveness_level\": \"LOW\",
                                        \"violations\": \"\",
                                        \"last_hit\": \"No hits\",
                                        \"shadowed_status\": \"FALSE\",
                                        \"ticket_ids\": \"\",
                                        \"business_owners\": \"\",
                                        \"expirations\": \"\",
                                        \"applications\": \"\",
                                        \"last_modified\": \"Today\"
                                    }
                                }
                            }
                        }
                    }
                }
            },
            \"rule_modifications\": {
                \"rule_modification\": {
                    \"@xsi.type\": \"modify_rule_modification\",
                    \"id\": 10,
                    \"rule_key\": {
                        \"device_id\": 4,
                        \"binding_uid\": \"{00-FACED0-00}\",
                        \"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"
                    },
                    \"source_modifications\": {
                        \"id\": 20,
                        \"network_object_cell_modifications\": {
                            \"network_object_cell_modification\": [
                                {
                                    \"id\": 69,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 65,
                                        \"uid\": \"9b9062a0-228a-4543-bbd4-9fda5c76573b\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"new\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                \"id\": 65,
                                                \"name\": \"My New Host\",
                                                \"comment\": \"some comment\",
                                                \"ip\": \"192.168.0.10\",
                                                \"netmask\": \"255.255.255.255\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 68,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 64,
                                        \"uid\": \"986c68ab-b5b5-478d-9300-bc0cacc06dfe\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"new\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                \"id\": 64,
                                                \"name\": \"My New Address Ragne\",
                                                \"comment\": \"some comment\",
                                                \"min_ip\": \"192.168.0.1\",
                                                \"max_ip\": \"192.168.0.254\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 70,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 68,
                                        \"uid\": \"1073dad5-4dc9-4392-8b42-f32de2937657\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"new\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                \"id\": 68,
                                                \"name\": \"My New Network\",
                                                \"comment\": \"some comment\",
                                                \"ip\": \"192.168.0.0\",
                                                \"netmask\": \"255.255.255.0\"
                                            }
                                        ]
                                    }
                                }
                            ]
                        }
                    },
                    \"destination_modifications\": {
                        \"id\": 19,
                        \"network_object_cell_modifications\": {
                            \"network_object_cell_modification\": [
                                {
                                    \"id\": 66,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 67,
                                        \"uid\": \"e52c07fc-dffb-4c77-a656-40d1b1322e77\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"existing\",
                                            \"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                \"id\": 67,
                                                \"name\": \"Range-Test\",
                                                \"comment\": \"\",
                                                \"min_ip\": \"1.1.2.0\",
                                                \"max_ip\": \"1.1.2.55\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 67,
                                    \"action\": \"REMOVE\",
                                    \"device_network_object\": {
                                        \"id\": 66,
                                        \"uid\": \"fa681c9b-8c4f-449d-9b31-108a399902f5\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"existing\",
                                            \"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                \"id\": 66,
                                                \"name\": \"22.22.2.2\",
                                                \"comment\": \"\",
                                                \"ip\": \"22.22.2.2\",
                                                \"netmask\": \"255.255.255.255\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 65,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 70,
                                        \"uid\": \"2b8eaa1a-f4ea-4c39-b89e-361af89a308e\",
                                        \"device_id\": 2,
                                        \"status\": {
                                            \"@xsi.type\": \"existing\",
                                            \"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                \"id\": 70,
                                                \"name\": \"Net_10.108.151.0\",
                                                \"comment\": \"\",
                                                \"ip\": \"10.108.151.0\",
                                                \"netmask\": \"255.255.255.0\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 64,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 69,
                                        \"uid\": \"88efeaad-cfb4-41c4-b14c-fff104c24e52\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"existing\",
                                            \"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                \"id\": 69,
                                                \"name\": \"Host_10.10.10.10\",
                                                \"comment\": \"\",
                                                \"ip\": \"10.10.10.10\",
                                                \"netmask\": \"255.255.255.255\"
                                            }
                                        ]
                                    }
                                }
                            ]
                        }
                    }
                }
            },
            \"designer_result\": {
                \"status\": \"not run\"
            }
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket step does not exist, or is not the current step
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: The new network object (<name>): device ID (<id>) does not match the rule key device ID (<id>). The device IDs must be the same.
400: Device ID is required for a new device network object
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <name>
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <st_uid>
400: <cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty.
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (Device ID is required for an existing device network object)
400: Invalid value for field: <FIELD_NAME> (ST UID is required for an existing device network object
400: Invalid value for field: <FIELD_NAME> (Network Object with device ID <DEVICE_ID> and ST UID <ST_UID> is not available for the action specified. Check the Knowledge Center or API Implementation Notes for more information
400: Status is required for a device network object"},"response":[]},{"name":"Get commands for device from designer results of a specific field id","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"deviceId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/designer/device/{{deviceId}}/commands","description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
deviceId: Device ID
fieldId: Field ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/designer/device/136/commands

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: Specified field, id: <ID> , name: <NAME>, cannot contain designer result
404: Designer results were not found in the access request.
404: Device with ID <ID> was not found in Designer result.
404: Device with ID <ID> does not support Commands feature."},"response":[]},{"name":"Change the ticket properties","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t\n\t\n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/ticket_properties","description":"Change the ticket properties listed in the TicketPropertiesDTO.
When specifying the notification_group property you must use the ID of the group or leave the ID empty to remove the group.

Parameters:
body: ticketPropertiesDTO
id: The ID number of the ticket as shown in SecureChange

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/ticket_properties
BODY<ticket_properties>
    <notification_group>
        <id>10</id>
    </notification_group>
</ticket_properties>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/ticket_properties
BODY<ticket_properties>
    <notification_group>
        <id/>
    </notification_group>
</ticket_properties>


Response Messages:
400: Notification Group <ID> is a user and not a user group
400: Notification Group <ID> exceeds the configured maximum allowed number of users for notifications
400: <ID> (“Any User”) is not allowed as a Notification Group
400: Notification Group <ID> does not have permission of 'Group members can perform actions on requests submitted by other members'
400: Notification Group <ID> is not a member in the first step of the workflow
400: Notification Group is not enabled in this workflow
401: You do not have permission to change the Notification Group
404: There is no group with ID <ID>.
404: There is no ticket with ID <ID>."},"response":[]},{"name":"Change a task of a ticket at the current step","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\t\"task\": {\n\t\t\"id\": 4,\n\t\t\"assignee_id\": 4,\n\t\t\"assignee\": \"a\",\n\t\t\"status\": \"ASSIGNED\",\n\t\t\"fields\": {\n\t\t\t\"field\": {\n\t\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\t\"id\": 71,\n\t\t\t\t\"name\": \"Fire Wall Rule\",\n\t\t\t\t\"read_only\": false,\n\t\t\t\t\"devices\": {\n\t\t\t\t\t\"device\": {\n\t\t\t\t\t\t\"revision_id\": 4,\n\t\t\t\t\t\t\"management_name\": \"Panorama/DG_1\",\n\t\t\t\t\t\t\"management_id\": 4,\n\t\t\t\t\t\t\"management_ip\": \"10.100.111.120\",\n\t\t\t\t\t\t\"revision_number\": 1,\n\t\t\t\t\t\t\"number_of_rules\": 1,\n\t\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\t\"policy_name\": \"Standard\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"Application test\",\n\t\t\t\t\t\t\t\t\t\t\"is_disabled\": false,\n\t\t\t\t\t\t\t\t\t\t\"ruleNumber\": 13,\n\t\t\t\t\t\t\t\t\t\t\"from_zone\": \"any\",\n\t\t\t\t\t\t\t\t\t\t\"to_zone\": \"any\",\n\t\t\t\t\t\t\t\t\t\t\"sourceNetworks\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"comment\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a01a\",\n\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"destinationNetworks\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a016\",\n\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"destinationServices\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a018\",\n\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\t\"min_port\": 82,\n\t\t\t\t\t\t\t\t\t\t\t\"max_port\": 82\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"applications\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"single_application\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"application_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE_PREDEFINED\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": true,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"service\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"implicit\": true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a014\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_port\": 80,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_port\": 80\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ACCEPT\",\n\t\t\t\t\t\t\t\t\t\t\"additional_parameters\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"options\": {\n\t\t\t\t\t\t\t\t\t\t\t\"option\": \"LOG_SESSION\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"rule_location\": \"DG_1\",\n\t\t\t\t\t\t\t\t\t\t\"users\": {\n\t\t\t\t\t\t\t\t\t\t\t\"user\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Any\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"any_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"displayName\": \"Any\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"track\": {\n\t\t\t\t\t\t\t\t\t\t\t\"track_level\": \"LOG\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"install_ons\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"communities\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"times\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"rule_metadata\": {\n\t\t\t\t\t\t\t\t\t\t\t\"permissiveness_level\": \"LOW\",\n\t\t\t\t\t\t\t\t\t\t\t\"violations\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"last_hit\": \"No hits\",\n\t\t\t\t\t\t\t\t\t\t\t\"shadowed_status\": \"FALSE\",\n\t\t\t\t\t\t\t\t\t\t\t\"ticket_ids\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"business_owners\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"expirations\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"applications\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"last_modified\": \"Today\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"rule_modifications\": {\n\t\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\t\"id\": 13,\n\t\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\t\"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\t\"id\": 26,\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 89,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 88,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"e7e4ac52-2fe4-49f7-8071-9638817a7434\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 88,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Host\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 91,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 89,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"13556e3e-1f93-4f95-939c-428a58001615\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 89,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Address Ragne\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"192.168.0.1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"192.168.0.254\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 90,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 87,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"1ecb9679-4da4-4fc5-9382-00f5fa455295\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 87,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Network\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\t\"id\": 25,\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 88,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 91,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"50f35caf-3f13-4961-9ccd-055e1703592a\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 91,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host_10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 85,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 90,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"21342c9a-3974-4bd3-b74b-b142e43ed39a\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 90,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Range-Test\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"1.1.2.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"1.1.2.55\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 86,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 86,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"8fff4c36-da34-4945-be33-ffd5d4d444e2\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 86,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 87,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 85,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"35ec73ed-e0fa-4690-9570-00b417b63ae6\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 2,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 85,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Net_10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"designer_result\": {\n\t\t\t\t\t\"status\": \"not run\"\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both object_UID and object_name are defined, object_UID takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: ticketTaskDTO
id: Ticket ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4
BODY<task>
    <status>DONE</status>
    <fields/>
</task>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/
BODY{
    \"task\": {
        \"id\": 4,
        \"assignee_id\": 4,
        \"assignee\": \"a\",
        \"status\": \"ASSIGNED\",
        \"fields\": {
            \"field\": {
                \"@xsi.type\": \"rule_modification_field\",
                \"id\": 71,
                \"name\": \"Fire Wall Rule\",
                \"read_only\": false,
                \"devices\": {
                    \"device\": {
                        \"revision_id\": 4,
                        \"management_name\": \"Panorama/DG_1\",
                        \"management_id\": 4,
                        \"management_ip\": \"10.100.111.120\",
                        \"revision_number\": 1,
                        \"number_of_rules\": 1,
                        \"bindings\": {
                            \"binding\": {
                                \"binding_uid\": \"{00-FACED0-00}\",
                                \"binding\": {
                                    \"@xsi.type\": \"policy__binding\",
                                    \"policy_name\": \"Standard\"
                                },
                                \"rules\": {
                                    \"rule\": {
                                        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                        \"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",
                                        \"name\": \"Application test\",
                                        \"is_disabled\": false,
                                        \"ruleNumber\": 13,
                                        \"from_zone\": \"any\",
                                        \"to_zone\": \"any\",
                                        \"sourceNetworks\": {
                                            \"@xsi.type\": \"host_network_object\",
                                            \"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",
                                            \"name\": \"H_5.3.2.5\",
                                            \"display_name\": \"H_5.3.2.5\",
                                            \"class_name\": \"host_plain\",
                                            \"origin\": \"DEVICE\",
                                            \"global\": false,
                                            \"implicit\": false,
                                            \"shared\": false,
                                            \"comment\": \"comment\",
                                            \"id\": \"5df1f2a5e9023c311ae4a01a\",
                                            \"version_id\": 4,
                                            \"device_type\": \"PaloAltoNetworks\",
                                            \"ip_type\": \"IPV4\",
                                            \"referenced\": \"UNKNOWN\",
                                            \"installable_target\": false,
                                            \"ip\": \"5.3.2.5\",
                                            \"subnet_mask\": \"255.255.255.255\"
                                        },
                                        \"destinationNetworks\": {
                                            \"@xsi.type\": \"host_network_object\",
                                            \"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",
                                            \"name\": \"22.22.2.2\",
                                            \"display_name\": \"22.22.2.2\",
                                            \"class_name\": \"host_plain\",
                                            \"origin\": \"DEVICE\",
                                            \"global\": false,
                                            \"implicit\": false,
                                            \"shared\": false,
                                            \"comment\": \"\",
                                            \"id\": \"5df1f2a5e9023c311ae4a016\",
                                            \"version_id\": 4,
                                            \"device_type\": \"PaloAltoNetworks\",
                                            \"ip_type\": \"IPV4\",
                                            \"referenced\": \"UNKNOWN\",
                                            \"installable_target\": false,
                                            \"ip\": \"22.22.2.2\",
                                            \"subnet_mask\": \"255.255.255.255\"
                                        },
                                        \"destinationServices\": {
                                            \"@xsi.type\": \"transport_service\",
                                            \"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",
                                            \"name\": \"TCP82\",
                                            \"display_name\": \"TCP82\",
                                            \"class_name\": \"tcp_service\",
                                            \"origin\": \"DEVICE\",
                                            \"global\": false,
                                            \"implicit\": false,
                                            \"shared\": false,
                                            \"comment\": \"TCP82\",
                                            \"id\": \"5df1f2a5e9023c311ae4a018\",
                                            \"version_id\": 4,
                                            \"referenced\": \"UNKNOWN\",
                                            \"type_on_device\": \"\",
                                            \"negate\": false,
                                            \"match_for_any\": false,
                                            \"timeout\": 0,
                                            \"protocol\": 6,
                                            \"min_port\": 82,
                                            \"max_port\": 82
                                        },
                                        \"applications\": {
                                            \"@xsi.type\": \"single_application\",
                                            \"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",
                                            \"name\": \"web-browsing\",
                                            \"display_name\": \"web-browsing\",
                                            \"class_name\": \"application_object\",
                                            \"origin\": \"DEVICE_PREDEFINED\",
                                            \"global\": true,
                                            \"implicit\": false,
                                            \"shared\": false,
                                            \"comment\": \"\",
                                            \"service\": [
                                                {
                                                    \"@xsi.type\": \"transport_service\",
                                                    \"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",
                                                    \"name\": \"st_implicit_app_web-browsing\",
                                                    \"display_name\": \"st_implicit_app_web-browsing\",
                                                    \"class_name\": \"tcp_service\",
                                                    \"origin\": \"DEVICE\",
                                                    \"global\": false,
                                                    \"implicit\": true,
                                                    \"shared\": false,
                                                    \"comment\": \"\",
                                                    \"id\": \"5df1f2a5e9023c311ae4a014\",
                                                    \"version_id\": 4,
                                                    \"referenced\": \"UNKNOWN\",
                                                    \"type_on_device\": \"\",
                                                    \"negate\": false,
                                                    \"match_for_any\": false,
                                                    \"timeout\": 0,
                                                    \"protocol\": 6,
                                                    \"min_port\": 80,
                                                    \"max_port\": 80
                                                }
                                            ]
                                        },
                                        \"action\": \"ACCEPT\",
                                        \"additional_parameters\": \"\",
                                        \"options\": {
                                            \"option\": \"LOG_SESSION\"
                                        },
                                        \"rule_location\": \"DG_1\",
                                        \"users\": {
                                            \"user\": [
                                                {
                                                    \"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",
                                                    \"name\": \"Any\",
                                                    \"class_name\": \"any_object\",
                                                    \"displayName\": \"Any\"
                                                }
                                            ]
                                        },
                                        \"track\": {
                                            \"track_level\": \"LOG\"
                                        },
                                        \"install_ons\": \"\",
                                        \"communities\": \"\",
                                        \"times\": \"\",
                                        \"rule_metadata\": {
                                            \"permissiveness_level\": \"LOW\",
                                            \"violations\": \"\",
                                            \"last_hit\": \"No hits\",
                                            \"shadowed_status\": \"FALSE\",
                                            \"ticket_ids\": \"\",
                                            \"business_owners\": \"\",
                                            \"expirations\": \"\",
                                            \"applications\": \"\",
                                            \"last_modified\": \"Today\"
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                \"rule_modifications\": {
                    \"rule_modification\": {
                        \"@xsi.type\": \"modify_rule_modification\",
                        \"id\": 13,
                        \"rule_key\": {
                            \"device_id\": 4,
                            \"binding_uid\": \"{00-FACED0-00}\",
                            \"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"
                        },
                        \"source_modifications\": {
                            \"id\": 26,
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"id\": 89,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 88,
                                            \"uid\": \"e7e4ac52-2fe4-49f7-8071-9638817a7434\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"id\": 88,
                                                    \"name\": \"My New Host\",
                                                    \"comment\": \"some comment\",
                                                    \"ip\": \"192.168.0.10\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 91,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 89,
                                            \"uid\": \"13556e3e-1f93-4f95-939c-428a58001615\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                    \"id\": 89,
                                                    \"name\": \"My New Address Ragne\",
                                                    \"comment\": \"some comment\",
                                                    \"min_ip\": \"192.168.0.1\",
                                                    \"max_ip\": \"192.168.0.254\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 90,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 87,
                                            \"uid\": \"1ecb9679-4da4-4fc5-9382-00f5fa455295\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                    \"id\": 87,
                                                    \"name\": \"My New Network\",
                                                    \"comment\": \"some comment\",
                                                    \"ip\": \"192.168.0.0\",
                                                    \"netmask\": \"255.255.255.0\"
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        },
                        \"destination_modifications\": {
                            \"id\": 25,
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"id\": 88,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 91,
                                            \"uid\": \"50f35caf-3f13-4961-9ccd-055e1703592a\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"id\": 91,
                                                    \"name\": \"Host_10.10.10.10\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"10.10.10.10\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 85,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 90,
                                            \"uid\": \"21342c9a-3974-4bd3-b74b-b142e43ed39a\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                    \"id\": 90,
                                                    \"name\": \"Range-Test\",
                                                    \"comment\": \"\",
                                                    \"min_ip\": \"1.1.2.0\",
                                                    \"max_ip\": \"1.1.2.55\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 86,
                                        \"action\": \"REMOVE\",
                                        \"device_network_object\": {
                                            \"id\": 86,
                                            \"uid\": \"8fff4c36-da34-4945-be33-ffd5d4d444e2\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"id\": 86,
                                                    \"name\": \"22.22.2.2\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"22.22.2.2\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 87,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 85,
                                            \"uid\": \"35ec73ed-e0fa-4690-9570-00b417b63ae6\",
                                            \"device_id\": 2,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                    \"id\": 85,
                                                    \"name\": \"Net_10.108.151.0\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"10.108.151.0\",
                                                    \"netmask\": \"255.255.255.0\"
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        }
                    }
                },
                \"designer_result\": {
                    \"status\": \"not run\"
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Task status does not exist.
400: Task status is not set to ASSIGNED or DONE.
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: The new network object (<name>): device ID (<id>) does not match the rule key device ID (<id>). The device IDs must be the same.
400: Device ID is required for a new device network object
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <name>
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <st_uid>
400: <cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty.
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
403: Task can not be done because there are unlicensed devices for change automation
400: Invalid value for field: <FIELD_NAME> (Device ID is required for an existing device network object)
400: Invalid value for field: <FIELD_NAME> (ST UID is required for an existing device network object
400: Invalid value for field: <FIELD_NAME> (Network Object with device ID <DEVICE_ID> and ST UID <ST_UID> is not available for the action specified. Check the Knowledge Center or API Implementation Notes for more information
400: Status is required for a device network object"},"response":[]},{"name":"Returns the details of a specified field","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
taskId: The ID number of the task as shown in SecureChange
fieldId: The ID number of the field as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/229

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.
404: Task with ID was not found in Stage ID in ticket ID .
404: Field ID was not found in Task ID in Stage ID in ticket ID ."},"response":[]},{"name":"Change a field within a task of a ticket","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\t\"rule_modification_field\": {\n\t\t\"id\": 71,\n\t\t\"name\": \"Fire Wall Rule\",\n\t\t\"devices\": {\n\t\t\t\"device\": {\n\t\t\t\t\"revision_id\": 4,\n\t\t\t\t\"management_name\": \"Panorama/DG_1\",\n\t\t\t\t\"management_id\": 4,\n\t\t\t\t\"management_ip\": \"10.100.111.120\",\n\t\t\t\t\"revision_number\": 1,\n\t\t\t\t\"number_of_rules\": 1,\n\t\t\t\t\"bindings\": {\n\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\"policy_name\": \"Standard\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",\n\t\t\t\t\t\t\t\t\"name\": \"Application test\",\n\t\t\t\t\t\t\t\t\"is_disabled\": false,\n\t\t\t\t\t\t\t\t\"ruleNumber\": 13,\n\t\t\t\t\t\t\t\t\"from_zone\": \"any\",\n\t\t\t\t\t\t\t\t\"to_zone\": \"any\",\n\t\t\t\t\t\t\t\t\"sourceNetworks\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\"display_name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\"comment\": \"comment\",\n\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a01a\",\n\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\"ip\": \"5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"destinationNetworks\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\"display_name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a016\",\n\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"destinationServices\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\"display_name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\"comment\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a018\",\n\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\"min_port\": 82,\n\t\t\t\t\t\t\t\t\t\"max_port\": 82\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"applications\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"single_application\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\"display_name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\"class_name\": \"application_object\",\n\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE_PREDEFINED\",\n\t\t\t\t\t\t\t\t\t\"global\": true,\n\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\"service\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": true,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a014\",\n\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\t\"min_port\": 80,\n\t\t\t\t\t\t\t\t\t\t\t\"max_port\": 80\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"action\": \"ACCEPT\",\n\t\t\t\t\t\t\t\t\"additional_parameters\": \"\",\n\t\t\t\t\t\t\t\t\"options\": {\n\t\t\t\t\t\t\t\t\t\"option\": \"LOG_SESSION\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"rule_location\": \"DG_1\",\n\t\t\t\t\t\t\t\t\"users\": {\n\t\t\t\t\t\t\t\t\t\"user\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Any\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"any_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"displayName\": \"Any\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"track\": {\n\t\t\t\t\t\t\t\t\t\"track_level\": \"LOG\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"install_ons\": \"\",\n\t\t\t\t\t\t\t\t\"communities\": \"\",\n\t\t\t\t\t\t\t\t\"times\": \"\",\n\t\t\t\t\t\t\t\t\"rule_metadata\": {\n\t\t\t\t\t\t\t\t\t\"permissiveness_level\": \"LOW\",\n\t\t\t\t\t\t\t\t\t\"violations\": \"\",\n\t\t\t\t\t\t\t\t\t\"last_hit\": \"No hits\",\n\t\t\t\t\t\t\t\t\t\"shadowed_status\": \"FALSE\",\n\t\t\t\t\t\t\t\t\t\"ticket_ids\": \"\",\n\t\t\t\t\t\t\t\t\t\"business_owners\": \"\",\n\t\t\t\t\t\t\t\t\t\"expirations\": \"\",\n\t\t\t\t\t\t\t\t\t\"applications\": \"\",\n\t\t\t\t\t\t\t\t\t\"last_modified\": \"Today\"\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t\"rule_modifications\": {\n\t\t\t\"rule_modification\": {\n\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\"id\": 12,\n\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"\n\t\t\t\t},\n\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\"id\": 24,\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 84,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 81,\n\t\t\t\t\t\t\t\t\t\"uid\": \"cd555580-3dd2-4830-86c6-260f9783569c\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 81,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Address Ragne\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"192.168.0.1\",\n\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"192.168.0.254\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 83,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 80,\n\t\t\t\t\t\t\t\t\t\"uid\": \"fb534919-e43f-42c9-a7e3-cb00f6b9aaac\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 80,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Network\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.0\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 82,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 79,\n\t\t\t\t\t\t\t\t\t\"uid\": \"b76a4265-dc2d-43c7-a3f2-dfe434f6a034\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 79,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Host\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.10\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\"id\": 23,\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 80,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 82,\n\t\t\t\t\t\t\t\t\t\"uid\": \"314933de-5b19-4d70-8712-576a0919285e\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 2,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 82,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Net_10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 81,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 78,\n\t\t\t\t\t\t\t\t\t\"uid\": \"de5a9ef7-a1f0-463c-bf64-9acacbfdb119\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 78,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host_10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 79,\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 83,\n\t\t\t\t\t\t\t\t\t\"uid\": \"822004d2-05bc-492b-96d5-6180b998fbc5\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 83,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 78,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 84,\n\t\t\t\t\t\t\t\t\t\"uid\": \"714dd5f3-976d-4880-b3cb-e45382ddb8ae\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 84,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Range-Test\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"1.1.2.0\",\n\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"1.1.2.55\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t\"designer_result\": {\n\t\t\t\"status\": \"not run\"\n\t\t}\n\t}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both object_UID and object_name are defined, object_UID takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldDTO
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/2/tasks/4/fields/7742
BODY<field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multiple_selection\">
     <id>7742</id>
     <name>filter type</name>
     <selected_options>
         <selected_option>
             <value>FTP</value>
         </selected_option>
     </selected_options>
</field>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/fields/71
BODY{
    \"rule_modification_field\": {
        \"id\": 71,
        \"name\": \"Fire Wall Rule\",
        \"devices\": {
            \"device\": {
                \"revision_id\": 4,
                \"management_name\": \"Panorama/DG_1\",
                \"management_id\": 4,
                \"management_ip\": \"10.100.111.120\",
                \"revision_number\": 1,
                \"number_of_rules\": 1,
                \"bindings\": {
                    \"binding\": {
                        \"binding_uid\": \"{00-FACED0-00}\",
                        \"binding\": {
                            \"@xsi.type\": \"policy__binding\",
                            \"policy_name\": \"Standard\"
                        },
                        \"rules\": {
                            \"rule\": {
                                \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                \"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",
                                \"name\": \"Application test\",
                                \"is_disabled\": false,
                                \"ruleNumber\": 13,
                                \"from_zone\": \"any\",
                                \"to_zone\": \"any\",
                                \"sourceNetworks\": {
                                    \"@xsi.type\": \"host_network_object\",
                                    \"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",
                                    \"name\": \"H_5.3.2.5\",
                                    \"display_name\": \"H_5.3.2.5\",
                                    \"class_name\": \"host_plain\",
                                    \"origin\": \"DEVICE\",
                                    \"global\": false,
                                    \"implicit\": false,
                                    \"shared\": false,
                                    \"comment\": \"comment\",
                                    \"id\": \"5df1f2a5e9023c311ae4a01a\",
                                    \"version_id\": 4,
                                    \"device_type\": \"PaloAltoNetworks\",
                                    \"ip_type\": \"IPV4\",
                                    \"referenced\": \"UNKNOWN\",
                                    \"installable_target\": false,
                                    \"ip\": \"5.3.2.5\",
                                    \"subnet_mask\": \"255.255.255.255\"
                                },
                                \"destinationNetworks\": {
                                    \"@xsi.type\": \"host_network_object\",
                                    \"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",
                                    \"name\": \"22.22.2.2\",
                                    \"display_name\": \"22.22.2.2\",
                                    \"class_name\": \"host_plain\",
                                    \"origin\": \"DEVICE\",
                                    \"global\": false,
                                    \"implicit\": false,
                                    \"shared\": false,
                                    \"comment\": \"\",
                                    \"id\": \"5df1f2a5e9023c311ae4a016\",
                                    \"version_id\": 4,
                                    \"device_type\": \"PaloAltoNetworks\",
                                    \"ip_type\": \"IPV4\",
                                    \"referenced\": \"UNKNOWN\",
                                    \"installable_target\": false,
                                    \"ip\": \"22.22.2.2\",
                                    \"subnet_mask\": \"255.255.255.255\"
                                },
                                \"destinationServices\": {
                                    \"@xsi.type\": \"transport_service\",
                                    \"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",
                                    \"name\": \"TCP82\",
                                    \"display_name\": \"TCP82\",
                                    \"class_name\": \"tcp_service\",
                                    \"origin\": \"DEVICE\",
                                    \"global\": false,
                                    \"implicit\": false,
                                    \"shared\": false,
                                    \"comment\": \"TCP82\",
                                    \"id\": \"5df1f2a5e9023c311ae4a018\",
                                    \"version_id\": 4,
                                    \"referenced\": \"UNKNOWN\",
                                    \"type_on_device\": \"\",
                                    \"negate\": false,
                                    \"match_for_any\": false,
                                    \"timeout\": 0,
                                    \"protocol\": 6,
                                    \"min_port\": 82,
                                    \"max_port\": 82
                                },
                                \"applications\": {
                                    \"@xsi.type\": \"single_application\",
                                    \"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",
                                    \"name\": \"web-browsing\",
                                    \"display_name\": \"web-browsing\",
                                    \"class_name\": \"application_object\",
                                    \"origin\": \"DEVICE_PREDEFINED\",
                                    \"global\": true,
                                    \"implicit\": false,
                                    \"shared\": false,
                                    \"comment\": \"\",
                                    \"service\": [
                                        {
                                            \"@xsi.type\": \"transport_service\",
                                            \"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",
                                            \"name\": \"st_implicit_app_web-browsing\",
                                            \"display_name\": \"st_implicit_app_web-browsing\",
                                            \"class_name\": \"tcp_service\",
                                            \"origin\": \"DEVICE\",
                                            \"global\": false,
                                            \"implicit\": true,
                                            \"shared\": false,
                                            \"comment\": \"\",
                                            \"id\": \"5df1f2a5e9023c311ae4a014\",
                                            \"version_id\": 4,
                                            \"referenced\": \"UNKNOWN\",
                                            \"type_on_device\": \"\",
                                            \"negate\": false,
                                            \"match_for_any\": false,
                                            \"timeout\": 0,
                                            \"protocol\": 6,
                                            \"min_port\": 80,
                                            \"max_port\": 80
                                        }
                                    ]
                                },
                                \"action\": \"ACCEPT\",
                                \"additional_parameters\": \"\",
                                \"options\": {
                                    \"option\": \"LOG_SESSION\"
                                },
                                \"rule_location\": \"DG_1\",
                                \"users\": {
                                    \"user\": [
                                        {
                                            \"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",
                                            \"name\": \"Any\",
                                            \"class_name\": \"any_object\",
                                            \"displayName\": \"Any\"
                                        }
                                    ]
                                },
                                \"track\": {
                                    \"track_level\": \"LOG\"
                                },
                                \"install_ons\": \"\",
                                \"communities\": \"\",
                                \"times\": \"\",
                                \"rule_metadata\": {
                                    \"permissiveness_level\": \"LOW\",
                                    \"violations\": \"\",
                                    \"last_hit\": \"No hits\",
                                    \"shadowed_status\": \"FALSE\",
                                    \"ticket_ids\": \"\",
                                    \"business_owners\": \"\",
                                    \"expirations\": \"\",
                                    \"applications\": \"\",
                                    \"last_modified\": \"Today\"
                                }
                            }
                        }
                    }
                }
            }
        },
        \"rule_modifications\": {
            \"rule_modification\": {
                \"@xsi.type\": \"modify_rule_modification\",
                \"id\": 12,
                \"rule_key\": {
                    \"device_id\": 4,
                    \"binding_uid\": \"{00-FACED0-00}\",
                    \"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"
                },
                \"source_modifications\": {
                    \"id\": 24,
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"id\": 84,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 81,
                                    \"uid\": \"cd555580-3dd2-4830-86c6-260f9783569c\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                            \"id\": 81,
                                            \"name\": \"My New Address Ragne\",
                                            \"comment\": \"some comment\",
                                            \"min_ip\": \"192.168.0.1\",
                                            \"max_ip\": \"192.168.0.254\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 83,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 80,
                                    \"uid\": \"fb534919-e43f-42c9-a7e3-cb00f6b9aaac\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                            \"id\": 80,
                                            \"name\": \"My New Network\",
                                            \"comment\": \"some comment\",
                                            \"ip\": \"192.168.0.0\",
                                            \"netmask\": \"255.255.255.0\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 82,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 79,
                                    \"uid\": \"b76a4265-dc2d-43c7-a3f2-dfe434f6a034\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"id\": 79,
                                            \"name\": \"My New Host\",
                                            \"comment\": \"some comment\",
                                            \"ip\": \"192.168.0.10\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                \"destination_modifications\": {
                    \"id\": 23,
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"id\": 80,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 82,
                                    \"uid\": \"314933de-5b19-4d70-8712-576a0919285e\",
                                    \"device_id\": 2,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                            \"id\": 82,
                                            \"name\": \"Net_10.108.151.0\",
                                            \"comment\": \"\",
                                            \"ip\": \"10.108.151.0\",
                                            \"netmask\": \"255.255.255.0\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 81,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 78,
                                    \"uid\": \"de5a9ef7-a1f0-463c-bf64-9acacbfdb119\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"id\": 78,
                                            \"name\": \"Host_10.10.10.10\",
                                            \"comment\": \"\",
                                            \"ip\": \"10.10.10.10\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 79,
                                \"action\": \"REMOVE\",
                                \"device_network_object\": {
                                    \"id\": 83,
                                    \"uid\": \"822004d2-05bc-492b-96d5-6180b998fbc5\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"id\": 83,
                                            \"name\": \"22.22.2.2\",
                                            \"comment\": \"\",
                                            \"ip\": \"22.22.2.2\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 78,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 84,
                                    \"uid\": \"714dd5f3-976d-4880-b3cb-e45382ddb8ae\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                            \"id\": 84,
                                            \"name\": \"Range-Test\",
                                            \"comment\": \"\",
                                            \"min_ip\": \"1.1.2.0\",
                                            \"max_ip\": \"1.1.2.55\"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            }
        },
        \"designer_result\": {
            \"status\": \"not run\"
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket step does not exist, or is not the current step
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: Deleting rule recertification info is not allowed
400: Application Change field cannot be managed via this REST API
400: Rule associated with successfully updated recertification info cannot be removed
400: Rule was already updated
400: Rule does not exist
400: The new network object (<name>): device ID (<id>) does not match the rule key device ID (<id>). The device IDs must be the same.
400: Device ID is required for a new device network object
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <name>
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <st_uid>
400: <cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty.
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (Device ID is required for an existing device network object)
400: Invalid value for field: <FIELD_NAME> (ST UID is required for an existing device network object
400: Invalid value for field: <FIELD_NAME> (Network Object with device ID <DEVICE_ID> and ST UID <ST_UID> is not available for the action specified. Check the Knowledge Center or API Implementation Notes for more information
400: Status is required for a device network object"},"response":[]},{"name":"Get rule decommision verifier results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/rule_decommission/verifier","description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/rule_decommission/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type <TYPE>.
404: Verifier results were not found in the request."},"response":[]},{"name":"Get designer results according to field id","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/designer","description":"Use this API to retrieve designer results generated in R17-2 and later.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/designer

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: Specified field, id: <ID> , name: <NAME>, cannot contain designer result
404: Designer results were not found in the request."},"response":[]},{"name":"Returns the results of the Commit action","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"},{"value":null,"type":"text","key":"managementId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/designer/commit_report/{{managementId}}","description":"GENERAL USE
The report returns the Commit results for the device with the specified management ID and for the devices suggested in the Designer results. The report also includes results for devices that are in the related hierarchy of these devices.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID
managementId: Management ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/designer/commit_report/3
OUTPUT{
    \"commit_report\": {
        \"ticketId\": 27,
        \"statTime\": \"24-Oct-2018 08:55 AM\",
        \"endTime\": \"24-Oct-2018 08:56 AM\",
        \"duration\": \"00:00:30\",
        \"vendorName\": \"PALO ALTO NETWORKS\",
        \"managmentName\": \"pano211\",
        \"devices\": {
            \"device\": [
                {
                    \"name\": \"DG1.1\",
                    \"status\": \"success_with_warnings\",
                    \"warnings\": {
                        \"warning\": \"Commit not performed: This device had no policies to install on its managed firewalls\"
                    },
                    \"policies\": \"\"
                },
                {
                    \"name\": \"DG1\",
                    \"status\": \"success_with_warnings\",
                    \"warnings\": {
                        \"warning\": \"Commit not performed: This device had no policies to install on its managed firewalls\"
                    },
                    \"policies\": \"\"
                }
            ]
        }
    }
}


Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: Specified field, id: <ID> , name: <NAME>, cannot contain designer result
404: Designer results were not found in the request."},"response":[]},{"name":"Returns the details of a specified ticket stages","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found"},"response":[]},{"name":"Change a field within a task of a ticket at the current step","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\t\"rule_modification_field\": {\n\t\t\"id\": 71,\n\t\t\"name\": \"Fire Wall Rule\",\n\t\t\"devices\": {\n\t\t\t\"device\": {\n\t\t\t\t\"revision_id\": 4,\n\t\t\t\t\"management_name\": \"Panorama/DG_1\",\n\t\t\t\t\"management_id\": 4,\n\t\t\t\t\"management_ip\": \"10.100.111.120\",\n\t\t\t\t\"revision_number\": 1,\n\t\t\t\t\"number_of_rules\": 1,\n\t\t\t\t\"bindings\": {\n\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\"policy_name\": \"Standard\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",\n\t\t\t\t\t\t\t\t\"name\": \"Application test\",\n\t\t\t\t\t\t\t\t\"is_disabled\": false,\n\t\t\t\t\t\t\t\t\"ruleNumber\": 13,\n\t\t\t\t\t\t\t\t\"from_zone\": \"any\",\n\t\t\t\t\t\t\t\t\"to_zone\": \"any\",\n\t\t\t\t\t\t\t\t\"sourceNetworks\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\"display_name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\"comment\": \"comment\",\n\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a01a\",\n\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\"ip\": \"5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"destinationNetworks\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\"display_name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a016\",\n\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"destinationServices\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\"display_name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\"comment\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a018\",\n\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\"min_port\": 82,\n\t\t\t\t\t\t\t\t\t\"max_port\": 82\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"applications\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"single_application\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\"display_name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\"class_name\": \"application_object\",\n\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE_PREDEFINED\",\n\t\t\t\t\t\t\t\t\t\"global\": true,\n\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\"service\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": true,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a014\",\n\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\t\"min_port\": 80,\n\t\t\t\t\t\t\t\t\t\t\t\"max_port\": 80\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"action\": \"ACCEPT\",\n\t\t\t\t\t\t\t\t\"additional_parameters\": \"\",\n\t\t\t\t\t\t\t\t\"options\": {\n\t\t\t\t\t\t\t\t\t\"option\": \"LOG_SESSION\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"rule_location\": \"DG_1\",\n\t\t\t\t\t\t\t\t\"users\": {\n\t\t\t\t\t\t\t\t\t\"user\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Any\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"any_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"displayName\": \"Any\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"track\": {\n\t\t\t\t\t\t\t\t\t\"track_level\": \"LOG\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"install_ons\": \"\",\n\t\t\t\t\t\t\t\t\"communities\": \"\",\n\t\t\t\t\t\t\t\t\"times\": \"\",\n\t\t\t\t\t\t\t\t\"rule_metadata\": {\n\t\t\t\t\t\t\t\t\t\"permissiveness_level\": \"LOW\",\n\t\t\t\t\t\t\t\t\t\"violations\": \"\",\n\t\t\t\t\t\t\t\t\t\"last_hit\": \"No hits\",\n\t\t\t\t\t\t\t\t\t\"shadowed_status\": \"FALSE\",\n\t\t\t\t\t\t\t\t\t\"ticket_ids\": \"\",\n\t\t\t\t\t\t\t\t\t\"business_owners\": \"\",\n\t\t\t\t\t\t\t\t\t\"expirations\": \"\",\n\t\t\t\t\t\t\t\t\t\"applications\": \"\",\n\t\t\t\t\t\t\t\t\t\"last_modified\": \"Today\"\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t\"rule_modifications\": {\n\t\t\t\"rule_modification\": {\n\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\"id\": 12,\n\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"\n\t\t\t\t},\n\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\"id\": 24,\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 84,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 81,\n\t\t\t\t\t\t\t\t\t\"uid\": \"cd555580-3dd2-4830-86c6-260f9783569c\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 81,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Address Ragne\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"192.168.0.1\",\n\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"192.168.0.254\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 83,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 80,\n\t\t\t\t\t\t\t\t\t\"uid\": \"fb534919-e43f-42c9-a7e3-cb00f6b9aaac\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 80,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Network\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.0\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 82,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 79,\n\t\t\t\t\t\t\t\t\t\"uid\": \"b76a4265-dc2d-43c7-a3f2-dfe434f6a034\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 79,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Host\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.10\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\"id\": 23,\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 80,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 82,\n\t\t\t\t\t\t\t\t\t\"uid\": \"314933de-5b19-4d70-8712-576a0919285e\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 2,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 82,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Net_10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 81,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 78,\n\t\t\t\t\t\t\t\t\t\"uid\": \"de5a9ef7-a1f0-463c-bf64-9acacbfdb119\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 78,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host_10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 79,\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 83,\n\t\t\t\t\t\t\t\t\t\"uid\": \"822004d2-05bc-492b-96d5-6180b998fbc5\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 83,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"id\": 78,\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"id\": 84,\n\t\t\t\t\t\t\t\t\t\"uid\": \"714dd5f3-976d-4880-b3cb-e45382ddb8ae\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 84,\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Range-Test\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"1.1.2.0\",\n\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"1.1.2.55\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t\"designer_result\": {\n\t\t\t\"status\": \"not run\"\n\t\t}\n\t}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/fields/{{fieldId}}","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both object_UID and object_name are defined, object_UID takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldDTO
id: Ticket ID
taskId: Task ID
fieldId: Field ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields/7642
BODY<field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"approve_reject\">
         <id>7661</id>
         <name>approve access</name>
         <approved>true</approved>
         <reason>Request approved</reason>
    </field>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields/71
BODY{
    \"rule_modification_field\": {
        \"id\": 71,
        \"name\": \"Fire Wall Rule\",
        \"devices\": {
            \"device\": {
                \"revision_id\": 4,
                \"management_name\": \"Panorama/DG_1\",
                \"management_id\": 4,
                \"management_ip\": \"10.100.111.120\",
                \"revision_number\": 1,
                \"number_of_rules\": 1,
                \"bindings\": {
                    \"binding\": {
                        \"binding_uid\": \"{00-FACED0-00}\",
                        \"binding\": {
                            \"@xsi.type\": \"policy__binding\",
                            \"policy_name\": \"Standard\"
                        },
                        \"rules\": {
                            \"rule\": {
                                \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                \"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",
                                \"name\": \"Application test\",
                                \"is_disabled\": false,
                                \"ruleNumber\": 13,
                                \"from_zone\": \"any\",
                                \"to_zone\": \"any\",
                                \"sourceNetworks\": {
                                    \"@xsi.type\": \"host_network_object\",
                                    \"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",
                                    \"name\": \"H_5.3.2.5\",
                                    \"display_name\": \"H_5.3.2.5\",
                                    \"class_name\": \"host_plain\",
                                    \"origin\": \"DEVICE\",
                                    \"global\": false,
                                    \"implicit\": false,
                                    \"shared\": false,
                                    \"comment\": \"comment\",
                                    \"id\": \"5df1f2a5e9023c311ae4a01a\",
                                    \"version_id\": 4,
                                    \"device_type\": \"PaloAltoNetworks\",
                                    \"ip_type\": \"IPV4\",
                                    \"referenced\": \"UNKNOWN\",
                                    \"installable_target\": false,
                                    \"ip\": \"5.3.2.5\",
                                    \"subnet_mask\": \"255.255.255.255\"
                                },
                                \"destinationNetworks\": {
                                    \"@xsi.type\": \"host_network_object\",
                                    \"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",
                                    \"name\": \"22.22.2.2\",
                                    \"display_name\": \"22.22.2.2\",
                                    \"class_name\": \"host_plain\",
                                    \"origin\": \"DEVICE\",
                                    \"global\": false,
                                    \"implicit\": false,
                                    \"shared\": false,
                                    \"comment\": \"\",
                                    \"id\": \"5df1f2a5e9023c311ae4a016\",
                                    \"version_id\": 4,
                                    \"device_type\": \"PaloAltoNetworks\",
                                    \"ip_type\": \"IPV4\",
                                    \"referenced\": \"UNKNOWN\",
                                    \"installable_target\": false,
                                    \"ip\": \"22.22.2.2\",
                                    \"subnet_mask\": \"255.255.255.255\"
                                },
                                \"destinationServices\": {
                                    \"@xsi.type\": \"transport_service\",
                                    \"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",
                                    \"name\": \"TCP82\",
                                    \"display_name\": \"TCP82\",
                                    \"class_name\": \"tcp_service\",
                                    \"origin\": \"DEVICE\",
                                    \"global\": false,
                                    \"implicit\": false,
                                    \"shared\": false,
                                    \"comment\": \"TCP82\",
                                    \"id\": \"5df1f2a5e9023c311ae4a018\",
                                    \"version_id\": 4,
                                    \"referenced\": \"UNKNOWN\",
                                    \"type_on_device\": \"\",
                                    \"negate\": false,
                                    \"match_for_any\": false,
                                    \"timeout\": 0,
                                    \"protocol\": 6,
                                    \"min_port\": 82,
                                    \"max_port\": 82
                                },
                                \"applications\": {
                                    \"@xsi.type\": \"single_application\",
                                    \"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",
                                    \"name\": \"web-browsing\",
                                    \"display_name\": \"web-browsing\",
                                    \"class_name\": \"application_object\",
                                    \"origin\": \"DEVICE_PREDEFINED\",
                                    \"global\": true,
                                    \"implicit\": false,
                                    \"shared\": false,
                                    \"comment\": \"\",
                                    \"service\": [
                                        {
                                            \"@xsi.type\": \"transport_service\",
                                            \"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",
                                            \"name\": \"st_implicit_app_web-browsing\",
                                            \"display_name\": \"st_implicit_app_web-browsing\",
                                            \"class_name\": \"tcp_service\",
                                            \"origin\": \"DEVICE\",
                                            \"global\": false,
                                            \"implicit\": true,
                                            \"shared\": false,
                                            \"comment\": \"\",
                                            \"id\": \"5df1f2a5e9023c311ae4a014\",
                                            \"version_id\": 4,
                                            \"referenced\": \"UNKNOWN\",
                                            \"type_on_device\": \"\",
                                            \"negate\": false,
                                            \"match_for_any\": false,
                                            \"timeout\": 0,
                                            \"protocol\": 6,
                                            \"min_port\": 80,
                                            \"max_port\": 80
                                        }
                                    ]
                                },
                                \"action\": \"ACCEPT\",
                                \"additional_parameters\": \"\",
                                \"options\": {
                                    \"option\": \"LOG_SESSION\"
                                },
                                \"rule_location\": \"DG_1\",
                                \"users\": {
                                    \"user\": [
                                        {
                                            \"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",
                                            \"name\": \"Any\",
                                            \"class_name\": \"any_object\",
                                            \"displayName\": \"Any\"
                                        }
                                    ]
                                },
                                \"track\": {
                                    \"track_level\": \"LOG\"
                                },
                                \"install_ons\": \"\",
                                \"communities\": \"\",
                                \"times\": \"\",
                                \"rule_metadata\": {
                                    \"permissiveness_level\": \"LOW\",
                                    \"violations\": \"\",
                                    \"last_hit\": \"No hits\",
                                    \"shadowed_status\": \"FALSE\",
                                    \"ticket_ids\": \"\",
                                    \"business_owners\": \"\",
                                    \"expirations\": \"\",
                                    \"applications\": \"\",
                                    \"last_modified\": \"Today\"
                                }
                            }
                        }
                    }
                }
            }
        },
        \"rule_modifications\": {
            \"rule_modification\": {
                \"@xsi.type\": \"modify_rule_modification\",
                \"id\": 12,
                \"rule_key\": {
                    \"device_id\": 4,
                    \"binding_uid\": \"{00-FACED0-00}\",
                    \"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"
                },
                \"source_modifications\": {
                    \"id\": 24,
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"id\": 84,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 81,
                                    \"uid\": \"cd555580-3dd2-4830-86c6-260f9783569c\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                            \"id\": 81,
                                            \"name\": \"My New Address Ragne\",
                                            \"comment\": \"some comment\",
                                            \"min_ip\": \"192.168.0.1\",
                                            \"max_ip\": \"192.168.0.254\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 83,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 80,
                                    \"uid\": \"fb534919-e43f-42c9-a7e3-cb00f6b9aaac\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                            \"id\": 80,
                                            \"name\": \"My New Network\",
                                            \"comment\": \"some comment\",
                                            \"ip\": \"192.168.0.0\",
                                            \"netmask\": \"255.255.255.0\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 82,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 79,
                                    \"uid\": \"b76a4265-dc2d-43c7-a3f2-dfe434f6a034\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"id\": 79,
                                            \"name\": \"My New Host\",
                                            \"comment\": \"some comment\",
                                            \"ip\": \"192.168.0.10\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                \"destination_modifications\": {
                    \"id\": 23,
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"id\": 80,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 82,
                                    \"uid\": \"314933de-5b19-4d70-8712-576a0919285e\",
                                    \"device_id\": 2,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                            \"id\": 82,
                                            \"name\": \"Net_10.108.151.0\",
                                            \"comment\": \"\",
                                            \"ip\": \"10.108.151.0\",
                                            \"netmask\": \"255.255.255.0\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 81,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 78,
                                    \"uid\": \"de5a9ef7-a1f0-463c-bf64-9acacbfdb119\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"id\": 78,
                                            \"name\": \"Host_10.10.10.10\",
                                            \"comment\": \"\",
                                            \"ip\": \"10.10.10.10\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 79,
                                \"action\": \"REMOVE\",
                                \"device_network_object\": {
                                    \"id\": 83,
                                    \"uid\": \"822004d2-05bc-492b-96d5-6180b998fbc5\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"id\": 83,
                                            \"name\": \"22.22.2.2\",
                                            \"comment\": \"\",
                                            \"ip\": \"22.22.2.2\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"id\": 78,
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"id\": 84,
                                    \"uid\": \"714dd5f3-976d-4880-b3cb-e45382ddb8ae\",
                                    \"device_id\": 4,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                            \"id\": 84,
                                            \"name\": \"Range-Test\",
                                            \"comment\": \"\",
                                            \"min_ip\": \"1.1.2.0\",
                                            \"max_ip\": \"1.1.2.55\"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            }
        },
        \"designer_result\": {
            \"status\": \"not run\"
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: The new network object (<name>): device ID (<id>) does not match the rule key device ID (<id>). The device IDs must be the same.
400: Device ID is required for a new device network object
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <name>
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <st_uid>
400: <cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty.
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (Device ID is required for an existing device network object)
400: Invalid value for field: <FIELD_NAME> (ST UID is required for an existing device network object
400: Invalid value for field: <FIELD_NAME> (Network Object with device ID <DEVICE_ID> and ST UID <ST_UID> is not available for the action specified. Check the Knowledge Center or API Implementation Notes for more information
400: Status is required for a device network object"},"response":[]},{"name":"Change multiple field within a task of a ticket in the current step","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\t\"fields\": {\n\t\t\"field\": {\n\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\"id\": 71,\n\t\t\t\"name\": \"Fire Wall Rule\",\n\t\t\t\"read_only\": false,\n\t\t\t\"devices\": {\n\t\t\t\t\"device\": {\n\t\t\t\t\t\"revision_id\": 4,\n\t\t\t\t\t\"management_name\": \"Panorama/DG_1\",\n\t\t\t\t\t\"management_id\": 4,\n\t\t\t\t\t\"management_ip\": \"10.100.111.120\",\n\t\t\t\t\t\"revision_number\": 1,\n\t\t\t\t\t\"number_of_rules\": 1,\n\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\"policy_name\": \"Standard\"\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",\n\t\t\t\t\t\t\t\t\t\"name\": \"Application test\",\n\t\t\t\t\t\t\t\t\t\"is_disabled\": false,\n\t\t\t\t\t\t\t\t\t\"ruleNumber\": 13,\n\t\t\t\t\t\t\t\t\t\"from_zone\": \"any\",\n\t\t\t\t\t\t\t\t\t\"to_zone\": \"any\",\n\t\t\t\t\t\t\t\t\t\"sourceNetworks\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\"display_name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"comment\",\n\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a01a\",\n\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\t\"ip\": \"5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"destinationNetworks\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\"display_name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a016\",\n\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"destinationServices\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\"display_name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a018\",\n\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\"min_port\": 82,\n\t\t\t\t\t\t\t\t\t\t\"max_port\": 82\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"applications\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"single_application\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\"display_name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\"class_name\": \"application_object\",\n\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE_PREDEFINED\",\n\t\t\t\t\t\t\t\t\t\t\"global\": true,\n\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"service\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\"implicit\": true,\n\t\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a014\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\t\t\"min_port\": 80,\n\t\t\t\t\t\t\t\t\t\t\t\t\"max_port\": 80\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"action\": \"ACCEPT\",\n\t\t\t\t\t\t\t\t\t\"additional_parameters\": \"\",\n\t\t\t\t\t\t\t\t\t\"options\": {\n\t\t\t\t\t\t\t\t\t\t\"option\": \"LOG_SESSION\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"rule_location\": \"DG_1\",\n\t\t\t\t\t\t\t\t\t\"users\": {\n\t\t\t\t\t\t\t\t\t\t\"user\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Any\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"any_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"displayName\": \"Any\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"track\": {\n\t\t\t\t\t\t\t\t\t\t\"track_level\": \"LOG\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"install_ons\": \"\",\n\t\t\t\t\t\t\t\t\t\"communities\": \"\",\n\t\t\t\t\t\t\t\t\t\"times\": \"\",\n\t\t\t\t\t\t\t\t\t\"rule_metadata\": {\n\t\t\t\t\t\t\t\t\t\t\"permissiveness_level\": \"LOW\",\n\t\t\t\t\t\t\t\t\t\t\"violations\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"last_hit\": \"No hits\",\n\t\t\t\t\t\t\t\t\t\t\"shadowed_status\": \"FALSE\",\n\t\t\t\t\t\t\t\t\t\t\"ticket_ids\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"business_owners\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"expirations\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"applications\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"last_modified\": \"Today\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"rule_modifications\": {\n\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\"id\": 10,\n\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"\n\t\t\t\t\t},\n\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\"id\": 20,\n\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 69,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 65,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"9b9062a0-228a-4543-bbd4-9fda5c76573b\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 65,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Host\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 68,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 64,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"986c68ab-b5b5-478d-9300-bc0cacc06dfe\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 64,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Address Ragne\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"192.168.0.1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"192.168.0.254\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 70,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 68,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"1073dad5-4dc9-4392-8b42-f32de2937657\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 68,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Network\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t]\n\t\t\t\t\t\t}\n\t\t\t\t\t},\n\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\"id\": 19,\n\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 66,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 67,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"e52c07fc-dffb-4c77-a656-40d1b1322e77\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 67,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Range-Test\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"1.1.2.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"1.1.2.55\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 67,\n\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 66,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"fa681c9b-8c4f-449d-9b31-108a399902f5\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 66,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 65,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 70,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"2b8eaa1a-f4ea-4c39-b89e-361af89a308e\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 2,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 70,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Net_10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\"id\": 64,\n\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\"id\": 69,\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"88efeaad-cfb4-41c4-b14c-fff104c24e52\",\n\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 69,\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host_10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t]\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t\t\"designer_result\": {\n\t\t\t\t\"status\": \"not run\"\n\t\t\t}\n\t\t}\n\t}\n}}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/fields","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both object_UID and object_name are defined, object_UID takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldListDTO
id: Ticket ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields
BODY<fields>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_server_decommission_request\">
         <id>7591</id>
         <name>sd</name>
         <server_decommission_request>
             <id>7596</id>
             <order>DR1</order>
             <servers>
                 <server type=\"IP\">
                     <id>7593</id>
                     <ip_address>2.2.2.2</ip_address>
                     <netmask>255.255.255.255</netmask>
                 </server>
             </servers>
             <targets>
                 <target type=\"ANY\">
                     <id>7595</id>
                 </target>
             </targets>
             <comment>change ip from 1.1.1.1 to 2.2.2.2</comment>
         </server_decommission_request>
     </field>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"date\">
         <id>7786</id>
         <name>date</name>
         <value>2015-12-15</value>
     </field>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"time\">
         <id>7787</id>
         <name>time</name>
         <value>12:00</value>
     </field>
</fields>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields
BODY{
    \"fields\": {
        \"field\": {
            \"@xsi.type\": \"rule_modification_field\",
            \"id\": 71,
            \"name\": \"Fire Wall Rule\",
            \"read_only\": false,
            \"devices\": {
                \"device\": {
                    \"revision_id\": 4,
                    \"management_name\": \"Panorama/DG_1\",
                    \"management_id\": 4,
                    \"management_ip\": \"10.100.111.120\",
                    \"revision_number\": 1,
                    \"number_of_rules\": 1,
                    \"bindings\": {
                        \"binding\": {
                            \"binding_uid\": \"{00-FACED0-00}\",
                            \"binding\": {
                                \"@xsi.type\": \"policy__binding\",
                                \"policy_name\": \"Standard\"
                            },
                            \"rules\": {
                                \"rule\": {
                                    \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                    \"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",
                                    \"name\": \"Application test\",
                                    \"is_disabled\": false,
                                    \"ruleNumber\": 13,
                                    \"from_zone\": \"any\",
                                    \"to_zone\": \"any\",
                                    \"sourceNetworks\": {
                                        \"@xsi.type\": \"host_network_object\",
                                        \"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",
                                        \"name\": \"H_5.3.2.5\",
                                        \"display_name\": \"H_5.3.2.5\",
                                        \"class_name\": \"host_plain\",
                                        \"origin\": \"DEVICE\",
                                        \"global\": false,
                                        \"implicit\": false,
                                        \"shared\": false,
                                        \"comment\": \"comment\",
                                        \"id\": \"5df1f2a5e9023c311ae4a01a\",
                                        \"version_id\": 4,
                                        \"device_type\": \"PaloAltoNetworks\",
                                        \"ip_type\": \"IPV4\",
                                        \"referenced\": \"UNKNOWN\",
                                        \"installable_target\": false,
                                        \"ip\": \"5.3.2.5\",
                                        \"subnet_mask\": \"255.255.255.255\"
                                    },
                                    \"destinationNetworks\": {
                                        \"@xsi.type\": \"host_network_object\",
                                        \"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",
                                        \"name\": \"22.22.2.2\",
                                        \"display_name\": \"22.22.2.2\",
                                        \"class_name\": \"host_plain\",
                                        \"origin\": \"DEVICE\",
                                        \"global\": false,
                                        \"implicit\": false,
                                        \"shared\": false,
                                        \"comment\": \"\",
                                        \"id\": \"5df1f2a5e9023c311ae4a016\",
                                        \"version_id\": 4,
                                        \"device_type\": \"PaloAltoNetworks\",
                                        \"ip_type\": \"IPV4\",
                                        \"referenced\": \"UNKNOWN\",
                                        \"installable_target\": false,
                                        \"ip\": \"22.22.2.2\",
                                        \"subnet_mask\": \"255.255.255.255\"
                                    },
                                    \"destinationServices\": {
                                        \"@xsi.type\": \"transport_service\",
                                        \"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",
                                        \"name\": \"TCP82\",
                                        \"display_name\": \"TCP82\",
                                        \"class_name\": \"tcp_service\",
                                        \"origin\": \"DEVICE\",
                                        \"global\": false,
                                        \"implicit\": false,
                                        \"shared\": false,
                                        \"comment\": \"TCP82\",
                                        \"id\": \"5df1f2a5e9023c311ae4a018\",
                                        \"version_id\": 4,
                                        \"referenced\": \"UNKNOWN\",
                                        \"type_on_device\": \"\",
                                        \"negate\": false,
                                        \"match_for_any\": false,
                                        \"timeout\": 0,
                                        \"protocol\": 6,
                                        \"min_port\": 82,
                                        \"max_port\": 82
                                    },
                                    \"applications\": {
                                        \"@xsi.type\": \"single_application\",
                                        \"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",
                                        \"name\": \"web-browsing\",
                                        \"display_name\": \"web-browsing\",
                                        \"class_name\": \"application_object\",
                                        \"origin\": \"DEVICE_PREDEFINED\",
                                        \"global\": true,
                                        \"implicit\": false,
                                        \"shared\": false,
                                        \"comment\": \"\",
                                        \"service\": [
                                            {
                                                \"@xsi.type\": \"transport_service\",
                                                \"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",
                                                \"name\": \"st_implicit_app_web-browsing\",
                                                \"display_name\": \"st_implicit_app_web-browsing\",
                                                \"class_name\": \"tcp_service\",
                                                \"origin\": \"DEVICE\",
                                                \"global\": false,
                                                \"implicit\": true,
                                                \"shared\": false,
                                                \"comment\": \"\",
                                                \"id\": \"5df1f2a5e9023c311ae4a014\",
                                                \"version_id\": 4,
                                                \"referenced\": \"UNKNOWN\",
                                                \"type_on_device\": \"\",
                                                \"negate\": false,
                                                \"match_for_any\": false,
                                                \"timeout\": 0,
                                                \"protocol\": 6,
                                                \"min_port\": 80,
                                                \"max_port\": 80
                                            }
                                        ]
                                    },
                                    \"action\": \"ACCEPT\",
                                    \"additional_parameters\": \"\",
                                    \"options\": {
                                        \"option\": \"LOG_SESSION\"
                                    },
                                    \"rule_location\": \"DG_1\",
                                    \"users\": {
                                        \"user\": [
                                            {
                                                \"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",
                                                \"name\": \"Any\",
                                                \"class_name\": \"any_object\",
                                                \"displayName\": \"Any\"
                                            }
                                        ]
                                    },
                                    \"track\": {
                                        \"track_level\": \"LOG\"
                                    },
                                    \"install_ons\": \"\",
                                    \"communities\": \"\",
                                    \"times\": \"\",
                                    \"rule_metadata\": {
                                        \"permissiveness_level\": \"LOW\",
                                        \"violations\": \"\",
                                        \"last_hit\": \"No hits\",
                                        \"shadowed_status\": \"FALSE\",
                                        \"ticket_ids\": \"\",
                                        \"business_owners\": \"\",
                                        \"expirations\": \"\",
                                        \"applications\": \"\",
                                        \"last_modified\": \"Today\"
                                    }
                                }
                            }
                        }
                    }
                }
            },
            \"rule_modifications\": {
                \"rule_modification\": {
                    \"@xsi.type\": \"modify_rule_modification\",
                    \"id\": 10,
                    \"rule_key\": {
                        \"device_id\": 4,
                        \"binding_uid\": \"{00-FACED0-00}\",
                        \"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"
                    },
                    \"source_modifications\": {
                        \"id\": 20,
                        \"network_object_cell_modifications\": {
                            \"network_object_cell_modification\": [
                                {
                                    \"id\": 69,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 65,
                                        \"uid\": \"9b9062a0-228a-4543-bbd4-9fda5c76573b\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"new\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                \"id\": 65,
                                                \"name\": \"My New Host\",
                                                \"comment\": \"some comment\",
                                                \"ip\": \"192.168.0.10\",
                                                \"netmask\": \"255.255.255.255\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 68,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 64,
                                        \"uid\": \"986c68ab-b5b5-478d-9300-bc0cacc06dfe\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"new\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                \"id\": 64,
                                                \"name\": \"My New Address Ragne\",
                                                \"comment\": \"some comment\",
                                                \"min_ip\": \"192.168.0.1\",
                                                \"max_ip\": \"192.168.0.254\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 70,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 68,
                                        \"uid\": \"1073dad5-4dc9-4392-8b42-f32de2937657\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"new\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                \"id\": 68,
                                                \"name\": \"My New Network\",
                                                \"comment\": \"some comment\",
                                                \"ip\": \"192.168.0.0\",
                                                \"netmask\": \"255.255.255.0\"
                                            }
                                        ]
                                    }
                                }
                            ]
                        }
                    },
                    \"destination_modifications\": {
                        \"id\": 19,
                        \"network_object_cell_modifications\": {
                            \"network_object_cell_modification\": [
                                {
                                    \"id\": 66,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 67,
                                        \"uid\": \"e52c07fc-dffb-4c77-a656-40d1b1322e77\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"existing\",
                                            \"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                \"id\": 67,
                                                \"name\": \"Range-Test\",
                                                \"comment\": \"\",
                                                \"min_ip\": \"1.1.2.0\",
                                                \"max_ip\": \"1.1.2.55\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 67,
                                    \"action\": \"REMOVE\",
                                    \"device_network_object\": {
                                        \"id\": 66,
                                        \"uid\": \"fa681c9b-8c4f-449d-9b31-108a399902f5\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"existing\",
                                            \"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                \"id\": 66,
                                                \"name\": \"22.22.2.2\",
                                                \"comment\": \"\",
                                                \"ip\": \"22.22.2.2\",
                                                \"netmask\": \"255.255.255.255\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 65,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 70,
                                        \"uid\": \"2b8eaa1a-f4ea-4c39-b89e-361af89a308e\",
                                        \"device_id\": 2,
                                        \"status\": {
                                            \"@xsi.type\": \"existing\",
                                            \"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                \"id\": 70,
                                                \"name\": \"Net_10.108.151.0\",
                                                \"comment\": \"\",
                                                \"ip\": \"10.108.151.0\",
                                                \"netmask\": \"255.255.255.0\"
                                            }
                                        ]
                                    }
                                },
                                {
                                    \"id\": 64,
                                    \"action\": \"ADD\",
                                    \"device_network_object\": {
                                        \"id\": 69,
                                        \"uid\": \"88efeaad-cfb4-41c4-b14c-fff104c24e52\",
                                        \"device_id\": 4,
                                        \"status\": {
                                            \"@xsi.type\": \"existing\",
                                            \"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"
                                        },
                                        \"network_object\": [
                                            {
                                                \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                \"id\": 69,
                                                \"name\": \"Host_10.10.10.10\",
                                                \"comment\": \"\",
                                                \"ip\": \"10.10.10.10\",
                                                \"netmask\": \"255.255.255.255\"
                                            }
                                        ]
                                    }
                                }
                            ]
                        }
                    }
                }
            },
            \"designer_result\": {
                \"status\": \"not run\"
            }
        }
    }
}}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: The new network object (<name>): device ID (<id>) does not match the rule key device ID (<id>). The device IDs must be the same.
400: Device ID is required for a new device network object
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <name>
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <st_uid>
400: <cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty.
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (Device ID is required for an existing device network object)
400: Invalid value for field: <FIELD_NAME> (ST UID is required for an existing device network object
400: Invalid value for field: <FIELD_NAME> (Network Object with device ID <DEVICE_ID> and ST UID <ST_UID> is not available for the action specified. Check the Knowledge Center or API Implementation Notes for more information
400: Status is required for a device network object"},"response":[]},{"name":"Modify the Designer suggestions for Access Request or Clone Server Policy","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"rule_placement\": {\"new_value\":\"before\"}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/tasks/{{taskId}}/designer/instruction/{{instructionId}}","description":" GENERAL USE
1. Create a ticket using UI/API.
2. Run the designer using UI/API.
3. Use relevent API to get the designer results.
4. Run this API to modify the required parameters.

*Note: you can modify one parameter at a time.

Change rule location use
a. Modifying the rule order places the new rule before the rule with the specified identifier (rule name or number).
b. Modifying the rule placement to \"last\" places the new rule as last rule or last pre-rule (depending on the vendor convention for the device).
c. For vendors that support \"after\" placement, modifying the rule placement allows positioning the new rule before or after the suggested rule location.

track level permitted values:
NONE, LOG, ACCOUNT, ALERT, SNMP, MAIL, USER_DEFINED, EMERGENCIES, ALERTS, CRITICAL, ERRORS, WARNINGS, NOTIFICATIONS, INFORMATIONAL, DEBUGGING, DISABLED, DEFAULT, FULL_LOG, NETWORK_LOG, USER_ALERT_1, USER_ALERT_2, USER_ALERT_3

rule placement permitted values:
BEFORE, AFTER, LAST

Parameters:
body: DesignerInstructionChangeDTO
id: Ticket ID
taskId: Task ID
instructionId: Instruction ID
force: force update when new revision available [optional]

Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"comment\": {\"new_value\":\"new comment\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196?force=true
BODY{
    \"comment\": {\"new_value\":\"new comment\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_name\": {\"new_value\":\"new rule name\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"track_level\": {\"new_value\":\"LOG\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"object_name\": {\"new_value\":\"new object name\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"log_forwarding_profile\": {\"new_value\":\"new log forwarding profile\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"security_profile_group\": {\"new_value\":\"new security profile group\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"object_replace\": {
             \"new_value\":\"new object uid\",
             \"old_value\":\"old object uid\"
    }
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_order\": {\"new_value\":\"8\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_placement\": {\"new_value\":\"last\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_placement\": {\"new_value\":\"before\"}
}


Response Messages:
200: New rule will be shadowed
200: New rule will be shadowed or break acceleration
400: Modify Designer Results API is only supported for Access Request and Clone Server Policy workflows
412: Current instruction cannot be modified because either the implementation was successful or failed irrevocably.
412: Current step does not support Designer modification action
400: A ticket with ID <ID> cannot be found.
400: Task ID <ID> cannot be found in the current step with ID <ID>.
403: Changing <TYPE> is not supported on this device
403: This Change is not supported for <INSTRUCTION TYPE> instruction type\"
401: You do not have permission to update this task. Contact your administrator for assistance.
403: New revision is available, cannot modify the Designer results
404: Specified instruction, id: <ID> was not found
404: Designer results were not found in the access request.
400: a valid object name must start with an alphanumeric character and can contain alphanumeric characters, underscore '_'. Hypen '-', dot '.' or spaces
400: For this device, the comment must be less than 100 characters per line.
400: For this device, this field must be less than <NUMBER OF CHARACTERS> characters
400: For this device, this field is required.
409: Rule name already exists for this device. Please give this rule a unique name.
409: Rule name <NAME> already exists in the device group hierarchy. Choose a unique name for this rule.
400: Comment contains invalid characters.
400: <DEVICE> does not support tracking level <TRACKING LEVEL>
400: <TRACKING LEVEL> is not a valid rule track level value
400: a valid object name cannot contain any of the following characters: <CHARACTERS>
400: a valid object name must be less than <NUMBER OF CHARACTERS> characters
400: a valid object name cannot be empty
400: a valid object name must conform to the following pattern: <STRING PATTERN>
409: Object already exists
400: A security profile group cannot be empty.
404: The security profile group <SECURITY PROFILE GROUP> was not found.
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to validate the security profile group.
400: A log forwarding profile cannot be empty.
404: The log forwarding profile <LOG FORWARDING PROFILE> was not found.
500: An error occurred in SecureTrack while trying to validate the log forwarding profile.
400: Object UID <OLD OBJECT UID> not found in the rule for this instruction.
400: Values of new object UID <NEW OBJECT UID> and old object UID <OLD OBJECT UID> do not match.
400: Rule placement can only be: \"before\", \"after\" or \"last\".
400: You can't change rule placement when there is no rule order. please add rule order first.
400: You can't change rule placement to \"After\" for this type of device.
400: You can't change rule placement to \"Last\" for this type of device."},"response":[]},{"name":"Returns the details of a specified ticket stages","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID."},"response":[]},{"name":"Returns a list of tickets by search parameters","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/free_text_search","description":"Parameters:
parameter: Free text search parameter (Search syntax details) [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/free_text_search/?parameter=taskstatus:ASSIGNED AND priority:High

Response Messages:
400: Can not fetch more than 100 tickets in 1 time
401: Access is denied.
404: Illegal ticket status entered. Permitted values are: IN_PROGRESS, REJECTED, CLOSED, CANCELLED, RESOLVED
404: Illegal ticket SLA status entered. Permitted values are: NA, OK, WARNING, ALERT, ESCALATION
404: Illegal ticket priority entered. Permitted values are: LOW, NORMAL, HIGH, CRITICAL
404: Illegal ticket expiration date entered. Permitted date format is: ddMMyyyy (ex. 20.11.2001)
404: No entity found for query"},"response":[]},{"name":"Get server clone policy verifier results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/clone_server_policy/verifier","description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/clone_server_policy/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.
404: Verifier results were not found in the server clone policy request."},"response":[]},{"name":"Returns the details of a specified ticket","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
expand_links: See expanded view of the objects [optional]
showStepsDetails: Include steps' details in the response [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1
OUTPUT {
    \"ticket\": {
        \"id\": 1,
        \"subject\": \"AR-Ticket\",
        \"requester\": \"a\",
        \"requester_id\": 4,
        \"priority\": \"Normal\",
        \"status\": \"In Progress\",
        \"domain_name\": \"\",
        \"sla_status\": \"NA\",
        \"sla_outcome\": \"NA\",
        \"workflow\": {
            \"id\": 11,
            \"name\": \"AR & MG\",
            \"uses_topology\": true
        },
        \"steps\": {
            \"step\": [
                {
                    \"id\": 209,
                    \"name\": \"Open request\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 209,
                            \"assignee_id\": 4,
                            \"assignee\": \"a\",
                            \"status\": \"DONE\",
                            \"fields\": {
                                \"field\": [
                                    {
                                        \"@xsi.type\": \"multi_access_request\",
                                        \"id\": 1695,
                                        \"name\": \"AR\",
                                        \"read_only\": false,
                                        \"access_request\": {
                                            \"id\": 1706,
                                            \"order\": \"AR1\",
                                            \"risk_analysis_result\": {
                                                \"status\": \"not run\"
                                            },
                                            \"verifier_result\": {
                                                \"status\": \"not run\"
                                            },
                                            \"use_topology\": true,
                                            \"targets\": {
                                                \"target\": {
                                                    \"@type\": \"ANY\",
                                                    \"id\": 1705
                                                }
                                            },
                                            \"users\": {
                                                \"user\": [
                                                    \"Any\"
                                                ]
                                            },
                                            \"sources\": {
                                                \"source\": [
                                                    {
                                                        \"@type\": \"INTERNET\",
                                                        \"id\": 1701
                                                    },
                                                    {
                                                        \"@type\": \"DNS\",
                                                        \"id\": 1702,
                                                        \"host_name\": \"www.google.com\",
                                                        \"dns_ip_addresses\": {
                                                            \"ip_address\": \"216.58.214.100\"
                                                        }
                                                    },
                                                    {
                                                        \"@type\": \"IP\",
                                                        \"id\": 1703,
                                                        \"ip_address\": \"1.1.1.1\",
                                                        \"netmask\": \"255.255.255.255\",
                                                        \"nat_ip_address\": \"4.4.4.4\",
                                                        \"nat_netmask\": \"255.255.255.255\"
                                                    }
                                                ]
                                            },
                                            \"destinations\": {
                                                \"destination\": [
                                                    {
                                                        \"@type\": \"ANY\",
                                                        \"id\": 1697
                                                    }
                                                ]
                                            },
                                            \"services\": {
                                                \"service\": [
                                                    {
                                                        \"@type\": \"ANY\",
                                                        \"id\": 1699
                                                    }
                                                ]
                                            },
                                            \"action\": \"Accept\",
                                            \"labels\": \"\"
                                        }
                                    },
                                    {
                                        \"@xsi.type\": \"multi_group_change\",
                                        \"id\": 1707,
                                        \"name\": \"MG\",
                                        \"read_only\": false,
                                        \"implementation_status\": \"NOT_SUPPORTED\"
                                    }
                                ]
                            }
                        }
                    }
                },
                {
                    \"id\": 210,
                    \"name\": \"STEP2 - auto AR with designer /update /commit\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 210,
                            \"assignee_id\": 4,
                            \"assignee\": \"a\",
                            \"status\": \"ASSIGNED\",
                            \"unlicensed_devices_for_automation\": {
                                \"unlicensed_device_for_automation\": [
                                    {
                                        \"id\": \"2\",
                                        \"name\": \"asa\"
                                    }
                                ]
                            }
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"multi_access_request\",
                                    \"id\": 1709,
                                    \"name\": \"AR\",
                                    \"read_only\": false,
                                    \"access_request\": {
                                        \"id\": 1720,
                                        \"order\": \"AR1\",
                                        \"risk_analysis_result\": {
                                            \"status\": \"not run\"
                                        },
                                        \"verifier_result\": {
                                            \"status\": \"not run\"
                                        },
                                        \"use_topology\": true,
                                        \"targets\": {
                                            \"target\": {
                                                \"@type\": \"ANY\",
                                                \"id\": 1719
                                            }
                                        },
                                        \"users\": {
                                            \"user\": [
                                                \"Any\"
                                            ]
                                        },
                                        \"sources\": {
                                            \"source\": [
                                                {
                                                    \"@type\": \"INTERNET\",
                                                    \"id\": 1721
                                                },
                                                {
                                                    \"@type\": \"DNS\",
                                                    \"id\": 1722,
                                                    \"host_name\": \"www.google.com\",
                                                    \"dns_ip_addresses\": {
                                                        \"ip_address\": \"216.58.214.100\"
                                                    }
                                                },
                                                {
                                                    \"@type\": \"IP\",
                                                    \"id\": 1723,
                                                    \"ip_address\": \"1.1.1.1\",
                                                    \"netmask\": \"255.255.255.255\",
                                                    \"nat_ip_address\": \"4.4.4.4\",
                                                    \"nat_netmask\": \"255.255.255.255\"
                                                },
                                                {
                                                    \"@type\": \"RANGE\",
                                                    \"id\": 1724,
                                                    \"range_first_ip\": \"1.1.11.1\",
                                                    \"range_last_ip\": \"1.1.11.10\"
                                                }
                                            ]
                                        },
                                        \"destinations\": {
                                            \"destination\": [
                                                {
                                                    \"@type\": \"ANY\",
                                                    \"id\": 1711
                                                }
                                            ]
                                        },
                                        \"services\": {
                                            \"service\": [
                                                {
                                                    \"@type\": \"ANY\",
                                                    \"id\": 1713
                                                }
                                            ]
                                        },
                                        \"action\": \"Accept\",
                                        \"labels\": \"\"
                                    }
                                }
                            }
                        }
                    }
                }
            ]
        },
        \"current_step\": {
            \"id\": 210,
            \"name\": \"STEP2 - auto AR with designer /update /commit\"
        },
        \"comments\": \"\"
    }
}


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2
OUTPUT {
    \"ticket\": {
        \"id\": 2,
        \"subject\": \"Clone Server Policy Ticket\",
        \"requester\": \"a\",
        \"requester_id\": 12,
        \"priority\": \"Normal\",
        \"status\": \"In Progress\",
        \"domain_name\": \"\",
        \"sla_status\": \"NA\",
        \"sla_outcome\": \"NA\",
        \"workflow\": {
            \"id\": 109,
            \"name\": \"sc_12705\",
            \"uses_topology\": false
        },
        \"steps\": {
            \"step\": [
                {
                    \"id\": 78,
                    \"name\": \"Open request\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 78,
                            \"assignee_id\": 12,
                            \"assignee\": \"a\",
                            \"status\": \"DONE\",
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"clone_server_policy_request\",
                                    \"id\": 872,
                                    \"name\": \"Clone Server Policy Field\",
                                    \"from_server\": {
                                        \"@type\": \"IP\",
                                        \"id\": 869,
                                        \"ip_address\": \"1.2.2.2\",
                                        \"cidr\": 32
                                    },
                                    \"to_servers\": {
                                        \"server\": {
                                            \"@type\": \"IP\",
                                            \"id\": 871,
                                            \"ip_address\": \"10.100.23.32\",
                                            \"netmask\": \"255.255.255.255\",
                                            \"cidr\": 32
                                        }
                                    },
                                    \"comment\": \"target servers to clone server policy to\"
                                }
                            }
                        }
                    }
                },
                {
                    \"id\": 79,
                    \"name\": \"Business Approval\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 79,
                            \"assignee_id\": 12,
                            \"assignee\": \"a\",
                            \"status\": \"ASSIGNED\",
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"clone_server_policy_request\",
                                    \"id\": 876,
                                    \"name\": \"Clone Server Policy Field\",
                                    \"from_server\": {
                                        \"@type\": \"IP\",
                                        \"id\": 873,
                                        \"ip_address\": \"1.2.2.2\",
                                        \"cidr\": 32
                                    },
                                    \"to_servers\": {
                                        \"server\": {
                                            \"@type\": \"IP\",
                                            \"id\": 875,
                                            \"ip_address\": \"10.100.23.32\",
                                            \"netmask\": \"255.255.255.255\",
                                            \"cidr\": 32
                                        }
                                    },
                                    \"comment\": \"target servers to clone server policy to\"
                                }
                            }
                        }
                    }
                }
            ]
        },
        \"current_step\": {
            \"id\": 79,
            \"name\": \"Business Approval\"
        },
        \"comments\": \"\"
    }
}


Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: No entity found for query"},"response":[]},{"name":"Submit a new ticket to Secure Change","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\t\"ticket\": {\n\t\t\"application_details\": { \"id\": \"1\" },\n\t\t\"subject\": \"topology mode_AR1-with topology_AR2-no topology\",\n\t\t\"priority\": \"Normal\",\n\t\t\"workflow\": { \"name\": \"ar\" }\n\t}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/","description":" GENERAL USE
When posting a Modify Group ticket, group scope must be configured for FortiManager advanced and Juniper SRX devices.
Juniper SRX devices:
Global address-book will be used unless an existing address-book is given.
Ticket validation will fail in case given Address Book is not configured on the device.
FortiManager advanced devices:
'Any' zone will be used unless an existing zone is given.
Ticket validation will fail in case given zone is not configured on the device.
*Note: Zones and address-books must not be configured for other devices.

Using newly created objects from a different group in the same ticket
The user can add a newly created object from a different group to the selected group, with object_UID equal to the name of the newly created object.
For management devices with hierarchies, the newly created object does not populate other levels of the hierarchies.

Permitted values for @type
Allowed values for @type property included in DestinationDTO and SourceDTO are:
ANY
IP
DNS
Object - Device's existing object
INTERNET
LDAP (SourceDTO only) - LDAP entity

To use a service object in a new request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id
2. Both object_name and management_name

To use a network object in a new request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both object_UID and object_name are defined, object_UID takes precedence over object_name

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: ticketDTO
closed: Cannot be done from the API [optional]
count [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY<ticket>
    <subject>topology mode_AR1-with topology_AR2-no topology</subject>
    <requester>u1</requester>
    <priority>Normal</priority>
    <domain_name>Default</domain_name>
    <workflow>
         <id>7</id>
         <name>Workflow with topology</name>
    </workflow>
    <steps>
         <step>
             <name>Open request</name>
             <tasks>
                 <task>
                     <fields>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_access_request\">
                             <name>Required Access</name>
                             <access_request>
                                 <use_topology>true</use_topology>
                                 <targets>
                                     <target type=\"Object\">
                                         <object_name>ASA</object_name>
                                         <management_name>ASA</management_name>
                                     </target>
                                 </targets>
                                 <users>
                                     <user>Any</user>
                                 </users>
                                 <sources>
                                     <source type=\"Object\">
                                         <object_name>host_10.100.10.140</object_name>
                                         <management_name>NetScreen</management_name>
                                     </source>
                                 <sources>
                                     <source type=\"Object\">
                                         <object_UID>{55908141-c341-4990-9cc6-a3fd2dfb49e1}</object_UID>
                                         <management_id>13</management_id>
                                     </source>
                                 </sources>
                                 <destinations>
                                     <destination type=\"Object\">
                                         <object_name>h_10.10.10.10</object_name>
                                         <management_name>ASA</management_name>
                                     </destination>
                                 </destinations>
                                 <services>
                                     <service type=\"PROTOCOL\">
                                         <protocol>TCP</protocol>
                                         <port>80</port>
                                     </service>
                                     <service type=\"APPLICATION_IDENTITY\">
                                         <application_name>Gmail</application_name>
                                     </service>
                                 </services>
                                 <action>Accept</action>
                                 <labels/>
                             </access_request>
                             <access_request>
                                 <use_topology>false</use_topology>
                                 <targets>
                                     <target type=\"Object\">
                                         <object_name>inside_access_in</object_name>
                                         <management_name>ASA</management_name>
                                     </target>
                                 </targets>
                                 <users>
                                     <user>Any</user>
                                 </users>
                                 <sources>
                                     <source type=\"Object\">
                                         <object_name>1.1.1.0</object_name>
                                         <management_name>NetScreen</management_name>
                                     </source>
                                 </sources>
                                 <destinations>
                                     <destination type=\"Object\">
                                         <object_name>network_regi3</object_name>
                                         <management_name>ASA</management_name>
                                     </destination>
                                 </destinations>
                                 <services>
                                     <service type=\"ANY\">
                                     </service>
                                 </services>
                                 <action>Accept</action>
                                 <labels/>
                             </access_request>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_area\">
                             <name>Business Justification</name>
                             <text>I need access to ftp </text>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_field\">
                             <name>Project Number</name>
                             <text>CR124560 </text>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"hyperlink\">
                             <name>Hyperlink</name>
                             <url>http://192.168.1.1/ticket</url>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"drop_down_list\">
                             <name>Change Window</name>
                             <selection>Monday</selection>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"manager\">
                             <name>manager email</name>
                             <text>manager@tufin.com</text>
                         </field>
                     </fields>
                 </task>
             </tasks>
        </step>
    </steps>
    <comments/>
</ticket>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY<ticket>
    <subject>New MG ticket</subject>
    <requester>a</requester>
    <requester_id>4</requester_id>
    <priority>Normal</priority>
    <status>In Progress</status>
    <domain_name/>
    <sla_status>NA</sla_status>
    <sla_outcome>NA</sla_outcome>
    <workflow>
        <id>6</id>
        <name>MG</name>
        <uses_topology>false</uses_topology>
    </workflow>
    <steps>
        <step>
            <id>72</id>
            <name>New step</name>
            <redone>false</redone>
            <skipped>false</skipped>
            <tasks>
                <task>
                    <id>72</id>
                    <assignee_id>4</assignee_id>
                    <assignee>a</assignee>
                    <status>ASSIGNED</status>
                    <fields>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_group_change\">
                            <id>262</id>
                            <name>MG</name>
                            <read_only>false</read_only>
                            <implementation_status>NOT_SUPPORTED</implementation_status>
                            <group_change>
                                <name>ExistingGroup</name>
                                <object_UID>{c862fb6f-1314-45da-9e01-56c9b85d001d}</object_UID>
                                <management_id>58</management_id>
                                <management_name>FMG/root</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>157</id>
                                        <name>10.100 net</name>
                                        <object_UID>{37cdc055-7aac-4385-b46b-cc54d95e4b6d}</object_UID>
                                        <object_type>Network</object_type>
                                        <object_details>10.100.0.0/255.255.0.0</object_details>
                                        <management_id>58</management_id>
                                        <management_name>FMG/root</management_name>
                                        <status>NOT_CHANGED</status>
                                        <object_updated_status>EXISTING_EDITED</object_updated_status>
                                        <comment>new_comment</comment>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                                <zone>
                                    <is_global>true</is_global>
                                    <name>any</name>
                                </zone>
                            </group_change>
                            <group_change>
                                <name>78.45.12.0</name>
                                <object_UID>{cac64d34-a05e-4a05-b271-64642eb976ff}</object_UID>
                                <management_id>28</management_id>
                                <management_name>SRX-root-lsys</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>158</id>
                                        <name>78.45.12.1</name>
                                        <object_UID>{7912c335-6dbe-47de-b872-1322f9015b2f}</object_UID>
                                        <object_type>Host</object_type>
                                        <object_details>78.45.12.1/255.255.255.255</object_details>
                                        <management_id>28</management_id>
                                        <management_name>SRX-root-lsys</management_name>
                                        <status>NOT_CHANGED</status>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                                <address_book>
                                    <name>global</name>
                                </address_book>
                            </group_change>
                            <group_change>
                                <name>10.10.0.0/16</name>
                                <object_UID>{5dff0bd8-51e4-4a83-8138-d54dd18ca52b}</object_UID>
                                <management_id>24</management_id>
                                <management_name>NSX-Distributed Firewall</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>161</id>
                                        <name>10.10.0.0/16</name>
                                        <object_UID>{5d7b826c-f053-40fd-81bd-7a6f44cf15ef}</object_UID>
                                        <object_type>Network</object_type>
                                        <object_details>10.10.0.0/255.255.0.0</object_details>
                                        <management_id>24</management_id>
                                        <management_name>NSX-Distributed Firewall</management_name>
                                        <status>NOT_CHANGED</status>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                            </group_change>
                        </field>
                    </fields>
                </task>
            </tasks>
        </step>
    </steps>
</ticket>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY<ticket>
    <subject>test API</subject>
    <requester>a</requester>
    <requester_id>4</requester_id>
    <priority>Normal</priority>
    <domain_name/>
    <sla_status>NA</sla_status>
    <sla_outcome>NA</sla_outcome>
    <workflow>
        <id>8</id>
        <name>Modify group</name>
        <uses_topology>false</uses_topology>
    </workflow>
    <steps>
        <step>
            <id>11</id>
            <name>Open request</name>
            <redone>false</redone>
            <skipped>false</skipped>
            <tasks>
                <task>
                    <id>11</id>
                    <assignee_id>4</assignee_id>
                    <assignee>a</assignee>                    <status>DONE</status>
                    <fields>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_group_change\">
                            <id>137</id>
                            <name>ff</name>
                            <read_only>false</read_only>
                            <implementation_status>NOT_SUPPORTED</implementation_status>
                            <group_change>
                                <name>port1Group</name>
                                <object_UID>{d5b4459b-6b27-4012-9924-b244c250520f}</object_UID>
                                <management_id>64</management_id>
                                <management_name>10.100.111.8/ADOM_5_2</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"HOST\">
                                        <id>69</id>
                                        <name>obj_1</name>
                                        <object_UID>obj_1</object_UID>
                                        <object_type>Host</object_type>
                                        <object_details>6.6.6.6/255.255.255.255</object_details>
                                        <management_id>64</management_id>
                                        <status>ADDED</status>
                                        <comment/>
                                        <object_updated_status>NEW</object_updated_status>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                            </group_change>
                            <group_change>
                                <name>gfd</name>
                                <management_id>64</management_id>
                                <management_name>10.100.111.8/ADOM_5_2</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>70</id>
                                        <name>obj_1</name>
                                        <object_UID>obj_1</object_UID>
                                        <object_type>Host</object_type>
                                        <object_details>6.6.6.6/255.255.255.255</object_details>
                                        <management_id>64</management_id>
                                        <management_name>10.100.111.8/ADOM_5_2</management_name>
                                        <status>ADDED</status>
                                        <object_updated_status>EXISTING_NOT_EDITED</object_updated_status>
                                    </member>
                                </members>
                                <change_action>CREATE</change_action>
                                <zone>
                                    <is_global>true</is_global>
                                    <name>any</name>
                                </zone>
                            </group_change>
                        </field>
                    </fields>
                </task>
            </tasks>
        </step>
    </steps>
    <current_step>
        <id>12</id>
        <name>Copy of Open request</name>
    </current_step>
    <comments/>
</ticket>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY{
    \"ticket\": {
        \"application_details\": { \"id\": \"1\" },
        \"subject\": \"topology mode_AR1-with topology_AR2-no topology\",
        \"priority\": \"Normal\",
        \"workflow\": { \"name\": \"ar\" }
    }
}


Response Messages:
400: Application ID is missing.
400: Create closed ticket is enabled only from SecureApp application.
400: The application was already deleted.
400: The requester must be the currently logged in user.
400: Workflow was not found.
400: Workflow is not active.
400: Workflow configuration is not valid.
400: Workflow is not set
400: You cannot enter a status for a new ticket.
400: Requester cannot open a ticket in domain.
400: Invalid ticket priority.
400: You cannot open a new ticket with an empty subject.
400: Expiration field is required.
400: Submit ticket enabled only with the first step
400: First step can be only with one task
400: The specified workflow does not contain an access request field in the first step.
400: There are no changed connections that are ready for creating a ticket.
400: You cannot use an access request field to create a ticket from SecureApp.
400: The ticket fields do not match the fields in the current step of the workflow.
400: You cannot change the value of a field because it is read-only.
400: Managed tasks are not initialized or done
400: Application Change field cannot be managed via this REST API
400: Invalid value for field: <FIELD_NAME> (Rule Modification workflow is not supported for this device)
401: You do not have permissions to edit this application.
401: Logged in user: NAME do not have permission to perform on behalf actions
401: You are not a participant in the first step of this workflow
401: UNAUTHORIZED
404: There is no application with the specified ID
400: Invalid value for field: <FIELD_NAME> (Device ID is required for an existing device network object)
400: Invalid value for field: <FIELD_NAME> (ST UID is required for an existing device network object
400: Invalid value for field: <FIELD_NAME> (Network Object with device ID <DEVICE_ID> and ST UID <ST_UID> is not available for the action specified. Check the Knowledge Center or API Implementation Notes for more information
400: Status is required for a device network object"},"response":[]},{"name":"Returns the details of a specified tickets (max 100 tickets in a single query)","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
status: The status of the tickets [optional]
count: Tickets list max pagination length (max value is 100) [optional]
start: Offset the count starting point [optional]
desc: Get the list in descending order [optional]
expand_links: See expanded view of the objects [optional]
showStepsDetails: Include steps' details in the response [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets?status=In Progress&count=10&start=3&expand_links=false

Response Messages:
400: Status is not a valid. The valid values are: TICKET_STATUSES
400: Can not fetch more than 100 tickets in 1 time
401: Access is denied"},"response":[]},{"name":"Returns a list of tickets by search parameters","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/search","description":"If the query is succesful but no results are found (for example, if there is no ticket for the specified Ticket ID) then the return code will be 200 and the results will be empty.

Parameters:
id: The ID number of the ticket as shown in SecureChange [optional]
subject: The subject of the ticket [optional]
requester: The requester of the ticket [optional]
group: The group handling the ticket [optional]
assigned_to: The user name of the person assigned to the ticket [optional]
priority: The priority of the ticket [optional]
status: The status of the ticket [optional]
sla_status: The SLA status of the ticket [optional]
field_name: Field name to search by [optional]
field_value: Field value to search by [optional]
current_step: Current step name [optional]
expiration_date_from: Search requests with expiration date from this date [optional]
expiration_date_to: Search requests with expiration date until this date [optional]
domain_name: The Domain of the ticket [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/search?id=1&status=IN_PROGRESS,REJECTED

Response Messages:
401: Access is denied.
400: Illegal ticket status entered. Permitted values are: IN_PROGRESS, REJECTED, CLOSED, CANCELLED, RESOLVED, WAITING_TO_BE_ASSIGNED, ASSIGNED, WAITING_FOR_MORE_INFO, DONE, INVALID, PENDING, PENDING_LICENS
400: Illegal ticket SLA status entered. Permitted values are: NA, OK, WARNING, ALERT, ESCALATION
400: Illegal ticket priority entered. Permitted values are: LOW, NORMAL, HIGH, CRITICAL
400: Illegal ticket expiration date entered. Permitted date format is: ddMMyyyy (ex. 20.11.2001)
400: Cannot find specified domain <DOMAIN_NAME>"},"response":[]},{"name":"Returns topology map image (png file) for specific verifier results","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_access_request/{{fieldId}}/verifier/topology_map","description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/multi_access_request/2022/verifier/topology_map

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.
404: Verifier results were not found in the access request.
404: Toplogy map was not found for this field."},"response":[]},{"name":"Get access request verifier results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_access_request/{{fieldId}}/verifier","description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/multi_access_request/2022/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.
404: Verifier results were not found in the access request."},"response":[]},{"name":"Returns the details of a specified task","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
taskId: The ID number of the task as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2?expand_links=true

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.
404: Task with ID was not found in Stage ID in ticket ID ."},"response":[]},{"name":"Change a task of a ticket","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\t\"task\": {\n\t\t\"id\": 4,\n\t\t\"assignee_id\": 4,\n\t\t\"assignee\": \"a\",\n\t\t\"status\": \"ASSIGNED\",\n\t\t\"fields\": {\n\t\t\t\"field\": {\n\t\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\t\"id\": 71,\n\t\t\t\t\"name\": \"Fire Wall Rule\",\n\t\t\t\t\"read_only\": false,\n\t\t\t\t\"devices\": {\n\t\t\t\t\t\"device\": {\n\t\t\t\t\t\t\"revision_id\": 4,\n\t\t\t\t\t\t\"management_name\": \"Panorama/DG_1\",\n\t\t\t\t\t\t\"management_id\": 4,\n\t\t\t\t\t\t\"management_ip\": \"10.100.111.120\",\n\t\t\t\t\t\t\"revision_number\": 1,\n\t\t\t\t\t\t\"number_of_rules\": 1,\n\t\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\t\"policy_name\": \"Standard\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"Application test\",\n\t\t\t\t\t\t\t\t\t\t\"is_disabled\": false,\n\t\t\t\t\t\t\t\t\t\t\"ruleNumber\": 13,\n\t\t\t\t\t\t\t\t\t\t\"from_zone\": \"any\",\n\t\t\t\t\t\t\t\t\t\t\"to_zone\": \"any\",\n\t\t\t\t\t\t\t\t\t\t\"sourceNetworks\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"H_5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"comment\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a01a\",\n\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"5.3.2.5\",\n\t\t\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"destinationNetworks\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"host_plain\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a016\",\n\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"device_type\": \"PaloAltoNetworks\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip_type\": \"IPV4\",\n\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\"installable_target\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\"subnet_mask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"destinationServices\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"TCP82\",\n\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a018\",\n\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\t\"min_port\": 82,\n\t\t\t\t\t\t\t\t\t\t\t\"max_port\": 82\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"applications\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"single_application\",\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"application_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE_PREDEFINED\",\n\t\t\t\t\t\t\t\t\t\t\t\"global\": true,\n\t\t\t\t\t\t\t\t\t\t\t\"implicit\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"service\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"display_name\": \"st_implicit_app_web-browsing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"tcp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"origin\": \"DEVICE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"global\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"implicit\": true,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"shared\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": \"5df1f2a5e9023c311ae4a014\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"version_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"referenced\": \"UNKNOWN\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"type_on_device\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"negate\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"match_for_any\": false,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"timeout\": 0,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": 6,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_port\": 80,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_port\": 80\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ACCEPT\",\n\t\t\t\t\t\t\t\t\t\t\"additional_parameters\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"options\": {\n\t\t\t\t\t\t\t\t\t\t\t\"option\": \"LOG_SESSION\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"rule_location\": \"DG_1\",\n\t\t\t\t\t\t\t\t\t\t\"users\": {\n\t\t\t\t\t\t\t\t\t\t\t\"user\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Any\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"class_name\": \"any_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"displayName\": \"Any\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"track\": {\n\t\t\t\t\t\t\t\t\t\t\t\"track_level\": \"LOG\"\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"install_ons\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"communities\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"times\": \"\",\n\t\t\t\t\t\t\t\t\t\t\"rule_metadata\": {\n\t\t\t\t\t\t\t\t\t\t\t\"permissiveness_level\": \"LOW\",\n\t\t\t\t\t\t\t\t\t\t\t\"violations\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"last_hit\": \"No hits\",\n\t\t\t\t\t\t\t\t\t\t\t\"shadowed_status\": \"FALSE\",\n\t\t\t\t\t\t\t\t\t\t\t\"ticket_ids\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"business_owners\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"expirations\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"applications\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"last_modified\": \"Today\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"rule_modifications\": {\n\t\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\t\"id\": 13,\n\t\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\"binding_uid\": \"{00-FACED0-00}\",\n\t\t\t\t\t\t\t\"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\t\"id\": 26,\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 89,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 88,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"e7e4ac52-2fe4-49f7-8071-9638817a7434\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 88,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Host\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 91,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 89,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"13556e3e-1f93-4f95-939c-428a58001615\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 89,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Address Ragne\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"192.168.0.1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"192.168.0.254\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 90,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 87,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"1ecb9679-4da4-4fc5-9382-00f5fa455295\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 87,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"My New Network\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"some comment\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"192.168.0.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\t\"id\": 25,\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 88,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 91,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"50f35caf-3f13-4961-9ccd-055e1703592a\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 91,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host_10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.10.10.10\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 85,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 90,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"21342c9a-3974-4bd3-b74b-b142e43ed39a\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 90,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Range-Test\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"1.1.2.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"1.1.2.55\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 86,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 86,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"8fff4c36-da34-4945-be33-ffd5d4d444e2\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 4,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 86,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"22.22.2.2\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"id\": 87,\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"id\": 85,\n\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"35ec73ed-e0fa-4690-9570-00b417b63ae6\",\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 2,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 85,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Net_10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"10.108.151.0\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.0\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"designer_result\": {\n\t\t\t\t\t\"status\": \"not run\"\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both object_UID and object_name are defined, object_UID takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: ticketTaskDTO
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/2/tasks/4
BODY<task>
     <status>ASSIGNED</status>
     <fields>
         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_group_change\">
             <id>7599</id>
             <name>mf</name>
             <read_only>false</read_only>
             <implementation_status>NOT_STARTED</implementation_status>
             <group_change>
                        <name>ggg</name>
                        <object_UID>{A12AE330-0DBD-11E5-B841-7F0000010E0E}</object_UID>
                        <management_id>42</management_id>
                        <management_name>cp239</management_name>
                        <members>
                             <member type=\"Object\">
                                 <id>8</id>
                                 <name>yaakovs_host</name>
                                 <object_UID>{BDAA378C-C90B-4D12-B598-1AFED2D1DA14}</object_UID>
                                 <object_type>Host</object_type>
                                 <object_details>1.1.1.1/255.255.255.255</object_details>
                         <management_id>42</management_id>
                         <management_name>cp239</management_name>
                                 <status>NOT_CHANGED</status>
                             </member>
                             <member type=\"Object\">
                                 <id>9</id>
                                    <name>Avi_10.100.120.254</name>
                                    <object_UID>{8F195CDC-F426-47B6-9E8A-1FF14C17E54F}</object_UID>
                                     <object_type>Host</object_type>
                                     <object_details>10.100.120.254/255.255.255.255</object_details>
                                     <management_id>42</management_id>
                                     <management_name>cp239</management_name>
                                     <status>NOT_CHANGED</status>
                                 </member>
                                 <member type=\"HOST\">
                                     <id>10</id>
                                     <name>h22</name>
                                     <object_type>Host</object_type>
                                     <object_details>2.2.2.2/255.255.255.255</object_details>
                                     <status>ADDED</status>
                                     <comment/>
                                 </member>
                                 <member type=\"HOST\">
                                     <id>10</id>
                                     <name>h22</name>
                                     <object_type>Host</object_type>
                                     <object_details>3.3.3.3/255.255.255.255</object_details>
                                     <status>ADDED</status>
                                     <comment/>
                                 </member>
                 </members>
                 <change_implementation_status>NOT_RUN</change_implementation_status>
                    </group_change>
            </field>
     </fields>
</task>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/
BODY{
    \"task\": {
        \"id\": 4,
        \"assignee_id\": 4,
        \"assignee\": \"a\",
        \"status\": \"ASSIGNED\",
        \"fields\": {
            \"field\": {
                \"@xsi.type\": \"rule_modification_field\",
                \"id\": 71,
                \"name\": \"Fire Wall Rule\",
                \"read_only\": false,
                \"devices\": {
                    \"device\": {
                        \"revision_id\": 4,
                        \"management_name\": \"Panorama/DG_1\",
                        \"management_id\": 4,
                        \"management_ip\": \"10.100.111.120\",
                        \"revision_number\": 1,
                        \"number_of_rules\": 1,
                        \"bindings\": {
                            \"binding\": {
                                \"binding_uid\": \"{00-FACED0-00}\",
                                \"binding\": {
                                    \"@xsi.type\": \"policy__binding\",
                                    \"policy_name\": \"Standard\"
                                },
                                \"rules\": {
                                    \"rule\": {
                                        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                        \"uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\",
                                        \"name\": \"Application test\",
                                        \"is_disabled\": false,
                                        \"ruleNumber\": 13,
                                        \"from_zone\": \"any\",
                                        \"to_zone\": \"any\",
                                        \"sourceNetworks\": {
                                            \"@xsi.type\": \"host_network_object\",
                                            \"uid\": \"{534DF349-DCDE-0662-C056-58BBB6F0AE7B}\",
                                            \"name\": \"H_5.3.2.5\",
                                            \"display_name\": \"H_5.3.2.5\",
                                            \"class_name\": \"host_plain\",
                                            \"origin\": \"DEVICE\",
                                            \"global\": false,
                                            \"implicit\": false,
                                            \"shared\": false,
                                            \"comment\": \"comment\",
                                            \"id\": \"5df1f2a5e9023c311ae4a01a\",
                                            \"version_id\": 4,
                                            \"device_type\": \"PaloAltoNetworks\",
                                            \"ip_type\": \"IPV4\",
                                            \"referenced\": \"UNKNOWN\",
                                            \"installable_target\": false,
                                            \"ip\": \"5.3.2.5\",
                                            \"subnet_mask\": \"255.255.255.255\"
                                        },
                                        \"destinationNetworks\": {
                                            \"@xsi.type\": \"host_network_object\",
                                            \"uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\",
                                            \"name\": \"22.22.2.2\",
                                            \"display_name\": \"22.22.2.2\",
                                            \"class_name\": \"host_plain\",
                                            \"origin\": \"DEVICE\",
                                            \"global\": false,
                                            \"implicit\": false,
                                            \"shared\": false,
                                            \"comment\": \"\",
                                            \"id\": \"5df1f2a5e9023c311ae4a016\",
                                            \"version_id\": 4,
                                            \"device_type\": \"PaloAltoNetworks\",
                                            \"ip_type\": \"IPV4\",
                                            \"referenced\": \"UNKNOWN\",
                                            \"installable_target\": false,
                                            \"ip\": \"22.22.2.2\",
                                            \"subnet_mask\": \"255.255.255.255\"
                                        },
                                        \"destinationServices\": {
                                            \"@xsi.type\": \"transport_service\",
                                            \"uid\": \"{021A32BC-7393-A469-FF24-94822DF3B959}\",
                                            \"name\": \"TCP82\",
                                            \"display_name\": \"TCP82\",
                                            \"class_name\": \"tcp_service\",
                                            \"origin\": \"DEVICE\",
                                            \"global\": false,
                                            \"implicit\": false,
                                            \"shared\": false,
                                            \"comment\": \"TCP82\",
                                            \"id\": \"5df1f2a5e9023c311ae4a018\",
                                            \"version_id\": 4,
                                            \"referenced\": \"UNKNOWN\",
                                            \"type_on_device\": \"\",
                                            \"negate\": false,
                                            \"match_for_any\": false,
                                            \"timeout\": 0,
                                            \"protocol\": 6,
                                            \"min_port\": 82,
                                            \"max_port\": 82
                                        },
                                        \"applications\": {
                                            \"@xsi.type\": \"single_application\",
                                            \"uid\": \"{D72A6495-E024-B4B8-07A0-A897EE460782}\",
                                            \"name\": \"web-browsing\",
                                            \"display_name\": \"web-browsing\",
                                            \"class_name\": \"application_object\",
                                            \"origin\": \"DEVICE_PREDEFINED\",
                                            \"global\": true,
                                            \"implicit\": false,
                                            \"shared\": false,
                                            \"comment\": \"\",
                                            \"service\": [
                                                {
                                                    \"@xsi.type\": \"transport_service\",
                                                    \"uid\": \"{8E62C531-577F-B589-BB84-549FAAF13FEC}\",
                                                    \"name\": \"st_implicit_app_web-browsing\",
                                                    \"display_name\": \"st_implicit_app_web-browsing\",
                                                    \"class_name\": \"tcp_service\",
                                                    \"origin\": \"DEVICE\",
                                                    \"global\": false,
                                                    \"implicit\": true,
                                                    \"shared\": false,
                                                    \"comment\": \"\",
                                                    \"id\": \"5df1f2a5e9023c311ae4a014\",
                                                    \"version_id\": 4,
                                                    \"referenced\": \"UNKNOWN\",
                                                    \"type_on_device\": \"\",
                                                    \"negate\": false,
                                                    \"match_for_any\": false,
                                                    \"timeout\": 0,
                                                    \"protocol\": 6,
                                                    \"min_port\": 80,
                                                    \"max_port\": 80
                                                }
                                            ]
                                        },
                                        \"action\": \"ACCEPT\",
                                        \"additional_parameters\": \"\",
                                        \"options\": {
                                            \"option\": \"LOG_SESSION\"
                                        },
                                        \"rule_location\": \"DG_1\",
                                        \"users\": {
                                            \"user\": [
                                                {
                                                    \"uid\": \"{3800615a-09b6-498f-ad55-4e71a0663ccc}\",
                                                    \"name\": \"Any\",
                                                    \"class_name\": \"any_object\",
                                                    \"displayName\": \"Any\"
                                                }
                                            ]
                                        },
                                        \"track\": {
                                            \"track_level\": \"LOG\"
                                        },
                                        \"install_ons\": \"\",
                                        \"communities\": \"\",
                                        \"times\": \"\",
                                        \"rule_metadata\": {
                                            \"permissiveness_level\": \"LOW\",
                                            \"violations\": \"\",
                                            \"last_hit\": \"No hits\",
                                            \"shadowed_status\": \"FALSE\",
                                            \"ticket_ids\": \"\",
                                            \"business_owners\": \"\",
                                            \"expirations\": \"\",
                                            \"applications\": \"\",
                                            \"last_modified\": \"Today\"
                                        }
                                    }
                                }
                            }
                        }
                    }
                },
                \"rule_modifications\": {
                    \"rule_modification\": {
                        \"@xsi.type\": \"modify_rule_modification\",
                        \"id\": 13,
                        \"rule_key\": {
                            \"device_id\": 4,
                            \"binding_uid\": \"{00-FACED0-00}\",
                            \"rule_uid\": \"{A72BF9D8-BA2B-A7BF-6A74-B548FD5C91AE}\"
                        },
                        \"source_modifications\": {
                            \"id\": 26,
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"id\": 89,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 88,
                                            \"uid\": \"e7e4ac52-2fe4-49f7-8071-9638817a7434\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"id\": 88,
                                                    \"name\": \"My New Host\",
                                                    \"comment\": \"some comment\",
                                                    \"ip\": \"192.168.0.10\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 91,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 89,
                                            \"uid\": \"13556e3e-1f93-4f95-939c-428a58001615\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                    \"id\": 89,
                                                    \"name\": \"My New Address Ragne\",
                                                    \"comment\": \"some comment\",
                                                    \"min_ip\": \"192.168.0.1\",
                                                    \"max_ip\": \"192.168.0.254\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 90,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 87,
                                            \"uid\": \"1ecb9679-4da4-4fc5-9382-00f5fa455295\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                    \"id\": 87,
                                                    \"name\": \"My New Network\",
                                                    \"comment\": \"some comment\",
                                                    \"ip\": \"192.168.0.0\",
                                                    \"netmask\": \"255.255.255.0\"
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        },
                        \"destination_modifications\": {
                            \"id\": 25,
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"id\": 88,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 91,
                                            \"uid\": \"50f35caf-3f13-4961-9ccd-055e1703592a\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{5A4CC65A-0A28-64F6-D6C3-96978A2517D0}\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"id\": 91,
                                                    \"name\": \"Host_10.10.10.10\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"10.10.10.10\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 85,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 90,
                                            \"uid\": \"21342c9a-3974-4bd3-b74b-b142e43ed39a\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{D651F4C0-C477-0D75-F8AE-54ED12889B45}\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                    \"id\": 90,
                                                    \"name\": \"Range-Test\",
                                                    \"comment\": \"\",
                                                    \"min_ip\": \"1.1.2.0\",
                                                    \"max_ip\": \"1.1.2.55\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 86,
                                        \"action\": \"REMOVE\",
                                        \"device_network_object\": {
                                            \"id\": 86,
                                            \"uid\": \"8fff4c36-da34-4945-be33-ffd5d4d444e2\",
                                            \"device_id\": 4,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{E6ECCD48-D14F-F166-7579-59F453F0C552}\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"id\": 86,
                                                    \"name\": \"22.22.2.2\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"22.22.2.2\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"id\": 87,
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"id\": 85,
                                            \"uid\": \"35ec73ed-e0fa-4690-9570-00b417b63ae6\",
                                            \"device_id\": 2,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{B64A7266-1BEC-61E5-6B27-C992026613BB}\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                    \"id\": 85,
                                                    \"name\": \"Net_10.108.151.0\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"10.108.151.0\",
                                                    \"netmask\": \"255.255.255.0\"
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        }
                    }
                },
                \"designer_result\": {
                    \"status\": \"not run\"
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket step does not exist, or is not the current step
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Task status does not exist.
400: Task status is not set to ASSIGNED or DONE.
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: The new network object (<name>): device ID (<id>) does not match the rule key device ID (<id>). The device IDs must be the same.
400: Device ID is required for a new device network object
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <name>
400: Network Object appears more than once in same rule modification action: Check <source / destination> for <st_uid>
400: <cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty.
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
403: Task can not be done because there are unlicensed devices for change automation
400: Invalid value for field: <FIELD_NAME> (Device ID is required for an existing device network object)
400: Invalid value for field: <FIELD_NAME> (ST UID is required for an existing device network object
400: Invalid value for field: <FIELD_NAME> (Network Object with device ID <DEVICE_ID> and ST UID <ST_UID> is not available for the action specified. Check the Knowledge Center or API Implementation Notes for more information
400: Status is required for a device network object"},"response":[]},{"name":"Returns the details of the tasks","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID."},"response":[]}]}]} \ No newline at end of file diff --git a/Postman Format v2/R19-3 postman collection/securetrack_R19-3-GA-v2.json b/Postman Format v2/R19-3 postman collection/securetrack_R19-3-GA-v2.json new file mode 100644 index 0000000..f9b5f91 --- /dev/null +++ b/Postman Format v2/R19-3 postman collection/securetrack_R19-3-GA-v2.json @@ -0,0 +1 @@ +{"info":{"_postman_id":"1","name":"Tufin Tufin SecureTrack R19-3-GA","description":"Tufin Orchestration Suite - Tufin SecureTrack APIs.
For detailed information about the APIs please see the documentation at:
https://your-securetrack-server/securetrack/apidoc","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json"},"item":[{"name":"Additional Policy Fields","item":[{"name":"Get all URL Categories by revision.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/url_categories","description":"Fetches list of URL Categories defined in a revision given by ID.
This API is supported for Panorama in advanced mode and Panorama Device Groups.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/762/url_categories
"},"response":[]},{"name":"Get additional parameters identities by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/additional_parameters","description":"Some firewall vendors use special fields in their security policy.
For example: Palo Alto uses Tags, Security Profiles and Log Profiles and Fortinet uses NAT Pools and other NAT configurations.
SecureTrack refers to these fields as “Additional Parameters”.
The additional parameters API retrieves the possible values of these fields.
This API is currently supported for Palo Alto Networks firewalls and Fortinet devices managed by Fortimanager.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
type: Additional parameter type [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/162/additional_parameters?type=security_profile_group

Response Messages:
200: Successful
400: Invalid request"},"response":[]},{"name":"Get specific additional parameter identity","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/additional_parameters/{{ids}}","description":"Some firewall vendors use special fields in their security policy.
For example: Palo Alto uses Tags, Security Profiles and Log Profiles and Fortinet uses NAT Pools and other NAT configurations.
SecureTrack refers to these fields as “Additional Parameters”.
The additional parameters API retrieves the possible values of these fields.
This API is currently supported for Palo Alto Networks firewalls and Fortinet devices managed by Fortimanager.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Additional parameter IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/revisions/162/additional_parameters/242767,242768,242760
"},"response":[]},{"name":"Get a URL Category.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/url_categories/{{ids}}","description":"Fetches one or more URL Categories.
This API is supported for Panorama in advanced mode and Panorama Device Groups.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Url Category IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/revisions/762/url_categories/242767,242768,242760
"},"response":[]}]},{"name":"Application IDs","item":[{"name":"Get specific application identity","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/applications/{{ids}}","description":"Fetches one or more applications defined by a device ID and Application Id or comma separated applications ids list.
This API is currently supported for Palo Alto Networks firewalls.
Note: This API retrieves the information from the latest revision.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.


Parameters:
context: Global MSSP context [optional]
id: Device ID
ids: Application IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/devices/1/applications/701
"},"response":[]},{"name":"Get application identities by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/applications","description":"Fetches list of applications defined on device given by ID.
This API is currently supported for Palo Alto Networks firewalls.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.
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.


Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable values are numeric [optional]
count: Number of pages for query allowable values are numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/applications?get_total=true
OUTPUT {
    \"applications\": {
        \"count\": 50,
        \"total\": 100,
        \"application\": [{
            \"@xsi.type\": \"singleApplicationDTO\",
            \"id\": 2095027,
            \"name\": \"any\",
            \"display_name\": \"any\",
            \"class_name\": \"application_object\",
            \"comment\": \"\",
            \"uid\": \"{61B7771C-8B0B-90D6-ED55-B6698691BEED}\",
            \"overrides\": false,
            \"service\": {
                \"id\": 5048925,
                \"uid\": \"{4BC8F8B5-7671-A61B-5DD2-8CA235955162}\",
                \"display_name\": \"any\",
                \"name\": \"any\"
            }
        }]
    }
}

"},"response":[]},{"name":"Get specific application identity","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/applications/{{ids}}","description":"Fetches one or more applications defined by a revision ID and Application Id or comma separated applications ids list.
This API is currently supported for Palo Alto Networks firewalls.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.


Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Application IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/revisions/762/applications/242767,242768,242760
"},"response":[]},{"name":"Get applications identities by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/applications","description":"Fetches list of applications defined in a revision given by ID.
This API is currently supported for Palo Alto Networks firewalls.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.
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.


Parameters:
context: Global MSSP context [optional]
id: Revision id
start: Starting page for query allowable value is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/762/applications?get_total=true
OUTPUT {
    \"applications\": {
        \"count\": 1,
        \"total\": 100,
        \"application\": [{
            \"@xsi.type\": \"singleApplicationDTO\",
            \"id\": 2095027,
            \"name\": \"any\",
            \"display_name\": \"any\",
            \"class_name\": \"application_object\",
            \"comment\": \"\",
            \"uid\": \"{61B7771C-8B0B-90D6-ED55-B6698691BEED}\",
            \"overrides\": false,
            \"service\": {
                \"id\": 5048925,
                \"uid\": \"{4BC8F8B5-7671-A61B-5DD2-8CA235955162}\",
                \"display_name\": \"any\",
                \"name\": \"any\"
            }
        }]
    }
}

"},"response":[]}]},{"name":"Change Authorization","item":[{"name":"Determine if changes between two revisions are authorized","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"new_version"},{"value":null,"type":"text","key":"old_version"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/change_authorization/","description":"This API checks for unauthorized changes between any two versions of a firewall policy.
The API returns authorized if and only if all traffic changes between the two versions were authorized by SecureChange tickets.
The API returns unauthorized if there is at least one change that cannot be matched to a SecureChange ticket.

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).
The API returns the authorization status, the relevant tickets in SecureChange and the rules that implement unauthorized access changes.

Note 1: To use this API you must enable “Authorize Revisions with Tickets” in SecureTrack/Configuration/Ticketing.
Note 2: Use the ID returned by the /revisions API for new_version and old_version.
Note 3: The default value for traffic_details and ignore_tickets is false.
Note 4: Traffic that is handled by an implicit rule will not have a rule ID.

Parameters:
new_version: New version ID
old_version: Old version ID
traffic_details: Return unauthorized traffic change details for all modified rules [optional]
ignore_tickets: Ignore SecureChange tickets and consider all traffic changes unauthorized [optional]

Usage Example
https://192.168.1.1/securetrack/api/change_authorization?old_version=1&new_version=2

Usage Example
https://192.168.1.1/securetrack/api/change_authorization?old_version=1&new_version=2&traffic_details=true&ignore_tickets=true

Response Messages:
200: Change authorization has been successfully calculated
400: Input parameters are not valid
400: Could not find the requested revisions for comparison"},"response":[]},{"name":"Compare revisions on two different devices in terms of traffic.","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"policy_traffic_comparison_request\": {\n\t\t\"oldVersionId\": \"234\",\n\t\t\"newVersionId\": \"179\",\n\t\t\"oldId2newIdMap\": [\n\t\t\t{\n\t\t\t\t\"oldId\": \"{037DEA62-A8D2-46F5-8DC9-DA404A60B96F}\",\n\t\t\t\t\"newId\" : \"{00-FACED0-00}\"\n\t\t\t}\n\t\t],\n\t\t\"withTraffic\": true\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/change_authorization/policyTrafficComparison","description":"This API compares two arbitrary revisions from any devices. The comparison will be done in terms of allowed/denied traffic.
The API returns authorized if and only if there are no differences between the traffic allowed/denied by the rules in the two revisions.
The API returns unauthorized if there is at least one difference in terms of allowed/denied traffic between the two revisions.
Note 1: To map policies from one revision to the other use oldId2newIdMap and provide the UIDs of the policies to be compared.
Note 2: Parameter in the request body specifies if the result will return traffic difference details for all incompatible rules
Note 3: The format of the result is the same as the one returned by /change_authorization
Note 4: The API accepts in request body only one pair of oldId - newId map
Note 5: The request is valid only if the mapping ids are found in the active policies

Parameters:
body: Request parameter containing the versions of the revisions to be compared and the policy mapping between the revisions.

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_authorization/policyTrafficComparison
BODY{
    \"policy_traffic_comparison_request\": {
        \"oldVersionId\": \"234\",
        \"newVersionId\": \"179\",
        \"oldId2newIdMap\": [
            {
                \"oldId\": \"{037DEA62-A8D2-46F5-8DC9-DA404A60B96F}\",
                \"newId\" : \"{00-FACED0-00}\"
            }
        ],
        \"withTraffic\": true
    }
}


Response Messages:
200: Policies diff was successfully calculated
400: Could not find the requested revisions for comparison"},"response":[]}]},{"name":"Change Windows","item":[{"name":"Get name and status for all change windows","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/change_windows/","description":"Retrieves a list of all change windows.
For valid pagination, both start and count should be provided. Otherwise, pagination is turned off.
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.


Parameters:
context: Global MSSP context [optional]
start: Starting result for query allowable value is numeric [optional]
count: Number of change windows for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_windows?start=0&count=50&get_total=true
OUTPUT {
    \"change_windows\": {
        \"count\": 2,
        \"total\": 2,
        \"change_window\": [
            {
                \"uuid\": \"6ae41504-a95c-4f23-98a2-f18b2efadb9d\",
                \"name\": \"cw1\",
                \"domain_id\": 1,
                \"enabled\": true
            },
            {
                \"uuid\": \"fc7b167c-29ea-49a1-9ee3-efb6d1351343\",
                \"name\": \"cw2\",
                \"domain_id\": 1,
                \"enabled\": true
            }
        ]
    }
}


Response Messages:
200: OK
400: For correct pagination provide a value for the start and count parameters
400: Start parameter must be a non-negative value
400: Count parameter must be a positive value
401: Not permitted to access this context "},"response":[]},{"name":"Get scheduling and device details for a specific change window","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"uid"},{"value":null,"type":"text","key":"task_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/change_windows/{{uid}}/tasks/{{task_id}}","description":"Retrieves scheduling and device details for a specific change window.

Parameters:
context: Global MSSP context [optional]
uid: Change window uuid
task_id: Task Id

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_windows/fc7b167c-29ea-49a1-9ee3-efb6d1351343/tasks/1
OUTPUT {
    \"commit_task\": {
        \"id\": 1,
        \"start_date\": \"04-Nov-2018 01:30:00PM +0200\",
        \"end_date\": \"04-Nov-2018 01:32:01PM +0200\",
        \"errors\": \"\",
        \"device_commits\": {
            \"device_commit\": [
                {
                    \"id\": 1,
                    \"result\": {
                        \"errors\": {
                            \"error\": \"got_error_from_dcs\"
                        },
                        \"device\": {
                            \"id\": 17,
                            \"status\": \"FAILURE\",
                            \"revision_id\": 1,
                            \"errors\": {
                                \"error\": \"Login error\"
                            }
                        }
                    }
                },
                {
                    \"id\": 2,
                    \"result\": {
                        \"errors\": \"\",
                        \"device\": {
                            \"id\": 19,
                            \"status\": \"SUCCESS_WITH_WARNINGS\",
                            \"revision_id\": 1,
                            \"warnings\": {
                                \"warning\": \"Commit not performed: This device had no policies to install on its managed firewalls\"
                            }
                        }
                    }
                }
            ]
        }
    }
}


Response Messages:
200: OK
400: For correct pagination provide a value for the start and count parameters
400: Start parameter must be a non-negative value
400: Count parameter must be a positive value
401: Not permitted to access this context
404: Change window with uuid was not found
404: Change window with uuid was not found in domain
404: Fail to find task for change window "},"response":[]},{"name":"Get a list of completed policy changes for a specific change window","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"uid"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/change_windows/{{uid}}/tasks","description":"Retrieves a list of completed policy changes for a specific change window.
For valid pagination, both start and count should be provided. Otherwise, pagination is turned off.
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.


Parameters:
context: Global MSSP context [optional]
uid: Change window uuid
start: Starting result for query allowable value is numeric [optional]
count: Number of tasks for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_windows/fc7b167c-29ea-49a1-9ee3-efb6d1351343/tasks?start=0&count=50&get_total=true
OUTPUT {
    \"commit_tasks\": {
        \"count\": 1,
        \"total\": 1,
        \"commit_task\": {
            \"id\": 1,
            \"start_date\": \"04-Nov-2018 01:30:00PM +0200\",
            \"end_date\": \"04-Nov-2018 01:32:01PM +0200\",
            \"errors\": \"\"
        }
    }
}


Response Messages:
200: OK
400: For correct pagination provide a value for the start and count parameters
400: Start parameter must be a non-negative value
400: Count parameter must be a positive value
401: Not permitted to access this context
404: Change window with uuid was not found
404: Change window with uuid was not found in domain "},"response":[]}]},{"name":"Device Interfaces and Zones","item":[{"name":"Get network interfaces by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/interfaces","description":"Reflects static data from the running-config.
For dynamic information see the /topology_interfaces API.
This API is not applicable for Check Point.

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/10/interfaces
"},"response":[]},{"name":"Get network interfaces by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/interfaces","description":"Reflects static data from the running-config.
For dynamic information see the /topology_interfaces API.
This API is not applicable for Check Point.

Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/227/interfaces
"},"response":[]},{"name":"Get device zones by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/zones","description":"Returns a list of the zones for the specified Juniper, Stonesoft, Fortinet or Palo Alto Networks revision.
Note: this API returns device zones, not Tufin zones.

Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/787/zones
"},"response":[]},{"name":"Get zones and network interfaces that participate in sub-policies","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/bindable_objects","description":"Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/104/bindable_objects
"},"response":[]},{"name":"Get device zones by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/zones","description":"Returns a list of the zones for the specified Juniper, Stonesoft, Fortinet or Palo Alto Networks device.
Note: this API returns device zones, not Tufin zones.

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/104/zones
"},"response":[]}]},{"name":"Domains","item":[{"name":"Get domain","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/domains/{{id}}","description":"Parameters:
context: Global MSSP context [optional]
id: Domain id

Usage Example
https://192.168.1.1/securetrack/api/domains/1

Response Messages:
401: User not permitted to access domains
400: Domain with ID was not found"},"response":[]},{"name":"Update a domain","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/domains/{{id}}","description":"Parameters:
id: Domain id
body [optional]

Usage Example
https://192.168.1.1/securetrack/api/domains/1

Response Messages:
401: User not permitted to access domains
400: Domain with ID was not found
400: Domain with this name already exists
400: Domain name is empty
400: Default domain cannot be changed"},"response":[]},{"name":"Get all domains","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/domains/","description":"

Usage Example
https://192.168.1.1/securetrack/api/domains

Response Messages:
401: User not permitted to access domains"},"response":[]},{"name":"Add a domain","request":{"method":"POST","header":[],"url":"https://{{SecureTrack_IP}}/securetrack/api/domains/","description":"Parameters:
body [optional]

Usage Example
https://192.168.1.1/securetrack/api/domains

Response Messages:
401: User not permitted to access domains
400: Domain with this name already exists
400: Domain name is empty"},"response":[]}]},{"name":"General Properties","item":[{"name":"Get general properties","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/properties/","description":"

Usage Example
URLhttps://192.168.1.1/securetrack/api/properties
OUTPUT{
    \"properties\": {
        \"sc_addresses\": {
            \"sc_address\": [
                {
                    \"ip_address\": \"127.0.0.1\",
                    \"type\": \"external\"
                },
                {
                    \"ip_address\": \"127.0.0.1\",
                    \"type\": \"internal\"
                }
            ]
        }
    }
}


Response Messages:
401: User not permitted to view properties"},"response":[]}]},{"name":"IPsec VPN","item":[{"name":"Get Cisco cryptographic maps by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/crypto_maps","description":"Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://191.168.1.1/securetrack/api/revisions/18/crypto_maps
"},"response":[]},{"name":"Get Cisco IPsec policy and peers","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"outputInterfaceName"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/ipsec_tunnels","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.
You can retrieve the interface names by calling the /devices/id/interfaces API.

Parameters:
device_id: The unique identifier of target device
outputInterfaceName: Interface name

Usage Example
https://192.168.1.1/securetrack/api/bindings/32/ipsec_tunnels?outputInterfaceName=GigabitEthernet1
"},"response":[]},{"name":"Get Check Point VPN (IPSec) communities and gateways","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/ipsec_communities","description":"Get Check Point VPN (IPSec) Communities and gateways that partcipant in those communities.
Works on clusters and gateways, not on management servers.

Parameters:
device_id: The unique identifier of target device

Usage Example
https://192.168.1.1/securetrack/api/bindings/20/ipsec_communities
"},"response":[]},{"name":"Get Cisco cryptographic maps by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/crypto_maps","description":"Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/19/crypto_maps
"},"response":[]}]},{"name":"Internet Objects","item":[{"name":"Create new Internet representation for a device","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"internet_referral\": {\n\t\t\"@xsi.type\": \"internetReferralObjectNameDTO\",\n\t\t\"device_id\": 2,\n\t\t\"object_name\": \"Host_2.2.2.2\"\n\t}\n}\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/","description":"The internet referral lets you represent the Internet as an object on a device.
See REST API: /internet_referral/{deviceId:[0-9]+}/object for a description of how internet referral is resolved.

Parameters:
body: Internet referral configuration

Usage Example
URLhttps://192.168.1.1/securetrack/api/internet_referral
BODY{
    \"internet_referral\": {
        \"@xsi.type\": \"internetReferralObjectNameDTO\",
        \"device_id\": 2,
        \"object_name\": \"Host_2.2.2.2\"
    }
}


Response Messages:
201: Internet referral configuration was created
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
400: Internet referral configuration was malformed
400: Internet referral configuration for given device ID already exists
401: Access is denied."},"response":[]},{"name":"Delete Internet representation for device","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"deviceId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}","description":"Parameters:
deviceId: SecureTrack Device ID

Usage Example
https://192.168.1.1/securetrack/api/internet_referral/2

Response Messages:
200: Internet referral configuration was deleted
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
400: Internet referral configuration for device ID does not exist
401: Access is denied."},"response":[]},{"name":"Get Internet representation for device","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"deviceId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}","description":"Parameters:
deviceId: SecureTrack Device ID

Usage Example
https://192.168.1.1/securetrack/api/internet_referral/2

Response Messages:
200: Internet referral configuration is returned
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
404: Internet referral configuration was not found for device ID
401: Access is denied."},"response":[]},{"name":"Update Internet representation for device","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"internet_referral\": {\n\t\t\"@xsi.type\": \"internetReferralObjectNameDTO\",\n\t\t\"device_id\": 2,\n\t\t\"object_name\": \"Host_10.11.73.1\"\n\t}\n}\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}","description":"Updates the Internet referral configuration for the device.
If there was no previous configuration, it will be created.

Parameters:
deviceId: SecureTrack Device ID
body: Internet referral configuration

Usage Example
URLhttps://192.168.1.1/securetrack/api/internet_referral
BODY{
    \"internet_referral\": {
        \"@xsi.type\": \"internetReferralObjectNameDTO\",
        \"device_id\": 2,
        \"object_name\": \"Host_10.11.73.1\"
    }
}


Response Messages:
200: Internet referral configuration was updated
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
400: Internet referral configuration was malformed
401: Access is denied."},"response":[]},{"name":"Get resolved Internet representation for device","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"deviceId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}/object","description":"The order of precedence used to resolve the Internet object is:
Step 1: Identify the Internet referral:
Search for a defined Internet referral on the specified device.
If it is not found on the device, search the parent and grandparents (up the device tree) for a defined Internet referral.
If a defined Internet referral is found, then match the name in the Internet referral to a network object, as defined in Step 2.
If an Internet referral is not found, it resolves to “Any”.
Step 2: Resolve the object by name:
Search the specified device for a defined network object that matches the name returned in Step 1.
If a matching network object is not found, an error will be returned.

Parameters:
deviceId: SecureTrack Device ID

Usage Example
https://192.168.1.1/securetrack/api/internet_referral/2/object

Response Messages:
200: Resolved Internet referral object for device is returned
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
404: Configured object was not found on the device
401: Access is denied."},"response":[]}]},{"name":"LDAP","item":[{"name":"Get the base DN entry details","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/getBaseDNEntry","description":"The returned \"base DN\" is used by GetEntriesByNames API as the search start entry.



Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/getBaseDNEntry
OUTPUT{
    \"ldap_entry\": {
        \"dn\": \"DC=tufintest,DC=com\",
        \"uid\": \"nABbRP/lPUKlteNRI4j6iA==\"
    }
}


Response Messages:
200: OK
404: Base Entry cannot be found
501: LDAP server is not configured
503: No connection to LDAP server"},"response":[]},{"name":"Return LDAP entries which match the given search criteria","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"search_criteria\": {\n\t\t\"search_base_dn\": \"DC=tufintest,DC=com\",\n\t\t\"search_text\": \"test\",\n\t\t\"ldap_search_options\": {\n\t\t\t\"ldap_entry_types\": {\n\t\t\t\t\"ldap_entry_type\": [\n\t\t\t\t\t\"OU\",\n\t\t\t\t\t\"USER\"\n\t\t\t\t]\n\t\t\t},\n\t\t\t\"search_mode\": \"CONTAINS\",\n\t\t\t\"max_search_result\": 3\n\t\t}\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/search","description":"Return list of LDAP entries which match the given search criteria according to the search mode (EXACT, CONTAINS, STARTS_WITH, ENDS_WITH).
The search is case insensitive.
The limit of max_search_result is 1000.

Parameters:
body: Search criteria

Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/search
BODY{
    \"search_criteria\": {
        \"search_base_dn\": \"DC=tufintest,DC=com\",
        \"search_text\": \"test\",
        \"ldap_search_options\": {
            \"ldap_entry_types\": {
                \"ldap_entry_type\": [
                    \"OU\",
                    \"USER\"
                ]
            },
            \"search_mode\": \"CONTAINS\",
            \"max_search_result\": 3
        }
    }
}
OUTPUT{
    \"search_result\": {
        \"ldap_entries\": {
            \"ldap_entry\": [
            {
                \"dn\": \"CN=User15ATTesting1,OU=Testing1,OU=new OU,OU=SC_Users,DC=tufintest,DC=com\",
                \"uid\": \"ZRuKW3XqIEOIxCwlfgJQYA==\",
                \"displayName\": \"User15ATTesting1\"
            },
            {
                \"dn\": \"CN=IWAM_TEST2003,CN=Users,DC=tufintest,DC=com\",
                \"uid\": \"bYVqqcZXsUSF51hiP4W7Yw==\",
                \"displayName\": \"Testing1\"
            },
            {
                \"dn\": \"CN=User1ATTesting1,OU=Testing1,OU=new OU,OU=SC_Users,DC=tufintest,DC=com\",
                \"uid\": \"2ma3TrgeHEWQDITwvcRqlg==\",
                \"displayName\": \"test\"
            }
            ]
        },
            \"has_more_results_to_return\": \"true\"
        }
}


Response Messages:
200: OK
400: Bad request (one of the request fields has an illegal or invalid value)
501: LDAP server is not configured
503: No connection to LDAP server"},"response":[]},{"name":"Return entries that exactly match one of the given strings","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"search_by_name_criteria\": {\n\t\t\"search_texts\": {\n\t\t\t\"search_text\": [\n\t\t\t\t\"Finance\",\n\t\t\t\t\"Marketing\",\n\t\t\t\t\"Management\"\n\t\t\t]\n\t\t},\n\t\t\"ldap_entry_types\": {\n\t\t\t\"ldap_entry_type\": [\n\t\t\t\t\"GROUP\"\n\t\t\t]\n\t\t},\n\t\t\"max_search_result\": 20\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/getEntriesByNames","description":"Return list of LDAP entries which match the exact given multiple search_text.

Parameters:
body: Names to search

Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/getEntriesByNames
BODY{
    \"search_by_name_criteria\": {
        \"search_texts\": {
            \"search_text\": [
                \"Finance\",
                \"Marketing\",
                \"Management\"
            ]
        },
        \"ldap_entry_types\": {
            \"ldap_entry_type\": [
                \"GROUP\"
            ]
        },
        \"max_search_result\": 20
    }
}
OUTPUT{
    \"search_result\": {
        \"ldap_entries\": {
            \"ldap_entry\": [
                {
                    \"@xsi.type\": \"LdapGroup\",
                    \"dn\": \"CN=Finance,OU=SecureTrack,DC=tufintest,DC=com\",
                    \"uid\": \"uOvJTpYRD0aTjEENA87N5A==\",
                    \"displayName\": \"Finance\"
                },
                {
                    \"@xsi.type\": \"LdapGroup\",
                    \"dn\": \"CN=Management,OU=SecureTrack,DC=tufintest,DC=com\",
                    \"uid\": \"jdf778skfsgs730fksdHHs==\",
                    \"displayName\": \"Management\"
                }
            ]
        },
        \"has_more_results_to_return\": false
    }
}


Response Messages:
200: OK
400: Bad request (one of the request fields has an illegal value)
501: LDAP server is not configured
503: No connection to LDAP server"},"response":[]},{"name":"Get LDAP entry details by DN","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"dn"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/getEntryByDN","description":"Returns the UID, DN and Name of a LDAP entry specified by the DN.

Parameters:
dn: LDAP DN

Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/getEntryByDN?dn=CN=Manufacturing,OU=RSA_Demo,DC=tufintest,DC=com
OUTPUT{
    \"ldap_entry\": {
        \"uid\": \"mYbWQms7p0q5YinEyW5Byw==\",
        \"dn\": \"CN=Manufacturing,OU=RSA_Demo,DC=tufintest,DC=com\",
        \"name\": \"Manufacturing\"
    }
}


Response Messages:
200: OK
400: Invalid DN format
404: Entry matching the DN cannot be found
501: LDAP server is not configured
503: No connection to LDAP server"},"response":[]}]},{"name":"Monitored Devices","item":[{"name":"Get textual configuration by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/config","description":"Returns textual configuration for the specified revision Id.


Parameters:
context: Global MSSP context [optional]
id: Revision id

Usage Example
https://192.168.1.1/securetrack/api/revisions/227/config
"},"response":[]},{"name":"Get devices","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/","description":"Returns the list of devices that are configured in SecureTrack, including the vendor, model, name, domain and device ID.
The results can be sorted by ip, name, vendor and model.
For more information on supported devices, supported models and virtual types please refer to 'Device and Revision Resources' section in the Tufin Knowledge Center .

Parameters:
context: Global MSSP context [optional]
name: Device name [optional]
ip: Device IP address [optional]
vendor: Device vendor [optional]
model: Device model [optional]
sort: Sort ascending or descending allowable types are: asc or desc [optional]
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query starting from starting page allowable type in numeric [optional]
show_os_version: Show os version as apart of the response [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices

Usage Example
https://192.168.1.1/securetrack/api/devices?vendor=VMware

Usage Example
https://192.168.1.1/securetrack/api/devices?sort=ip:asc

Usage Example
https://192.168.1.1/securetrack/api/devices?show_os_version=true
"},"response":[]},{"name":"Add offline device","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t asa \n\t Cisco\n\t 1\n\t Default\n\t API OFFLINE ASA1\n\t true\n\t true\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/","description":"You can choose to select the domain either by name or id using the domain_id or domain_name tags.\nDevice name should contain only Lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^()

Parameters:
body: Device to be added

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices
BODY<device>
     <model>asa</model>
     <vendor>Cisco</vendor>
     <domain_id>1</domain_id>
     <domain_name>Default</domain_name>
     <name>API OFFLINE ASA1</name>
     <offline>true</offline>
     <topology>true</topology>
</device>

"},"response":[]},{"name":"Get textual configuration by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/config","description":"Get latest revision of running configuration for a given device Id.


Parameters:
context: global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/111/config
"},"response":[]},{"name":"Edit Securetrack device","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \n \t \"devices_list\":{ \n\t\t \"devices\": [{\n\t\t\t \"device_id\": 1,\n\t\t\t \"display_name\": \"CheckPoint-R77-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"ip_address\": \"1.1.1.1\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"opsec_application\": \"ST-Opsec\",\n\t\t\t\t \"activation_key\": \"ST-Activation\",\n\t\t\t\t \"authentication_mode\": \"LEA\",\n\t\t\t\t \"lea_authentication_mode\": \"ssl_opsec\",\n\t\t\t\t \"lea_authentication_port\": \"2488\",\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 2,\n\t\t\t \"display_name\": \"CheckPoint-R80-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"ip_address\": \"1.1.1.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"opsec_application\": \"ST-Opsec\",\n\t\t\t\t \"activation_key\": \"ST-Activation\",\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\",\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 3,\n\t\t\t \"display_name\": \"Cisco-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"ip_address\": \"2.2.2.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\",\n\t\t\t\t \"enable_password\": \"st-super-password\",\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 4,\n\t\t\t \"display_name\": \"PaloAlto-PanoramaNg-Device\",\n\t\t\t \"ip_address\": \"2.2.2.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 5,\n\t\t\t \"display_name\": \"PaloAlto-DeviceGroup\"\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 6,\n\t\t\t \"display_name\": \"PaloAlto-FireWall-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_dynamic_topology\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 7,\n\t\t\t \"display_name\": \"Spain-FortiManager\",\n\t\t\t \"ip_address\": \"2.2.2.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 8,\n\t\t\t \"display_name\": \"FortiManager-Adom\"\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 9,\n\t\t\t \"display_name\": \"FortiManager-FireWall\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_dynamic_topology\": \"true\"\n\t\t\t }\n\t\t }\n\t\t]\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/","description":"Use this API to edit the settings of a management device, including changing multiple parameters in the same call.
The API body should include a JSON file with the mandatory parameters for the operation.
String parameters contain only lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^().
The following devices can be added: Check Point CMA R77, CMA R80, SMC R77, SMC R80; Cisco ASA; Palo Alto Panorama NG; Fortinet FortiManager.
Note: This API cannot be used to edit SecureTrack Domains and SecureTrack Servers.
This API verifies connection to the provided device, before updating a device.
This is done by:
  Cisco - Connect with SSH and see that the credentials are correct.
  Check Point - Test OPSEC connectivity. For R80 devices, this also verifies the connectivity for API login.
  Panorama - Login through the API to check connectivity.
  Fortimanager - Login through the API to check connectivity.
If the connection test fails the device will not be updated.
Only \"live\" device with correct credentials can be updated using this API.

Parameters:
body: device_list

Usage Example
URL https://192.168.1.1/securetrack/api/devices/bulk
BODY{
     \"devices_list\":{
         \"devices\": [{
             \"device_id\": 1,
             \"display_name\": \"CheckPoint-R77-Device\",
             \"enable_topology\": \"true\",
             \"ip_address\": \"1.1.1.1\",
             \"device_data\": {
                 \"opsec_application\": \"ST-Opsec\",
                 \"activation_key\": \"ST-Activation\",
                 \"authentication_mode\": \"LEA\",
                 \"lea_authentication_mode\": \"ssl_opsec\",
                 \"lea_authentication_port\": \"2488\",
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\"
             }
         },
         {
             \"device_id\": 2,
             \"display_name\": \"CheckPoint-R80-Device\",
             \"enable_topology\": \"true\",
             \"ip_address\": \"1.1.1.2\",
             \"device_data\": {
                 \"opsec_application\": \"ST-Opsec\",
                 \"activation_key\": \"ST-Activation\",
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\",
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\"
             }
         },
         {
             \"device_id\": 3,
             \"display_name\": \"Cisco-Device\",
             \"enable_topology\": \"true\",
             \"ip_address\": \"2.2.2.2\",
             \"device_data\": {
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\",
                 \"enable_password\": \"st-super-password\",
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\"
             }
         },
         {
             \"device_id\": 4,
             \"display_name\": \"PaloAlto-PanoramaNg-Device\",
             \"ip_address\": \"2.2.2.2\",
             \"device_data\": {
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\"
             }
         },
         {
             \"device_id\": 5,
             \"display_name\": \"PaloAlto-DeviceGroup\"
         },
         {
             \"device_id\": 6,
             \"display_name\": \"PaloAlto-FireWall-Device\",
             \"enable_topology\": \"true\",
             \"device_data\": {
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\",
                 \"collect_dynamic_topology\": \"true\"
             }
         },
         {
             \"device_id\": 7,
             \"display_name\": \"Spain-FortiManager\",
             \"ip_address\": \"2.2.2.2\",
             \"device_data\": {
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\"
             }
         },
         {
             \"device_id\": 8,
             \"display_name\": \"FortiManager-Adom\"
         },
         {
             \"device_id\": 9,
             \"display_name\": \"FortiManager-FireWall\",
             \"enable_topology\": \"true\",
             \"device_data\": {
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\",
                 \"collect_dynamic_topology\": \"true\"
             }
         }
        ]
    }
}


Response Messages:
202: Accepted
408: Request timed out
500: Internal server error
503: Task with UID already running"},"response":[]},{"name":"Add devices to SecureTrack","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \n \t \"devices_list\":{ \n \t\t \"devices\": [{ \n \t\t\t \"model\":\"CMA\",\n \t\t\t \"vendor\":\"Checkpoint\",\n \t\t\t \"display_name\":\"Europe-CMA\",\n \t\t\t \"ip_address\":\"192.168.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"securetrack_domain\":\"Default\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"lea_authentication_port\":\"65000\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"opsec_application\":\"ST-Opsec\",\n \t\t\t\t \"activation_key\":\"ST-Activation\",\n \t\t\t\t \"r80_version\":\"false\"\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"model\":\"CMA\",\n \t\t\t \"vendor\":\"Checkpoint\",\n \t\t\t \"display_name\":\"Europe-CMA\",\n \t\t\t \"ip_address\":\"192.168.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"securetrack_domain\":\"Default\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"lea_authentication_port\":\"65000\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"opsec_application\":\"ST-Opsec\",\n \t\t\t\t \"activation_key\":\"ST-Activation\",\n \t\t\t\t \"user_name\":\"admin\",\n \t\t\t\t \"password\":\"1234\",\n \t\t\t\t \"r80_version\":\"true\"\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"model\":\"ASA\",\n \t\t\t \"vendor\":\"Cisco\",\n \t\t\t \"securetrack_domain\":\"Domain-A\",\n \t\t\t \"display_name\":\"Ireland-ASA\",\n \t\t\t \"ip_address\":\"172.16.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t \"enable_virtual_contexts\":\"true\",\n \t\t\t \"import_all\":\"false\",\n \t\t\t \"import_devices\": \n \t\t\t\t\t [\"VC1\",\"VC2\"],\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"false\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"user_name\":\"St-Super-use\",\n \t\t\t\t \"password\":\"st-super-password\",\n \t\t\t\t \"enable_password\":\"st-enable-password\"\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"model\":\"Panorama\",\n \t\t\t \"vendor\":\"PaloAltoNetworks\",\n \t\t\t \"display_name\":\"First-Device-example\",\n \t\t\t \"ip_address\":\"172.16.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"user_name\":\"St-Super-use\",\n \t\t\t\t \"password\":\"st-super-password\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"import_devices\":[\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG1\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"] \n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG2\",\n \t\t\t\t\t\t \"import_all\":\"true\"\n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG3\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [] \n \t\t\t\t\t }\n \t\t\t\t ]\n \t\t\t }\n \t\t },\n \t\t {\n \t\t\t \"model\":\"FortiManager\",\n \t\t\t \"vendor\":\"Fortinet\",\n \t\t\t \"display_name\":\"Spain-FortiManager\",\n \t\t\t \"securetrack_server\":\"RemoteControlServerName\",\n \t\t\t \"ip_address\":\"172.16.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"false\",\n \t\t\t\t \"user_name\":\"St-Super-use\",\n \t\t\t\t \"password\":\"st-super-password\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"import_all\": \"false\",\n \t\t\t\t \"import_devices\": [\n \t\t\t\t\t\t { \n \t\t\t\t \"name\": \"AdomX\",\n \t\t\t\t \"import_all\": \"false\", \n \t\t\t\t \"managed_devices\": [\"FW1\"]\n \t\t\t\t\t\t}\n \t\t\t\t\t]\n \t\t\t\t}\n \t\t\t}\n \t\t]\n \t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/","description":"Use this API to add a single device or a list of devices to SecureTrack.
The following devices can be added: Check Point CMA R77, CMA R80, SMC R77, SMC R80; Cisco ASA; Palo Alto Panorama NG; Fortinet FortiManager.
The API body should include a JSON file with the mandatory parameters for the operation.
String parameters contain only lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^().
Currently supported types: CMA, SMC, ASA, Panorama NG and FortiManager.

This API verifies connection to the provided device, before adding a device.
This is done by:
  Cisco - Connect with SSH and see that the credentials are correct.
  Check Point - Test OPSEC connectivity. For R80 devices, this also verifies the connectivity for API login.
  Panorama - Login through the API to check connectivity.
  Fortimanager - Login through the API to check connectivity.
If the connection test fails the device will not be added.
Only \"live\" device with correct credentials can be added using this API.
To add Checkpoint R77 devices, use \"r80_version\" : \"false\".


Parameters:
body: device_list

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/bulk
BODY{
     \"devices_list\":{
         \"devices\": [{
             \"model\":\"CMA\",
             \"vendor\":\"Checkpoint\",
             \"display_name\":\"Europe-CMA\",
             \"ip_address\":\"192.168.1.1\",
             \"enable_topology\": \"true\",
             \"securetrack_domain\":\"Default\",
             \"device_data\":{
                 \"lea_authentication_port\":\"65000\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"opsec_application\":\"ST-Opsec\",
                 \"activation_key\":\"ST-Activation\",
                 \"r80_version\":\"false\"
             }
         },
         {
             \"model\":\"CMA\",
             \"vendor\":\"Checkpoint\",
             \"display_name\":\"Europe-CMA\",
             \"ip_address\":\"192.168.1.1\",
             \"enable_topology\": \"true\",
             \"securetrack_domain\":\"Default\",
             \"device_data\":{
                 \"lea_authentication_port\":\"65000\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"opsec_application\":\"ST-Opsec\",
                 \"activation_key\":\"ST-Activation\",
                 \"user_name\":\"admin\",
                 \"password\":\"1234\",
                 \"r80_version\":\"true\"
             }
         },
         {
             \"model\":\"ASA\",
             \"vendor\":\"Cisco\",
             \"securetrack_domain\":\"Domain-A\",
             \"display_name\":\"Ireland-ASA\",
             \"ip_address\":\"172.16.1.1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
             \"enable_virtual_contexts\":\"true\",
             \"import_all\":\"false\",
             \"import_devices\":
                     [\"VC1\",\"VC2\"],
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"false\",
                 \"collect_dynamic_topology\":\"false\",
                 \"user_name\":\"St-Super-use\",
                 \"password\":\"st-super-password\",
                 \"enable_password\":\"st-enable-password\"
             }
         },
         {
             \"model\":\"Panorama\",
             \"vendor\":\"PaloAltoNetworks\",
             \"display_name\":\"First-Device-example\",
             \"ip_address\":\"172.16.1.1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"user_name\":\"St-Super-use\",
                 \"password\":\"st-super-password\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"collect_dynamic_topology\":\"false\",
                 \"import_devices\":[
                     {
                         \"name\":\"DG1\",
                         \"import_all\":\"false\",
                         \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"]
                     },
                     {
                         \"name\":\"DG2\",
                         \"import_all\":\"true\"
                     },
                     {
                         \"name\":\"DG3\",
                         \"import_all\":\"false\",
                         \"managed_devices\": []
                     }
                 ]
             }
         },
         {
             \"model\":\"FortiManager\",
             \"vendor\":\"Fortinet\",
             \"display_name\":\"Spain-FortiManager\",
             \"securetrack_server\":\"RemoteControlServerName\",
             \"ip_address\":\"172.16.1.1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"false\",
                 \"user_name\":\"St-Super-use\",
                 \"password\":\"st-super-password\",
                 \"collect_dynamic_topology\":\"false\",
                 \"import_all\": \"false\",
                 \"import_devices\": [
                         {
                 \"name\": \"AdomX\",
                 \"import_all\": \"false\",
                 \"managed_devices\": [\"FW1\"]
                        }
                    ]
                }
            }
        ]
    }
}


Response Messages:
202: Accepted
408: Request timed out
500: Internal server error
503: Task with UID already running"},"response":[]},{"name":"Import managed devices","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \n \t \"devices_list\":{ \n \t\t \"devices\":[ \n \t\t { \n \t\t\t \"device_id\":\"1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"import_devices\":[\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG1\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"] \n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG2\",\n \t\t\t\t\t\t \"import_all\":\"true\"\n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG3\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [] \n \t\t\t\t\t }\n \t\t\t\t ]\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"device_id\":\"2\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"import_devices\": [\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"Adom1\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [\"firewall1\", \"firewall2\"] \n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"Adom2\",\n \t\t\t\t\t\t \"import_all\":\"true\"\n \t\t\t\t\t }\n \t\t\t\t ]\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"device_id\":\"3\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"import_devices\": [\"wantedVirtualContext\", \"anotherWantedVirtualContext\"] \n \t\t\t }\n \t\t }\n \t\t]\n \t}\n} "},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/import","description":"Use this API to import more managed devices to SecureTrack.
The following devices can be added: Device Groups (for Panorama), Administrative Domains (for FortiManager).\nCurrently supported types: Panorama, FortiManager, Cisco ASA.
Please see examples below per device id: device id 1 for Panorama, device 2 for FortiManager, device id 3 for Cisco ASA.

Parameters:
body: device_list

Usage Example
URL https://192.168.1.1/securetrack/api/devices/bulk/import
BODY{
     \"devices_list\":{
         \"devices\":[
         {
             \"device_id\":\"1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"collect_dynamic_topology\":\"false\",
                 \"import_devices\":[
                     {
                         \"name\":\"DG1\",
                         \"import_all\":\"false\",
                         \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"]
                     },
                     {
                         \"name\":\"DG2\",
                         \"import_all\":\"true\"
                     },
                     {
                         \"name\":\"DG3\",
                         \"import_all\":\"false\",
                         \"managed_devices\": []
                     }
                 ]
             }
         },
         {
             \"device_id\":\"2\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"import_devices\": [
                     {
                         \"name\":\"Adom1\",
                         \"import_all\":\"false\",
                         \"managed_devices\": [\"firewall1\", \"firewall2\"]
                     },
                     {
                         \"name\":\"Adom2\",
                         \"import_all\":\"true\"
                     }
                 ]
             }
         },
         {
             \"device_id\":\"3\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"import_devices\": [\"wantedVirtualContext\", \"anotherWantedVirtualContext\"]
             }
         }
        ]
    }
}


Response Messages:
202: Accepted
408: Request timed out
500: Internal server error
503: Task with UID already running"},"response":[]},{"name":"Get specific task results of bulk operations on devices","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"task_uid"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/tasks/{{task_uid}}","description":"Use this API to track and display the current progress of the devices being edited or added to\nSecureTrack for a specific Task ID.
For a list of devices, the status of each device is displayed.

A device that was not added due to some reason will be added to \"failed\" list with status element containing a description.
For example:
\"description\": \"No connection to device\".

Parameters:
task_uid: Task UID

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/bulk/tasks/d7e88799-a6e5-45da-8c72-c979a5dbe235
OUTPUT{
    \"task_result\":{
        \"total_succeeded\":\"0\",
        \"total_in_progress\":\"2\",
        \"total_failed\":\"0\",
        \"succeeded\":{
            \"count\":\"0\"
        },
        \"in_progress\":{
            \"count\":\"2\",
            \"devices\":[
                {
                    \"device_id\":\"1\",
                    \"display_name\":\"Europe-CMA\",
                    \"ip_address\":\"192.168.1.1\",
                    \"status\":{
                    }
                },
                {
                    \"device_id\":\"2\",
                    \"display_name\":\"Ireland-ASA\",
                    \"ip_address\":\"172.16.1.1\",
                    \"status\":{
                    }
                }
            ]
        },
        \"failed\":{
            \"count\":\"0\"
        }
    }
}


Response Messages:
404: The task with the given UID was not found
400: Bad request
200: Accepted
408: Request timed out
500: Internal server error"},"response":[]},{"name":"Add configuration for offline device","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"configuration_file"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/tasks/add_device_config_task","description":"Parameters:
device_id: Device ID
configuration_file: Configuration File

Usage Example
curl -X POST -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F \"configuration_file=@/tmp/config.txt;type=application/octet-stream\" -F \"device_id=1\" https://192.168.1.1/securetrack/api/tasks/add_device_config_task

Response Messages:
200: Configuration added successfully."},"response":[]},{"name":"Get specific device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}","description":"Returns the vendor, model, name, domain and ID for the specified device.
For more information on supported devices, supported models and virtual types please refer to 'Device and Revision Resources' section in the Tufin Knowledge Center .

Parameters:
context: Global MSSP context [optional]
id: Device ID
show_os_version: Show os version as apart of the response [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/60

Usage Example
https://192.168.1.1/securetrack/api/devices/20?show_os_version=true
"},"response":[]},{"name":"Update offline device","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t API OFFLINE ASA2\n\t true\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}","description":"Device name should contain only Lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^()

Parameters:
device_id: Device ID
body: Device to be updated

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/1
BODY<device>
     <name>API OFFLINE ASA2</name>
     <topology>true</topology>
</device>

"},"response":[]}]},{"name":"NAT Policies","item":[{"name":"Get NAT objects by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/nat_objects","description":"Fetches a list of NAT objects defined on device given by device ID
Note: NAT objects are only relevant for Check Point management servers and Juniper Netscreen devices.
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.


Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable value is numeric [optional]
count: Starting page for query allowable value is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/nat_objects

Usage Example
https://192.168.1.1/securetrack/api/devices/20/nat_objects?get_total=true
"},"response":[]},{"name":"Get NAT rules by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/nat_rules/bindings","description":"Fetches list of NAT rules for device given by device ID

input_interface and output_interface are not supported for Panorama running in Advanced management mode
nat_stage is supported for Netscreen and JunOS
nat_type is supported for FortiManager
Note: For Check Point, NAT rules are available from the modules (not managements)
Note: For Palo Alto, filtering NAT rules by interface is only available for firewall devices

Parameters:
context: Global MSSP context [optional]
id: Device ID
input_interface: Input interface for NAT rules, \"any\" for all interfaces [optional]
output_interface: output interface for NAT rules, \"any\" for all interfaces [optional]
nat_stage: NAT stage for NAT rules allowable values: \"pre_policy\" , \"post_policy\" or \"both\" [optional]
nat_type: NAT stage for NAT rules allowable values: \"vip\" or \"reverse_vip\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/10/nat_rules/bindings?input_interface=Any
"},"response":[]},{"name":"Get NAT objects by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/nat_objects","description":"Fetches a list of NAT objects for a given revision
Note: NAT objects are only relevant for Check Point management servers and Juniper Netscreen devices.
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.


Parameters:
context: Global MSSP context [optional]
id: Version ID
start: Starting page for query allowable value is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/nat_objects

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/nat_objects?get_total=true
"},"response":[]}]},{"name":"Network Objects","item":[{"name":"Get network objects by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/network_objects","description":"Fetches list of network objects defined on device given by ID
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.
The show_members parameter is only relevant if type=group.
If type=group, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.

Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
name: Network object name [optional]
type: Network object type [optional]
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
contains_ip: Get only network objects containing this IP [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]
typeOnDevice: Get EDL groups [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/network_objects

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?get_total=true
OUTPUT {
    \"network_objects\": {
    \"count\": 1,
    \"total\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"hostNetworkObjectDTO\",
                \"id\": 499226,
                \"name\": \"1.1.1.2 not shared\",
                \"display_name\": \"1.1.1.2 not shared\",
                \"class_name\": \"host_plain\",
                \"type\": \"host\",
                \"comment\": \"\",
                \"uid\": \"{EFE8E61B-EE2A-2F55-4C5C-56508661EAA7}\",
                \"implicit\": false,
                \"management_domain\": \"Shared\",
                \"overrides\": false,
                \"ip\": \"1.1.1.2\"
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"count\": 1
        \"network_object\": [
            {
                \"@xsi.type\": \"identityAwarenessDTO\",
                \"id\": 169178,
                \"name\": \"Access_role\",
                \"display_name\": \"Access_role\",
                \"class_name\": \"access_role\",
                \"type\": \"identity_awareness\",
                \"global\": false,
                \"comment\": \"\",
                \"uid\": \"{FC267948-DA8C-4FB6-A736-76B5254BF825}\",
                \"implicit\": false,
                \"overrides\": false,
                \"type_on_device\": \"\",
                \"networks\": {
                    \"network\": {
                        \"@xsi.type\": \"basicNetworkObjectDTO\",
                        \"id\": 168419,
                        \"name\": \"Any\",
                        \"display_name\": \"Any\",
                        \"class_name\": \"any_object\",
                        \"type\": \"basic\",
                        \"global\": false,
                        \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                        \"implicit\": false,
                        \"overrides\": false
                    }
                },
                \"users\": {
                    \"user\": {
                        \"id\": 14320,
                        \"name\": \"ad_group_auto_30K_grp1\",
                        \"display_name\": \"auto_30K_grp1\",
                        \"class_name\": \"ad_group\",
                        \"global\": false,
                        \"comment\": \"\",
                        \"uid\": \"{CAB92DCC-CF63-4E47-B8E3-1E1231996D5E}\",
                        \"dn\": \"CN=auto_30K_grp1,OU=OU_30K_Groups,DC=rnd,DC=local\"
                    }
                }
            },
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?type=group&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 105934,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?typeOnDevice=edl_ip_list&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 1,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 123123,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"type_on_device\": edl_ip_list,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Response Messages:
400: The typeOnDevice value is not valid"},"response":[]},{"name":"Get specific network object","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/network_objects/{{ids}}","description":"Fetches a single or partial list of the network objects for a given device ID.
For group network objects, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.
Note: This API retrieves the information from the latest revision.

Parameters:
context: Global MSSP context [optional]
device_id: Device ID
ids: Network object IDs separated by commas
show_members: Set to false to return only the name and ID of the members [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/network_objects/69548

Usage Example
https://192.168.1.1/securetrack/api/devices/31/network_objects/69547,69548,69550

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects/169184?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"network_object\": {
            \"@xsi.type\": \"identityAwarenessDTO\",
            \"id\": 169184,
            \"name\": \"Access_Role_@grp\",
            \"display_name\": \"Access_Role_@grp\",
            \"class_name\": \"access_role\",
            \"type\": \"identity_awareness\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{1870612C-0922-4AEE-81FF-5472DB7C32E1}\",
            \"implicit\": false,
            \"overrides\": false,
            \"type_on_device\": \"\",
            \"networks\": {
                \"network\": {
                    \"@xsi.type\": \"basicNetworkObjectDTO\",
                    \"id\": 168419,
                    \"name\": \"Any\",
                    \"display_name\": \"Any\",
                    \"class_name\": \"any_object\",
                    \"type\": \"basic\",
                    \"global\": false,
                    \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                    \"implicit\": false,
                    \"overrides\": false
                }
            },
            \"users\": {
                \"user\": {
                    \"id\": 14338,
                    \"name\": \"ad_group_grp\",
                    \"display_name\": \"@grp\",
                    \"class_name\": \"ad_group\",
                    \"global\": false,
                    \"comment\": \"\",
                    \"uid\": \"{C5740C23-F36E-4D2E-8B17-1F99C239C12A}\",
                    \"dn\": \"CN=@grp,OU=SC_Users,DC=test,DC=com\"
                }
            }
        }
    }
}

"},"response":[]},{"name":"Get network groups containing specified network object","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/network_objects/{{id}}/groups","description":"Returns groups that contain the specified network object


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the network object.

Usage Example
https://192.168.1.1/securetrack/api/network_objects/69577/groups
"},"response":[]},{"name":"Get network objects matching specified criteria","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"filter"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/network_objects/search","description":"You can search for network objects where the IP address, name or comment fields have a specified text string,
or you can search for network objects that have an IP address that matches, contains or is contained in a specified IP subnet,
or you can search for network objects by uid.

Parameters:
context: Returns results for the specified domain ID. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]
filter: “text” filter returns network objects where the IP address, name or comment fields have a specified text string. “subnet” filter returns network objects that have an IP address that matches, contains or is contained in a specified IP subnet. “uid“ filter returns network objects with the specified uid. If no filter is specified, the “text” filter is used.
device_id: Returns network objects belonging to the specified device_id. [optional]
ip: (For “text” filter) You can specify \"ip\" to find network objects with the specified text in the IP address field. [optional]
name: (For “text” filter) You can specify \"name\" to find network objects with the specified text in the name field. [optional]
comment: (For “text” filter) You can specify “comment” to find network objects with the specified text in the comment field. [optional]
any_field: (For “text” filter) You can specify \"any_field\" to find network objects with the specified text in the IP address, name or comment fields. [optional]
exact_match: (For “text” filter) You can add \"exact_match=true\" to find network objects with the specified text in the comment field. If this field is not specified, the query uses \"exact_match=false\". [optional]
contained_in: (For “subnet” filter) You can specify \"contained_in\" to find network objects that are contained in the specified IP subnet. For example, 10.1.0.0 is contained in 10.0.0.0. [optional]
contains: (For “subnet” filter) You can specify \"contains\" to find network objects that contain the specified IP subnet. For example, 10.0.0.0 contains 10.1.0.0. [optional]
exact_subnet: (For “subnet” filter) You can specify \"exact_subnet\" to find network objects that have the specified IP address. [optional]
uid: (for “uid“ filter) Returns network objects with the specified uid. [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]
typeOnDevice: You can specify \"typeOnDevice\" to find network object groups that are EDL. [optional]

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=text&name=host&exact_match=true

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=text&any_field=host&count=10&exact_match=true

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=subnet&contains=10.1.1.0

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=subnet&count=10&exact_subnet=1.1.1.1

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=uid&uid=24a8774d-24c1-4b3a-aae9-3c272a2b5191

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=uid&uid=24a8774d-24c1-4b3a-aae9-3c272a2b5191&device_id=4

Usage Example
URLhttps://192.168.1.1/securetrack/api/network_objects/search?filter=text&name=Access_Role&identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"count\": 1,
        \"total\": 1,
        \"network_object\": {
            \"@xsi.type\": \"identityAwarenessDTO\",
            \"id\": 169197,
            \"name\": \"Access_Role_aaa\",
            \"display_name\": \"Access_Role_aaa\",
            \"class_name\": \"access_role\",
            \"type\": \"identity_awareness\",
            \"global\": false,
            \"device_id\": 158,
            \"comment\": \"\",
            \"uid\": \"{9EDC2607-6BEC-43D7-A99D-B522BA694ADA}\",
            \"implicit\": false,
            \"overrides\": false,
            \"type_on_device\": \"\",
            \"networks\": {
                \"network\": {
                    \"@xsi.type\": \"basicNetworkObjectDTO\",
                    \"id\": 168419,
                    \"name\": \"Any\",
                    \"display_name\": \"Any\",
                    \"class_name\": \"any_object\",
                    \"type\": \"basic\",
                    \"global\": false,
                    \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                    \"implicit\": false,
                    \"overrides\": false
                }
            },
            \"users\": {
                \"user\": {
                    \"id\": 14317,
                    \"name\": \"ad_group_aaa\",
                    \"display_name\": \"aaa\",
                    \"class_name\": \"ad_group\",
                    \"global\": false,
                    \"comment\": \"\",
                    \"uid\": \"{5D16859C-0256-4673-A402-4254588B8F40}\",
                    \"dn\": \"CN=aaa,OU=SC_Users,DC=test,DC=com\"
                }
            }
        }
    }
}


Response Messages:
400: The typeOnDevice value is not valid.Use edl_ip_list as value to search EDL groups."},"response":[]},{"name":"Get specific network objects by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/network_objects/{{ids}}","description":"Fetches a single or partial list of the network objects for a given revision.
For group network objects, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision id
ids: Network object IDs separated by commas
show_members: Set to false to return only the name and ID of the members [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/779/network_objects/69548

Usage Example
https://192.168.1.1/securetrack/api/revisions/779/network_objects/69547,69548,69550

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/779/network_objects/69547?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"network_object\": {
            \"@xsi.type\": \"identityAwarenessDTO\",
            \"id\": 169185,
            \"name\": \"Access_Role_Domain Controllers\",
            \"display_name\": \"Access_Role_Domain Controllers\",
            \"class_name\": \"access_role\",
            \"type\": \"identity_awareness\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{140B8F32-188D-414C-A7BE-F4A7D7E9A169}\",
            \"implicit\": false,
            \"overrides\": false,
            \"type_on_device\": \"\",
            \"networks\": {
                \"network\": {
                    \"@xsi.type\": \"basicNetworkObjectDTO\",
                    \"id\": 168419,
                    \"name\": \"Any\",
                    \"display_name\": \"Any\",
                    \"class_name\": \"any_object\",
                    \"type\": \"basic\",
                    \"global\": false,
                    \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                    \"implicit\": false,
                    \"overrides\": false
                }
            },
            \"users\": {
                \"user\": {
                    \"id\": 14237,
                    \"name\": \"ad_group_Domain_Controllers\",
                    \"display_name\": \"Domain Controllers\",
                    \"class_name\": \"ad_group\",
                    \"global\": false,
                    \"comment\": \"\",
                    \"uid\": \"{0A8A459E-58E8-45DC-981E-16BBF2BD1922}\",
                    \"dn\": \"CN=Domain Controllers,CN=Users,DC=rnd,DC=local\"
                }
            }
        }
    }
}

"},"response":[]},{"name":"Get network objects by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/network_objects","description":"Fetches list of network objects from specific revision
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.
The show_members parameter is only relevant if type=group.
If type=group, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.

Parameters:
context: Global MSSP context [optional]
id: Revision id
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
name: Network object name [optional]
type: Network object type [optional]
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
contains_ip: Get only network objects containing this IP [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]
typeOnDevice: Get EDL groups [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/779/network_objects

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?get_total=true
OUTPUT {
    \"network_objects\": {
    \"count\": 1,
    \"total\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"hostNetworkObjectDTO\",
                \"id\": 499226,
                \"name\": \"1.1.1.2 not shared\",
                \"display_name\": \"1.1.1.2 not shared\",
                \"class_name\": \"host_plain\",
                \"type\": \"host\",
                \"comment\": \"\",
                \"uid\": \"{EFE8E61B-EE2A-2F55-4C5C-56508661EAA7}\",
                \"implicit\": false,
                \"management_domain\": \"Shared\",
                \"overrides\": false,
                \"ip\": \"1.1.1.2\"
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/779/network_objects?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
    \"count\": 1,
        \"network_object\": [
            {
                \"@xsi.type\": \"identityAwarenessDTO\",
                \"id\": 169183,
                \"name\": \"Access role 1\",
                \"display_name\": \"Access role 1\",
                \"class_name\": \"access_role\",
                \"type\": \"identity_awareness\",
                \"global\": true,
                \"comment\": \"\",
                \"uid\": \"{1E4C35A0-1FE4-4101-8A38-FDE656BCDCFB}\",
                \"implicit\": false,
                \"overrides\": false,
                \"type_on_device\": \"\",
                \"networks\": {
                    \"network\": {
                        \"@xsi.type\": \"basicNetworkObjectDTO\",
                        \"id\": 168419,
                        \"name\": \"Any\",
                        \"display_name\": \"Any\",
                        \"class_name\": \"any_object\",
                        \"type\": \"basic\",
                        \"global\": false,
                        \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                        \"implicit\": false,
                        \"overrides\": false
                    }
                },
                \"users\": {
                    \"user\": {
                        \"id\": 14346,
                        \"name\": \"all identified\",
                        \"display_name\": \"all identified\",
                        \"class_name\": \"all_identified\",
                        \"global\": false,
                        \"comment\": \"\",
                        \"uid\": \"{17A972AC-4B4A-4715-859F-867128707F59}\",
                        \"dn\": \"\"
                    }
                }
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/31/network_objects?type=group&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 105934,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/31/network_objects?typeOnDevice=edl_ip_list&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 1,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 123123,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"type_on_device\": edl_ip_list,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Response Messages:
400: The typeOnDevice value is not valid"},"response":[]},{"name":"Get rules containing specified network object","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/network_objects/{{id}}/rules","description":"Returns the security rules that contain the specified network object


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the network object.
include_groups: You can add \"include_groups\" to find rules that include the network object and rules that include the groups that include the network object. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]

Usage Example
https://192.168.1.1/securetrack/api/network_objects/65078/rules?include_groups=true
"},"response":[]}]},{"name":"Network Topology","item":[{"name":"Add generic device to Topology model","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"configuration_file"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/","description":"Upload a configuration file that will be used to add a generic device to the Topology model.
The context field is the domain ID to which the generic device is added: If not provided, the device is added to the global domain.
configuration_file must include a valid generic device configuration.
The specified path must point to a file on the computer being sue to make the REST API call.
If update update_topology = true, then the Topology model will be updated immediately after the device is added.
For maximum efficiency, if you are adding multiple generic devices in consecutive API calls, you can set update_topology = false on all API calls except for the last one. On the last call, set update_toplogy = true.Default value for update_topology = true.
For more information on input file formats, refer to Knowledge Center topic 'Adding and Updating a Generic Device'.

Parameters:
body: Generic device to be added
configuration_file: Configuration File for generic device
update_topology: Synchronize And Update Topology [optional]

Usage Example
curl -X POST -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F 'device_data={\"generic_device\":{\"name\": \"my_generic_device\", \"customer_id\": 1}};type=application/json' -F \"configuration_file=@/tmp/config.txt;type=application/octet-stream\" -F \"update_topology=true\" https://192.168.1.1/securetrack/api/generic_devices\n

Response Messages:
201: The generic device was created successfully
401: User is not permitted to access the specified domain
400: Failed to create generic device "},"response":[]},{"name":"Get generic devices that are configured in ST","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/","description":"Returns a list of the generic devices included in all the domains that the user has permission to.
Use context and/or name optional parameters to get more specific results.
To get context optional parameter, you can call /domains/ API and use the id included within the returned domain DTO.

Parameters:
context: Global MSSP context [optional]
name: Generic device name [optional]

Usage Example
https://192.168.1.1/securetrack/api/generic_devices
"},"response":[]},{"name":"Get path image for specified traffic","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"src"},{"value":null,"type":"text","key":"dst"},{"value":null,"type":"text","key":"service"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/path_image","description":"Returns an image containing one or more paths for the specified traffic.
src and dst parameters may contain multiple, comma separated values.
Service parameter can be a port (for example, “tcp:80”, “any”) or an application (for example, “Skype”, “Facebook”).
Application names are case sensitive.
Service parameter can also be a combination of ports and applications, for example “tcp:80, Skype, Facebook”
If sourceDomainIdTag is provided, the path starting points will be restricted to the specified domain ID. sourceDomainIdTag is valid only if overlapping IP mode is enabled.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is valid only if MSSP mode is enabled.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.
displayIncompletePaths parameter default value is false, if this parameter is set to true -
all nodes on the path will be displayed, even if the node cannot reach the destination, or if the source and destination are the same.
displayBlockedStatus parameter default value is false, if this parameter is set to true -
blocked traffic icons will be displayed next to devices blocking the traffic.
simulateNat parameter default value is true if this parameter is set to false - NAT simulation will not be used when calculating the path.
lastInstall parameter default value is true, which means simulation would use last installed policies. If this parameter is set to false - simulation would use last saved policies.
This API cannot be executed more than 10 times in parallel.

Parameters:
context: Global MSSP context [optional]
src: Source address/addresses
dst: Destination address/addresses
service: Service/services
sourceDomainIdTag: Path starting point Domain Id [optional]
displayIncompletePaths: Display incomplete paths [optional]
displayBlockedStatus: Display blocked traffic status icons [optional]
simulateNat: Simulate NAT [optional]
lastInstall: Last Installed [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/path_image?src=10.10.10.1&dst=3.3.3.3:32&service=any

Usage Example
https://192.168.1.1/securetrack/api/topology/path_image?src=10.10.10.1&dst=3.3.3.3:32&service=Facebook,tcp:80
"},"response":[]},{"name":"Get topology clouds","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds","description":"Returns a list of the topology clouds for all the domains for which the user has permission to access.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
Use the optional name parameter to restrict the results to topology clouds that contain the specified string.
The default pagination is start=0 and count=50.

Parameters:
context: Global MSSP context [optional]
type: Required clouds type [optional]
name: Cloud name [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds
OUTPUT{
    \"topology_clouds\": {
        \"count\": 3,
        \"total\": 3,
        \"topology_cloud\": [
            {
                \"id\": 48,
                \"name\": \"Cloud 69.70.120.155\",
                \"domain\": 1,
                \"type\": \"NON_JOINED\",
                \"ip\": \"69.70.120.155\"
            },
            {
                \"id\": 50,
                \"name\": \"Cloud 10.100.6.238\",
                \"domain\": 1,
                \"type\": \"MEMBER\",
                \"ip\": \"10.100.6.238\"
            },
            {
                \"id\": 66,
                \"name\": \"Cloud 10.100.10.14\",
                \"domain\": 1,
                \"type\": \"JOINED\",
                \"members\": [
                    {
                        \"id\": 50,
                        \"ip\": \"10.100.6.238\",
                        \"name\": \"Cloud 10.100.6.238\"
                    },
                    {
                        \"id\": 73,
                        \"ip\": \"10.100.10.14\",
                        \"name\": \"Cloud 10.100.10.14\"
                    },
                    {
                        \"id\": 74,
                        \"ip\": \"10.100.9.9\",
                        \"name\": \"Cloud 10.100.9.9\"
                    }
                ]
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds?type=non-joined
OUTPUT{
    \"topology_clouds\": {
        \"count\": 2,
        \"total\": 3,
        \"topology_cloud\": [
            {
                \"id\": 48,
                \"name\": \"Cloud 69.70.120.155\",
                \"domain\": 1,
                \"type\": \"NON_JOINED\",
                \"ip\": \"69.70.120.155\"
            },
            {
                \"id\": 50,
                \"name\": \"Cloud 10.100.6.238\",
                \"domain\": 1,
                \"type\": \"NON_JOINED\",
                \"ip\": \"10.100.6.238\"
            }
        ]
    }
}


Response Messages:
401: Access is denied
401: Only users with ‘Super admin’ permissions can access Global domain map
401: You do not have access permission to domain id: domainId
400: Wrong type provided - allowable values are: joined or non-joined"},"response":[]},{"name":"Create a joined topology cloud","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"cloud_data\":{\n\t\t\"cloud_name\" : \"optional new cloud name\",\n\t\t\"cloud_members\" : [118,179,258]\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds","description":"Create a new topology cloud in the Interactive Map by joining existing clouds together.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
The body must include at least two topology cloud ids that are on a single domain.
If the context parameter is not provided, then the API will use the context id of the first member of the members list in the body.
Clouds included in the members list of the body must not be joined clouds or members of another joined cloud.
If the provided body does not specify a joined cloud name, the newly created topology cloud will be given the name of the first member of the members list in the body.


Parameters:
context: Global MSSP context [optional]
body: Cloud data

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds
BODY{
    \"cloud_data\":{
        \"cloud_name\" : \"optional new cloud name\",
        \"cloud_members\" : [118,179,258]
    }
}


Response Messages:
201: Joined cloud created successfully
401: Access is denied
401: You do not have access permission to the domain for cloud with id ID
404: Cloud with id ID was not found in the provided MSSP domain
412: You must provide 2 or more clouds
412: Cloud id: cloudId does not belong to domain: Context
412: Cloud with id ID is a joined cloud
412: Cloud with id ID is a member of a joined cloud"},"response":[]},{"name":"Get path for specified traffic","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"src"},{"value":null,"type":"text","key":"dst"},{"value":null,"type":"text","key":"service"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/path","description":"Returns one or more paths for the specified traffic.
src and dst parameters may contain multiple, comma separated values.
Service parameter can be a port (for example, “tcp:80”, “any”) or an application (for example, “Skype”, “Facebook”).
Application names are case sensitive.
Service parameter can also be a combination of ports and applications, for example “tcp:80, Skype, Facebook”
If sourceDomainIdTag is provided, the path starting points will be restricted to the specified domain ID. sourceDomainIdTag is valid only if overlapping IP mode is enabled.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is valid only if MSSP mode is enabled.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.
includeIncompletePaths parameter default value is false, if this parameter is set to true -
all nodes on the path will be included, even if the node cannot reach the destination, or if the source and destination are the same.
simulateNat parameter default value is true if this parameter is set to false - NAT simulation will not be used when calculating the path.
lastInstall parameter default value is true, which means simulation would use last installed policies. If this parameter is set to false - simulation would use last saved policies.
This API cannot be executed more than 10 times in parallel.

Parameters:
context: Global MSSP context [optional]
src: Source address/addresses
dst: Destination address/addresses
service: Service/services
sourceDomainIdTag: Path starting point Domain Id [optional]
includeIncompletePaths: Include incomplete paths [optional]
simulateNat: Simulate NAT [optional]
lastInstall: Last Installed [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/path?src=10.10.10.1&dst=3.3.3.3:32&service=any

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/path?src=29.29.29.1&dst=25.25.25.1&service=Facebook,tcp:80
OUTPUT {
    \"path_calc_results\": {
        \"traffic_allowed\": false,
        \"device_info\": {
            \"id\": \"17\",
            \"name\": \"PA-VM-111.6 (Cluster)\",
            \"type\": \"mgmt\",
            \"vendor\": \"Palo Alto Networks\",
            \"incomingInterfaces\": {
                \"incomingVrf\": \"default\",
                \"ip\": \"29.29.29.1/255.255.255.252\",
                \"name\": \"tunnel.11\"
            },
            \"nextDevices\": {
                \"name\": \"DIRECTLY_CONNECTED\",
                \"routes\": {
                    \"outgoingInterfaceName\": \"ethernet1/5\",
                    \"outgoingVrf\": \"default\",
                    \"routeDestination\": \"25.25.25.1/255.255.255.0\"
                }
            },
            \"bindings\": {
                \"name\": \"\",
                \"rules\": [
                    {
                        \"action\": \"Accept\",
                        \"applications\": \"facebook\",
                        \"destNegated\": false,
                        \"destinations\": \"Any\",
                        \"ruleIdentifier\": 43,
                        \"serviceNegated\": false,
                        \"services\": \"Any\",
                        \"sourceNegated\": false,
                        \"sources\": \"Any\",
                        \"users\": \"Any\"
                    },
                    {
                        \"action\": \"Deny\",
                        \"applications\": \"Any\",
                        \"destNegated\": false,
                        \"destinations\": \"Any\",
                        \"ruleIdentifier\": 62,
                        \"serviceNegated\": false,
                        \"services\": \"Any\",
                        \"sourceNegated\": false,
                        \"sources\": \"Any\",
                        \"users\": \"Any\"
                    }
                ]
            }
        }
    }
}

"},"response":[]},{"name":"Get Specific topology subnet","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/subnets/{{id}}","description":"Returns the subnet for the specified id, including information regarding attached devices and join candidates.
This API requires 'Super admin' or 'Multi-Domain admin' privileges.
Multi-Domain user must have access permission to the domain where the subnet resides.

Parameters:
id: Subnet id

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/subnets/20
OUTPUT{
    \"subnet\": {
        \"id\": 18,
        \"name\": \"90.0.0.0/24\",
        \"ip\": \"90.0.0.0\",
        \"mask\": \"255.255.255.0\",
        \"attached_devices\": {
            \"attached_device\": [
                {
                    \"is_generic\": false,
                    \"id\": 10,
                    \"name\": \"srx\",
                    \"interface_id\": 4,
                    \"interface_name\": \"eth0\",
                    \"interface_ip\": \"90.0.0.1\"
                },
                {
                    \"is_generic\": false,
                    \"id\": 13,
                    \"name\": \"ZBFW\",
                    \"interface_id\": 5,
                    \"interface_name\": \"eth1\",
                    \"interface_ip\": \"90.0.0.124\"
                },
                {
                    \"is_generic\": false,
                    \"id\": 85,
                    \"name\": \"netscreen\",
                    \"interface_id\": 6,
                    \"interface_name\": \"eth2\",
                    \"interface_ip\": \"90.0.0.50\"
                }
            ]
        },
        \"join_candidates\": {
            \"join_candidate\": {
                \"is_generic\": false,
                \"id\": 72,
                \"name\": \"CP25\",
                \"interface_id\": 14,
                \"interface_name\": \"eth24/1\",
                \"interface_ip\": \"90.0.0.83\"
            }
        }
    }
}


Response Messages:
401: Access is denied
401: You do not have access permission to the domain for subnet with id ID
404: No subnet was found for the provided ID"},"response":[]},{"name":"Get topology subnets","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/subnets","description":"Returns a list of the topology subnets for all the domains for which the user has permission to access.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
Use the optional name parameter to restrict the results to topology subnet names that match the search criteria provided, as follows:
1. If you provide only a mask, then an exact match search is done on the mask portion of the name
e.g. if name=/2, the results will include 1.2.3.4/2, but not 1.2.3.4/22
2. If you provide only a partial or complete IP address, then a contains search is done in the IPv4 block portion of the name
e.g. name=32, the results will include 192.168.205.32/24 and 55.192.32.22/16, but will not include 55.168.205.5/32
3. If you provide both an IPv4 address (either partial or complete) and a mask, then an exact match search is done
e.g. if name=23.4/2, then the results will include 192.168.23.4/2, but will not include 192.168.23.4/23 or 23.4.192.168/2

The default pagination is start=0 and count=50.

Parameters:
context: Global MSSP context [optional]
name: Subnet name [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/subnets?name=10.27
OUTPUT{
    \"topology_subnets\": {
        \"count\": 4,
        \"total\": 4,
        \"subnets\": [
            {
                \"id\": 615,
                \"name\": \"10.27.122.20/32\",
                \"ip\": \"10.27.122.20\",
                \"mask\": \"255.255.255.255\"
            },
            {
                \"id\": 616,
                \"name\": \"10.27.122.60/32\",
                \"ip\": \"10.27.122.60\",
                \"mask\": \"255.255.255.255\"
            },
            {
                \"id\": 619,
                \"name\": \"10.27.122.0/30\",
                \"ip\": \"10.27.122.0\",
                \"mask\": \"255.255.255.252\"
            },
            {
                \"id\": 620,
                \"name\": \"10.27.122.4/30\",
                \"ip\": \"10.27.122.4\",
                \"mask\": \"255.255.255.252\"
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/subnets?name=144/30
OUTPUT{
    \"topology_subnets\": {
        \"count\": 2,
        \"total\": 2,
        \"subnets\": [
            {
                \"id\": 773,
                \"name\": \"10.13.64.144/30\",
                \"ip\": \"10.13.64.144\",
                \"mask\": \"255.255.255.252\"
            },
            {
                \"id\": 825,
                \"name\": \"10.15.64.144/30\",
                \"ip\": \"10.15.64.144\",
                \"mask\": \"255.255.255.252\"
            }
        ]
    }
}


Response Messages:
401: Access is denied
401: Only users with ‘Super admin’ permissions can access Global domain map
401: You do not have access permission to domain id: domainId"},"response":[]},{"name":"Get Specific topology cloud","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds/{{id}}","description":"Returns the topology cloud data for the specified id.
This API requires 'Super admin' or 'Multi-Domain admin' privileges.
Multi-Domain user must have access permission to the domain where the cloud resides.

Parameters:
id: Cloud id

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds/48
OUTPUT{
    \"topology_cloud\": {
        \"id\": 48,
        \"name\": \"Cloud 69.70.120.155\",
        \"domain\": 1,
        \"type\": \"NON_JOINED\",
        \"ip\": \"69.70.120.155\"
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds/66
OUTPUT{
    \"topology_cloud\": {
        \"id\": 66,
        \"name\": \"Cloud 10.100.10.14\",
        \"domain\": 1,
        \"type\": \"JOINED\",
        \"members\": [
            {
                \"id\": 50,
                \"ip\": \"10.100.6.238\",
                \"name\": \"Cloud 10.100.6.238\"
            },
            {
                \"id\": 73,
                \"ip\": \"10.100.10.14\",
                \"name\": \"Cloud 10.100.10.14\"
            },
            {
                \"id\": 74,
                \"ip\": \"10.100.9.9\",
                \"name\": \"Cloud 10.100.9.9\"
            }
        ]
    }
}


Response Messages:
401: Access is denied
401: You do not have access permission to the domain for cloud with id ID
404: No cloud was found for the provided ID"},"response":[]},{"name":"Update a cloud","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"cloud_data\":{\n\t\t\"cloud_name\" : \"new cloud\",\n\t\t\"cloud_members\" : [118,179,258]\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds/{{id}}","description":"Modify the name of a topology cloud, and add/remove members of a joined cloud.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
Multi-Domain user must have access permission to the domain context of the joined cloud, and any members specified in the body.
To change the name of a topology cloud, enter a value in the name field of the body.
To add/remove members of a joined cloud, specify the action and specify the clouds in the members list of the body.
The action is used only if the body contains a members list. If a members list is provided but no actions is specified, then the default action is ‘add’.
When adding cloud members, clouds included in the members list of the body must not be joined clouds or members of another joined cloud.
When removing cloud members, if only zero or one member remains in the joined cloud, it will be deleted from the Interactive Map.

Parameters:
id: cloud id
action: action [optional]
body: Cloud data

Usage Example
URLfor renaming of any cloud - https://192.168.1.1/securetrack/api/topology/clouds/436
BODY{
    \"cloud_data\":{
        \"cloud_name\" : \"new cloud\"
    }
}


Usage Example
URLfor renaming and members updating of a joined cloud - https://192.168.1.1/securetrack/api/topology/clouds/436?action=remove
BODY{
    \"cloud_data\":{
        \"cloud_name\" : \"new cloud\",
        \"cloud_members\" : [118,179,258]
    }
}


Response Messages:
204: Cloud updated successfully
401: Access is denied
401: You do not have access permission to the domain for cloud with id ID
404: Cloud with id ID was not found in the provided MSSP domain
412: Cloud with id ID is a not joined cloud
412: Cloud id: cloudId does not belong to domain: Context
412: Provided clouds don't belongs to the same domain
412: Cloud with id ID is a joined cloud
412: Cloud with id ID is a member of a joined cloud
412: Member cloud with id ID cannot be removed - it is not a member of a joined cloud"},"response":[]},{"name":"Get cloud information","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"suggested_clouds\": {\n\t\t\"count\": 1,\n\t\t\"total\": 1,\n\t\t\"cloud\": {\n\t\t\t\"management_name\": \"FW1\",\n\t\t\t\"management_id\": 20,\n\t\t\t\"cloud_name\": \"Cloud 10.100.0.1\",\n\t\t\t\"cloud_id\": 120,\n\t\t\t\"vertex_id\": 250,\n\t\t\t\"ip\": \"10.100.0.1\",\n\t\t\t\"routes_count\": 5,\n\t\t\t\"is_parent\": false\n\t\t}\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/cloud_suggestions/{{cloud_id}}","description":"Returns information about a specific cloud in the topology.
This API includes the ID of the cloud, the number of routes that point to the cloud, and the relevant devices (including the management_id) that have routes that point to the cloud.
This information can be used to identify missing devices that may need to be added to the topology or to identify clouds that are candidates for being joined.

Parameters:
cloud_id: cloud id
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/cloud_suggestions/120
BODY{
    \"suggested_clouds\": {
        \"count\": 1,
        \"total\": 1,
        \"cloud\": {
            \"management_name\": \"FW1\",
            \"management_id\": 20,
            \"cloud_name\": \"Cloud 10.100.0.1\",
            \"cloud_id\": 120,
            \"vertex_id\": 250,
            \"ip\": \"10.100.0.1\",
            \"routes_count\": 5,
            \"is_parent\": false
        }
    }
}


Response Messages:
202: Accepted
401: User is not permitted to access the specified domain"},"response":[]},{"name":"Get Cloud Internal Networks","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/cloud_internal_networks/{{id}}","description":"Returns the internal networks for the specified Cloud management id.
This API requires 'Super admin' privileges.

Parameters:
id: Cloud management id

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/cloud_internal_networks/20
OUTPUT{
    \"network_list\":
    {
        \"count\": 3,
        \"total\": 3,
        \"network\":
        {
            \"ip\": \"10.27.122.20\",
            \"mask\": \"255.255.255.255\"
        },
        \"network\":
        {
            \"ip\": \"10.27.122.60\",
            \"mask\": \"255.255.255.255\"
        },
        \"network\":
        {
            \"ip\": \"10.27.122.4\",
            \"mask\": \"255.255.255.252\"
        }
    }
}


Response Messages:
401: Access is denied
401: You do not have access permission to the domain for NSX with id ID
401: Device ID specified is not supported
404: The specified device ID was not found
404: The specified device ID was not found in Topology"},"response":[]},{"name":"Get Topology Synchronization status","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/synchronize/status","description":"Returns the progress status of the Topology Model Synchronization.



Usage Example
https://192.168.1.1/securetrack/api/topology/synchronize/status

Response Messages:
200: The topology synchronization was invoked successfully.
401: Access is denied
500: Error getting synchronize progress"},"response":[]},{"name":"Get most specific network interfaces from which a host IP is accessible","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"host"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/interfaces/last_hop","description":"Parameters:
context: Global MSSP context [optional]
host: IP address of device for a query

Usage Example
https://192.168.1.1/securetrack/api/devices/interfaces/last_hop?host=192.168.1.66
"},"response":[]},{"name":"Get cloud information","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"suggested_clouds\": {\n\t\t\"count\": 2,\n\t\t\"total\": 2,\n\t\t\"cloud\": [\n\t\t\t{\n\t\t\t\t\"management_name\": \"FW1\",\n\t\t\t\t\"management_id\": 20,\n\t\t\t\t\"cloud_name\": \"Cloud 10.100.0.1\",\n\t\t\t\t\"cloud_id\": 120,\n\t\t\t\t\"vertex_id\": 250,\n\t\t\t\t\"ip\": \"10.100.0.1\",\n\t\t\t\t\"routes_count\": 5,\n\t\t\t\t\"is_parent\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"management_name\": \"FW2\",\n\t\t\t\t\"management_id\": 21,\n\t\t\t\t\"cloud_name\": \"Cloud 172.16.0.1\",\n\t\t\t\t\"cloud_id\": 125,\n\t\t\t\t\"vertex_id\": 270,\n\t\t\t\t\"ip\": \"172.16.0.1\",\n\t\t\t\t\"routes_count\": 7,\n\t\t\t\t\"is_parent\": false,\n\t\t\t\t\"parent_vertex_id\": 40\n\t\t\t\t\"parent_cloud_id\": 45\n\t\t\t\t\"parent_cloud_name\": \"Cloud 172.16.0.1\",\n\t\t\t}\n\t\t]\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/cloud_suggestions","description":"Returns information about all clouds in the topology.
This API includes the ID of the cloud, the number of routes that point to the cloud, and the relevant devices (including the management_id) that have routes that point to the cloud.
This information can be used to identify missing devices that may need to be added to the topology or to identify clouds that are candidates for being joined.

Parameters:
context: Global MSSP context [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/cloud_suggestions
BODY{
    \"suggested_clouds\": {
        \"count\": 2,
        \"total\": 2,
        \"cloud\": [
            {
                \"management_name\": \"FW1\",
                \"management_id\": 20,
                \"cloud_name\": \"Cloud 10.100.0.1\",
                \"cloud_id\": 120,
                \"vertex_id\": 250,
                \"ip\": \"10.100.0.1\",
                \"routes_count\": 5,
                \"is_parent\": false
            },
            {
                \"management_name\": \"FW2\",
                \"management_id\": 21,
                \"cloud_name\": \"Cloud 172.16.0.1\",
                \"cloud_id\": 125,
                \"vertex_id\": 270,
                \"ip\": \"172.16.0.1\",
                \"routes_count\": 7,
                \"is_parent\": false,
                \"parent_vertex_id\": 40
                \"parent_cloud_id\": 45
                \"parent_cloud_name\": \"Cloud 172.16.0.1\",
            }
        ]
    }
}


Response Messages:
202: Accepted
401: User is not permitted to access the specified domain"},"response":[]},{"name":"Get topology network interfaces by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"mgmtId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/topology_interfaces","description":"The returned interfaces are taken from the topology data and will include only devices that are topology enabled.
When adding a device, the user can can choose whether to use dynamic or static topology for the device,
this choice will determine which kind of data is stored in the topology graph and returned by this API.

The parameter mgmtId should be a cluster or a gateway, not a management server.
You may provide a generic device Id (see generic_devices API under 'Monitored Devices' category) -
in this case make sure you set 'is_generic' parameter to 'true'

Parameters:
context: Global MSSP context [optional]
mgmtId: Management Id or Generic Device Id to query
is_generic: Should be set to 'true' if the provided mgmtId is related to generic device [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_interfaces?mgmtId=10

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_interfaces?mgmtId=1&is_generic=true
"},"response":[]},{"name":"Get topology routing tables for a given device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"mgmtId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/topology_routes","description":"The returned routing tables are taken from the topology data and will include only devices that are topology enabled.
When adding a device, the user can can choose whether to use dynamic or static topology for the device,
this choice will determine which kind of data is stored in the topology graph and returned by this API.

The parameter mgmtId should be a cluster or a gateway, not a management server.
You may provide a generic device Id (see generic_devices API under 'Monitored Devices' category) -
in this case make sure you set 'is_generic' parameter to 'true'

Parameters:
mgmtId: Management Id or Generic Device Id to query
is_generic: Should be set to 'true' if the provided mgmtId is related to generic device [optional]
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query from starting page, allowable type is numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_routes?mgmtId=10

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_routes?mgmtId=1&is_generic=true
"},"response":[]},{"name":"Get topology generic VPN connections","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic_vpns{device_id:(/device_id)?}","protocol":"https","host":["{{SecureTrack_IP}}"],"path":["securetrack","api","topology","generic_vpns{device_id:(","device_id)"],"query":[{"key":"}","value":null}]},"description":"Returns a list of the generic vpn connections in the Topology map, for all the domains for which the user has permission to access.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
Use the optional name parameter to restrict the results to topology generic vpn connections that contain the specified string.
The default pagination is start=0 and count=50.

Parameters:
context: Global MSSP context [optional]
is_generic: Get generic devices [optional]
device_id: Device id [optional]
name: VPN connection name (accepts '*', '?' as wildcards) [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/generic_vpns
OUTPUT{
    \"generic_vpns\": {
        \"count\": 3,
        \"total\": 3,
        \"generic_vpn\": [
            {
                \"device_id\": 222,
                \"generic\": false,
                \"id\": 3,
                \"interface_name\": \"tunnel.2\",
                \"tunnel_dest_ip\": \"54.239.63.155\",
                \"tunnel_src_ip\": \"84.200.6.1\",
                \"vpn_name\": \"Palo_to_AWS\"
            },
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 4,
                \"interface_name\": \"tunnel.1\",
                \"tunnel_dest_ip\": \"54.239.63.156\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 5,
                \"interface_name\": \"tunnel.2\",
                \"tunnel_dest_ip\": \"54.239.63.157\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/generic_vpns?is_generic=true
OUTPUT{
    \"generic_vpns\": {
        \"count\": 2,
        \"total\": 2,
        \"generic_vpn\": [
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 4,
                \"interface_name\": \"tunnel.1\",
                \"tunnel_dest_ip\": \"54.239.63.156\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 5,
                \"interface_name\": \"tunnel.2\",
                \"tunnel_dest_ip\": \"54.239.63.157\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
        ]
    }
}


Response Messages:
401: Access is denied
401: Only users with ‘Super admin’ permissions can access Global domain map
401: You do not have access permission to domain id: domainId
400: Wrong type provided - allowable values are: joined or non-joined"},"response":[]},{"name":"Delete generic device from Topology model","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/{{id}}","description":"Delete a generic device from the Topology model.
The ID must be for a valid generic device listed in the Topology Model.
If update update_topology = true, then the Topology model will be updated immediately after the device is deleted.
For maximum efficiency, if you are deleting multiple generic devices in consecutive API calls, you can set update_topology = false on all API calls except for the last one. On the last call, set update_toplogy = true.
Default value for update_topology = true.

Parameters:
id: Generic device id
update_topology: Synchronize And Update Topology [optional]

Usage Example
https://192.168.1.1/securetrack/api/generic_devices/1

Usage Example
https://192.168.1.1/securetrack/api/generic_devices/10?update_topology=false

Response Messages:
204: Generic Device deleted successfully.
400: Failed to delete generic device with id {}
404: A 'Generic Device' with the specified ID was not found"},"response":[]},{"name":"Update an existing generic device in the Topology model","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/{{id}}","description":"Modify an existing generic device by uploading a new configuration file and/or specifying a new name.
If name field is specified, the generic device will be renamed.
configuration_file is optional, if provided it must include a valid generic device configuration.
The specified path points to a file in the client machine.
If a generic device name is changed and a new configuration file is not provided, topology will not be synchronized (update_topology flag is ignored).
Default value for update_topology = true.
To save time when there are several consecutive api calls: For the last call, set update_topology = true (for all other calls, update_topology = false).
For more information on input file formats, refer to Knowledge Center topic 'Adding and Updating a Generic Device'.

Parameters:
id: Generic device id
body: Generic device to be updated [optional]
configuration_file: Configuration File for generic device [optional]
update_topology: Synchronize And Update Topology [optional]

Usage Example
curl -X PUT -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F \"configuration_file=@/tmp/config.txt;type=application/octet-stream\" -F \"update_topology=true\" https://192.168.1.1/securetrack/api/generic_devices/24

Usage Example
curl -X PUT -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F 'device_data={\"generic_device\":{\"name\": \"new_generic_device_name\"}};type=application/json' -F \"update_topology=false\" https://192.168.1.1/securetrack/api/generic_devices/72

Response Messages:
204: The generic device was updated successfully.
400: A new name or a new configuration file must be indicated in order to update generic device with id {}
400: Failed to update generic device with id {}
404: A 'Generic Device' with the specified ID was not found"},"response":[]},{"name":"Synchronize the Topology model","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/synchronize","description":"Invoke of the Topology Model Synchronization.
full_sync=false - Builds the topology model from the information stored in the Tufin database.
full_sync=true - Retrieves the current data from devices and builds the topology model.
Default value for full_sync = false.

Parameters:
full_sync: Perform full sync [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/synchronize

Usage Example
https://192.168.1.1/securetrack/api/topology/synchronize?full_sync=true

Response Messages:
200: The topology synchronization was invoked successfully.
401: Access is denied
500: Error Synchronizing Topology Model"},"response":[]}]},{"name":"Network Zone Manager - Patterns","item":[{"name":"Get all pattern entries for specific zones","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\n\t\n\t\t0\n\t\t2\n\t\t2\n\t\n\t\n\t\t\n\t\t\t2\n\t\t\tsecurity_group_by_name\n\t\t\tThis is a comment\n\t\t\tWEB\n\t\t\t1\n\t\t\n\t\t\n\t\t\t3\n\t\t\tsecurity_group_by_name\n\t\t\tThis is a comment\n\t\t\tWEo\n\t\t\t2\n\t\t\n\t\n\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/pattern-entries","description":"Get the list of zone pattern entries for specific zones by identifiers

Parameters:
context: Global MSSP context. [optional]
ids: Filter by IDs for the pattern entry results. [optional]
pattern: Filter by pattern string for the zone entry results. [optional]
name: Filter by zone name for the pattern entry results. [optional]
comment: Filter by comment for the pattern entry results. [optional]
sort: Sort ascending or descending. [optional]
start: Starting page number for query results. [optional]
count: Number of pages to return for the query, starting from the specified starting page. [optional]
children: Include child zones in the results. [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/1,2/pattern-entries
BODY<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<pattern_match_entries_find_result>
    <paging_info>
        <start>0</start>
        <count>2</count>
        <total>2</total>
    </paging_info>
    <pattern_match_entries>
        <pattern_match_entry>
            <id>2</id>
            <type>security_group_by_name</type>
            <comment>This is a comment</comment>
            <pattern>WEB</pattern>
            <zone_id>1</zone_id>
        </pattern_match_entry>
        <pattern_match_entry>
            <id>3</id>
            <type>security_group_by_name</type>
            <comment>This is a comment</comment>
            <pattern>WEo</pattern>
            <zone_id>2</zone_id>
        </pattern_match_entry>
    </pattern_match_entries>
</pattern_match_entries_find_result>


Response Messages:
200: The zone pattern entries were successfully retrieved.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Create a zone pattern entry in a specific zone","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\n\t\n\t\t1\n\t\t2\n\t\t\n\t\t\t1\n\t\t\tDefault\n\t\t\n\t\tWEB\n\t\tsecurity_group_by_name\n\t\tThis is a comment\n\t\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/pattern-entries","description":"Create a zone pattern entry in a specific zone by identifier

Parameters:
context: Global MSSP context. [optional]
zone_id: Identifier of the zone containing the zone pattern entry.
body: The zone pattern entry to create.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/pattern-entries
BODY<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<create_pattern_match_entry>
    <pattern_match_entry>
        <id>1</id>
        <zone_id>2</zone_id>
        <domain>
            <id>1</id>
            <name>Default</name>
        </domain>
        <pattern>WEB</pattern>
        <type>security_group_by_name</type>
        <comment>This is a comment</comment>
    </pattern_match_entry>
</create_pattern_match_entry>


Response Messages:
201: The zone pattern entry was created successfully.
401: User is not permitted to access the specified domain
400: Some of pattern entry parameters were invalid or missing
404: A zone with the specified identifier was not found."},"response":[]},{"name":"Get a specific zone pattern entry for a specific zone","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\n\t2\tsecurity_group_by_name\n\tThis is a comment\n\tWEB\n\t75\n\tZone_10_0_0_1\n\t\n\t\t
koko
\n\t\tbobo\n\t\t1\n\t\tDefault\n\t\n\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/pattern-entries/{{id}}","description":"Get a specific zone pattern entry for a specific zone by identifier

Parameters:
context: Global MSSP context. [optional]
zone_id: Identifier of the zone containing the zone entry.
id: Identifier of the zone pattern entry.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/75/pattern-entries/2
BODY<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<pattern_match_entry>
    <id>2</id>    <type>security_group_by_name</type>
    <comment>This is a comment</comment>
    <pattern>WEB</pattern>
    <zone_id>75</zone_id>
    <zone_name>Zone_10_0_0_1</zone_name>
    <domain>
        <address>koko</address>
        <description>bobo</description>
        <id>1</id>
        <name>Default</name>
    </domain>
</pattern_match_entry>


Response Messages:
200: The zone pattern entry was successfully retrieved.
401: User is not permitted to access the specified domain
404: A zone with the specified identifier was not found.
404: A zone pattern entry with the specified identifier was not found."},"response":[]}]},{"name":"Network Zone Manager - Subnets","item":[{"name":"Modify multiple existing zone entries","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"zone_entries\" : {\n\t\t\"zone_entry\": [\n\t\t\t{\n\t\t\t\t\"id\": 120,\n\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\"prefix\": 32,\n\t\t\t\t\"new_zone_id\": 85\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": 139,\n\t\t\t\t\"ip\": \"1b98:c72:1f00:0001::\",\n\t\t\t\t\"prefix\": \"52\",\n\t\t\t\t\"new_zone_id\": 98\n\t\t\t}\n\t\t]\n}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_ids}}/entries/{{ids}}","description":"For IPv4 entry provide IP and netmask/prefix.
For IPv6 provide IP and prefix only, netmask is not allowed.
new_zone_id is not optional, it may be the same as the present zoneId.

Parameters:
context: Global MSSP context. [optional]
zone_ids: The ID(s) of the zones containing the zone entries.
ids: The ID(s) of the zone entries to modify.
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/85,98/entries/120,139
BODY{
\"zone_entries\" : {
        \"zone_entry\": [
            {
                \"id\": 120,
                \"ip\": \"3.3.3.3\",
                \"prefix\": 32,
                \"new_zone_id\": 85
            },
            {
                \"id\": 139,
                \"ip\": \"1b98:c72:1f00:0001::\",
                \"prefix\": \"52\",
                \"new_zone_id\": 98
            }
        ]
}
}


Response Messages:
200: The zone entry was modified successfully.
401: User is not permitted to access the specified domain
400: The zone entry parameters were invalid
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found."},"response":[]},{"name":"Create a zone entry","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"zone_entry\": {\n\t\"ip\": \"1b98:c72:1f00:0000::\",\n\t\"prefix\": \"52\"\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries","description":"For IPv4 entry provide IP and netmask/prefix (see Usage Example #1 and #2).
For IPv6 provide IP and prefix only, netmask is not allowed(see Usage Example #3).

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
body: The zone entry to create.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"netmask\": \"255.255.255.0\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"prefix\": \"24\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries
BODY{
\"zone_entry\": {
    \"ip\": \"1b98:c72:1f00:0000::\",
    \"prefix\": \"52\"
    }
}


Response Messages:
201: The zone entry was created successfully.
401: User is not permitted to access the specified domain
400: The zone entry parameters were invalid
404: A zone with the specified ID was not found."},"response":[]},{"name":"Modify a zone entry","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"zone_entry\": {\n\t\"ip\": \"1b98:c72:1f00:0000::\",\n\t\"prefix\": \"52\"\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries/{{id}}","description":"For IPv4 entry provide IP and netmask/prefix (see Usage Example #1 and #2).
For IPv6 provide IP and prefix only, netmask is not allowed(see Usage Example #3).

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
id: The ID of the zone entry.
body: The modified zone entry.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries/1
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"netmask\": \"255.255.255.0\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries/1
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"prefix\": \"24\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries/1
BODY{
\"zone_entry\": {
    \"ip\": \"1b98:c72:1f00:0000::\",
    \"prefix\": \"52\"
    }
}


Response Messages:
200: The zone entry was modified successfully.
401: User is not permitted to access the specified domain
400: The zone entry parameters were invalid
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found."},"response":[]},{"name":"Get a specific zone entry","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"zone_id"},{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries/{{id}}","description":"Get a specific zone entry by ID for a zone.

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
id: The ID of the zone entry.

Usage Example
https://192.168.1.1/securetrack/api/zones/2/entries/123

Response Messages:
200: The zone entry was successfully retrieved.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found."},"response":[]},{"name":"Delete zone entries","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"zone_id"},{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries/{{id}}","description":"Delete existing zone entries.

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
id: The ID of the zone entry to delete.

Usage Example
https://192.168.1.1/securetrack/api/zones/2/entries/10

Response Messages:
200: The zone entry was deleted successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found."},"response":[]},{"name":"Get entries for a zone","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/entries","description":"Get the list of zone entries for a zone.

Parameters:
context: Global MSSP context. [optional]
ids: Filter by IDs for the zone entry results. [optional]
name: Filter by name for the zone entry results. [optional]
ip: Filter by IP for the zone entry results. [optional]
netmask: Filter by netmask for the zone entry results. [optional]
prefix: Filter by prefix for the zone entry results. [optional]
comment: Filter by comment for the zone entry results. [optional]
group: Filter by device group for the zone entry results. [optional]
sort: Sort ascending or descending. [optional]
start: Starting page number for query results. [optional]
count: Number of pages to return for the query, starting from the specified starting page. [optional]
children: Include child zones in the results. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/2/entries

Response Messages:
200: The zone entries were successfully retrieved.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Modify a zone entry","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"zone_ids"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_ids}}/entries/{{ids}}","description":"Modify an existing zone entry.

Parameters:
context: Global MSSP context. [optional]
zone_ids: The ID(s) of the zones containing the zone entry.
ids: The ID(s) of the zone entries to delete.

Usage Example
https://192.168.1.1/securetrack/api/zones/2,3/entries/10,20

Response Messages:
200: The zone entry was deleted successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found."},"response":[]}]},{"name":"Network Zone Manager - Zones","item":[{"name":"Delete a zone","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}","description":"Delete an existing zone.

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zone to delete.

Usage Example
https://192.168.1.1/securetrack/api/zones/1,2

Response Messages:
204: The specified zone was successfully deleted.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Get descendant zones for a zone","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/descendants","description":"Get a list of zones descended from the specified zone(s).

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones for which to look for descendant zones.

Usage Example
https://192.168.1.1/securetrack/api/zones/10,20/descendants

Response Messages:
200: The zone descendants were retrieved successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Get ancestor zones for a zone","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/ancestors","description":"Get a list of ancestor zones for the specified zone(s).

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones for which to look for ancestor zones.

Usage Example
https://192.168.1.1/securetrack/api/zones/123,234/ancestors

Response Messages:
200: The zone ancestors were retrieved successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Get shared zones","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/shared","description":"Get a list of shared zones.

Parameters:
context: Global MSSP context. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/shared

Response Messages:
200: The list of shared zones was retrieved successfully.
401: User is not permitted to access the specified domain"},"response":[]},{"name":"Import a zone","request":{"method":"POST","header":[],"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/import/{{ids}}","description":"Import a shared zone into the specified domain

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones to import. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/import/10,20

Response Messages:
200: The zone was imported successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Remove a zone as an descendants to a zone","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"parent_id"},{"value":null,"type":"text","key":"child_ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{parent_id}}/descendants/{{child_ids}}","description":"Remove a zone(s) as an descendants to a existing zone.

Parameters:
context: Global MSSP context. [optional]
parent_id: The ID of the zone for which to remove descendant zone(s).
child_ids: The ID(s) of the zone to remove as a descendant.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/descendants/10,20

Response Messages:
200: The zone was removed as an descendant successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Add a zone as a descendant to a zone","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"parent_id"},{"value":null,"type":"text","key":"child_ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{parent_id}}/descendants/{{child_ids}}","description":"Add a zone(s) as a descendant to a existing zone.

Parameters:
context: Global MSSP context. [optional]
parent_id: The ID of the zone for which to add descendant zone(s).
child_ids: The ID(s) of the zones to add as descendants.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/descendants/10,20

Response Messages:
200: The zone was added as an descendant successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Get configuration usages for a zone","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/dependencies","description":"Get a list of configuration usages for the specified zone(s).

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones for which to look for configuration dependencies.

Usage Example
https://192.168.1.1/securetrack/api/zones/2,3/dependencies

Response Messages:
200: The zone dependencies were retrieved successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Create a zone","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\n\tDMZ\n\tAll DMZ addresses\n\tfalse\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/","description":"Create a zone.

Parameters:
context: Global MSSP context. [optional]
body: The zone to add.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones
BODY<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<zone>
    <name>DMZ</name>
    <comment>All DMZ addresses</comment>
    <shared>false</shared>
</zone>


Response Messages:
201: The zone was created successfully.
401: User is not permitted to access the specified domain
400: The zone parameters were invalid"},"response":[]},{"name":"Delete all zones","request":{"method":"DELETE","header":[],"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/","description":"Delete all existing zones.

Parameters:
context: Global MSSP context. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones

Response Messages:
204: All zones were successfully deleted.
401: User is not permitted to access the specified domain"},"response":[]},{"name":"Get all zones","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/","description":"Gets a list of all zones.

Parameters:
context: Global MSSP context. [optional]
name: Filter by zone name for the zone results. [optional]
comment: Filter by zone comment for the zone results. [optional]
imported: List domains that imported zones. [optional]
includeInternet: Include the Internet zone. [optional]
includeImported: Include imported zones. [optional]
sort: Sort ascending or descending. [optional]
start: Starting page number for query results. [optional]
count: Number of pages to return for the query, starting from the specified starting page. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones

Response Messages:
200: The zones were retrieved successfully.
401: User is not permitted to access the specified domain"},"response":[]},{"name":"Map network elements to security zones","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t \n\t\t 10.8.8.0\n\t\t 255.255.255.0\n\t\t \n\t \n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_zones/","description":"This API maps each network element in the AccessRequestNetworkListDTO (such as IP address, IP address range, object, or group) to all matching Tufin security zones. If the network element is a group, then each zone also identifies all matching group members. The internet referral object can be included in the list, and will always map to the predefined Internet security zone. If the 'Any' element is included in the list it will map to all zones.
Note: if multi-domain mode is enabled, the API calls only checks zones that are in the “Default” domain.

Parameters:
body: AccessRequestNetworkListDTO

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_zones
BODY<network_objects>
     <network_object xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"ip_network\">
         <network xsi:type=\"raw_network_subnet\">
         <ip>10.8.8.0</ip>
         <mask>255.255.255.0</mask>
         </network>
     </network_object>
</network_objects>


Response Messages:
200: Returns mapping of network elements to security zones
400: Access Request Network List is malformed.
401: Access is denied."},"response":[]},{"name":"Get a specific zone","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{id}}","description":"Get the zone with the specified ID.

Parameters:
context: Global MSSP context. [optional]
id: The ID of the zone to get.
imported: List domains that imported zones. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/2

Response Messages:
200: The zone was retrieved successfully.
401: User is not permitted to access the specified domain
401: A zone with the specified ID does not exist."},"response":[]},{"name":"Modify a zone","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\n\t2\n\tDMZ\n\tAll DMZ hosts\n\tfalse\n\tfalse\n\tfalse\n\tfalse\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{id}}","description":"Modify an existing zone.

Parameters:
context: Global MSSP context. [optional]
id: The ID of the zone to modify.
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2
BODY<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<zone>
    <id>2</id>
    <name>DMZ</name>
    <comment>All DMZ hosts</comment>
    <shared>false</shared>
    <internet>false</internet>
    <user_networks>false</user_networks>
    <unassociated_networks>false</unassociated_networks>
</zone>


Response Messages:
204: The specified zone was successfully modified.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
400: The zone parameters were invalid"},"response":[]},{"name":"Remove a zone as an ancestor to a zone","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"child_id"},{"value":null,"type":"text","key":"parent_ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{child_id}}/ancestors/{{parent_ids}}","description":"Remove a zone(s) as an ancestor to a existing zone.

Parameters:
context: Global MSSP context. [optional]
child_id: The ID of the zone for which to remove ancestors zone(s).
parent_ids: The ID(s) of the zones to remove as ancestors.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/ancestors/10,20

Response Messages:
200: The zone was removed as an ancestor successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Add a zone as an ancestor to a zone","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"child_id"},{"value":null,"type":"text","key":"parent_ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{child_id}}/ancestors/{{parent_ids}}","description":"Add a zone(s) as an ancestor to a existing zone.

Parameters:
context: Global MSSP context. [optional]
child_id: The ID of the zone for which to add ancestors zone(s).
parent_ids: The ID(s) of the zones to add as ancestors.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/ancestors/10,20

Response Messages:
200: The zone was added as an ancestor successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]}]},{"name":"Policies and Sub-Policies","item":[{"name":"Get rules by input and output interfaces","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/topology_interfaces","description":"Parameters:
device_id: The unique identifier of target device
inputInterfaceName: Input interface name [optional]
outputInterfaceName: Output interface name [optional]

Usage Example
https://192.168.1.1/securetrack/api/bindings/2/topology_interfaces?inputInterfaceName=ethernet1/1&outputInterfaceName=ethernet1/2
"},"response":[]},{"name":"Get sub-policies (bindings) by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/bindings","description":"Returns a list of all of the subpolicies (bindings) for a given device.
The definition of subpolicy is different for each vendor:
Check Point - policy package and inline layer (inline layer will be returned only when the optional include_subpolicy parameter is set to true)
Cisco - ACL
Juniper/Fortinet/Palo Alto/Stonesoft - zone-to-zone policy
Cloud platforms - Security Groups


Parameters:
context: Global MSSP context [optional]
id: Device ID
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
include_subpolicy: when set to true, includes sub policies in the returned result, supported only for Checkpoint [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/bindings

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/bindings? include_subpolicy=true
"},"response":[]},{"name":"Get policies by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/policies","description":"Fetches list of policies defined on a given revision ID

Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/policies
"},"response":[]},{"name":"Get list of sub-policies (bindings) with input and/or output interfaces","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"supremum_version_id"},{"value":null,"type":"text","key":"inputInterfaceName"},{"value":null,"type":"text","key":"outputInterfaceName"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/binding_query","description":"Retrieve list of bindings of input and/or output interfaces

Parameters:
device_id: The unique identifier of target device
supremum_version_id: The unique identifier of target revision
inputInterfaceName: Input interface name
outputInterfaceName: Output interface name

Usage Example
https://192.168.1.1/securetrack/api/bindings/20/binding_query?supremum_version_id=785&inputInterfaceName=Any&outputInterfaceName=Any
"},"response":[]},{"name":"Get sub-policies (bindings) by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/bindings","description":"Returns a list of all of the subpolicies (bindings) for a given revision.
The definition of subpolicy is different for each vendor:
Check Point - policy package and inline layer (inline layer will be returned only when the optional include_subpolicy parameter is set to true)
Cisco - ACL
Juniper/Fortinet/Palo Alto/Stonesoft - zone-to-zone policy
Cloud platforms - Security Groups


Parameters:
context: Global MSSP context [optional]
id: Revision ID
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
include_subpolicy: when set to true, includes sub policies in the returned result, supported only for Checkpoint [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/bindings

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/bindings? include_subpolicy=true
"},"response":[]},{"name":"Get policies by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/policies","description":"Fetches list of policies defined on a given device ID.
Supported devices: CheckPoint, Panorama Advanced, FortiManager Basic and Advanced, FMC and NSX.

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/20/policies
"},"response":[]}]},{"name":"Policy Analysis","item":[{"name":"Run Policy Analysis query","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_ids"},{"value":null,"type":"text","key":"sources"},{"value":null,"type":"text","key":"destinations"},{"value":null,"type":"text","key":"services"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/policy_analysis/query/matching_rules","description":"Parameters:
device_ids: Device ids
sources: Source list
destinations: Destination list
services: Service list
exclude_any: Exclude any in the specified, comma-separated fields of source, destination or service. For example: exclude_any = destination,service [optional]
action: Action [optional]

Usage Example
https://192.168.1.1/securetrack/api/policy_analysis/query/matching_rules?device_ids=41&sources=33.33.33.0:24,113.113.113.100&destinations=114.1.1.0:24&services=tcp:80&exclude_any=source,destination

Response Messages:
200: Returns request results.
400: Error in request syntax."},"response":[]}]},{"name":"Policy Browser (formerly Rule Documentation)","item":[{"name":"Get specific rule documentation","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"rule_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules/{{rule_id}}/documentation","description":"Fetches rule documentation for a single rule given by device ID and rule ID

Parameters:
context: Global MSSP context [optional]
id: Device ID
rule_id: Rule ID

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules/16373/documentation
"},"response":[]},{"name":"Modify specific rule documentation","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t admin\n\t Comment text\n\t false\n\t true\n\t \n\t\t user@company.com\n\t\t Business Owner\n\t\t 2013-01-08T00:00:00+02:00\n\t\t 173\n\t\t 789112\n\t \n\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules/{{rule_id}}/documentation","description":"Modify rule documentation for a single rule given by device ID and rule ID
A single rule can be set as either a stealth rule or legacy rule. If both flags are set, an error will be returned (error 400, Bad request).
If there is no existing rule documentation for the rule, the specified documentation is added to the rule and the response code is: 201 Created.
If there is existing rule documentation for the rule, the specified documentation replaces the existing documentation and the response code is: 204 No Content.

Parameters:
context: Global MSSP context [optional]
id: Device ID
rule_id: Rule ID
body: RuleDocumentationDTO

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/20/rules/3040/documentation
BODY<rule_documentation>
     <tech_owner>admin</tech_owner>
     <comment>Comment text</comment>
     <legacy_rule>false</legacy_rule>
     <stealth_rule>true</stealth_rule>
     <record_set>
         <businessOwnerEmail>user@company.com</businessOwnerEmail>
         <businessOwnerName>Business Owner</businessOwnerName>
         <expireDate>2013-01-08T00:00:00+02:00</expireDate>
         <id>173</id>
         <ticketCr>789112</ticketCr>
     </record_set>
</rule_documentation>

"},"response":[]},{"name":"Delete specific rule documentation","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"rule_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules/{{rule_id}}/documentation","description":"Delete rule documentation for a single rule given by device ID and rule ID

Parameters:
context: Global MSSP context [optional]
id: Device ID
rule_id: Rule ID

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules/3040/documentation
"},"response":[]},{"name":"Delete specific rule documentation","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"rule_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules/{{rule_id}}/documentation","description":"Delete rule documentation for a single rule given by revision ID and rule ID.
If the rule has automatic mapping to a ticket, the record is not deleted.

Parameters:
context: Global MSSP context [optional]
id: Revision id
rule_id: Rule id

Usage Example
https://192.168.1.1/securetrack/api/revisions/173/rules/3373/documentation
"},"response":[]},{"name":"Modify specific rule documentation","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t admin\n\t Comment text\n\t false\n\t true\n\t \n\t\t user@company.com\n\t\t Business Owner\n\t\t 2013-01-08T00:00:00+02:00\n\t\t 172\n\t\t 789111\n\t \n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules/{{rule_id}}/documentation","description":"Modify rule documentation for a single rule identified by revision ID and rule ID.
A single rule can be set as either a stealth rule or legacy rule. If both flags are set, an error will be returned (error 400, Bad request).
If no rule documentation exists for the rule, the specified documentation is added to the rule and the response code is: 201 Created.
If rule documentation already exists for the rule, the specified documentation replaces the existing documentation and the response code is: 204 No Content.
Record set entries that are automatically created or calculated, for example automatic mapping to a SecureChange ticket, cannot be modified.
The following fields are automatically calculated, and cannot be modified:
Permissiveness, Violations, Last Hit, Last Modified, Shadowing Status, Certification Status, Certification Date, Certification Expiration Date, Application Name, Application Owner

Parameters:
context: Global MSSP context [optional]
id: Revision id
rule_id: Id of the changed rule
body: RuleDocumentationDTO

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/173/rules/3373/documentation
BODY<rule_documentation>
     <tech_owner>admin</tech_owner>
     <comment>Comment text</comment>
     <legacy_rule>false</legacy_rule>
     <stealth_rule>true</stealth_rule>
     <record_set>
         <businessOwnerEmail>user@company.com</businessOwnerEmail>
         <businessOwnerName>Business Owner</businessOwnerName>
         <expireDate>2013-01-08T00:00:00+02:00</expireDate>
         <id>172</id>
         <ticketCr>789111</ticketCr>
     </record_set>
</rule_documentation>

"},"response":[]},{"name":"Get specific rule documentation","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"rule_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules/{{rule_id}}/documentation","description":"Fetches rule documentation for a single rule given by revision ID and rule ID.

Parameters:
context: Global MSSP context [optional]
id: Revision id
rule_id: Id of the requested rule

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules/16373/documentation
"},"response":[]}]},{"name":"Policy Optimization","item":[{"name":"Get cleanups by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"code"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/cleanups","description":"Fetches set of Cleanup calculation results for a device given by ID.
Only fully shadowed rules (cleanup code C01) are supported.

Parameters:
context: Global MSSP context [optional]
device_id: Device ID
code: Cleanup category code
start: Starting page for query allowable values are numeric [optional]
count: Number of pages for query result allowable values are numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/cleanups?code=C01
"},"response":[]},{"name":"Get risks results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/risk/","description":"Parameters:
context: Global MSSP context [optional]
devices: Devices ids [optional]

Usage Example
https://192.168.1.1/securetrack/api/risk
"},"response":[]},{"name":"Get devices in cleanup results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"cleanup_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/cleanup/{{cleanup_id}}/devices","description":"Parameters:
context: Global MSSP context [optional]
cleanup_id: Cleanup id

Usage Example
https://192.168.1.1/securetrack/api/cleanup/1/devices
"},"response":[]},{"name":"Get the specific objects or rules identified for the cleanup results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"cleanup_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/cleanup/{{cleanup_id}}/instances","description":"Parameters:
context: Global MSSP context [optional]
cleanup_id: Cleanup id
devices: Devices ids [optional]
start: Start [optional]
count: Results count [optional]

Usage Example
https://192.168.1.1/securetrack/api/cleanup/1/instances
"},"response":[]},{"name":"Get devices in risk results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"risk_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/risk/{{risk_id}}/devices","description":"Parameters:
context: Global MSSP context [optional]
risk_id: Risk id

Usage Example
https://192.168.1.1/securetrack/api/risk/1/devices
"},"response":[]},{"name":"Get the specific objects or rules identified for the risk results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"risk_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/risk/{{risk_id}}/instances","description":"Parameters:
context: Global MSSP context [optional]
risk_id: Risk id
devices: Devices ids [optional]
start: Start [optional]
count: Results count [optional]

Usage Example
https://192.168.1.1/securetrack/api/risk/1/instances
"},"response":[]},{"name":"Get shadowing rules by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"shadowed_uids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/shadowing_rules","description":"Find shadowing rules for given shadowed rules of a specific device

Parameters:
device_id: Device ID
shadowed_uids: UIDs of shadowed rules separated by commas

Usage Example
https://192.168.1.1/securetrack/api/devices/31/shadowing_rules?shadowed_uids=78786a0d-b9cc-478e-b7a2-dea953c976c7
"},"response":[]},{"name":"Get cleanups results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/cleanup/","description":"Parameters:
context: Global MSSP context [optional]
devices: Devices ids [optional]

Usage Example
https://192.168.1.1/securetrack/api/cleanup
"},"response":[]}]},{"name":"Revisions","item":[{"name":"Get specific revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revId}}","description":"Fetches a revision specified by revision Id.
To get revId for this API, use the 'id' property of RevisionDTO that is returned by 'Get revisions by device' or 'Get latest revision by device' APIs

Parameters:
context: Global MSSP context [optional]
revId: Id of fetched revision

Usage Example
https://192.168.1.1/securetrack/api/revisions/785
"},"response":[]},{"name":"Get latest revision by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/latest_revision","description":"Fetches latest revision for a given device

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/105/latest_revision
"},"response":[]},{"name":"Get revisions by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/revisions","description":"Fetches revisions for a given device

Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query starting from starting page allowable type is numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/105/revisions
"},"response":[]}]},{"name":"Rule Usage","item":[{"name":"Get last hits for all rules by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/rule_last_usage/find_all/{{device_id}}","description":"Get last hit dates for all rules in a given device.
For Palo Alto firewalls, this also returns last hits for users and applications in the rule.

Parameters:
device_id: device id

Usage Example
https://192.168.1.1/securetrack/api/rule_last_usage/find_all/20
"},"response":[]},{"name":"Get last hit for a specific rule","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"rule_uid"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/rule_last_usage/find/{{device_id}}/{{rule_uid}}","description":"Get last hit dates for all rules in a given device.
For Palo Alto firewalls, this also returns last hits for users and applications in the rule.
The rule_uid is the value from the uid field returned by the /rules API: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Parameters:
device_id: device_id
rule_uid: rule_uid

Usage Example
https://192.168.1.1/securetrack/api/rule_last_usage/find/20/ea9db13e-d058-45c6-a2f0-cd731027c22b
"},"response":[]}]},{"name":"Security Rules","item":[{"name":"Get rules by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules","description":"Returns a list of all of the security rules for the specified revision.
Use add=documentation to retrieve rule documentation.
The is_global parameter is device dependent. For ACL devices, only global rules are returned when set to true. For Check Point R80, only global layers are returned when set to true, and specify a layer name in the subpolicy_name parameter This parameter is ignored for all other vendors. The default value is false.
The subpolicy_name parameter is device dependent. For Check Point R80, only rules that use the specified layer are returned. You can only specify the name of a single layer. This parameter is ignored for all other vendors.


Parameters:
context: Global MSSP context [optional]
id: Revision id
policyId: Policy id [optional]
policy: Policy name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules only(device dependent, see implementation Notes) [optional]
add: If set to \"documentation\" result will include rule documentation [optional]
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
groupBy: Rules grouping criteria, can be set only to \"bindings\" [optional]
with_zb: Include zone-based rules [optional]
uid: Binding UID [optional]
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
subpolicy_name: Filter by sub policy name (see implementation notes) [optional]
is_alternate_order: OrderBy alternate order, for display Aci rules by contracts [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules?subpolicy_name=layer1&is_global=true
"},"response":[]},{"name":"Get specific rule","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/rules/{{ids}}","description":"Returns a list of rules by device ID, rule IDs and additional criteria.
Note: This API retrieves the information from the latest revision.


Parameters:
context: Global MSSP context [optional]
device_id: Device ID
ids: Rule IDs
policy: Policy Name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules only(device dependent, see implementation Notes) [optional]
add: If set to \"documentation\" result will include rule documentation [optional]
groupBy: Rules grouping criteria, can be set only to \"bindings\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules/16370
"},"response":[]},{"name":"Get specific rule","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/rules/{{ids}}","description":"Returns a list of rules by revision ID, rule IDs and additional criteria

Parameters:
context: Global MSSP context [optional]
revision_id: Revision id
ids: Rule IDs
policy: Policy name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules (Only for: ACL devices) [optional]
add: If set to \\\"documentation\\\" result will include rule documentation [optional]
groupBy: Rules grouping criteria, can be set only to \\\"bindings\\\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules/16370
"},"response":[]},{"name":"Get rules by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules","description":"Returns a list of all of the security rules for the specified device.
Use add=documentation to retrieve rule documentation.
The is_global parameter is device dependent. For ACL devices, only global rules are returned when set to true. For Check Point R80, only global layers are returned when set to true, and specify a layer name in the subpolicy_name parameter This parameter is ignored for all other vendors. The default value is false.
The subpolicy_name parameter is device dependent. For Check Point R80, only rules that use the specified layer are returned. You can only specify the name of a single layer. This parameter is ignored for all other vendors.


Parameters:
context: Global MSSP context [optional]
id: Device ID
policyId: Policy ID [optional]
policy: Policy Name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules (Only for: ACL devices) [optional]
add: If set to \"documentation\" result will include rule documentation [optional]
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
groupBy: Show rules grouping criteria. Can be set only to \"bindings\". Output will be grouped by bindings and section header for Check Point devices, ACL for Cisco devices, and Zones for Juniper, Palo Alto, and Fortinet device [optional]
with_zb: Include zone based rules, values can be 'true' or 'false' [optional]
uid: Binding UID [optional]
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
subpolicy_name: Filter by sub policy name (see implementation notes) [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules?subpolicy_name=layer1&is_global=true
"},"response":[]},{"name":"Get rule count per device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/rule_search/","description":"The search_text parameter provides the same capabilities as the Policy Browser feature in SecureTrack.
You can search for a string across all rule fields, or you can search for a combination of specific strings in specific fields.
The text format is for a field is <fieldname>:<text> for example uid:9259f6ee-47a0-4996-a214-ab7edc14a916.
See the search info documentation in Securetrack Policy Browser page for more information.
This API will return a list of all the devices, the devices that has rules that match the search criteria will have rule_count that is bigger than 0

Parameters:
context: Global MSSP context [optional]
search_text: Search text [optional]
devices: Devices ids [optional]

Usage Example
https://192.168.1.1/securetrack/api/rule_search/87

Usage Example
https://192.168.1.1/securetrack/api/rule_search/87?search_text=ICMP application:facebook

Usage Example
URLhttps://192.168.1.1/securetrack/api/rule_search?search_text=uid:9259f6ee-47a0-4996-a214-ab7edc14a916
OUTPUT{
    \"device_list\":{
        \"device\":[
            {
                \"device_id\":512,
                \"revision_id\":6864,
                \"rule_count\":1
            },
            {
                \"device_id\":59,
                \"revision_id\":543,
                \"rule_count\":0
            }
        ]
    }
}

"},"response":[]},{"name":"Find rules","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/rule_search/{{device_id}}","description":"The search_text parameter provides the same capabilities as the Policy Browser feature in SecureTrack.
You can search for a string across all rule fields, or you can search for a combination of specific strings in specific fields.
The text format is for a field is <fieldname>:<text> for example uid:9259f6ee-47a0-4996-a214-ab7edc14a916.
See the search info documentation in Securetrack Policy Browser page for more information.To get more information regarding objects included in the returned rules (like src_network or dst_network) use their uid, as the objects’ ID might change.
\n By default, if there are less than 3,000 rules - the API will return all the rules.\nIn case there are more than 3,000 rules the API will return an error code 413 with the error message “There are more than 3000 rules, you must use pagination”

Parameters:
context: Global MSSP context [optional]
search_text: Search text [optional]
device_id: Device id
start: The starting rule to include in the returned results [optional]
count: Number of rules to include in the results [optional]

Usage Example
https://192.168.1.1/securetrack/api/rule_search/31?search_text=source:Sales_192.168.2.60 fromzone:sales tozone:External

Usage Example
https://192.168.1.1/securetrack/api/rule_search/20?search_text=Mobile Access hascomment:false

Usage Example
https://192.168.1.1/securetrack/api/rule_search/87?search_text=web_server&start=0&count=10

Usage Example
URLhttps://192.168.1.1/securetrack/api/rule_search/59?search_text=uid:9259f6ee-47a0-4996-a214-ab7edc14a916
OUTPUT {
    \"rules\":{
        \"count\":1,
        \"total\":1,
        \"rule\":{
            \"@xsi.type\":\"securityRuleDTO\",
            \"id\":21,
            \"cp_uid\":\"\",
            \"uid\":\"{9259f6ee-47a0-4996-a214-ab7edc14a916}\",
            \"order\":2,
            \"binding\":{
                \"default\":true,
                \"policy\":{
                    \"@xsi.type\":\"managementDomainPolicyDTO\",
                    \"id\":2,
                    \"name\":\"Standard\",
                    \"installable_targets\":\"\"
                },
                \"rule_count\":19,
                \"security_rule_count\":19,
                \"uid\":\"{00-FACED0-00}\"
                },
            \"acceleration_breaker\":false,
            \"action\":\"Accept\",
            \"application\":{
                \"id\":4735,
                \"display_name\":\"ssh\",
                \"name\":\"ssh\"
            },
            \"authentication_rule\":false,
            \"comment\":\"DO NOT DELETE OR EDIT\",
            \"dst_network\":{
                \"id\":39,
                \"display_name\":\"Net_10.110.65.0\",
                \"name\":\"Net_10.110.65.0\"
                \"uid\":\"{1290f6ee-47a1-4996-a214-ab2edc26a916}\"
            },
            \"dest_networks_negated\":false,
            \"dst_service\":{
                \"id\":7420,
                \"display_name\":\"ssh\",
                \"name\":\"ssh\"
                \"uid\":\"{2904f6ee-47a1-4996-a214-ab2edc26a916}\"
            },
            \"dest_services_negated\":false,
            \"dst_zone\":\"any\",
            \"disabled\":false,
            \"external\":false,
            \"implicit\":false,
            \"dst_zone_any\":true,
            \"src_zone_any\":true,
            \"name\":\"Accept SSHG\",
            \"option\":\"LOG_SESSION\",
            \"documentation\":{
                \"permissiveness_level\":\"LOW\",
                \"shadowed\":\"Not shadowed\",
                \"last_modified\":\"Today\",
                \"last_hit\":\"N/A\",
                \"violations\":\"\"
            },
            \"rule_location\":\"Shared\",
            \"rule_location_display\":\"Shared - Pre Rule\",
            \"rule_number\":2,
            \"rule_type\":\"universal\",
            \"src_zone\":\"any\",
            \"src_network\":{
                \"id\":38,
                \"display_name\":\"Net_10.110.64.0\",
                \"name\":\"Net_10.110.64.0\"
                \"uid\":\"{4934f6ee-47a1-4996-a214-ab2edc26a916}\"
            },
            \"src_networks_negated\":false,
            \"src_services_negated\":false,
            \"track\":{
                \"level\":\"LOG\"
            },
            \"type\":\"rule\",
            \"users\":{
                \"id\":5,
                \"display_name\":\"tufin\\\\regina\",
                \"name\":\"tufin\\\\regina@ldap\"
            }
        }
    }
}


Response Messages:
400: Value for start parameter is missing or not valid
400: Value for count parameter is missing or not valid
413: Max supported count is 3000
413: There are more than 3000 rules, you must use pagination"},"response":[]},{"name":"Create a CSV file for rules search results","request":{"method":"GET","header":[],"url":"https://{{SecureTrack_IP}}/securetrack/api/rule_search/export","description":"The search_text parameter provides the same capabilities as the Policy Browser feature in SecureTrack.
You can search for a string across all rule fields, or you can search for a combination of specific strings in specific fields.
The text format is for a field is : for example uid:9259f6ee-47a0-4996-a214-ab7edc14a916.
See the search info documentation in Securetrack Policy Browser page for more information.
This API exports the results data as a CSV file in the SecureTrack Reports Repository.

Parameters:
context: Global MSSP context [optional]
search_text: Search text [optional]

Usage Example
https://192.168.1.1/securetrack/api/rule_search/export

Usage Example
https://192.168.1.1/securetrack/api/rule_search/export?search_text=shadowed:true
"},"response":[]},{"name":"Get a specific rule","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"ruleId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/rules/{{ruleId}}","description":"Parameters:
ruleId: Rule ID

Usage Example
https://192.168.1.1/securetrack/api/rules/60
"},"response":[]}]},{"name":"Services and Ports","item":[{"name":"Get service groups containing specified service objects","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/services/{{id}}/groups","description":"Returns groups that contain the specified service objects


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the service object.

Usage Example
https://192.168.1.1/securetrack/api/services/69577/groups
"},"response":[]},{"name":"Get specific service","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/services/{{ids}}","description":"Fetches list of specific service objects defined in device given by device ID and specified by their IDs.
Note: This API retrieves the information from the latest revision.

Parameters:
context: Global MSSP context [optional]
device_id: Device ID
ids: Service object IDs separated by commas
show_members: Set to false to return only the name and ID of the members [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/services/959888,959966
"},"response":[]},{"name":"Get services by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/services","description":"Fetches list of service objects defined on device given by device ID.
The default value for get_total is false. For APIF 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.


Parameters:
context: Global MSSP context [optional]
id: Device ID
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
start: Starting page for query allowable types are numeric [optional]
count: Number of pages for query allowable values are numeric [optional]
name: Service name [optional]
type: Service type, allowable values are: tcp, udp, ip or icmp [optional]
port: Service port [optional]
icmp_type: Service ICMP type allowable values are numeric between 0 to 40 [optional]
protocol: Service protocol, allowable values are numeric between 0 to 255 [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/20/services?get_total=true
OUTPUT {
    \"services\": {
        \"count\": 50,
        \"total\": 100,
        \"service\": [{
            \"@xsi.type\": \"singleServiceDTO\",
            \"id\": 5129479,
            \"name\": \"Tcp30025\",
            \"display_name\": \"Tcp30025\",
            \"class_name\": \"tcp_service\",
            \"type\": \"tcp_service\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{079F15A5-009E-7E47-BBD0-E65973646562}\",
            \"implicit\": false,
            \"overrides\": false,
            \"max\": 30025,
            \"min\": 30025,
            \"negate\": false,
            \"protocol\": 6,
            \"timeout\": 0
        }]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/services?type=group&show_members=false
OUTPUT{
    \"services\": {
    \"count\": 100,
        \"service\": [
            {
                \"@xsi.type\": \"serviceGroupDTO\",
                \"id\": 1359066,
                \"name\": \"#Shared Domain@DNS\",
                \"display_name\": \"DNS\",
                \"class_name\": \"service_group\",
                \"type\": \"group\",
                \"global\": \"false\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": false,
                \"overrides\": \"false\",
                \"type_on_device\": gen_service_group,
                \"is_device_predefined\": true,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"DNS\",
                    \"name\": \"#Shared Domain@DNS\",
            }
        ]
    }
}

"},"response":[]},{"name":"Get rules containing specified service object","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/services/{{id}}/rules","description":"Returns the security rules that contain the specified service object


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the service object.
include_groups: You can add \"include_groups\" to find rules that include the service object and rules that include the groups that include the service object. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]

Usage Example
https://192.168.1.1/securetrack/api/services/65078/rules?include_groups=true
"},"response":[]},{"name":"Get services by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/services","description":"Fetches list of service objects defined in revision given by revision ID
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.


Parameters:
context: Global MSSP context [optional]
id: Revision id
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
start: Starting page for query allowable types are numeric [optional]
count: Number of pages for query allowable values are numeric [optional]
name: Service name [optional]
type: Service type, allowable values are: tcp, udp, ip or icmp [optional]
port: Service port [optional]
icmp_type: Service ICMP type allowable values are numeric between 0 to 40 [optional]
protocol: Service protocol, allowable values are numeric betweenm 0 to 255 [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/785/services?get_total=true
OUTPUT {
    \"services\": {
        \"count\": 50,
        \"total\": 100,
        \"service\": [{
            \"@xsi.type\": \"singleServiceDTO\",
            \"id\": 5129479,
            \"name\": \"Tcp30025\",
            \"display_name\": \"Tcp30025\",
            \"class_name\": \"tcp_service\",
            \"type\": \"tcp_service\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{079F15A5-009E-7E47-BBD0-E65973646562}\",
            \"implicit\": false,
            \"overrides\": false,
            \"max\": 30025,
            \"min\": 30025,
            \"negate\": false,
            \"protocol\": 6,
            \"timeout\": 0
        }]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/31/services?type=group&show_members=false
OUTPUT{
    \"services\": {
    \"count\": 100,
        \"service\": [
            {
                \"@xsi.type\": \"serviceGroupDTO\",
                \"id\": 1359066,
                \"name\": \"#Shared Domain@DNS\",
                \"display_name\": \"DNS\",
                \"class_name\": \"service_group\",
                \"type\": \"group\",
                \"global\": \"false\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": false,
                \"overrides\": \"false\",
                \"type_on_device\": gen_service_group,
                \"is_device_predefined\": true,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"DNS\",
                    \"name\": \"#Shared Domain@DNS\",
            }
        ]
    }
}

"},"response":[]},{"name":"Get specific service","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/services/{{ids}}","description":"Fetches list of specific service objects defined in revision given by revision ID and specified by their IDs

Parameters:
context: Global MSSP context [optional]
revision_id: Revision id
ids: Rule IDs
show_members: Set to false to return only the name and ID of the members [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/services/959888
"},"response":[]},{"name":"Get services objects matching specified criteria","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"services\": {\n\t\t\"count\": 1,\n\t\t\"total\": 1,\n\t\t\"service:\": {\n\t\t\t\"id\": 169197,\n\t\t\t\"name\": \"tcp_10\",\n\t\t\t\"display_name\": \"tcp_10\",\n\t\t\t\"class_name\": \"access_role\",\n\t\t\t\"global\": false,\n\t\t\t\"device_id\": 158,\n\t\t\t\"comment\": \"\",\n\t\t\t\"uid\": \"{9EDC2607-6BEC-43D7-A99D-B522BA694ADA}\",\n\t\t\t\"implicit\": false,\n\t\t\t\"max\": false,\n\t\t\t\"min\": false,\n\t\t\t\"protocol\": 6,\n\t\t\t\"timeout\": \"\",\n\t\t\t\"type\": \"tcp_service\",\n\t\t\t}\n\t\t}\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/services/search","description":"You can search for service objects where the name or comment fields have a specified text string,
or you can search for service objects that have an Port or protocol that matches,
or you can search for service objects by uid.

Parameters:
context: Returns results for the specified domain ID. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]
filter: “text” filter returns service objects where the name or comment fields have a specified text string. \n“protocol” filter returns service objects that have a protocol that matches specified IP protocol number.\n“port” filter returns service objects that have a port that matches specified port number.\n “uid“ filter returns service objects with the specified uid.\n If no filter is specified, the “text” filter is used.
device_id: Returns service objects belonging to the specified device_id. [optional]
name: (For “text” filter) You can specify \"name\" to find service objects with the specified text in the name field. [optional]
comment: (For “text” filter) You can specify “comment” to find service objects with the specified text in the comment field. [optional]
protocol: Specify Protocolto find service objects that have the specified IP Protocol. [optional]
port: Specify Portto find service objects that have the specified Port. [optional]
uid: (for “uid“ filter) Returns service objects with the specified uid. [optional]

Usage Example
https://192.168.1.1/securetrack/api/services/search?filter=protocol&protocol=6&device_id=68

Usage Example
https://192.168.1.1/securetrack/api/services/search?filter=port&port=80

Usage Example
https://192.168.1.1/securetrack/api/services/search?filter=uid&uid=24a8774d-24c1-4b3a-aae9-3c272a2b5191

Usage Example
URLhttps://192.168.1.1/securetrack/api/services/search?filter=text&name=tcp_10
BODY{
    \"services\": {
        \"count\": 1,
        \"total\": 1,
        \"service:\": {
            \"id\": 169197,
            \"name\": \"tcp_10\",
            \"display_name\": \"tcp_10\",
            \"class_name\": \"access_role\",
            \"global\": false,
            \"device_id\": 158,
            \"comment\": \"\",
            \"uid\": \"{9EDC2607-6BEC-43D7-A99D-B522BA694ADA}\",
            \"implicit\": false,
            \"max\": false,
            \"min\": false,
            \"protocol\": 6,
            \"timeout\": \"\",
            \"type\": \"tcp_service\",
            }
        }
    }
}

"},"response":[]}]},{"name":"Time Objects","item":[{"name":"Get time objects by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/time_objects","description":"Returns the time objects used in the specified device.

Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable values are numeric [optional]
count: Starting page for query allowable values are numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/time_objects
"},"response":[]},{"name":"Get time objects by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/time_objects","description":"Returns the time objects used in the specified revision.

Parameters:
context: Global MSSP context [optional]
id: Revision ID
start: Starting page for query allowable value is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/time_objects
"},"response":[]},{"name":"Get specific time object","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/time_objects/{{ids}}","description":"Fetches list of time objects by revision ID and rule ID

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Rule IDs

Usage Example
https://192.168.1.1/securetrack/api/revisions/7/time_objects/9
"},"response":[]}]},{"name":"Traffic Policy Matcher","item":[{"name":"Get policy relevance metrics for traffic","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"relevance_metrics\": {\n\t\t\"source_ips\": {\n\t\t\t\"source\":[\"10.10.253.0/24\", \"172.31.50.99/32\"]\n\t\t},\n\t\t\"dest_ips\": {\n\t\t\t\"dest\": [\"172.31.150.0/24\", \"172.31.50.99/32\"]\n\t\t},\n\t\t\"targets\": {\n\t\t\t\"target\": [4, 10]\n\t\t}\n\t}\n}\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/traffic_policy/","description":"The response lists all the relevant security groups, tags, relevant instances, and count of unrelated instances for each Amazon VPC in the specified traffic path.
A relevant security group contains at least one instance including either the source or destination IP address.
An unrelated instance is included in the security group but not part of the specified traffic path.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is used only if MSSP mode is enabled. If MSSP mode is disabled context is ignored.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.

Parameters:
context: Global MSSP context [optional]
body: Relevance metrics request

Usage Example
URLhttps://192.168.1.1/securetrack/api/traffic_policy
BODY{
    \"relevance_metrics\": {
        \"source_ips\": {
            \"source\":[\"10.10.253.0/24\", \"172.31.50.99/32\"]
        },
        \"dest_ips\": {
            \"dest\": [\"172.31.150.0/24\", \"172.31.50.99/32\"]
        },
        \"targets\": {
            \"target\": [4, 10]
        }
    }
}


Response Messages:
200: Successful
401: Insufficient user permissions
404: Device not found
400: Invalid parameters"},"response":[]}]},{"name":"Unified Security Policy - Access Request Violations","item":[{"name":"Cancel violation task","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/task/{{taskId}}","description":"Delete an access request violations task.

Parameters:
taskId: The unique identifier of the access request violations task.

Usage Example
https://192.168.1.1/securetrack/api/violations/access_requests/task/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
204: Access request violations task has been aborted successfully.
401: Access is denied.
404: Access request violations task was not found."},"response":[]},{"name":"Start a task to calculate violations for an access request","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t false\n\t 0\n\t \n\t \n\t\t \n\t\t false\n\t\t 10.100.0.1\n\t\t 255.255.255.255\n\t\t \n\t \n\t \n\t\t ssh\n\t\t \n\t\t\t true\n\t\t\t 6\n\t\t\t 6\n\t\t\t 22\n\t\t\t 22\n\t\t\t false\n\t\t \n\t \n\t ACCEPT\n\t\n\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/task","description":"Create a calculation task to find access requests violations.
Returns a task Id that can be used to check the task status and get the task results

Parameters:
body [optional]
use_topology: Use topology to determine access request domains. [optional]
ar_domain_mode: The access request uses resources from multiple domains. [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/violations/access_requests/task?use_topology=false&ar_domain_mode=false
BODY<access_requests>
    <access_request>
     <use_topology>false</use_topology>
     <access_request_order>0</access_request_order>
     <access_request_source xsi:type=\"internet\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"/>
     <access_request_destination xsi:type=\"ip_network\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <network xsi:type=\"raw_network_subnet\">
         <negate>false</negate>
         <ip>10.100.0.1</ip>
         <mask>255.255.255.255</mask>
         </network>
     </access_request_destination>
     <access_request_service xsi:type=\"implicit_service\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <name>ssh</name>
         <service>
             <predefined>true</predefined>
             <min_protocol>6</min_protocol>
             <max_protocol>6</max_protocol>
             <min_port>22</min_port>
             <max_port>22</max_port>
             <negate>false</negate>
         </service>
     </access_request_service>
     <action>ACCEPT</action>
    </access_request>
</access_requests>


Response Messages:
202: Access request violations task was accepted.
400: Access request order is not unique.
400: Domain cannot be specified when domain mode is false.
400: Cannot specify both ticket domain id and source and destination domains.
400: No domain specified in MSSP mode.
400: Domain does not exist.
400: Access request is malformed.
400: No valid access requests (Access requests cannot have topology enabled and the Internet object in the Source/Destination)
400: No network source were specified.
400: No network destination were specified.
401: Access is denied.
503: Access request violations task was rejected."},"response":[]},{"name":"Get violation task results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/result/{{taskId}}","description":"Get result of access requests violations task.

Parameters:
taskId: The unique identifier of the access request violations task.

Usage Example
https://192.168.1.1/securetrack/api/violations/access_requests/result/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Access request violations task results were received.
401: Access is denied.
404: An error occurred during the calculation.
404: The calculation for the task has not finished yet."},"response":[]},{"name":"Get violation task status","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/status/{{taskId}}","description":"Get access requests violations task status.

Parameters:
taskId: The unique identifier of the access request violations task.

Usage Example
https://192.168.1.1/securetrack/api/violations/access_requests/status/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Access request violations task status was received.
401: Access is denied.
404: Access request violations task status was not found."},"response":[]},{"name":"Get violations for an access request","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t false\n\t 0\n\t \n\t \n\t\t \n\t\t false\n\t\t 10.100.0.1\n\t\t 255.255.255.255\n\t\t \n\t \n\t \n\t\t ssh\n\t\t \n\t\t\t true\n\t\t\t 6\n\t\t\t 6\n\t\t\t 22\n\t\t\t 22\n\t\t\t false\n\t\t \n\t \n\t ACCEPT\n\t\n\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/sync","description":"Calculate the violations for the given access request.
Note: this API may take a while to complete.
See the asynchronous API /violations/access_request/task as an alternative.

Parameters:
body: AccessRequestListDTO
use_topology: Use topology to determine access request domains. [optional]
ar_domain_mode: The access request supports multiple domains. [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/violations/access_requests/sync?use_topology=false&ar_domain_mode=false
BODY<access_requests>
    <access_request>
     <use_topology>false</use_topology>
     <access_request_order>0</access_request_order>
     <access_request_source xsi:type=\"internet\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"/>
     <access_request_destination xsi:type=\"ip_network\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <network xsi:type=\"raw_network_subnet\">
         <negate>false</negate>
         <ip>10.100.0.1</ip>
         <mask>255.255.255.255</mask>
         </network>
     </access_request_destination>
     <access_request_service xsi:type=\"implicit_service\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <name>ssh</name>
         <service>
             <predefined>true</predefined>
             <min_protocol>6</min_protocol>
             <max_protocol>6</max_protocol>
             <min_port>22</min_port>
             <max_port>22</max_port>
             <negate>false</negate>
         </service>
     </access_request_service>
     <action>ACCEPT</action>
    </access_request>
</access_requests>


Response Messages:
200: Access request violations were calculated.
400: Access request order is not unique.
400: Domain cannot be specified when domain mode is false.
400: Cannot specify both ticket domain id and source and destination domains.
400: No domain specified in MSSP mode.
400: Domain does not exist.
400: Access request is malformed.
400: No valid access requests (Access requests cannot have topology enabled and the Internet object in the Source/Destination).
401: Access is denied."},"response":[]}]},{"name":"Unified Security Policy - Alerts","item":[{"name":"Delete alerts by ids","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/{{ids}}","description":"Delete specified alerts by IDs
To delete multiple alert_ids, use a comma between each ID

Parameters:
context: Delete alerts in the specified domain ID. [optional]
ids: The alert Ids for deletion

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts/87

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts/86,87,88

Response Messages:
200:
401: Security Policy Alert Ids: :|'alert ids'| don't exist"},"response":[]},{"name":"Get a specific alert","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/{{id}}","description":"Returns a specified alert.
If the alert_id does not exist, an error message is returned.

Parameters:
context: MSSP context [optional]
id: The alert Id

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts/1

Response Messages:
401: Alert ID does not exist"},"response":[]},{"name":"Update an alert","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"usp_alert_configuration\": {\n\t\t\"name\": \"uspAlert\",\n\t\t\"description\": \"description\",\n\t\t\"status\": \"ACTIVE\",\n\t\t\"domain_id\": 6,\n\t\t\"all_devices\": false,\n\t\t\"device_ids\": {\n\t\t\t\"device_id\": [\n\t\t\t\t1,\n\t\t\t\t2,\n\t\t\t\t3,\n\t\t\t\t4\n\t\t\t]\n\t\t},\n\t\t\"low_severity\": true,\n\t\t\"medium_severity\": true,\n\t\t\"high_severity\": true,\n\t\t\"critical_severity\": false,\n\t\t\"user_ids\": {\n\t\t\t\"user_id\": \"moshe\"\n\t\t},\n\t\t\"emails\": \"user@doamin.com\",\n\t\t\"send_syslog\": true\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/{{id}}","description":"Update an alert for unified security policies.
Alerts can be defined for all devices (all_devices:true) or for specified device IDs.
An email and/or user name must be defined. For multiple entries of emails or user names, use a semicolon to separate values. For SecureTrack, users in the collection are populated with \"user_ids\". The alert will be sent to the users (according to the addresses configured in SecureTrack) and to the emails.
To get the domain_id (optional parameter), call /domains/ API and use the ID included within the returned domain DTO.
At least one severity should be marked as 'true'.
There are no default values

Parameters:
context: Global MSSP context [optional]
id: The alert ID for updating [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_policies/alerts/1
BODY{
    \"usp_alert_configuration\": {
        \"name\": \"uspAlert\",
        \"description\": \"description\",
        \"status\": \"ACTIVE\",
        \"domain_id\": 6,
        \"all_devices\": false,
        \"device_ids\": {
            \"device_id\": [
                1,
                2,
                3,
                4
            ]
        },
        \"low_severity\": true,
        \"medium_severity\": true,
        \"high_severity\": true,
        \"critical_severity\": false,
        \"user_ids\": {
            \"user_id\": \"moshe\"
        },
        \"emails\": \"user@doamin.com\",
        \"send_syslog\": true
    }
}


Response Messages:
204: Alert ID: 'alertId' was updated successfully
404: Alert ID: 'alertId' does not exist
412: Alert name not specified
409: Alert name specified already exists
412: Status not specified
412: Domain not specified
404: Domain specified does not exist
401: User is not authorized to configure alerts for domain 'domainId'
412: Device not specified
404: Device ID specified does not exist or belongs to a different domain
403: Device: 'deviceId' not supported for USP
412: Severity not specified
412: No recipient details entered for alert
412: Invalid email address. Format must be name@domain.com
404: Username: 'userName' does not exist
403: User is not authorized to configure alerts for Super Admin user: 'userName'
403: Username: 'userName' not valid for the specified domain"},"response":[]},{"name":"Get alerts","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"start"},{"value":null,"type":"text","key":"count"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/","description":"Returns a list of all alerts. If an empty list is returned, it implies that there are no configured alerts for that context.
You must set start and count parameters to limit the number of returned alerts.
Start is zero based - to start from the second rule use start=1, to get rules 51-60 use start=50 and count=10.

Parameters:
context: MSSP context [optional]
start: Returns the results beginning with the specified result number
count: Returns the specified number of results

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts?start=10&count=25

Response Messages:
400: Value for start parameter is missing or not valid
400: Value for count parameter is missing or not valid"},"response":[]},{"name":"Create an alert","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"usp_alert_configuration\": {\n\t\t\"name\": \"uspAlert\",\n\t\t\"description\": \"description\",\n\t\t\"status\": \"ACTIVE\",\n\t\t\"domain_id\": 6,\n\t\t\"all_devices\": false,\n\t\t\"device_ids\": {\n\t\t\t\"device_id\": [\n\t\t\t\t1,\n\t\t\t\t2,\n\t\t\t\t3,\n\t\t\t\t4\n\t\t\t]\n\t\t},\n\t\t\"low_severity\": true,\n\t\t\"medium_severity\": true,\n\t\t\"high_severity\": true,\n\t\t\"critical_severity\": false,\n\t\t\"user_ids\": {\n\t\t\t\"user_id\": \"moshe\"\n\t\t},\n\t\t\"emails\": \"user@doamin.com\",\n\t\t\"send_syslog\": true\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/","description":"Create an alert for unified security policies.
Returns location with the alert id to get the alert.
Alerts can be defined for all devices (all_devices:true) or for specified device IDs.
An email and/or user name must be defined. For multiple entries of emails or user names, use a semicolon to separate values. For SecureTrack, users in the collection are populated with \"user_ids\". The alert will be sent to the users (according to the addresses configured in SecureTrack) and to the emails.
To get the domain_id (optional parameter), call /domains/ API and use the ID included within the returned domain DTO.
At least one severity should be marked as 'true'.
There are no default values

Parameters:
context: Global MSSP context [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_policies/alerts
BODY{
    \"usp_alert_configuration\": {
        \"name\": \"uspAlert\",
        \"description\": \"description\",
        \"status\": \"ACTIVE\",
        \"domain_id\": 6,
        \"all_devices\": false,
        \"device_ids\": {
            \"device_id\": [
                1,
                2,
                3,
                4
            ]
        },
        \"low_severity\": true,
        \"medium_severity\": true,
        \"high_severity\": true,
        \"critical_severity\": false,
        \"user_ids\": {
            \"user_id\": \"moshe\"
        },
        \"emails\": \"user@doamin.com\",
        \"send_syslog\": true
    }
}


Response Messages:
201: Security policy alert id :|'alertId'| , name : 'alertName'
412: Alert name not specified
409: Alert name specified already exists
412: Status not specified
412: Domain not specified
404: Domain specified does not exist
401: User is not authorized to configure alerts for domain 'domainId'
412: Device not specified
404: Device ID specified does not exist or belongs to a different domain
403: Device: 'deviceId' not supported for USP
412: Severity not specified
412: No recipient details entered for alert
412: Invalid email address. Format must be name@domain.com
404: Username: 'userName' does not exist
403: User is not authorized to configure alerts for Super Admin user: 'userName'
403: Username: 'userName' not valid for the specified domain"},"response":[]}]},{"name":"Unified Security Policy - Cloud Tag Policy","item":[{"name":"Check if tags are compliant with cloud tag policies","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":" {\n\t\"type\": \"vm\",\n\t\"name\": \"CRM-FE\",\n\t\"os\": \"ubuntu14.4\",\n\t\"image\": \"AMI-12345\",\n\t\"tags\": {\n\t\t\"Role\": \"webserver\",\n\t\t\"Budget\": \"corporate\",\n\t\t\"Owner\": \"Steve.Smith\"\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/violation_check/","description":"Check if the tags of a cloud resource are compliant with the specified cloud tag policy. Specify the tag policy to validate in the TagPolicyViolationsCheckRequestDTO. The tags of a cloud resource are specified as a json object with the attribute 'tags' at the root level. 'tags' attributes can be a list of tag names or a map including both the tag name and value. If no tags are specified or if the tag is specified incorrectly, The compliance check will treat the resource as if it has no tags. If no cloud tag policy violations are found the API returns an empty violations list.

Parameters:
context: Returns results for the specified domain ID [optional]
policy_external_id: Tag policy external identifier
body: Tag policy violation check request

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/violation_check?policy_external_id=policyId
BODY {
    \"type\": \"vm\",
    \"name\": \"CRM-FE\",
    \"os\": \"ubuntu14.4\",
    \"image\": \"AMI-12345\",
    \"tags\": {
        \"Role\": \"webserver\",
        \"Budget\": \"corporate\",
        \"Owner\": \"Steve.Smith\"
    }
}


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions
404: Resource not found"},"response":[]},{"name":"Get all cloud tag policies","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/policies/","description":"This API returns the details of all the tag policies.

Results are filtered according to user domain permissions and request context. If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Returns results for the specified domain ID [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/
OUTPUT{
        \"status\": \"OK\",
        \"result\": [
                {
                        \"policy_id\": \"tp-101\",
                        \"policy_name\": \"myPolicy1\",
                        \"requirements\": [
                                {
                                        \"requirement_type\": \"mandatory_tags\",
                                        \"requirement_name\": \"myMandatoryRequirement\",
                                        \"requirement_severity\": \"HIGH\",
                                        \"tags\": [
                                                \"Owner\",
                                                \"Name\"
                                        ]
                                },
                                {
                                        \"requirement_type\": \"valid_values\",
                                        \"requirement_name\": \"myValidValueRequirement\",
                                        \"requirement_severity\": \"CRTICAL\",
                                        \"tag\": \"Budget\",
                                        \"values\": [
                                                \"R&D\",
                                                \"HR\"
                                        ]
                                }
                        ]
                },
                {
                        \"policy_id\": \"tp-102\",
                        \"policy_name\": \"myPolicy2\",
                        \"requirements\": [
                                {
                                        \"requirement_type\": \"mandatory_tags\",
                                        \"requirement_name\": \"myMandatoryRequirement\",
                                        \"requirement_severity\": \"HIGH\",
                                        \"tags\": [
                                                \"Owner\"
                                        ]
                                },
                                {
                                        \"requirement_type\": \"valid_values\",
                                        \"requirement_name\": \"myValidValueRequirement\",
                                        \"requirement_severity\": \"CRTICAL\",
                                        \"tag\": \"Budget\",
                                        \"values\": [
                                                \"R&D\",
                                                \"HR\"
                                        ]
                                }
                        ]
                }
        ]
}


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions"},"response":[]},{"name":"Create a cloud tag policy","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":" {\n\t\"policy_name\": \"Production-VPC-Tag-Policy\",\n\t\"policy_description\": \"Instances tags in production\",\n\t\"requirements\": [\n\t\t{\n\t\t\t\"requirement_type\": \"mandatory_tags\",\n\t\t\t\"requirement_name\": \"mandatory_financial_tags\",\n\t\t\t\"requirement_severity\": \"HIGH\",\n\t\t\t\"tags\": [\n\t\t\t\t\"Owner\",\n\t\t\t\t\"Budget\"\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"requirement_type\": \"valid_values\",\n\t\t\t\"requirement_name\": \"budget_valid_values\",\n\t\t\t\"requirement_severity\": \"CRITICAL\",\n\t\t\t\"tag\": \"Budget\",\n\t\t\t\"values\": [\n\t\t\t\t\"Corporate\",\n\t\t\t\t\"Dev\"\n\t\t\t]\n\t\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/policies/","description":"Create a new cloud tag policy. The policyName field specified in the TagPolicyDTO must be unique. Define the requirements enforced by the cloud tag policy in the requirements field of the TagPolicyDTO. The supported value for the \"requirement_type\" field are \"mandatory_tags\" and \"valid_values\"If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Create policy for the specified domain ID [optional]
body: cloud tag policy DTO [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/
BODY {
    \"policy_name\": \"Production-VPC-Tag-Policy\",
    \"policy_description\": \"Instances tags in production\",
    \"requirements\": [
        {
            \"requirement_type\": \"mandatory_tags\",
            \"requirement_name\": \"mandatory_financial_tags\",
            \"requirement_severity\": \"HIGH\",
            \"tags\": [
                \"Owner\",
                \"Budget\"
            ]
        },
        {
            \"requirement_type\": \"valid_values\",
            \"requirement_name\": \"budget_valid_values\",
            \"requirement_severity\": \"CRITICAL\",
            \"tag\": \"Budget\",
            \"values\": [
                \"Corporate\",
                \"Dev\"
            ]
        }
    ]
}
OUTPUT{
        \"status\": \"OK\",
        \"policy_id\": \"tp-123\"
}


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions
409: Policy name already exists"},"response":[]},{"name":"Get all cloud tag policy violations for a VPC","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"deviceId"},{"value":null,"type":"text","key":"severity"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/tag_violations/","description":"Retrieve all cloud tag policy violations for the specified VPC and severity level.

Parameters:
context: Global MSSP context. [optional]
deviceId: The device ID for which to get violations
severity: Return only violations of this severity
resourceId: The id of the VM instance [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses \"count=100\". [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tag_violations?deviceId=123&severity=CRITICAL
OUTPUT<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<tag_policy_device_violations>
    <violating_resources_count>2</violating_resources_count>
    <device_name>Amazon Test VPC </device_name>
    <severity>critical</severity>
    <violating_resources>
        <violating_resource>
            <tag_violations>
                <tag_violation>
                    <violation_message>Tag 'Name' value 'email server' is not valid. Valid values are [R&D, HR]</violation_message>
                    <policy_id>tp-100</policy_id>
                    <policy_name>Tag policy 1</policy_name>
                    <requirement_name>validValue_constraint2</requirement_name>
                    <requirement_severity>high</requirement_severity>
                    <violation_attributes xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"valid_values\">
                        <tag>Name</tag>
                        <valid_values>
                            <valid_value>R&D</valid_value>
                            <valid_value>HR</valid_value>
                        </valid_values>
                        <invalid_value>email server</invalid_value>
                    </violation_attributes>
                </tag_violation>
            </tag_violations>
            <resource_id>i-abc12345</resource_id>
            <resource_name>email server</resource_name>
        </violating_resource>
        <violating_resource>
            <tag_violations>
                <tag_violation>
                    <violation_message>Tag 'Application' is missing</violation_message>
                    <policy_id>tp-105</policy_id>
                    <policy_name>Tag policy 1</policy_name>
                    <requirement_name>mandatory_constraint1</requirement_name>
                    <requirement_severity>critical</requirement_severity>
                    <violation_attributes xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"mandatory_tags\">
                        <missing_tag>Application</missing_tag>
                    </violation_attributes>
                </tag_violation>
            </tag_violations>
            <resource_id>i-12345678</resource_id>
            <resource_name>Violations tests server</resource_name>
        </violating_resource>
    </violating_resources>
</tag_policy_device_violations>


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions
404: A device with the specified ID was not found"},"response":[]},{"name":"Replace a cloud tag policy","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"policy_name\": \"myPolicyName\",\n\t\"requirements\": [\n\t\t{\n\t\t\t\"requirement_type\": \"mandatory_tags\",\n\t\t\t\"requirement_name\": \"mandatory_requirement1\",\n\t\t\t\"requirement_severity\": \"CRTICAL\",\n\t\t\t\"tags\": [\n\t\t\t\t\"Owner\",\n\t\t\t\t\"Role\"\n\t\t\t]\n\t\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","description":"Replace the cloud tag policy specified by policyID with the new policy attributes.

Use PATCH in order to partially modify a policy. If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Replace policy of the specified domain ID [optional]
policyId: cloud tag policy id [optional]
body: cloud tag policy dTO [optional]

Usage Example
URLhttps://{ip}/securetrack/api/tagpolicy/policies/policyId
BODY{
    \"policy_name\": \"myPolicyName\",
    \"requirements\": [
        {
            \"requirement_type\": \"mandatory_tags\",
            \"requirement_name\": \"mandatory_requirement1\",
            \"requirement_severity\": \"CRTICAL\",
            \"tags\": [
                \"Owner\",
                \"Role\"
            ]
        }
    ]
}
OUTPUT{
        \"status\": \"OK\",
        \"policy_id\": \"tp-123\"
}

"},"response":[]},{"name":"Modify a cloud tag policy","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"policy_name\": \"myPolicyName\",\n\t\"requirements\": [\n\t\t{\n\t\t\t\"requirement_type\": \"mandatory_tags\",\n\t\t\t\"requirement_name\": \"mandatory_requirement1\",\n\t\t\t\"requirement_severity\": \"CRTICAL\",\n\t\t\t\"tags\": [\n\t\t\t\t\"Owner\",\n\t\t\t\t\"Role\"\n\t\t\t]\n\t\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","description":"Partially modify a cloud tag policy by stating the modified attributes. Providing requirements replaces the entire list.

Specifying an empty requirement list is not permitted. Modify some attributes of the cloud tag policy specified by policyID with the attributes provided. If one or more \"requirement\" objects is provided, the exsiting \"requirement\" objects will be deleted and replaced with the new objetcs. Specifying an empty requirement list is not permitted.If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Rename policy of the specified domain ID [optional]
policyId: cloud tag policy id [optional]
body: cloud tag policy dTO [optional]

Usage Example
URLhttps://{ip}/securetrack/api/tagpolicy/policies/policyId
BODY{
    \"policy_name\": \"myPolicyName\",
    \"requirements\": [
        {
            \"requirement_type\": \"mandatory_tags\",
            \"requirement_name\": \"mandatory_requirement1\",
            \"requirement_severity\": \"CRTICAL\",
            \"tags\": [
                \"Owner\",
                \"Role\"
            ]
        }
    ]
}
OUTPUT{
        \"status\": \"OK\",
        \"policy_id\": \"tp-123\"
}


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions
404: Resource not found"},"response":[]},{"name":"Delete cloud tag policy","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","description":"Delete the cloud tag policy specified by policyId.

If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Delete policy of the specified domain ID [optional]
policyId: cloud tag policy id [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/policyId
OUTPUT {
        \"status\": \"OK\",
        \"policy_name\": \"myPolicyName\"
}


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions
404: Resource not found"},"response":[]},{"name":"Get cloud tag policy","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","description":"This API retrieves the details of the cloud tag policy specified by policyId.

User must have admin permissions to the policy affiliated domain. If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Returns results for the specified domain ID [optional]
policyId: cloud tag policy id [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/policyId
OUTPUT{
        \"status\": \"OK\",
        \"result\": [
                {
                        \"policy_id\": \"tp-101\",
                        \"policy_name\": \"myPolicyName\",
                        \"requirements\": [
                                {
                                        \"requirement_type\": \"mandatory_tags\",
                                        \"requirement_name\": \"myMandatoryTagsRequirement\",
                                    \"requirement_severity\": \"CRTICAL\",
                                        \"tags\": [
                                                \"Owner\",
                                                \"Name\"
                                        ]
                                },
                                {
                                        \"requirement_type\": \"valid_values\",
                                        \"requirement_name\": \"myValidValueRequirement\",
                                    \"requirement_severity\": \"CRTICAL\",
                                        \"tag\": \"Budget\",
                                        \"values\": [
                                                \"R&D\",
                                                \"HR\"
                                        ]
                                }
                        ]
                }
        ]
}


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions
404: Resource not found"},"response":[]}]},{"name":"Unified Security Policy - Exceptions","item":[{"name":"Get matching rules task status","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/matching_rules/status/{{taskId}}","description":"Parameters:
taskId: The unique identifier of the matching rules task.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/matching_rules/status/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Matching rules task status was received.
401: User not permitted to Security policy exceptions.
404: Matching rules task status was not found."},"response":[]},{"name":"Get matching rules task results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/matching_rules/result/{{taskId}}","description":"Parameters:
taskId: The unique identifier of the matching rules task.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/matching_rules/result/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Matching rules task results were received.
401: User not permitted to Security policy exceptions.
404: An error occurred during the calculation.
404: The calculation for the task has not finished yet."},"response":[]},{"name":"Get a specific exception","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"exceptionId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/{{exceptionId}}","description":"Gets a specific exception for unified security policies.

Parameters:
exceptionId: The ID of the exception to get.
context: Global MSSP context [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/14

Response Messages:
401: User not permitted to access the specified domain
404: A security policy exception with the specified ID was not found."},"response":[]},{"name":"Delete an exception","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"exceptionId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/{{exceptionId}}","description":"Delete the specific unified security policy exceptions

Parameters:
exceptionId: The ID of the exception to delete.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/14

Response Messages:
404: The security policy with the specified ID does not exist
401: User not permitted to access the specified domain."},"response":[]},{"name":"Start a task to calculate matching rules for an exception","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"exceptionId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/{{exceptionId}}/matching_rules/start","description":"Create a calculation task to find matching rules.
The results will be on the relevant devices for each access.
Returns a task Id that can be used to check the task status and get the task results

Parameters:
exceptionId: Security policy Exception ID on which to run the API.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/1/matching_rules/start

Response Messages:
401: User not permitted to Security policy exceptions.
404: A security policy exception with the specified ID was not found."},"response":[]},{"name":"Cancel Matching rules task","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/matching_rules/{{taskId}}","description":"Parameters:
taskId: The unique identifier of the matching rules task.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/matching_rules/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
204: Matching rules task has been aborted successfully.
401: User not permitted to Security policy exceptions.
404: Matching rules task was not found."},"response":[]},{"name":"Get all exceptions","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/","description":"Gets a list of all unified security policy exceptions.

Parameters:
context: Global MSSP context [optional]
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query starting from starting page allowable type in numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions

Response Messages:
401: User not permitted to access the specified domain"},"response":[]},{"name":"Create an exception","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\n\tadmin\n\tst_user\n\t2015-01-01\n\tAllow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321\n\t\n\t\t\n\t\t\tCreating USP exception for ticket 123\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t192.168.1.2\n\t\t\t\t\t\t255.255.255.255\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\tLAN\n\t\t\t\t\tcorporate security policy\n\t\t\t\t\tDMZ\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t4321\n\t\t\t\t\t\ttcp\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t1\n\t\t\t\t\t\t{5aa1c104-bd4d-4635-a281-b3a5442639ba}\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\thttp\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t10\n\t\t\t\t\t\t20\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t192.168.1.1\n\t\t\t\t\t\t255.255.255.255\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\t2025-01-01\n\tAllow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321\n\tadmin\n\t123\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/","description":"Create an exception for unified security policies.

Parameters:
context: Global MSSP context [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_policies/exceptions
BODY<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<security_policy_exception>
    <approved_by>admin</approved_by>
    <created_by>st_user</created_by>
    <creation_date>2015-01-01</creation_date>
    <description>Allow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321</description>
    <exempted_traffic_list>
        <exempted_traffic>
            <comment>Creating USP exception for ticket 123</comment>
            <dest_network_collection>
                <network_items>
                    <network_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"subnet\">
                        <ip>192.168.1.2</ip>
                        <netmask>255.255.255.255</netmask>
                    </network_item>
                </network_items>
            </dest_network_collection>
            <security_requirements>
                <zone_to_zone_security_requirement>
                    <from_zone>LAN</from_zone>
                    <policy_name>corporate security policy</policy_name>
                    <to_zone>DMZ</to_zone>
                </zone_to_zone_security_requirement>
            </security_requirements>
            <service_collection>
                <service_items>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"custom\">
                        <port>4321</port>
                        <protocol>tcp</protocol>
                    </service_item>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"device_service\">
                        <mgmt_id>1</mgmt_id>
                        <service_uid>{5aa1c104-bd4d-4635-a281-b3a5442639ba}</service_uid>
                    </service_item>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"predefined\">
                        <predefined_service_name>http</predefined_service_name>
                    </service_item>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"range_service\">
                        <minProtocol>10</minProtocol>
                        <maxProtocol>20</maxProtocol>
                    </service_item>
                </service_items>
            </service_collection>
            <source_network_collection>
                <network_items>
                    <network_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"subnet\">
                        <ip>192.168.1.1</ip>
                        <netmask>255.255.255.255</netmask>
                    </network_item>
                </network_items>
            </source_network_collection>
        </exempted_traffic>
    </exempted_traffic_list>
    <expiration_date>2025-01-01</expiration_date>
    <name>Allow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321</name>
    <requested_by>admin</requested_by>
    <ticket_id>123</ticket_id>
</security_policy_exception>


Response Messages:
400: The specified network item is not valid.
400: The specified zone name does not exist.
400: The security policy with the specified name does not exist
400: The security policy 'created by' user is not valid.
400: The security policy with the specified name already exists.
401: User not permitted to access the specified domain."},"response":[]}]},{"name":"Unified Security Policy - Security Zone Matrix","item":[{"name":"Get unified security policies","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/","description":"Fetches the security zone matrices defined under Unified Security Policy.

Parameters:
context: Returns results for the specified domain ID. [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies

Response Messages:
401: User not permitted to access the specified domain"},"response":[]},{"name":"Set manual device mapping","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n \n Vlan_30\n \n \n 10\n add\n \n \n \n\n "},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/{{deviceId}}/manual_mapping","description":"Add or remove a zone on a device interface

Parameters:
context: Global MSSP context [optional]
deviceId: Device ID
body: InterfacesManualMappingsDTO

Usage Example
URLhttps://127.0.0.1/securetrack/api/security_policies/10/manual_mapping
BODY<interfaces_manual_mappings>
<interface_manual_mapping>
<interface_name>Vlan_30</interface_name>
<zones_user_actions>
<zone_user_action>
<zoneId>10</zoneId>
<action>add</action>
</zone_user_action>
</zones_user_actions>
</interface_manual_mapping>
</interfaces_manual_mappings>


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions
404: Not found error
404: User action not valid (only add/remove)
404: No interface with name for device with id
404: No zone with id
404: No revision for device with id
404: No device with ID
404: Access denied for device with ID
404: InterfacesManualMappingsDTO is empty
404: Error on updating security_policy_interface_zone_mapping_user_action table for device with ID"},"response":[]},{"name":"Get global unified security policies","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/global","description":"Fetches the global security zone matrices defined under Unified Security Policy.



Usage Example
https://192.168.1.1/securetrack/api/security_policies/global

Response Messages:
401: User not permitted to access global security policies"},"response":[]},{"name":"Get unified security policy as CSV","request":{"method":"GET","header":[],"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/{{id}}/export","description":"Exports a Security Policy in CSV format

Parameters:
context: Returns results for the specified domain ID. [optional]
id: ID of the security policy. [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies/1/export

Response Messages:
401: User not permitted to access the specified domain
404: Security Policy does not exist"},"response":[]},{"name":"Delete unified security policy","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/{{id}}","description":"Delete a Security Policy Matrix

Parameters:
context: Returns results for the specified domain ID. [optional]
id: The unique identifier of the security policy matrix to delete

Usage Example
https://192.168.1.1/securetrack/api/security_policies/1
"},"response":[]}]},{"name":"Unified Security Policy - Violations","item":[{"name":"Get the violating rules for the specified device.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"deviceId"},{"value":null,"type":"text","key":"severity"},{"value":null,"type":"text","key":"type"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/violating_rules/{{deviceId}}/device_violations","description":"policyName is supported for management devices running in Advanced management mode.

Parameters:
deviceId: The device ID for which to get violations
policyName: Return only violations that match this policy [optional]
severity: Return only violations of this severity
type: Return only violations of this type

Usage Example
https://192.168.1.1/securetrack/api/violating_rules/1/device_violations?policy=policy_name&type=SECURITY_POLICY&severity=MEDIUM

Response Messages:
200: The violations were successfully retrieved
400: The specified value for the violation severity is invalid
400: The specified value for the violation type is invalid
400: You cannot specify a policyName because the device is not running in Advanced management mode
404: A device with the specified ID was not found
404: A policy with the specified policyName was not found for this device"},"response":[]},{"name":"Get the amount of violating rules for the specified device.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"deviceId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/violating_rules/{{deviceId}}/count","description":"Parameters:
deviceId: The device ID for which to get violations.

Usage Example
https://192.168.1.1/securetrack/api/violating_rules/1/count

Response Messages:
200: The violation count was successfully retrieved
404: Device with id: <deviceId> doesn't exist"},"response":[]}]}]} \ No newline at end of file diff --git a/Postman Format v2/R19-3 postman collection/tufin.postman_environment b/Postman Format v2/R19-3 postman collection/tufin.postman_environment new file mode 100644 index 0000000..51d4258 --- /dev/null +++ b/Postman Format v2/R19-3 postman collection/tufin.postman_environment @@ -0,0 +1 @@ +{"name":"Tufin environment","values":[{"type":"text","key":"SecureApp_IP"},{"type":"text","key":"SecureChange_IP"},{"type":"text","key":"SecureTrack_IP"},{"type":"text","key":"applicationId"},{"type":"text","key":"applicationInterfaceId"},{"type":"text","key":"application_id"},{"type":"text","key":"application_pack_id"},{"type":"text","key":"assigneeId"},{"type":"text","key":"child_id"},{"type":"text","key":"child_ids"},{"type":"text","key":"cleanup_id"},{"type":"text","key":"cloud_id"},{"type":"text","key":"connectionId"},{"type":"text","key":"connectionInterfaceId"},{"type":"text","key":"connectionToApplicationId"},{"type":"text","key":"connection_id"},{"type":"text","key":"connection_to_application_pack_id"},{"type":"text","key":"customer_id"},{"type":"text","key":"deviceId"},{"type":"text","key":"device_id"},{"type":"text","key":"domainId"},{"type":"text","key":"exceptionId"},{"type":"text","key":"fieldId"},{"type":"text","key":"id"},{"type":"text","key":"ids"},{"type":"text","key":"instructionId"},{"type":"text","key":"managementId"},{"type":"text","key":"parent_id"},{"type":"text","key":"parent_ids"},{"type":"text","key":"policyId"},{"type":"text","key":"requestId"},{"type":"text","key":"revId"},{"type":"text","key":"revision_id"},{"type":"text","key":"risk_id"},{"type":"text","key":"ruleId"},{"type":"text","key":"rule_id"},{"type":"text","key":"rule_uid"},{"type":"text","key":"serverId"},{"type":"text","key":"serviceId"},{"type":"text","key":"sourceApplicationId"},{"type":"text","key":"stepId"},{"type":"text","key":"tag_id"},{"type":"text","key":"targetApplicationId"},{"type":"text","key":"taskId"},{"type":"text","key":"task_id"},{"type":"text","key":"task_uid"},{"type":"text","key":"toStepId"},{"type":"text","key":"uid"},{"type":"text","key":"userId"},{"type":"text","key":"zone_id"},{"type":"text","key":"zone_ids"}]} \ No newline at end of file diff --git a/Postman Format v2/R20-1 postman collection/securechangeworkflow_R20-1-GA-v2.json b/Postman Format v2/R20-1 postman collection/securechangeworkflow_R20-1-GA-v2.json new file mode 100644 index 0000000..cc00a65 --- /dev/null +++ b/Postman Format v2/R20-1 postman collection/securechangeworkflow_R20-1-GA-v2.json @@ -0,0 +1 @@ +{"info":{"_postman_id":"2","name":"Tufin Tufin SecureChange/SecureApp R20-1-GA","description":"Tufin Orchestration Suite - Tufin SecureChange/SecureApp APIs.
For detailed information about the APIs please see the documentation at:
https://your-securetrack-server/securechangeworkflow/apidoc","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json"},"item":[{"name":"Access Portal","item":[{"name":"Retrieve existing application access requests","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests","description":"Parameters:
applicationId: The unique identifier of the application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests

Response Messages:
400: The application was already deleted.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID."},"response":[]},{"name":"Update application access requests","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t1\n\t\tAPPROVE\n\t\n\t\n\t\t2\n\t\tREJECT\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests","description":"Use this API to approve or reject application access requests

Parameters:
applicationId: The unique identifier of the application
body: application access requests

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests
BODY<application_access_requests>
    <application_access_request>
        <id>1</id>
        <action>APPROVE</action>
    </application_access_request>
    <application_access_request>
        <id>2</id>
        <action>REJECT</action>
    </application_access_request>
</application_access_requests>


Response Messages:
200: Application access requests were updated.
400: The application was already deleted.
400: Invalid ID for access request
400: Cannot update access request with id ID
400: Action cannot be empty in request with id ID
400: Invalid action in request with id ID
400: The Server group is lock for discovery
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]},{"name":"Create application access request","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t1\n\t1.1.1.1\n\tRequest to join the WebServers server group\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests","description":"Parameters:
applicationId: The unique identifier of the application
body: application access request

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests
BODY<application_access_request>
    <server_group_id>1</server_group_id>
    <server_ip>1.1.1.1</server_ip>
    <comment>Request to join the WebServers server group</comment>
</application_access_request>


Response Messages:
201: Application access request was submitted.
400: The application was already deleted.
400: Server id cannot be empty.
400: Hostname or IP cannot be empty.
400: The provided server does not exist in application.
400: The provided server is not allowed to access.
400: Request already created
400: Requester cannot be null
400: Group cannot be empty
400: Invalid ip
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]},{"name":"Update an application access request","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tAPPROVE\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests/{{requestId}}","description":"Use this API to approve or reject application access requests

Parameters:
applicationId: The unique identifier of the application
requestId: The unique identifier of the application access request
body: application access request

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests/1
BODY<application_access_request>
    <action>APPROVE</action>
</application_access_request>


Response Messages:
200: Application access request was updated.
400: The application was already deleted.
400: Invalid ID for access request
400: Cannot update access request with id ID
400: Action cannot be empty in request with id ID
400: Invalid action in request with id ID
400: The Server group is lock for discovery
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]},{"name":"Retrieve an existing application access request by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"requestId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests/{{requestId}}","description":"Parameters:
applicationId: The unique identifier of the application
requestId: The unique identifier of the application access request

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests/1

Response Messages:
400: The application was already deleted.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Access request with id ID was not found in application with id ID"},"response":[]}]},{"name":"Application Connections","item":[{"name":"Retrieve existing connections, with extended resources information","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_extended","description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the connection [optional]
start: Return results starting only from the specified index; 0-based index; default value = 0 [optional]
count: Return the specified number of results. Returns all results if no value specified [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended?name=Connection Name

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended?name=Connection Name&start=50&count=100

Response Messages:
400: Start value cannot be a negative number.
400: Count value must be greater than 0.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: Access is denied.
404: There is no application with the specified ID.
404: There are no connections with the name NAME."},"response":[]},{"name":"Retrieve an existing connection by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"connectionId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}","description":"Parameters:
applicationId: The unique identifier of the application
connectionId: The unique identifier of the connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/1

Response Messages:
401: No available licenses. Ask your SecureApp administrator for assistance.
401: Access is denied
401: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID."},"response":[]},{"name":"Update a connection","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":" \n\t Connection A\n\t Connection A comment\n\t \n\t\t \n\t\t\t 2\n\t\t \n\t\t \n\t\t\t 3\n\t\t \n\t \n\t \n\t\t \n\t\t\t 1\n\t\t \n\t \n\t \n\t\t \n\t\t\t 1\n\t\t \n\t \n "},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}","description":"Parameters:
applicationId: The unique identifier of the application
connectionId: The unique identifier of the connection
body: Connection

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections/1
BODY <connection>
     <name>Connection A</name>
     <comment>Connection A comment</comment>
     <sources>
         <source>
             <id>2</id>
         </source>
         <source>
             <id>3</id>
         </source>
     </sources>
     <services>
         <service>
             <id>1</id>
         </service>
     </services>
     <destinations>
         <destination>
             <id>1</id>
         </destination>
     </destinations>
</connection>


Response Messages:
200: Connection was modified.
400: Reference to service ID is invalid.
400: Reference to source/destination with ID is invalid.
400: Connection name cannot be empty.
400: Connection name already exists.
400: Connection NAME contains duplicate destinations.
400: Destination cannot contain users.
400: Resource cannot contain other objects along with Any.
400: Connection NAME contains duplicate sources.
400: You cannot add external resources to interface connections.
400: You cannot have Any in both the source and destination.
400: You cannot add external resources to interface connections.
400: Source cannot contain both users and servers.
400: Connection NAME contains duplicate services.
400: Cannot contain other services along with ANY.
400: Connections can only include objects within the same customer.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permission to access application that contains the server ID
401: You do not have permissions to edit this application.
401: Access is denied
401: You cannot edit or delete an external connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID."},"response":[]},{"name":"Delete connection","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"connectionId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}","description":"Parameters:
applicationId: The unique identifier of the application
connectionId: The unique identifier of the connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/1

Response Messages:
200: Connection was deleted.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
401: Access is denied
401: You cannot edit or delete an external connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID."},"response":[]},{"name":"Create a ticket to repair a connection","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tRepair connection 2\n\tu1\n\tNormal\n\t\n\t\tWorkflow with topology\n\t\n\t\n\t\t\n\t\t\tOpen request\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tBusiness Justification\n\t\t\t\t\t\t\tI need access to ftp \n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tProject Number\n\t\t\t\t\t\t\tCR124560\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tHyperlink\n\t\t\t\t\t\t\thttp://192.168.1.1/ticket\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tChange Window\n\t\t\t\t\t\t\tMonday\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tmanager email\n\t\t\t\t\t\t\tmanager@tufin.com\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connections/{{connection_id}}/repair","description":"Parameters:
application_id: The application ID
connection_id: The connection ID
body: Ticket

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/2/repair
BODY<ticket>
    <subject>Repair connection 2</subject>
    <requester>u1</requester>
    <priority>Normal</priority>
    <workflow>
        <name>Workflow with topology</name>
    </workflow>
    <steps>
        <step>
            <name>Open request</name>
            <tasks>
                <task>
                    <fields>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_area\">
                            <name>Business Justification</name>
                            <text>I need access to ftp </text>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_field\">
                            <name>Project Number</name>
                            <text>CR124560</text>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"hyperlink\">
                            <name>Hyperlink</name>
                            <url>http://192.168.1.1/ticket</url>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"drop_down_list\">
                            <name>Change Window</name>
                            <selection>Monday</selection>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"manager\">
                            <name>manager email</name>
                            <text>manager@tufin.com</text>
                        </field>
                    </fields>
                </task>
            </tasks>
        </step>
    </steps>
    <comments/>
</ticket>


Response Messages:
201: Ticket was created.
400: The requester must be the currently logged in user.
400: Workflow was not found.
400: Workflow is not active.
400: Workflow configuration is not valid.
400: Workflow is not set.
400: You cannot enter a status for a new ticket.
400: Requester cannot open a ticket in domain.
400: Invalid ticket priority.
400: Expiration field is required.
400: Submit ticket enabled only with the first step.
400: First step can be only with one task.
400: The specified workflow does not contain an access request field in the first step.
400: You cannot use an access request field to create a ticket from SecureApp.
400: The ticket fields do not match the fields in the current step of the workflow.
400: You cannot change the value of a field because it is read-only.
401: Logged in user: NAME do not have permission to perform on behalf actions.
401: You are not a participant in the first step of this workflow.
401: Access is denied.
401: To create a ticket you must purchase a valid SecureChange license.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: Cannot create a ticket to repair this connection because the connection status is not disconnected.
403: Cannot create a ticket to repair this connection because the connection was edited but a ticket has not been created yet.
403: Cannot create a ticket to repair this connection because there are other open tickets for an application that includes this connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID."},"response":[]},{"name":"Update connections","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t 1\n\t\t Connection A\n\t\t Connection A comment\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t\t \n\t\t\t\t 3\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t \n\t \n\t\t 2\n\t\t Connection B\n\t \n\t \n\t\t 3\n\t\t Connection C\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t \n\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections","description":"Parameters:
applicationId: The unique identifier of the application
body: List of connections

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections
BODY<connections>
     <connection>
         <id>1</id>
         <name>Connection A</name>
         <comment>Connection A comment</comment>
         <sources>
             <source>
                 <id>2</id>
             </source>
             <source>
                 <id>3</id>
             </source>
         </sources>
         <services>
             <service>
                 <id>1</id>
             </service>
         </services>
         <destinations>
             <destination>
                 <id>1</id>
             </destination>
         </destinations>
     </connection>
     <connection>
         <id>2</id>
         <name>Connection B</name>
     </connection>
     <connection>
         <id>3</id>
         <name>Connection C</name>
         <sources>
             <source>
                 <id>2</id>
             </source>
         </sources>
     </connection>
</connections>


Response Messages:
200: Connections were modified.
400: Reference to service ID is invalid.
400: Reference to source/destination with ID is invalid.
400: Connection name cannot be empty.
400: Connection name already exists.
400: Connection NAME contains duplicate destinations.
400: Destination cannot contain users.
400: Resource cannot contain other objects along with Any.
400: Connection NAME contains duplicate sources.
400: You cannot add external resources to interface connections.
400: You cannot have Any in both the source and destination.
400: You cannot add external resources to interface connections.
400: Source cannot contain both users and servers.
400: Connection NAME contains duplicate services.
400: Cannot contain other services along with ANY.
400: Connections can only include objects within the same customer.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permission to access application that contains the server ID
401: You do not have permissions to edit this application.
401: Access is denied
401: You cannot edit or delete an external connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID."},"response":[]},{"name":"Retrieve existing connections","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections","description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the connection [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections?name=Connection Name

Response Messages:
401: No available licenses. Ask your SecureApp administrator for assistance.
401: Access is denied
401: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: There are no connections with the name NAME."},"response":[]},{"name":"Create connections","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t Connection A\n\t\t Connection A comment\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t\t \n\t\t\t\t 3\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t \n\t \n\t\t Connection B\n\t \n\t \n\t\t Connection C\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t \n\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections","description":"Parameters:
applicationId: The unique identifier of the application
body: The list of the connections

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections
BODY<connections>
     <connection>
         <name>Connection A</name>
         <comment>Connection A comment</comment>
         <sources>
             <source>
                 <id>2</id>
             </source>
             <source>
                 <id>3</id>
             </source>
         </sources>
         <services>
             <service>
                 <id>1</id>
             </service>
         </services>
         <destinations>
             <destination>
                 <id>1</id>
             </destination>
         </destinations>
     </connection>
     <connection>
         <name>Connection B</name>
     </connection>
     <connection>
         <name>Connection C</name>
         <sources>
             <source>
                 <id>2</id>
             </source>
         </sources>
     </connection>
</connections>


Response Messages:
200: Connections were created.
201: Connection was created.
400: There are no items to add.
400: You cannot add to application NAME because it was decommissioned.
400: Connection name already exists.
400: Reference to service ID is invalid.
400: Reference to source/destination with ID is invalid.
400: Connection NAME contains duplicate destinations.
400: Destination cannot contain users.
400: Resource cannot contain other objects along with Any.
400: Connection NAME contains duplicate sources.
400: You cannot add external resources to interface connections.
400: You cannot have Any in both the source and destination.
400: You cannot add external resources to interface connections.
400: Source cannot contain both users and servers.
400: Connection NAME contains duplicate services.
400: Cannot contain other services along with ANY.
400: Connections can only include objects within the same customer.
401: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
401: Access is denied
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]}]},{"name":"Application Identities","item":[{"name":"Fetches application identities","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/application_identities","description":"Fetches the list of pre-defined application identities (like facebook) that can be used in a connection.

Parameters:
name: The name of the service [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/application_identities

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/application_identities?name=facebook

Response Messages:
404: There are no application identities with the name NAME.
401: Access is denied."},"response":[]}]},{"name":"Application Interfaces","item":[{"name":"Retrieve an existing application interface by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"applicationInterfaceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}","description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID."},"response":[]},{"name":"Delete application interface","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"applicationInterfaceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}","description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1

Response Messages:
200: Application interface was deleted.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID."},"response":[]},{"name":"Update an application interface","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tupdated name\n\tUpdated application interface\n\ttrue\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}","description":"Update the application interface properties. If is_published is set to true, the application interface is published for use by other users.

Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of The application interface
body: The application interface

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1
BODY<application_interface>
    <name>updated name</name>
    <comment>Updated application interface</comment>
    <is_published>true</is_published>
</application_interface>


Response Messages:
200: Application interface was modified.
400: Application interface is not complete for publish.
400: Name cannot be empty.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID."},"response":[]},{"name":"Retrieve existing interface connections","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"applicationInterfaceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections","description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
name: The name of the interface connection [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections?name=Connection 1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There are no connection interfaces with the name NAME.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID."},"response":[]},{"name":"Create interface connections","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\tConnection 1\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\t\n\t\t\t\tFacebook\n\t\t\t\n\t\t\n\t\tNew connection\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections","description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
body: The interface connections

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections
BODY<interface_connections>
    <interface_connection>
        <name>Connection 1</name>
        <sources>
            <source>
                <id>3</id>
            </source>
        </sources>
        <services>
            <service>
                <id>3</id>
            </service>
            <service>
                <id>Facebook</id>
            </service>
        </services>
        <comment>New connection</comment>
    </interface_connection>
</interface_connections>


Response Messages:
200: Interface connections were created.
201: Interface connection was created.
400: There are no items to add.
400: Cannot create interface connection without a name.
400: Connection name already exists.
400: You cannot add user to connection interface.
400: You cannot add Any to connection interface.
400: You cannot add Internet to connection interface.
400: Cannot have external servers.
400: Cannot have both sources and destinations.
400: Connection NAME contains duplicate sources.
400: Connection NAME contains duplicate services.
400: Connection NAME contains duplicate destinations.
400: Reference to source/destination with ID is invalid.
400: Reference to service ID is invalid.
401: Access is denied.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID."},"response":[]},{"name":"Create connection to application","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tConnection to Application 1\n\tNew connection to application\n\t1\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications","description":"Create a connection from this application to an application interface.

Parameters:
applicationId: The unique identifier of the application
body: The connection to application

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications
BODY<connection_to_application>
    <name>Connection to Application 1</name>
    <comment>New connection to application</comment>
    <application_interface_id>1</application_interface_id>
    <servers>
        <server>
            <id>3</id>
        </server>
    </servers>
</connection_to_application>


Response Messages:
201: Connection to application was created.
400: You cannot add to application NAME because it was decommissioned.
400: The selected interface cannot be used more than once in the application.
400: Name cannot be empty.
400: Cannot create from local interface.
400: ApplicationInterface didn't got published.
400: Name already exists.
400: Cannot create connection to application without servers, there should be at least one server.
400: Reference to source/destination with ID is invalid.
400: You can use only interface from the same customer.
400: You cannot add ANY to connection to application.
400: You cannot add user to connection to application.
400: You cannot add Internet to connection to application.
401: Access is denied
401: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found."},"response":[]},{"name":"Retrieve existing connections to application","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications","description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the connection to application [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications?name=Connection to Application 1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID."},"response":[]},{"name":"Update an interface connection","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tUpdated name\n\t\n\t\t\n\t\t\t19\n\t\t\n\t\n\t\n\t\t\n\t\t\t9\n\t\t\n\t\n\tUpdated connection\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}","description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
connectionInterfaceId: The unique identifier of the interface connection
body: The interface connection

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections/1
BODY<interface_connection>
    <name>Updated name</name>
    <sources>
        <source>
            <id>19</id>
        </source>
    </sources>
    <services>
        <service>
            <id>9</id>
        </service>
    </services>
    <comment>Updated connection</comment>
</interface_connection>


Response Messages:
200: Interface connection was modified.
400: Interface connection name cannot be empty.
400: Connection name already exists.
400: You cannot add user to connection interface.
400: You cannot add Any to connection interface.
400: You cannot add Internet to connection interface.
400: Cannot have external servers.
400: Cannot have both sources and destinations.
400: Connection NAME contains duplicate sources.
400: Connection NAME contains duplicate services.
400: Connection NAME contains duplicate destinations.
400: Reference to source/destination with ID is invalid.
400: Reference to service ID is invalid.
401: Access is denied.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID."},"response":[]},{"name":"Retrieve an existing interface connection by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"applicationInterfaceId"},{"value":null,"type":"text","key":"connectionInterfaceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}","description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
connectionInterfaceId: The unique identifier of the interface connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections/1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID."},"response":[]},{"name":"Delete interface connection","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"applicationInterfaceId"},{"value":null,"type":"text","key":"connectionInterfaceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}","description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
connectionInterfaceId: The unique identifier of the interface connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections/1

Response Messages:
200: Interface connection was deleted.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID."},"response":[]},{"name":"Update a connection to application","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tUpdated name\n\tUpdated connection to application\n\t\n\t\t\n\t\t\t4\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications/{{connectionToApplicationId}}","description":"Parameters:
applicationId: The unique identifier of the application
connectionToApplicationId: The unique identifier of the connection to application
body: The connection to application

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications/1
BODY<connection_to_application>
    <name>Updated name</name>
    <comment>Updated connection to application</comment>
    <servers>
        <server>
            <id>4</id>
        </server>
    </servers>
</connection_to_application>


Response Messages:
200: Connection to application was modified.
400: Name cannot be empty.
400: Name already exists.
400: Reference to source/destination with ID is invalid.
400: You cannot add ANY to connection to application.
400: You cannot add user to connection to application.
400: You cannot add Internet to connection to application.
401: Access is denied
401: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection to application with ID was not found for application interface with ID."},"response":[]},{"name":"Delete connection to application","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"connectionToApplicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications/{{connectionToApplicationId}}","description":"Parameters:
applicationId: The unique identifier of the application
connectionToApplicationId: The unique identifier of the connection to application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications/1

Response Messages:
200: Connection to application was deleted.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection to application with ID was not found for application interface with ID."},"response":[]},{"name":"Retrieve an existing connection to application by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"connectionToApplicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications/{{connectionToApplicationId}}","description":"Parameters:
applicationId: The unique identifier of the application
connectionToApplicationId: The unique identifier of the connection to application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications/1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Connection to application with ID was not found for application interface with ID."},"response":[]},{"name":"Create application interface","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tInterface to Application 1\n\tNew application interface\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces","description":"Parameters:
applicationId: The unique identifier of the application
body: The application interface

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces
BODY<application_interface>
    <name>Interface to Application 1</name>
    <comment>New application interface</comment>
</application_interface>


Response Messages:
201: Application interface was created.
400: You cannot add to application NAME because it was decommissioned.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID."},"response":[]},{"name":"Retrieve existing application interfaces","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces","description":"To improve response time, set 'calculateIsPublished = false' to avoid calculating 'is_published'.

Parameters:
applicationId: The unique identifier of the application
name: The name of the application interface [optional]
calculateIsPublished: Should calculate is_published value [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces?name=Interface to Application 1

Response Messages:
400: There is no application with the specified ID.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There are no application interfaces with the name NAME."},"response":[]}]},{"name":"Application Migration","item":[{"name":"Retrieve server mappings for source and target applications","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"sourceApplicationId"},{"value":null,"type":"text","key":"targetApplicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/servers_mapping","description":"Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application
search_servers_type: Search server type [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/servers_mapping

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/servers_mapping?search_servers_type=EXTERNAL

Response Messages:
400: Search migrated servers type parameter must be either internal, external or both.
400: Cannot get mappings between application to itself.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permission to access application with ID
401: You do not have permissions to edit this application.
404: There is no application with the specified ID."},"response":[]},{"name":"Update server mappings for source and target applications","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n\t\n\t\t\n\t\t\t5\n\t\t\n\t\t\n\t\t\t-1\n\t\t\n\t\n\t\n\t\t\n\t\t\t6\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/servers_mapping","description":"Use id=-1 for target_network_object if new mapping is “Not Needed”.
If the source is specified and the target is empty, the mapping that is currently configured will be deleted.

Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application
body: The server mapping list [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/servers_mapping
BODY<servers_mapping>
    <server_mapping>
        <source_network_object>
            <id>3</id>
        </source_network_object>
        <target_network_object>
            <id>4</id>
        </target_network_object>
    </server_mapping>
    <server_mapping>
        <source_network_object>
            <id>5</id>
        </source_network_object>
        <target_network_object>
            <id>-1</id>
        </target_network_object>
    </server_mapping>
    <server_mapping>
        <source_network_object>
            <id>6</id>
        </source_network_object>
    </server_mapping>
</servers_mapping>


Response Messages:
200: Server mappings were modified.
400: Source network object cannot be empty.
400: Source network object is not valid
400: Target network object is not valid
400: Source and target network objects must be internal or external both.
400: Cannot use DEVICE application resources as external network objects.
400: Source network object with ID must be used by any connection.
400: Cannot remove mapping of network object with ID because it has never been mapped.
400: Cannot migrate application to itself.
400: Cannot map to ANY network object.
400: Cannot map Internet network object.
400: Cannot map to Internet network object.
400: Target network object ID must be in the same customer as the target application.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Server with ID was not found."},"response":[]},{"name":"Copy application servers and connections to another application.","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"sourceApplicationId"},{"value":null,"type":"text","key":"targetApplicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}","description":"This API can be used to:
1. Create applications based on a blueprint (template).
2. Copy applications between environments (dev, test, prod).
3. Migrate applications between data-centers.

Before migrating make sure to map servers and connections to applications (if any exist).\nThis migration uses the configuration specified in the other API calls.

Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2

Response Messages:
200: Application was migrated.
400: Cannot migrate a decommissioned application.
400: Cannot migrate to a decommissioned application.
400: Cannot migrate an application to itself.
400: Cannot edit target DEVICE application.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
400: The source application has no connections to migrate.
409: You cannot migrate the application because not all servers are mapped.
409: You cannot migrate the application because not all connections to application are mapped.
409: You cannot migrate the application because one of the interfaces in the original application has been changed and has not been published."},"response":[]},{"name":"Update connection to application mappings for source and target applications","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n\t\n\t\t\n\t\t\t2\n\t\t\n\t\t\n\t\t\t-1\n\t\t\n\t\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/connections_to_applications_mapping","description":"Use id=-1 for target_application_interface if new mapping is “Not Needed”.
If the source is specified and the target is empty, the mapping that is currently configured will be deleted.

Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application
body: The interface instance mapping list [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/connections_to_applications_mapping
BODY<connections_to_applications_mapping>
    <connection_to_application_mapping>
        <source_connection_to_application>
            <id>1</id>
        </source_connection_to_application>
        <target_application_interface>
            <id>4</id>
        </target_application_interface>
    </connection_to_application_mapping>
    <connection_to_application_mapping>
        <source_connection_to_application>
            <id>2</id>
        </source_connection_to_application>
        <target_application_interface>
            <id>-1</id>
        </target_application_interface>
    </connection_to_application_mapping>
    <connection_to_application_mapping>
        <source_connection_to_application>
            <id>3</id>
        </source_connection_to_application>
    </connection_to_application_mapping>
</connections_to_applications_mapping>


Response Messages:
200: Connection to application mappings were modified.
400: Source interface instance cannot be empty.
400: Source interface instance object is not valid
400: Target application interface is not valid
400: Connection to application with ID: ID was not found.
400: Interface with ID: ID was not found.
400: Cannot remove mapping of instance with ID because it has never been mapped.
400: Cannot migrate application to itself.
400: Cannot map instance to interface with ID ID because the interface exists in target application.
400: Cannot map to duplicate application interfaces
400: Application interface didn't got published
400: Connection to application with id: ID must used by source application
400: You cannot map connection to application ID, because it is contained in a connection to application pack.
400: Application interface ID must be in the same customer as the target application.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]},{"name":"Retrieve connection to application mappings for source and target applications","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"sourceApplicationId"},{"value":null,"type":"text","key":"targetApplicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/connections_to_applications_mapping","description":"Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/connections_to_applications_mapping

Response Messages:
400: Cannot get mappings between application to itself.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID."},"response":[]}]},{"name":"Application Packs","item":[{"name":"List all application packs","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/","description":"Parameters:
customer_id: The unique identifier of customer
name: The name of the application pack [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs?name=Application pack 1

Response Messages:
401: Access is denied
404: There are no application packs with the NAME in customer with ID."},"response":[]},{"name":"Create new application packs","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\tApplication pack 1\n\t\tNew application pack\n\t\t\n\t\t\t4\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t5\n\t\t\t\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/","description":"Parameters:
customer_id: The unique identifier of customer
body: List of application packs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs
BODY<application_packs>
    <application_pack>
        <name>Application pack 1</name>
        <comment>New application pack</comment>
        <owner>
            <id>4</id>
        </owner>
        <editors>
            <editor>
                <id>3</id>
            </editor>
        </editors>
        <viewers>
            <viewer>
                <id>5</id>
            </viewer>
        </viewers>
    </application_pack>
</application_packs>


Response Messages:
401: Access is denied
401: You do not have permission to access application that contains the interface ID
400: There are no application packs to add.
400: Application pack can be created only in meshed domain mode.
404: Customer with ID was not found.
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to owner ID is invalid.
400: There is an editor without an ID or name.
400: The application pack owner cannot also be an editor of the application pack.
400: There is a viewer without an ID or name.
400: The application pack owner cannot also be a viewer of the application pack.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application pack.
400: The owner NAME does not have permission to access applications.
400: Application pack was already saved.
400: Application pack NAME already exists.
400: Application pack name must contain at least 2 and no more than 160 characters.
400: Customer NAME is not imported to SecureApp.
400: Customer NAME was decommissioned."},"response":[]},{"name":"Update application packs","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t1\n\t\tUpdated name\n\t\tUpdated application pack\n\t\t\n\t\t\t4\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\n\t\tfalse\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/","description":"Update the application packs properties. If is_published is set to true, the application pack is published for use by other users.

Parameters:
customer_id: The unique identifier of customer
body: List of application packs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs
BODY<application_packs>
    <application_pack>
        <id>1</id>
        <name>Updated name</name>
        <comment>Updated application pack</comment>
        <owner>
            <id>4</id>
        </owner>
        <editors>
            <editor>
                <id>3</id>
            </editor>
        </editors>
        <is_published>false</is_published>
    </application_pack>
</application_packs>


Response Messages:
400: There are no application packs to edit.
400: Application pack ID cannot be empty.
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to owner ID is invalid.
400: The owner NAME does not have permission to access applications.
400: There is an editor without an ID or name.
400: The application pack owner cannot also be an editor of the application pack.
400: There is a viewer without an ID or name.
400: The application pack owner cannot also be a viewer of the application pack.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application pack.
400: Application pack NAME already exists.
400: Application pack name must contain at least 2 and no more than 160 characters.
400: Customer NAME is not imported to SecureApp.
400: Customer NAME was decommissioned.
400: Application pack with ID is not ready for publish, or has no changes from the last publish.
401: Access is denied
401: You do not have permission to access application that contains the interface ID
401: You do not have permissions to edit this application pack.
401: You do not have permissions to change the owner of application pack ID.
401: You do not have permissions to change the editors and viewers of application pack ID.
404: There are no application packs with the NAME in customer with ID."},"response":[]},{"name":"Delete a connection to application pack","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"application_id"},{"value":null,"type":"text","key":"connection_to_application_pack_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/{{connection_to_application_pack_id}}","description":"Parameters:
application_id: The unique identifier of application
connection_to_application_pack_id: The unique identifier of the connection to application pack to delete

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs/1

Response Messages:
400: Connection to application pack with ID was not found for application with ID.
400: The connection to application pack was already deleted.
401: Access is denied.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed."},"response":[]},{"name":"Retrieve an existing connection to application pack by ID.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"application_id"},{"value":null,"type":"text","key":"connection_to_application_pack_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/{{connection_to_application_pack_id}}","description":"Parameters:
application_id: The unique identifier of application
connection_to_application_pack_id: The unique identifier of the connection to application pack

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs/1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
404: There is no connection to application pack with the specified ID.
400: Application with ID doesn't own a connection to application pack with ID."},"response":[]},{"name":"Update an application pack","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tUpdated name\n\tUpdated Connection to application pack\n\t\n\t\t\n\t\t\t\n\t\t\t\t1\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t3\n\t\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\tTag 1\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/{{connection_to_application_pack_id}}","description":"Parameters:
application_id: The unique identifier of application
connection_to_application_pack_id: The unique identifier of the connection to application pack to update
body: Connection to application pack

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs/1
BODY<connection_to_application_pack>
    <name>Updated name</name>
    <comment>Updated Connection to application pack</comment>
    <tags_servers>
        <tag_servers>
            <tag>
                <id>1</id>
            </tag>
            <servers>
                <server>
                    <id>3</id>
                </server>
            </servers>
        </tag_servers>
        <tag_servers>
            <tag>
                <name>Tag 1</name>
            </tag>
            <servers>
            </servers>
        </tag_servers>
    </tags_servers>
</connection_to_application_pack>


Response Messages:
400: There is no application with the specified ID.
400: There is no connection to application pack with the specified ID.
400: Application with ID doesn't own a connection to application pack with ID.
400: Name cannot be empty.
400: Name must contain at least 2 and no more than 160 characters.
400: Name already exists.
400: Tag cannot be empty.
400: Tag ID or name is required.
400: Tag with Name was not found.
400: Server ID cannot be empty.
400: Servers cannot be null.
400: You cannot add ANY to connection to application pack.
400: You cannot add user to connection to application pack.
400: You cannot add Internet to connection to application pack.
401: Access is denied.
401: You do not have permission to access application that contains the server ID
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed."},"response":[]},{"name":"Remove application interfaces from application pack","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"},{"value":null,"type":"text","key":"application_pack_id"},{"value":null,"type":"text","key":"application_interface_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/application_interfaces","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
application_interface_id: IDs of application interfaces to remove

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/application_interfaces?application_interface_id=1&application_interface_id=2

Response Messages:
200: Application Interface was deleted.
401: Access is denied
401: You do not have permissions to edit this application pack.
404: There are no application packs with the ID in customer with ID.
404: Application Package ID was not found.
404: Application interface ID was not found in application pack ID."},"response":[]},{"name":"Update application interfaces and tag mapping","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t3\n\t\t\n\t\n\t\n\t\t\n\t\t\t2\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/application_interfaces","description":"Add application interfaces to application pack, and map a tag to the application interface. If a tag is not specified for the interface, the tag will be set to “No Tag”.

Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
body: List of interface tag mapping to be added or modified

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/application_interfaces
BODY<application_interface_tags>
    <application_interface_tag>
        <application_interface>
            <id>1</id>
        </application_interface>
        <tag>
            <id>3</id>
        </tag>
    </application_interface_tag>
    <application_interface_tag>
        <application_interface>
            <id>2</id>
        </application_interface>
    </application_interface_tag>
</application_interface_tags>


Response Messages:
401: Access is denied
404: There are no application packs with the NAME in customer with ID.
401: You do not have permissions to edit this application pack.
401: You do not have permission to access application that contains the interface ID
400: You cannot edit APPLICATION PACK because it was decommissioned.
400: Application Interface can't be null.
400: Empty interface ID is not valid."},"response":[]},{"name":"Modify tags of an application pack","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t1\n\t\tTag 1\n\t\n\t\n\t\t2\t\n\t\tTag 2\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
body: Tags to modify

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags
BODY<tags>
    <tag>
        <id>1</id>
        <name>Tag 1</name>
    </tag>
    <tag>
        <id>2</id>    
        <name>Tag 2</name>
    </tag>
</tags>


Response Messages:
401: Access is denied
401: You do not have permissions to edit this application pack.
404: Customer with ID was not found.
404: There is no application pack with the ID in customer with ID.
400: Tag with NAME already exists in application pack ID.
400: Updated tag ID can't be empty
400: Updated Tag ID doesn't exist on application pack ID."},"response":[]},{"name":"Create new Tag under an application pack ","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\tTag 1\n\t\n\t\n\t\tTag 2\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack
body: List of tags

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags
BODY<tags>
    <tag>
        <name>Tag 1</name>
    </tag>
    <tag>
        <name>Tag 2</name>
    </tag>
</tags>


Response Messages:
401: Access is denied
404: There is no application pack with the ID in customer with ID.
400: You cannot edit APPLICATION PACK because it was decommissioned.
400: Tag name must contain at least 2 and no more than 160 characters.
400: Tag with NAME already exists in application pack ID."},"response":[]},{"name":"Delete tags from application pack","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"},{"value":null,"type":"text","key":"application_pack_id"},{"value":null,"type":"text","key":"tag_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
tag_id: IDs of tags to remove

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/21/tags?tag_id=1&tag_id=2

Response Messages:
200: Tags were deleted.
401: Access is denied
401: You do not have permissions to edit this application pack.
404: There are no application packs with the ID in customer with ID.
404: Application Package ID was not found.
404: Tag ID was not found in application pack ID.
404: Tag ID is in use so can't be deleted.
404: Removed tag ID can't be empty."},"response":[]},{"name":"List all application pack tags","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"},{"value":null,"type":"text","key":"application_pack_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags

Response Messages:
401: Access is denied
404: There is no application pack with the ID."},"response":[]},{"name":"Delete application pack","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"},{"value":null,"type":"text","key":"application_pack_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1

Response Messages:
200: Application pack wes deleted.
401: You do not have permissions to delete this application pack.
400: There is no application pack with the specified ID.
400: Customer with ID doesn't own an application pack with ID.
400: Application Pack ID cannot be deleted. It is in use by applications IDs."},"response":[]},{"name":"Retrieve an existing application pack by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"},{"value":null,"type":"text","key":"application_pack_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to retrieve

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1

Response Messages:
401: Access is denied
401: You do not have permission to access application pack with ID
404: Application pack with ID was not found for customer with ID."},"response":[]},{"name":"Update an application pack","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tUpdated name\n\tUpdated application pack\n\t\n\t\t4\n\t\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\n\t\n\t\t\n\t\t\t5\n\t\t\n\t\n\ttrue\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}","description":"Update the application pack properties. If is_published is set to true, the application pack is published for use by other users.

Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
body: Application pack

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1
BODY<application_pack>
    <name>Updated name</name>
    <comment>Updated application pack</comment>
    <owner>
        <id>4</id>
    </owner>
    <editors>
        <editor>
            <id>3</id>
        </editor>
    </editors>
    <viewers>
        <viewer>
            <id>5</id>
        </viewer>
    </viewers>
    <is_published>true</is_published>
</application_pack>


Response Messages:
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to owner ID is invalid.
400: The owner NAME does not have permission to access applications.
400: There is an editor without an ID or name.
400: The application pack owner cannot also be an editor of the application pack.
400: There is a viewer without an ID or name.
400: The application pack owner cannot also be a viewer of the application pack.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application pack.
400: Application pack NAME already exists.
400: Application pack name must contain at least 2 and no more than 160 characters.
400: Customer NAME is not imported to SecureApp.
400: Customer NAME was decommissioned.
400: Application pack with ID is not ready for publish, or has no changes from the last publish.
401: Access is denied
401: You do not have permission to access application that contains the interface ID
401: You do not have permissions to edit this application pack.
401: You do not have permissions to change the owner of application pack ID.
401: You do not have permissions to change the editors and viewers of application pack ID.
404: There are no application packs with the NAME in customer with ID."},"response":[]},{"name":"Get tag by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"},{"value":null,"type":"text","key":"application_pack_id"},{"value":null,"type":"text","key":"tag_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags/{{tag_id}}","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack
tag_id: The unique identifier of a tag

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags/1

Response Messages:
401: Access is denied
404: There is no tag with ID.
404: Customer with ID doesn't own a tag with ID.
404: Application Pack with ID doesn't own a tag with ID."},"response":[]},{"name":"Retrieve a list of all connection to application pack by application ID.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"application_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/","description":"Parameters:
application_id: The unique identifier of application
name: The name of the connection to application pack [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs?name=Connection to application pack 1

Response Messages:
401: Access is denied
401: You do not have permission to access application with ID
404: There are no connection to application pack with the NAME in application with ID."},"response":[]},{"name":"Create new connection to application packs","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\tConnection to application pack 1\n\t\tNew Connection to application pack\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t1\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t3\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\tTag 1\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t4\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/","description":"Parameters:
application_id: The unique identifier of application
body: List of connection to application packs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs
BODY<connection_to_application_packs>
    <connection_to_application_pack>
        <name>Connection to application pack 1</name>
        <comment>New Connection to application pack</comment>
        <application_pack>
            <id>1</id>
        </application_pack>
        <tags_servers>
            <tag_servers>
                <tag>
                    <id>1</id>
                </tag>
                <servers>
                    <server>
                        <id>3</id>
                    </server>
                </servers>
            </tag_servers>
            <tag_servers>
                <tag>
                    <name>Tag 1</name>
                </tag>
                <servers>
                    <server>
                        <id>4</id>
                    </server>
                </servers>
            </tag_servers>
        </tags_servers>
    </connection_to_application_pack>
</connection_to_application_packs>


Response Messages:
400: There are no connection to application packs to add.
400: Application pack ID cannot be empty.
400: Application with ID was not found.
400: There is no application with the specified ID.
400: There is no application pack with the specified ID.
400: Application pack with ID was decommissioned.
400: Application pack with ID was not published.
400: Connection to application pack cannot be created in the domain of the application pack.
400: The application pack cannot be used more than once in the application.
400: Name cannot be empty.
400: Name must contain at least 2 and no more than 160 characters.
400: Name already exists.
400: Tag cannot be empty.
400: Tag ID or name is missing.
400: Tag ID does not exist.
400: Server ID does not exist.
400: Tag ID is not in use in connection to application pack ID, so it cannot be updated.
400: Servers cannot be null.
400: You cannot add ANY to connection to application pack.
400: You cannot add user to connection to application pack.
400: You cannot add Internet to connection to application pack.
401: Access is denied.
401: You do not have permission to access application that contains the server ID
401: You do not have permission to access application pack with ID
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Tag with NAME was not found."},"response":[]}]},{"name":"Application Pending Changes","item":[{"name":"Retrieve existing access rules","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/access_requests","description":"Parameters:
applicationId: The unique identifier of the application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/87/access_requests

Response Messages:
400: The application was already deleted.
400: There are no changed connections that are ready for creating a ticket.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
400: Application with ID ID was not found."},"response":[]}]},{"name":"Application Servers (across all applications)","item":[{"name":"Fetches server by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"serverId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/network_objects/{{serverId}}","description":"Parameters:
serverId: The ID of the server

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects/87

Response Messages:
400: Server with id ID was not found.
400: Application with ID ID was not found.
400: The application was already deleted.
401: Access is denied
401: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance."},"response":[]},{"name":"Fetches servers","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/network_objects","description":"Parameters:
name: The name of the servers [optional]
typeOnDevice: The typeOnDevice of the servers [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects?name=server1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects?typeOnDevice=edl_ip_list

Response Messages:
400: Server with name NAME was not found.
400: Parameter typeOnDevice is not valid.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There are no servers with the name NAME
404: There are no servers with the typeOnDevice TYPEONDEVICE "},"response":[]}]},{"name":"Application Servers (by application)","item":[{"name":"Create servers","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t host comment\n\t\t host1\n\t\t 1.1.1.1\n\t \n\t \n\t\t range comment\n\t\t range1\n\t\t 2.2.2.2\n \t\t 2.2.2.22\n\t \n\t \n\t\t subnet comment\n\t\t subnet1\n\t\t 3.3.3.3\n\t\t 255.255.255.0\n\t \n\t \n\t\t virtual server comment\n\t\t {e1a7722f-e92e-48f2-9087-9cb1711eb8b9}\n\t\t 12\n\t \n\t \n\t\t group comment\n\t\t group1\n\t\t true\n\t\t \n\t\t\t 3\n\t\t \n\t\tedl_ip_list\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects","description":"Parameters:
applicationId: The unique identifier of the application
body: List of servers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects
BODY<network_objects xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
     <network_object xsi:type=\"hostNetworkObjectDTO\">
         <comment>host comment</comment>
         <name>host1</name>
         <ip>1.1.1.1</ip>
     </network_object>
     <network_object xsi:type=\"rangeNetworkObjectDTO\">
         <comment>range comment</comment>
         <name>range1</name>
         <first_ip>2.2.2.2</first_ip>
         <last_ip>2.2.2.22</last_ip>
     </network_object>
     <network_object xsi:type=\"subnetNetworkObjectDTO\">
         <comment>subnet comment</comment>
         <name>subnet1</name>
         <ip>3.3.3.3</ip>
         <netmask>255.255.255.0</netmask>
     </network_object>
     <network_object xsi:type=\"networkObjectVirtualServerDTO\">
         <comment>virtual server comment</comment>
         <uid>{e1a7722f-e92e-48f2-9087-9cb1711eb8b9}</uid>
         <device_id>12</device_id>
     </network_object>
     <network_object xsi:type=\"networkObjectGroupDTO\">
         <comment>group comment</comment>
         <name>group1</name>
         <access_allowed>true</access_allowed>
         <member>
             <id>3</id>
         </member>
        <type_on_device>edl_ip_list</type_on_device>     </network_object>
</network_objects>


Response Messages:
400: There are no items to add.
400: The application was already deleted.
400: You cannot add to application NAME because it was decommissioned.
400: Network object was already saved
400: Name cannot be empty
400: Server with NAME already exists.
400: IP is missing
400: Mask is missing
400: Invalid IP
400: Invalid mask
400: Max IP is missing
400: Min IP is missing
400: Invalid min IP
400: Invalid max IP
400: Min IP cannot be larger than max IP
400: Invalid network object type CLASS_NAME.
400: Invalid uid
400: Invalid device ID
400: Virtual server does not exist in SecureTrack
400: The virtual server already exists in SecureApp as resource NAME: VIRTUAL SERVER NAME VIRTUAL SERVER DEVICE NAME.
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Internet cannot be a member of a group.
400: Cannot save the server because the virtual server does not exist.
400: Cannot save the server because an error occurred
400: The type_on_device value is not valid
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID.
404: Virtual server was not found in SecureTrack.
503: Not connected to SecureTrack."},"response":[]},{"name":"Retrieve existing servers","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects","description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the server [optional]
typeOnDevice: The typeOnDevice of the servers [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects?name=ServerName

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects?typeOnDevice=edl_ip_list

Response Messages:
400: The application was already deleted.
400: Parameter typeOnDevice is not valid.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: There are no servers with the name NAME.
404: There are no servers with the typeOnDevice TYPEONDEVICE "},"response":[]},{"name":"Update servers","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t 1\n\t\t host comment\n\t\t host1\n\t\t 1.1.1.1\n\t\t host\n\t \n\t \n\t\t 2\n\t\t range comment\n\t\t range1\n\t\t 2.2.2.2\n\t\t 2.2.2.22\n\t\t range\n\t \n\t \n\t\t 3\n\t\t subnet comment\n\t\t subnet1\n\t\t 3.3.3.3\n\t\t 255.255.255.0\n\t\t subnet\n\t \n\t \n\t\t 4\n\t\t virtual server comment\n\t\t {e1a7722f-e92e-48f2-9087-9cb1711eb8b9}\n\t\t 12\n\t\t virtual-server\n\t \n\t \n\t\t 5\n\t\t vm1\n\t\t vm instance comment\n\t\t vm_instance\n\t \n\t \n\t\t 6\n\t\t group comment\n\t\t group1\n\t\t true\n\t\t group\n\t\t \n\t\t\t 3\n\t\t \n\t\tedl_ip_list\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects","description":"Parameters:
applicationId: The unique identifier of the application
body: List of servers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects
BODY<network_objects xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
     <network_object xsi:type=\"hostNetworkObjectDTO\">
         <id>1</id>
         <comment>host comment</comment>
         <name>host1</name>
         <ip>1.1.1.1</ip>
         <type>host</type>
     </network_object>
     <network_object xsi:type=\"rangeNetworkObjectDTO\">
         <id>2</id>
         <comment>range comment</comment>
         <name>range1</name>
         <first_ip>2.2.2.2</first_ip>
         <last_ip>2.2.2.22</last_ip>
         <type>range</type>
     </network_object>
     <network_object xsi:type=\"subnetNetworkObjectDTO\">
         <id>3</id>
         <comment>subnet comment</comment>
         <name>subnet1</name>
         <ip>3.3.3.3</ip>
         <netmask>255.255.255.0</netmask>
         <type>subnet</type>
     </network_object>
     <network_object xsi:type=\"networkObjectVirtualServerDTO\">
         <id>4</id>
         <comment>virtual server comment</comment>
         <uid>{e1a7722f-e92e-48f2-9087-9cb1711eb8b9}</uid>
         <device_id>12</device_id>
         <type>virtual-server</type>
     </network_object>
     <network_object xsi:type=\"vmInstanceDTO\">
         <id>5</id>
         <name>vm1</name>
         <comment>vm instance comment</comment>
         <type>vm_instance</type>
     </network_object>
     <network_object xsi:type=\"networkObjectGroupDTO\">
         <id>6</id>
         <comment>group comment</comment>
         <name>group1</name>
         <access_allowed>true</access_allowed>
         <type>group</type>
         <member>
             <id>3</id>
         </member>
        <type_on_device>edl_ip_list</type_on_device>     </network_object>
</network_objects>


Response Messages:
400: The application was already deleted.
400: You cannot update a predefined object.
400: Invalid type in server with id ID.
400: Invalid member with id ID
400: Invalid ID
400: Invalid uid
400: Invalid network object type NAME
400: Cannot update user
400: Network object is new
400: Name cannot be empty
400: Server is in discovery
400: Ip is missing
400: Mask is missing
400: Invalid ip
400: Invalid mask
400: Max ip is missing
400: Min ip is missing
400: Invalid min ip
400: Invalid max ip
400: Min ip cannot be larger than max ip
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Internet cannot be a member of a group.
400: Server with NAME already exists.
400: Invalid device ID
400: The type_on_device value is not valid
400: An EDL group can not be modified to a regular group
400: The virtual server already exists in SecureApp as resource NAME: VIRTUAL SERVER NAME VIRTUAL SERVER DEVICE NAME.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: DTO type used for server id ID is incompatible with this vendor.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Virtual server was not found in ST.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID.
503: Not connected to SecureTrack."},"response":[]},{"name":"Delete server","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"serverId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}","description":"To decommission a serer use force=true.

Parameters:
applicationId: The unique identifier of the application
serverId: The unique identifier of the server
force: Force delete [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/4

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/4?force=true

Response Messages:
400: The application was already deleted.
400: You cannot delete a predefined object.
400: Cannot delete an object that is being referenced by other objects
400: Cannot delete a predefined object.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID."},"response":[]},{"name":"Retrieve an existing server by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"serverId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}","description":"Parameters:
applicationId: The unique identifier of the application
serverId: The unique identifier of the server

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/3

Response Messages:
400: The application was already deleted.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID."},"response":[]},{"name":"Export Server Impact Analysis to a CSV file.","request":{"method":"GET","header":[],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}/impact_analysis_csv","description":"Parameters:
applicationId [optional]
serverId [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/6/impact_analysis_csv

Response Messages:
400: Server with ID was not found.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
404: There is no application with the specified ID."},"response":[]},{"name":"Move server","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"application_id"},{"value":null,"type":"text","key":"server_id"},{"value":null,"type":"text","key":"target_application_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/move_server","description":"Parameters:
application_id: The unique identifier of the application
server_id: The unique identifier of the server
target_application_id: The unique identifier of the target application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/move_server?server_id=5&target_application_id=3

Response Messages:
400: Server ID is missing.
400: Target application ID is missing.
400: You cannot move a predefined object.
400: Server with ID is already associated to application with ID.
400: Cannot move server to a different customer.
400: The application was already deleted.
400: You cannot add to application APPLICATION_NAME because it was decommissioned.
400: Group/Server cannot be moved because there is no other application to move it to.
400: Group/Server cannot be moved because it or at least one of its group members is part of these groups: GROUPS_NAME.
400: Group/Server cannot be moved because it or at least one of its group members is locked for discovery.
400: Group/Server cannot be moved because it or at least one of its group members is used in these application interfaces: APPLICATION_INTERFACE_NAME.
400: Group/Server cannot be moved because it or at least one of its group members is used in these connections with another external resource: CONNECTION_NAME
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]},{"name":"If the identified server is a group, return a list of its members. When the media type is 'text/plain' (default), print each member on a separate line.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}/members","description":"Parameters:
applicationId [optional]
serverId [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/6/members

Response Messages:
400: Server with ID is not of type group
401: Access is denied
401: You do not have permissions to view this application
403: No available licenses. Ask your SecureApp administrator for assistance
404: There is no application with the specified ID
404: Server with ID was not found"},"response":[]}]},{"name":"Application Services (global)","item":[{"name":"Fetches service by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"serviceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services/{{serviceId}}","description":"Parameters:
serviceId: The ID of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services/2

Response Messages:
404: Service with ID <ID> was not found.
401: Access is denied."},"response":[]},{"name":"Delete unused and non predefined global service","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"serviceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services/{{serviceId}}","description":"Parameters:
serviceId: The ID of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services/260

Response Messages:
200: Service was deleted.
404: Global Service with ID was not found.
400: Cannot delete an object that is being referenced by other objects.
400: You cannot delete a predefined object.
401: Access is denied."},"response":[]},{"name":"Modify unused and non predefined global services","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t250\n\t\ticmp service updated\n\t\tUpdated comment\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\t251\n\t\tip service updated\n\t\tUpdated comment\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\t252\n\t\ttcp service updated\n\t\tUpdated comment\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t253\n\t\tudp service updated\n\t\tUpdated comment\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t254\n\t\tService Group 1 updated\n\t\tUpdated comment\n\t\tgroup\n\t\t\n\t\t\t3\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services/","description":"Parameters:
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>250</id>
        <name>icmp service updated</name>
        <comment>Updated comment</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>251</id>
        <name>ip service updated</name>
        <comment>Updated comment</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>252</id>
        <name>tcp service updated</name>
        <comment>Updated comment</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>253</id>
        <name>udp service updated</name>
        <comment>Updated comment</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <id>254</id>
        <name>Service Group 1 updated</name>
        <comment>Updated comment</comment>
        <type>group</type>
        <member>
            <id>3</id>
        </member>
        <member>
            <id>4</id>
        </member>
    </service>
</services>


Response Messages:
200: Services were modified.
400: Members IDs cannot be empty.
404: Service with ID <ID> was not found.
400: Service type must be either SingleServiceDTO or ServiceMemberDTO.
400: Service is new.
400: You cannot update a predefined object.
400: Name <NAME> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: Invalid protocol
400: Global Service cannot be associated with an application.
400: Cannot update a global service that is being referenced by other objects.
400: Cannot update an empty global group.
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Cannot have a local member in global group.
400: Group cannot contain itself as a member.
400: Application identity cannot be a member of a group.
401: Access is denied."},"response":[]},{"name":"Fetches services","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services","description":"Parameters:
globals_only: get only globals [optional]
name: The name of the service [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?name=AH

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?globals_only=true

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?globals_only=true&name=AH

Response Messages:
404: There are no services with the name NAME.
401: Access is denied."},"response":[]},{"name":"Create global services","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\ticmp service\n\t\tNew service\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\tip service\n\t\tIPSEC Authentication Header Protocol\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\ttcp service\n\t\tDiscard Server Protocol (TCP)\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tudp service\n\t\tDiscard Server Protocol (UDP)\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tService Group 1\n\t\tNew Service group\n\t\tgroup\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t2\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services","description":"Parameters:
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>icmp service</name>
        <comment>New service</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>ip service</name>
        <comment>IPSEC Authentication Header Protocol</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>tcp service</name>
        <comment>Discard Server Protocol (TCP)</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>udp service</name>
        <comment>Discard Server Protocol (UDP)</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <name>Service Group 1</name>
        <comment>New Service group</comment>
        <type>group</type>
        <member>
            <id>1</id>
        </member>
        <member>
            <id>2</id>
        </member>
    </service>
</services>


Response Messages:
201: Service was created.
200: Services were created.
400: There are no items to add.
400: Members IDs cannot be empty.
404: Service with ID <ID> was not found.
400: Invalid service type <TYPE>
400: Name <NAME> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: Global Service cannot be associated with an application.
400: Cannot create an empty global group.
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Cannot have a local member in global group.
400: Application identity cannot be a member of a group.
401: Access is denied."},"response":[]},{"name":"Delete unused and non predefined global service by name","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"name"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services","description":"Parameters:
name: The name of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?name=Global service

Response Messages:
200: Service was deleted.
404: Service name has not been provided.
404: There are no services with the name NAME.
400: Cannot delete ANY.
400: Cannot delete an object that is being referenced by other objects.
400: Cannot delete a predefined object.
401: Access is denied."},"response":[]}]},{"name":"Application Services (local)","item":[{"name":"Delete service","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"serviceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services/{{serviceId}}","description":"Use force=true to delete a service with decommission.

Parameters:
applicationId: The unique identifier of the application
serviceId: The unique identifier of the service
force: Force delete [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services/250

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services/250?force=true

Response Messages:
400: The application was already deleted.
400: Cannot delete an object that is being referenced by other objects.
400: Cannot delete a predefined object.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Service with ID <SERVICE_ID> was not found in application with id <APPLICATION_ID>"},"response":[]},{"name":"Retrieve an existing service by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"serviceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services/{{serviceId}}","description":"Parameters:
applicationId: The unique identifier of the application
serviceId: The unique identifier of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services/250

Response Messages:
400: The application was already deleted.
401: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: Service with ID was not found."},"response":[]},{"name":"Create services","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\ticmp service\n\t\tNew service\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\tip service\n\t\tIPSEC Authentication Header Protocol\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\ttcp service\n\t\tDiscard Server Protocol (TCP)\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tudp service\n\t\tDiscard Server Protocol (UDP)\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tService Group 1\n\t\tNew Service group\n\t\tgroup\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t2\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services","description":"Parameters:
applicationId: The unique identifier of the application
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>icmp service</name>
        <comment>New service</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>ip service</name>
        <comment>IPSEC Authentication Header Protocol</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>tcp service</name>
        <comment>Discard Server Protocol (TCP)</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>udp service</name>
        <comment>Discard Server Protocol (UDP)</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <name>Service Group 1</name>
        <comment>New Service group</comment>
        <type>group</type>
        <member>
            <id>1</id>
        </member>
        <member>
            <id>2</id>
        </member>
    </service>
</services>


Response Messages:
201: Service was created.
200: Services were created.
400: There are no items to add.
400: Members IDs cannot be empty.
400: Invalid service type <TYPE>
400: Name <NAME> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: Cannot create an empty global group.
400: The group contains duplicate members.
400: ANY cannot be a member of a group.
400: Cannot have members from different applications.
400: Can not have application identity in group
401: Access is denied
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Service with ID <ID> was not found.
404: There is no application with the specified ID."},"response":[]},{"name":"Update services","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t250\n\t\ticmp service updated\n\t\tUpdated comment\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\t251\n\t\tip service updated\n\t\tUpdated comment\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\t252\n\t\ttcp service updated\n\t\tUpdated comment\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t253\n\t\tudp service updated\n\t\tUpdated comment\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t254\n\t\tService Group 1 updated\n\t\tUpdated comment\n\t\tgroup\n\t\t\n\t\t\t3\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n\t\n\t\t255\n\t\tService Group 2 updated\n\t\tUpdated comment\n\t\tgroup\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services","description":"Parameters:
applicationId: The unique identifier of the application
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>250</id>
        <name>icmp service updated</name>
        <comment>Updated comment</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>251</id>
        <name>ip service updated</name>
        <comment>Updated comment</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>252</id>
        <name>tcp service updated</name>
        <comment>Updated comment</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>253</id>
        <name>udp service updated</name>
        <comment>Updated comment</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <id>254</id>
        <name>Service Group 1 updated</name>
        <comment>Updated comment</comment>
        <type>group</type>
        <member>
            <id>3</id>
        </member>
        <member>
            <id>4</id>
        </member>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <id>255</id>
        <name>Service Group 2 updated</name>
        <comment>Updated comment</comment>
        <type>group</type>
    </service>
</services>


Response Messages:
200: Services were modified.
400: Members IDs cannot be empty.
400: Service type must be either SingleServiceDTO or ServiceMemberDTO.
400: Local service must be associated with an application.
400: Service is locked for discovery.
400: Service is new.
400: Name <NAME> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: The group contains duplicate members.
400: ANY cannot be a member of a group.
400: Application identity cannot be a member of a group.
401: Access is denied
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Service with ID <ID> was not found."},"response":[]},{"name":"Retrieve existing services","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services","description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the service [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services?name=Local service

Response Messages:
400: The application was already deleted.
401: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: There are no services with the name NAME."},"response":[]}]},{"name":"Application Users","item":[{"name":"Delete unused user","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"userId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users/{{userId}}","description":"Parameters:
userId: The ID of the user

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users/10

Response Messages:
200: User was deleted.
404: User with ID <ID> was not found.
400: Cannot delete an object that is being referenced by other objects.
401: Access is denied."},"response":[]},{"name":"Fetches user by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"userId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users/{{userId}}","description":"Parameters:
userId: The ID of the user

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users/10

Response Messages:
404: User with ID <ID> was not found.
401: Access is denied."},"response":[]},{"name":"Fetches users","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users","description":"Parameters:
name: The name of the user [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users?name=Local user 1

Response Messages:
404: There are no users with the name NAME.
401: Access is denied."},"response":[]},{"name":"Create users","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\tLocal user 1\n\t\tNew local user\n\t\t8.8.8.8\n\t\n\t\n\t\tLdap user 1\n\t\tNew ldap user\n\t\n\t\n\t\tUser group 1\n\t\tNew user group\n\t\t\n\t\t\t14\n\t\t\n\t\t\n\t\t\t15\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users","description":"Parameters:
body: List of users

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/users
BODY<users>
    <user>
        <name>Local user 1</name>
        <comment>New local user</comment>
        <ip>8.8.8.8</ip>
    </user>
    <user>
        <name>Ldap user 1</name>
        <comment>New ldap user</comment>
    </user>
    <user xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"userObjectGroupDTO\">
        <name>User group 1</name>
        <comment>New user group</comment>
        <member>
            <id>14</id>
        </member>
        <member>
            <id>15</id>
        </member>
    </user>
</users>


Response Messages:
201: User was created.
200: Users were created.
400: There are no items to add.
400: Members IDs cannot be empty.
404: User with id <ID> was not found.
400: Invalid user type <TYPE>
400: Name cannot be empty.
400: User with name <NAME> already exists.
400: Invalid ip
401: Access is denied."},"response":[]}]},{"name":"Applications","item":[{"name":"Delete an application","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}","description":"Parameters:
applicationId: The unique identifier of the application to delete

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1

Response Messages:
400: The application was already deleted.
400: The resources of application NAME are used in connections for other applications.
400: You cannot delete application NAME because its application interfaces are used in other applications.
400: You cannot delete application NAME because its application interfaces are used in other application packs.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
400: Application with ID ID was not found.
400: You cannot delete application NAME because there are connection changes pending a ticket in other application."},"response":[]},{"name":"Change an application","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t 139\n\t UpdatedAppName\n\t UpdatedComment\n\t false\n\t \n\t\t 4\n\t \n\t \n\t\t \n\t\t\t 3\n\t\t \n\t \n\t \n\t\t \n\t\t\t 5\n\t\t \n\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}","description":"This API can be used to delete or decommission an application.
To decommission an application, send true in decommissioned tag.

Parameters:
applicationId: The unique identifier of an application to change
body: Application

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/139
BODY<application>
     <id>139</id>
     <name>UpdatedAppName</name>
     <comment>UpdatedComment</comment>
     <decommissioned>false</decommissioned>
     <owner>
         <id>4</id>
     </owner>
     <editors>
         <editor>
             <id>3</id>
         </editor>
     </editors>
     <viewers>
         <viewer>
             <id>5</id>
         </viewer>
     </viewers>
</application>


Response Messages:
400: The application was already deleted.
400: Application owner is missing.
400: Owner cannot be empty.
400: Reference to owner ID is invalid.
400: There is an editor without an ID or name.
400: The application owner cannot also be an editor of the application.
400: There is a viewer without an ID or name.
400: The application owner cannot also be a viewer of the application.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application.
401: Access is denied
401: You do not have permissions to change the owner of application ID.
401: You do not have permissions to change the editors and a viewer of application ID.
401: You do not have permissions to decommission this application.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]},{"name":"Retrieve an existing application by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}","description":"Parameters:
applicationId: The unique identifier of an application to retrieve

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1

Response Messages:
400: The application was already deleted.
401: No available licenses. Ask your SecureApp administrator for assistance.
401: Access is denied
401: You do not have permission to access application with ID
404: There is no application with the specified ID."},"response":[]},{"name":"Export application history to PDF","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"application_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/history/export_pdf","description":"Parameters:
application_id: The unique identifier of the application
start_date: States starting date to fetch history since. Date format expected: yyyy-mm-dd [optional]
end_date: Get history until this date. Date format expected: yyyy-mm-dd [optional]
count: History max rows [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?start_date=2015-07-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?start_date=2015-07-18&end_date=2015-12-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?start_date=2015-07-18&count=2

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?count=2

Response Messages:
401: Access is denied.
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
400: The date format must be: yyyy-mm-dd
400: Start date must be before End date"},"response":[]},{"name":"Update applications","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t 140\n\t\t App1\n\t\t true\n\t\t \n\t\t\t 4\n\t\t \n\t \n\t \n\t\t 139\n\t\t UpdatedAppName\n\t\t Updated Comment\n\t\t \n\t\t\t 4\n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 3\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 5\n\t\t\t \n\t\t \n\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/","description":"This API can be used to delete or decommission an application.
To decommission an application, send true in decommissioned tag.

Parameters:
body: List of applications

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications
BODY<applications>
     <application>
         <id>140</id>
         <name>App1</name>
         <decommissioned>true</decommissioned>
         <owner>
             <id>4</id>
         </owner>
     </application>
     <application>
         <id>139</id>
         <name>UpdatedAppName</name>
         <comment>Updated Comment</comment>
         <owner>
             <id>4</id>
         </owner>
         <editors>
             <editor>
                 <id>3</id>
             </editor>
         </editors>
         <viewers>
             <viewer>
                 <id>5</id>
             </viewer>
         </viewers>
     </application>
</applications>


Response Messages:
400: Application ID is missing.
400: Application ID is invalid
400: The application was already deleted.
400: You must include the owner field.
400: There is an editor without an ID or name.
400: The application owner cannot also be an editor of the application.
400: There is a viewer without an ID or name.
400: The application owner cannot also be a viewer of the application.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application.
401: Access is denied
401: You do not have permissions to change the owner of application ID.
401: You do not have permissions to change the editors and a viewer of application ID.
401: You do not have permissions to decommission this application.
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID."},"response":[]},{"name":"Create new applications","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t AppName\n\t\t Comment\n\t\t \n\t\t\t 3\n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 4\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 5\n\t\t\t \n\t\t \n\t\t \n\t\t\t 24\n\t\t \n\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/","description":"Parameters:
body: List all applications

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications
BODY<applications>
     <application>
         <name>AppName</name>
         <comment>Comment</comment>
         <owner>
             <id>3</id>
         </owner>
         <editors>
             <editor>
                 <id>4</id>
             </editor>
         </editors>
         <viewers>
             <viewer>
                 <id>5</id>
             </viewer>
         </viewers>
         <customer>
             <id>24</id>
         </customer>
     </application>
</applications>


Response Messages:
400: There are no items to add.
400: Application was already saved.
400: Application name must contain at least 2 and no more than 160 characters.
400: Owner cannot be empty.
400: The specified owner does not exist.
400: The owner NAME does not have permission to access applications.
400: There is an editor without an ID or name.
400: The application owner cannot also be an editor of the application.
400: There is a viewer without an ID or name.
400: The application owner cannot also be a viewer of the application.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application.
400: Application with NAME already exists.
400: Application owner is missing.
400: Reference to owner ID is invalid.
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to customer ID is invalid.
400: You must specify the name or ID of the customer.
400: The customer has no ID or name.
400: The specified customer does not exist.
400: There is an editor without an ID or name.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no editor with the name NAME."},"response":[]},{"name":"List all applications","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/","description":"Parameters:
userId: Applications by user ID, if not given the default is logged in user id [optional]
name: The name of the application [optional]
app_permissions: Filter applications by the given permissions (separated with commas):\napp_owner - returns applications where the user is the owner\napp_editor - returns applications where the user has been explicitly added as an editor\napp_viewer - returns applications where the user has been explicitly added as a viewer\napp_adminonly - returns applications where the user only has editor access because user has “edit all applications” permission, and does not include applications where this user is either the app_owner, app_editor, or app_viewer [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?name=App

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?userId=1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?app_permissions=app_owner,app_editor,app_viewer

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?name=App&app_permissions=app_adminonly

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications

Response Messages:
400: Invalid app_permissions value: 'appPermissions'.
401: Access is denied
401: You can't use the parameter 'userId' because you don't have 'View all applications' permission.
404: There are no applications matching your filter.
404: User with ID 'userId' was not found."},"response":[]},{"name":"Export Impact Analysis to a CSV file.","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"application_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/impact_analysis_csv","description":"To prevent a CSV injection attack when exporting Impact Analysis to a CSV file, if a special character ( = - + @ ) appears at the beginning of any field, a single quote (') is added before the character.

Parameters:
application_id: The unique identifier of the application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/impact_analysis_csv

Response Messages:
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
404: There is no application with the specified ID."},"response":[]},{"name":"Move applications to another customer","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t \n\t\t\t1\n\t\t \n\t\t \n\t\t\t 2\n\t\t \n\t \n\t \n\t\t \n\t\t\t2\n\t\t \n\t\t \n\t\t\tDefault\n\t\t \n\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/move_applications","description":"Parameters:
body: List of applications and customers [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/move_applications
BODY<move_applications>
     <move_application>
         <application>
            <id>1</id>
         </application>
         <customer>
             <id>2</id>
         </customer>
     </move_application>
     <move_application>
         <application>
            <id>2</id>
         </application>
         <customer>
            <name>Default</name>
         </customer>
     </move_application>
</move_applications>


Response Messages:
200: Applications were moved successfully.
400: Multi-Customer mode is not enabled.
400: You cannot move an application pack to a different customer.
400: Reference to application is invalid.
400: APPLICATION already exists in CUSTOMER.
400: You must specify the name or ID of the customer.
400: The customer has no ID or name.
400: Reference to CUSTOMER is invalid.
400: CUSTOMER is not imported to SecureApp.
400: CUSTOMER was decommissioned.
400: You must delete virtual servers from CUSTOMER before you move APPLICATION to another customer.
400: You must remove virtual servers from the INTERFACE and publish it before you move APPLICATION to another customer.
400: You cannot move APPLICATION to CUSTOMER because the connection to application pack and the application pack cannot be in the same customer.
400: You cannot move APPLICATION to a different customer because the application interface and the application pack must be in the same customer.
400: You must remove INTERFACE from APPLICATION PACK and publish it before you can move APPLICATION to another customer.
400: CONNECTION TO APPLICATION from APPLICATION must use interface from CUSTOMER.
400: Sources in CONNECTION from APPLICATION must all be from applications in the same customer.
400: Destinations in CONNECTION in APPLICATION must all be from applications in the same customer.
400: Servers in CONNECTION from APPLICATION must all be from CUSTOMER.
400: Servers in CONNECTION TO APPLICATION from APPLICATION must be from applications in the same customer.
400: Servers in CONNECTION TO APPLICATION from APPLICATION must be from CUSTOMER.
400: Application or application pack with NAME already exists in CUSTOMER.
400: There are no applications to move.
401: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
401: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]},{"name":"Retrieve security policy violations from SecureTrack","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/compliance_violations","description":"Parameters:
applicationId [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/compliance_violations

Response Messages:
400: No valid connections found in APPLICATION.
400: Security policy compliance check is not available because a security policy has not been defined.
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
503: Cannot connect to SecureTrack.
503: Timeout occurred while waiting for response from SecureTrack.
500: An error occurred in SecureTrack when running the security compliance check."},"response":[]},{"name":"Retrieve application history","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/history","description":"Parameters:
applicationId: The unique identifier of the application
start_date: States starting date to fetch history since. Date format expected: yyyy-mm-dd [optional]
end_date: Get history until this date. Date format expected: yyyy-mm-dd [optional]
count: History list length [optional]
start: Offset the count starting point [optional]
type: States the history type to fetch [optional]
user: The username of the user made the changes [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start_date=2015-07-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start_date=2015-07-18&end_date=2015-12-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start_date=2015-07-18&count=1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start=0&count=1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?type=SERVER

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?user=Jack

Response Messages:
400: The date format must be: yyyy-mm-dd
400: Start date must be before End date
400: Count parameter must be a number
400: Start parameter must be a number
400: Start parameter must be less than total
400: Type parameter must be either server, server_group, connection, application, application_interface, connection_interface or connection_to_application
400: User not found
401: Access is denied
401: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID."},"response":[]}]},{"name":"Cloud Console","item":[{"name":"Associate cloud servers from SecureTrack with an application","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t9\n\t\t\n\t\t\t{b503916e-4468-4dc8-981b-2ec534587352}\n\t\t\t{0cc947a5-276f-4a4a-9d12-df5284fce609}\n\t\t\n\t\n\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/cloud_console/servers/","description":"Parameters:
application_id: The ID of the application
body: List of device IDs and cloud server UIDs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers?application_id=87
BODY<devices_to_uids>
    <device_to_uids>
        <device_id>9</device_id>
        <uids>
            <uid>{b503916e-4468-4dc8-981b-2ec534587352}</uid>
            <uid>{0cc947a5-276f-4a4a-9d12-df5284fce609}</uid>
        </uids>
    </device_to_uids>
</devices_to_uids>


Response Messages:
201: Servers were imported to SecureApp.
401: Access is denied
400: There is no application with the specified ID.
401: No available licenses. Ask your SecureApp administrator for assistance.
400: You do not have permissions to edit this application.
400: You cannot associate servers with this application, because the application has been decommissioned.
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to add cloud servers.
403: UID does not exist in device ID.
403: Device with ID does not exist.
403: Device with ID does not exist in DOMAIN.
403: The AWS instance with UID and device ID has already been imported to application NAME. You cannot import the same instance multiple times."},"response":[]},{"name":"Retrieve cloud server listing from SecureTrack","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"vendor"},{"value":null,"type":"text","key":"search_string"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/cloud_console/servers/","description":"Parameters:
customer_id: Customer ID to be filtered by. [optional]
vendor: Vendor to be filtered by.
search_string: Search text.
start: Returning matching result starting from this element in the array (0-based). [optional]
count: Total number of matching servers to return. [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers?vendor=Amazon&search_string=WebServe

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers?vendor=Amazon&search_string=\"WebServer1\"

Response Messages:
401: Access is denied
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to search for cloud servers.
400: Illegal search string.
400: Start is bigger then possible result count.
400: Start and count cannot hold negative values.
400: Vendor query param is required.
400: Vendor should be one of the following: Amazon.
400: Search string query param is required.
400: Customer with ID does not exist in SecureApp
400: Customer with ID was decommissioned."},"response":[]},{"name":"Auto associate cloud servers from SecureTrack with an application","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tApplication\n\ttrue\n\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/cloud_console/servers/auto_association_rule","description":"When auto-associate is enabled, user must enter key value

Parameters:
body: Auto association rule

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers/auto_association_rule
BODY<auto_association_rule>
    <key>Application</key>
    <enabled>true</enabled>
</auto_association_rule>


Response Messages:
200: Auto association rule is saved.
400: Enabled rule requires key value.
401: Access is denied
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to search for cloud servers."},"response":[]}]},{"name":"Customers","item":[{"name":"Fetches customer by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/{{customer_id}}","description":"Parameters:
customer_id: The ID of the customer

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/1

Response Messages:
400: Not available in single-customer mode.
400: Customer with id ID was not found."},"response":[]},{"name":"Update a customer","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tNOT_IMPORTED\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/{{customer_id}}","description":"Parameters:
customer_id: The ID of the customer
body: Customers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/customers/2
BODY<customer>
    <usage_mode>NOT_IMPORTED</usage_mode>
</customer>


Response Messages:
400: Not available in single-customer mode.
400: Customer with id ID was not found.
400: Can not update Default customer.
400: This customer is already not imported.
400: USAGE_MODE is not a valid state. The valid values are: USAGE_MODES
401: Access is denied
500: This customer is not imported.
400: You cannot delete this customer because there are connection changes pending a ticket in another customer.You must decommission this customer first, and then delete it."},"response":[]},{"name":"List all customers","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/","description":"Parameters:
name: The name of the customer [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers?name=Customer 1

Response Messages:
400: Not available in single-customer mode.
404: There are no customers with the name NAME."},"response":[]},{"name":"Retrieve existing applications for specific domain","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/{{customer_id}}/applications","description":"Parameters:
customer_id: The ID of the customer

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/2/applications

Response Messages:
400: Not available in single-customer mode.
400: Customer with id ID was not found.
401: Access is denied"},"response":[]},{"name":"import customers","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t2\n\t\n\t\n\t\t3\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/import","description":"Only users with 'Create new applications' and 'View all applications' permissions can run this API.

Parameters:
body: Customers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/customers/import
BODY<customers>
    <customer>
        <id>2</id>
    </customer>
    <customer>
        <id>3</id>
    </customer>
</customers>


Response Messages:
400: Not available in single-customer mode.
400: ID can not be empty.
400: There are some id's that doesn't exist.
401: Access is denied
503: Not connected to SecureTrack."},"response":[]},{"name":"List all non-imported customers","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/not_imported","description":"Only users with 'Create new applications' and 'View all applications' permissions can run this API.



Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/not_imported

Response Messages:
400: Not available in single-customer mode.
401: Access is denied
503: Not connected to SecureTrack."},"response":[]},{"name":"List all imported customers","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/imported","description":"

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/imported

Response Messages:
400: Not available in single-customer mode.
401: Access is denied"},"response":[]}]},{"name":"Domains","item":[{"name":"List all domains","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/domains/","description":"Parameters:
name: The name of the domain [optional]

Usage Example


Response Messages:
404: There are no domains with the name NAME."},"response":[]},{"name":"synchronize domains","request":{"method":"PUT","header":[],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/domains/synchronize","description":"Retrieves all the domains lists in ST , for use by SC. If a domain was deleted in ST, then it will be removed from SC



Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/domains/synchronize

Response Messages:
500: Multi-Domain mode is disabled in SecureChange. Unable to synchronize with SecureTrack domains"},"response":[]},{"name":"Fetches domain by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"domainId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/domains/{{domainId}}","description":"Parameters:
domainId: The ID of the domain

Usage Example


Response Messages:
400: Domain with id ID was not found."},"response":[]}]},{"name":"Load Balancers","item":[{"name":"Fetches virtual servers from SecureTrack","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"ip"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/external_resources/f5_virtual_servers","description":"Find virtual servers matching a given IP address.
You can search for the virtual server itself of any of its members.

Parameters:
ip: ip
domainId: The unique identifier of a domain [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/external_resources/f5_virtual_servers?ip=2.2.2.2

Response Messages:
400: Invalid IP
400: Invalid Subnet
400: There is no domain with the specified ID.
401: Access is denied
503: Not connected to SecureTrack."},"response":[]}]},{"name":"SecureChange Devices","item":[{"name":"Returns the details of the devices that you can select as a target in SecureChange","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/","description":"Parameters:
name: device name or part of a name [optional]
show_targets: show devices as targets [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/devices?name=asa&show_targets=true

Response Messages:
404: Devices not found"},"response":[]},{"name":"Update the whole list of excluded devices in SecureChange","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t1\n\t12\n\n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/excluded","description":"Parameters:
body [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded
BODY<device_ids>
    <id>1</id>
    <id>12</id>
</device_ids>

"},"response":[]},{"name":"Returns IDs for specified list of excluded parent management devices and child firewalls in SecureChange","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/excluded","description":"For example on this Panorama hierarchy:
DG1 - Excluded
  DG1.1
    FW1
    FW2
    FW3

Calling this API with false value will return only DG1’s id.
Calling this API with true value will return DG1, FW1, FW2, FW3 id’s.


Parameters:
show_all: When set to true - Displays the specified devices and all their child firewalls in the hierarchy, which will be excluded implicitly.
When set to false - Displays only the devices which were explicitly excluded.
Default value is false.
[optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded
OUTPUT<device_ids>
    <id>10</id>
    <id>11</id>
</device_ids>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded?show_all=false
OUTPUT<device_ids>
    <id>10</id>
    <id>11</id>
</device_ids>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded?show_all=true
OUTPUT<device_ids>
    <id>33</id>
    <id>10</id>
    <id>11</id>
    <id>35</id>
    <id>29</id>
    <id>31</id>
</device_ids>

"},"response":[]},{"name":"Get suggested targets for a given access request","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"access_request\":{\n\t\t\"users\":{\n\t\t\t\"user\":[\n\t\t\t\t\"Any\"\n\t\t\t]\n\t\t},\n\t\t\"sources\":{\n\t\t\t\"source\":[\n\t\t\t\t{\n\t\t\t\t\t\"@type\":\"IP\",\n\t\t\t\t\t\"ip_address\":\"10.100.1.1\",\n\t\t\t\t\t\"netmask\":\"255.255.255.255\",\n\t\t\t\t\t\"cidr\":32\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"destinations\":{\n\t\t\t\"destination\":[\n\t\t\t\t{\n\t\t\t\t\t\"@type\":\"IP\",\n\t\t\t\t\t\"ip_address\":\"10.100.20.2\",\n\t\t\t\t\t\"netmask\":\"255.255.255.255\",\n\t\t\t\t\t\"cidr\":32\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"services\":{\n\t\t\t\"service\":[\n\t\t\t\t{\n\t\t\t\t\t\"@type\":\"ANY\",\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"action\":\"Accept\",\n\t}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/suggest_target","description":"Returns a list of suggested targets for a given access request, based on topology calculations.

Parameters:
body [optional]
domain_name: Domain Name
workflow_name: Workflow Name

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/suggest_target?domain_name=Default&workflow_name=AR
BODY{
    \"access_request\":{
        \"users\":{
            \"user\":[
                \"Any\"
            ]
        },
        \"sources\":{
            \"source\":[
                {
                    \"@type\":\"IP\",
                    \"ip_address\":\"10.100.1.1\",
                    \"netmask\":\"255.255.255.255\",
                    \"cidr\":32
                }
            ]
        },
        \"destinations\":{
            \"destination\":[
                {
                    \"@type\":\"IP\",
                    \"ip_address\":\"10.100.20.2\",
                    \"netmask\":\"255.255.255.255\",
                    \"cidr\":32
                }
            ]
        },
        \"services\":{
            \"service\":[
                {
                    \"@type\":\"ANY\",
                }
            ]
        },
        \"action\":\"Accept\",
    }
}
OUTPUT{
    \"multi_target\": {
        \"target\": {
            \"@type\": \"Object\",
            \"object_name\": \"Device-1\",
            \"object_type\": \"firewall\",
            \"object_details\": \"10.100.40.1\",
            \"management_id\": 250,
            \"management_name\": \"Panorama/Domain1\"
        }
    }
}


Response Messages:
200: Targets returned successfully
400: User does not have permissions to domain or domain does not exist
401: Access is denied"},"response":[]}]},{"name":"Server Decommissioning","item":[{"name":"Get server decommission designer results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_server_decommission_request/{{fieldId}}/designer","description":"Use this API to retrieve designer results generated in R17-1 and earlier.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Server Decommission Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/multi_server_decommission_request/261/designer

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>."},"response":[]},{"name":"Get verifier results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_server_decommission_request/{{fieldId}}/verifier","description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Server Decommission Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/multi_server_decommission_request/261/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>."},"response":[]},{"name":"Run server decommission designer for given task","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/multi_server_decommission_request/designer","description":"Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/multi_server_decommission_request/designer

Response Messages:
400: Server decommission designer is not defined for the requested field.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a decommission request field.
401: You do not have permission to update this task. Contact your administrator for assistance."},"response":[]},{"name":"Get impact analysis results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_server_decommission_request/{{fieldId}}/impact_analysis","description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Server Decommission Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/multi_server_decommission_request/261/impact_analysis

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>."},"response":[]},{"name":"Run Verifier for given task","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/multi_server_decommission_request/verifier","description":"Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/multi_server_decommission_request/verifier

Response Messages:
400: Verifier is not defined for the requested field.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a decommission request field.
401: You do not have permission to update this task. Contact your administrator for assistance."},"response":[]},{"name":"Run Impact Analysis for given task","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/multi_server_decommission_request/impact_analysis","description":"Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/multi_server_decommission_request/impact_analysis

Response Messages:
400: Impact analysis is not defined for the requested field.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a decommission request field.
401: You do not have permission to update this task. Contact your administrator for assistance."},"response":[]}]},{"name":"System Configuration","item":[{"name":"Modify the SecureTrack connection settings and test the connection status","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\t\n\t\t \n\t\t\t192.168.11.1\n\t\t\tadmin\n\t\t\n\t\tfalse\n\t\t30\n\t\t192.168.2.2\n\t"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/integration_with_secureTrack/","description":"Parameters:
testOnly: Test the connection status using the specified settings. The new settings are not saved. The default value is false [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/integration_with_secureTrack
BODY    <secureTrack_settings>
        <host xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"remoteHost\">
            <IP_or_hostname>192.168.11.1</IP_or_hostname>
            <user_name>admin</user_name>
        </host>
        <show_link_to_secureTrack>false</show_link_to_secureTrack>
        <check_connection_interval>30</check_connection_interval>
        <internal_IP_of_secureChange_server>192.168.2.2</internal_IP_of_secureChange_server>
    </secureTrack_settings>


Response Messages:
400: Invalid host name or IP address.
400: show_link_to_secureTrack is invalid. It must be 'true', 'false' or empty."},"response":[]},{"name":"Retrieve the SecureTrack connection settings and status","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/integration_with_secureTrack/","description":"

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/integration_with_secureTrack?testOnly=false
"},"response":[]}]},{"name":"System Users","item":[{"name":"Import LDAP users to SecureChange by simulating login process","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tx\n\tLDAP\n\t\t\n\t\t\t1\n\t\t\n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/","description":"This API implicitly imports LDAP users to SecureChange by simulating their login.
To explicitly import LDAP entities- both users and groups, it is recommended to use /users/import API

Parameters:
body: partyDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/users
BODY<user xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"user\">
    <name>x</name>
    <origin_type>LDAP</origin_type>
        <ldap_configuration>
            <id>1</id>
        </ldap_configuration>
</user>


Response Messages:
401: Access is denied.
400: Name is missing.
400: Origin is missing.
400: User {login_name} already exists, with ID (id} and name {name}.
400: User {login_name} not found in LDAP.
400: Creating a user via REST API is available only if origin is LDAP.
400: Creating a user via REST API is available only if type is User.
400: Ldap configuration with ID {id} not found."},"response":[]},{"name":"Return the list of users","request":{"method":"GET","header":[],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/","description":"user_name: case insensitive, search mode: contains text
exact_name: when set to true, user_name search mode is case sensitive and exact text
email: case insentitive, search mode: exact match
Logical OR between user_name and email.

Parameters:
showIndirectRelation: Members that belong to the selected group only indirectly [optional]
user_name: The user's login name [optional]
email: The user's email [optional]
exact_name: Search user_name as exact match [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/users?email=bob@tufin.com&user_name=bob&exact_name=true
"},"response":[]},{"name":"Change local group members","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"group_change\":{\n\t\t\"member_ids_to_add\": [1,2],\n\t\t\"member_ids_to_remove\":[3,4]\n\t}\n}\t"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/group/{{id}}","description":"Only users with 'view settings tab' permission can run this API.

Parameters:
id: Group ID
body: groupChangeDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/users/group/1
BODY{
    \"group_change\":{
        \"member_ids_to_add\": [1,2],
        \"member_ids_to_remove\":[3,4]
    }
}    


Response Messages:
400: Exceeded limit of {MAXIMUM} group member changes
400: These user IDs do not exist: {IDs}
400: These user IDs do not exist or are not group members: {IDs}
400: Group ID {ID} is not a local group
400: Group ID {ID} does not exist
400: Cannot add a group to itself
400: Cannot add a group to a group that it already contains. Group {ID1} contains group {ID2}"},"response":[]},{"name":"Import user / group from LDAP","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"ldap_party\": {\n\t\t\"ldap_configuration_name\": \"ldap_name\",\n\t\t\"ldap_dn\": \"CN=alice,OU=Advertising,OU=Marketing,DC=testEnv,DC=com\"\n\t}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/import","description":"The imported user / group will be visible in SecureChange GUI under users section.
In multi domain mode, imported entity will be assigned with the domains of \"any user\" group.
Only users with 'view settings tab' permission can run this API.

Parameters:
body: ldapPartyDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/users/import
BODY{
    \"ldap_party\": {
        \"ldap_configuration_name\": \"ldap_name\",
        \"ldap_dn\": \"CN=alice,OU=Advertising,OU=Marketing,DC=testEnv,DC=com\"
    }
}


Response Messages:
400: The LDAP configuration name does not exist
400: The given ldap_dn does not exist
400: The given ldap_dn is already imported
400: Failed to create the selected user
400: Failed to create the selected group
400: Selected user already exists in SecureChange but is not synchronized with the LDAP server. Go to Settings > LDAP and synchronize with the LDAP
400: This group has a large number of users, and will not be expanded in the users console. To be able to configure roles and step participation for individual users from the group, add them explicitly.
400: Failed to update the selected group
400: Unsupported LDAP object class
400: Unable to establish a connection to server <SERVER_IP>:<SERVER_PORT> within the configured timeout of <TIMEOUT> milliseconds.
401: Access is denied"},"response":[]},{"name":"Create local group","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"group\": {\n\t\t\"name\": \"name1\",\n\t\t\"description\": \"description1\",\n\t\t\"email\": \"email1@tufin.com\"\n\t}\n}\t"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/group","description":"Only users with 'view settings tab' permission can run this API.

Parameters:
body: CreateGroupDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/users/group
BODY{
    \"group\": {
        \"name\": \"name1\",
        \"description\": \"description1\",
        \"email\": \"email1@tufin.com\"
    }
}    


Response Messages:
400: Input Validation Error : {field name}: {input validation error message}
400: Name already exists"},"response":[]},{"name":"Delete the specified User or Group","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/{{id}}","description":"Parameters:
id: User ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/users/5

Response Messages:
400: User with id {id} does not exist"},"response":[]},{"name":"Return the specified user","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/{{id}}","description":"Parameters:
id: User ID
showIndirectRelation: Members that belong to the selected group only indirectly [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/users/5

Response Messages:
400: User or group was not found."},"response":[]}]},{"name":"Ticket Lifecycle","item":[{"name":"Reject a ticket","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\trejected\n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/reject","description":"Parameters:
id: The ID of the ticket as shown in SecureChange
handler_id: The user id, when logged in user is rejecting on behalf [optional]
body: Reject comment

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/reject?handler_id=5
BODY<reject_comment>
    <comment>rejected</comment>
</reject_comment>


Response Messages:
400: Ticket status <STATUS> is incorrect to perform this action
400: User <NAME> has no permissions to perform this action
400: Comment cannot be empty
401: User is not permitted to reject this ticket on behalf another user
401: You do not have permission to access ticket <ID>
401: On behalf user do not have permission to access ticket <ID>
401: Access is denied.
404: There is no ticket with ID <ID>.
404: There is no handler (User) with ID <ID>."},"response":[]},{"name":"Change the requester of the specified ticket task to the specified user.","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tuser was deleted moving tickets to Bob\n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/change_requester/{{assigneeId}}","description":"Parameters:
id: Ticket ID
assigneeId: The assignee ID
body: CommentDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/change_requester/4
BODY<comment>
    <comment>user was deleted moving tickets to Bob</comment>
</comment>


Response Messages:
400: The change requester comment must be set in order to change the requester the ticket.
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
404: There is no ticket with ID.
404: There is no requester (User) with ID."},"response":[]},{"name":"Returns the specified ticket to the specified step","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tplease fix source \n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/redo/{{toStepId}}","description":"Values can only be updated for the current step.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
toStepId: To which step we the ticket will return
body: RedoCommentDto

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/redo/1
BODY<redo_step_comment>
    <comment>please fix source </comment>
</redo_step_comment>


Response Messages:
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Task <NAME> is no longer active
401: User has no permissions to redo ticket steps.
404: There is no ticket with ID.
404: No entity found for query"},"response":[]},{"name":"Cancel a ticket","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/cancel","description":"Parameters:
id: The ID of the ticket as shown in SecureChange
requester_id: The user of the ticket's requester, when logged in user is canceling on behalf [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/cancel?requester_id=5

Response Messages:
401: Access is denied.
404: Ticket is already closed
404: Ticket ID was not found"},"response":[]},{"name":"Map rules to ticket","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/map_rules","description":"Maps the rules from the ticket to the relevant rules in SecureTrack.
Adds record set entries to the relevant rules metadata.
Link to history is found in the returned location header.
Applicable only for closed tickets in the following workflows: Access Request, Access Request and Modify Group, and Clone Server Policy.
Use handler_id for running on behalf of another user.
To get handler_id, use the System Users API.

Parameters:
id: The ID of the ticket as shown in SecureChange
handler_id: Run API on behalf of defined user id [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/map_rules

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/map_rules?handler_id=5

Response Messages:
201: Started asynchronous mapping of rules to ticket ID <ID>. Mapping status is displayed in ticket history.
400: Ticket's workflow type does not support this operation
401: Access is denied.
401: You do not have permission to access ticket <ID>
401: On behalf user do not have permission to access ticket <ID>
404: There is no ticket with ID <ID>.
404: There is no handler (User) with ID <ID>.
412: Ticket is not in closed status"},"response":[]},{"name":"Returns the history of the specified ticket","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/history","description":"Parameters:
id: Ticket ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/history

Response Messages:
401: User has no permissions to view ticket history
404: You do not have permission to view this task. Contact your administrator for assistance.
404: There is no ticket with ID."},"response":[]},{"name":"Confirm the request","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tconfirmed\n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/confirm","description":"Parameters:
id: Ticket ID
requester_id: The user of the ticket's requester, when logged in user is confirm on behalf [optional]
body: Confirm comment

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/confirm?requester_id=5
BODY<confirm_comment>
    <comment>confirmed</comment>
</confirm_comment>


Response Messages:
400: User is trying to confirm a ticket that belongs to another user
400: User is not permitted to confirm this ticket on behalf another user
400: The user can not confirm the ticket, because he is not in the domain of the ticket
401: Access is denied.
404: There is no ticket with ID ."},"response":[]},{"name":"Reassigns the specified ticket task to the specified user.","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tPlease complete the AR\n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/reassign/{{assigneeId}}","description":"Values can only be updated for the current step.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
assigneeId: The assignee ID
body: ReassignTaskCommentDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/reassign/4
BODY<reassign_task_comment>
    <comment>Please complete the AR</comment>
</reassign_task_comment>


Response Messages:
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Task <NAME> is no longer active
404: There is no ticket with ID.
404: No entity found for query"},"response":[]}]},{"name":"Tickets","item":[{"name":"Get server clone policy verifier results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/clone_server_policy/verifier","description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/clone_server_policy/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.
404: Verifier results were not found in the server clone policy request."},"response":[]},{"name":"Get access request verifier results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_access_request/{{fieldId}}/verifier","description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/multi_access_request/2022/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.
404: Verifier results were not found in the access request."},"response":[]},{"name":"Change a task of a ticket at the current step","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\t\"task\": {\n\t\t\"status\": \"ASSIGNED\",\n\t\t\"fields\": {\n\t\t\t\"field\": {\n\t\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\t\"id\": 743,\n\t\t\t\t\"devices\": {\n\t\t\t\t\t\"device\": {\n\t\t\t\t\t\t\"revision_id\": 24,\n\t\t\t\t\t\t\"management_id\": 5,\n\t\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"rule_modifications\": {\n\t\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: ticketTaskDTO
id: Ticket ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4
BODY<task>
    <status>DONE</status>
    <fields/>
</task>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4
BODY{
    \"task\": {
        \"status\": \"ASSIGNED\",
        \"fields\": {
            \"field\": {
                \"@xsi.type\": \"rule_modification_field\",
                \"id\": 743,
                \"devices\": {
                    \"device\": {
                        \"revision_id\": 24,
                        \"management_id\": 5,
                        \"bindings\": {
                            \"binding\": {
                                \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                                \"binding\": {
                                    \"@xsi.type\": \"policy__binding\",
                                    \"policy_name\": \"FortiGate-VM64-111-10_3\"
                                },
                                \"rules\": {
                                    \"rule\": {
                                        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                        \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                                    }
                                }
                            }
                        }
                    }
                },
                \"rule_modifications\": {
                    \"rule_modification\": {
                        \"@xsi.type\": \"modify_rule_modification\",
                        \"rule_key\": {
                            \"device_id\": 5,
                            \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                            \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                        },
                        \"source_modifications\": {
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                    \"name\": \"RANGE_1\",
                                                    \"comment\": \"EXAMPLE_RANGE\",
                                                    \"min_ip\": \"3.3.3.3\",
                                                    \"max_ip\": \"5.5.5.5\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                    \"name\": \"NET_1\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"3.3.3.3\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        },
                        \"destination_modifications\": {
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                    \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"name\": \"Host123\",
                                                    \"comment\": \"cccHost\",
                                                    \"ip\": \"1.2.3.4\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"REMOVE\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                            }
                                        }
                                    }
                                ]
                            }
                        },
                        \"service_modifications\": {
                            \"service_object_cell_modifications\": {
                                \"service_object_cell_modification\": [
                                    {
                                        \"action\": \"REMOVE\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                                \"name\": \"ICMP_1\",
                                                \"comment\": \"EXAMPLE_ICMP\",
                                                \"type\": {
                                                    \"from\": 55,
                                                    \"to\": 55
                                                }
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                \"name\": \"TCP_1\",
                                                \"comment\": \"EXAMPLE_TCP\",
                                                \"port\": {
                                                    \"from\": 1234,
                                                    \"to\": 1234
                                                },
                                                \"protocol\": \"TCP\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                \"name\": \"UDP_1\",
                                                \"comment\": \"EXAMPLE_UDP\",
                                                \"port\": {
                                                    \"from\": 3,
                                                    \"to\": 3
                                                },
                                                \"protocol\": \"UDP\"
                                            }
                                        }
                                    }
                                ]
                            }
                        }
                    }
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Task status does not exist.
400: Task status is not set to ASSIGNED or DONE.
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
403: Task can not be done because there are unlicensed devices for change automation
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value"},"response":[]},{"name":"Returns a list of tickets by search parameters","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/search","description":"If the query is succesful but no results are found (for example, if there is no ticket for the specified Ticket ID) then the return code will be 200 and the results will be empty.

Parameters:
id: The ID number of the ticket as shown in SecureChange [optional]
subject: The subject of the ticket [optional]
requester: The requester of the ticket [optional]
group: The group handling the ticket [optional]
assigned_to: The user name of the person assigned to the ticket [optional]
priority: The priority of the ticket [optional]
status: The status of the ticket [optional]
sla_status: The SLA status of the ticket [optional]
field_name: Field name to search by [optional]
field_value: Field value to search by [optional]
current_step: Current step name [optional]
expiration_date_from: Search requests with expiration date from this date [optional]
expiration_date_to: Search requests with expiration date until this date [optional]
domain_name: The Domain of the ticket [optional]
start: Offset the count starting point [optional]
count: Ticket list length [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/search?id=1&status=IN_PROGRESS,REJECTED

Response Messages:
401: Access is denied.
400: Illegal ticket status entered. Permitted values are: IN_PROGRESS, REJECTED, CLOSED, CANCELLED, RESOLVED, WAITING_TO_BE_ASSIGNED, ASSIGNED, WAITING_FOR_MORE_INFO, DONE, INVALID, PENDING, PENDING_LICENS
400: Illegal ticket SLA status entered. Permitted values are: NA, OK, WARNING, ALERT, ESCALATION
400: Illegal ticket priority entered. Permitted values are: LOW, NORMAL, HIGH, CRITICAL
400: Illegal ticket expiration date entered. Permitted date format is: ddMMyyyy (ex. 20.11.2001)
400: Cannot find specified domain <DOMAIN_NAME>"},"response":[]},{"name":"Get designer results according to field id","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/designer","description":"Use this API to retrieve designer results generated in R17-2 and later.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/designer

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: Specified field, id: <ID> , name: <NAME>, cannot contain designer result
404: Designer results were not found in the request."},"response":[]},{"name":"Returns the details of a specified ticket","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
expand_links: See expanded view of the objects [optional]
showStepsDetails: Include steps' details in the response [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1
OUTPUT {
    \"ticket\": {
        \"id\": 1,
        \"subject\": \"AR-Ticket\",
        \"requester\": \"a\",
        \"requester_id\": 4,
        \"priority\": \"Normal\",
        \"status\": \"In Progress\",
        \"domain_name\": \"\",
        \"sla_status\": \"NA\",
        \"sla_outcome\": \"NA\",
        \"workflow\": {
            \"id\": 11,
            \"name\": \"AR & MG\",
            \"uses_topology\": true
        },
        \"steps\": {
            \"step\": [
                {
                    \"id\": 209,
                    \"name\": \"Open request\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 209,
                            \"assignee_id\": 4,
                            \"assignee\": \"a\",
                            \"status\": \"DONE\",
                            \"fields\": {
                                \"field\": [
                                    {
                                        \"@xsi.type\": \"multi_access_request\",
                                        \"id\": 1695,
                                        \"name\": \"AR\",
                                        \"read_only\": false,
                                        \"access_request\": {
                                            \"id\": 1706,
                                            \"order\": \"AR1\",
                                            \"risk_analysis_result\": {
                                                \"status\": \"not run\"
                                            },
                                            \"verifier_result\": {
                                                \"status\": \"not run\"
                                            },
                                            \"use_topology\": true,
                                            \"targets\": {
                                                \"target\": {
                                                    \"@type\": \"ANY\",
                                                    \"id\": 1705
                                                }
                                            },
                                            \"users\": {
                                                \"user\": [
                                                    \"Any\"
                                                ]
                                            },
                                            \"sources\": {
                                                \"source\": [
                                                    {
                                                        \"@type\": \"INTERNET\",
                                                        \"id\": 1701
                                                    },
                                                    {
                                                        \"@type\": \"DNS\",
                                                        \"id\": 1702,
                                                        \"host_name\": \"www.google.com\",
                                                        \"dns_ip_addresses\": {
                                                            \"ip_address\": \"216.58.214.100\"
                                                        }
                                                    },
                                                    {
                                                        \"@type\": \"IP\",
                                                        \"id\": 1703,
                                                        \"ip_address\": \"1.1.1.1\",
                                                        \"netmask\": \"255.255.255.255\",
                                                        \"nat_ip_address\": \"4.4.4.4\",
                                                        \"nat_netmask\": \"255.255.255.255\"
                                                    }
                                                ]
                                            },
                                            \"destinations\": {
                                                \"destination\": [
                                                    {
                                                        \"@type\": \"ANY\",
                                                        \"id\": 1697
                                                    }
                                                ]
                                            },
                                            \"services\": {
                                                \"service\": [
                                                    {
                                                        \"@type\": \"ANY\",
                                                        \"id\": 1699
                                                    }
                                                ]
                                            },
                                            \"action\": \"Accept\",
                                            \"labels\": \"\"
                                        }
                                    },
                                    {
                                        \"@xsi.type\": \"multi_group_change\",
                                        \"id\": 1707,
                                        \"name\": \"MG\",
                                        \"read_only\": false,
                                        \"implementation_status\": \"NOT_SUPPORTED\"
                                    }
                                ]
                            }
                        }
                    }
                },
                {
                    \"id\": 210,
                    \"name\": \"STEP2 - auto AR with designer /update /commit\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 210,
                            \"assignee_id\": 4,
                            \"assignee\": \"a\",
                            \"status\": \"ASSIGNED\",
                            \"unlicensed_devices_for_automation\": {
                                \"unlicensed_device_for_automation\": [
                                    {
                                        \"id\": \"2\",
                                        \"name\": \"asa\"
                                    }
                                ]
                            }
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"multi_access_request\",
                                    \"id\": 1709,
                                    \"name\": \"AR\",
                                    \"read_only\": false,
                                    \"access_request\": {
                                        \"id\": 1720,
                                        \"order\": \"AR1\",
                                        \"risk_analysis_result\": {
                                            \"status\": \"not run\"
                                        },
                                        \"verifier_result\": {
                                            \"status\": \"not run\"
                                        },
                                        \"use_topology\": true,
                                        \"targets\": {
                                            \"target\": {
                                                \"@type\": \"ANY\",
                                                \"id\": 1719
                                            }
                                        },
                                        \"users\": {
                                            \"user\": [
                                                \"Any\"
                                            ]
                                        },
                                        \"sources\": {
                                            \"source\": [
                                                {
                                                    \"@type\": \"INTERNET\",
                                                    \"id\": 1721
                                                },
                                                {
                                                    \"@type\": \"DNS\",
                                                    \"id\": 1722,
                                                    \"host_name\": \"www.google.com\",
                                                    \"dns_ip_addresses\": {
                                                        \"ip_address\": \"216.58.214.100\"
                                                    }
                                                },
                                                {
                                                    \"@type\": \"IP\",
                                                    \"id\": 1723,
                                                    \"ip_address\": \"1.1.1.1\",
                                                    \"netmask\": \"255.255.255.255\",
                                                    \"nat_ip_address\": \"4.4.4.4\",
                                                    \"nat_netmask\": \"255.255.255.255\"
                                                },
                                                {
                                                    \"@type\": \"RANGE\",
                                                    \"id\": 1724,
                                                    \"range_first_ip\": \"1.1.11.1\",
                                                    \"range_last_ip\": \"1.1.11.10\"
                                                }
                                            ]
                                        },
                                        \"destinations\": {
                                            \"destination\": [
                                                {
                                                    \"@type\": \"ANY\",
                                                    \"id\": 1711
                                                }
                                            ]
                                        },
                                        \"services\": {
                                            \"service\": [
                                                {
                                                    \"@type\": \"ANY\",
                                                    \"id\": 1713
                                                }
                                            ]
                                        },
                                        \"action\": \"Accept\",
                                        \"labels\": \"\"
                                    }
                                }
                            }
                        }
                    }
                }
            ]
        },
        \"current_step\": {
            \"id\": 210,
            \"name\": \"STEP2 - auto AR with designer /update /commit\"
        },
        \"comments\": \"\"
    }
}


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2
OUTPUT {
    \"ticket\": {
        \"id\": 2,
        \"subject\": \"Clone Server Policy Ticket\",
        \"requester\": \"a\",
        \"requester_id\": 12,
        \"priority\": \"Normal\",
        \"status\": \"In Progress\",
        \"domain_name\": \"\",
        \"sla_status\": \"NA\",
        \"sla_outcome\": \"NA\",
        \"workflow\": {
            \"id\": 109,
            \"name\": \"sc_12705\",
            \"uses_topology\": false
        },
        \"steps\": {
            \"step\": [
                {
                    \"id\": 78,
                    \"name\": \"Open request\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 78,
                            \"assignee_id\": 12,
                            \"assignee\": \"a\",
                            \"status\": \"DONE\",
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"clone_server_policy_request\",
                                    \"id\": 872,
                                    \"name\": \"Clone Server Policy Field\",
                                    \"from_server\": {
                                        \"@type\": \"IP\",
                                        \"id\": 869,
                                        \"ip_address\": \"1.2.2.2\",
                                        \"cidr\": 32
                                    },
                                    \"to_servers\": {
                                        \"server\": {
                                            \"@type\": \"IP\",
                                            \"id\": 871,
                                            \"ip_address\": \"10.100.23.32\",
                                            \"netmask\": \"255.255.255.255\",
                                            \"cidr\": 32
                                        }
                                    },
                                    \"comment\": \"target servers to clone server policy to\"
                                }
                            }
                        }
                    }
                },
                {
                    \"id\": 79,
                    \"name\": \"Business Approval\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 79,
                            \"assignee_id\": 12,
                            \"assignee\": \"a\",
                            \"status\": \"ASSIGNED\",
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"clone_server_policy_request\",
                                    \"id\": 876,
                                    \"name\": \"Clone Server Policy Field\",
                                    \"from_server\": {
                                        \"@type\": \"IP\",
                                        \"id\": 873,
                                        \"ip_address\": \"1.2.2.2\",
                                        \"cidr\": 32
                                    },
                                    \"to_servers\": {
                                        \"server\": {
                                            \"@type\": \"IP\",
                                            \"id\": 875,
                                            \"ip_address\": \"10.100.23.32\",
                                            \"netmask\": \"255.255.255.255\",
                                            \"cidr\": 32
                                        }
                                    },
                                    \"comment\": \"target servers to clone server policy to\"
                                }
                            }
                        }
                    }
                }
            ]
        },
        \"current_step\": {
            \"id\": 79,
            \"name\": \"Business Approval\"
        },
        \"comments\": \"\"
    }
}


Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: No entity found for query"},"response":[]},{"name":"Get commands for device from designer results of a specific field id","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"deviceId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/designer/device/{{deviceId}}/commands","description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
deviceId: Device ID
fieldId: Field ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/designer/device/136/commands

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: Specified field, id: <ID> , name: <NAME>, cannot contain designer result
404: Designer results were not found in the access request.
404: Device with ID <ID> was not found in Designer result.
404: Device with ID <ID> does not support Commands feature."},"response":[]},{"name":"Returns the details of a specified ticket stages","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found"},"response":[]},{"name":"Change multiple fields within a task of a ticket","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\"fields\": {\n\"field\": {\n\"@xsi.type\": \"rule_modification_field\",\n\"id\": 746,\n\"name\": \"rm\",\n\"devices\": {\n\t\"device\": {\n\t\"revision_id\": 24,\n\t\"management_id\": 5,\n\t\"bindings\": {\n\t\"binding\": {\n\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\"binding\": {\n\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t},\n\t\"rules\": {\n\t\t\"rule\": {\n\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t}\n\t}\n\t}\n\t}\n\t}\n},\n\"rule_modifications\": {\n\t\"rule_modification\": {\n\t\"@xsi.type\": \"modify_rule_modification\",\n\t\"rule_key\": {\n\t\"device_id\": 5,\n\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t},\n\t\"source_modifications\": {\n\t\"network_object_cell_modifications\": {\n\t\"network_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\"name\": \"NET_1\",\n\t\t\t\"comment\": \"\",\n\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t}\n\t\t]\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t}\n\t\t]\n\t\t}\n\t\t}\n\t]\n\t}\n\t},\n\t\"destination_modifications\": {\n\t\"network_object_cell_modifications\": {\n\t\"network_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"REMOVE\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\"name\": \"Host123\",\n\t\t\t\"comment\": \"cccHost\",\n\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t}\n\t\t]\n\t\t}\n\t\t}\n\t]\n\t}\n\t},\n\t\"service_modifications\": {\n\t\"service_object_cell_modifications\": {\n\t\"service_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"REMOVE\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\"name\": \"ICMP_1\",\n\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\"type\": {\n\t\t\t\"from\": 55,\n\t\t\t\"to\": 55\n\t\t}\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\"name\": \"TCP_1\",\n\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\"port\": {\n\t\t\t\"from\": 1234,\n\t\t\t\"to\": 1234\n\t\t},\n\t\t\"protocol\": \"TCP\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\"name\": \"UDP_1\",\n\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\"port\": {\n\t\t\t\"from\": 3,\n\t\t\t\"to\": 3\n\t\t},\n\t\t\"protocol\": \"UDP\"\n\t\t}\n\t\t}\n\t\t}\n\t]\n\t}\n\t}\n\t}\n}\n}\n}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldListDTO
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/2/tasks/4/fields
BODY<fields>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_network_object\">
         <id>7885</id>
         <name>n_obj</name>
         <network_object type=\"Object\">
             <object_name>Host_10.1.1.1</object_name>
             <management_name>cp239</management_name>
         </network_object>
         <network_object type=\"Object\">
             <st_uid>{55908141-c341-4990-9cc6-a3fd2dfb49e1}</st_uid>
             <management_id>2</management_id>
         </network_object>
         <network_object type=\"DNS\">
             <host_name>tufin.com</host_name>
         </network_object>
     <field>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_service\">
         <id>7887</id>
         <name>service</name>
         <service type=\"PROTOCOL\">
             <protocol>TCP</protocol>
             <port>80</port>
         </service>
         <service type=\"Object\">
             <object_name>AOL</object_name>
             <management_name>cp239</management_name>
         </service>
     </field>
</fields>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/fields
BODY{
\"fields\": {
\"field\": {
\"@xsi.type\": \"rule_modification_field\",
\"id\": 746,
\"name\": \"rm\",
\"devices\": {
    \"device\": {
    \"revision_id\": 24,
    \"management_id\": 5,
    \"bindings\": {
    \"binding\": {
    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
    \"binding\": {
        \"@xsi.type\": \"policy__binding\",
        \"policy_name\": \"FortiGate-VM64-111-10_3\"
    },
    \"rules\": {
        \"rule\": {
        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
        \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
        }
    }
    }
    }
    }
},
\"rule_modifications\": {
    \"rule_modification\": {
    \"@xsi.type\": \"modify_rule_modification\",
    \"rule_key\": {
    \"device_id\": 5,
    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
    \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
    },
    \"source_modifications\": {
    \"network_object_cell_modifications\": {
    \"network_object_cell_modification\": [
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
            \"name\": \"NET_1\",
            \"comment\": \"\",
            \"ip\": \"3.3.3.3\",
            \"netmask\": \"255.255.255.255\"
        }
        ]
        }
        },
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
            \"name\": \"RANGE_1\",
            \"comment\": \"EXAMPLE_RANGE\",
            \"min_ip\": \"3.3.3.3\",
            \"max_ip\": \"5.5.5.5\"
        }
        ]
        }
        }
    ]
    }
    },
    \"destination_modifications\": {
    \"network_object_cell_modifications\": {
    \"network_object_cell_modification\": [
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
        }
        }
        },
        {
        \"action\": \"REMOVE\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
            \"name\": \"Host123\",
            \"comment\": \"cccHost\",
            \"ip\": \"1.2.3.4\",
            \"netmask\": \"255.255.255.255\"
        }
        ]
        }
        }
    ]
    }
    },
    \"service_modifications\": {
    \"service_object_cell_modifications\": {
    \"service_object_cell_modification\": [
        {
        \"action\": \"REMOVE\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:icmp_service\",
        \"name\": \"ICMP_1\",
        \"comment\": \"EXAMPLE_ICMP\",
        \"type\": {
            \"from\": 55,
            \"to\": 55
        }
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:transport_service\",
        \"name\": \"TCP_1\",
        \"comment\": \"EXAMPLE_TCP\",
        \"port\": {
            \"from\": 1234,
            \"to\": 1234
        },
        \"protocol\": \"TCP\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:transport_service\",
        \"name\": \"UDP_1\",
        \"comment\": \"EXAMPLE_UDP\",
        \"port\": {
            \"from\": 3,
            \"to\": 3
        },
        \"protocol\": \"UDP\"
        }
        }
        }
    ]
    }
    }
    }
}
}
}
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket step does not exist, or is not the current step
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (Network Object with device ID <DEVICE_ID> and ST UID <ST_UID> is not available for the action specified. Check the Knowledge Center or API Implementation Notes for more information
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value"},"response":[]},{"name":"Returns the details of a the fields","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
taskId: The ID number of the task as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.
404: Task with ID was not found in Stage ID in ticket ID ."},"response":[]},{"name":"Returns the details of a specified field","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
taskId: The ID number of the task as shown in SecureChange
fieldId: The ID number of the field as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/229

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.
404: Task with ID was not found in Stage ID in ticket ID .
404: Field ID was not found in Task ID in Stage ID in ticket ID ."},"response":[]},{"name":"Change a field within a task of a ticket","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\t\"rule_modification_field\": {\n\t\t\"devices\": {\n\t\t\t\"device\": {\n\t\t\t\t\"management_id\": 5,\n\t\t\t\t\"bindings\": {\n\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t\"rule_modifications\": {\n\t\t\t\"rule_modification\": {\n\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t},\n\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"uid\": \"551556da-22dc-46f4-9253-a7ceee70394b\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldDTO
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/2/tasks/4/fields/7742
BODY<field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multiple_selection\">
     <id>7742</id>
     <name>filter type</name>
     <selected_options>
         <selected_option>
             <value>FTP</value>
         </selected_option>
     </selected_options>
</field>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/fields/71
BODY{
    \"rule_modification_field\": {
        \"devices\": {
            \"device\": {
                \"management_id\": 5,
                \"bindings\": {
                    \"binding\": {
                        \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                        \"binding\": {
                            \"@xsi.type\": \"policy__binding\",
                            \"policy_name\": \"FortiGate-VM64-111-10_3\"
                        },
                        \"rules\": {
                            \"rule\": {
                                \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                            }
                        }
                    }
                }
            }
        },
        \"rule_modifications\": {
            \"rule_modification\": {
                \"@xsi.type\": \"modify_rule_modification\",
                \"rule_key\": {
                    \"device_id\": 5,
                    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                    \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                },
                \"source_modifications\": {
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                            \"name\": \"NET_1\",
                                            \"comment\": \"\",
                                            \"ip\": \"3.3.3.3\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                            \"name\": \"RANGE_1\",
                                            \"comment\": \"EXAMPLE_RANGE\",
                                            \"min_ip\": \"3.3.3.3\",
                                            \"max_ip\": \"5.5.5.5\"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                \"destination_modifications\": {
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"name\": \"Host123\",
                                            \"comment\": \"cccHost\",
                                            \"ip\": \"1.2.3.4\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"action\": \"REMOVE\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                    }
                                }
                            }
                        ]
                    }
                },
                \"service_modifications\": {
                    \"service_object_cell_modifications\": {
                        \"service_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                        \"name\": \"TCP_1\",
                                        \"comment\": \"EXAMPLE_TCP\",
                                        \"port\": {
                                            \"from\": 1234,
                                            \"to\": 1234
                                        },
                                        \"protocol\": \"TCP\"
                                    }
                                }
                            },
                            {
                                \"action\": \"REMOVE\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"uid\": \"551556da-22dc-46f4-9253-a7ceee70394b\",
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                        \"name\": \"UDP_1\",
                                        \"comment\": \"EXAMPLE_UDP\",
                                        \"port\": {
                                            \"from\": 3,
                                            \"to\": 3
                                        },
                                        \"protocol\": \"UDP\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                        \"name\": \"ICMP_1\",
                                        \"comment\": \"EXAMPLE_ICMP\",
                                        \"type\": {
                                            \"from\": 55,
                                            \"to\": 55
                                        }
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                    }
                                }
                            }
                        ]
                    }
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket step does not exist, or is not the current step
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: Deleting rule recertification info is not allowed
400: Application Change field cannot be managed via this REST API
400: Rule associated with successfully updated recertification info cannot be removed
400: Rule was already updated
400: Rule does not exist
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value"},"response":[]},{"name":"Returns the results of the Commit action","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"},{"value":null,"type":"text","key":"managementId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/designer/commit_report/{{managementId}}","description":"GENERAL USE
The report returns the Commit results for the device with the specified management ID and for the devices suggested in the Designer results. The report also includes results for devices that are in the related hierarchy of these devices.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID
managementId: Management ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/designer/commit_report/3
OUTPUT{
    \"commit_report\": {
        \"ticketId\": 27,
        \"statTime\": \"24-Oct-2018 08:55 AM\",
        \"endTime\": \"24-Oct-2018 08:56 AM\",
        \"duration\": \"00:00:30\",
        \"vendorName\": \"PALO ALTO NETWORKS\",
        \"managmentName\": \"pano211\",
        \"devices\": {
            \"device\": [
                {
                    \"name\": \"DG1.1\",
                    \"status\": \"success_with_warnings\",
                    \"warnings\": {
                        \"warning\": \"Commit not performed: This device had no policies to install on its managed firewalls\"
                    },
                    \"policies\": \"\"
                },
                {
                    \"name\": \"DG1\",
                    \"status\": \"success_with_warnings\",
                    \"warnings\": {
                        \"warning\": \"Commit not performed: This device had no policies to install on its managed firewalls\"
                    },
                    \"policies\": \"\"
                }
            ]
        }
    }
}


Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: Specified field, id: <ID> , name: <NAME>, cannot contain designer result
404: Designer results were not found in the request."},"response":[]},{"name":"Change the ticket properties","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t\n\t\n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/ticket_properties","description":"Change the ticket properties listed in the TicketPropertiesDTO.
When specifying the notification_group property you must use the ID of the group or leave the ID empty to remove the group.

Parameters:
body: ticketPropertiesDTO
id: The ID number of the ticket as shown in SecureChange

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/ticket_properties
BODY<ticket_properties>
    <notification_group>
        <id>10</id>
    </notification_group>
</ticket_properties>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/ticket_properties
BODY<ticket_properties>
    <notification_group>
        <id/>
    </notification_group>
</ticket_properties>


Response Messages:
400: Notification Group <ID> is a user and not a user group
400: Notification Group <ID> exceeds the configured maximum allowed number of users for notifications
400: <ID> (“Any User”) is not allowed as a Notification Group
400: Notification Group <ID> does not have permission of 'Group members can perform actions on requests submitted by other members'
400: Notification Group <ID> is not a member in the first step of the workflow
400: Notification Group is not enabled in this workflow
401: You do not have permission to change the Notification Group
404: There is no group with ID <ID>.
404: There is no ticket with ID <ID>."},"response":[]},{"name":"Change multiple field within a task of a ticket in the current step","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\"fields\": {\n\"field\": {\n\"@xsi.type\": \"rule_modification_field\",\n\"id\": 746,\n\"name\": \"rm\",\n\"devices\": {\n\t\"device\": {\n\t\"revision_id\": 24,\n\t\"management_id\": 5,\n\t\"bindings\": {\n\t\"binding\": {\n\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\"binding\": {\n\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t},\n\t\"rules\": {\n\t\t\"rule\": {\n\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t}\n\t}\n\t}\n\t}\n\t}\n},\n\"rule_modifications\": {\n\t\"rule_modification\": {\n\t\"@xsi.type\": \"modify_rule_modification\",\n\t\"rule_key\": {\n\t\"device_id\": 5,\n\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t},\n\t\"source_modifications\": {\n\t\"network_object_cell_modifications\": {\n\t\"network_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\"name\": \"NET_1\",\n\t\t\t\"comment\": \"\",\n\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t}\n\t\t]\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t}\n\t\t]\n\t\t}\n\t\t}\n\t]\n\t}\n\t},\n\t\"destination_modifications\": {\n\t\"network_object_cell_modifications\": {\n\t\"network_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"REMOVE\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\"name\": \"Host123\",\n\t\t\t\"comment\": \"cccHost\",\n\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t}\n\t\t]\n\t\t}\n\t\t}\n\t]\n\t}\n\t},\n\t\"service_modifications\": {\n\t\"service_object_cell_modifications\": {\n\t\"service_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"REMOVE\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\"name\": \"ICMP_1\",\n\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\"type\": {\n\t\t\t\"from\": 55,\n\t\t\t\"to\": 55\n\t\t}\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\"name\": \"TCP_1\",\n\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\"port\": {\n\t\t\t\"from\": 1234,\n\t\t\t\"to\": 1234\n\t\t},\n\t\t\"protocol\": \"TCP\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\"name\": \"UDP_1\",\n\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\"port\": {\n\t\t\t\"from\": 3,\n\t\t\t\"to\": 3\n\t\t},\n\t\t\"protocol\": \"UDP\"\n\t\t}\n\t\t}\n\t\t}\n\t]\n\t}\n\t}\n\t}\n}\n}\n}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/fields","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldListDTO
id: Ticket ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields
BODY<fields>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_server_decommission_request\">
         <id>7591</id>
         <name>sd</name>
         <server_decommission_request>
             <id>7596</id>
             <order>DR1</order>
             <servers>
                 <server type=\"IP\">
                     <id>7593</id>
                     <ip_address>2.2.2.2</ip_address>
                     <netmask>255.255.255.255</netmask>
                 </server>
             </servers>
             <targets>
                 <target type=\"ANY\">
                     <id>7595</id>
                 </target>
             </targets>
             <comment>change ip from 1.1.1.1 to 2.2.2.2</comment>
         </server_decommission_request>
     </field>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"date\">
         <id>7786</id>
         <name>date</name>
         <value>2015-12-15</value>
     </field>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"time\">
         <id>7787</id>
         <name>time</name>
         <value>12:00</value>
     </field>
</fields>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields
BODY{
\"fields\": {
\"field\": {
\"@xsi.type\": \"rule_modification_field\",
\"id\": 746,
\"name\": \"rm\",
\"devices\": {
    \"device\": {
    \"revision_id\": 24,
    \"management_id\": 5,
    \"bindings\": {
    \"binding\": {
    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
    \"binding\": {
        \"@xsi.type\": \"policy__binding\",
        \"policy_name\": \"FortiGate-VM64-111-10_3\"
    },
    \"rules\": {
        \"rule\": {
        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
        \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
        }
    }
    }
    }
    }
},
\"rule_modifications\": {
    \"rule_modification\": {
    \"@xsi.type\": \"modify_rule_modification\",
    \"rule_key\": {
    \"device_id\": 5,
    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
    \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
    },
    \"source_modifications\": {
    \"network_object_cell_modifications\": {
    \"network_object_cell_modification\": [
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
            \"name\": \"NET_1\",
            \"comment\": \"\",
            \"ip\": \"3.3.3.3\",
            \"netmask\": \"255.255.255.255\"
        }
        ]
        }
        },
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
            \"name\": \"RANGE_1\",
            \"comment\": \"EXAMPLE_RANGE\",
            \"min_ip\": \"3.3.3.3\",
            \"max_ip\": \"5.5.5.5\"
        }
        ]
        }
        }
    ]
    }
    },
    \"destination_modifications\": {
    \"network_object_cell_modifications\": {
    \"network_object_cell_modification\": [
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
        }
        }
        },
        {
        \"action\": \"REMOVE\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
            \"name\": \"Host123\",
            \"comment\": \"cccHost\",
            \"ip\": \"1.2.3.4\",
            \"netmask\": \"255.255.255.255\"
        }
        ]
        }
        }
    ]
    }
    },
    \"service_modifications\": {
    \"service_object_cell_modifications\": {
    \"service_object_cell_modification\": [
        {
        \"action\": \"REMOVE\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:icmp_service\",
        \"name\": \"ICMP_1\",
        \"comment\": \"EXAMPLE_ICMP\",
        \"type\": {
            \"from\": 55,
            \"to\": 55
        }
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:transport_service\",
        \"name\": \"TCP_1\",
        \"comment\": \"EXAMPLE_TCP\",
        \"port\": {
            \"from\": 1234,
            \"to\": 1234
        },
        \"protocol\": \"TCP\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:transport_service\",
        \"name\": \"UDP_1\",
        \"comment\": \"EXAMPLE_UDP\",
        \"port\": {
            \"from\": 3,
            \"to\": 3
        },
        \"protocol\": \"UDP\"
        }
        }
        }
    ]
    }
    }
    }
}
}
}
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value"},"response":[]},{"name":"Returns the details of a specified ticket stages","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID."},"response":[]},{"name":"Submit a new ticket to Secure Change","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\t\"ticket\": {\n\t\t\"subject\": \"RM_EXAMPLE\",\n\t\t\"requester\": \"m\",\n\t\t\"requester_id\": 4,\n\t\t\"priority\": \"Normal\",\n\t\t\"domain_name\": \"\",\n\t\t\"workflow\": {\n\t\t\t\"name\": \"RM\",\n\t\t},\n\t\t\"steps\": {\n\t\t\t\"step\": [\n\t\t\t\t{\n\t\t\t\t\t\"tasks\": {\n\t\t\t\t\t\t\"task\": {\n\t\t\t\t\t\t\t\"fields\": {\n\t\t\t\t\t\t\t\t\"field\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\t\t\t\t\t\t\"devices\": {\n\t\t\t\t\t\t\t\t\t\t\"device\": {\n\t\t\t\t\t\t\t\t\t\t\t\"revision_id\": 24,\n\t\t\t\t\t\t\t\t\t\t\t\"management_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"rule_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\t\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 11,\n\t\t\t\t\t\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 9,\n\t\t\t\t\t\t\t\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/","description":" GENERAL USE
When posting a Modify Group ticket, group scope must be configured for FortiManager advanced and Juniper SRX devices.
Juniper SRX devices:
Global address-book will be used unless an existing address-book is given.
Ticket validation will fail in case given Address Book is not configured on the device.
FortiManager advanced devices:
'Any' zone will be used unless an existing zone is given.
Ticket validation will fail in case given zone is not configured on the device.
*Note: Zones and address-books must not be configured for other devices.

Using newly created objects from a different group in the same ticket
The user can add a newly created object from a different group to the selected group, with object_UID equal to the name of the newly created object.
For management devices with hierarchies, the newly created object does not populate other levels of the hierarchies.

Permitted values for @type
Allowed values for @type property included in DestinationDTO and SourceDTO are:
ANY
IP
DNS
Object - Device's existing object
INTERNET
LDAP (SourceDTO only) - LDAP entity

To use a service object in a new request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id
2. Both object_name and management_name

To use a network object in a new request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both object_UID and object_name are defined, object_UID takes precedence over object_name

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: ticketDTO
closed: Cannot be done from the API [optional]
count [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY<ticket>
    <subject>topology mode_AR1-with topology_AR2-no topology</subject>
    <requester>u1</requester>
    <priority>Normal</priority>
    <domain_name>Default</domain_name>
    <workflow>
         <id>7</id>
         <name>Workflow with topology</name>
    </workflow>
    <steps>
         <step>
             <name>Open request</name>
             <tasks>
                 <task>
                     <fields>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_access_request\">
                             <name>Required Access</name>
                             <access_request>
                                 <use_topology>true</use_topology>
                                 <targets>
                                     <target type=\"Object\">
                                         <object_name>ASA</object_name>
                                         <management_name>ASA</management_name>
                                     </target>
                                 </targets>
                                 <users>
                                     <user>Any</user>
                                 </users>
                                 <sources>
                                     <source type=\"Object\">
                                         <object_name>host_10.100.10.140</object_name>
                                         <management_name>NetScreen</management_name>
                                     </source>
                                 <sources>
                                     <source type=\"Object\">
                                         <object_UID>{55908141-c341-4990-9cc6-a3fd2dfb49e1}</object_UID>
                                         <management_id>13</management_id>
                                     </source>
                                 </sources>
                                 <destinations>
                                     <destination type=\"Object\">
                                         <object_name>h_10.10.10.10</object_name>
                                         <management_name>ASA</management_name>
                                     </destination>
                                 </destinations>
                                 <services>
                                     <service type=\"PROTOCOL\">
                                         <protocol>TCP</protocol>
                                         <port>80</port>
                                     </service>
                                     <service type=\"APPLICATION_IDENTITY\">
                                         <application_name>Gmail</application_name>
                                     </service>
                                 </services>
                                 <action>Accept</action>
                                 <labels/>
                             </access_request>
                             <access_request>
                                 <use_topology>false</use_topology>
                                 <targets>
                                     <target type=\"Object\">
                                         <object_name>inside_access_in</object_name>
                                         <management_name>ASA</management_name>
                                     </target>
                                 </targets>
                                 <users>
                                     <user>Any</user>
                                 </users>
                                 <sources>
                                     <source type=\"Object\">
                                         <object_name>1.1.1.0</object_name>
                                         <management_name>NetScreen</management_name>
                                     </source>
                                 </sources>
                                 <destinations>
                                     <destination type=\"Object\">
                                         <object_name>network_regi3</object_name>
                                         <management_name>ASA</management_name>
                                     </destination>
                                 </destinations>
                                 <services>
                                     <service type=\"ANY\">
                                     </service>
                                 </services>
                                 <action>Accept</action>
                                 <labels/>
                             </access_request>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_area\">
                             <name>Business Justification</name>
                             <text>I need access to ftp </text>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_field\">
                             <name>Project Number</name>
                             <text>CR124560 </text>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"hyperlink\">
                             <name>Hyperlink</name>
                             <url>http://192.168.1.1/ticket</url>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"drop_down_list\">
                             <name>Change Window</name>
                             <selection>Monday</selection>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"manager\">
                             <name>manager email</name>
                             <text>manager@tufin.com</text>
                         </field>
                     </fields>
                 </task>
             </tasks>
        </step>
    </steps>
    <comments/>
</ticket>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY<ticket>
    <subject>New MG ticket</subject>
    <requester>a</requester>
    <requester_id>4</requester_id>
    <priority>Normal</priority>
    <status>In Progress</status>
    <domain_name/>
    <sla_status>NA</sla_status>
    <sla_outcome>NA</sla_outcome>
    <workflow>
        <id>6</id>
        <name>MG</name>
        <uses_topology>false</uses_topology>
    </workflow>
    <steps>
        <step>
            <id>72</id>
            <name>New step</name>
            <redone>false</redone>
            <skipped>false</skipped>
            <tasks>
                <task>
                    <id>72</id>
                    <assignee_id>4</assignee_id>
                    <assignee>a</assignee>
                    <status>ASSIGNED</status>
                    <fields>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_group_change\">
                            <id>262</id>
                            <name>MG</name>
                            <read_only>false</read_only>
                            <implementation_status>NOT_SUPPORTED</implementation_status>
                            <group_change>
                                <name>ExistingGroup</name>
                                <object_UID>{c862fb6f-1314-45da-9e01-56c9b85d001d}</object_UID>
                                <management_id>58</management_id>
                                <management_name>FMG/root</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>157</id>
                                        <name>10.100 net</name>
                                        <object_UID>{37cdc055-7aac-4385-b46b-cc54d95e4b6d}</object_UID>
                                        <object_type>Network</object_type>
                                        <object_details>10.100.0.0/255.255.0.0</object_details>
                                        <management_id>58</management_id>
                                        <management_name>FMG/root</management_name>
                                        <status>NOT_CHANGED</status>
                                        <object_updated_status>EXISTING_EDITED</object_updated_status>
                                        <comment>new_comment</comment>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                                <zone>
                                    <is_global>true</is_global>
                                    <name>any</name>
                                </zone>
                            </group_change>
                            <group_change>
                                <name>78.45.12.0</name>
                                <object_UID>{cac64d34-a05e-4a05-b271-64642eb976ff}</object_UID>
                                <management_id>28</management_id>
                                <management_name>SRX-root-lsys</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>158</id>
                                        <name>78.45.12.1</name>
                                        <object_UID>{7912c335-6dbe-47de-b872-1322f9015b2f}</object_UID>
                                        <object_type>Host</object_type>
                                        <object_details>78.45.12.1/255.255.255.255</object_details>
                                        <management_id>28</management_id>
                                        <management_name>SRX-root-lsys</management_name>
                                        <status>NOT_CHANGED</status>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                                <address_book>
                                    <name>global</name>
                                </address_book>
                            </group_change>
                            <group_change>
                                <name>10.10.0.0/16</name>
                                <object_UID>{5dff0bd8-51e4-4a83-8138-d54dd18ca52b}</object_UID>
                                <management_id>24</management_id>
                                <management_name>NSX-Distributed Firewall</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>161</id>
                                        <name>10.10.0.0/16</name>
                                        <object_UID>{5d7b826c-f053-40fd-81bd-7a6f44cf15ef}</object_UID>
                                        <object_type>Network</object_type>
                                        <object_details>10.10.0.0/255.255.0.0</object_details>
                                        <management_id>24</management_id>
                                        <management_name>NSX-Distributed Firewall</management_name>
                                        <status>NOT_CHANGED</status>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                            </group_change>
                        </field>
                    </fields>
                </task>
            </tasks>
        </step>
    </steps>
</ticket>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY<ticket>
    <subject>test API</subject>
    <requester>a</requester>
    <requester_id>4</requester_id>
    <priority>Normal</priority>
    <domain_name/>
    <sla_status>NA</sla_status>
    <sla_outcome>NA</sla_outcome>
    <workflow>
        <id>8</id>
        <name>Modify group</name>
        <uses_topology>false</uses_topology>
    </workflow>
    <steps>
        <step>
            <id>11</id>
            <name>Open request</name>
            <redone>false</redone>
            <skipped>false</skipped>
            <tasks>
                <task>
                    <id>11</id>
                    <assignee_id>4</assignee_id>
                    <assignee>a</assignee>                    <status>DONE</status>
                    <fields>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_group_change\">
                            <id>137</id>
                            <name>ff</name>
                            <read_only>false</read_only>
                            <implementation_status>NOT_SUPPORTED</implementation_status>
                            <group_change>
                                <name>port1Group</name>
                                <object_UID>{d5b4459b-6b27-4012-9924-b244c250520f}</object_UID>
                                <management_id>64</management_id>
                                <management_name>10.100.111.8/ADOM_5_2</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"HOST\">
                                        <id>69</id>
                                        <name>obj_1</name>
                                        <object_UID>obj_1</object_UID>
                                        <object_type>Host</object_type>
                                        <object_details>6.6.6.6/255.255.255.255</object_details>
                                        <management_id>64</management_id>
                                        <status>ADDED</status>
                                        <comment/>
                                        <object_updated_status>NEW</object_updated_status>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                            </group_change>
                            <group_change>
                                <name>gfd</name>
                                <management_id>64</management_id>
                                <management_name>10.100.111.8/ADOM_5_2</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>70</id>
                                        <name>obj_1</name>
                                        <object_UID>obj_1</object_UID>
                                        <object_type>Host</object_type>
                                        <object_details>6.6.6.6/255.255.255.255</object_details>
                                        <management_id>64</management_id>
                                        <management_name>10.100.111.8/ADOM_5_2</management_name>
                                        <status>ADDED</status>
                                        <object_updated_status>EXISTING_NOT_EDITED</object_updated_status>
                                    </member>
                                </members>
                                <change_action>CREATE</change_action>
                                <zone>
                                    <is_global>true</is_global>
                                    <name>any</name>
                                </zone>
                            </group_change>
                        </field>
                    </fields>
                </task>
            </tasks>
        </step>
    </steps>
    <current_step>
        <id>12</id>
        <name>Copy of Open request</name>
    </current_step>
    <comments/>
</ticket>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY{
    \"ticket\": {
        \"application_details\": { \"id\": \"1\" },
        \"subject\": \"topology mode_AR1-with topology_AR2-no topology\",
        \"priority\": \"Normal\",
        \"workflow\": { \"name\": \"ar\" }
    }
}


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY{
    \"ticket\": {
        \"subject\": \"RM_EXAMPLE\",
        \"requester\": \"m\",
        \"requester_id\": 4,
        \"priority\": \"Normal\",
        \"domain_name\": \"\",
        \"workflow\": {
            \"name\": \"RM\",
        },
        \"steps\": {
            \"step\": [
                {
                    \"tasks\": {
                        \"task\": {
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"rule_modification_field\",
                                    \"devices\": {
                                        \"device\": {
                                            \"revision_id\": 24,
                                            \"management_id\": 5,
                                            \"bindings\": {
                                                \"binding\": {
                                                    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                                                    \"binding\": {
                                                        \"@xsi.type\": \"policy__binding\",
                                                        \"policy_name\": \"FortiGate-VM64-111-10_3\"
                                                    },
                                                    \"rules\": {
                                                        \"rule\": {
                                                            \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                                            \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    \"rule_modifications\": {
                                        \"rule_modification\": {
                                            \"@xsi.type\": \"modify_rule_modification\",
                                            \"rule_key\": {
                                                \"device_id\": 5,
                                                \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                                                \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                                            },
                                            \"source_modifications\": {
                                                \"network_object_cell_modifications\": {
                                                    \"network_object_cell_modification\": [
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"network_object\": [
                                                                    {
                                                                        \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                                        \"name\": \"RANGE_1\",
                                                                        \"comment\": \"EXAMPLE_RANGE\",
                                                                        \"min_ip\": \"3.3.3.3\",
                                                                        \"max_ip\": \"5.5.5.5\"
                                                                    }
                                                                ]
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"network_object\": [
                                                                    {
                                                                        \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                                        \"name\": \"NET_1\",
                                                                        \"comment\": \"\",
                                                                        \"ip\": \"3.3.3.3\",
                                                                        \"netmask\": \"255.255.255.255\"
                                                                    }
                                                                ]
                                                            }
                                                        }
                                                    ]
                                                }
                                            },
                                            \"destination_modifications\": {
                                                \"id\": 11,
                                                \"network_object_cell_modifications\": {
                                                    \"network_object_cell_modification\": [
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"existing\",
                                                                    \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"REMOVE\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"existing\",
                                                                    \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"network_object\": [
                                                                    {
                                                                        \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                                        \"name\": \"Host123\",
                                                                        \"comment\": \"cccHost\",
                                                                        \"ip\": \"1.2.3.4\",
                                                                        \"netmask\": \"255.255.255.255\"
                                                                    }
                                                                ]
                                                            }
                                                        }
                                                    ]
                                                }
                                            },
                                            \"service_modifications\": {
                                                \"id\": 9,
                                                \"service_object_cell_modifications\": {
                                                    \"service_object_cell_modification\": [
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"service_object\": {
                                                                    \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                                                    \"name\": \"ICMP_1\",
                                                                    \"comment\": \"EXAMPLE_ICMP\",
                                                                    \"type\": {
                                                                        \"from\": 55,
                                                                        \"to\": 55
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"service_object\": {
                                                                    \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                                    \"name\": \"UDP_1\",
                                                                    \"comment\": \"EXAMPLE_UDP\",
                                                                    \"port\": {
                                                                        \"from\": 3,
                                                                        \"to\": 3
                                                                    },
                                                                    \"protocol\": \"UDP\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"service_object\": {
                                                                    \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                                    \"name\": \"TCP_1\",
                                                                    \"comment\": \"EXAMPLE_TCP\",
                                                                    \"port\": {
                                                                        \"from\": 1234,
                                                                        \"to\": 1234
                                                                    },
                                                                    \"protocol\": \"TCP\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"existing\",
                                                                    \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"REMOVE\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"existing\",
                                                                    \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                                                }
                                                            }
                                                        }
                                                    ]
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            ]
        },
    }
}


Response Messages:
400: Application ID is missing.
400: Create closed ticket is enabled only from SecureApp application.
400: The application was already deleted.
400: The requester must be the currently logged in user.
400: Workflow was not found.
400: Workflow is not active.
400: Workflow configuration is not valid.
400: Workflow is not set
400: You cannot enter a status for a new ticket.
400: Requester cannot open a ticket in domain.
400: Invalid ticket priority.
400: You cannot open a new ticket with an empty subject.
400: Expiration field is required.
400: Submit ticket enabled only with the first step
400: First step can be only with one task
400: The specified workflow does not contain an access request field in the first step.
400: There are no changed connections that are ready for creating a ticket.
400: You cannot use an access request field to create a ticket from SecureApp.
400: The ticket fields do not match the fields in the current step of the workflow.
400: You cannot change the value of a field because it is read-only.
400: Managed tasks are not initialized or done
400: Application Change field cannot be managed via this REST API
400: Invalid value for field: <FIELD_NAME> (Rule Modification workflow is not supported for this device)
401: You do not have permissions to edit this application.
401: Logged in user: NAME do not have permission to perform on behalf actions
401: You are not a participant in the first step of this workflow
401: UNAUTHORIZED
404: There is no application with the specified ID
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (Network object cell modification missing action)
400: Invalid value for field: <FIELD_NAME> (Network object cell modification element cannot be empty)
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value"},"response":[]},{"name":"Returns the details of a specified tickets (max 100 tickets in a single query)","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
status: The status of the tickets [optional]
count: Tickets list max pagination length (max value is 100) [optional]
start: Offset the count starting point [optional]
desc: Get the list in descending order [optional]
expand_links: See expanded view of the objects [optional]
showStepsDetails: Include steps' details in the response [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets?status=In Progress&count=10&start=3&expand_links=false

Response Messages:
400: Status is not a valid. The valid values are: TICKET_STATUSES
400: Can not fetch more than 100 tickets in 1 time
401: Access is denied"},"response":[]},{"name":"Returns a list of tickets by search parameters","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/free_text_search","description":"Parameters:
parameter: Free text search parameter (Search syntax details) [optional]
start: Offset the count starting point [optional]
count: Tickets list max length (max value is 1000) [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/free_text_search/?parameter=taskstatus:ASSIGNED AND priority:High

Response Messages:
400: Can not fetch more than 1000 tickets in 1 time
401: Access is denied.
404: Illegal ticket status entered. Permitted values are: IN_PROGRESS, REJECTED, CLOSED, CANCELLED, RESOLVED
404: Illegal ticket SLA status entered. Permitted values are: NA, OK, WARNING, ALERT, ESCALATION
404: Illegal ticket priority entered. Permitted values are: LOW, NORMAL, HIGH, CRITICAL
400: Illegal count value entered. Max value is 1000
404: Illegal ticket expiration date entered. Permitted date format is: ddMMyyyy (ex. 20.11.2001)
404: No entity found for query"},"response":[]},{"name":"Returns the details of the tasks","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID."},"response":[]},{"name":"Returns topology map image (png file) for specific verifier results","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_access_request/{{fieldId}}/verifier/topology_map","description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/multi_access_request/2022/verifier/topology_map

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.
404: Verifier results were not found in the access request.
404: Toplogy map was not found for this field."},"response":[]},{"name":"Change a task of a ticket","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\t\"task\": {\n\t\t\"status\": \"ASSIGNED\",\n\t\t\"fields\": {\n\t\t\t\"field\": {\n\t\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\t\"id\": 743,\n\t\t\t\t\"devices\": {\n\t\t\t\t\t\"device\": {\n\t\t\t\t\t\t\"revision_id\": 24,\n\t\t\t\t\t\t\"management_id\": 5,\n\t\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"rule_modifications\": {\n\t\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: ticketTaskDTO
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/2/tasks/4
BODY<task>
     <status>ASSIGNED</status>
     <fields>
         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_group_change\">
             <id>7599</id>
             <name>mf</name>
             <read_only>false</read_only>
             <implementation_status>NOT_STARTED</implementation_status>
             <group_change>
                        <name>ggg</name>
                        <st_uid>{A12AE330-0DBD-11E5-B841-7F0000010E0E}</st_uid>
                        <management_id>42</management_id>
                        <management_name>cp239</management_name>
                        <members>
                             <member type=\"Object\">
                                 <id>8</id>
                                 <name>yaakovs_host</name>
                                 <st_uid>{BDAA378C-C90B-4D12-B598-1AFED2D1DA14}</st_uid>
                                 <object_type>Host</object_type>
                                 <object_details>1.1.1.1/255.255.255.255</object_details>
                         <management_id>42</management_id>
                         <management_name>cp239</management_name>
                                 <status>NOT_CHANGED</status>
                             </member>
                             <member type=\"Object\">
                                 <id>9</id>
                                    <name>Avi_10.100.120.254</name>
                                    <st_uid>{8F195CDC-F426-47B6-9E8A-1FF14C17E54F}</st_uid>
                                     <object_type>Host</object_type>
                                     <object_details>10.100.120.254/255.255.255.255</object_details>
                                     <management_id>42</management_id>
                                     <management_name>cp239</management_name>
                                     <status>NOT_CHANGED</status>
                                 </member>
                                 <member type=\"HOST\">
                                     <id>10</id>
                                     <name>h22</name>
                                     <object_type>Host</object_type>
                                     <object_details>2.2.2.2/255.255.255.255</object_details>
                                     <status>ADDED</status>
                                     <comment/>
                                 </member>
                                 <member type=\"HOST\">
                                     <id>10</id>
                                     <name>h22</name>
                                     <object_type>Host</object_type>
                                     <object_details>3.3.3.3/255.255.255.255</object_details>
                                     <status>ADDED</status>
                                     <comment/>
                                 </member>
                 </members>
                 <change_implementation_status>NOT_RUN</change_implementation_status>
                    </group_change>
            </field>
     </fields>
</task>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4
BODY{
    \"task\": {
        \"status\": \"ASSIGNED\",
        \"fields\": {
            \"field\": {
                \"@xsi.type\": \"rule_modification_field\",
                \"id\": 743,
                \"devices\": {
                    \"device\": {
                        \"revision_id\": 24,
                        \"management_id\": 5,
                        \"bindings\": {
                            \"binding\": {
                                \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                                \"binding\": {
                                    \"@xsi.type\": \"policy__binding\",
                                    \"policy_name\": \"FortiGate-VM64-111-10_3\"
                                },
                                \"rules\": {
                                    \"rule\": {
                                        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                        \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                                    }
                                }
                            }
                        }
                    }
                },
                \"rule_modifications\": {
                    \"rule_modification\": {
                        \"@xsi.type\": \"modify_rule_modification\",
                        \"rule_key\": {
                            \"device_id\": 5,
                            \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                            \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                        },
                        \"source_modifications\": {
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                    \"name\": \"RANGE_1\",
                                                    \"comment\": \"EXAMPLE_RANGE\",
                                                    \"min_ip\": \"3.3.3.3\",
                                                    \"max_ip\": \"5.5.5.5\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                    \"name\": \"NET_1\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"3.3.3.3\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        },
                        \"destination_modifications\": {
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                    \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"name\": \"Host123\",
                                                    \"comment\": \"cccHost\",
                                                    \"ip\": \"1.2.3.4\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"REMOVE\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                            }
                                        }
                                    }
                                ]
                            }
                        },
                        \"service_modifications\": {
                            \"service_object_cell_modifications\": {
                                \"service_object_cell_modification\": [
                                    {
                                        \"action\": \"REMOVE\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                                \"name\": \"ICMP_1\",
                                                \"comment\": \"EXAMPLE_ICMP\",
                                                \"type\": {
                                                    \"from\": 55,
                                                    \"to\": 55
                                                }
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                \"name\": \"TCP_1\",
                                                \"comment\": \"EXAMPLE_TCP\",
                                                \"port\": {
                                                    \"from\": 1234,
                                                    \"to\": 1234
                                                },
                                                \"protocol\": \"TCP\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                \"name\": \"UDP_1\",
                                                \"comment\": \"EXAMPLE_UDP\",
                                                \"port\": {
                                                    \"from\": 3,
                                                    \"to\": 3
                                                },
                                                \"protocol\": \"UDP\"
                                            }
                                        }
                                    }
                                ]
                            }
                        }
                    }
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket step does not exist, or is not the current step
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Task status does not exist.
400: Task status is not set to ASSIGNED or DONE.
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
403: Task can not be done because there are unlicensed devices for change automation
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value"},"response":[]},{"name":"Returns the details of a specified task","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
taskId: The ID number of the task as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2?expand_links=true

Response Messages:
401: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.
404: Task with ID was not found in Stage ID in ticket ID ."},"response":[]},{"name":"Modify the Designer suggestions for Access Request or Clone Server Policy","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"rule_placement\": {\"new_value\":\"before\"}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/tasks/{{taskId}}/designer/instruction/{{instructionId}}","description":" GENERAL USE
1. Create a ticket using UI/API.
2. Run the designer using UI/API.
3. Use relevent API to get the designer results.
4. Run this API to modify the required parameters.

*Note: you can modify one parameter at a time.

Change rule location use
a. Modifying the rule order places the new rule before the rule with the specified identifier (rule name or number).
b. Modifying the rule placement to \"last\" places the new rule as last rule or last pre-rule (depending on the vendor convention for the device).
c. For vendors that support \"after\" placement, modifying the rule placement allows positioning the new rule before or after the suggested rule location.

track level permitted values:
NONE, LOG, ACCOUNT, ALERT, SNMP, MAIL, USER_DEFINED, EMERGENCIES, ALERTS, CRITICAL, ERRORS, WARNINGS, NOTIFICATIONS, INFORMATIONAL, DEBUGGING, DISABLED, DEFAULT, FULL_LOG, NETWORK_LOG, USER_ALERT_1, USER_ALERT_2, USER_ALERT_3

rule placement permitted values:
BEFORE, AFTER, LAST

Parameters:
body: DesignerInstructionChangeDTO
id: Ticket ID
taskId: Task ID
instructionId: Instruction ID
force: force update when new revision available [optional]

Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"comment\": {\"new_value\":\"new comment\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196?force=true
BODY{
    \"comment\": {\"new_value\":\"new comment\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_name\": {\"new_value\":\"new rule name\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"track_level\": {\"new_value\":\"LOG\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"object_name\": {\"new_value\":\"new object name\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"log_forwarding_profile\": {\"new_value\":\"new log forwarding profile\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"security_profile_group\": {\"new_value\":\"new security profile group\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"object_replace\": {
             \"new_value\":\"new object uid\",
             \"old_value\":\"old object uid\"
    }
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_order\": {\"new_value\":\"8\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_placement\": {\"new_value\":\"last\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_placement\": {\"new_value\":\"before\"}
}


Response Messages:
200: New rule will be shadowed
200: New rule will be shadowed or break acceleration
400: Modify Designer Results API is only supported for Access Request and Clone Server Policy workflows
412: Current instruction cannot be modified because either the implementation was successful or failed irrevocably.
412: Current step does not support Designer modification action
400: A ticket with ID <ID> cannot be found.
400: Task ID <ID> cannot be found in the current step with ID <ID>.
403: Changing <TYPE> is not supported on this device
403: This Change is not supported for <INSTRUCTION TYPE> instruction type\"
401: You do not have permission to update this task. Contact your administrator for assistance.
403: New revision is available, cannot modify the Designer results
404: Specified instruction, id: <ID> was not found
404: Designer results were not found in the access request.
400: a valid object name must start with an alphanumeric character and can contain alphanumeric characters, underscore '_'. Hypen '-', dot '.' or spaces
400: For this device, the comment must be less than 100 characters per line.
400: For this device, this field must be less than <NUMBER OF CHARACTERS> characters
400: For this device, this field is required.
400: For this device, a valid object name cannot be <OBJECT NAME> because it is a reserved word
409: Rule name already exists for this device. Please give this rule a unique name.
409: Rule name <NAME> already exists in the device group hierarchy. Choose a unique name for this rule.
400: Comment contains invalid characters.
400: <DEVICE> does not support tracking level <TRACKING LEVEL>
400: <TRACKING LEVEL> is not a valid rule track level value
400: a valid object name cannot contain any of the following characters: <CHARACTERS>
400: a valid object name must be less than <NUMBER OF CHARACTERS> characters
400: a valid object name cannot be empty
400: a valid object name must conform to the following pattern: <STRING PATTERN>
409: Object already exists
400: A security profile group cannot be empty.
404: The security profile group <SECURITY PROFILE GROUP> was not found.
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to validate the security profile group.
400: A log forwarding profile cannot be empty.
404: The log forwarding profile <LOG FORWARDING PROFILE> was not found.
500: An error occurred in SecureTrack while trying to validate the log forwarding profile.
400: Object UID <OLD OBJECT UID> not found in the rule for this instruction.
400: Values of new object UID <NEW OBJECT UID> and old object UID <OLD OBJECT UID> do not match.
400: Rule placement can only be: \"before\", \"after\" or \"last\".
400: You can't change rule placement when there is no rule order. please add rule order first.
400: You can't change rule placement to \"After\" for this type of device.
400: You can't change rule placement to \"Last\" for this type of device."},"response":[]},{"name":"Get rule decommision verifier results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/rule_decommission/verifier","description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/rule_decommission/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type <TYPE>.
404: Verifier results were not found in the request."},"response":[]},{"name":"Change a field within a task of a ticket at the current step","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\t\"rule_modification_field\": {\n\t\t\"devices\": {\n\t\t\t\"device\": {\n\t\t\t\t\"management_id\": 5,\n\t\t\t\t\"bindings\": {\n\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t\"rule_modifications\": {\n\t\t\t\"rule_modification\": {\n\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t},\n\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"uid\": \"551556da-22dc-46f4-9253-a7ceee70394b\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/fields/{{fieldId}}","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldDTO
id: Ticket ID
taskId: Task ID
fieldId: Field ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields/7642
BODY<field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"approve_reject\">
         <id>7661</id>
         <name>approve access</name>
         <approved>true</approved>
         <reason>Request approved</reason>
    </field>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields/71
BODY{
    \"rule_modification_field\": {
        \"devices\": {
            \"device\": {
                \"management_id\": 5,
                \"bindings\": {
                    \"binding\": {
                        \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                        \"binding\": {
                            \"@xsi.type\": \"policy__binding\",
                            \"policy_name\": \"FortiGate-VM64-111-10_3\"
                        },
                        \"rules\": {
                            \"rule\": {
                                \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                            }
                        }
                    }
                }
            }
        },
        \"rule_modifications\": {
            \"rule_modification\": {
                \"@xsi.type\": \"modify_rule_modification\",
                \"rule_key\": {
                    \"device_id\": 5,
                    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                    \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                },
                \"source_modifications\": {
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                            \"name\": \"NET_1\",
                                            \"comment\": \"\",
                                            \"ip\": \"3.3.3.3\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                            \"name\": \"RANGE_1\",
                                            \"comment\": \"EXAMPLE_RANGE\",
                                            \"min_ip\": \"3.3.3.3\",
                                            \"max_ip\": \"5.5.5.5\"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                \"destination_modifications\": {
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"name\": \"Host123\",
                                            \"comment\": \"cccHost\",
                                            \"ip\": \"1.2.3.4\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"action\": \"REMOVE\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                    }
                                }
                            }
                        ]
                    }
                },
                \"service_modifications\": {
                    \"service_object_cell_modifications\": {
                        \"service_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                        \"name\": \"TCP_1\",
                                        \"comment\": \"EXAMPLE_TCP\",
                                        \"port\": {
                                            \"from\": 1234,
                                            \"to\": 1234
                                        },
                                        \"protocol\": \"TCP\"
                                    }
                                }
                            },
                            {
                                \"action\": \"REMOVE\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"uid\": \"551556da-22dc-46f4-9253-a7ceee70394b\",
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                        \"name\": \"UDP_1\",
                                        \"comment\": \"EXAMPLE_UDP\",
                                        \"port\": {
                                            \"from\": 3,
                                            \"to\": 3
                                        },
                                        \"protocol\": \"UDP\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                        \"name\": \"ICMP_1\",
                                        \"comment\": \"EXAMPLE_ICMP\",
                                        \"type\": {
                                            \"from\": 55,
                                            \"to\": 55
                                        }
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                    }
                                }
                            }
                        ]
                    }
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
401: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value"},"response":[]}]}]} \ No newline at end of file diff --git a/Postman Format v2/R20-1 postman collection/securetrack_R20-1-GA-v2.json b/Postman Format v2/R20-1 postman collection/securetrack_R20-1-GA-v2.json new file mode 100644 index 0000000..fc43357 --- /dev/null +++ b/Postman Format v2/R20-1 postman collection/securetrack_R20-1-GA-v2.json @@ -0,0 +1 @@ +{"info":{"_postman_id":"1","name":"Tufin Tufin SecureTrack R20-1-GA","description":"Tufin Orchestration Suite - Tufin SecureTrack APIs.
For detailed information about the APIs please see the documentation at:
https://your-securetrack-server/securetrack/apidoc","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json"},"item":[{"name":"Additional Policy Fields","item":[{"name":"Get additional parameters identities by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/additional_parameters","description":"Some firewall vendors use special fields in their security policy.
For example: Palo Alto uses Tags, Security Profiles and Log Profiles and Fortinet uses NAT Pools and other NAT configurations.
SecureTrack refers to these fields as “Additional Parameters”.
The additional parameters API retrieves the possible values of these fields.
This API is currently supported for Palo Alto Networks firewalls and Fortinet devices managed by Fortimanager.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
type: Additional parameter type [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/162/additional_parameters?type=security_profile_group

Response Messages:
200: Successful
400: Invalid request"},"response":[]},{"name":"Get all URL Categories by revision.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/url_categories","description":"Fetches list of URL Categories defined in a revision given by ID.
This API is supported for Panorama in advanced mode and Panorama Device Groups.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/762/url_categories
"},"response":[]},{"name":"Get specific additional parameter identity","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/additional_parameters/{{ids}}","description":"Some firewall vendors use special fields in their security policy.
For example: Palo Alto uses Tags, Security Profiles and Log Profiles and Fortinet uses NAT Pools and other NAT configurations.
SecureTrack refers to these fields as “Additional Parameters”.
The additional parameters API retrieves the possible values of these fields.
This API is currently supported for Palo Alto Networks firewalls and Fortinet devices managed by Fortimanager.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Additional parameter IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/revisions/162/additional_parameters/242767,242768,242760
"},"response":[]},{"name":"Get a URL Category.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/url_categories/{{ids}}","description":"Fetches one or more URL Categories.
This API is supported for Panorama in advanced mode and Panorama Device Groups.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Url Category IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/revisions/762/url_categories/242767,242768,242760
"},"response":[]}]},{"name":"Application IDs","item":[{"name":"Get applications identities by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/applications","description":"Fetches list of applications defined in a revision given by ID.
This API is currently supported for Palo Alto Networks firewalls.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.
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.


Parameters:
context: Global MSSP context [optional]
id: Revision id
start: Starting page for query allowable value is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/762/applications?get_total=true
OUTPUT {
    \"applications\": {
        \"count\": 1,
        \"total\": 100,
        \"application\": [{
            \"@xsi.type\": \"singleApplicationDTO\",
            \"id\": 2095027,
            \"name\": \"any\",
            \"display_name\": \"any\",
            \"class_name\": \"application_object\",
            \"comment\": \"\",
            \"uid\": \"{61B7771C-8B0B-90D6-ED55-B6698691BEED}\",
            \"overrides\": false,
            \"service\": {
                \"id\": 5048925,
                \"uid\": \"{4BC8F8B5-7671-A61B-5DD2-8CA235955162}\",
                \"display_name\": \"any\",
                \"name\": \"any\"
            }
        }]
    }
}

"},"response":[]},{"name":"Get specific application identity","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/applications/{{ids}}","description":"Fetches one or more applications defined by a revision ID and Application Id or comma separated applications ids list.
This API is currently supported for Palo Alto Networks firewalls.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.


Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Application IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/revisions/762/applications/242767,242768,242760
"},"response":[]},{"name":"Get application identities by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/applications","description":"Fetches list of applications defined on device given by ID.
This API is currently supported for Palo Alto Networks firewalls.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.
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.


Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable values are numeric [optional]
count: Number of pages for query allowable values are numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/applications?get_total=true
OUTPUT {
    \"applications\": {
        \"count\": 50,
        \"total\": 100,
        \"application\": [{
            \"@xsi.type\": \"singleApplicationDTO\",
            \"id\": 2095027,
            \"name\": \"any\",
            \"display_name\": \"any\",
            \"class_name\": \"application_object\",
            \"comment\": \"\",
            \"uid\": \"{61B7771C-8B0B-90D6-ED55-B6698691BEED}\",
            \"overrides\": false,
            \"service\": {
                \"id\": 5048925,
                \"uid\": \"{4BC8F8B5-7671-A61B-5DD2-8CA235955162}\",
                \"display_name\": \"any\",
                \"name\": \"any\"
            }
        }]
    }
}

"},"response":[]},{"name":"Get specific application identity","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/applications/{{ids}}","description":"Fetches one or more applications defined by a device ID and Application Id or comma separated applications ids list.
This API is currently supported for Palo Alto Networks firewalls.
Note: This API retrieves the information from the latest revision.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.


Parameters:
context: Global MSSP context [optional]
id: Device ID
ids: Application IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/devices/1/applications/701
"},"response":[]}]},{"name":"Change Authorization","item":[{"name":"Compare revisions on two different devices in terms of traffic.","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"policy_traffic_comparison_request\": {\n\t\t\"oldVersionId\": \"234\",\n\t\t\"newVersionId\": \"179\",\n\t\t\"oldId2newIdMap\": [\n\t\t\t{\n\t\t\t\t\"oldId\": \"{037DEA62-A8D2-46F5-8DC9-DA404A60B96F}\",\n\t\t\t\t\"newId\" : \"{00-FACED0-00}\"\n\t\t\t}\n\t\t],\n\t\t\"withTraffic\": true\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/change_authorization/policyTrafficComparison","description":"This API compares two arbitrary revisions from any devices. The comparison will be done in terms of allowed/denied traffic.
The API returns authorized if and only if there are no differences between the traffic allowed/denied by the rules in the two revisions.
The API returns unauthorized if there is at least one difference in terms of allowed/denied traffic between the two revisions.
Note 1: To map policies from one revision to the other use oldId2newIdMap and provide the UIDs of the policies to be compared.
Note 2: Parameter in the request body specifies if the result will return traffic difference details for all incompatible rules
Note 3: The format of the result is the same as the one returned by /change_authorization
Note 4: The API accepts in request body only one pair of oldId - newId map
Note 5: The request is valid only if the mapping ids are found in the active policies

Parameters:
body: Request parameter containing the versions of the revisions to be compared and the policy mapping between the revisions.

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_authorization/policyTrafficComparison
BODY{
    \"policy_traffic_comparison_request\": {
        \"oldVersionId\": \"234\",
        \"newVersionId\": \"179\",
        \"oldId2newIdMap\": [
            {
                \"oldId\": \"{037DEA62-A8D2-46F5-8DC9-DA404A60B96F}\",
                \"newId\" : \"{00-FACED0-00}\"
            }
        ],
        \"withTraffic\": true
    }
}


Response Messages:
200: Policies diff was successfully calculated
400: Could not find the requested revisions for comparison"},"response":[]},{"name":"Determine if changes between two revisions are authorized","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"new_version"},{"value":null,"type":"text","key":"old_version"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/change_authorization/","description":"This API checks for unauthorized changes between any two versions of a firewall policy.
The API returns authorized if and only if all traffic changes between the two versions were authorized by SecureChange tickets.
The API returns unauthorized if there is at least one change that cannot be matched to a SecureChange ticket.

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).
The API returns the authorization status, the relevant tickets in SecureChange and the rules that implement unauthorized access changes.

Note 1: To use this API you must enable “Authorize Revisions with Tickets” in SecureTrack/Configuration/Ticketing.
Note 2: Use the ID returned by the /revisions API for new_version and old_version.
Note 3: The default value for traffic_details and ignore_tickets is false.
Note 4: Traffic that is handled by an implicit rule will not have a rule ID.

Parameters:
new_version: New version ID
old_version: Old version ID
traffic_details: Return unauthorized traffic change details for all modified rules [optional]
ignore_tickets: Ignore SecureChange tickets and consider all traffic changes unauthorized [optional]

Usage Example
https://192.168.1.1/securetrack/api/change_authorization?old_version=1&new_version=2

Usage Example
https://192.168.1.1/securetrack/api/change_authorization?old_version=1&new_version=2&traffic_details=true&ignore_tickets=true

Response Messages:
200: Change authorization has been successfully calculated
400: Input parameters are not valid
400: Could not find the requested revisions for comparison"},"response":[]}]},{"name":"Change Windows","item":[{"name":"Get a list of completed policy changes for a specific change window","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"uid"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/change_windows/{{uid}}/tasks","description":"Retrieves a list of completed policy changes for a specific change window.
For valid pagination, both start and count should be provided. Otherwise, pagination is turned off.
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.


Parameters:
context: Global MSSP context [optional]
uid: Change window uuid
start: Starting result for query allowable value is numeric [optional]
count: Number of tasks for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_windows/fc7b167c-29ea-49a1-9ee3-efb6d1351343/tasks?start=0&count=50&get_total=true
OUTPUT {
    \"commit_tasks\": {
        \"count\": 1,
        \"total\": 1,
        \"commit_task\": {
            \"id\": 1,
            \"start_date\": \"04-Nov-2018 01:30:00PM +0200\",
            \"end_date\": \"04-Nov-2018 01:32:01PM +0200\",
            \"errors\": \"\"
        }
    }
}


Response Messages:
200: OK
400: For correct pagination provide a value for the start and count parameters
400: Start parameter must be a non-negative value
400: Count parameter must be a positive value
401: Not permitted to access this context
404: Change window with uuid was not found
404: Change window with uuid was not found in domain "},"response":[]},{"name":"Get scheduling and device details for a specific change window","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"uid"},{"value":null,"type":"text","key":"task_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/change_windows/{{uid}}/tasks/{{task_id}}","description":"Retrieves scheduling and device details for a specific change window.

Parameters:
context: Global MSSP context [optional]
uid: Change window uuid
task_id: Task Id

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_windows/fc7b167c-29ea-49a1-9ee3-efb6d1351343/tasks/1
OUTPUT {
    \"commit_task\": {
        \"id\": 1,
        \"start_date\": \"04-Nov-2018 01:30:00PM +0200\",
        \"end_date\": \"04-Nov-2018 01:32:01PM +0200\",
        \"errors\": \"\",
        \"device_commits\": {
            \"device_commit\": [
                {
                    \"id\": 1,
                    \"result\": {
                        \"errors\": {
                            \"error\": \"got_error_from_dcs\"
                        },
                        \"device\": {
                            \"id\": 17,
                            \"status\": \"FAILURE\",
                            \"revision_id\": 1,
                            \"errors\": {
                                \"error\": \"Login error\"
                            }
                        }
                    }
                },
                {
                    \"id\": 2,
                    \"result\": {
                        \"errors\": \"\",
                        \"device\": {
                            \"id\": 19,
                            \"status\": \"SUCCESS_WITH_WARNINGS\",
                            \"revision_id\": 1,
                            \"warnings\": {
                                \"warning\": \"Commit not performed: This device had no policies to install on its managed firewalls\"
                            }
                        }
                    }
                }
            ]
        }
    }
}


Response Messages:
200: OK
400: For correct pagination provide a value for the start and count parameters
400: Start parameter must be a non-negative value
400: Count parameter must be a positive value
401: Not permitted to access this context
404: Change window with uuid was not found
404: Change window with uuid was not found in domain
404: Fail to find task for change window "},"response":[]},{"name":"Get name and status for all change windows","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/change_windows/","description":"Retrieves a list of all change windows.
For valid pagination, both start and count should be provided. Otherwise, pagination is turned off.
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.


Parameters:
context: Global MSSP context [optional]
start: Starting result for query allowable value is numeric [optional]
count: Number of change windows for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_windows?start=0&count=50&get_total=true
OUTPUT {
    \"change_windows\": {
        \"count\": 2,
        \"total\": 2,
        \"change_window\": [
            {
                \"uuid\": \"6ae41504-a95c-4f23-98a2-f18b2efadb9d\",
                \"name\": \"cw1\",
                \"domain_id\": 1,
                \"enabled\": true
            },
            {
                \"uuid\": \"fc7b167c-29ea-49a1-9ee3-efb6d1351343\",
                \"name\": \"cw2\",
                \"domain_id\": 1,
                \"enabled\": true
            }
        ]
    }
}


Response Messages:
200: OK
400: For correct pagination provide a value for the start and count parameters
400: Start parameter must be a non-negative value
400: Count parameter must be a positive value
401: Not permitted to access this context "},"response":[]}]},{"name":"Device Interfaces and Zones","item":[{"name":"Get device zones by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/zones","description":"Returns a list of the zones for the specified Juniper, Stonesoft, Fortinet or Palo Alto Networks revision.
Note: this API returns device zones, not Tufin zones.

Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/787/zones
"},"response":[]},{"name":"Get network interfaces by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/interfaces","description":"Reflects static data from the running-config.
For dynamic information see the /topology_interfaces API.
This API is not applicable for Check Point.

Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/227/interfaces
"},"response":[]},{"name":"Get device zones by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/zones","description":"Returns a list of the zones for the specified Juniper, Stonesoft, Fortinet or Palo Alto Networks device.
Note: this API returns device zones, not Tufin zones.

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/104/zones
"},"response":[]},{"name":"Get zones and network interfaces that participate in sub-policies","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/bindable_objects","description":"Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/104/bindable_objects
"},"response":[]},{"name":"Get network interfaces by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/interfaces","description":"Reflects static data from the running-config.
For dynamic information see the /topology_interfaces API.
This API is not applicable for Check Point.

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/10/interfaces
"},"response":[]}]},{"name":"Domains","item":[{"name":"Get domain","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/domains/{{id}}","description":"Parameters:
context: Global MSSP context [optional]
id: Domain id

Usage Example
https://192.168.1.1/securetrack/api/domains/1

Response Messages:
401: User not permitted to access domains
400: Domain with ID was not found"},"response":[]},{"name":"Update a domain","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"domain\": {\n\t\t\"name\": \"edited name\",\n\t\t\"address\": \"edited address\",\n\t\t\"description\": \"edited description\"\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/domains/{{id}}","description":"Parameters:
id: Domain id
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/domains/2
BODY{
    \"domain\": {
        \"name\": \"edited name\",
        \"address\": \"edited address\",
        \"description\": \"edited description\"
    }
}


Response Messages:
401: User not permitted to access domains
400: Domain with ID was not found
400: Domain with this name already exists
400: Domain name is empty
400: Default domain cannot be changed"},"response":[]},{"name":"Add a domain","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"domain\": {\n\t\t\"name\": \"domain1\",\n\t\t\"address\": \"address\",\n\t\t\"description\": \"description\"\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/domains/","description":"Parameters:
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/domains
BODY{
    \"domain\": {
        \"name\": \"domain1\",
        \"address\": \"address\",
        \"description\": \"description\"
    }
}


Response Messages:
401: User not permitted to access domains
400: Domain with this name already exists
400: Domain name is empty"},"response":[]},{"name":"Get all domains","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/domains/","description":"

Usage Example
https://192.168.1.1/securetrack/api/domains

Response Messages:
401: User not permitted to access domains"},"response":[]}]},{"name":"General Properties","item":[{"name":"Get general properties","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/properties/","description":"This API requires 'Super admin' privileges



Usage Example
URLhttps://192.168.1.1/securetrack/api/properties
OUTPUT{
    \"properties\": {
        \"sc_addresses\": {
            \"sc_address\": [
                {
                    \"ip_address\": \"127.0.0.1\",
                    \"type\": \"external\"
                },
                {
                    \"ip_address\": \"127.0.0.1\",
                    \"type\": \"internal\"
                }
            ]
        }
    }
}


Response Messages:
401: User not permitted to view properties"},"response":[]}]},{"name":"IPsec VPN","item":[{"name":"Get Cisco cryptographic maps by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/crypto_maps","description":"Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://191.168.1.1/securetrack/api/revisions/18/crypto_maps
"},"response":[]},{"name":"Get Check Point VPN (IPSec) communities and gateways","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/ipsec_communities","description":"Get Check Point VPN (IPSec) Communities and gateways that partcipant in those communities.
Works on clusters and gateways, not on management servers.

Parameters:
device_id: The unique identifier of target device

Usage Example
https://192.168.1.1/securetrack/api/bindings/20/ipsec_communities
"},"response":[]},{"name":"Get Cisco IPsec policy and peers","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"outputInterfaceName"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/ipsec_tunnels","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.
You can retrieve the interface names by calling the /devices/id/interfaces API.

Parameters:
device_id: The unique identifier of target device
outputInterfaceName: Interface name

Usage Example
https://192.168.1.1/securetrack/api/bindings/32/ipsec_tunnels?outputInterfaceName=GigabitEthernet1
"},"response":[]},{"name":"Get Cisco cryptographic maps by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/crypto_maps","description":"Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/19/crypto_maps
"},"response":[]}]},{"name":"Internet Objects","item":[{"name":"Get resolved Internet representation for device","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"deviceId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}/object","description":"The order of precedence used to resolve the Internet object is:
Step 1: Identify the Internet referral:
Search for a defined Internet referral on the specified device.
If it is not found on the device, search the parent and grandparents (up the device tree) for a defined Internet referral.
If a defined Internet referral is found, then match the name in the Internet referral to a network object, as defined in Step 2.
If an Internet referral is not found, it resolves to “Any”.
Step 2: Resolve the object by name:
Search the specified device for a defined network object that matches the name returned in Step 1.
If a matching network object is not found, an error will be returned.

Parameters:
deviceId: SecureTrack Device ID

Usage Example
https://192.168.1.1/securetrack/api/internet_referral/2/object

Response Messages:
200: Resolved Internet referral object for device is returned
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
404: Configured object was not found on the device
401: Access is denied."},"response":[]},{"name":"Update Internet representation for device","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"internet_referral\": {\n\t\t\"@xsi.type\": \"internetReferralObjectNameDTO\",\n\t\t\"device_id\": 2,\n\t\t\"object_name\": \"Host_10.11.73.1\"\n\t}\n}\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}","description":"Updates the Internet referral configuration for the device.
If there was no previous configuration, it will be created.

Parameters:
deviceId: SecureTrack Device ID
body: Internet referral configuration

Usage Example
URLhttps://192.168.1.1/securetrack/api/internet_referral
BODY{
    \"internet_referral\": {
        \"@xsi.type\": \"internetReferralObjectNameDTO\",
        \"device_id\": 2,
        \"object_name\": \"Host_10.11.73.1\"
    }
}


Response Messages:
200: Internet referral configuration was updated
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
400: Internet referral configuration was malformed
401: Access is denied."},"response":[]},{"name":"Get Internet representation for device","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"deviceId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}","description":"Parameters:
deviceId: SecureTrack Device ID

Usage Example
https://192.168.1.1/securetrack/api/internet_referral/2

Response Messages:
200: Internet referral configuration is returned
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
404: Internet referral configuration was not found for device ID
401: Access is denied."},"response":[]},{"name":"Delete Internet representation for device","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"deviceId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}","description":"Parameters:
deviceId: SecureTrack Device ID

Usage Example
https://192.168.1.1/securetrack/api/internet_referral/2

Response Messages:
200: Internet referral configuration was deleted
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
400: Internet referral configuration for device ID does not exist
401: Access is denied."},"response":[]},{"name":"Create new Internet representation for a device","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"internet_referral\": {\n\t\t\"@xsi.type\": \"internetReferralObjectNameDTO\",\n\t\t\"device_id\": 2,\n\t\t\"object_name\": \"Host_2.2.2.2\"\n\t}\n}\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/","description":"The internet referral lets you represent the Internet as an object on a device.
See REST API: /internet_referral/{deviceId:[0-9]+}/object for a description of how internet referral is resolved.

Parameters:
body: Internet referral configuration

Usage Example
URLhttps://192.168.1.1/securetrack/api/internet_referral
BODY{
    \"internet_referral\": {
        \"@xsi.type\": \"internetReferralObjectNameDTO\",
        \"device_id\": 2,
        \"object_name\": \"Host_2.2.2.2\"
    }
}


Response Messages:
201: Internet referral configuration was created
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
400: Internet referral configuration was malformed
400: Internet referral configuration for given device ID already exists
401: Access is denied."},"response":[]}]},{"name":"LDAP","item":[{"name":"Get LDAP entry details by DN","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"dn"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/getEntryByDN","description":"Returns the UID, DN and Name of a LDAP entry specified by the DN.

Parameters:
dn: LDAP DN

Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/getEntryByDN?dn=CN=Manufacturing,OU=RSA_Demo,DC=tufintest,DC=com
OUTPUT{
    \"ldap_entry\": {
        \"uid\": \"mYbWQms7p0q5YinEyW5Byw==\",
        \"dn\": \"CN=Manufacturing,OU=RSA_Demo,DC=tufintest,DC=com\",
        \"name\": \"Manufacturing\"
    }
}


Response Messages:
200: OK
400: Invalid DN format
404: Entry matching the DN cannot be found
501: LDAP server is not configured
503: No connection to LDAP server"},"response":[]},{"name":"Get the base DN entry details","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/getBaseDNEntry","description":"The returned \"base DN\" is used by GetEntriesByNames API as the search start entry.



Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/getBaseDNEntry
OUTPUT{
    \"ldap_entry\": {
        \"dn\": \"DC=tufintest,DC=com\",
        \"uid\": \"nABbRP/lPUKlteNRI4j6iA==\"
    }
}


Response Messages:
200: OK
404: Base Entry cannot be found
501: LDAP server is not configured
503: No connection to LDAP server"},"response":[]},{"name":"Return entries that exactly match one of the given strings","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"search_by_name_criteria\": {\n\t\t\"search_texts\": {\n\t\t\t\"search_text\": [\n\t\t\t\t\"Finance\",\n\t\t\t\t\"Marketing\",\n\t\t\t\t\"Management\"\n\t\t\t]\n\t\t},\n\t\t\"ldap_entry_types\": {\n\t\t\t\"ldap_entry_type\": [\n\t\t\t\t\"GROUP\"\n\t\t\t]\n\t\t},\n\t\t\"max_search_result\": 20\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/getEntriesByNames","description":"Return list of LDAP entries which match the exact given multiple search_text.

Parameters:
body: Names to search

Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/getEntriesByNames
BODY{
    \"search_by_name_criteria\": {
        \"search_texts\": {
            \"search_text\": [
                \"Finance\",
                \"Marketing\",
                \"Management\"
            ]
        },
        \"ldap_entry_types\": {
            \"ldap_entry_type\": [
                \"GROUP\"
            ]
        },
        \"max_search_result\": 20
    }
}
OUTPUT{
    \"search_result\": {
        \"ldap_entries\": {
            \"ldap_entry\": [
                {
                    \"@xsi.type\": \"LdapGroup\",
                    \"dn\": \"CN=Finance,OU=SecureTrack,DC=tufintest,DC=com\",
                    \"uid\": \"uOvJTpYRD0aTjEENA87N5A==\",
                    \"displayName\": \"Finance\"
                },
                {
                    \"@xsi.type\": \"LdapGroup\",
                    \"dn\": \"CN=Management,OU=SecureTrack,DC=tufintest,DC=com\",
                    \"uid\": \"jdf778skfsgs730fksdHHs==\",
                    \"displayName\": \"Management\"
                }
            ]
        },
        \"has_more_results_to_return\": false
    }
}


Response Messages:
200: OK
400: Bad request (one of the request fields has an illegal value)
501: LDAP server is not configured
503: No connection to LDAP server"},"response":[]},{"name":"Return LDAP entries which match the given search criteria","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"search_criteria\": {\n\t\t\"search_base_dn\": \"DC=tufintest,DC=com\",\n\t\t\"search_text\": \"test\",\n\t\t\"ldap_search_options\": {\n\t\t\t\"ldap_entry_types\": {\n\t\t\t\t\"ldap_entry_type\": [\n\t\t\t\t\t\"OU\",\n\t\t\t\t\t\"USER\"\n\t\t\t\t]\n\t\t\t},\n\t\t\t\"search_mode\": \"CONTAINS\",\n\t\t\t\"max_search_result\": 3\n\t\t}\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/search","description":"Return list of LDAP entries which match the given search criteria according to the search mode (EXACT, CONTAINS, STARTS_WITH, ENDS_WITH).
The search is case insensitive.
The limit of max_search_result is 1000.

Parameters:
body: Search criteria

Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/search
BODY{
    \"search_criteria\": {
        \"search_base_dn\": \"DC=tufintest,DC=com\",
        \"search_text\": \"test\",
        \"ldap_search_options\": {
            \"ldap_entry_types\": {
                \"ldap_entry_type\": [
                    \"OU\",
                    \"USER\"
                ]
            },
            \"search_mode\": \"CONTAINS\",
            \"max_search_result\": 3
        }
    }
}
OUTPUT{
    \"search_result\": {
        \"ldap_entries\": {
            \"ldap_entry\": [
            {
                \"dn\": \"CN=User15ATTesting1,OU=Testing1,OU=new OU,OU=SC_Users,DC=tufintest,DC=com\",
                \"uid\": \"ZRuKW3XqIEOIxCwlfgJQYA==\",
                \"displayName\": \"User15ATTesting1\"
            },
            {
                \"dn\": \"CN=IWAM_TEST2003,CN=Users,DC=tufintest,DC=com\",
                \"uid\": \"bYVqqcZXsUSF51hiP4W7Yw==\",
                \"displayName\": \"Testing1\"
            },
            {
                \"dn\": \"CN=User1ATTesting1,OU=Testing1,OU=new OU,OU=SC_Users,DC=tufintest,DC=com\",
                \"uid\": \"2ma3TrgeHEWQDITwvcRqlg==\",
                \"displayName\": \"test\"
            }
            ]
        },
            \"has_more_results_to_return\": \"true\"
        }
}


Response Messages:
200: OK
400: Bad request (one of the request fields has an illegal or invalid value)
501: LDAP server is not configured
503: No connection to LDAP server"},"response":[]}]},{"name":"Monitored Devices","item":[{"name":"Add devices to SecureTrack","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \n \t \"devices_list\":{ \n \t\t \"devices\": [{ \n \t\t\t \"model\":\"CMA\",\n \t\t\t \"vendor\":\"Checkpoint\",\n \t\t\t \"display_name\":\"Europe-CMA\",\n \t\t\t \"ip_address\":\"192.168.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"securetrack_domain\":\"Default\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"lea_authentication_port\":\"65000\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"opsec_application\":\"ST-Opsec\",\n \t\t\t\t \"activation_key\":\"ST-Activation\",\n \t\t\t\t \"r80_version\":\"false\"\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"model\":\"CMA\",\n \t\t\t \"vendor\":\"Checkpoint\",\n \t\t\t \"display_name\":\"Europe-CMA\",\n \t\t\t \"ip_address\":\"192.168.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"securetrack_domain\":\"Default\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"lea_authentication_port\":\"65000\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"opsec_application\":\"ST-Opsec\",\n \t\t\t\t \"activation_key\":\"ST-Activation\",\n \t\t\t\t \"user_name\":\"admin\",\n \t\t\t\t \"password\":\"1234\",\n \t\t\t\t \"r80_version\":\"true\"\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"model\":\"ASA\",\n \t\t\t \"vendor\":\"Cisco\",\n \t\t\t \"securetrack_domain\":\"Domain-A\",\n \t\t\t \"display_name\":\"Ireland-ASA\",\n \t\t\t \"ip_address\":\"172.16.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t \"enable_virtual_contexts\":\"true\",\n \t\t\t \"import_all\":\"false\",\n \t\t\t \"import_devices\": \n \t\t\t\t\t [\"VC1\",\"VC2\"],\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"false\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"user_name\":\"St-Super-use\",\n \t\t\t\t \"password\":\"st-super-password\",\n \t\t\t\t \"enable_password\":\"st-enable-password\"\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"model\":\"Panorama\",\n \t\t\t \"vendor\":\"PaloAltoNetworks\",\n \t\t\t \"display_name\":\"First-Device-example\",\n \t\t\t \"ip_address\":\"172.16.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"user_name\":\"St-Super-use\",\n \t\t\t\t \"password\":\"st-super-password\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"import_devices\":[\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG1\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"] \n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG2\",\n \t\t\t\t\t\t \"import_all\":\"true\"\n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG3\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [] \n \t\t\t\t\t }\n \t\t\t\t ]\n \t\t\t }\n \t\t },\n \t\t {\n \t\t\t \"model\":\"FortiManager\",\n \t\t\t \"vendor\":\"Fortinet\",\n \t\t\t \"display_name\":\"Spain-FortiManager\",\n \t\t\t \"securetrack_server\":\"RemoteControlServerName\",\n \t\t\t \"ip_address\":\"172.16.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"false\",\n \t\t\t\t \"user_name\":\"St-Super-use\",\n \t\t\t\t \"password\":\"st-super-password\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"import_all\": \"false\",\n \t\t\t\t \"import_devices\": [\n \t\t\t\t\t\t { \n \t\t\t\t \"name\": \"AdomX\",\n \t\t\t\t \"import_all\": \"false\", \n \t\t\t\t \"managed_devices\": [\"FW1\"]\n \t\t\t\t\t\t}\n \t\t\t\t\t]\n \t\t\t\t}\n \t\t\t}\n \t\t]\n \t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/","description":"Use this API to add a single device or a list of devices to SecureTrack.
The following devices can be added: Check Point CMA R77, CMA R80, SMC R77, SMC R80; Cisco ASA; Palo Alto Panorama NG; Fortinet FortiManager.
The API body should include a JSON file with the mandatory parameters for the operation.
String parameters contain only lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^().
Currently supported types: CMA, SMC, ASA, Panorama NG and FortiManager.

This API verifies connection to the provided device, before adding a device.
This is done by:
  Cisco - Connect with SSH and see that the credentials are correct.
  Check Point - Test OPSEC connectivity. For R80 devices, this also verifies the connectivity for API login.
  Panorama - Login through the API to check connectivity.
  Fortimanager - Login through the API to check connectivity.
If the connection test fails the device will not be added.
Only \"live\" device with correct credentials can be added using this API.
To add Checkpoint R77 devices, use \"r80_version\" : \"false\".


Parameters:
body: device_list

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/bulk
BODY{
     \"devices_list\":{
         \"devices\": [{
             \"model\":\"CMA\",
             \"vendor\":\"Checkpoint\",
             \"display_name\":\"Europe-CMA\",
             \"ip_address\":\"192.168.1.1\",
             \"enable_topology\": \"true\",
             \"securetrack_domain\":\"Default\",
             \"device_data\":{
                 \"lea_authentication_port\":\"65000\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"opsec_application\":\"ST-Opsec\",
                 \"activation_key\":\"ST-Activation\",
                 \"r80_version\":\"false\"
             }
         },
         {
             \"model\":\"CMA\",
             \"vendor\":\"Checkpoint\",
             \"display_name\":\"Europe-CMA\",
             \"ip_address\":\"192.168.1.1\",
             \"enable_topology\": \"true\",
             \"securetrack_domain\":\"Default\",
             \"device_data\":{
                 \"lea_authentication_port\":\"65000\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"opsec_application\":\"ST-Opsec\",
                 \"activation_key\":\"ST-Activation\",
                 \"user_name\":\"admin\",
                 \"password\":\"1234\",
                 \"r80_version\":\"true\"
             }
         },
         {
             \"model\":\"ASA\",
             \"vendor\":\"Cisco\",
             \"securetrack_domain\":\"Domain-A\",
             \"display_name\":\"Ireland-ASA\",
             \"ip_address\":\"172.16.1.1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
             \"enable_virtual_contexts\":\"true\",
             \"import_all\":\"false\",
             \"import_devices\":
                     [\"VC1\",\"VC2\"],
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"false\",
                 \"collect_dynamic_topology\":\"false\",
                 \"user_name\":\"St-Super-use\",
                 \"password\":\"st-super-password\",
                 \"enable_password\":\"st-enable-password\"
             }
         },
         {
             \"model\":\"Panorama\",
             \"vendor\":\"PaloAltoNetworks\",
             \"display_name\":\"First-Device-example\",
             \"ip_address\":\"172.16.1.1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"user_name\":\"St-Super-use\",
                 \"password\":\"st-super-password\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"collect_dynamic_topology\":\"false\",
                 \"import_devices\":[
                     {
                         \"name\":\"DG1\",
                         \"import_all\":\"false\",
                         \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"]
                     },
                     {
                         \"name\":\"DG2\",
                         \"import_all\":\"true\"
                     },
                     {
                         \"name\":\"DG3\",
                         \"import_all\":\"false\",
                         \"managed_devices\": []
                     }
                 ]
             }
         },
         {
             \"model\":\"FortiManager\",
             \"vendor\":\"Fortinet\",
             \"display_name\":\"Spain-FortiManager\",
             \"securetrack_server\":\"RemoteControlServerName\",
             \"ip_address\":\"172.16.1.1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"false\",
                 \"user_name\":\"St-Super-use\",
                 \"password\":\"st-super-password\",
                 \"collect_dynamic_topology\":\"false\",
                 \"import_all\": \"false\",
                 \"import_devices\": [
                         {
                 \"name\": \"AdomX\",
                 \"import_all\": \"false\",
                 \"managed_devices\": [\"FW1\"]
                        }
                    ]
                }
            }
        ]
    }
}


Response Messages:
202: Accepted
408: Request timed out
500: Internal server error
503: Task with UID already running"},"response":[]},{"name":"Edit Securetrack device","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \n \t \"devices_list\":{ \n\t\t \"devices\": [{\n\t\t\t \"device_id\": 1,\n\t\t\t \"display_name\": \"CheckPoint-R77-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"ip_address\": \"1.1.1.1\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"opsec_application\": \"ST-Opsec\",\n\t\t\t\t \"activation_key\": \"ST-Activation\",\n\t\t\t\t \"authentication_mode\": \"LEA\",\n\t\t\t\t \"lea_authentication_mode\": \"ssl_opsec\",\n\t\t\t\t \"lea_authentication_port\": \"2488\",\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 2,\n\t\t\t \"display_name\": \"CheckPoint-R80-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"ip_address\": \"1.1.1.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"opsec_application\": \"ST-Opsec\",\n\t\t\t\t \"activation_key\": \"ST-Activation\",\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\",\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 3,\n\t\t\t \"display_name\": \"Cisco-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"ip_address\": \"2.2.2.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\",\n\t\t\t\t \"enable_password\": \"st-super-password\",\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 4,\n\t\t\t \"display_name\": \"PaloAlto-PanoramaNg-Device\",\n\t\t\t \"ip_address\": \"2.2.2.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 5,\n\t\t\t \"display_name\": \"PaloAlto-DeviceGroup\"\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 6,\n\t\t\t \"display_name\": \"PaloAlto-FireWall-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_dynamic_topology\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 7,\n\t\t\t \"display_name\": \"Spain-FortiManager\",\n\t\t\t \"ip_address\": \"2.2.2.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 8,\n\t\t\t \"display_name\": \"FortiManager-Adom\"\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 9,\n\t\t\t \"display_name\": \"FortiManager-FireWall\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_dynamic_topology\": \"true\"\n\t\t\t }\n\t\t }\n\t\t]\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/","description":"Use this API to edit the settings of a management device, including changing multiple parameters in the same call.
The API body should include a JSON file with the mandatory parameters for the operation.
String parameters contain only lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^().
The following devices can be added: Check Point CMA R77, CMA R80, SMC R77, SMC R80; Cisco ASA; Palo Alto Panorama NG; Fortinet FortiManager.
Note: This API cannot be used to edit SecureTrack Domains and SecureTrack Servers.
This API verifies connection to the provided device, before updating a device.
This is done by:
  Cisco - Connect with SSH and see that the credentials are correct.
  Check Point - Test OPSEC connectivity. For R80 devices, this also verifies the connectivity for API login.
  Panorama - Login through the API to check connectivity.
  Fortimanager - Login through the API to check connectivity.
If the connection test fails the device will not be updated.
Only \"live\" device with correct credentials can be updated using this API.

Parameters:
body: device_list

Usage Example
URL https://192.168.1.1/securetrack/api/devices/bulk
BODY{
     \"devices_list\":{
         \"devices\": [{
             \"device_id\": 1,
             \"display_name\": \"CheckPoint-R77-Device\",
             \"enable_topology\": \"true\",
             \"ip_address\": \"1.1.1.1\",
             \"device_data\": {
                 \"opsec_application\": \"ST-Opsec\",
                 \"activation_key\": \"ST-Activation\",
                 \"authentication_mode\": \"LEA\",
                 \"lea_authentication_mode\": \"ssl_opsec\",
                 \"lea_authentication_port\": \"2488\",
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\"
             }
         },
         {
             \"device_id\": 2,
             \"display_name\": \"CheckPoint-R80-Device\",
             \"enable_topology\": \"true\",
             \"ip_address\": \"1.1.1.2\",
             \"device_data\": {
                 \"opsec_application\": \"ST-Opsec\",
                 \"activation_key\": \"ST-Activation\",
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\",
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\"
             }
         },
         {
             \"device_id\": 3,
             \"display_name\": \"Cisco-Device\",
             \"enable_topology\": \"true\",
             \"ip_address\": \"2.2.2.2\",
             \"device_data\": {
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\",
                 \"enable_password\": \"st-super-password\",
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\"
             }
         },
         {
             \"device_id\": 4,
             \"display_name\": \"PaloAlto-PanoramaNg-Device\",
             \"ip_address\": \"2.2.2.2\",
             \"device_data\": {
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\"
             }
         },
         {
             \"device_id\": 5,
             \"display_name\": \"PaloAlto-DeviceGroup\"
         },
         {
             \"device_id\": 6,
             \"display_name\": \"PaloAlto-FireWall-Device\",
             \"enable_topology\": \"true\",
             \"device_data\": {
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\",
                 \"collect_dynamic_topology\": \"true\"
             }
         },
         {
             \"device_id\": 7,
             \"display_name\": \"Spain-FortiManager\",
             \"ip_address\": \"2.2.2.2\",
             \"device_data\": {
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\"
             }
         },
         {
             \"device_id\": 8,
             \"display_name\": \"FortiManager-Adom\"
         },
         {
             \"device_id\": 9,
             \"display_name\": \"FortiManager-FireWall\",
             \"enable_topology\": \"true\",
             \"device_data\": {
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\",
                 \"collect_dynamic_topology\": \"true\"
             }
         }
        ]
    }
}


Response Messages:
202: Accepted
408: Request timed out
500: Internal server error
503: Task with UID already running"},"response":[]},{"name":"Add configuration for offline device","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"configuration_file"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/tasks/add_device_config_task","description":"Parameters:
device_id: Device ID
configuration_file: Configuration File

Usage Example
curl -X POST -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F \"configuration_file=@/tmp/config.txt;type=application/octet-stream\" -F \"device_id=1\" https://192.168.1.1/securetrack/api/tasks/add_device_config_task

Response Messages:
200: Configuration added successfully."},"response":[]},{"name":"Get textual configuration by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/config","description":"Returns textual configuration for the specified revision Id.


Parameters:
context: Global MSSP context [optional]
id: Revision id

Usage Example
https://192.168.1.1/securetrack/api/revisions/227/config
"},"response":[]},{"name":"Get textual configuration by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/config","description":"Get latest revision of running configuration for a given device Id.


Parameters:
context: global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/111/config
"},"response":[]},{"name":"Update offline device","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t API OFFLINE ASA2\n\t true\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}","description":"Device name should contain only Lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^()

Parameters:
device_id: Device ID
body: Device to be updated

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/1
BODY<device>
     <name>API OFFLINE ASA2</name>
     <topology>true</topology>
</device>

"},"response":[]},{"name":"Get specific device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}","description":"Returns the vendor, model, name, domain and ID for the specified device.
For more information on supported devices, supported models and virtual types please refer to 'Device and Revision Resources' section in the Tufin Knowledge Center .

Parameters:
context: Global MSSP context [optional]
id: Device ID
show_os_version: Show os version as apart of the response [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/60

Usage Example
https://192.168.1.1/securetrack/api/devices/20?show_os_version=true
"},"response":[]},{"name":"Import managed devices","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \n \t \"devices_list\":{ \n \t\t \"devices\":[ \n \t\t { \n \t\t\t \"device_id\":\"1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"import_devices\":[\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG1\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"] \n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG2\",\n \t\t\t\t\t\t \"import_all\":\"true\"\n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG3\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [] \n \t\t\t\t\t }\n \t\t\t\t ]\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"device_id\":\"2\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"import_devices\": [\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"Adom1\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [\"firewall1\", \"firewall2\"] \n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"Adom2\",\n \t\t\t\t\t\t \"import_all\":\"true\"\n \t\t\t\t\t }\n \t\t\t\t ]\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"device_id\":\"3\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"import_devices\": [\"wantedVirtualContext\", \"anotherWantedVirtualContext\"] \n \t\t\t }\n \t\t }\n \t\t]\n \t}\n} "},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/import","description":"Use this API to import more managed devices to SecureTrack.
The following devices can be added: Device Groups (for Panorama), Administrative Domains (for FortiManager).\nCurrently supported types: Panorama, FortiManager, Cisco ASA.
Please see examples below per device id: device id 1 for Panorama, device 2 for FortiManager, device id 3 for Cisco ASA.

Parameters:
body: device_list

Usage Example
URL https://192.168.1.1/securetrack/api/devices/bulk/import
BODY{
     \"devices_list\":{
         \"devices\":[
         {
             \"device_id\":\"1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"collect_dynamic_topology\":\"false\",
                 \"import_devices\":[
                     {
                         \"name\":\"DG1\",
                         \"import_all\":\"false\",
                         \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"]
                     },
                     {
                         \"name\":\"DG2\",
                         \"import_all\":\"true\"
                     },
                     {
                         \"name\":\"DG3\",
                         \"import_all\":\"false\",
                         \"managed_devices\": []
                     }
                 ]
             }
         },
         {
             \"device_id\":\"2\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"import_devices\": [
                     {
                         \"name\":\"Adom1\",
                         \"import_all\":\"false\",
                         \"managed_devices\": [\"firewall1\", \"firewall2\"]
                     },
                     {
                         \"name\":\"Adom2\",
                         \"import_all\":\"true\"
                     }
                 ]
             }
         },
         {
             \"device_id\":\"3\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"import_devices\": [\"wantedVirtualContext\", \"anotherWantedVirtualContext\"]
             }
         }
        ]
    }
}


Response Messages:
202: Accepted
408: Request timed out
500: Internal server error
503: Task with UID already running"},"response":[]},{"name":"Add offline device","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t asa \n\t Cisco\n\t 1\n\t Default\n\t API OFFLINE ASA1\n\t true\n\t true\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/","description":"You can choose to select the domain either by name or id using the domain_id or domain_name tags.\nDevice name should contain only Lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^()

Parameters:
body: Device to be added

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices
BODY<device>
     <model>asa</model>
     <vendor>Cisco</vendor>
     <domain_id>1</domain_id>
     <domain_name>Default</domain_name>
     <name>API OFFLINE ASA1</name>
     <offline>true</offline>
     <topology>true</topology>
</device>

"},"response":[]},{"name":"Get devices","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/","description":"Returns the list of devices that are configured in SecureTrack, including the vendor, model, name, domain and device ID.
The results can be sorted by ip, name, vendor and model.
For more information on supported devices, supported models and virtual types please refer to 'Device and Revision Resources' section in the Tufin Knowledge Center .

Parameters:
context: Global MSSP context [optional]
name: Device name [optional]
ip: Device IP address [optional]
vendor: Device vendor [optional]
model: Device model [optional]
sort: Sort ascending or descending allowable types are: asc or desc [optional]
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query starting from starting page allowable type in numeric [optional]
show_os_version: Show os version as apart of the response [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices

Usage Example
https://192.168.1.1/securetrack/api/devices?vendor=VMware

Usage Example
https://192.168.1.1/securetrack/api/devices?sort=ip:asc

Usage Example
https://192.168.1.1/securetrack/api/devices?show_os_version=true
"},"response":[]},{"name":"Get specific task results of bulk operations on devices","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"task_uid"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/tasks/{{task_uid}}","description":"Use this API to track and display the current progress of the devices being edited or added to\nSecureTrack for a specific Task ID.
For a list of devices, the status of each device is displayed.

A device that was not added due to some reason will be added to \"failed\" list with status element containing a description.
For example:
\"description\": \"No connection to device\".

Parameters:
task_uid: Task UID

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/bulk/tasks/d7e88799-a6e5-45da-8c72-c979a5dbe235
OUTPUT{
    \"task_result\":{
        \"total_succeeded\":\"0\",
        \"total_in_progress\":\"2\",
        \"total_failed\":\"0\",
        \"succeeded\":{
            \"count\":\"0\"
        },
        \"in_progress\":{
            \"count\":\"2\",
            \"devices\":[
                {
                    \"device_id\":\"1\",
                    \"display_name\":\"Europe-CMA\",
                    \"ip_address\":\"192.168.1.1\",
                    \"status\":{
                    }
                },
                {
                    \"device_id\":\"2\",
                    \"display_name\":\"Ireland-ASA\",
                    \"ip_address\":\"172.16.1.1\",
                    \"status\":{
                    }
                }
            ]
        },
        \"failed\":{
            \"count\":\"0\"
        }
    }
}


Response Messages:
404: The task with the given UID was not found
400: Bad request
200: Accepted
408: Request timed out
500: Internal server error"},"response":[]}]},{"name":"NAT Policies","item":[{"name":"Get NAT objects by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/nat_objects","description":"Fetches a list of NAT objects for a given revision
Note: NAT objects are only relevant for Check Point management servers and Juniper Netscreen devices.
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.


Parameters:
context: Global MSSP context [optional]
id: Version ID
start: Starting page for query allowable value is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/nat_objects

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/nat_objects?get_total=true
"},"response":[]},{"name":"Get NAT rules by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/nat_rules/bindings","description":"Fetches list of NAT rules for device given by device ID

input_interface and output_interface are not supported for Panorama running in Advanced management mode
nat_stage is supported for Netscreen and JunOS
nat_type is supported for FortiManager
Note: For Check Point, NAT rules are available from the modules (not managements)
Note: For Palo Alto, filtering NAT rules by interface is only available for firewall devices

Parameters:
context: Global MSSP context [optional]
id: Device ID
input_interface: Input interface for NAT rules, \"any\" for all interfaces [optional]
output_interface: output interface for NAT rules, \"any\" for all interfaces [optional]
nat_stage: NAT stage for NAT rules allowable values: \"pre_policy\" , \"post_policy\" or \"both\" [optional]
nat_type: NAT stage for NAT rules allowable values: \"vip\" or \"reverse_vip\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/10/nat_rules/bindings?input_interface=Any
"},"response":[]},{"name":"Get NAT objects by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/nat_objects","description":"Fetches a list of NAT objects defined on device given by device ID
Note: NAT objects are only relevant for Check Point management servers and Juniper Netscreen devices.
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.


Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable value is numeric [optional]
count: Starting page for query allowable value is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/nat_objects

Usage Example
https://192.168.1.1/securetrack/api/devices/20/nat_objects?get_total=true
"},"response":[]}]},{"name":"Network Objects","item":[{"name":"Get rules containing specified network object","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/network_objects/{{id}}/rules","description":"Returns the security rules that contain the specified network object


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the network object.
include_groups: You can add \"include_groups\" to find rules that include the network object and rules that include the groups that include the network object. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]

Usage Example
https://192.168.1.1/securetrack/api/network_objects/65078/rules?include_groups=true
"},"response":[]},{"name":"Get specific network objects by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/network_objects/{{ids}}","description":"Fetches a single or partial list of the network objects for a given revision.
For group network objects, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision id
ids: Network object IDs separated by commas
show_members: Set to false to return only the name and ID of the members [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/779/network_objects/69548

Usage Example
https://192.168.1.1/securetrack/api/revisions/779/network_objects/69547,69548,69550

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/779/network_objects/69547?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"network_object\": {
            \"@xsi.type\": \"identityAwarenessDTO\",
            \"id\": 169185,
            \"name\": \"Access_Role_Domain Controllers\",
            \"display_name\": \"Access_Role_Domain Controllers\",
            \"class_name\": \"access_role\",
            \"type\": \"identity_awareness\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{140B8F32-188D-414C-A7BE-F4A7D7E9A169}\",
            \"implicit\": false,
            \"overrides\": false,
            \"type_on_device\": \"\",
            \"networks\": {
                \"network\": {
                    \"@xsi.type\": \"basicNetworkObjectDTO\",
                    \"id\": 168419,
                    \"name\": \"Any\",
                    \"display_name\": \"Any\",
                    \"class_name\": \"any_object\",
                    \"type\": \"basic\",
                    \"global\": false,
                    \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                    \"implicit\": false,
                    \"overrides\": false
                }
            },
            \"users\": {
                \"user\": {
                    \"id\": 14237,
                    \"name\": \"ad_group_Domain_Controllers\",
                    \"display_name\": \"Domain Controllers\",
                    \"class_name\": \"ad_group\",
                    \"global\": false,
                    \"comment\": \"\",
                    \"uid\": \"{0A8A459E-58E8-45DC-981E-16BBF2BD1922}\",
                    \"dn\": \"CN=Domain Controllers,CN=Users,DC=rnd,DC=local\"
                }
            }
        }
    }
}

"},"response":[]},{"name":"Get network objects by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/network_objects","description":"Fetches list of network objects defined on device given by ID
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.
The show_members parameter is only relevant if type=group.
If type=group, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.

Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
name: Network object name [optional]
type: Network object type [optional]
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
contains_ip: Get only network objects containing this IP [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]
typeOnDevice: Get EDL groups [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/network_objects

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?get_total=true
OUTPUT {
    \"network_objects\": {
    \"count\": 1,
    \"total\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"hostNetworkObjectDTO\",
                \"id\": 499226,
                \"name\": \"1.1.1.2 not shared\",
                \"display_name\": \"1.1.1.2 not shared\",
                \"class_name\": \"host_plain\",
                \"type\": \"host\",
                \"comment\": \"\",
                \"uid\": \"{EFE8E61B-EE2A-2F55-4C5C-56508661EAA7}\",
                \"implicit\": false,
                \"management_domain\": \"Shared\",
                \"overrides\": false,
                \"ip\": \"1.1.1.2\"
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"count\": 1
        \"network_object\": [
            {
                \"@xsi.type\": \"identityAwarenessDTO\",
                \"id\": 169178,
                \"name\": \"Access_role\",
                \"display_name\": \"Access_role\",
                \"class_name\": \"access_role\",
                \"type\": \"identity_awareness\",
                \"global\": false,
                \"comment\": \"\",
                \"uid\": \"{FC267948-DA8C-4FB6-A736-76B5254BF825}\",
                \"implicit\": false,
                \"overrides\": false,
                \"type_on_device\": \"\",
                \"networks\": {
                    \"network\": {
                        \"@xsi.type\": \"basicNetworkObjectDTO\",
                        \"id\": 168419,
                        \"name\": \"Any\",
                        \"display_name\": \"Any\",
                        \"class_name\": \"any_object\",
                        \"type\": \"basic\",
                        \"global\": false,
                        \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                        \"implicit\": false,
                        \"overrides\": false
                    }
                },
                \"users\": {
                    \"user\": {
                        \"id\": 14320,
                        \"name\": \"ad_group_auto_30K_grp1\",
                        \"display_name\": \"auto_30K_grp1\",
                        \"class_name\": \"ad_group\",
                        \"global\": false,
                        \"comment\": \"\",
                        \"uid\": \"{CAB92DCC-CF63-4E47-B8E3-1E1231996D5E}\",
                        \"dn\": \"CN=auto_30K_grp1,OU=OU_30K_Groups,DC=rnd,DC=local\"
                    }
                }
            },
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?type=group&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 105934,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?typeOnDevice=edl_ip_list&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 1,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 123123,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"type_on_device\": edl_ip_list,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Response Messages:
400: The typeOnDevice value is not valid"},"response":[]},{"name":"Get specific network object","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/network_objects/{{ids}}","description":"Fetches a single or partial list of the network objects for a given device ID.
For group network objects, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.
Note: This API retrieves the information from the latest revision.

Parameters:
context: Global MSSP context [optional]
device_id: Device ID
ids: Network object IDs separated by commas
show_members: Set to false to return only the name and ID of the members [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/network_objects/69548

Usage Example
https://192.168.1.1/securetrack/api/devices/31/network_objects/69547,69548,69550

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects/169184?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"network_object\": {
            \"@xsi.type\": \"identityAwarenessDTO\",
            \"id\": 169184,
            \"name\": \"Access_Role_@grp\",
            \"display_name\": \"Access_Role_@grp\",
            \"class_name\": \"access_role\",
            \"type\": \"identity_awareness\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{1870612C-0922-4AEE-81FF-5472DB7C32E1}\",
            \"implicit\": false,
            \"overrides\": false,
            \"type_on_device\": \"\",
            \"networks\": {
                \"network\": {
                    \"@xsi.type\": \"basicNetworkObjectDTO\",
                    \"id\": 168419,
                    \"name\": \"Any\",
                    \"display_name\": \"Any\",
                    \"class_name\": \"any_object\",
                    \"type\": \"basic\",
                    \"global\": false,
                    \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                    \"implicit\": false,
                    \"overrides\": false
                }
            },
            \"users\": {
                \"user\": {
                    \"id\": 14338,
                    \"name\": \"ad_group_grp\",
                    \"display_name\": \"@grp\",
                    \"class_name\": \"ad_group\",
                    \"global\": false,
                    \"comment\": \"\",
                    \"uid\": \"{C5740C23-F36E-4D2E-8B17-1F99C239C12A}\",
                    \"dn\": \"CN=@grp,OU=SC_Users,DC=test,DC=com\"
                }
            }
        }
    }
}

"},"response":[]},{"name":"Get network objects matching specified criteria","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"filter"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/network_objects/search","description":"You can search for network objects where the IP address, name or comment fields have a specified text string,
or you can search for network objects that have an IP address that matches, contains or is contained in a specified IP subnet,
or you can search for network objects by uid.

Parameters:
context: Returns results for the specified domain ID. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]
filter: “text” filter returns network objects where the IP address, name or comment fields have a specified text string. “subnet” filter returns network objects that have an IP address that matches, contains or is contained in a specified IP subnet. “uid“ filter returns network objects with the specified uid. If no filter is specified, the “text” filter is used.
device_id: Returns network objects belonging to the specified device_id. [optional]
ip: (For “text” filter) You can specify \"ip\" to find network objects with the specified text in the IP address field. [optional]
name: (For “text” filter) You can specify \"name\" to find network objects with the specified text in the name field. [optional]
comment: (For “text” filter) You can specify “comment” to find network objects with the specified text in the comment field. [optional]
any_field: (For “text” filter) You can specify \"any_field\" to find network objects with the specified text in the IP address, name or comment fields. [optional]
exact_match: (For “text” filter) You can add \"exact_match=true\" to find network objects with the specified text in the comment field. If this field is not specified, the query uses \"exact_match=false\". [optional]
contained_in: (For “subnet” filter) You can specify \"contained_in\" to find network objects that are contained in the specified IP subnet. For example, 10.1.0.0 is contained in 10.0.0.0. [optional]
contains: (For “subnet” filter) You can specify \"contains\" to find network objects that contain the specified IP subnet. For example, 10.0.0.0 contains 10.1.0.0. [optional]
exact_subnet: (For “subnet” filter) You can specify \"exact_subnet\" to find network objects that have the specified IP address. [optional]
uid: (for “uid“ filter) Returns network objects with the specified uid. [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]
typeOnDevice: You can specify \"typeOnDevice\" to find network object groups that are EDL. [optional]

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=text&name=host&exact_match=true

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=text&any_field=host&count=10&exact_match=true

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=subnet&contains=10.1.1.0

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=subnet&count=10&exact_subnet=1.1.1.1

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=uid&uid=24a8774d-24c1-4b3a-aae9-3c272a2b5191

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=uid&uid=24a8774d-24c1-4b3a-aae9-3c272a2b5191&device_id=4

Usage Example
URLhttps://192.168.1.1/securetrack/api/network_objects/search?filter=text&name=Access_Role&identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"count\": 1,
        \"total\": 1,
        \"network_object\": {
            \"@xsi.type\": \"identityAwarenessDTO\",
            \"id\": 169197,
            \"name\": \"Access_Role_aaa\",
            \"display_name\": \"Access_Role_aaa\",
            \"class_name\": \"access_role\",
            \"type\": \"identity_awareness\",
            \"global\": false,
            \"device_id\": 158,
            \"comment\": \"\",
            \"uid\": \"{9EDC2607-6BEC-43D7-A99D-B522BA694ADA}\",
            \"implicit\": false,
            \"overrides\": false,
            \"type_on_device\": \"\",
            \"networks\": {
                \"network\": {
                    \"@xsi.type\": \"basicNetworkObjectDTO\",
                    \"id\": 168419,
                    \"name\": \"Any\",
                    \"display_name\": \"Any\",
                    \"class_name\": \"any_object\",
                    \"type\": \"basic\",
                    \"global\": false,
                    \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                    \"implicit\": false,
                    \"overrides\": false
                }
            },
            \"users\": {
                \"user\": {
                    \"id\": 14317,
                    \"name\": \"ad_group_aaa\",
                    \"display_name\": \"aaa\",
                    \"class_name\": \"ad_group\",
                    \"global\": false,
                    \"comment\": \"\",
                    \"uid\": \"{5D16859C-0256-4673-A402-4254588B8F40}\",
                    \"dn\": \"CN=aaa,OU=SC_Users,DC=test,DC=com\"
                }
            }
        }
    }
}


Response Messages:
400: The typeOnDevice value is not valid.Use edl_ip_list as value to search EDL groups."},"response":[]},{"name":"Get network groups containing specified network object","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/network_objects/{{id}}/groups","description":"Returns groups that contain the specified network object


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the network object.

Usage Example
https://192.168.1.1/securetrack/api/network_objects/69577/groups
"},"response":[]},{"name":"Get network objects by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/network_objects","description":"Fetches list of network objects from specific revision
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.
The show_members parameter is only relevant if type=group.
If type=group, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.

Parameters:
context: Global MSSP context [optional]
id: Revision id
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
name: Network object name [optional]
type: Network object type [optional]
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
contains_ip: Get only network objects containing this IP [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]
typeOnDevice: Get EDL groups [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/779/network_objects

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?get_total=true
OUTPUT {
    \"network_objects\": {
    \"count\": 1,
    \"total\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"hostNetworkObjectDTO\",
                \"id\": 499226,
                \"name\": \"1.1.1.2 not shared\",
                \"display_name\": \"1.1.1.2 not shared\",
                \"class_name\": \"host_plain\",
                \"type\": \"host\",
                \"comment\": \"\",
                \"uid\": \"{EFE8E61B-EE2A-2F55-4C5C-56508661EAA7}\",
                \"implicit\": false,
                \"management_domain\": \"Shared\",
                \"overrides\": false,
                \"ip\": \"1.1.1.2\"
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/779/network_objects?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
    \"count\": 1,
        \"network_object\": [
            {
                \"@xsi.type\": \"identityAwarenessDTO\",
                \"id\": 169183,
                \"name\": \"Access role 1\",
                \"display_name\": \"Access role 1\",
                \"class_name\": \"access_role\",
                \"type\": \"identity_awareness\",
                \"global\": true,
                \"comment\": \"\",
                \"uid\": \"{1E4C35A0-1FE4-4101-8A38-FDE656BCDCFB}\",
                \"implicit\": false,
                \"overrides\": false,
                \"type_on_device\": \"\",
                \"networks\": {
                    \"network\": {
                        \"@xsi.type\": \"basicNetworkObjectDTO\",
                        \"id\": 168419,
                        \"name\": \"Any\",
                        \"display_name\": \"Any\",
                        \"class_name\": \"any_object\",
                        \"type\": \"basic\",
                        \"global\": false,
                        \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                        \"implicit\": false,
                        \"overrides\": false
                    }
                },
                \"users\": {
                    \"user\": {
                        \"id\": 14346,
                        \"name\": \"all identified\",
                        \"display_name\": \"all identified\",
                        \"class_name\": \"all_identified\",
                        \"global\": false,
                        \"comment\": \"\",
                        \"uid\": \"{17A972AC-4B4A-4715-859F-867128707F59}\",
                        \"dn\": \"\"
                    }
                }
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/31/network_objects?type=group&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 105934,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/31/network_objects?typeOnDevice=edl_ip_list&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 1,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 123123,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"type_on_device\": edl_ip_list,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Response Messages:
400: The typeOnDevice value is not valid"},"response":[]}]},{"name":"Network Topology","item":[{"name":"Get generic Route","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/{{routeId}}","description":"Get a generic Route by Id.

Parameters:
routeId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/route/30
OUTPUT{
    GenericRoute: {
        id: 30,
        mgmtId: 2,
        destination: \"222.100.10.22\",
        mask: \"255.255.0.0\",
        interfaceName: \"catch22\",
        nextHop: \"100.100.10.10\",
        nextHopType: \"IP\",
        vrf: \"V102-YO\"
    }
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Generic Route Not Found.
500: General error occurred."},"response":[]},{"name":"Delete generic Route","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/{{routeId}}","description":"Delete a generic Route by Id.

Parameters:
routeId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/route/5\n

Response Messages:
204: No Content.
400: Bad Request.
401: Access is denied.
404: Generic Route Not Found.
500: General error occurred."},"response":[]},{"name":"Get topology routing tables for a given device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"mgmtId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/topology_routes","description":"The returned routing tables are taken from the topology data and will include only devices that are topology enabled.
When adding a device, the user can can choose whether to use dynamic or static topology for the device,
this choice will determine which kind of data is stored in the topology graph and returned by this API.

The parameter mgmtId should be a cluster or a gateway, not a management server.
You may provide a generic device Id (see generic_devices API under 'Monitored Devices' category) -
in this case make sure you set 'is_generic' parameter to 'true'

Parameters:
mgmtId: Management Id or Generic Device Id to query
is_generic: Should be set to 'true' if the provided mgmtId is related to generic device [optional]
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query from starting page, allowable type is numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_routes?mgmtId=10

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_routes?mgmtId=1&is_generic=true
"},"response":[]},{"name":"Delete Ignored Interfaces.","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/ignoredinterface/mgmt/{{mgmtId}}","description":"Delete Ignored Interfaces by management id.

Parameters:
mgmtId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/ignoredinterface/mgmt/10\n

Response Messages:
200: 2 entries deleted where mgmtId = 10
400: Bad Request.
401: Access is denied.
404: Management Id 10 not found.
500: General error occurred."},"response":[]},{"name":"Get Ignored Interfaces.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/ignoredinterface/mgmt/{{mgmtId}}","description":"Get Ignored Interfaces by management id.

Parameters:
mgmtId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/ignoredinterface/mgmt/10
OUTPUT{
    IgnoredInterfaces: [
        {
            interfaceName: \"eth2\",
            mgmtId: 10,
            ip: \"0.0.0.0\"
        },
        {
            interfaceName: \"loopback100\",
            mgmtId: 10,
            ip: \"34.34.34.34\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
500: General error occurred."},"response":[]},{"name":"Get cloud information","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"suggested_clouds\": {\n\t\t\"count\": 1,\n\t\t\"total\": 1,\n\t\t\"cloud\": {\n\t\t\t\"management_name\": \"FW1\",\n\t\t\t\"management_id\": 20,\n\t\t\t\"cloud_name\": \"Cloud 10.100.0.1\",\n\t\t\t\"cloud_id\": 120,\n\t\t\t\"vertex_id\": 250,\n\t\t\t\"ip\": \"10.100.0.1\",\n\t\t\t\"routes_count\": 5,\n\t\t\t\"is_parent\": false\n\t\t}\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/cloud_suggestions/{{cloud_id}}","description":"Returns information about a specific cloud in the topology.
This API includes the ID of the cloud, the number of routes that point to the cloud, and the relevant devices (including the management_id) that have routes that point to the cloud.
This information can be used to identify missing devices that may need to be added to the topology or to identify clouds that are candidates for being joined.

Parameters:
cloud_id: cloud id
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/cloud_suggestions/120
BODY{
    \"suggested_clouds\": {
        \"count\": 1,
        \"total\": 1,
        \"cloud\": {
            \"management_name\": \"FW1\",
            \"management_id\": 20,
            \"cloud_name\": \"Cloud 10.100.0.1\",
            \"cloud_id\": 120,
            \"vertex_id\": 250,
            \"ip\": \"10.100.0.1\",
            \"routes_count\": 5,
            \"is_parent\": false
        }
    }
}


Response Messages:
202: Accepted
401: User is not permitted to access the specified domain"},"response":[]},{"name":"Add generic device to Topology model","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"configuration_file"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/","description":"Upload a configuration file that will be used to add a generic device to the Topology model.
The context field is the domain ID to which the generic device is added: If not provided, the device is added to the global domain.
configuration_file must include a valid generic device configuration.
The specified path must point to a file on the computer being sue to make the REST API call.
If update update_topology = true, then the Topology model will be updated immediately after the device is added.
For maximum efficiency, if you are adding multiple generic devices in consecutive API calls, you can set update_topology = false on all API calls except for the last one. On the last call, set update_toplogy = true.Default value for update_topology = true.
For more information on input file formats, refer to Knowledge Center topic 'Adding and Updating a Generic Device'.

Parameters:
body: Generic device to be added
configuration_file: Configuration File for generic device
update_topology: Synchronize And Update Topology [optional]

Usage Example
curl -X POST -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F 'device_data={\"generic_device\":{\"name\": \"my_generic_device\", \"customer_id\": 1}};type=application/json' -F \"configuration_file=@/tmp/config.txt;type=application/octet-stream\" -F \"update_topology=true\" https://192.168.1.1/securetrack/api/generic_devices\n

Response Messages:
201: The generic device was created successfully
401: User is not permitted to access the specified domain
400: Failed to create generic device "},"response":[]},{"name":"Get generic devices that are configured in ST","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/","description":"Returns a list of the generic devices included in all the domains that the user has permission to.
Use context and/or name optional parameters to get more specific results.
To get context optional parameter, you can call /domains/ API and use the id included within the returned domain DTO.

Parameters:
context: Global MSSP context [optional]
name: Generic device name [optional]

Usage Example
https://192.168.1.1/securetrack/api/generic_devices
"},"response":[]},{"name":"Get cloud information","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"suggested_clouds\": {\n\t\t\"count\": 2,\n\t\t\"total\": 2,\n\t\t\"cloud\": [\n\t\t\t{\n\t\t\t\t\"management_name\": \"FW1\",\n\t\t\t\t\"management_id\": 20,\n\t\t\t\t\"cloud_name\": \"Cloud 10.100.0.1\",\n\t\t\t\t\"cloud_id\": 120,\n\t\t\t\t\"vertex_id\": 250,\n\t\t\t\t\"ip\": \"10.100.0.1\",\n\t\t\t\t\"routes_count\": 5,\n\t\t\t\t\"is_parent\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"management_name\": \"FW2\",\n\t\t\t\t\"management_id\": 21,\n\t\t\t\t\"cloud_name\": \"Cloud 172.16.0.1\",\n\t\t\t\t\"cloud_id\": 125,\n\t\t\t\t\"vertex_id\": 270,\n\t\t\t\t\"ip\": \"172.16.0.1\",\n\t\t\t\t\"routes_count\": 7,\n\t\t\t\t\"is_parent\": false,\n\t\t\t\t\"parent_vertex_id\": 40\n\t\t\t\t\"parent_cloud_id\": 45\n\t\t\t\t\"parent_cloud_name\": \"Cloud 172.16.0.1\",\n\t\t\t}\n\t\t]\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/cloud_suggestions","description":"Returns information about all clouds in the topology.
This API includes the ID of the cloud, the number of routes that point to the cloud, and the relevant devices (including the management_id) that have routes that point to the cloud.
This information can be used to identify missing devices that may need to be added to the topology or to identify clouds that are candidates for being joined.

Parameters:
context: Global MSSP context [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/cloud_suggestions
BODY{
    \"suggested_clouds\": {
        \"count\": 2,
        \"total\": 2,
        \"cloud\": [
            {
                \"management_name\": \"FW1\",
                \"management_id\": 20,
                \"cloud_name\": \"Cloud 10.100.0.1\",
                \"cloud_id\": 120,
                \"vertex_id\": 250,
                \"ip\": \"10.100.0.1\",
                \"routes_count\": 5,
                \"is_parent\": false
            },
            {
                \"management_name\": \"FW2\",
                \"management_id\": 21,
                \"cloud_name\": \"Cloud 172.16.0.1\",
                \"cloud_id\": 125,
                \"vertex_id\": 270,
                \"ip\": \"172.16.0.1\",
                \"routes_count\": 7,
                \"is_parent\": false,
                \"parent_vertex_id\": 40
                \"parent_cloud_id\": 45
                \"parent_cloud_name\": \"Cloud 172.16.0.1\",
            }
        ]
    }
}


Response Messages:
202: Accepted
401: User is not permitted to access the specified domain"},"response":[]},{"name":"Create generic Vpns","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"GenericVpns\": [\n\t{\n\t\t\"generic\": true,\n\t\t\"deviceId\": 3,\n\t\t\"interfaceName\": \"33\",\n\t\t\"vpnName\": null,\n\t\t\"tunnelSourceIpAddr\": \"3.3.3.33\",\n\t\t\"tunnelDestIpAddr\": \"1.1.1.11\"\n\t},\n\t{\n\t\t\"generic\": false,\n\t\t\"deviceId\": 1,\n\t\t\"interfaceName\": \"111\",\n\t\t\"vpnName\": null,\n\t\t\"tunnelSourceIpAddr\": \"1.1.1.11\",\n\t\t\"tunnelDestIpAddr\": \"3.3.3.33\"\n\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/","description":"Create generic Vpns.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/vpn
BODY{
    \"GenericVpns\": [
    {
        \"generic\": true,
        \"deviceId\": 3,
        \"interfaceName\": \"33\",
        \"vpnName\": null,
        \"tunnelSourceIpAddr\": \"3.3.3.33\",
        \"tunnelDestIpAddr\": \"1.1.1.11\"
    },
    {
        \"generic\": false,
        \"deviceId\": 1,
        \"interfaceName\": \"111\",
        \"vpnName\": null,
        \"tunnelSourceIpAddr\": \"1.1.1.11\",
        \"tunnelDestIpAddr\": \"3.3.3.33\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred."},"response":[]},{"name":"Update generic Vpns","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"GenericVpns\": [\n\t{\n\t\t\"id\": 24,\n\t\t\"generic\": true,\n\t\t\"deviceId\": 3,\n\t\t\"interfaceName\": \"new33\",\n\t\t\"vpnName\": null,\n\t\t\"tunnelSourceIpAddr\": \"3.3.3.33\",\n\t\t\"tunnelDestIpAddr\": \"1.1.1.11\"\n\t},\n\t{\n\t\t\"id\": 25,\n\t\t\"generic\": false,\n\t\t\"deviceId\": 1,\n\t\t\"interfaceName\": \"new111\",\n\t\t\"vpnName\": null,\n\t\t\"tunnelSourceIpAddr\": \"1.1.1.11\",\n\t\t\"tunnelDestIpAddr\": \"3.3.3.33\"\n\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/","description":"Update generic Vpns.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/vpn
BODY{
    \"GenericVpns\": [
    {
        \"id\": 24,
        \"generic\": true,
        \"deviceId\": 3,
        \"interfaceName\": \"new33\",
        \"vpnName\": null,
        \"tunnelSourceIpAddr\": \"3.3.3.33\",
        \"tunnelDestIpAddr\": \"1.1.1.11\"
    },
    {
        \"id\": 25,
        \"generic\": false,
        \"deviceId\": 1,
        \"interfaceName\": \"new111\",
        \"vpnName\": null,
        \"tunnelSourceIpAddr\": \"1.1.1.11\",
        \"tunnelDestIpAddr\": \"3.3.3.33\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Vpn/Management/GenericDevice Not Found.
500: General error occurred."},"response":[]},{"name":"Get Transparent Firewalls","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw/device/{{deviceId}}","description":"Get Transparent Firewalls for participated managed/generic DeviceId

Parameters:
deviceId [optional]
generic [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/transparentfw/device/9?generic=false
OUTPUT{
    TransparentFirewalls: [
        {
            id: 17,
            outputL3DeviceId: 22,
            outputL3IsGenericDevice: false,
            outputL3InterfaceName: \"FastEthernet0/0\",
            layer2DeviceId: 9,
            inputL2InterfaceName: \"inside\",
            outputL2InterfaceName: \"outside\",
            inputL3DeviceId: 1,
            inputL3IsGenericDevice: true,
            inputL3InterfaceName: \"interface2\"
        },
        {
            id: 23,
            outputL3DeviceId: 23,
            outputL3IsGenericDevice: false,
            outputL3InterfaceName: \"FastEthernet2/0\",
            layer2DeviceId: 9,
            inputL2InterfaceName: \"inside\",
            outputL2InterfaceName: \"outside\",
            inputL3DeviceId: 17,
            inputL3IsGenericDevice: false,
            inputL3InterfaceName: \"mgmt\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred."},"response":[]},{"name":"Delete Transparent Firewalls.","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw/device/{{deviceId}}","description":"Delete Transparent Firewalls for participated layer 2 deviceId

Parameters:
deviceId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/transparentfw/device/9\n

Response Messages:
200: 4 entries deleted where layer2 deviceId = 9
400: Bad Request.
401: Access is denied.
404: DeviceId 9 not found.
500: General error occurred."},"response":[]},{"name":"Delete generic Vpns","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/device/{{deviceId}}","description":"Delete all generic Vpns from management/genericDevice Id.

Parameters:
deviceId [optional]
generic [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/vpn/device/2?generic=false\n

Response Messages:
200: 4 Generic Vpns were deleted from mgmtId 2.
400: Bad Request.
401: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred."},"response":[]},{"name":"Get generic Vpns","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/device/{{deviceId}}","description":"Get generic Vpns of management/genericDevice Id.

Parameters:
deviceId [optional]
generic [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/vpn/device/3?generic=true
OUTPUT{
    GenericVpns: [
    {
        id: 17,
        generic: true,
        deviceId: 3,
        interfaceName: \"777\",
        tunnelSourceIpAddr: \"1.1.1.177\",
        tunnelDestIpAddr: \"1.1.1.188\"
    },
    {
        id: 22,
        generic: true,
        deviceId: 3,
        interfaceName: \"111\",
        tunnelSourceIpAddr: \"1.1.1.188\",
        tunnelDestIpAddr: \"1.1.1.177\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred."},"response":[]},{"name":"Get topology subnets","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/subnets","description":"Returns a list of the topology subnets for all the domains for which the user has permission to access.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
Use the optional name parameter to restrict the results to topology subnet names that match the search criteria provided, as follows:
1. If you provide only a mask, then an exact match search is done on the mask portion of the name
e.g. if name=/2, the results will include 1.2.3.4/2, but not 1.2.3.4/22
2. If you provide only a partial or complete IP address, then a contains search is done in the IPv4 block portion of the name
e.g. name=32, the results will include 192.168.205.32/24 and 55.192.32.22/16, but will not include 55.168.205.5/32
3. If you provide both an IPv4 address (either partial or complete) and a mask, then an exact match search is done
e.g. if name=23.4/2, then the results will include 192.168.23.4/2, but will not include 192.168.23.4/23 or 23.4.192.168/2

The default pagination is start=0 and count=50.

Parameters:
context: Global MSSP context [optional]
name: Subnet name [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/subnets?name=10.27
OUTPUT{
    \"topology_subnets\": {
        \"count\": 4,
        \"total\": 4,
        \"subnets\": [
            {
                \"id\": 615,
                \"name\": \"10.27.122.20/32\",
                \"ip\": \"10.27.122.20\",
                \"mask\": \"255.255.255.255\"
            },
            {
                \"id\": 616,
                \"name\": \"10.27.122.60/32\",
                \"ip\": \"10.27.122.60\",
                \"mask\": \"255.255.255.255\"
            },
            {
                \"id\": 619,
                \"name\": \"10.27.122.0/30\",
                \"ip\": \"10.27.122.0\",
                \"mask\": \"255.255.255.252\"
            },
            {
                \"id\": 620,
                \"name\": \"10.27.122.4/30\",
                \"ip\": \"10.27.122.4\",
                \"mask\": \"255.255.255.252\"
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/subnets?name=144/30
OUTPUT{
    \"topology_subnets\": {
        \"count\": 2,
        \"total\": 2,
        \"subnets\": [
            {
                \"id\": 773,
                \"name\": \"10.13.64.144/30\",
                \"ip\": \"10.13.64.144\",
                \"mask\": \"255.255.255.252\"
            },
            {
                \"id\": 825,
                \"name\": \"10.15.64.144/30\",
                \"ip\": \"10.15.64.144\",
                \"mask\": \"255.255.255.252\"
            }
        ]
    }
}


Response Messages:
401: Access is denied
401: Only users with ‘Super admin’ permissions can access Global domain map
401: You do not have access permission to domain id: domainId"},"response":[]},{"name":"Delete Transparent Firewall","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw/{{layer2DataId}}","description":"Delete Transparent Firewall by Id.

Parameters:
layer2DataId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/transparentfw/17\n

Response Messages:
200: layer2DataId 17 deleted.
400: Bad Request.
401: Access is denied.
404: Layer2Data Id 17 not found.
500: General error occurred."},"response":[]},{"name":"Create Join Cloud","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \n\t\"JoinCloud\" : \n\t{\n\t\t\"name\" : \"Yami\",\n\t\t\"clouds\" : [1, 2]\n\t}\n} "},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/join/clouds/","description":"Create Join Cloud.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/join/clouds
BODY{
    \"JoinCloud\" :
    {
        \"name\" : \"Yami\",
        \"clouds\" : [1, 2]
    }
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Cloud Not Found.
500: General error occurred."},"response":[]},{"name":"Update Join Cloud","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \n\t\"JoinCloud\" : \n\t{\n\t\t\"id\" : 67,\n\t\t\"name\" : \"Yamile\",\n\t\t\"clouds\" : [1, 2, 57]\n\t}\n} "},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/join/clouds/","description":"Update Join Clouds.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/join/clouds
BODY{
    \"JoinCloud\" :
    {
        \"id\" : 67,
        \"name\" : \"Yamile\",
        \"clouds\" : [1, 2, 57]
    }
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Cloud Not Found.
500: General error occurred."},"response":[]},{"name":"Get path image for specified traffic","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"src"},{"value":null,"type":"text","key":"dst"},{"value":null,"type":"text","key":"service"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/path_image","description":"Returns an image containing one or more paths for the specified traffic.
src and dst parameters may contain multiple, comma separated values.
Service parameter can be a port (for example, “tcp:80”, “any”) or an application (for example, “Skype”, “Facebook”).
Application names are case sensitive.
Service parameter can also be a combination of ports and applications, for example “tcp:80, Skype, Facebook”
If sourceDomainIdTag is provided, the path starting points will be restricted to the specified domain ID. sourceDomainIdTag is valid only if overlapping IP mode is enabled.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is valid only if MSSP mode is enabled.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.
displayIncompletePaths parameter default value is false, if this parameter is set to true -
all nodes on the path will be displayed, even if the node cannot reach the destination, or if the source and destination are the same.
displayBlockedStatus parameter default value is false, if this parameter is set to true -
blocked traffic icons will be displayed next to devices blocking the traffic.
simulateNat parameter default value is true if this parameter is set to false - NAT simulation will not be used when calculating the path.
lastInstall parameter default value is true, which means simulation would use last installed policies. If this parameter is set to false - simulation would use last saved policies.
This API cannot be executed more than 10 times in parallel.

Parameters:
context: Global MSSP context [optional]
src: Source address/addresses
dst: Destination address/addresses
service: Service/services
sourceDomainIdTag: Path starting point Domain Id [optional]
displayIncompletePaths: Display incomplete paths [optional]
displayBlockedStatus: Display blocked traffic status icons [optional]
simulateNat: Simulate NAT [optional]
lastInstall: Last Installed [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/path_image?src=10.10.10.1&dst=3.3.3.3:32&service=any

Usage Example
https://192.168.1.1/securetrack/api/topology/path_image?src=10.10.10.1&dst=3.3.3.3:32&service=Facebook,tcp:80
"},"response":[]},{"name":"Delete generic Vpn","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/{{vpnId}}","description":"Delete a generic Vpn by Id.

Parameters:
vpnId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/vpn/5\n

Response Messages:
204: No Content.
400: Bad Request.
401: Access is denied.
404: Generic Vpn Not Found.
500: General error occurred."},"response":[]},{"name":"Get generic Vpn","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/{{vpnId}}","description":"Get a generic Vpn by Id.

Parameters:
vpnId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/vpn/18
OUTPUT{
    GenericVpn: {
        id: 18,
        generic: false,
        deviceId: 2,
        interfaceName: \"777\",
        tunnelSourceIpAddr: \"1.1.1.77\",
        tunnelDestIpAddr: \"1.1.1.88\"
    }
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Generic Vpn Not Found.
500: General error occurred."},"response":[]},{"name":"Update generic Interfaces","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"GenericInterfaces\": [\n\t{\n\t\t\"id\": 204,\n\t\t\"mgmtId\": 1,\n\t\t\"name\": \"NewBob1\",\n\t\t\"ip\": \"100.100.45.55\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"vrf\": \"V101-LV\",\n\t\t\"mpls\": false,\n\t\t\"unnumbered\": false,\n\t\t\"type\": null\n\t},\n\t{\n\t\t\"id\": 205,\n\t\t\"mgmtId\": 2,\n\t\t\"name\": \"NewBob2\",\n\t\t\"ip\": \"100.100.45.55\",\n\t\t\"mask\": \"255.255.255.0\",\n\t\t\"vrf\": \"V101-LV\",\n\t\t\"mpls\": false,\n\t\t\"unnumbered\": false,\n\t\t\"type\": \"external\"\n\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface","description":"Update generic Interfaces.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interface
BODY{
    \"GenericInterfaces\": [
    {
        \"id\": 204,
        \"mgmtId\": 1,
        \"name\": \"NewBob1\",
        \"ip\": \"100.100.45.55\",
        \"mask\": \"255.255.0.0\",
        \"vrf\": \"V101-LV\",
        \"mpls\": false,
        \"unnumbered\": false,
        \"type\": null
    },
    {
        \"id\": 205,
        \"mgmtId\": 2,
        \"name\": \"NewBob2\",
        \"ip\": \"100.100.45.55\",
        \"mask\": \"255.255.255.0\",
        \"vrf\": \"V101-LV\",
        \"mpls\": false,
        \"unnumbered\": false,
        \"type\": \"external\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Interface/Management Not Found.
500: General error occurred."},"response":[]},{"name":"Create generic Interfaces","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"GenericInterfaces\": [\n\t{\n\t\t\"mgmtId\": 1,\n\t\t\"name\": \"Bob1\",\n\t\t\"ip\": \"100.100.45.55\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"vrf\": \"V101-PA\",\n\t\t\"mpls\": false,\n\t\t\"unnumbered\": false,\n\t\t\"type\": \"external\"\n\t},\n\t{\n\t\t\"mgmtId\": 2,\n\t\t\"name\": \"Bob2\",\n\t\t\"ip\": \"100.100.45.66\",\n\t\t\"mask\": \"255.255.255.0\",\n\t\t\"vrf\": \"V101-BA\",\n\t\t\"mpls\": false,\n\t\t\"unnumbered\": false,\n\t\t\"type\": \"external\"\n\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface","description":"Create generic Interfaces.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interface
BODY{
    \"GenericInterfaces\": [
    {
        \"mgmtId\": 1,
        \"name\": \"Bob1\",
        \"ip\": \"100.100.45.55\",
        \"mask\": \"255.255.0.0\",
        \"vrf\": \"V101-PA\",
        \"mpls\": false,
        \"unnumbered\": false,
        \"type\": \"external\"
    },
    {
        \"mgmtId\": 2,
        \"name\": \"Bob2\",
        \"ip\": \"100.100.45.66\",
        \"mask\": \"255.255.255.0\",
        \"vrf\": \"V101-BA\",
        \"mpls\": false,
        \"unnumbered\": false,
        \"type\": \"external\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Management Not Found.
500: General error occurred."},"response":[]},{"name":"Get generic Interfaces","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface/mgmt/{{mgmtId}}","description":"Get generic Interfaces of management Id.

Parameters:
mgmtId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interface/mgmt/1
OUTPUT{
    GenericInterfaces: [
    {
        id: 206,
        mgmtId: 1,
        name: \"newApo3\",
        ip: \"100.103.33.33\",
        mask: \"255.255.255.0\",
        vrf: \"V101-PA\",
        mpls: false,
        unnumbered: false,
        type: \"external\"
    },
    {
        id: 208,
        mgmtId: 1,
        name: \"newApo4\",
        ip: \"100.103.33.34\",
        mask: \"255.255.255.0\",
        vrf: \"V101-PA\",
        mpls: false,
        unnumbered: false,
        type: \"internal\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Management Not Found.
500: General error occurred."},"response":[]},{"name":"Delete generic Interfaces","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface/mgmt/{{mgmtId}}","description":"Delete all generic Interfaces from management Id.

Parameters:
mgmtId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/interface/mgmt/2\n

Response Messages:
200: 11 Generic Interfaces were deleted from mgmtId 2.
400: Bad Request.
401: Access is denied.
404: Management Not Found.
500: General error occurred."},"response":[]},{"name":"Create Ignored Interfaces.","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"IgnoredInterfaces\": \n\t[\n\t\t{\n\t\t\t\"interfaceName\" : \"eth2\",\n\t\t\t\"mgmtId\" : 10,\n\t\t\t\"ip\" : \"0.0.0.0\"\n\t\t},\n\t\t{\n\t\t\t\"interfaceName\" : \"loopback100\",\n\t\t\t\"mgmtId\" : 10,\n\t\t\t\"ip\" : \"34.34.34.34\"\n\t\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/ignoredinterface","description":"Create Ignored Interfaces.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/ignoredinterface
BODY{
    \"IgnoredInterfaces\":
    [
        {
            \"interfaceName\" : \"eth2\",
            \"mgmtId\" : 10,
            \"ip\" : \"0.0.0.0\"
        },
        {
            \"interfaceName\" : \"loopback100\",
            \"mgmtId\" : 10,
            \"ip\" : \"34.34.34.34\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Management Id 10 not found.
500: General error occurred."},"response":[]},{"name":"Create manual Interface CustomerTags","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"InterfaceCustomerTags\": \n\t[\n\t\t{\n\t\t\t\"generic\": false,\n\t\t\t\"deviceId\": 5,\n\t\t\t\"interfaceName\": \"port4\",\n\t\t\t\"customerId\": 2\n\t\t},\n\t\t{\n\t\t\t\"generic\": false,\n\t\t\t\"deviceId\": 6,\n\t\t\t\"interfaceName\": \"port3\",\n\t\t\t\"customerId\": 3\n\t\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/","description":"Create manual Interface CustomerTags.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interfacecustomer
BODY{
    \"InterfaceCustomerTags\":
    [
        {
            \"generic\": false,
            \"deviceId\": 5,
            \"interfaceName\": \"port4\",
            \"customerId\": 2
        },
        {
            \"generic\": false,
            \"deviceId\": 6,
            \"interfaceName\": \"port3\",
            \"customerId\": 3
        }
    ]
}


Response Messages:
200: OK.
400: Interface CustomerTag already exist for deviceId-InterfaceName/Interface not found on deviceId
401: Access is denied.
404: Management/GenericDevice Not Found./Customer Id not found.
500: General error occurred."},"response":[]},{"name":"Update manual Interface CustomerTags","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"InterfaceCustomerTags\": \n\t[\n\t\t{\n\t\t\t\"id\": 73,\n\t\t\t\"generic\": false,\n\t\t\t\"deviceId\": 5,\n\t\t\t\"interfaceName\": \"port5\",\n\t\t\t\"customerId\": 2\n\t\t},\n\t\t{\n\t\t\t\"id\": 74,\n\t\t\t\"generic\": false,\n\t\t\t\"deviceId\": 5,\n\t\t\t\"interfaceName\": \"port3\",\n\t\t\t\"customerId\": 3\n\t\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/","description":"Update manual Interface CustomerTags.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interfacecustomer
BODY{
    \"InterfaceCustomerTags\":
    [
        {
            \"id\": 73,
            \"generic\": false,
            \"deviceId\": 5,
            \"interfaceName\": \"port5\",
            \"customerId\": 2
        },
        {
            \"id\": 74,
            \"generic\": false,
            \"deviceId\": 5,
            \"interfaceName\": \"port3\",
            \"customerId\": 3
        }
    ]
}


Response Messages:
200: OK.
400: Interface CustomerTag already exist for deviceId-InterfaceName/Interface not found on deviceId
401: Access is denied.
404: Management/GenericDevice Not Found./Customer Id not found.
500: General error occurred."},"response":[]},{"name":"Delete manual Interface CustomerTag","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/{{interfaceCustomerId}}","description":"Delete a manual Interface CustomerTag by Id.

Parameters:
interfaceCustomerId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/interfacecustomer/66\n

Response Messages:
204: No Content.
400: Bad Request.
401: Access is denied.
404: InterfaceCustomer Id 66 not found
500: General error occurred."},"response":[]},{"name":"Get manual Interface CustomerTag","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/{{interfaceCustomerId}}","description":"Get manual Interface CustomerTag by Id.

Parameters:
interfaceCustomerId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interfacecustomer/74
OUTPUT{
    InterfaceCustomerTag: {
        id: 74,
        generic: false,
        deviceId: 5,
        interfaceName: \"port4.1\",
        customerId: 3
    }
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: InterfaceCustomer Id 74 not found.
500: General error occurred."},"response":[]},{"name":"Get manual Interface CustomerTags","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/device/{{deviceId}}","description":"Get manual Interface CustomerTags of management/genericDevice Id.

Parameters:
deviceId [optional]
generic [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interfacecustomer/device/5?generic=false
OUTPUT{
    InterfaceCustomerTags: [
        {
            id: 73,
            generic: false,
            deviceId: 5,
            interfaceName: \"port4\",
            customerId: 2
        },
        {
            id: 74,
            generic: false,
            deviceId: 5,
            interfaceName: \"port4.1\",
            customerId: 3
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred."},"response":[]},{"name":"Delete manual Interface CustomerTags","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/device/{{deviceId}}","description":"Delete all manual Interface CustomerTags from management/genericDevice Id.

Parameters:
deviceId [optional]
generic [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/interfacecustomer/device/6?generic=false\n

Response Messages:
200: 2 Interface Customers were deleted from deviceId 6.
400: Bad Request.
401: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred."},"response":[]},{"name":"Create generic Routes","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"GenericRoutes\": [\n\t{\n\t\t\"mgmtId\": 1,\n\t\t\"destination\": \"111.100.10.11\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"interfaceName\": \"YOLO3\",\n\t\t\"nextHop\": \"100.100.10.10\",\n\t\t\"nextHopType\": \"IP\",\n\t\t\"vrf\": \"V103-KO\"\n\t},\n\t{\n\t\t\"mgmtId\": 2,\n\t\t\"destination\": \"222.100.10.22\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"interfaceName\": \"catch22\",\n\t\t\"nextHop\": \"100.100.10.10\",\n\t\t\"nextHopType\": \"IP\",\n\t\t\"vrf\": \"V103-KO\"\n\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/","description":"Create generic Routes.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/route
BODY{
    \"GenericRoutes\": [
    {
        \"mgmtId\": 1,
        \"destination\": \"111.100.10.11\",
        \"mask\": \"255.255.0.0\",
        \"interfaceName\": \"YOLO3\",
        \"nextHop\": \"100.100.10.10\",
        \"nextHopType\": \"IP\",
        \"vrf\": \"V103-KO\"
    },
    {
        \"mgmtId\": 2,
        \"destination\": \"222.100.10.22\",
        \"mask\": \"255.255.0.0\",
        \"interfaceName\": \"catch22\",
        \"nextHop\": \"100.100.10.10\",
        \"nextHopType\": \"IP\",
        \"vrf\": \"V103-KO\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Management Not Found.
500: General error occurred."},"response":[]},{"name":"Update generic Routes","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"GenericRoutes\": [\n\t{\n\t\t\"id\": 29,\n\t\t\"mgmtId\": 3,\n\t\t\"destination\": \"111.100.10.11\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"interfaceName\": \"YOLO3\",\n\t\t\"nextHop\": \"100.100.10.10\",\n\t\t\"nextHopType\": \"IP\",\n\t\t\"vrf\": \"V103-KO\"\n\t},\n\t{\n\t\t\"id\": 30,\n\t\t\"mgmtId\": 3,\n\t\t\"destination\": \"222.100.10.22\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"interfaceName\": \"catch22\",\n\t\t\"nextHop\": \"100.100.10.10\",\n\t\t\"nextHopType\": \"IP\",\n\t\t\"vrf\": \"V103-KO\"\n\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/","description":"Update generic Routes.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/route
BODY{
    \"GenericRoutes\": [
    {
        \"id\": 29,
        \"mgmtId\": 3,
        \"destination\": \"111.100.10.11\",
        \"mask\": \"255.255.0.0\",
        \"interfaceName\": \"YOLO3\",
        \"nextHop\": \"100.100.10.10\",
        \"nextHopType\": \"IP\",
        \"vrf\": \"V103-KO\"
    },
    {
        \"id\": 30,
        \"mgmtId\": 3,
        \"destination\": \"222.100.10.22\",
        \"mask\": \"255.255.0.0\",
        \"interfaceName\": \"catch22\",
        \"nextHop\": \"100.100.10.10\",
        \"nextHopType\": \"IP\",
        \"vrf\": \"V103-KO\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Interface/Management Not Found.
500: General error occurred."},"response":[]},{"name":"Get Cloud Internal Networks","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/cloud_internal_networks/{{id}}","description":"Returns the internal networks for the specified Cloud management id.
This API requires 'Super admin' privileges.

Parameters:
id: Cloud management id

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/cloud_internal_networks/20
OUTPUT{
    \"network_list\":
    {
        \"count\": 3,
        \"total\": 3,
        \"network\":
        {
            \"ip\": \"10.27.122.20\",
            \"mask\": \"255.255.255.255\"
        },
        \"network\":
        {
            \"ip\": \"10.27.122.60\",
            \"mask\": \"255.255.255.255\"
        },
        \"network\":
        {
            \"ip\": \"10.27.122.4\",
            \"mask\": \"255.255.255.252\"
        }
    }
}


Response Messages:
401: Access is denied
401: You do not have access permission to the domain for NSX with id ID
401: Device ID specified is not supported
404: The specified device ID was not found
404: The specified device ID was not found in Topology"},"response":[]},{"name":"Synchronize the Topology model","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/synchronize","description":"Invoke of the Topology Model Synchronization.
full_sync=false - Builds the topology model from the information stored in the Tufin database.
full_sync=true - Retrieves the current data from devices and builds the topology model.
Default value for full_sync = false.

Parameters:
full_sync: Perform full sync [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/synchronize

Usage Example
https://192.168.1.1/securetrack/api/topology/synchronize?full_sync=true

Response Messages:
200: The topology synchronization was invoked successfully.
401: Access is denied
500: Error Synchronizing Topology Model"},"response":[]},{"name":"Create Transparent Firewalls","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"TransparentFirewalls\": \n\t[\n\t {\n\t\t\t\"outputL3DeviceId\" : 22,\n\t\t\t\"outputL3IsGenericDevice\" : false,\n\t\t\t\"outputL3InterfaceName\" : \"FastEthernet0/0\",\n\t\t\t\"outputL3InterfaceIp\" : \"\",\n\t\t\t\"layer2DeviceId\" : 21,\n\t\t\t\"inputL2InterfaceName\" : \"inside\",\n\t\t\t\"outputL2InterfaceName\" : \"outside\",\n\t\t\t\"inputL3DeviceId\" : 20,\n\t\t\t\"inputL3IsGenericDevice\" : false,\n\t\t\t\"inputL3InterfaceName\" : \"Loopback0\",\n\t\t\t\"inputL3InterfaceIp\" : \"\"\n\t\t},\n\t\t{\n\t\t\t\"outputL3DeviceId\" : 23,\n\t\t\t\"outputL3IsGenericDevice\" : false,\n\t\t\t\"outputL3InterfaceName\" : \"FastEthernet2/0\",\n\t\t\t\"outputL3InterfaceIp\" : \"\",\n\t\t\t\"layer2DeviceId\" : 9,\n\t\t\t\"inputL2InterfaceName\" : \"inside\",\n\t\t\t\"outputL2InterfaceName\" : \"outside\",\n\t\t\t\"inputL3DeviceId\" : 17,\n\t\t\t\"inputL3IsGenericDevice\" : false,\n\t\t\t\"inputL3InterfaceName\" : \"mgmt\",\n\t\t\t\"inputL3InterfaceIp\" : \"\"\n\t\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw","description":"Create Transparent Firewalls.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/transparentfw
BODY{
    \"TransparentFirewalls\":
    [
     {
            \"outputL3DeviceId\" : 22,
            \"outputL3IsGenericDevice\" : false,
            \"outputL3InterfaceName\" : \"FastEthernet0/0\",
            \"outputL3InterfaceIp\" : \"\",
            \"layer2DeviceId\" : 21,
            \"inputL2InterfaceName\" : \"inside\",
            \"outputL2InterfaceName\" : \"outside\",
            \"inputL3DeviceId\" : 20,
            \"inputL3IsGenericDevice\" : false,
            \"inputL3InterfaceName\" : \"Loopback0\",
            \"inputL3InterfaceIp\" : \"\"
        },
        {
            \"outputL3DeviceId\" : 23,
            \"outputL3IsGenericDevice\" : false,
            \"outputL3InterfaceName\" : \"FastEthernet2/0\",
            \"outputL3InterfaceIp\" : \"\",
            \"layer2DeviceId\" : 9,
            \"inputL2InterfaceName\" : \"inside\",
            \"outputL2InterfaceName\" : \"outside\",
            \"inputL3DeviceId\" : 17,
            \"inputL3IsGenericDevice\" : false,
            \"inputL3InterfaceName\" : \"mgmt\",
            \"inputL3InterfaceIp\" : \"\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Device Id 23 not found.
500: General error occurred."},"response":[]},{"name":"Update Transparent Firewalls","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"TransparentFirewalls\": \n\t[\n\t {\n\t\t\t\"id\" : 25,\n\t\t\t\"outputL3DeviceId\" : 22,\n\t\t\t\"outputL3IsGenericDevice\" : false,\n\t\t\t\"outputL3InterfaceName\" : \"FastEthernet0/0\",\n\t\t\t\"outputL3InterfaceIp\" : \"\",\n\t\t\t\"layer2DeviceId\" : 21,\n\t\t\t\"inputL2InterfaceName\" : \"inside\",\n\t\t\t\"outputL2InterfaceName\" : \"outside\",\n\t\t\t\"inputL3DeviceId\" : 20,\n\t\t\t\"inputL3IsGenericDevice\" : false,\n\t\t\t\"inputL3InterfaceName\" : \"Loopback2\",\n\t\t\t\"inputL3InterfaceIp\" : \"\"\n\t\t},\n\t\t{\n\t\t\t\"id\" : 27,\n\t\t\t\"outputL3DeviceId\" : 23,\n\t\t\t\"outputL3IsGenericDevice\" : false,\n\t\t\t\"outputL3InterfaceName\" : \"FastEthernet2/0\",\n\t\t\t\"outputL3InterfaceIp\" : \"\",\n\t\t\t\"layer2DeviceId\" : 9,\n\t\t\t\"inputL2InterfaceName\" : \"inside\",\n\t\t\t\"outputL2InterfaceName\" : \"outside\",\n\t\t\t\"inputL3DeviceId\" : 17,\n\t\t\t\"inputL3IsGenericDevice\" : false,\n\t\t\t\"inputL3InterfaceName\" : \"mgmt2\",\n\t\t\t\"inputL3InterfaceIp\" : \"\"\n\t\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw","description":"Update Transparent Firewalls.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/transparentfw
BODY{
    \"TransparentFirewalls\":
    [
     {
            \"id\" : 25,
            \"outputL3DeviceId\" : 22,
            \"outputL3IsGenericDevice\" : false,
            \"outputL3InterfaceName\" : \"FastEthernet0/0\",
            \"outputL3InterfaceIp\" : \"\",
            \"layer2DeviceId\" : 21,
            \"inputL2InterfaceName\" : \"inside\",
            \"outputL2InterfaceName\" : \"outside\",
            \"inputL3DeviceId\" : 20,
            \"inputL3IsGenericDevice\" : false,
            \"inputL3InterfaceName\" : \"Loopback2\",
            \"inputL3InterfaceIp\" : \"\"
        },
        {
            \"id\" : 27,
            \"outputL3DeviceId\" : 23,
            \"outputL3IsGenericDevice\" : false,
            \"outputL3InterfaceName\" : \"FastEthernet2/0\",
            \"outputL3InterfaceIp\" : \"\",
            \"layer2DeviceId\" : 9,
            \"inputL2InterfaceName\" : \"inside\",
            \"outputL2InterfaceName\" : \"outside\",
            \"inputL3DeviceId\" : 17,
            \"inputL3IsGenericDevice\" : false,
            \"inputL3InterfaceName\" : \"mgmt2\",
            \"inputL3InterfaceIp\" : \"\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Device Id 23 not found.
500: General error occurred."},"response":[]},{"name":"Get topology network interfaces by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"mgmtId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/topology_interfaces","description":"The returned interfaces are taken from the topology data and will include only devices that are topology enabled.
When adding a device, the user can can choose whether to use dynamic or static topology for the device,
this choice will determine which kind of data is stored in the topology graph and returned by this API.

The parameter mgmtId should be a cluster or a gateway, not a management server.
You may provide a generic device Id (see generic_devices API under 'Monitored Devices' category) -
in this case make sure you set 'is_generic' parameter to 'true'

Parameters:
context: Global MSSP context [optional]
mgmtId: Management Id or Generic Device Id to query
is_generic: Should be set to 'true' if the provided mgmtId is related to generic device [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_interfaces?mgmtId=10

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_interfaces?mgmtId=1&is_generic=true
"},"response":[]},{"name":"Get Specific topology cloud","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds/{{id}}","description":"Returns the topology cloud data for the specified id.
This API requires 'Super admin' or 'Multi-Domain admin' privileges.
Multi-Domain user must have access permission to the domain where the cloud resides.

Parameters:
id: Cloud id

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds/48
OUTPUT{
    \"topology_cloud\": {
        \"id\": 48,
        \"name\": \"Cloud 69.70.120.155\",
        \"domain\": 1,
        \"type\": \"NON_JOINED\",
        \"ip\": \"69.70.120.155\"
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds/66
OUTPUT{
    \"topology_cloud\": {
        \"id\": 66,
        \"name\": \"Cloud 10.100.10.14\",
        \"domain\": 1,
        \"type\": \"JOINED\",
        \"members\": [
            {
                \"id\": 50,
                \"ip\": \"10.100.6.238\",
                \"name\": \"Cloud 10.100.6.238\"
            },
            {
                \"id\": 73,
                \"ip\": \"10.100.10.14\",
                \"name\": \"Cloud 10.100.10.14\"
            },
            {
                \"id\": 74,
                \"ip\": \"10.100.9.9\",
                \"name\": \"Cloud 10.100.9.9\"
            }
        ]
    }
}


Response Messages:
401: Access is denied
401: You do not have access permission to the domain for cloud with id ID
404: No cloud was found for the provided ID"},"response":[]},{"name":"Update a cloud","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"cloud_data\":{\n\t\t\"cloud_name\" : \"new cloud\",\n\t\t\"cloud_members\" : [118,179,258]\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds/{{id}}","description":"Modify the name of a topology cloud, and add/remove members of a joined cloud.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
Multi-Domain user must have access permission to the domain context of the joined cloud, and any members specified in the body.
To change the name of a topology cloud, enter a value in the name field of the body.
To add/remove members of a joined cloud, specify the action and specify the clouds in the members list of the body.
The action is used only if the body contains a members list. If a members list is provided but no actions is specified, then the default action is ‘add’.
When adding cloud members, clouds included in the members list of the body must not be joined clouds or members of another joined cloud.
When removing cloud members, if only zero or one member remains in the joined cloud, it will be deleted from the Interactive Map.

Parameters:
id: cloud id
action: action [optional]
body: Cloud data

Usage Example
URLfor renaming of any cloud - https://192.168.1.1/securetrack/api/topology/clouds/436
BODY{
    \"cloud_data\":{
        \"cloud_name\" : \"new cloud\"
    }
}


Usage Example
URLfor renaming and members updating of a joined cloud - https://192.168.1.1/securetrack/api/topology/clouds/436?action=remove
BODY{
    \"cloud_data\":{
        \"cloud_name\" : \"new cloud\",
        \"cloud_members\" : [118,179,258]
    }
}


Response Messages:
204: Cloud updated successfully
401: Access is denied
401: You do not have access permission to the domain for cloud with id ID
404: Cloud with id ID was not found in the provided MSSP domain
412: Cloud with id ID is a not joined cloud
412: Cloud id: cloudId does not belong to domain: Context
412: Provided clouds don't belongs to the same domain
412: Cloud with id ID is a joined cloud
412: Cloud with id ID is a member of a joined cloud
412: Member cloud with id ID cannot be removed - it is not a member of a joined cloud"},"response":[]},{"name":"Get Topology Synchronization status","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/synchronize/status","description":"Returns the progress status of the Topology Model Synchronization.



Usage Example
https://192.168.1.1/securetrack/api/topology/synchronize/status

Response Messages:
200: The topology synchronization was invoked successfully.
401: Access is denied
500: Error getting synchronize progress"},"response":[]},{"name":"Delete Join Cloud","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/join/clouds/{{cloudId}}","description":"Delete Join Cloud by Id.

Parameters:
cloudId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/join/clouds/67\n

Response Messages:
204: No Content.
400: Bad Request.
401: Access is denied.
404: Cloud Not Found.
500: General error occurred."},"response":[]},{"name":"Get Join Cloud","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/join/clouds/{{cloudId}}","description":"Get Join Cloud by Id.

Parameters:
cloudId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/join/clouds/67
OUTPUT{
    id: 67,
    name: \"Yami\",
    clouds: [
        1,
        2,
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Cloud Not Found.
500: General error occurred."},"response":[]},{"name":"Get generic Interface","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface/{{inId}}","description":"Get a generic Interface by Id.

Parameters:
inId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interface/212
OUTPUT{
    GenericInterface: {
        id: 212,
        mgmtId: 1,
        name: \"newApo5\",
        ip: \"100.103.33.33\",
        mask: \"255.255.255.0\",
        vrf: \"V101-PAL\",
        mpls: false,
        unnumbered: false,
        type: \"external\"
    }
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Generic Interface Not Found.
500: General error occurred."},"response":[]},{"name":"Delete generic Interface","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface/{{inId}}","description":"Delete a generic Interface by Id.

Parameters:
inId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/interface/5\n

Response Messages:
204: No Content.
400: Bad Request.
401: Access is denied.
404: Generic Interface Not Found.
500: General error occurred."},"response":[]},{"name":"Create a joined topology cloud","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"cloud_data\":{\n\t\t\"cloud_name\" : \"optional new cloud name\",\n\t\t\"cloud_members\" : [118,179,258]\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds","description":"Create a new topology cloud in the Interactive Map by joining existing clouds together.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
The body must include at least two topology cloud ids that are on a single domain.
If the context parameter is not provided, then the API will use the context id of the first member of the members list in the body.
Clouds included in the members list of the body must not be joined clouds or members of another joined cloud.
If the provided body does not specify a joined cloud name, the newly created topology cloud will be given the name of the first member of the members list in the body.


Parameters:
context: Global MSSP context [optional]
body: Cloud data

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds
BODY{
    \"cloud_data\":{
        \"cloud_name\" : \"optional new cloud name\",
        \"cloud_members\" : [118,179,258]
    }
}


Response Messages:
201: Joined cloud created successfully
401: Access is denied
401: You do not have access permission to the domain for cloud with id ID
404: Cloud with id ID was not found in the provided MSSP domain
412: You must provide 2 or more clouds
412: Cloud id: cloudId does not belong to domain: Context
412: Cloud with id ID is a joined cloud
412: Cloud with id ID is a member of a joined cloud"},"response":[]},{"name":"Get topology clouds","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds","description":"Returns a list of the topology clouds for all the domains for which the user has permission to access.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
Use the optional name parameter to restrict the results to topology clouds that contain the specified string.
The default pagination is start=0 and count=50.

Parameters:
context: Global MSSP context [optional]
type: Required clouds type [optional]
name: Cloud name [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds
OUTPUT{
    \"topology_clouds\": {
        \"count\": 3,
        \"total\": 3,
        \"topology_cloud\": [
            {
                \"id\": 48,
                \"name\": \"Cloud 69.70.120.155\",
                \"domain\": 1,
                \"type\": \"NON_JOINED\",
                \"ip\": \"69.70.120.155\"
            },
            {
                \"id\": 50,
                \"name\": \"Cloud 10.100.6.238\",
                \"domain\": 1,
                \"type\": \"MEMBER\",
                \"ip\": \"10.100.6.238\"
            },
            {
                \"id\": 66,
                \"name\": \"Cloud 10.100.10.14\",
                \"domain\": 1,
                \"type\": \"JOINED\",
                \"members\": [
                    {
                        \"id\": 50,
                        \"ip\": \"10.100.6.238\",
                        \"name\": \"Cloud 10.100.6.238\"
                    },
                    {
                        \"id\": 73,
                        \"ip\": \"10.100.10.14\",
                        \"name\": \"Cloud 10.100.10.14\"
                    },
                    {
                        \"id\": 74,
                        \"ip\": \"10.100.9.9\",
                        \"name\": \"Cloud 10.100.9.9\"
                    }
                ]
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds?type=non-joined
OUTPUT{
    \"topology_clouds\": {
        \"count\": 2,
        \"total\": 3,
        \"topology_cloud\": [
            {
                \"id\": 48,
                \"name\": \"Cloud 69.70.120.155\",
                \"domain\": 1,
                \"type\": \"NON_JOINED\",
                \"ip\": \"69.70.120.155\"
            },
            {
                \"id\": 50,
                \"name\": \"Cloud 10.100.6.238\",
                \"domain\": 1,
                \"type\": \"NON_JOINED\",
                \"ip\": \"10.100.6.238\"
            }
        ]
    }
}


Response Messages:
401: Access is denied
401: Only users with ‘Super admin’ permissions can access Global domain map
401: You do not have access permission to domain id: domainId
400: Wrong type provided - allowable values are: joined or non-joined"},"response":[]},{"name":"Get path for specified traffic","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"src"},{"value":null,"type":"text","key":"dst"},{"value":null,"type":"text","key":"service"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/path","description":"Returns one or more paths for the specified traffic.
src and dst parameters may contain multiple, comma separated values.
Service parameter can be a port (for example, “tcp:80”, “any”) or an application (for example, “Skype”, “Facebook”).
Application names are case sensitive.
Service parameter can also be a combination of ports and applications, for example “tcp:80, Skype, Facebook”
If sourceDomainIdTag is provided, the path starting points will be restricted to the specified domain ID. sourceDomainIdTag is valid only if overlapping IP mode is enabled.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is valid only if MSSP mode is enabled.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.
includeIncompletePaths parameter default value is false, if this parameter is set to true -
all nodes on the path will be included, even if the node cannot reach the destination, or if the source and destination are the same.
simulateNat parameter default value is true if this parameter is set to false - NAT simulation will not be used when calculating the path.
lastInstall parameter default value is true, which means simulation would use last installed policies. If this parameter is set to false - simulation would use last saved policies.
This API cannot be executed more than 10 times in parallel.

Parameters:
context: Global MSSP context [optional]
src: Source address/addresses
dst: Destination address/addresses
service: Service/services
sourceDomainIdTag: Path starting point Domain Id [optional]
includeIncompletePaths: Include incomplete paths [optional]
simulateNat: Simulate NAT [optional]
lastInstall: Last Installed [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/path?src=10.10.10.1&dst=3.3.3.3:32&service=any

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/path?src=29.29.29.1&dst=25.25.25.1&service=Facebook,tcp:80
OUTPUT {
    \"path_calc_results\": {
        \"traffic_allowed\": false,
        \"device_info\": {
            \"id\": \"17\",
            \"name\": \"PA-VM-111.6 (Cluster)\",
            \"type\": \"mgmt\",
            \"vendor\": \"Palo Alto Networks\",
            \"incomingInterfaces\": {
                \"incomingVrf\": \"default\",
                \"ip\": \"29.29.29.1/255.255.255.252\",
                \"name\": \"tunnel.11\"
            },
            \"nextDevices\": {
                \"name\": \"DIRECTLY_CONNECTED\",
                \"routes\": {
                    \"outgoingInterfaceName\": \"ethernet1/5\",
                    \"outgoingVrf\": \"default\",
                    \"routeDestination\": \"25.25.25.1/255.255.255.0\"
                }
            },
            \"bindings\": {
                \"name\": \"\",
                \"rules\": [
                    {
                        \"action\": \"Accept\",
                        \"applications\": \"facebook\",
                        \"destNegated\": false,
                        \"destinations\": \"Any\",
                        \"ruleIdentifier\": 43,
                        \"serviceNegated\": false,
                        \"services\": \"Any\",
                        \"sourceNegated\": false,
                        \"sources\": \"Any\",
                        \"users\": \"Any\"
                    },
                    {
                        \"action\": \"Deny\",
                        \"applications\": \"Any\",
                        \"destNegated\": false,
                        \"destinations\": \"Any\",
                        \"ruleIdentifier\": 62,
                        \"serviceNegated\": false,
                        \"services\": \"Any\",
                        \"sourceNegated\": false,
                        \"sources\": \"Any\",
                        \"users\": \"Any\"
                    }
                ]
            }
        }
    }
}

"},"response":[]},{"name":"Delete generic device from Topology model","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/{{id}}","description":"Delete a generic device from the Topology model.
The ID must be for a valid generic device listed in the Topology Model.
If update update_topology = true, then the Topology model will be updated immediately after the device is deleted.
For maximum efficiency, if you are deleting multiple generic devices in consecutive API calls, you can set update_topology = false on all API calls except for the last one. On the last call, set update_toplogy = true.
Default value for update_topology = true.

Parameters:
id: Generic device id
update_topology: Synchronize And Update Topology [optional]

Usage Example
https://192.168.1.1/securetrack/api/generic_devices/1

Usage Example
https://192.168.1.1/securetrack/api/generic_devices/10?update_topology=false

Response Messages:
204: Generic Device deleted successfully.
400: Failed to delete generic device with id {}
404: A 'Generic Device' with the specified ID was not found"},"response":[]},{"name":"Update an existing generic device in the Topology model","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/{{id}}","description":"Modify an existing generic device by uploading a new configuration file and/or specifying a new name.
If name field is specified, the generic device will be renamed.
configuration_file is optional, if provided it must include a valid generic device configuration.
The specified path points to a file in the client machine.
If a generic device name is changed and a new configuration file is not provided, topology will not be synchronized (update_topology flag is ignored).
Default value for update_topology = true.
To save time when there are several consecutive api calls: For the last call, set update_topology = true (for all other calls, update_topology = false).
For more information on input file formats, refer to Knowledge Center topic 'Adding and Updating a Generic Device'.

Parameters:
id: Generic device id
body: Generic device to be updated [optional]
configuration_file: Configuration File for generic device [optional]
update_topology: Synchronize And Update Topology [optional]

Usage Example
curl -X PUT -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F \"configuration_file=@/tmp/config.txt;type=application/octet-stream\" -F \"update_topology=true\" https://192.168.1.1/securetrack/api/generic_devices/24

Usage Example
curl -X PUT -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F 'device_data={\"generic_device\":{\"name\": \"new_generic_device_name\"}};type=application/json' -F \"update_topology=false\" https://192.168.1.1/securetrack/api/generic_devices/72

Response Messages:
204: The generic device was updated successfully.
400: A new name or a new configuration file must be indicated in order to update generic device with id {}
400: Failed to update generic device with id {}
404: A 'Generic Device' with the specified ID was not found"},"response":[]},{"name":"Delete generic Routes","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/mgmt/{{mgmtId}}","description":"Delete all generic Routes from management Id.

Parameters:
mgmtId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/route/mgmt/2\n

Response Messages:
200: 11 Generic Routes were deleted from mgmtId 2.
400: Bad Request.
401: Access is denied.
404: Management Not Found.
500: General error occurred."},"response":[]},{"name":"Get generic Routes","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/mgmt/{{mgmtId}}","description":"Get generic Routes of management Id.

Parameters:
mgmtId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/route/mgmt/2
OUTPUT{
    GenericRoutes: [
    {
        id: 27,
        mgmtId: 2,
        destination: \"10.4.4.4\",
        mask: \"255.0.0.0\",
        interfaceName: \"\",
        nextHop: \"AA\",
        nextHopType: \"VR\",
        vrf: \"V102-YO\"
    },
    {
        id: 28,
        mgmtId: 2,
        destination: \"10.4.5.5\",
        mask: \"255.0.0.0\",
        interfaceName: \"eeee\",
        nextHop: \"\",
        nextHopType: \"IP\",
        vrf: \"V101-PA\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
401: Access is denied.
404: Management Not Found.
500: General error occurred."},"response":[]},{"name":"Get most specific network interfaces from which a host IP is accessible","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"host"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/interfaces/last_hop","description":"Parameters:
context: Global MSSP context [optional]
host: IP address of device for a query

Usage Example
https://192.168.1.1/securetrack/api/devices/interfaces/last_hop?host=192.168.1.66
"},"response":[]},{"name":"Get topology generic VPN connections","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic_vpns{device_id:(/device_id)?}","protocol":"https","host":["{{SecureTrack_IP}}"],"path":["securetrack","api","topology","generic_vpns{device_id:(","device_id)"],"query":[{"key":"}","value":null}]},"description":"Returns a list of the generic vpn connections in the Topology map, for all the domains for which the user has permission to access.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
Use the optional name parameter to restrict the results to topology generic vpn connections that contain the specified string.
The default pagination is start=0 and count=50.

Parameters:
context: Global MSSP context [optional]
is_generic: Get generic devices [optional]
device_id: Device id [optional]
name: VPN connection name (accepts '*', '?' as wildcards) [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/generic_vpns
OUTPUT{
    \"generic_vpns\": {
        \"count\": 3,
        \"total\": 3,
        \"generic_vpn\": [
            {
                \"device_id\": 222,
                \"generic\": false,
                \"id\": 3,
                \"interface_name\": \"tunnel.2\",
                \"tunnel_dest_ip\": \"54.239.63.155\",
                \"tunnel_src_ip\": \"84.200.6.1\",
                \"vpn_name\": \"Palo_to_AWS\"
            },
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 4,
                \"interface_name\": \"tunnel.1\",
                \"tunnel_dest_ip\": \"54.239.63.156\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 5,
                \"interface_name\": \"tunnel.2\",
                \"tunnel_dest_ip\": \"54.239.63.157\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/generic_vpns?is_generic=true
OUTPUT{
    \"generic_vpns\": {
        \"count\": 2,
        \"total\": 2,
        \"generic_vpn\": [
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 4,
                \"interface_name\": \"tunnel.1\",
                \"tunnel_dest_ip\": \"54.239.63.156\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 5,
                \"interface_name\": \"tunnel.2\",
                \"tunnel_dest_ip\": \"54.239.63.157\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
        ]
    }
}


Response Messages:
401: Access is denied
401: Only users with ‘Super admin’ permissions can access Global domain map
401: You do not have access permission to domain id: domainId
400: Wrong type provided - allowable values are: joined or non-joined"},"response":[]},{"name":"Get Specific topology subnet","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/subnets/{{id}}","description":"Returns the subnet for the specified id, including information regarding attached devices and join candidates.
This API requires 'Super admin' or 'Multi-Domain admin' privileges.
Multi-Domain user must have access permission to the domain where the subnet resides.

Parameters:
id: Subnet id

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/subnets/20
OUTPUT{
    \"subnet\": {
        \"id\": 18,
        \"name\": \"90.0.0.0/24\",
        \"ip\": \"90.0.0.0\",
        \"mask\": \"255.255.255.0\",
        \"attached_devices\": {
            \"attached_device\": [
                {
                    \"is_generic\": false,
                    \"id\": 10,
                    \"name\": \"srx\",
                    \"interface_id\": 4,
                    \"interface_name\": \"eth0\",
                    \"interface_ip\": \"90.0.0.1\"
                },
                {
                    \"is_generic\": false,
                    \"id\": 13,
                    \"name\": \"ZBFW\",
                    \"interface_id\": 5,
                    \"interface_name\": \"eth1\",
                    \"interface_ip\": \"90.0.0.124\"
                },
                {
                    \"is_generic\": false,
                    \"id\": 85,
                    \"name\": \"netscreen\",
                    \"interface_id\": 6,
                    \"interface_name\": \"eth2\",
                    \"interface_ip\": \"90.0.0.50\"
                }
            ]
        },
        \"join_candidates\": {
            \"join_candidate\": {
                \"is_generic\": false,
                \"id\": 72,
                \"name\": \"CP25\",
                \"interface_id\": 14,
                \"interface_name\": \"eth24/1\",
                \"interface_ip\": \"90.0.0.83\"
            }
        }
    }
}


Response Messages:
401: Access is denied
401: You do not have access permission to the domain for subnet with id ID
404: No subnet was found for the provided ID"},"response":[]}]},{"name":"Network Zone Manager - Patterns","item":[{"name":"Get a specific zone pattern entry for a specific zone","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\n\t2\tsecurity_group_by_name\n\tThis is a comment\n\tWEB\n\t75\n\tZone_10_0_0_1\n\t\n\t\t
koko
\n\t\tbobo\n\t\t1\n\t\tDefault\n\t\n\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/pattern-entries/{{id}}","description":"Get a specific zone pattern entry for a specific zone by identifier

Parameters:
context: Global MSSP context. [optional]
zone_id: Identifier of the zone containing the zone entry.
id: Identifier of the zone pattern entry.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/75/pattern-entries/2
BODY<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<pattern_match_entry>
    <id>2</id>    <type>security_group_by_name</type>
    <comment>This is a comment</comment>
    <pattern>WEB</pattern>
    <zone_id>75</zone_id>
    <zone_name>Zone_10_0_0_1</zone_name>
    <domain>
        <address>koko</address>
        <description>bobo</description>
        <id>1</id>
        <name>Default</name>
    </domain>
</pattern_match_entry>


Response Messages:
200: The zone pattern entry was successfully retrieved.
401: User is not permitted to access the specified domain
404: A zone with the specified identifier was not found.
404: A zone pattern entry with the specified identifier was not found."},"response":[]},{"name":"Create a zone pattern entry in a specific zone","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\n\t\n\t\t1\n\t\t2\n\t\t\n\t\t\t1\n\t\t\tDefault\n\t\t\n\t\tWEB\n\t\tsecurity_group_by_name\n\t\tThis is a comment\n\t\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/pattern-entries","description":"Create a zone pattern entry in a specific zone by identifier

Parameters:
context: Global MSSP context. [optional]
zone_id: Identifier of the zone containing the zone pattern entry.
body: The zone pattern entry to create.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/pattern-entries
BODY<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<create_pattern_match_entry>
    <pattern_match_entry>
        <id>1</id>
        <zone_id>2</zone_id>
        <domain>
            <id>1</id>
            <name>Default</name>
        </domain>
        <pattern>WEB</pattern>
        <type>security_group_by_name</type>
        <comment>This is a comment</comment>
    </pattern_match_entry>
</create_pattern_match_entry>


Response Messages:
201: The zone pattern entry was created successfully.
401: User is not permitted to access the specified domain
400: Some of pattern entry parameters were invalid or missing
404: A zone with the specified identifier was not found."},"response":[]},{"name":"Get all pattern entries for specific zones","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\n\t\n\t\t0\n\t\t2\n\t\t2\n\t\n\t\n\t\t\n\t\t\t2\n\t\t\tsecurity_group_by_name\n\t\t\tThis is a comment\n\t\t\tWEB\n\t\t\t1\n\t\t\n\t\t\n\t\t\t3\n\t\t\tsecurity_group_by_name\n\t\t\tThis is a comment\n\t\t\tWEo\n\t\t\t2\n\t\t\n\t\n\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/pattern-entries","description":"Get the list of zone pattern entries for specific zones by identifiers

Parameters:
context: Global MSSP context. [optional]
ids: Filter by IDs for the pattern entry results. [optional]
pattern: Filter by pattern string for the zone entry results. [optional]
name: Filter by zone name for the pattern entry results. [optional]
comment: Filter by comment for the pattern entry results. [optional]
sort: Sort ascending or descending. [optional]
start: Starting page number for query results. [optional]
count: Number of pages to return for the query, starting from the specified starting page. [optional]
children: Include child zones in the results. [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/1,2/pattern-entries
BODY<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<pattern_match_entries_find_result>
    <paging_info>
        <start>0</start>
        <count>2</count>
        <total>2</total>
    </paging_info>
    <pattern_match_entries>
        <pattern_match_entry>
            <id>2</id>
            <type>security_group_by_name</type>
            <comment>This is a comment</comment>
            <pattern>WEB</pattern>
            <zone_id>1</zone_id>
        </pattern_match_entry>
        <pattern_match_entry>
            <id>3</id>
            <type>security_group_by_name</type>
            <comment>This is a comment</comment>
            <pattern>WEo</pattern>
            <zone_id>2</zone_id>
        </pattern_match_entry>
    </pattern_match_entries>
</pattern_match_entries_find_result>


Response Messages:
200: The zone pattern entries were successfully retrieved.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]}]},{"name":"Network Zone Manager - Subnets","item":[{"name":"Get a specific zone entry","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"zone_id"},{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries/{{id}}","description":"Get a specific zone entry by ID for a zone.

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
id: The ID of the zone entry.

Usage Example
https://192.168.1.1/securetrack/api/zones/2/entries/123

Response Messages:
200: The zone entry was successfully retrieved.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found."},"response":[]},{"name":"Delete zone entries","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"zone_id"},{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries/{{id}}","description":"Delete existing zone entries.

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
id: The ID of the zone entry to delete.

Usage Example
https://192.168.1.1/securetrack/api/zones/2/entries/10

Response Messages:
200: The zone entry was deleted successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found."},"response":[]},{"name":"Create a zone entry","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"zone_entry\": {\n\t\"ip\": \"1b98:c72:1f00:0000::\",\n\t\"prefix\": \"52\"\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries","description":"For IPv4 entry provide IP and netmask/prefix (see Usage Example #1 and #2).
For IPv6 provide IP and prefix only, netmask is not allowed(see Usage Example #3).

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
body: The zone entry to create.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"netmask\": \"255.255.255.0\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"prefix\": \"24\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries
BODY{
\"zone_entry\": {
    \"ip\": \"1b98:c72:1f00:0000::\",
    \"prefix\": \"52\"
    }
}


Response Messages:
201: The zone entry was created successfully.
401: User is not permitted to access the specified domain
400: The zone entry parameters were invalid
404: A zone with the specified ID was not found."},"response":[]},{"name":"Get entries for a zone","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/entries","description":"Get the list of zone entries for a zone.

Parameters:
context: Global MSSP context. [optional]
ids: Filter by IDs for the zone entry results. [optional]
name: Filter by name for the zone entry results. [optional]
ip: Filter by IP for the zone entry results. [optional]
netmask: Filter by netmask for the zone entry results. [optional]
prefix: Filter by prefix for the zone entry results. [optional]
comment: Filter by comment for the zone entry results. [optional]
group: Filter by device group for the zone entry results. [optional]
sort: Sort ascending or descending. [optional]
start: Starting page number for query results. [optional]
count: Number of pages to return for the query, starting from the specified starting page. [optional]
children: Include child zones in the results. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/2/entries

Response Messages:
200: The zone entries were successfully retrieved.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Modify multiple existing zone entries","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"zone_entries\" : {\n\t\t\"zone_entry\": [\n\t\t\t{\n\t\t\t\t\"id\": 120,\n\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\"prefix\": 32,\n\t\t\t\t\"new_zone_id\": 85\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": 139,\n\t\t\t\t\"ip\": \"1b98:c72:1f00:0001::\",\n\t\t\t\t\"prefix\": \"52\",\n\t\t\t\t\"new_zone_id\": 98\n\t\t\t}\n\t\t]\n}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_ids}}/entries/{{ids}}","description":"For IPv4 entry provide IP and netmask/prefix.
For IPv6 provide IP and prefix only, netmask is not allowed.
new_zone_id is not optional, it may be the same as the present zoneId.

Parameters:
context: Global MSSP context. [optional]
zone_ids: The ID(s) of the zones containing the zone entries.
ids: The ID(s) of the zone entries to modify.
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/85,98/entries/120,139
BODY{
\"zone_entries\" : {
        \"zone_entry\": [
            {
                \"id\": 120,
                \"ip\": \"3.3.3.3\",
                \"prefix\": 32,
                \"new_zone_id\": 85
            },
            {
                \"id\": 139,
                \"ip\": \"1b98:c72:1f00:0001::\",
                \"prefix\": \"52\",
                \"new_zone_id\": 98
            }
        ]
}
}


Response Messages:
200: The zone entry was modified successfully.
401: User is not permitted to access the specified domain
400: The zone entry parameters were invalid
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found."},"response":[]},{"name":"Modify a zone entry","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"zone_entry\": {\n\t\"ip\": \"1b98:c72:1f00:0000::\",\n\t\"prefix\": \"52\"\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries/{{id}}","description":"For IPv4 entry provide IP and netmask/prefix (see Usage Example #1 and #2).
For IPv6 provide IP and prefix only, netmask is not allowed(see Usage Example #3).

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
id: The ID of the zone entry.
body: The modified zone entry.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries/1
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"netmask\": \"255.255.255.0\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries/1
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"prefix\": \"24\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries/1
BODY{
\"zone_entry\": {
    \"ip\": \"1b98:c72:1f00:0000::\",
    \"prefix\": \"52\"
    }
}


Response Messages:
200: The zone entry was modified successfully.
401: User is not permitted to access the specified domain
400: The zone entry parameters were invalid
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found."},"response":[]},{"name":"Modify a zone entry","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"zone_ids"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_ids}}/entries/{{ids}}","description":"Modify an existing zone entry.

Parameters:
context: Global MSSP context. [optional]
zone_ids: The ID(s) of the zones containing the zone entry.
ids: The ID(s) of the zone entries to delete.

Usage Example
https://192.168.1.1/securetrack/api/zones/2,3/entries/10,20

Response Messages:
200: The zone entry was deleted successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found."},"response":[]}]},{"name":"Network Zone Manager - Zones","item":[{"name":"Add a zone as an ancestor to a zone","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"child_id"},{"value":null,"type":"text","key":"parent_ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{child_id}}/ancestors/{{parent_ids}}","description":"Add a zone(s) as an ancestor to a existing zone.

Parameters:
context: Global MSSP context. [optional]
child_id: The ID of the zone for which to add ancestors zone(s).
parent_ids: The ID(s) of the zones to add as ancestors.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/ancestors/10,20

Response Messages:
200: The zone was added as an ancestor successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Remove a zone as an ancestor to a zone","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"child_id"},{"value":null,"type":"text","key":"parent_ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{child_id}}/ancestors/{{parent_ids}}","description":"Remove a zone(s) as an ancestor to a existing zone.

Parameters:
context: Global MSSP context. [optional]
child_id: The ID of the zone for which to remove ancestors zone(s).
parent_ids: The ID(s) of the zones to remove as ancestors.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/ancestors/10,20

Response Messages:
200: The zone was removed as an ancestor successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Get ancestor zones for a zone","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/ancestors","description":"Get a list of ancestor zones for the specified zone(s).

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones for which to look for ancestor zones.

Usage Example
https://192.168.1.1/securetrack/api/zones/123,234/ancestors

Response Messages:
200: The zone ancestors were retrieved successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Create a zone","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\n\tDMZ\n\tAll DMZ addresses\n\tfalse\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/","description":"Create a zone.

Parameters:
context: Global MSSP context. [optional]
body: The zone to add.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones
BODY<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<zone>
    <name>DMZ</name>
    <comment>All DMZ addresses</comment>
    <shared>false</shared>
</zone>


Response Messages:
201: The zone was created successfully.
401: User is not permitted to access the specified domain
400: The zone parameters were invalid"},"response":[]},{"name":"Get all zones","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/","description":"Gets a list of all zones.

Parameters:
context: Global MSSP context. [optional]
name: Filter by zone name for the zone results. [optional]
comment: Filter by zone comment for the zone results. [optional]
imported: List domains that imported zones. [optional]
includeInternet: Include the Internet zone. [optional]
includeImported: Include imported zones. [optional]
sort: Sort ascending or descending. [optional]
start: Starting page number for query results. [optional]
count: Number of pages to return for the query, starting from the specified starting page. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones

Response Messages:
200: The zones were retrieved successfully.
401: User is not permitted to access the specified domain"},"response":[]},{"name":"Delete all zones","request":{"method":"DELETE","header":[],"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/","description":"Delete all existing zones.

Parameters:
context: Global MSSP context. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones

Response Messages:
204: All zones were successfully deleted.
401: User is not permitted to access the specified domain"},"response":[]},{"name":"Get shared zones","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/shared","description":"Get a list of shared zones.

Parameters:
context: Global MSSP context. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/shared

Response Messages:
200: The list of shared zones was retrieved successfully.
401: User is not permitted to access the specified domain"},"response":[]},{"name":"Import a zone","request":{"method":"POST","header":[],"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/import/{{ids}}","description":"Import a shared zone into the specified domain

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones to import. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/import/10,20

Response Messages:
200: The zone was imported successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Delete a zone","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}","description":"Delete an existing zone.

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zone to delete.

Usage Example
https://192.168.1.1/securetrack/api/zones/1,2

Response Messages:
204: The specified zone was successfully deleted.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Map network elements to security zones","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t \n\t\t 10.8.8.0\n\t\t 255.255.255.0\n\t\t \n\t \n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_zones/","description":"This API maps each network element in the AccessRequestNetworkListDTO (such as IP address, IP address range, object, or group) to all matching Tufin security zones. If the network element is a group, then each zone also identifies all matching group members. The internet referral object can be included in the list, and will always map to the predefined Internet security zone. If the 'Any' element is included in the list it will map to all zones.
Note: if multi-domain mode is enabled, the API calls only checks zones that are in the “Default” domain.

Parameters:
body: AccessRequestNetworkListDTO

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_zones
BODY<network_objects>
     <network_object xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"ip_network\">
         <network xsi:type=\"raw_network_subnet\">
         <ip>10.8.8.0</ip>
         <mask>255.255.255.0</mask>
         </network>
     </network_object>
</network_objects>


Response Messages:
200: Returns mapping of network elements to security zones
400: Access Request Network List is malformed.
401: Access is denied."},"response":[]},{"name":"Modify a zone","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\n\t2\n\tDMZ\n\tAll DMZ hosts\n\tfalse\n\tfalse\n\tfalse\n\tfalse\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{id}}","description":"Modify an existing zone.

Parameters:
context: Global MSSP context. [optional]
id: The ID of the zone to modify.
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2
BODY<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<zone>
    <id>2</id>
    <name>DMZ</name>
    <comment>All DMZ hosts</comment>
    <shared>false</shared>
    <internet>false</internet>
    <user_networks>false</user_networks>
    <unassociated_networks>false</unassociated_networks>
</zone>


Response Messages:
204: The specified zone was successfully modified.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
400: The zone parameters were invalid"},"response":[]},{"name":"Get a specific zone","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{id}}","description":"Get the zone with the specified ID.

Parameters:
context: Global MSSP context. [optional]
id: The ID of the zone to get.
imported: List domains that imported zones. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/2

Response Messages:
200: The zone was retrieved successfully.
401: User is not permitted to access the specified domain
401: A zone with the specified ID does not exist."},"response":[]},{"name":"Get descendant zones for a zone","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/descendants","description":"Get a list of zones descended from the specified zone(s).

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones for which to look for descendant zones.

Usage Example
https://192.168.1.1/securetrack/api/zones/10,20/descendants

Response Messages:
200: The zone descendants were retrieved successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Get configuration usages for a zone","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/dependencies","description":"Get a list of configuration usages for the specified zone(s).

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones for which to look for configuration dependencies.

Usage Example
https://192.168.1.1/securetrack/api/zones/2,3/dependencies

Response Messages:
200: The zone dependencies were retrieved successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Remove a zone as an descendants to a zone","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"parent_id"},{"value":null,"type":"text","key":"child_ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{parent_id}}/descendants/{{child_ids}}","description":"Remove a zone(s) as an descendants to a existing zone.

Parameters:
context: Global MSSP context. [optional]
parent_id: The ID of the zone for which to remove descendant zone(s).
child_ids: The ID(s) of the zone to remove as a descendant.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/descendants/10,20

Response Messages:
200: The zone was removed as an descendant successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Add a zone as a descendant to a zone","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"parent_id"},{"value":null,"type":"text","key":"child_ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{parent_id}}/descendants/{{child_ids}}","description":"Add a zone(s) as a descendant to a existing zone.

Parameters:
context: Global MSSP context. [optional]
parent_id: The ID of the zone for which to add descendant zone(s).
child_ids: The ID(s) of the zones to add as descendants.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/descendants/10,20

Response Messages:
200: The zone was added as an descendant successfully.
401: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]}]},{"name":"Policies and Sub-Policies","item":[{"name":"Get sub-policies (bindings) by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/bindings","description":"Returns a list of all of the subpolicies (bindings) for a given revision.
The definition of subpolicy is different for each vendor:
Check Point - policy package and inline layer (inline layer will be returned only when the optional include_subpolicy parameter is set to true)
Cisco - ACL
Juniper/Fortinet/Palo Alto/Stonesoft - zone-to-zone policy
Cloud platforms - Security Groups


Parameters:
context: Global MSSP context [optional]
id: Revision ID
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
include_subpolicy: when set to true, includes sub policies in the returned result, supported only for Checkpoint [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/bindings

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/bindings? include_subpolicy=true
"},"response":[]},{"name":"Get list of sub-policies (bindings) with input and/or output interfaces","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"supremum_version_id"},{"value":null,"type":"text","key":"inputInterfaceName"},{"value":null,"type":"text","key":"outputInterfaceName"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/binding_query","description":"Retrieve list of bindings of input and/or output interfaces

Parameters:
device_id: The unique identifier of target device
supremum_version_id: The unique identifier of target revision
inputInterfaceName: Input interface name
outputInterfaceName: Output interface name

Usage Example
https://192.168.1.1/securetrack/api/bindings/20/binding_query?supremum_version_id=785&inputInterfaceName=Any&outputInterfaceName=Any
"},"response":[]},{"name":"Get sub-policies (bindings) by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/bindings","description":"Returns a list of all of the subpolicies (bindings) for a given device.
The definition of subpolicy is different for each vendor:
Check Point - policy package and inline layer (inline layer will be returned only when the optional include_subpolicy parameter is set to true)
Cisco - ACL
Juniper/Fortinet/Palo Alto/Stonesoft - zone-to-zone policy
Cloud platforms - Security Groups


Parameters:
context: Global MSSP context [optional]
id: Device ID
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
include_subpolicy: when set to true, includes sub policies in the returned result, supported only for Checkpoint [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/bindings

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/bindings? include_subpolicy=true
"},"response":[]},{"name":"Get policies by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/policies","description":"Fetches list of policies defined on a given device ID.
Supported devices: CheckPoint, Panorama Advanced, FortiManager Basic and Advanced, FMC and NSX.

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/20/policies
"},"response":[]},{"name":"Get policies by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/policies","description":"Fetches list of policies defined on a given revision ID

Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/policies
"},"response":[]},{"name":"Get rules by input and output interfaces","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/topology_interfaces","description":"Parameters:
device_id: The unique identifier of target device
inputInterfaceName: Input interface name [optional]
outputInterfaceName: Output interface name [optional]

Usage Example
https://192.168.1.1/securetrack/api/bindings/2/topology_interfaces?inputInterfaceName=ethernet1/1&outputInterfaceName=ethernet1/2
"},"response":[]}]},{"name":"Policy Analysis","item":[{"name":"Run Policy Analysis query","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_ids"},{"value":null,"type":"text","key":"sources"},{"value":null,"type":"text","key":"destinations"},{"value":null,"type":"text","key":"services"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/policy_analysis/query/matching_rules","description":"Parameters:
device_ids: Device ids
sources: Source list
destinations: Destination list
services: Service list
exclude_any: Exclude any in the specified, comma-separated fields of source, destination or service. For example: exclude_any = destination,service [optional]
action: Action [optional]

Usage Example
https://192.168.1.1/securetrack/api/policy_analysis/query/matching_rules?device_ids=41&sources=33.33.33.0:24,113.113.113.100&destinations=114.1.1.0:24&services=tcp:80&exclude_any=source,destination

Response Messages:
200: Returns request results.
400: Error in request syntax."},"response":[]}]},{"name":"Policy Browser (formerly Rule Documentation)","item":[{"name":"Get specific rule documentation","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"rule_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules/{{rule_id}}/documentation","description":"Fetches rule documentation for a single rule given by revision ID and rule ID.

Parameters:
context: Global MSSP context [optional]
id: Revision id
rule_id: Id of the requested rule

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules/16373/documentation
"},"response":[]},{"name":"Modify specific rule documentation","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t admin\n\t Comment text\n\t false\n\t true\n\t \n\t\t user@company.com\n\t\t Business Owner\n\t\t 2013-01-08T00:00:00+02:00\n\t\t 172\n\t\t 789111\n\t \n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules/{{rule_id}}/documentation","description":"Modify rule documentation for a single rule identified by revision ID and rule ID.
A single rule can be set as either a stealth rule or legacy rule. If both flags are set, an error will be returned (error 400, Bad request).
If no rule documentation exists for the rule, the specified documentation is added to the rule and the response code is: 201 Created.
If rule documentation already exists for the rule, the specified documentation replaces the existing documentation and the response code is: 204 No Content.
Record set entries that are automatically created or calculated, for example automatic mapping to a SecureChange ticket, cannot be modified.
The following fields are automatically calculated, and cannot be modified:
Permissiveness, Violations, Last Hit, Last Modified, Shadowing Status, Certification Status, Certification Date, Certification Expiration Date, Application Name, Application Owner

Parameters:
context: Global MSSP context [optional]
id: Revision id
rule_id: Id of the changed rule
body: RuleDocumentationDTO

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/173/rules/3373/documentation
BODY<rule_documentation>
     <tech_owner>admin</tech_owner>
     <comment>Comment text</comment>
     <legacy_rule>false</legacy_rule>
     <stealth_rule>true</stealth_rule>
     <record_set>
         <businessOwnerEmail>user@company.com</businessOwnerEmail>
         <businessOwnerName>Business Owner</businessOwnerName>
         <expireDate>2013-01-08T00:00:00+02:00</expireDate>
         <id>172</id>
         <ticketCr>789111</ticketCr>
     </record_set>
</rule_documentation>

"},"response":[]},{"name":"Delete specific rule documentation","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"rule_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules/{{rule_id}}/documentation","description":"Delete rule documentation for a single rule given by revision ID and rule ID.
If the rule has automatic mapping to a ticket, the record is not deleted.

Parameters:
context: Global MSSP context [optional]
id: Revision id
rule_id: Rule id

Usage Example
https://192.168.1.1/securetrack/api/revisions/173/rules/3373/documentation
"},"response":[]},{"name":"Modify specific rule documentation","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t admin\n\t Comment text\n\t false\n\t true\n\t \n\t\t user@company.com\n\t\t Business Owner\n\t\t 2013-01-08T00:00:00+02:00\n\t\t 173\n\t\t 789112\n\t \n\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules/{{rule_id}}/documentation","description":"Modify rule documentation for a single rule given by device ID and rule ID
A single rule can be set as either a stealth rule or legacy rule. If both flags are set, an error will be returned (error 400, Bad request).
If there is no existing rule documentation for the rule, the specified documentation is added to the rule and the response code is: 201 Created.
If there is existing rule documentation for the rule, the specified documentation replaces the existing documentation and the response code is: 204 No Content.

Parameters:
context: Global MSSP context [optional]
id: Device ID
rule_id: Rule ID
body: RuleDocumentationDTO

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/20/rules/3040/documentation
BODY<rule_documentation>
     <tech_owner>admin</tech_owner>
     <comment>Comment text</comment>
     <legacy_rule>false</legacy_rule>
     <stealth_rule>true</stealth_rule>
     <record_set>
         <businessOwnerEmail>user@company.com</businessOwnerEmail>
         <businessOwnerName>Business Owner</businessOwnerName>
         <expireDate>2013-01-08T00:00:00+02:00</expireDate>
         <id>173</id>
         <ticketCr>789112</ticketCr>
     </record_set>
</rule_documentation>

"},"response":[]},{"name":"Get specific rule documentation","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"rule_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules/{{rule_id}}/documentation","description":"Fetches rule documentation for a single rule given by device ID and rule ID

Parameters:
context: Global MSSP context [optional]
id: Device ID
rule_id: Rule ID

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules/16373/documentation
"},"response":[]},{"name":"Delete specific rule documentation","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"rule_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules/{{rule_id}}/documentation","description":"Delete rule documentation for a single rule given by device ID and rule ID

Parameters:
context: Global MSSP context [optional]
id: Device ID
rule_id: Rule ID

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules/3040/documentation
"},"response":[]}]},{"name":"Policy Optimization","item":[{"name":"Get the specific objects or rules identified for the cleanup results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"cleanup_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/cleanup/{{cleanup_id}}/instances","description":"Parameters:
context: Global MSSP context [optional]
cleanup_id: Cleanup id
devices: Devices ids [optional]
start: Start [optional]
count: Results count [optional]

Usage Example
https://192.168.1.1/securetrack/api/cleanup/1/instances
"},"response":[]},{"name":"Get cleanups results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/cleanup/","description":"Parameters:
context: Global MSSP context [optional]
devices: Devices ids [optional]

Usage Example
https://192.168.1.1/securetrack/api/cleanup
"},"response":[]},{"name":"Get cleanups by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"code"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/cleanups","description":"Fetches set of Cleanup calculation results for a device given by ID.
Only fully shadowed rules (cleanup code C01) are supported.

Parameters:
context: Global MSSP context [optional]
device_id: Device ID
code: Cleanup category code
start: Starting page for query allowable values are numeric [optional]
count: Number of pages for query result allowable values are numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/cleanups?code=C01
"},"response":[]},{"name":"Get shadowing rules by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"shadowed_uids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/shadowing_rules","description":"Find shadowing rules for given shadowed rules of a specific device

Parameters:
device_id: Device ID
shadowed_uids: UIDs of shadowed rules separated by commas

Usage Example
https://192.168.1.1/securetrack/api/devices/31/shadowing_rules?shadowed_uids=78786a0d-b9cc-478e-b7a2-dea953c976c7
"},"response":[]},{"name":"Get devices in risk results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"risk_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/risk/{{risk_id}}/devices","description":"Parameters:
context: Global MSSP context [optional]
risk_id: Risk id

Usage Example
https://192.168.1.1/securetrack/api/risk/1/devices
"},"response":[]},{"name":"Get risks results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/risk/","description":"Parameters:
context: Global MSSP context [optional]
devices: Devices ids [optional]

Usage Example
https://192.168.1.1/securetrack/api/risk
"},"response":[]},{"name":"Get the specific objects or rules identified for the risk results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"risk_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/risk/{{risk_id}}/instances","description":"Parameters:
context: Global MSSP context [optional]
risk_id: Risk id
devices: Devices ids [optional]
start: Start [optional]
count: Results count [optional]

Usage Example
https://192.168.1.1/securetrack/api/risk/1/instances
"},"response":[]},{"name":"Get devices in cleanup results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"cleanup_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/cleanup/{{cleanup_id}}/devices","description":"Parameters:
context: Global MSSP context [optional]
cleanup_id: Cleanup id

Usage Example
https://192.168.1.1/securetrack/api/cleanup/1/devices
"},"response":[]}]},{"name":"Revisions","item":[{"name":"Get specific revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revId}}","description":"Fetches a revision specified by revision Id.
To get revId for this API, use the 'id' property of RevisionDTO that is returned by 'Get revisions by device' or 'Get latest revision by device' APIs

Parameters:
context: Global MSSP context [optional]
revId: Id of fetched revision

Usage Example
https://192.168.1.1/securetrack/api/revisions/785
"},"response":[]},{"name":"Get latest revision by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/latest_revision","description":"Fetches latest revision for a given device

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/105/latest_revision
"},"response":[]},{"name":"Get revisions by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/revisions","description":"Fetches revisions for a given device

Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query starting from starting page allowable type is numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/105/revisions
"},"response":[]}]},{"name":"Rule Usage","item":[{"name":"Get last hit for a specific rule","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"rule_uid"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/rule_last_usage/find/{{device_id}}/{{rule_uid}}","description":"Get last hit dates for all rules in a given device.
For Palo Alto firewalls, this also returns last hits for users and applications in the rule.
The rule_uid is the value from the uid field returned by the /rules API: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Parameters:
device_id: device_id
rule_uid: rule_uid

Usage Example
https://192.168.1.1/securetrack/api/rule_last_usage/find/20/ea9db13e-d058-45c6-a2f0-cd731027c22b
"},"response":[]},{"name":"Get last hits for all rules by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/rule_last_usage/find_all/{{device_id}}","description":"Get last hit dates for all rules in a given device.
For Palo Alto firewalls, this also returns last hits for users and applications in the rule.

Parameters:
device_id: device id

Usage Example
https://192.168.1.1/securetrack/api/rule_last_usage/find_all/20
"},"response":[]}]},{"name":"Security Rules","item":[{"name":"Get a specific rule","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"ruleId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/rules/{{ruleId}}","description":"Parameters:
ruleId: Rule ID

Usage Example
https://192.168.1.1/securetrack/api/rules/60
"},"response":[]},{"name":"Get rule count per device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/rule_search/","description":"The search_text parameter provides the same capabilities as the Policy Browser feature in SecureTrack.
You can search for a string across all rule fields, or you can search for a combination of specific strings in specific fields.
The text format is for a field is <fieldname>:<text> for example uid:9259f6ee-47a0-4996-a214-ab7edc14a916.
See the search info documentation in Securetrack Policy Browser page for more information.
This API will return a list of all the devices, the devices that has rules that match the search criteria will have rule_count that is bigger than 0

Parameters:
context: Global MSSP context [optional]
search_text: Search text [optional]
devices: Devices ids [optional]

Usage Example
https://192.168.1.1/securetrack/api/rule_search/87

Usage Example
https://192.168.1.1/securetrack/api/rule_search/87?search_text=ICMP application:facebook

Usage Example
URLhttps://192.168.1.1/securetrack/api/rule_search?search_text=uid:9259f6ee-47a0-4996-a214-ab7edc14a916
OUTPUT{
    \"device_list\":{
        \"device\":[
            {
                \"device_id\":512,
                \"revision_id\":6864,
                \"rule_count\":1
            },
            {
                \"device_id\":59,
                \"revision_id\":543,
                \"rule_count\":0
            }
        ]
    }
}

"},"response":[]},{"name":"Get rules by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules","description":"Returns a list of all of the security rules for the specified revision.
Use add=documentation to retrieve rule documentation.
The is_global parameter is device dependent. For ACL devices, only global rules are returned when set to true. For Check Point R80, only global layers are returned when set to true, and specify a layer name in the subpolicy_name parameter This parameter is ignored for all other vendors. The default value is false.
The subpolicy_name parameter is device dependent. For Check Point R80, only rules that use the specified layer are returned. You can only specify the name of a single layer. This parameter is ignored for all other vendors.


Parameters:
context: Global MSSP context [optional]
id: Revision id
policyId: Policy id [optional]
policy: Policy name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules only(device dependent, see implementation Notes) [optional]
add: If set to \"documentation\" result will include rule documentation [optional]
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
groupBy: Rules grouping criteria, can be set only to \"bindings\" [optional]
with_zb: Include zone-based rules [optional]
uid: Binding UID [optional]
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
subpolicy_name: Filter by sub policy name (see implementation notes) [optional]
is_alternate_order: OrderBy alternate order, for display Aci rules by contracts [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules?subpolicy_name=layer1&is_global=true
"},"response":[]},{"name":"Get rules by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules","description":"Returns a list of all of the security rules for the specified device.
Use add=documentation to retrieve rule documentation.
The is_global parameter is device dependent. For ACL devices, only global rules are returned when set to true. For Check Point R80, only global layers are returned when set to true, and specify a layer name in the subpolicy_name parameter This parameter is ignored for all other vendors. The default value is false.
The subpolicy_name parameter is device dependent. For Check Point R80, only rules that use the specified layer are returned. You can only specify the name of a single layer. This parameter is ignored for all other vendors.


Parameters:
context: Global MSSP context [optional]
id: Device ID
policyId: Policy ID [optional]
policy: Policy Name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules (Only for: ACL devices) [optional]
add: If set to \"documentation\" result will include rule documentation [optional]
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
groupBy: Show rules grouping criteria. Can be set only to \"bindings\". Output will be grouped by bindings and section header for Check Point devices, ACL for Cisco devices, and Zones for Juniper, Palo Alto, and Fortinet device [optional]
with_zb: Include zone based rules, values can be 'true' or 'false' [optional]
uid: Binding UID [optional]
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
subpolicy_name: Filter by sub policy name (see implementation notes) [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules?subpolicy_name=layer1&is_global=true
"},"response":[]},{"name":"Get specific rule","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/rules/{{ids}}","description":"Returns a list of rules by revision ID, rule IDs and additional criteria

Parameters:
context: Global MSSP context [optional]
revision_id: Revision id
ids: Rule IDs
policy: Policy name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules (Only for: ACL devices) [optional]
add: If set to \\\"documentation\\\" result will include rule documentation [optional]
groupBy: Rules grouping criteria, can be set only to \\\"bindings\\\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules/16370
"},"response":[]},{"name":"Create a CSV file for rules search results","request":{"method":"GET","header":[],"url":"https://{{SecureTrack_IP}}/securetrack/api/rule_search/export","description":"The search_text parameter provides the same capabilities as the Policy Browser feature in SecureTrack.
You can search for a string across all rule fields, or you can search for a combination of specific strings in specific fields.
The text format is for a field is : for example uid:9259f6ee-47a0-4996-a214-ab7edc14a916.
See the search info documentation in Securetrack Policy Browser page for more information.
This API exports the results data as a CSV file in the SecureTrack Reports Repository.

Parameters:
context: Global MSSP context [optional]
search_text: Search text [optional]

Usage Example
https://192.168.1.1/securetrack/api/rule_search/export

Usage Example
https://192.168.1.1/securetrack/api/rule_search/export?search_text=shadowed:true
"},"response":[]},{"name":"Find rules","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/rule_search/{{device_id}}","description":"The search_text parameter provides the same capabilities as the Policy Browser feature in SecureTrack.
You can search for a string across all rule fields, or you can search for a combination of specific strings in specific fields.
The text format is for a field is <fieldname>:<text> for example uid:9259f6ee-47a0-4996-a214-ab7edc14a916.
See the search info documentation in Securetrack Policy Browser page for more information.To get more information regarding objects included in the returned rules (like src_network or dst_network) use their uid, as the objects’ ID might change.
\n By default, if there are less than 3,000 rules - the API will return all the rules.\nIn case there are more than 3,000 rules the API will return an error code 413 with the error message “There are more than 3000 rules, you must use pagination”

Parameters:
context: Global MSSP context [optional]
search_text: Search text [optional]
device_id: Device id
start: The starting rule to include in the returned results [optional]
count: Number of rules to include in the results [optional]

Usage Example
https://192.168.1.1/securetrack/api/rule_search/31?search_text=source:Sales_192.168.2.60 fromzone:sales tozone:External

Usage Example
https://192.168.1.1/securetrack/api/rule_search/20?search_text=Mobile Access hascomment:false

Usage Example
https://192.168.1.1/securetrack/api/rule_search/87?search_text=web_server&start=0&count=10

Usage Example
URLhttps://192.168.1.1/securetrack/api/rule_search/59?search_text=uid:9259f6ee-47a0-4996-a214-ab7edc14a916
OUTPUT {
    \"rules\":{
        \"count\":1,
        \"total\":1,
        \"rule\":{
            \"@xsi.type\":\"securityRuleDTO\",
            \"id\":21,
            \"cp_uid\":\"\",
            \"uid\":\"{9259f6ee-47a0-4996-a214-ab7edc14a916}\",
            \"order\":2,
            \"binding\":{
                \"default\":true,
                \"policy\":{
                    \"@xsi.type\":\"managementDomainPolicyDTO\",
                    \"id\":2,
                    \"name\":\"Standard\",
                    \"installable_targets\":\"\"
                },
                \"rule_count\":19,
                \"security_rule_count\":19,
                \"uid\":\"{00-FACED0-00}\"
                },
            \"acceleration_breaker\":false,
            \"action\":\"Accept\",
            \"application\":{
                \"id\":4735,
                \"display_name\":\"ssh\",
                \"name\":\"ssh\"
            },
            \"authentication_rule\":false,
            \"comment\":\"DO NOT DELETE OR EDIT\",
            \"dst_network\":{
                \"id\":39,
                \"display_name\":\"Net_10.110.65.0\",
                \"name\":\"Net_10.110.65.0\"
                \"uid\":\"{1290f6ee-47a1-4996-a214-ab2edc26a916}\"
            },
            \"dest_networks_negated\":false,
            \"dst_service\":{
                \"id\":7420,
                \"display_name\":\"ssh\",
                \"name\":\"ssh\"
                \"uid\":\"{2904f6ee-47a1-4996-a214-ab2edc26a916}\"
            },
            \"dest_services_negated\":false,
            \"dst_zone\":\"any\",
            \"disabled\":false,
            \"external\":false,
            \"implicit\":false,
            \"dst_zone_any\":true,
            \"src_zone_any\":true,
            \"name\":\"Accept SSHG\",
            \"option\":\"LOG_SESSION\",
            \"documentation\":{
                \"permissiveness_level\":\"LOW\",
                \"shadowed\":\"Not shadowed\",
                \"last_modified\":\"Today\",
                \"last_hit\":\"N/A\",
                \"violations\":\"\"
            },
            \"rule_location\":\"Shared\",
            \"rule_location_display\":\"Shared - Pre Rule\",
            \"rule_number\":2,
            \"rule_type\":\"universal\",
            \"src_zone\":\"any\",
            \"src_network\":{
                \"id\":38,
                \"display_name\":\"Net_10.110.64.0\",
                \"name\":\"Net_10.110.64.0\"
                \"uid\":\"{4934f6ee-47a1-4996-a214-ab2edc26a916}\"
            },
            \"src_networks_negated\":false,
            \"src_services_negated\":false,
            \"track\":{
                \"level\":\"LOG\"
            },
            \"type\":\"rule\",
            \"users\":{
                \"id\":5,
                \"display_name\":\"tufin\\\\regina\",
                \"name\":\"tufin\\\\regina@ldap\"
            }
        }
    }
}


Response Messages:
400: Value for start parameter is missing or not valid
400: Value for count parameter is missing or not valid
413: Max supported count is 3000
413: There are more than 3000 rules, you must use pagination"},"response":[]},{"name":"Get specific rule","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/rules/{{ids}}","description":"Returns a list of rules by device ID, rule IDs and additional criteria.
Note: This API retrieves the information from the latest revision.


Parameters:
context: Global MSSP context [optional]
device_id: Device ID
ids: Rule IDs
policy: Policy Name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules only(device dependent, see implementation Notes) [optional]
add: If set to \"documentation\" result will include rule documentation [optional]
groupBy: Rules grouping criteria, can be set only to \"bindings\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules/16370
"},"response":[]}]},{"name":"Services and Ports","item":[{"name":"Get services by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/services","description":"Fetches list of service objects defined in revision given by revision ID
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.


Parameters:
context: Global MSSP context [optional]
id: Revision id
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
start: Starting page for query allowable types are numeric [optional]
count: Number of pages for query allowable values are numeric [optional]
name: Service name [optional]
type: Service type, allowable values are: tcp, udp, ip or icmp [optional]
port: Service port [optional]
icmp_type: Service ICMP type allowable values are numeric between 0 to 40 [optional]
protocol: Service protocol, allowable values are numeric betweenm 0 to 255 [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/785/services?get_total=true
OUTPUT {
    \"services\": {
        \"count\": 50,
        \"total\": 100,
        \"service\": [{
            \"@xsi.type\": \"singleServiceDTO\",
            \"id\": 5129479,
            \"name\": \"Tcp30025\",
            \"display_name\": \"Tcp30025\",
            \"class_name\": \"tcp_service\",
            \"type\": \"tcp_service\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{079F15A5-009E-7E47-BBD0-E65973646562}\",
            \"implicit\": false,
            \"overrides\": false,
            \"max\": 30025,
            \"min\": 30025,
            \"negate\": false,
            \"protocol\": 6,
            \"timeout\": 0
        }]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/31/services?type=group&show_members=false
OUTPUT{
    \"services\": {
    \"count\": 100,
        \"service\": [
            {
                \"@xsi.type\": \"serviceGroupDTO\",
                \"id\": 1359066,
                \"name\": \"#Shared Domain@DNS\",
                \"display_name\": \"DNS\",
                \"class_name\": \"service_group\",
                \"type\": \"group\",
                \"global\": \"false\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": false,
                \"overrides\": \"false\",
                \"type_on_device\": gen_service_group,
                \"is_device_predefined\": true,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"DNS\",
                    \"name\": \"#Shared Domain@DNS\",
            }
        ]
    }
}

"},"response":[]},{"name":"Get rules containing specified service object","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/services/{{id}}/rules","description":"Returns the security rules that contain the specified service object


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the service object.
include_groups: You can add \"include_groups\" to find rules that include the service object and rules that include the groups that include the service object. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]

Usage Example
https://192.168.1.1/securetrack/api/services/65078/rules?include_groups=true
"},"response":[]},{"name":"Get specific service","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/services/{{ids}}","description":"Fetches list of specific service objects defined in revision given by revision ID and specified by their IDs

Parameters:
context: Global MSSP context [optional]
revision_id: Revision id
ids: Rule IDs
show_members: Set to false to return only the name and ID of the members [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/services/959888
"},"response":[]},{"name":"Get service groups containing specified service objects","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/services/{{id}}/groups","description":"Returns groups that contain the specified service objects


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the service object.

Usage Example
https://192.168.1.1/securetrack/api/services/69577/groups
"},"response":[]},{"name":"Get specific service","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/services/{{ids}}","description":"Fetches list of specific service objects defined in device given by device ID and specified by their IDs.
Note: This API retrieves the information from the latest revision.

Parameters:
context: Global MSSP context [optional]
device_id: Device ID
ids: Service object IDs separated by commas
show_members: Set to false to return only the name and ID of the members [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/services/959888,959966
"},"response":[]},{"name":"Get services by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/services","description":"Fetches list of service objects defined on device given by device ID.
The default value for get_total is false. For APIF 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.


Parameters:
context: Global MSSP context [optional]
id: Device ID
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
start: Starting page for query allowable types are numeric [optional]
count: Number of pages for query allowable values are numeric [optional]
name: Service name [optional]
type: Service type, allowable values are: tcp, udp, ip or icmp [optional]
port: Service port [optional]
icmp_type: Service ICMP type allowable values are numeric between 0 to 40 [optional]
protocol: Service protocol, allowable values are numeric between 0 to 255 [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/20/services?get_total=true
OUTPUT {
    \"services\": {
        \"count\": 50,
        \"total\": 100,
        \"service\": [{
            \"@xsi.type\": \"singleServiceDTO\",
            \"id\": 5129479,
            \"name\": \"Tcp30025\",
            \"display_name\": \"Tcp30025\",
            \"class_name\": \"tcp_service\",
            \"type\": \"tcp_service\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{079F15A5-009E-7E47-BBD0-E65973646562}\",
            \"implicit\": false,
            \"overrides\": false,
            \"max\": 30025,
            \"min\": 30025,
            \"negate\": false,
            \"protocol\": 6,
            \"timeout\": 0
        }]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/services?type=group&show_members=false
OUTPUT{
    \"services\": {
    \"count\": 100,
        \"service\": [
            {
                \"@xsi.type\": \"serviceGroupDTO\",
                \"id\": 1359066,
                \"name\": \"#Shared Domain@DNS\",
                \"display_name\": \"DNS\",
                \"class_name\": \"service_group\",
                \"type\": \"group\",
                \"global\": \"false\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": false,
                \"overrides\": \"false\",
                \"type_on_device\": gen_service_group,
                \"is_device_predefined\": true,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"DNS\",
                    \"name\": \"#Shared Domain@DNS\",
            }
        ]
    }
}

"},"response":[]},{"name":"Get services objects matching specified criteria","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"services\": {\n\t\t\"count\": 1,\n\t\t\"total\": 1,\n\t\t\"service:\": {\n\t\t\t\"id\": 169197,\n\t\t\t\"name\": \"tcp_10\",\n\t\t\t\"display_name\": \"tcp_10\",\n\t\t\t\"class_name\": \"access_role\",\n\t\t\t\"global\": false,\n\t\t\t\"device_id\": 158,\n\t\t\t\"comment\": \"\",\n\t\t\t\"uid\": \"{9EDC2607-6BEC-43D7-A99D-B522BA694ADA}\",\n\t\t\t\"implicit\": false,\n\t\t\t\"max\": false,\n\t\t\t\"min\": false,\n\t\t\t\"protocol\": 6,\n\t\t\t\"timeout\": \"\",\n\t\t\t\"type\": \"tcp_service\",\n\t\t\t}\n\t\t}\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/services/search","description":"You can search for service objects where the name or comment fields have a specified text string,
or you can search for service objects that have an Port or protocol that matches,
or you can search for service objects by uid.

Parameters:
context: Returns results for the specified domain ID. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]
filter: “text” filter returns service objects where the name or comment fields have a specified text string. \n“protocol” filter returns service objects that have a protocol that matches specified IP protocol number.\n“port” filter returns service objects that have a port that matches specified port number.\n “uid“ filter returns service objects with the specified uid.\n If no filter is specified, the “text” filter is used.
device_id: Returns service objects belonging to the specified device_id. [optional]
name: (For “text” filter) You can specify \"name\" to find service objects with the specified text in the name field. [optional]
comment: (For “text” filter) You can specify “comment” to find service objects with the specified text in the comment field. [optional]
protocol: Specify Protocolto find service objects that have the specified IP Protocol. [optional]
port: Specify Portto find service objects that have the specified Port. [optional]
uid: (for “uid“ filter) Returns service objects with the specified uid. [optional]

Usage Example
https://192.168.1.1/securetrack/api/services/search?filter=protocol&protocol=6&device_id=68

Usage Example
https://192.168.1.1/securetrack/api/services/search?filter=port&port=80

Usage Example
https://192.168.1.1/securetrack/api/services/search?filter=uid&uid=24a8774d-24c1-4b3a-aae9-3c272a2b5191

Usage Example
URLhttps://192.168.1.1/securetrack/api/services/search?filter=text&name=tcp_10
BODY{
    \"services\": {
        \"count\": 1,
        \"total\": 1,
        \"service:\": {
            \"id\": 169197,
            \"name\": \"tcp_10\",
            \"display_name\": \"tcp_10\",
            \"class_name\": \"access_role\",
            \"global\": false,
            \"device_id\": 158,
            \"comment\": \"\",
            \"uid\": \"{9EDC2607-6BEC-43D7-A99D-B522BA694ADA}\",
            \"implicit\": false,
            \"max\": false,
            \"min\": false,
            \"protocol\": 6,
            \"timeout\": \"\",
            \"type\": \"tcp_service\",
            }
        }
    }
}

"},"response":[]}]},{"name":"Time Objects","item":[{"name":"Get specific time object","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/time_objects/{{ids}}","description":"Fetches list of time objects by revision ID and rule ID

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Rule IDs

Usage Example
https://192.168.1.1/securetrack/api/revisions/7/time_objects/9
"},"response":[]},{"name":"Get time objects by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/time_objects","description":"Returns the time objects used in the specified device.

Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable values are numeric [optional]
count: Starting page for query allowable values are numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/time_objects
"},"response":[]},{"name":"Get time objects by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/time_objects","description":"Returns the time objects used in the specified revision.

Parameters:
context: Global MSSP context [optional]
id: Revision ID
start: Starting page for query allowable value is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/time_objects
"},"response":[]}]},{"name":"Traffic Policy Matcher","item":[{"name":"Get policy relevance metrics for traffic","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"relevance_metrics\": {\n\t\t\"source_ips\": {\n\t\t\t\"source\":[\"10.10.253.0/24\", \"172.31.50.99/32\"]\n\t\t},\n\t\t\"dest_ips\": {\n\t\t\t\"dest\": [\"172.31.150.0/24\", \"172.31.50.99/32\"]\n\t\t},\n\t\t\"targets\": {\n\t\t\t\"target\": [4, 10]\n\t\t}\n\t}\n}\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/traffic_policy/","description":"The response lists all the relevant security groups, tags, relevant instances, and count of unrelated instances for each Amazon VPC in the specified traffic path.
A relevant security group contains at least one instance including either the source or destination IP address.
An unrelated instance is included in the security group but not part of the specified traffic path.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is used only if MSSP mode is enabled. If MSSP mode is disabled context is ignored.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.

Parameters:
context: Global MSSP context [optional]
body: Relevance metrics request

Usage Example
URLhttps://192.168.1.1/securetrack/api/traffic_policy
BODY{
    \"relevance_metrics\": {
        \"source_ips\": {
            \"source\":[\"10.10.253.0/24\", \"172.31.50.99/32\"]
        },
        \"dest_ips\": {
            \"dest\": [\"172.31.150.0/24\", \"172.31.50.99/32\"]
        },
        \"targets\": {
            \"target\": [4, 10]
        }
    }
}


Response Messages:
200: Successful
401: Insufficient user permissions
404: Device not found
400: Invalid parameters"},"response":[]}]},{"name":"Unified Security Policy - Access Request Violations","item":[{"name":"Start a task to calculate violations for an access request","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t false\n\t 0\n\t \n\t \n\t\t \n\t\t false\n\t\t 10.100.0.1\n\t\t 255.255.255.255\n\t\t \n\t \n\t \n\t\t ssh\n\t\t \n\t\t\t true\n\t\t\t 6\n\t\t\t 6\n\t\t\t 22\n\t\t\t 22\n\t\t\t false\n\t\t \n\t \n\t ACCEPT\n\t\n\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/task","description":"Create a calculation task to find access requests violations.
Returns a task Id that can be used to check the task status and get the task results

Parameters:
body [optional]
use_topology: Use topology to determine access request domains. [optional]
ar_domain_mode: The access request uses resources from multiple domains. [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/violations/access_requests/task?use_topology=false&ar_domain_mode=false
BODY<access_requests>
    <access_request>
     <use_topology>false</use_topology>
     <access_request_order>0</access_request_order>
     <access_request_source xsi:type=\"internet\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"/>
     <access_request_destination xsi:type=\"ip_network\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <network xsi:type=\"raw_network_subnet\">
         <negate>false</negate>
         <ip>10.100.0.1</ip>
         <mask>255.255.255.255</mask>
         </network>
     </access_request_destination>
     <access_request_service xsi:type=\"implicit_service\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <name>ssh</name>
         <service>
             <predefined>true</predefined>
             <min_protocol>6</min_protocol>
             <max_protocol>6</max_protocol>
             <min_port>22</min_port>
             <max_port>22</max_port>
             <negate>false</negate>
         </service>
     </access_request_service>
     <action>ACCEPT</action>
    </access_request>
</access_requests>


Response Messages:
202: Access request violations task was accepted.
400: Access request order is not unique.
400: Domain cannot be specified when domain mode is false.
400: Cannot specify both ticket domain id and source and destination domains.
400: No domain specified in MSSP mode.
400: Domain does not exist.
400: Access request is malformed.
400: No valid access requests (Access requests cannot have topology enabled and the Internet object in the Source/Destination)
400: No network source were specified.
400: No network destination were specified.
401: Access is denied.
503: Access request violations task was rejected."},"response":[]},{"name":"Get violation task results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/result/{{taskId}}","description":"Get result of access requests violations task.

Parameters:
taskId: The unique identifier of the access request violations task.

Usage Example
https://192.168.1.1/securetrack/api/violations/access_requests/result/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Access request violations task results were received.
401: Access is denied.
404: An error occurred during the calculation.
404: The calculation for the task has not finished yet."},"response":[]},{"name":"Cancel violation task","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/task/{{taskId}}","description":"Delete an access request violations task.

Parameters:
taskId: The unique identifier of the access request violations task.

Usage Example
https://192.168.1.1/securetrack/api/violations/access_requests/task/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
204: Access request violations task has been aborted successfully.
401: Access is denied.
404: Access request violations task was not found."},"response":[]},{"name":"Get violation task status","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/status/{{taskId}}","description":"Get access requests violations task status.

Parameters:
taskId: The unique identifier of the access request violations task.

Usage Example
https://192.168.1.1/securetrack/api/violations/access_requests/status/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Access request violations task status was received.
401: Access is denied.
404: Access request violations task status was not found."},"response":[]},{"name":"Get violations for an access request","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t false\n\t 0\n\t \n\t \n\t\t \n\t\t false\n\t\t 10.100.0.1\n\t\t 255.255.255.255\n\t\t \n\t \n\t \n\t\t ssh\n\t\t \n\t\t\t true\n\t\t\t 6\n\t\t\t 6\n\t\t\t 22\n\t\t\t 22\n\t\t\t false\n\t\t \n\t \n\t ACCEPT\n\t\n\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/sync","description":"Calculate the violations for the given access request.
Note: this API may take a while to complete.
See the asynchronous API /violations/access_request/task as an alternative.

Parameters:
body: AccessRequestListDTO
use_topology: Use topology to determine access request domains. [optional]
ar_domain_mode: The access request supports multiple domains. [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/violations/access_requests/sync?use_topology=false&ar_domain_mode=false
BODY<access_requests>
    <access_request>
     <use_topology>false</use_topology>
     <access_request_order>0</access_request_order>
     <access_request_source xsi:type=\"internet\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"/>
     <access_request_destination xsi:type=\"ip_network\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <network xsi:type=\"raw_network_subnet\">
         <negate>false</negate>
         <ip>10.100.0.1</ip>
         <mask>255.255.255.255</mask>
         </network>
     </access_request_destination>
     <access_request_service xsi:type=\"implicit_service\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <name>ssh</name>
         <service>
             <predefined>true</predefined>
             <min_protocol>6</min_protocol>
             <max_protocol>6</max_protocol>
             <min_port>22</min_port>
             <max_port>22</max_port>
             <negate>false</negate>
         </service>
     </access_request_service>
     <action>ACCEPT</action>
    </access_request>
</access_requests>


Response Messages:
200: Access request violations were calculated.
400: Access request order is not unique.
400: Domain cannot be specified when domain mode is false.
400: Cannot specify both ticket domain id and source and destination domains.
400: No domain specified in MSSP mode.
400: Domain does not exist.
400: Access request is malformed.
400: No valid access requests (Access requests cannot have topology enabled and the Internet object in the Source/Destination).
401: Access is denied."},"response":[]}]},{"name":"Unified Security Policy - Alerts","item":[{"name":"Delete alerts by ids","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/{{ids}}","description":"Delete specified alerts by IDs
To delete multiple alert_ids, use a comma between each ID

Parameters:
context: Delete alerts in the specified domain ID. [optional]
ids: The alert Ids for deletion

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts/87

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts/86,87,88

Response Messages:
200:
401: Security Policy Alert Ids: :|'alert ids'| don't exist"},"response":[]},{"name":"Get a specific alert","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/{{id}}","description":"Returns a specified alert.
If the alert_id does not exist, an error message is returned.

Parameters:
context: MSSP context [optional]
id: The alert Id

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts/1

Response Messages:
401: Alert ID does not exist"},"response":[]},{"name":"Update an alert","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"usp_alert_configuration\": {\n\t\t\"name\": \"uspAlert\",\n\t\t\"description\": \"description\",\n\t\t\"status\": \"ACTIVE\",\n\t\t\"domain_id\": 6,\n\t\t\"all_devices\": false,\n\t\t\"device_ids\": {\n\t\t\t\"device_id\": [\n\t\t\t\t1,\n\t\t\t\t2,\n\t\t\t\t3,\n\t\t\t\t4\n\t\t\t]\n\t\t},\n\t\t\"low_severity\": true,\n\t\t\"medium_severity\": true,\n\t\t\"high_severity\": true,\n\t\t\"critical_severity\": false,\n\t\t\"user_ids\": {\n\t\t\t\"user_id\": \"moshe\"\n\t\t},\n\t\t\"emails\": \"user@doamin.com\",\n\t\t\"send_syslog\": true\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/{{id}}","description":"Update an alert for unified security policies.
Alerts can be defined for all devices (all_devices:true) or for specified device IDs.
An email and/or user name must be defined. For multiple entries of emails or user names, use a semicolon to separate values. For SecureTrack, users in the collection are populated with \"user_ids\". The alert will be sent to the users (according to the addresses configured in SecureTrack) and to the emails.
To get the domain_id (optional parameter), call /domains/ API and use the ID included within the returned domain DTO.
At least one severity should be marked as 'true'.
There are no default values

Parameters:
context: Global MSSP context [optional]
id: The alert ID for updating [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_policies/alerts/1
BODY{
    \"usp_alert_configuration\": {
        \"name\": \"uspAlert\",
        \"description\": \"description\",
        \"status\": \"ACTIVE\",
        \"domain_id\": 6,
        \"all_devices\": false,
        \"device_ids\": {
            \"device_id\": [
                1,
                2,
                3,
                4
            ]
        },
        \"low_severity\": true,
        \"medium_severity\": true,
        \"high_severity\": true,
        \"critical_severity\": false,
        \"user_ids\": {
            \"user_id\": \"moshe\"
        },
        \"emails\": \"user@doamin.com\",
        \"send_syslog\": true
    }
}


Response Messages:
204: Alert ID: 'alertId' was updated successfully
404: Alert ID: 'alertId' does not exist
412: Alert name not specified
409: Alert name specified already exists
412: Status not specified
412: Domain not specified
404: Domain specified does not exist
401: User is not authorized to configure alerts for domain 'domainId'
412: Device not specified
404: Device ID specified does not exist or belongs to a different domain
403: Device: 'deviceId' not supported for USP
412: Severity not specified
412: No recipient details entered for alert
412: Invalid email address. Format must be name@domain.com
404: Username: 'userName' does not exist
403: User is not authorized to configure alerts for Super Admin user: 'userName'
403: Username: 'userName' not valid for the specified domain"},"response":[]},{"name":"Get alerts","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"start"},{"value":null,"type":"text","key":"count"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/","description":"Returns a list of all alerts. If an empty list is returned, it implies that there are no configured alerts for that context.
You must set start and count parameters to limit the number of returned alerts.
Start is zero based - to start from the second rule use start=1, to get rules 51-60 use start=50 and count=10.

Parameters:
context: MSSP context [optional]
start: Returns the results beginning with the specified result number
count: Returns the specified number of results

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts?start=10&count=25

Response Messages:
400: Value for start parameter is missing or not valid
400: Value for count parameter is missing or not valid"},"response":[]},{"name":"Create an alert","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"usp_alert_configuration\": {\n\t\t\"name\": \"uspAlert\",\n\t\t\"description\": \"description\",\n\t\t\"status\": \"ACTIVE\",\n\t\t\"domain_id\": 6,\n\t\t\"all_devices\": false,\n\t\t\"device_ids\": {\n\t\t\t\"device_id\": [\n\t\t\t\t1,\n\t\t\t\t2,\n\t\t\t\t3,\n\t\t\t\t4\n\t\t\t]\n\t\t},\n\t\t\"low_severity\": true,\n\t\t\"medium_severity\": true,\n\t\t\"high_severity\": true,\n\t\t\"critical_severity\": false,\n\t\t\"user_ids\": {\n\t\t\t\"user_id\": \"moshe\"\n\t\t},\n\t\t\"emails\": \"user@doamin.com\",\n\t\t\"send_syslog\": true\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/","description":"Create an alert for unified security policies.
Returns location with the alert id to get the alert.
Alerts can be defined for all devices (all_devices:true) or for specified device IDs.
An email and/or user name must be defined. For multiple entries of emails or user names, use a semicolon to separate values. For SecureTrack, users in the collection are populated with \"user_ids\". The alert will be sent to the users (according to the addresses configured in SecureTrack) and to the emails.
To get the domain_id (optional parameter), call /domains/ API and use the ID included within the returned domain DTO.
At least one severity should be marked as 'true'.
There are no default values

Parameters:
context: Global MSSP context [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_policies/alerts
BODY{
    \"usp_alert_configuration\": {
        \"name\": \"uspAlert\",
        \"description\": \"description\",
        \"status\": \"ACTIVE\",
        \"domain_id\": 6,
        \"all_devices\": false,
        \"device_ids\": {
            \"device_id\": [
                1,
                2,
                3,
                4
            ]
        },
        \"low_severity\": true,
        \"medium_severity\": true,
        \"high_severity\": true,
        \"critical_severity\": false,
        \"user_ids\": {
            \"user_id\": \"moshe\"
        },
        \"emails\": \"user@doamin.com\",
        \"send_syslog\": true
    }
}


Response Messages:
201: Security policy alert id :|'alertId'| , name : 'alertName'
412: Alert name not specified
409: Alert name specified already exists
412: Status not specified
412: Domain not specified
404: Domain specified does not exist
401: User is not authorized to configure alerts for domain 'domainId'
412: Device not specified
404: Device ID specified does not exist or belongs to a different domain
403: Device: 'deviceId' not supported for USP
412: Severity not specified
412: No recipient details entered for alert
412: Invalid email address. Format must be name@domain.com
404: Username: 'userName' does not exist
403: User is not authorized to configure alerts for Super Admin user: 'userName'
403: Username: 'userName' not valid for the specified domain"},"response":[]}]},{"name":"Unified Security Policy - Cloud Tag Policy","item":[{"name":"Create a cloud tag policy","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":" {\n\t\"policy_name\": \"Production-VPC-Tag-Policy\",\n\t\"policy_description\": \"Instances tags in production\",\n\t\"requirements\": [\n\t\t{\n\t\t\t\"requirement_type\": \"mandatory_tags\",\n\t\t\t\"requirement_name\": \"mandatory_financial_tags\",\n\t\t\t\"requirement_severity\": \"HIGH\",\n\t\t\t\"tags\": [\n\t\t\t\t\"Owner\",\n\t\t\t\t\"Budget\"\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"requirement_type\": \"valid_values\",\n\t\t\t\"requirement_name\": \"budget_valid_values\",\n\t\t\t\"requirement_severity\": \"CRITICAL\",\n\t\t\t\"tag\": \"Budget\",\n\t\t\t\"values\": [\n\t\t\t\t\"Corporate\",\n\t\t\t\t\"Dev\"\n\t\t\t]\n\t\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/policies/","description":"Create a new cloud tag policy. The policyName field specified in the TagPolicyDTO must be unique. Define the requirements enforced by the cloud tag policy in the requirements field of the TagPolicyDTO. The supported value for the \"requirement_type\" field are \"mandatory_tags\" and \"valid_values\"If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Create policy for the specified domain ID [optional]
body: cloud tag policy DTO [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/
BODY {
    \"policy_name\": \"Production-VPC-Tag-Policy\",
    \"policy_description\": \"Instances tags in production\",
    \"requirements\": [
        {
            \"requirement_type\": \"mandatory_tags\",
            \"requirement_name\": \"mandatory_financial_tags\",
            \"requirement_severity\": \"HIGH\",
            \"tags\": [
                \"Owner\",
                \"Budget\"
            ]
        },
        {
            \"requirement_type\": \"valid_values\",
            \"requirement_name\": \"budget_valid_values\",
            \"requirement_severity\": \"CRITICAL\",
            \"tag\": \"Budget\",
            \"values\": [
                \"Corporate\",
                \"Dev\"
            ]
        }
    ]
}
OUTPUT{
        \"status\": \"OK\",
        \"policy_id\": \"tp-123\"
}


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions
409: Policy name already exists"},"response":[]},{"name":"Get all cloud tag policies","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/policies/","description":"This API returns the details of all the tag policies.

Results are filtered according to user domain permissions and request context. If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Returns results for the specified domain ID [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/
OUTPUT{
        \"status\": \"OK\",
        \"result\": [
                {
                        \"policy_id\": \"tp-101\",
                        \"policy_name\": \"myPolicy1\",
                        \"requirements\": [
                                {
                                        \"requirement_type\": \"mandatory_tags\",
                                        \"requirement_name\": \"myMandatoryRequirement\",
                                        \"requirement_severity\": \"HIGH\",
                                        \"tags\": [
                                                \"Owner\",
                                                \"Name\"
                                        ]
                                },
                                {
                                        \"requirement_type\": \"valid_values\",
                                        \"requirement_name\": \"myValidValueRequirement\",
                                        \"requirement_severity\": \"CRTICAL\",
                                        \"tag\": \"Budget\",
                                        \"values\": [
                                                \"R&D\",
                                                \"HR\"
                                        ]
                                }
                        ]
                },
                {
                        \"policy_id\": \"tp-102\",
                        \"policy_name\": \"myPolicy2\",
                        \"requirements\": [
                                {
                                        \"requirement_type\": \"mandatory_tags\",
                                        \"requirement_name\": \"myMandatoryRequirement\",
                                        \"requirement_severity\": \"HIGH\",
                                        \"tags\": [
                                                \"Owner\"
                                        ]
                                },
                                {
                                        \"requirement_type\": \"valid_values\",
                                        \"requirement_name\": \"myValidValueRequirement\",
                                        \"requirement_severity\": \"CRTICAL\",
                                        \"tag\": \"Budget\",
                                        \"values\": [
                                                \"R&D\",
                                                \"HR\"
                                        ]
                                }
                        ]
                }
        ]
}


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions"},"response":[]},{"name":"Replace a cloud tag policy","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"policy_name\": \"myPolicyName\",\n\t\"requirements\": [\n\t\t{\n\t\t\t\"requirement_type\": \"mandatory_tags\",\n\t\t\t\"requirement_name\": \"mandatory_requirement1\",\n\t\t\t\"requirement_severity\": \"CRTICAL\",\n\t\t\t\"tags\": [\n\t\t\t\t\"Owner\",\n\t\t\t\t\"Role\"\n\t\t\t]\n\t\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","description":"Replace the cloud tag policy specified by policyID with the new policy attributes.

Use PATCH in order to partially modify a policy. If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Replace policy of the specified domain ID [optional]
policyId: cloud tag policy id [optional]
body: cloud tag policy dTO [optional]

Usage Example
URLhttps://{ip}/securetrack/api/tagpolicy/policies/policyId
BODY{
    \"policy_name\": \"myPolicyName\",
    \"requirements\": [
        {
            \"requirement_type\": \"mandatory_tags\",
            \"requirement_name\": \"mandatory_requirement1\",
            \"requirement_severity\": \"CRTICAL\",
            \"tags\": [
                \"Owner\",
                \"Role\"
            ]
        }
    ]
}
OUTPUT{
        \"status\": \"OK\",
        \"policy_id\": \"tp-123\"
}

"},"response":[]},{"name":"Get cloud tag policy","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","description":"This API retrieves the details of the cloud tag policy specified by policyId.

User must have admin permissions to the policy affiliated domain. If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Returns results for the specified domain ID [optional]
policyId: cloud tag policy id [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/policyId
OUTPUT{
        \"status\": \"OK\",
        \"result\": [
                {
                        \"policy_id\": \"tp-101\",
                        \"policy_name\": \"myPolicyName\",
                        \"requirements\": [
                                {
                                        \"requirement_type\": \"mandatory_tags\",
                                        \"requirement_name\": \"myMandatoryTagsRequirement\",
                                    \"requirement_severity\": \"CRTICAL\",
                                        \"tags\": [
                                                \"Owner\",
                                                \"Name\"
                                        ]
                                },
                                {
                                        \"requirement_type\": \"valid_values\",
                                        \"requirement_name\": \"myValidValueRequirement\",
                                    \"requirement_severity\": \"CRTICAL\",
                                        \"tag\": \"Budget\",
                                        \"values\": [
                                                \"R&D\",
                                                \"HR\"
                                        ]
                                }
                        ]
                }
        ]
}


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions
404: Resource not found"},"response":[]},{"name":"Modify a cloud tag policy","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"policy_name\": \"myPolicyName\",\n\t\"requirements\": [\n\t\t{\n\t\t\t\"requirement_type\": \"mandatory_tags\",\n\t\t\t\"requirement_name\": \"mandatory_requirement1\",\n\t\t\t\"requirement_severity\": \"CRTICAL\",\n\t\t\t\"tags\": [\n\t\t\t\t\"Owner\",\n\t\t\t\t\"Role\"\n\t\t\t]\n\t\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","description":"Partially modify a cloud tag policy by stating the modified attributes. Providing requirements replaces the entire list.

Specifying an empty requirement list is not permitted. Modify some attributes of the cloud tag policy specified by policyID with the attributes provided. If one or more \"requirement\" objects is provided, the exsiting \"requirement\" objects will be deleted and replaced with the new objetcs. Specifying an empty requirement list is not permitted.If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Rename policy of the specified domain ID [optional]
policyId: cloud tag policy id [optional]
body: cloud tag policy dTO [optional]

Usage Example
URLhttps://{ip}/securetrack/api/tagpolicy/policies/policyId
BODY{
    \"policy_name\": \"myPolicyName\",
    \"requirements\": [
        {
            \"requirement_type\": \"mandatory_tags\",
            \"requirement_name\": \"mandatory_requirement1\",
            \"requirement_severity\": \"CRTICAL\",
            \"tags\": [
                \"Owner\",
                \"Role\"
            ]
        }
    ]
}
OUTPUT{
        \"status\": \"OK\",
        \"policy_id\": \"tp-123\"
}


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions
404: Resource not found"},"response":[]},{"name":"Delete cloud tag policy","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","description":"Delete the cloud tag policy specified by policyId.

If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Delete policy of the specified domain ID [optional]
policyId: cloud tag policy id [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/policyId
OUTPUT {
        \"status\": \"OK\",
        \"policy_name\": \"myPolicyName\"
}


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions
404: Resource not found"},"response":[]},{"name":"Check if tags are compliant with cloud tag policies","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":" {\n\t\"type\": \"vm\",\n\t\"name\": \"CRM-FE\",\n\t\"os\": \"ubuntu14.4\",\n\t\"image\": \"AMI-12345\",\n\t\"tags\": {\n\t\t\"Role\": \"webserver\",\n\t\t\"Budget\": \"corporate\",\n\t\t\"Owner\": \"Steve.Smith\"\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/violation_check/","description":"Check if the tags of a cloud resource are compliant with the specified cloud tag policy. Specify the tag policy to validate in the TagPolicyViolationsCheckRequestDTO. The tags of a cloud resource are specified as a json object with the attribute 'tags' at the root level. 'tags' attributes can be a list of tag names or a map including both the tag name and value. If no tags are specified or if the tag is specified incorrectly, The compliance check will treat the resource as if it has no tags. If no cloud tag policy violations are found the API returns an empty violations list.

Parameters:
context: Returns results for the specified domain ID [optional]
policy_external_id: Tag policy external identifier
body: Tag policy violation check request

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/violation_check?policy_external_id=policyId
BODY {
    \"type\": \"vm\",
    \"name\": \"CRM-FE\",
    \"os\": \"ubuntu14.4\",
    \"image\": \"AMI-12345\",
    \"tags\": {
        \"Role\": \"webserver\",
        \"Budget\": \"corporate\",
        \"Owner\": \"Steve.Smith\"
    }
}


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions
404: Resource not found"},"response":[]},{"name":"Get all cloud tag policy violations for a VPC","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"deviceId"},{"value":null,"type":"text","key":"severity"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/tag_violations/","description":"Retrieve all cloud tag policy violations for the specified VPC and severity level.

Parameters:
context: Global MSSP context. [optional]
deviceId: The device ID for which to get violations
severity: Return only violations of this severity
resourceId: The id of the VM instance [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses \"count=100\". [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tag_violations?deviceId=123&severity=CRITICAL
OUTPUT<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<tag_policy_device_violations>
    <violating_resources_count>2</violating_resources_count>
    <device_name>Amazon Test VPC </device_name>
    <severity>critical</severity>
    <violating_resources>
        <violating_resource>
            <tag_violations>
                <tag_violation>
                    <violation_message>Tag 'Name' value 'email server' is not valid. Valid values are [R&D, HR]</violation_message>
                    <policy_id>tp-100</policy_id>
                    <policy_name>Tag policy 1</policy_name>
                    <requirement_name>validValue_constraint2</requirement_name>
                    <requirement_severity>high</requirement_severity>
                    <violation_attributes xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"valid_values\">
                        <tag>Name</tag>
                        <valid_values>
                            <valid_value>R&D</valid_value>
                            <valid_value>HR</valid_value>
                        </valid_values>
                        <invalid_value>email server</invalid_value>
                    </violation_attributes>
                </tag_violation>
            </tag_violations>
            <resource_id>i-abc12345</resource_id>
            <resource_name>email server</resource_name>
        </violating_resource>
        <violating_resource>
            <tag_violations>
                <tag_violation>
                    <violation_message>Tag 'Application' is missing</violation_message>
                    <policy_id>tp-105</policy_id>
                    <policy_name>Tag policy 1</policy_name>
                    <requirement_name>mandatory_constraint1</requirement_name>
                    <requirement_severity>critical</requirement_severity>
                    <violation_attributes xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"mandatory_tags\">
                        <missing_tag>Application</missing_tag>
                    </violation_attributes>
                </tag_violation>
            </tag_violations>
            <resource_id>i-12345678</resource_id>
            <resource_name>Violations tests server</resource_name>
        </violating_resource>
    </violating_resources>
</tag_policy_device_violations>


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions
404: A device with the specified ID was not found"},"response":[]}]},{"name":"Unified Security Policy - Exceptions","item":[{"name":"Delete an exception","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"exceptionId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/{{exceptionId}}","description":"Delete the specific unified security policy exceptions

Parameters:
exceptionId: The ID of the exception to delete.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/14

Response Messages:
404: The security policy with the specified ID does not exist
401: User not permitted to access the specified domain."},"response":[]},{"name":"Get a specific exception","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"exceptionId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/{{exceptionId}}","description":"Gets a specific exception for unified security policies.

Parameters:
exceptionId: The ID of the exception to get.
context: Global MSSP context [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/14

Response Messages:
401: User not permitted to access the specified domain
404: A security policy exception with the specified ID was not found."},"response":[]},{"name":"Get matching rules task status","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/matching_rules/status/{{taskId}}","description":"Parameters:
taskId: The unique identifier of the matching rules task.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/matching_rules/status/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Matching rules task status was received.
401: User not permitted to Security policy exceptions.
404: Matching rules task status was not found."},"response":[]},{"name":"Create an exception","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\n\tadmin\n\tst_user\n\t2015-01-01\n\tAllow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321\n\t\n\t\t\n\t\t\tCreating USP exception for ticket 123\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t192.168.1.2\n\t\t\t\t\t\t255.255.255.255\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\tLAN\n\t\t\t\t\tcorporate security policy\n\t\t\t\t\tDMZ\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t4321\n\t\t\t\t\t\ttcp\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t1\n\t\t\t\t\t\t{5aa1c104-bd4d-4635-a281-b3a5442639ba}\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\thttp\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t10\n\t\t\t\t\t\t20\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t192.168.1.1\n\t\t\t\t\t\t255.255.255.255\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\t2025-01-01\n\tAllow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321\n\tadmin\n\t123\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/","description":"Create an exception for unified security policies.

Parameters:
context: Global MSSP context [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_policies/exceptions
BODY<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<security_policy_exception>
    <approved_by>admin</approved_by>
    <created_by>st_user</created_by>
    <creation_date>2015-01-01</creation_date>
    <description>Allow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321</description>
    <exempted_traffic_list>
        <exempted_traffic>
            <comment>Creating USP exception for ticket 123</comment>
            <dest_network_collection>
                <network_items>
                    <network_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"subnet\">
                        <ip>192.168.1.2</ip>
                        <netmask>255.255.255.255</netmask>
                    </network_item>
                </network_items>
            </dest_network_collection>
            <security_requirements>
                <zone_to_zone_security_requirement>
                    <from_zone>LAN</from_zone>
                    <policy_name>corporate security policy</policy_name>
                    <to_zone>DMZ</to_zone>
                </zone_to_zone_security_requirement>
            </security_requirements>
            <service_collection>
                <service_items>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"custom\">
                        <port>4321</port>
                        <protocol>tcp</protocol>
                    </service_item>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"device_service\">
                        <mgmt_id>1</mgmt_id>
                        <service_uid>{5aa1c104-bd4d-4635-a281-b3a5442639ba}</service_uid>
                    </service_item>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"predefined\">
                        <predefined_service_name>http</predefined_service_name>
                    </service_item>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"range_service\">
                        <minProtocol>10</minProtocol>
                        <maxProtocol>20</maxProtocol>
                    </service_item>
                </service_items>
            </service_collection>
            <source_network_collection>
                <network_items>
                    <network_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"subnet\">
                        <ip>192.168.1.1</ip>
                        <netmask>255.255.255.255</netmask>
                    </network_item>
                </network_items>
            </source_network_collection>
        </exempted_traffic>
    </exempted_traffic_list>
    <expiration_date>2025-01-01</expiration_date>
    <name>Allow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321</name>
    <requested_by>admin</requested_by>
    <ticket_id>123</ticket_id>
</security_policy_exception>


Response Messages:
400: The specified network item is not valid.
400: The specified zone name does not exist.
400: The security policy with the specified name does not exist
400: The security policy 'created by' user is not valid.
400: The security policy with the specified name already exists.
401: User not permitted to access the specified domain."},"response":[]},{"name":"Get all exceptions","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/","description":"Gets a list of all unified security policy exceptions.

Parameters:
context: Global MSSP context [optional]
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query starting from starting page allowable type in numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions

Response Messages:
401: User not permitted to access the specified domain"},"response":[]},{"name":"Start a task to calculate matching rules for an exception","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"exceptionId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/{{exceptionId}}/matching_rules/start","description":"Create a calculation task to find matching rules.
The results will be on the relevant devices for each access.
Returns a task Id that can be used to check the task status and get the task results

Parameters:
exceptionId: Security policy Exception ID on which to run the API.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/1/matching_rules/start

Response Messages:
401: User not permitted to Security policy exceptions.
404: A security policy exception with the specified ID was not found."},"response":[]},{"name":"Get matching rules task results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/matching_rules/result/{{taskId}}","description":"Parameters:
taskId: The unique identifier of the matching rules task.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/matching_rules/result/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Matching rules task results were received.
401: User not permitted to Security policy exceptions.
404: An error occurred during the calculation.
404: The calculation for the task has not finished yet."},"response":[]},{"name":"Cancel Matching rules task","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/matching_rules/{{taskId}}","description":"Parameters:
taskId: The unique identifier of the matching rules task.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/matching_rules/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
204: Matching rules task has been aborted successfully.
401: User not permitted to Security policy exceptions.
404: Matching rules task was not found."},"response":[]}]},{"name":"Unified Security Policy - Security Zone Matrix","item":[{"name":"Set manual device mapping","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n \n Vlan_30\n \n \n 10\n add\n \n \n \n\n "},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/{{deviceId}}/manual_mapping","description":"Add or remove a zone on a device interface

Parameters:
context: Global MSSP context [optional]
deviceId: Device ID
body: InterfacesManualMappingsDTO

Usage Example
URLhttps://127.0.0.1/securetrack/api/security_policies/10/manual_mapping
BODY<interfaces_manual_mappings>
<interface_manual_mapping>
<interface_name>Vlan_30</interface_name>
<zones_user_actions>
<zone_user_action>
<zoneId>10</zoneId>
<action>add</action>
</zone_user_action>
</zones_user_actions>
</interface_manual_mapping>
</interfaces_manual_mappings>


Response Messages:
200: Successful
400: Invalid request
401: Insufficient user permissions
404: Not found error
404: User action not valid (only add/remove)
404: No interface with name for device with id
404: No zone with id
404: No revision for device with id
404: No device with ID
404: Access denied for device with ID
404: InterfacesManualMappingsDTO is empty
404: Error on updating security_policy_interface_zone_mapping_user_action table for device with ID"},"response":[]},{"name":"Delete unified security policy","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/{{id}}","description":"Delete a Security Policy Matrix

Parameters:
context: Returns results for the specified domain ID. [optional]
id: The unique identifier of the security policy matrix to delete

Usage Example
https://192.168.1.1/securetrack/api/security_policies/1
"},"response":[]},{"name":"Get global unified security policies","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/global","description":"Fetches the global security zone matrices defined under Unified Security Policy.



Usage Example
https://192.168.1.1/securetrack/api/security_policies/global

Response Messages:
401: User not permitted to access global security policies"},"response":[]},{"name":"Get unified security policy as CSV","request":{"method":"GET","header":[],"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/{{id}}/export","description":"Exports a Security Policy in CSV format

Parameters:
context: Returns results for the specified domain ID. [optional]
id: ID of the security policy. [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies/1/export

Response Messages:
401: User not permitted to access the specified domain
404: Security Policy does not exist"},"response":[]},{"name":"Get unified security policies","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/","description":"Fetches the security zone matrices defined under Unified Security Policy.

Parameters:
context: Returns results for the specified domain ID. [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies

Response Messages:
401: User not permitted to access the specified domain"},"response":[]}]},{"name":"Unified Security Policy - Violations","item":[{"name":"Get the amount of violating rules for the specified device.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"deviceId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/violating_rules/{{deviceId}}/count","description":"Parameters:
deviceId: The device ID for which to get violations.

Usage Example
https://192.168.1.1/securetrack/api/violating_rules/1/count

Response Messages:
200: The violation count was successfully retrieved
404: Device with id: <deviceId> doesn't exist"},"response":[]},{"name":"Get the violating rules for the specified device.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"deviceId"},{"value":null,"type":"text","key":"severity"},{"value":null,"type":"text","key":"type"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/violating_rules/{{deviceId}}/device_violations","description":"policyName is supported for management devices running in Advanced management mode.

Parameters:
deviceId: The device ID for which to get violations
policyName: Return only violations that match this policy [optional]
severity: Return only violations of this severity
type: Return only violations of this type

Usage Example
https://192.168.1.1/securetrack/api/violating_rules/1/device_violations?policy=policy_name&type=SECURITY_POLICY&severity=MEDIUM

Response Messages:
200: The violations were successfully retrieved
400: The specified value for the violation severity is invalid
400: The specified value for the violation type is invalid
400: You cannot specify a policyName because the device is not running in Advanced management mode
404: A device with the specified ID was not found
404: A policy with the specified policyName was not found for this device"},"response":[]}]}]} \ No newline at end of file diff --git a/Postman Format v2/R20-1 postman collection/tufin.postman_environment b/Postman Format v2/R20-1 postman collection/tufin.postman_environment new file mode 100644 index 0000000..c031d2b --- /dev/null +++ b/Postman Format v2/R20-1 postman collection/tufin.postman_environment @@ -0,0 +1 @@ +{"name":"Tufin environment","values":[{"type":"text","key":"SecureApp_IP"},{"type":"text","key":"SecureChange_IP"},{"type":"text","key":"SecureTrack_IP"},{"type":"text","key":"applicationId"},{"type":"text","key":"applicationInterfaceId"},{"type":"text","key":"application_id"},{"type":"text","key":"application_pack_id"},{"type":"text","key":"assigneeId"},{"type":"text","key":"child_id"},{"type":"text","key":"child_ids"},{"type":"text","key":"cleanup_id"},{"type":"text","key":"cloudId"},{"type":"text","key":"cloud_id"},{"type":"text","key":"connectionId"},{"type":"text","key":"connectionInterfaceId"},{"type":"text","key":"connectionToApplicationId"},{"type":"text","key":"connection_id"},{"type":"text","key":"connection_to_application_pack_id"},{"type":"text","key":"customer_id"},{"type":"text","key":"deviceId"},{"type":"text","key":"device_id"},{"type":"text","key":"domainId"},{"type":"text","key":"exceptionId"},{"type":"text","key":"fieldId"},{"type":"text","key":"id"},{"type":"text","key":"ids"},{"type":"text","key":"inId"},{"type":"text","key":"instructionId"},{"type":"text","key":"interfaceCustomerId"},{"type":"text","key":"layer2DataId"},{"type":"text","key":"managementId"},{"type":"text","key":"mgmtId"},{"type":"text","key":"parent_id"},{"type":"text","key":"parent_ids"},{"type":"text","key":"policyId"},{"type":"text","key":"requestId"},{"type":"text","key":"revId"},{"type":"text","key":"revision_id"},{"type":"text","key":"risk_id"},{"type":"text","key":"routeId"},{"type":"text","key":"ruleId"},{"type":"text","key":"rule_id"},{"type":"text","key":"rule_uid"},{"type":"text","key":"serverId"},{"type":"text","key":"serviceId"},{"type":"text","key":"sourceApplicationId"},{"type":"text","key":"stepId"},{"type":"text","key":"tag_id"},{"type":"text","key":"targetApplicationId"},{"type":"text","key":"taskId"},{"type":"text","key":"task_id"},{"type":"text","key":"task_uid"},{"type":"text","key":"toStepId"},{"type":"text","key":"uid"},{"type":"text","key":"userId"},{"type":"text","key":"vpnId"},{"type":"text","key":"zone_id"},{"type":"text","key":"zone_ids"}]} \ No newline at end of file diff --git a/Postman Format v2/R20-2 postman collection/securechangeworkflow_R20-2-HF2-v2.json b/Postman Format v2/R20-2 postman collection/securechangeworkflow_R20-2-HF2-v2.json new file mode 100644 index 0000000..a458c72 --- /dev/null +++ b/Postman Format v2/R20-2 postman collection/securechangeworkflow_R20-2-HF2-v2.json @@ -0,0 +1 @@ +{"info":{"_postman_id":"2","name":"Tufin Tufin SecureChange/SecureApp R20-2-HF2","description":"Tufin Orchestration Suite - Tufin SecureChange/SecureApp APIs.
For detailed information about the APIs please see the documentation at:
https://your-securetrack-server/securechangeworkflow/apidoc","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json"},"item":[{"name":"Access Portal","item":[{"name":"Retrieve existing application access requests","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests","description":"Parameters:
applicationId: The unique identifier of the application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests

Response Messages:
400: The application was already deleted.
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID."},"response":[]},{"name":"Create application access request","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t1\n\t1.1.1.1\n\tRequest to join the WebServers server group\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests","description":"Parameters:
applicationId: The unique identifier of the application
body: application access request

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests
BODY<application_access_request>
    <server_group_id>1</server_group_id>
    <server_ip>1.1.1.1</server_ip>
    <comment>Request to join the WebServers server group</comment>
</application_access_request>


Response Messages:
201: Application access request was submitted.
400: The application was already deleted.
400: Server id cannot be empty.
400: Hostname or IP cannot be empty.
400: The provided server does not exist in application.
400: The provided server is not allowed to access.
400: Request already created
400: Requester cannot be null
400: Group cannot be empty
400: Invalid ip
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]},{"name":"Update application access requests","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t1\n\t\tAPPROVE\n\t\n\t\n\t\t2\n\t\tREJECT\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests","description":"Use this API to approve or reject application access requests

Parameters:
applicationId: The unique identifier of the application
body: application access requests

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests
BODY<application_access_requests>
    <application_access_request>
        <id>1</id>
        <action>APPROVE</action>
    </application_access_request>
    <application_access_request>
        <id>2</id>
        <action>REJECT</action>
    </application_access_request>
</application_access_requests>


Response Messages:
200: Application access requests were updated.
400: The application was already deleted.
400: Invalid ID for access request
400: Cannot update access request with id ID
400: Action cannot be empty in request with id ID
400: Invalid action in request with id ID
400: The Server group is lock for discovery
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]},{"name":"Update an application access request","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tAPPROVE\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests/{{requestId}}","description":"Use this API to approve or reject application access requests

Parameters:
applicationId: The unique identifier of the application
requestId: The unique identifier of the application access request
body: application access request

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests/1
BODY<application_access_request>
    <action>APPROVE</action>
</application_access_request>


Response Messages:
200: Application access request was updated.
400: The application was already deleted.
400: Invalid ID for access request
400: Cannot update access request with id ID
400: Action cannot be empty in request with id ID
400: Invalid action in request with id ID
400: The Server group is lock for discovery
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]},{"name":"Retrieve an existing application access request by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"requestId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests/{{requestId}}","description":"Parameters:
applicationId: The unique identifier of the application
requestId: The unique identifier of the application access request

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests/1

Response Messages:
400: The application was already deleted.
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Access request with id ID was not found in application with id ID"},"response":[]}]},{"name":"Application Connections","item":[{"name":"Retrieve existing connections, with extended resources information","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_extended","description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the connection [optional]
start: Return results starting only from the specified index; 0-based index; default value = 0 [optional]
count: Return the specified number of results. Returns all results if no value specified [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended?name=Connection Name

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended?name=Connection Name&start=50&count=100

Response Messages:
400: Start value cannot be a negative number.
400: Count value must be greater than 0.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: Access is denied.
404: There is no application with the specified ID.
404: There are no connections with the name NAME."},"response":[]},{"name":"Create a ticket to repair a connection","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tRepair connection 2\n\tu1\n\tNormal\n\t\n\t\tWorkflow with topology\n\t\n\t\n\t\t\n\t\t\tOpen request\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tBusiness Justification\n\t\t\t\t\t\t\tI need access to ftp \n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tProject Number\n\t\t\t\t\t\t\tCR124560\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tHyperlink\n\t\t\t\t\t\t\thttp://192.168.1.1/ticket\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tChange Window\n\t\t\t\t\t\t\tMonday\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tmanager email\n\t\t\t\t\t\t\tmanager@tufin.com\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connections/{{connection_id}}/repair","description":"Parameters:
application_id: The application ID
connection_id: The connection ID
body: Ticket

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/2/repair
BODY<ticket>
    <subject>Repair connection 2</subject>
    <requester>u1</requester>
    <priority>Normal</priority>
    <workflow>
        <name>Workflow with topology</name>
    </workflow>
    <steps>
        <step>
            <name>Open request</name>
            <tasks>
                <task>
                    <fields>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_area\">
                            <name>Business Justification</name>
                            <text>I need access to ftp </text>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_field\">
                            <name>Project Number</name>
                            <text>CR124560</text>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"hyperlink\">
                            <name>Hyperlink</name>
                            <url>http://192.168.1.1/ticket</url>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"drop_down_list\">
                            <name>Change Window</name>
                            <selection>Monday</selection>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"manager\">
                            <name>manager email</name>
                            <text>manager@tufin.com</text>
                        </field>
                    </fields>
                </task>
            </tasks>
        </step>
    </steps>
    <comments/>
</ticket>


Response Messages:
201: Ticket was created.
400: The requester must be the currently logged in user.
400: Workflow was not found.
400: Workflow is not active.
400: Workflow configuration is not valid.
400: Workflow is not set.
400: You cannot enter a status for a new ticket.
400: Requester cannot open a ticket in domain.
400: Invalid ticket priority.
400: Expiration field is required.
400: Submit ticket enabled only with the first step.
400: First step can be only with one task.
400: The specified workflow does not contain an access request field in the first step.
400: You cannot use an access request field to create a ticket from SecureApp.
400: The ticket fields do not match the fields in the current step of the workflow.
400: You cannot change the value of a field because it is read-only.
403: Logged in user: NAME do not have permission to perform on behalf actions.
403: You are not a participant in the first step of this workflow.
403: Access is denied.
403: To create a ticket you must purchase a valid SecureChange license.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: Cannot create a ticket to repair this connection because the connection status is not disconnected.
403: Cannot create a ticket to repair this connection because the connection was edited but a ticket has not been created yet.
403: Cannot create a ticket to repair this connection because there are other open tickets for an application that includes this connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID."},"response":[]},{"name":"Retrieve an existing connection by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"connectionId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}","description":"Parameters:
applicationId: The unique identifier of the application
connectionId: The unique identifier of the connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/1

Response Messages:
401: No available licenses. Ask your SecureApp administrator for assistance.
403: Access is denied
403: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID."},"response":[]},{"name":"Update a connection","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":" \n\t Connection A\n\t Connection A comment\n\t \n\t\t \n\t\t\t 2\n\t\t \n\t\t \n\t\t\t 3\n\t\t \n\t \n\t \n\t\t \n\t\t\t 1\n\t\t \n\t \n\t \n\t\t \n\t\t\t 1\n\t\t \n\t \n "},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}","description":"Parameters:
applicationId: The unique identifier of the application
connectionId: The unique identifier of the connection
body: Connection

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections/1
BODY <connection>
     <name>Connection A</name>
     <comment>Connection A comment</comment>
     <sources>
         <source>
             <id>2</id>
         </source>
         <source>
             <id>3</id>
         </source>
     </sources>
     <services>
         <service>
             <id>1</id>
         </service>
     </services>
     <destinations>
         <destination>
             <id>1</id>
         </destination>
     </destinations>
</connection>


Response Messages:
200: Connection was modified.
400: Reference to service ID is invalid.
400: Reference to source/destination with ID is invalid.
400: Connection name cannot be empty.
400: Connection name already exists.
400: Connection NAME contains duplicate destinations.
400: Destination cannot contain users.
400: Resource cannot contain other objects along with Any.
400: Connection NAME contains duplicate sources.
400: You cannot add external resources to interface connections.
400: You cannot have Any in both the source and destination.
400: You cannot add external resources to interface connections.
400: Source cannot contain both users and servers.
400: Connection NAME contains duplicate services.
400: Cannot contain other services along with ANY.
400: Connections can only include objects within the same customer.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permission to access application that contains the server ID
403: You do not have permissions to edit this application.
403: Access is denied
403: You cannot edit or delete an external connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID."},"response":[]},{"name":"Delete connection","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"connectionId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}","description":"Parameters:
applicationId: The unique identifier of the application
connectionId: The unique identifier of the connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/1

Response Messages:
200: Connection was deleted.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: Access is denied
403: You cannot edit or delete an external connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID."},"response":[]},{"name":"Update connections","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t 1\n\t\t Connection A\n\t\t Connection A comment\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t\t \n\t\t\t\t 3\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t \n\t \n\t\t 2\n\t\t Connection B\n\t \n\t \n\t\t 3\n\t\t Connection C\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t \n\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections","description":"Parameters:
applicationId: The unique identifier of the application
body: List of connections

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections
BODY<connections>
     <connection>
         <id>1</id>
         <name>Connection A</name>
         <comment>Connection A comment</comment>
         <sources>
             <source>
                 <id>2</id>
             </source>
             <source>
                 <id>3</id>
             </source>
         </sources>
         <services>
             <service>
                 <id>1</id>
             </service>
         </services>
         <destinations>
             <destination>
                 <id>1</id>
             </destination>
         </destinations>
     </connection>
     <connection>
         <id>2</id>
         <name>Connection B</name>
     </connection>
     <connection>
         <id>3</id>
         <name>Connection C</name>
         <sources>
             <source>
                 <id>2</id>
             </source>
         </sources>
     </connection>
</connections>


Response Messages:
200: Connections were modified.
400: Reference to service ID is invalid.
400: Reference to source/destination with ID is invalid.
400: Connection name cannot be empty.
400: Connection name already exists.
400: Connection NAME contains duplicate destinations.
400: Destination cannot contain users.
400: Resource cannot contain other objects along with Any.
400: Connection NAME contains duplicate sources.
400: You cannot add external resources to interface connections.
400: You cannot have Any in both the source and destination.
400: You cannot add external resources to interface connections.
400: Source cannot contain both users and servers.
400: Connection NAME contains duplicate services.
400: Cannot contain other services along with ANY.
400: Connections can only include objects within the same customer.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permission to access application that contains the server ID
403: You do not have permissions to edit this application.
403: Access is denied
403: You cannot edit or delete an external connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID."},"response":[]},{"name":"Retrieve existing connections","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections","description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the connection [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections?name=Connection Name

Response Messages:
401: No available licenses. Ask your SecureApp administrator for assistance.
403: Access is denied
403: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: There are no connections with the name NAME."},"response":[]},{"name":"Create connections","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t Connection A\n\t\t Connection A comment\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t\t \n\t\t\t\t 3\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t \n\t \n\t\t Connection B\n\t \n\t \n\t\t Connection C\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t \n\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections","description":"Parameters:
applicationId: The unique identifier of the application
body: The list of the connections

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections
BODY<connections>
     <connection>
         <name>Connection A</name>
         <comment>Connection A comment</comment>
         <sources>
             <source>
                 <id>2</id>
             </source>
             <source>
                 <id>3</id>
             </source>
         </sources>
         <services>
             <service>
                 <id>1</id>
             </service>
         </services>
         <destinations>
             <destination>
                 <id>1</id>
             </destination>
         </destinations>
     </connection>
     <connection>
         <name>Connection B</name>
     </connection>
     <connection>
         <name>Connection C</name>
         <sources>
             <source>
                 <id>2</id>
             </source>
         </sources>
     </connection>
</connections>


Response Messages:
200: Connections were created.
201: Connection was created.
400: There are no items to add.
400: You cannot add to application NAME because it was decommissioned.
400: Connection name already exists.
400: Reference to service ID is invalid.
400: Reference to source/destination with ID is invalid.
400: Connection NAME contains duplicate destinations.
400: Destination cannot contain users.
400: Resource cannot contain other objects along with Any.
400: Connection NAME contains duplicate sources.
400: You cannot add external resources to interface connections.
400: You cannot have Any in both the source and destination.
400: You cannot add external resources to interface connections.
400: Source cannot contain both users and servers.
400: Connection NAME contains duplicate services.
400: Cannot contain other services along with ANY.
400: Connections can only include objects within the same customer.
403: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: Access is denied
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]}]},{"name":"Application Identities","item":[{"name":"Fetches application identities","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/application_identities","description":"Fetches the list of pre-defined application identities (like facebook) that can be used in a connection.

Parameters:
name: The name of the service [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/application_identities

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/application_identities?name=facebook

Response Messages:
404: There are no application identities with the name NAME.
403: Access is denied."},"response":[]}]},{"name":"Application Interfaces","item":[{"name":"Retrieve existing interface connections","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"applicationInterfaceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections","description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
name: The name of the interface connection [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections?name=Connection 1

Response Messages:
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There are no connection interfaces with the name NAME.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID."},"response":[]},{"name":"Create interface connections","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\tConnection 1\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\t\n\t\t\t\tFacebook\n\t\t\t\n\t\t\n\t\tNew connection\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections","description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
body: The interface connections

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections
BODY<interface_connections>
    <interface_connection>
        <name>Connection 1</name>
        <sources>
            <source>
                <id>3</id>
            </source>
        </sources>
        <services>
            <service>
                <id>3</id>
            </service>
            <service>
                <id>Facebook</id>
            </service>
        </services>
        <comment>New connection</comment>
    </interface_connection>
</interface_connections>


Response Messages:
200: Interface connections were created.
201: Interface connection was created.
400: There are no items to add.
400: Cannot create interface connection without a name.
400: Connection name already exists.
400: You cannot add user to connection interface.
400: You cannot add Any to connection interface.
400: You cannot add Internet to connection interface.
400: Cannot have external servers.
400: Cannot have both sources and destinations.
400: Connection NAME contains duplicate sources.
400: Connection NAME contains duplicate services.
400: Connection NAME contains duplicate destinations.
400: Reference to source/destination with ID is invalid.
400: Reference to service ID is invalid.
403: Access is denied.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID."},"response":[]},{"name":"Retrieve an existing interface connection by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"applicationInterfaceId"},{"value":null,"type":"text","key":"connectionInterfaceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}","description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
connectionInterfaceId: The unique identifier of the interface connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections/1

Response Messages:
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID."},"response":[]},{"name":"Delete interface connection","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"applicationInterfaceId"},{"value":null,"type":"text","key":"connectionInterfaceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}","description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
connectionInterfaceId: The unique identifier of the interface connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections/1

Response Messages:
200: Interface connection was deleted.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID."},"response":[]},{"name":"Update an interface connection","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tUpdated name\n\t\n\t\t\n\t\t\t19\n\t\t\n\t\n\t\n\t\t\n\t\t\t9\n\t\t\n\t\n\tUpdated connection\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}","description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
connectionInterfaceId: The unique identifier of the interface connection
body: The interface connection

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections/1
BODY<interface_connection>
    <name>Updated name</name>
    <sources>
        <source>
            <id>19</id>
        </source>
    </sources>
    <services>
        <service>
            <id>9</id>
        </service>
    </services>
    <comment>Updated connection</comment>
</interface_connection>


Response Messages:
200: Interface connection was modified.
400: Interface connection name cannot be empty.
400: Connection name already exists.
400: You cannot add user to connection interface.
400: You cannot add Any to connection interface.
400: You cannot add Internet to connection interface.
400: Cannot have external servers.
400: Cannot have both sources and destinations.
400: Connection NAME contains duplicate sources.
400: Connection NAME contains duplicate services.
400: Connection NAME contains duplicate destinations.
400: Reference to source/destination with ID is invalid.
400: Reference to service ID is invalid.
403: Access is denied.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID."},"response":[]},{"name":"Retrieve an existing application interface by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"applicationInterfaceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}","description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1

Response Messages:
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID."},"response":[]},{"name":"Update an application interface","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tupdated name\n\tUpdated application interface\n\ttrue\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}","description":"Update the application interface properties. If is_published is set to true, the application interface is published for use by other users.

Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of The application interface
body: The application interface

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1
BODY<application_interface>
    <name>updated name</name>
    <comment>Updated application interface</comment>
    <is_published>true</is_published>
</application_interface>


Response Messages:
200: Application interface was modified.
400: Application interface is not complete for publish.
400: Name cannot be empty.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID."},"response":[]},{"name":"Delete application interface","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"applicationInterfaceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}","description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1

Response Messages:
200: Application interface was deleted.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID."},"response":[]},{"name":"Delete connection to application","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"connectionToApplicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications/{{connectionToApplicationId}}","description":"Parameters:
applicationId: The unique identifier of the application
connectionToApplicationId: The unique identifier of the connection to application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications/1

Response Messages:
200: Connection to application was deleted.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection to application with ID was not found for application interface with ID."},"response":[]},{"name":"Update a connection to application","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tUpdated name\n\tUpdated connection to application\n\t\n\t\t\n\t\t\t4\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications/{{connectionToApplicationId}}","description":"Parameters:
applicationId: The unique identifier of the application
connectionToApplicationId: The unique identifier of the connection to application
body: The connection to application

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications/1
BODY<connection_to_application>
    <name>Updated name</name>
    <comment>Updated connection to application</comment>
    <servers>
        <server>
            <id>4</id>
        </server>
    </servers>
</connection_to_application>


Response Messages:
200: Connection to application was modified.
400: Name cannot be empty.
400: Name already exists.
400: Reference to source/destination with ID is invalid.
400: You cannot add ANY to connection to application.
400: You cannot add user to connection to application.
400: You cannot add Internet to connection to application.
403: Access is denied
403: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection to application with ID was not found for application interface with ID."},"response":[]},{"name":"Retrieve an existing connection to application by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"connectionToApplicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications/{{connectionToApplicationId}}","description":"Parameters:
applicationId: The unique identifier of the application
connectionToApplicationId: The unique identifier of the connection to application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications/1

Response Messages:
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Connection to application with ID was not found for application interface with ID."},"response":[]},{"name":"Retrieve existing connections to application","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications","description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the connection to application [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications?name=Connection to Application 1

Response Messages:
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID."},"response":[]},{"name":"Create connection to application","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tConnection to Application 1\n\tNew connection to application\n\t1\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications","description":"Create a connection from this application to an application interface.

Parameters:
applicationId: The unique identifier of the application
body: The connection to application

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications
BODY<connection_to_application>
    <name>Connection to Application 1</name>
    <comment>New connection to application</comment>
    <application_interface_id>1</application_interface_id>
    <servers>
        <server>
            <id>3</id>
        </server>
    </servers>
</connection_to_application>


Response Messages:
201: Connection to application was created.
400: You cannot add to application NAME because it was decommissioned.
400: The selected interface cannot be used more than once in the application.
400: Name cannot be empty.
400: Cannot create from local interface.
400: ApplicationInterface didn't got published.
400: Name already exists.
400: Cannot create connection to application without servers, there should be at least one server.
400: Reference to source/destination with ID is invalid.
400: You can use only interface from the same customer.
400: You cannot add ANY to connection to application.
400: You cannot add user to connection to application.
400: You cannot add Internet to connection to application.
403: Access is denied
403: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found."},"response":[]},{"name":"Create application interface","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tInterface to Application 1\n\tNew application interface\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces","description":"Parameters:
applicationId: The unique identifier of the application
body: The application interface

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces
BODY<application_interface>
    <name>Interface to Application 1</name>
    <comment>New application interface</comment>
</application_interface>


Response Messages:
201: Application interface was created.
400: You cannot add to application NAME because it was decommissioned.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID."},"response":[]},{"name":"Retrieve existing application interfaces","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces","description":"To improve response time, set 'calculateIsPublished = false' to avoid calculating 'is_published'.

Parameters:
applicationId: The unique identifier of the application
name: The name of the application interface [optional]
calculateIsPublished: Should calculate is_published value [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces?name=Interface to Application 1

Response Messages:
400: There is no application with the specified ID.
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There are no application interfaces with the name NAME."},"response":[]}]},{"name":"Application Migration","item":[{"name":"Copy application servers and connections to another application.","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"sourceApplicationId"},{"value":null,"type":"text","key":"targetApplicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}","description":"This API can be used to:
1. Create applications based on a blueprint (template).
2. Copy applications between environments (dev, test, prod).
3. Migrate applications between data-centers.

Before migrating make sure to map servers and connections to applications (if any exist).\nThis migration uses the configuration specified in the other API calls.

Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2

Response Messages:
200: Application was migrated.
400: Cannot migrate a decommissioned application.
400: Cannot migrate to a decommissioned application.
400: Cannot migrate an application to itself.
400: Cannot edit target DEVICE application.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
400: The source application has no connections to migrate.
409: You cannot migrate the application because not all servers are mapped.
409: You cannot migrate the application because not all connections to application are mapped.
409: You cannot migrate the application because one of the interfaces in the original application has been changed and has not been published."},"response":[]},{"name":"Retrieve server mappings for source and target applications","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"sourceApplicationId"},{"value":null,"type":"text","key":"targetApplicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/servers_mapping","description":"Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application
search_servers_type: Search server type [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/servers_mapping

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/servers_mapping?search_servers_type=EXTERNAL

Response Messages:
400: Search migrated servers type parameter must be either internal, external or both.
400: Cannot get mappings between application to itself.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permission to access application with ID
403: You do not have permissions to edit this application.
404: There is no application with the specified ID."},"response":[]},{"name":"Update server mappings for source and target applications","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n\t\n\t\t\n\t\t\t5\n\t\t\n\t\t\n\t\t\t-1\n\t\t\n\t\n\t\n\t\t\n\t\t\t6\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/servers_mapping","description":"Use id=-1 for target_network_object if new mapping is “Not Needed”.
If the source is specified and the target is empty, the mapping that is currently configured will be deleted.

Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application
body: The server mapping list [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/servers_mapping
BODY<servers_mapping>
    <server_mapping>
        <source_network_object>
            <id>3</id>
        </source_network_object>
        <target_network_object>
            <id>4</id>
        </target_network_object>
    </server_mapping>
    <server_mapping>
        <source_network_object>
            <id>5</id>
        </source_network_object>
        <target_network_object>
            <id>-1</id>
        </target_network_object>
    </server_mapping>
    <server_mapping>
        <source_network_object>
            <id>6</id>
        </source_network_object>
    </server_mapping>
</servers_mapping>


Response Messages:
200: Server mappings were modified.
400: Source network object cannot be empty.
400: Source network object is not valid
400: Target network object is not valid
400: Source and target network objects must be internal or external both.
400: Cannot use DEVICE application resources as external network objects.
400: Source network object with ID must be used by any connection.
400: Cannot remove mapping of network object with ID because it has never been mapped.
400: Cannot migrate application to itself.
400: Cannot map to ANY network object.
400: Cannot map Internet network object.
400: Cannot map to Internet network object.
400: Target network object ID must be in the same customer as the target application.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Server with ID was not found."},"response":[]},{"name":"Update connection to application mappings for source and target applications","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n\t\n\t\t\n\t\t\t2\n\t\t\n\t\t\n\t\t\t-1\n\t\t\n\t\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/connections_to_applications_mapping","description":"Use id=-1 for target_application_interface if new mapping is “Not Needed”.
If the source is specified and the target is empty, the mapping that is currently configured will be deleted.

Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application
body: The interface instance mapping list [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/connections_to_applications_mapping
BODY<connections_to_applications_mapping>
    <connection_to_application_mapping>
        <source_connection_to_application>
            <id>1</id>
        </source_connection_to_application>
        <target_application_interface>
            <id>4</id>
        </target_application_interface>
    </connection_to_application_mapping>
    <connection_to_application_mapping>
        <source_connection_to_application>
            <id>2</id>
        </source_connection_to_application>
        <target_application_interface>
            <id>-1</id>
        </target_application_interface>
    </connection_to_application_mapping>
    <connection_to_application_mapping>
        <source_connection_to_application>
            <id>3</id>
        </source_connection_to_application>
    </connection_to_application_mapping>
</connections_to_applications_mapping>


Response Messages:
200: Connection to application mappings were modified.
400: Source interface instance cannot be empty.
400: Source interface instance object is not valid
400: Target application interface is not valid
400: Connection to application with ID: ID was not found.
400: Interface with ID: ID was not found.
400: Cannot remove mapping of instance with ID because it has never been mapped.
400: Cannot migrate application to itself.
400: Cannot map instance to interface with ID ID because the interface exists in target application.
400: Cannot map to duplicate application interfaces
400: Application interface didn't got published
400: Connection to application with id: ID must used by source application
400: You cannot map connection to application ID, because it is contained in a connection to application pack.
400: Application interface ID must be in the same customer as the target application.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]},{"name":"Retrieve connection to application mappings for source and target applications","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"sourceApplicationId"},{"value":null,"type":"text","key":"targetApplicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/connections_to_applications_mapping","description":"Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/connections_to_applications_mapping

Response Messages:
400: Cannot get mappings between application to itself.
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID."},"response":[]}]},{"name":"Application Packs","item":[{"name":"Retrieve an existing application pack by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"},{"value":null,"type":"text","key":"application_pack_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to retrieve

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1

Response Messages:
403: Access is denied
403: You do not have permission to access application pack with ID
404: Application pack with ID was not found for customer with ID."},"response":[]},{"name":"Update an application pack","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tUpdated name\n\tUpdated application pack\n\t\n\t\t4\n\t\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\n\t\n\t\t\n\t\t\t5\n\t\t\n\t\n\ttrue\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}","description":"Update the application pack properties. If is_published is set to true, the application pack is published for use by other users.

Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
body: Application pack

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1
BODY<application_pack>
    <name>Updated name</name>
    <comment>Updated application pack</comment>
    <owner>
        <id>4</id>
    </owner>
    <editors>
        <editor>
            <id>3</id>
        </editor>
    </editors>
    <viewers>
        <viewer>
            <id>5</id>
        </viewer>
    </viewers>
    <is_published>true</is_published>
</application_pack>


Response Messages:
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to owner ID is invalid.
400: The owner NAME does not have permission to access applications.
400: There is an editor without an ID or name.
400: The application pack owner cannot also be an editor of the application pack.
400: There is a viewer without an ID or name.
400: The application pack owner cannot also be a viewer of the application pack.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application pack.
400: Application pack NAME already exists.
400: Application pack name must contain at least 2 and no more than 160 characters.
400: Customer NAME is not imported to SecureApp.
400: Customer NAME was decommissioned.
400: Application pack with ID is not ready for publish, or has no changes from the last publish.
403: Access is denied
403: You do not have permission to access application that contains the interface ID
403: You do not have permissions to edit this application pack.
403: You do not have permissions to change the owner of application pack ID.
403: You do not have permissions to change the editors and viewers of application pack ID.
404: There are no application packs with the NAME in customer with ID."},"response":[]},{"name":"Delete application pack","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"},{"value":null,"type":"text","key":"application_pack_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1

Response Messages:
200: Application pack wes deleted.
403: You do not have permissions to delete this application pack.
400: There is no application pack with the specified ID.
400: Customer with ID doesn't own an application pack with ID.
400: Application Pack ID cannot be deleted. It is in use by applications IDs."},"response":[]},{"name":"Remove application interfaces from application pack","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"},{"value":null,"type":"text","key":"application_pack_id"},{"value":null,"type":"text","key":"application_interface_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/application_interfaces","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
application_interface_id: IDs of application interfaces to remove

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/application_interfaces?application_interface_id=1&application_interface_id=2

Response Messages:
200: Application Interface was deleted.
403: Access is denied
403: You do not have permissions to edit this application pack.
404: There are no application packs with the ID in customer with ID.
404: Application Package ID was not found.
404: Application interface ID was not found in application pack ID."},"response":[]},{"name":"Update application interfaces and tag mapping","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t3\n\t\t\n\t\n\t\n\t\t\n\t\t\t2\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/application_interfaces","description":"Add application interfaces to application pack, and map a tag to the application interface. If a tag is not specified for the interface, the tag will be set to “No Tag”.

Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
body: List of interface tag mapping to be added or modified

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/application_interfaces
BODY<application_interface_tags>
    <application_interface_tag>
        <application_interface>
            <id>1</id>
        </application_interface>
        <tag>
            <id>3</id>
        </tag>
    </application_interface_tag>
    <application_interface_tag>
        <application_interface>
            <id>2</id>
        </application_interface>
    </application_interface_tag>
</application_interface_tags>


Response Messages:
403: Access is denied
404: There are no application packs with the NAME in customer with ID.
403: You do not have permissions to edit this application pack.
403: You do not have permission to access application that contains the interface ID
400: You cannot edit APPLICATION PACK because it was decommissioned.
400: Application Interface can't be null.
400: Empty interface ID is not valid."},"response":[]},{"name":"Update application packs","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t1\n\t\tUpdated name\n\t\tUpdated application pack\n\t\t\n\t\t\t4\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\n\t\tfalse\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/","description":"Update the application packs properties. If is_published is set to true, the application pack is published for use by other users.

Parameters:
customer_id: The unique identifier of customer
body: List of application packs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs
BODY<application_packs>
    <application_pack>
        <id>1</id>
        <name>Updated name</name>
        <comment>Updated application pack</comment>
        <owner>
            <id>4</id>
        </owner>
        <editors>
            <editor>
                <id>3</id>
            </editor>
        </editors>
        <is_published>false</is_published>
    </application_pack>
</application_packs>


Response Messages:
400: There are no application packs to edit.
400: Application pack ID cannot be empty.
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to owner ID is invalid.
400: The owner NAME does not have permission to access applications.
400: There is an editor without an ID or name.
400: The application pack owner cannot also be an editor of the application pack.
400: There is a viewer without an ID or name.
400: The application pack owner cannot also be a viewer of the application pack.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application pack.
400: Application pack NAME already exists.
400: Application pack name must contain at least 2 and no more than 160 characters.
400: Customer NAME is not imported to SecureApp.
400: Customer NAME was decommissioned.
400: Application pack with ID is not ready for publish, or has no changes from the last publish.
403: Access is denied
403: You do not have permission to access application that contains the interface ID
403: You do not have permissions to edit this application pack.
403: You do not have permissions to change the owner of application pack ID.
403: You do not have permissions to change the editors and viewers of application pack ID.
404: There are no application packs with the NAME in customer with ID."},"response":[]},{"name":"List all application packs","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/","description":"Parameters:
customer_id: The unique identifier of customer
name: The name of the application pack [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs?name=Application pack 1

Response Messages:
403: Access is denied
404: There are no application packs with the NAME in customer with ID."},"response":[]},{"name":"Create new application packs","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\tApplication pack 1\n\t\tNew application pack\n\t\t\n\t\t\t4\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t5\n\t\t\t\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/","description":"Parameters:
customer_id: The unique identifier of customer
body: List of application packs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs
BODY<application_packs>
    <application_pack>
        <name>Application pack 1</name>
        <comment>New application pack</comment>
        <owner>
            <id>4</id>
        </owner>
        <editors>
            <editor>
                <id>3</id>
            </editor>
        </editors>
        <viewers>
            <viewer>
                <id>5</id>
            </viewer>
        </viewers>
    </application_pack>
</application_packs>


Response Messages:
403: Access is denied
403: You do not have permission to access application that contains the interface ID
400: There are no application packs to add.
400: Application pack can be created only in meshed domain mode.
404: Customer with ID was not found.
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to owner ID is invalid.
400: There is an editor without an ID or name.
400: The application pack owner cannot also be an editor of the application pack.
400: There is a viewer without an ID or name.
400: The application pack owner cannot also be a viewer of the application pack.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application pack.
400: The owner NAME does not have permission to access applications.
400: Application pack was already saved.
400: Application pack NAME already exists.
400: Application pack name must contain at least 2 and no more than 160 characters.
400: Customer NAME is not imported to SecureApp.
400: Customer NAME was decommissioned."},"response":[]},{"name":"Modify tags of an application pack","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t1\n\t\tTag 1\n\t\n\t\n\t\t2\t\n\t\tTag 2\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
body: Tags to modify

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags
BODY<tags>
    <tag>
        <id>1</id>
        <name>Tag 1</name>
    </tag>
    <tag>
        <id>2</id>    
        <name>Tag 2</name>
    </tag>
</tags>


Response Messages:
403: Access is denied
403: You do not have permissions to edit this application pack.
404: Customer with ID was not found.
404: There is no application pack with the ID in customer with ID.
400: Tag with NAME already exists in application pack ID.
400: Updated tag ID can't be empty
400: Updated Tag ID doesn't exist on application pack ID."},"response":[]},{"name":"Delete tags from application pack","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"},{"value":null,"type":"text","key":"application_pack_id"},{"value":null,"type":"text","key":"tag_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
tag_id: IDs of tags to remove

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/21/tags?tag_id=1&tag_id=2

Response Messages:
200: Tags were deleted.
403: Access is denied
403: You do not have permissions to edit this application pack.
404: There are no application packs with the ID in customer with ID.
404: Application Package ID was not found.
404: Tag ID was not found in application pack ID.
404: Tag ID is in use so can't be deleted.
404: Removed tag ID can't be empty."},"response":[]},{"name":"List all application pack tags","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"},{"value":null,"type":"text","key":"application_pack_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags

Response Messages:
403: Access is denied
404: There is no application pack with the ID."},"response":[]},{"name":"Create new Tag under an application pack ","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\tTag 1\n\t\n\t\n\t\tTag 2\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack
body: List of tags

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags
BODY<tags>
    <tag>
        <name>Tag 1</name>
    </tag>
    <tag>
        <name>Tag 2</name>
    </tag>
</tags>


Response Messages:
403: Access is denied
404: There is no application pack with the ID in customer with ID.
400: You cannot edit APPLICATION PACK because it was decommissioned.
400: Tag name must contain at least 2 and no more than 160 characters.
400: Tag with NAME already exists in application pack ID."},"response":[]},{"name":"Create new connection to application packs","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\tConnection to application pack 1\n\t\tNew Connection to application pack\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t1\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t3\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\tTag 1\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t4\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/","description":"Parameters:
application_id: The unique identifier of application
body: List of connection to application packs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs
BODY<connection_to_application_packs>
    <connection_to_application_pack>
        <name>Connection to application pack 1</name>
        <comment>New Connection to application pack</comment>
        <application_pack>
            <id>1</id>
        </application_pack>
        <tags_servers>
            <tag_servers>
                <tag>
                    <id>1</id>
                </tag>
                <servers>
                    <server>
                        <id>3</id>
                    </server>
                </servers>
            </tag_servers>
            <tag_servers>
                <tag>
                    <name>Tag 1</name>
                </tag>
                <servers>
                    <server>
                        <id>4</id>
                    </server>
                </servers>
            </tag_servers>
        </tags_servers>
    </connection_to_application_pack>
</connection_to_application_packs>


Response Messages:
400: There are no connection to application packs to add.
400: Application pack ID cannot be empty.
400: Application with ID was not found.
400: There is no application with the specified ID.
400: There is no application pack with the specified ID.
400: Application pack with ID was decommissioned.
400: Application pack with ID was not published.
400: Connection to application pack cannot be created in the domain of the application pack.
400: The application pack cannot be used more than once in the application.
400: Name cannot be empty.
400: Name must contain at least 2 and no more than 160 characters.
400: Name already exists.
400: Tag cannot be empty.
400: Tag ID or name is missing.
400: Tag ID does not exist.
400: Server ID does not exist.
400: Tag ID is not in use in connection to application pack ID, so it cannot be updated.
400: Servers cannot be null.
400: You cannot add ANY to connection to application pack.
400: You cannot add user to connection to application pack.
400: You cannot add Internet to connection to application pack.
403: Access is denied.
403: You do not have permission to access application that contains the server ID
403: You do not have permission to access application pack with ID
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Tag with NAME was not found."},"response":[]},{"name":"Retrieve a list of all connection to application pack by application ID.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"application_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/","description":"Parameters:
application_id: The unique identifier of application
name: The name of the connection to application pack [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs?name=Connection to application pack 1

Response Messages:
403: Access is denied
403: You do not have permission to access application with ID
404: There are no connection to application pack with the NAME in application with ID."},"response":[]},{"name":"Get tag by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"},{"value":null,"type":"text","key":"application_pack_id"},{"value":null,"type":"text","key":"tag_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags/{{tag_id}}","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack
tag_id: The unique identifier of a tag

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags/1

Response Messages:
403: Access is denied
404: There is no tag with ID.
404: Customer with ID doesn't own a tag with ID.
404: Application Pack with ID doesn't own a tag with ID."},"response":[]},{"name":"Update an application pack","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tUpdated name\n\tUpdated Connection to application pack\n\t\n\t\t\n\t\t\t\n\t\t\t\t1\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t3\n\t\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\tTag 1\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/{{connection_to_application_pack_id}}","description":"Parameters:
application_id: The unique identifier of application
connection_to_application_pack_id: The unique identifier of the connection to application pack to update
body: Connection to application pack

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs/1
BODY<connection_to_application_pack>
    <name>Updated name</name>
    <comment>Updated Connection to application pack</comment>
    <tags_servers>
        <tag_servers>
            <tag>
                <id>1</id>
            </tag>
            <servers>
                <server>
                    <id>3</id>
                </server>
            </servers>
        </tag_servers>
        <tag_servers>
            <tag>
                <name>Tag 1</name>
            </tag>
            <servers>
            </servers>
        </tag_servers>
    </tags_servers>
</connection_to_application_pack>


Response Messages:
400: There is no application with the specified ID.
400: There is no connection to application pack with the specified ID.
400: Application with ID doesn't own a connection to application pack with ID.
400: Name cannot be empty.
400: Name must contain at least 2 and no more than 160 characters.
400: Name already exists.
400: Tag cannot be empty.
400: Tag ID or name is required.
400: Tag with Name was not found.
400: Server ID cannot be empty.
400: Servers cannot be null.
400: You cannot add ANY to connection to application pack.
400: You cannot add user to connection to application pack.
400: You cannot add Internet to connection to application pack.
403: Access is denied.
403: You do not have permission to access application that contains the server ID
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed."},"response":[]},{"name":"Delete a connection to application pack","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"application_id"},{"value":null,"type":"text","key":"connection_to_application_pack_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/{{connection_to_application_pack_id}}","description":"Parameters:
application_id: The unique identifier of application
connection_to_application_pack_id: The unique identifier of the connection to application pack to delete

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs/1

Response Messages:
400: Connection to application pack with ID was not found for application with ID.
400: The connection to application pack was already deleted.
403: Access is denied.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed."},"response":[]},{"name":"Retrieve an existing connection to application pack by ID.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"application_id"},{"value":null,"type":"text","key":"connection_to_application_pack_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/{{connection_to_application_pack_id}}","description":"Parameters:
application_id: The unique identifier of application
connection_to_application_pack_id: The unique identifier of the connection to application pack

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs/1

Response Messages:
403: Access is denied
403: You do not have permission to access application with ID
404: There is no connection to application pack with the specified ID.
400: Application with ID doesn't own a connection to application pack with ID."},"response":[]}]},{"name":"Application Pending Changes","item":[{"name":"Retrieve existing access rules","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/access_requests","description":"Parameters:
applicationId: The unique identifier of the application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/87/access_requests

Response Messages:
400: The application was already deleted.
400: There are no changed connections that are ready for creating a ticket.
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
400: Application with ID ID was not found."},"response":[]}]},{"name":"Application Servers (across all applications)","item":[{"name":"Fetches server by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"serverId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/network_objects/{{serverId}}","description":"Parameters:
serverId: The ID of the server

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects/87

Response Messages:
400: Server with id ID was not found.
400: Application with ID ID was not found.
400: The application was already deleted.
403: Access is denied
403: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance."},"response":[]},{"name":"Fetches servers","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/network_objects","description":"Parameters:
name: The name of the servers [optional]
typeOnDevice: The typeOnDevice of the servers [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects?name=server1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects?typeOnDevice=edl_ip_list

Response Messages:
400: Server with name NAME was not found.
400: Parameter typeOnDevice is not valid.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There are no servers with the name NAME
404: There are no servers with the typeOnDevice TYPEONDEVICE "},"response":[]}]},{"name":"Application Servers (by application)","item":[{"name":"Delete server","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"serverId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}","description":"To decommission a serer use force=true.

Parameters:
applicationId: The unique identifier of the application
serverId: The unique identifier of the server
force: Force delete [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/4

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/4?force=true

Response Messages:
400: The application was already deleted.
400: You cannot delete a predefined object.
400: Cannot delete an object that is being referenced by other objects
400: Cannot delete a predefined object.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID."},"response":[]},{"name":"Retrieve an existing server by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"serverId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}","description":"Parameters:
applicationId: The unique identifier of the application
serverId: The unique identifier of the server

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/3

Response Messages:
400: The application was already deleted.
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID."},"response":[]},{"name":"If the identified server is a group, return a list of its members. When the media type is 'text/plain' (default), print each member on a separate line.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}/members","description":"Parameters:
applicationId [optional]
serverId [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/6/members

Response Messages:
400: Server with ID is not of type group
403: Access is denied
403: You do not have permissions to view this application
403: No available licenses. Ask your SecureApp administrator for assistance
404: There is no application with the specified ID
404: Server with ID was not found"},"response":[]},{"name":"Export Server Impact Analysis to a CSV file.","request":{"method":"GET","header":[],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}/impact_analysis_csv","description":"Parameters:
applicationId [optional]
serverId [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/6/impact_analysis_csv

Response Messages:
400: Server with ID was not found.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
404: There is no application with the specified ID."},"response":[]},{"name":"Move server","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"application_id"},{"value":null,"type":"text","key":"server_id"},{"value":null,"type":"text","key":"target_application_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/move_server","description":"Parameters:
application_id: The unique identifier of the application
server_id: The unique identifier of the server
target_application_id: The unique identifier of the target application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/move_server?server_id=5&target_application_id=3

Response Messages:
400: Server ID is missing.
400: Target application ID is missing.
400: You cannot move a predefined object.
400: Server with ID is already associated to application with ID.
400: Cannot move server to a different customer.
400: The application was already deleted.
400: You cannot add to application APPLICATION_NAME because it was decommissioned.
400: Group/Server cannot be moved because there is no other application to move it to.
400: Group/Server cannot be moved because it or at least one of its group members is part of these groups: GROUPS_NAME.
400: Group/Server cannot be moved because it or at least one of its group members is locked for discovery.
400: Group/Server cannot be moved because it or at least one of its group members is used in these application interfaces: APPLICATION_INTERFACE_NAME.
400: Group/Server cannot be moved because it or at least one of its group members is used in these connections with another external resource: CONNECTION_NAME
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]},{"name":"Update servers","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t 1\n\t\t host comment\n\t\t host1\n\t\t 1.1.1.1\n\t\t host\n\t \n\t \n\t\t 2\n\t\t range comment\n\t\t range1\n\t\t 2.2.2.2\n\t\t 2.2.2.22\n\t\t range\n\t \n\t \n\t\t 3\n\t\t subnet comment\n\t\t subnet1\n\t\t 3.3.3.3\n\t\t 255.255.255.0\n\t\t subnet\n\t \n\t \n\t\t 4\n\t\t virtual server comment\n\t\t {e1a7722f-e92e-48f2-9087-9cb1711eb8b9}\n\t\t 12\n\t\t virtual-server\n\t \n\t \n\t\t 5\n\t\t vm1\n\t\t vm instance comment\n\t\t vm_instance\n\t \n\t \n\t\t 6\n\t\t group comment\n\t\t group1\n\t\t true\n\t\t group\n\t\t \n\t\t\t 3\n\t\t \n\t\tedl_ip_list\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects","description":"Parameters:
applicationId: The unique identifier of the application
body: List of servers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects
BODY<network_objects xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
     <network_object xsi:type=\"hostNetworkObjectDTO\">
         <id>1</id>
         <comment>host comment</comment>
         <name>host1</name>
         <ip>1.1.1.1</ip>
         <type>host</type>
     </network_object>
     <network_object xsi:type=\"rangeNetworkObjectDTO\">
         <id>2</id>
         <comment>range comment</comment>
         <name>range1</name>
         <first_ip>2.2.2.2</first_ip>
         <last_ip>2.2.2.22</last_ip>
         <type>range</type>
     </network_object>
     <network_object xsi:type=\"subnetNetworkObjectDTO\">
         <id>3</id>
         <comment>subnet comment</comment>
         <name>subnet1</name>
         <ip>3.3.3.3</ip>
         <netmask>255.255.255.0</netmask>
         <type>subnet</type>
     </network_object>
     <network_object xsi:type=\"networkObjectVirtualServerDTO\">
         <id>4</id>
         <comment>virtual server comment</comment>
         <uid>{e1a7722f-e92e-48f2-9087-9cb1711eb8b9}</uid>
         <device_id>12</device_id>
         <type>virtual-server</type>
     </network_object>
     <network_object xsi:type=\"vmInstanceDTO\">
         <id>5</id>
         <name>vm1</name>
         <comment>vm instance comment</comment>
         <type>vm_instance</type>
     </network_object>
     <network_object xsi:type=\"networkObjectGroupDTO\">
         <id>6</id>
         <comment>group comment</comment>
         <name>group1</name>
         <access_allowed>true</access_allowed>
         <type>group</type>
         <member>
             <id>3</id>
         </member>
        <type_on_device>edl_ip_list</type_on_device>     </network_object>
</network_objects>


Response Messages:
400: The application was already deleted.
400: You cannot update a predefined object.
400: Invalid type in server with id ID.
400: Invalid member with id ID
400: Invalid ID
400: Invalid uid
400: Invalid network object type NAME
400: Cannot update user
400: Network object is new
400: Name cannot be empty
400: Server is in discovery
400: Ip is missing
400: Mask is missing
400: Invalid ip
400: Invalid mask
400: Max ip is missing
400: Min ip is missing
400: Invalid min ip
400: Invalid max ip
400: Min ip cannot be larger than max ip
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Internet cannot be a member of a group.
400: Server with NAME already exists.
400: Invalid device ID
400: The type_on_device value is not valid
400: An EDL group can not be modified to a regular group
400: The virtual server already exists in SecureApp as resource NAME: VIRTUAL SERVER NAME VIRTUAL SERVER DEVICE NAME.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: DTO type used for server id ID is incompatible with this vendor.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Virtual server was not found in ST.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID.
503: Not connected to SecureTrack."},"response":[]},{"name":"Retrieve existing servers","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects","description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the server [optional]
typeOnDevice: The typeOnDevice of the servers [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects?name=ServerName

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects?typeOnDevice=edl_ip_list

Response Messages:
400: The application was already deleted.
400: Parameter typeOnDevice is not valid.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: There are no servers with the name NAME.
404: There are no servers with the typeOnDevice TYPEONDEVICE "},"response":[]},{"name":"Create servers","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t host comment\n\t\t host1\n\t\t 1.1.1.1\n\t \n\t \n\t\t range comment\n\t\t range1\n\t\t 2.2.2.2\n \t\t 2.2.2.22\n\t \n\t \n\t\t subnet comment\n\t\t subnet1\n\t\t 3.3.3.3\n\t\t 255.255.255.0\n\t \n\t \n\t\t virtual server comment\n\t\t {e1a7722f-e92e-48f2-9087-9cb1711eb8b9}\n\t\t 12\n\t \n\t \n\t\t group comment\n\t\t group1\n\t\t true\n\t\t \n\t\t\t 3\n\t\t \n\t\tedl_ip_list\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects","description":"Parameters:
applicationId: The unique identifier of the application
body: List of servers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects
BODY<network_objects xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
     <network_object xsi:type=\"hostNetworkObjectDTO\">
         <comment>host comment</comment>
         <name>host1</name>
         <ip>1.1.1.1</ip>
     </network_object>
     <network_object xsi:type=\"rangeNetworkObjectDTO\">
         <comment>range comment</comment>
         <name>range1</name>
         <first_ip>2.2.2.2</first_ip>
         <last_ip>2.2.2.22</last_ip>
     </network_object>
     <network_object xsi:type=\"subnetNetworkObjectDTO\">
         <comment>subnet comment</comment>
         <name>subnet1</name>
         <ip>3.3.3.3</ip>
         <netmask>255.255.255.0</netmask>
     </network_object>
     <network_object xsi:type=\"networkObjectVirtualServerDTO\">
         <comment>virtual server comment</comment>
         <uid>{e1a7722f-e92e-48f2-9087-9cb1711eb8b9}</uid>
         <device_id>12</device_id>
     </network_object>
     <network_object xsi:type=\"networkObjectGroupDTO\">
         <comment>group comment</comment>
         <name>group1</name>
         <access_allowed>true</access_allowed>
         <member>
             <id>3</id>
         </member>
        <type_on_device>edl_ip_list</type_on_device>     </network_object>
</network_objects>


Response Messages:
400: There are no items to add.
400: The application was already deleted.
400: You cannot add to application NAME because it was decommissioned.
400: Network object was already saved
400: Name cannot be empty
400: Server with NAME already exists.
400: IP is missing
400: Mask is missing
400: Invalid IP
400: Invalid mask
400: Max IP is missing
400: Min IP is missing
400: Invalid min IP
400: Invalid max IP
400: Min IP cannot be larger than max IP
400: Invalid network object type CLASS_NAME.
400: Invalid uid
400: Invalid device ID
400: Virtual server does not exist in SecureTrack
400: The virtual server already exists in SecureApp as resource NAME: VIRTUAL SERVER NAME VIRTUAL SERVER DEVICE NAME.
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Internet cannot be a member of a group.
400: Cannot save the server because the virtual server does not exist.
400: Cannot save the server because an error occurred
400: The type_on_device value is not valid
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID.
404: Virtual server was not found in SecureTrack.
503: Not connected to SecureTrack."},"response":[]}]},{"name":"Application Services (global)","item":[{"name":"Modify unused and non predefined global services","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t250\n\t\ticmp service updated\n\t\tUpdated comment\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\t251\n\t\tip service updated\n\t\tUpdated comment\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\t252\n\t\ttcp service updated\n\t\tUpdated comment\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t253\n\t\tudp service updated\n\t\tUpdated comment\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t254\n\t\tService Group 1 updated\n\t\tUpdated comment\n\t\tgroup\n\t\t\n\t\t\t3\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services/","description":"Parameters:
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>250</id>
        <name>icmp service updated</name>
        <comment>Updated comment</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>251</id>
        <name>ip service updated</name>
        <comment>Updated comment</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>252</id>
        <name>tcp service updated</name>
        <comment>Updated comment</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>253</id>
        <name>udp service updated</name>
        <comment>Updated comment</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <id>254</id>
        <name>Service Group 1 updated</name>
        <comment>Updated comment</comment>
        <type>group</type>
        <member>
            <id>3</id>
        </member>
        <member>
            <id>4</id>
        </member>
    </service>
</services>


Response Messages:
200: Services were modified.
400: Members IDs cannot be empty.
404: Service with ID <ID> was not found.
400: Service type must be either SingleServiceDTO or ServiceMemberDTO.
400: Service is new.
400: You cannot update a predefined object.
400: Name <NAME> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: Invalid protocol
400: Global Service cannot be associated with an application.
400: Cannot update a global service that is being referenced by other objects.
400: Cannot update an empty global group.
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Cannot have a local member in global group.
400: Group cannot contain itself as a member.
400: Application identity cannot be a member of a group.
403: Access is denied."},"response":[]},{"name":"Fetches services","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services","description":"Parameters:
globals_only: get only globals [optional]
name: The name of the service [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?name=AH

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?globals_only=true

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?globals_only=true&name=AH

Response Messages:
404: There are no services with the name NAME.
403: Access is denied."},"response":[]},{"name":"Create global services","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\ticmp service\n\t\tNew service\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\tip service\n\t\tIPSEC Authentication Header Protocol\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\ttcp service\n\t\tDiscard Server Protocol (TCP)\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tudp service\n\t\tDiscard Server Protocol (UDP)\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tService Group 1\n\t\tNew Service group\n\t\tgroup\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t2\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services","description":"Parameters:
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>icmp service</name>
        <comment>New service</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>ip service</name>
        <comment>IPSEC Authentication Header Protocol</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>tcp service</name>
        <comment>Discard Server Protocol (TCP)</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>udp service</name>
        <comment>Discard Server Protocol (UDP)</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <name>Service Group 1</name>
        <comment>New Service group</comment>
        <type>group</type>
        <member>
            <id>1</id>
        </member>
        <member>
            <id>2</id>
        </member>
    </service>
</services>


Response Messages:
201: Service was created.
200: Services were created.
400: There are no items to add.
400: Members IDs cannot be empty.
404: Service with ID <ID> was not found.
400: Invalid service type <TYPE>
400: Name <NAME> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: Global Service cannot be associated with an application.
400: Cannot create an empty global group.
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Cannot have a local member in global group.
400: Application identity cannot be a member of a group.
403: Access is denied."},"response":[]},{"name":"Delete unused and non predefined global service by name","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"name"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services","description":"Parameters:
name: The name of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?name=Global service

Response Messages:
200: Service was deleted.
404: Service name has not been provided.
404: There are no services with the name NAME.
400: Cannot delete ANY.
400: Cannot delete an object that is being referenced by other objects.
400: Cannot delete a predefined object.
403: Access is denied."},"response":[]},{"name":"Fetches service by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"serviceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services/{{serviceId}}","description":"Parameters:
serviceId: The ID of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services/2

Response Messages:
404: Service with ID <ID> was not found.
403: Access is denied."},"response":[]},{"name":"Delete unused and non predefined global service","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"serviceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services/{{serviceId}}","description":"Parameters:
serviceId: The ID of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services/260

Response Messages:
200: Service was deleted.
404: Global Service with ID was not found.
400: Cannot delete an object that is being referenced by other objects.
400: You cannot delete a predefined object.
403: Access is denied."},"response":[]}]},{"name":"Application Services (local)","item":[{"name":"Retrieve an existing service by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"serviceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services/{{serviceId}}","description":"Parameters:
applicationId: The unique identifier of the application
serviceId: The unique identifier of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services/250

Response Messages:
400: The application was already deleted.
403: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: Service with ID was not found."},"response":[]},{"name":"Delete service","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"serviceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services/{{serviceId}}","description":"Use force=true to delete a service with decommission.

Parameters:
applicationId: The unique identifier of the application
serviceId: The unique identifier of the service
force: Force delete [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services/250

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services/250?force=true

Response Messages:
400: The application was already deleted.
400: Cannot delete an object that is being referenced by other objects.
400: Cannot delete a predefined object.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Service with ID <SERVICE_ID> was not found in application with id <APPLICATION_ID>"},"response":[]},{"name":"Create services","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\ticmp service\n\t\tNew service\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\tip service\n\t\tIPSEC Authentication Header Protocol\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\ttcp service\n\t\tDiscard Server Protocol (TCP)\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tudp service\n\t\tDiscard Server Protocol (UDP)\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tService Group 1\n\t\tNew Service group\n\t\tgroup\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t2\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services","description":"Parameters:
applicationId: The unique identifier of the application
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>icmp service</name>
        <comment>New service</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>ip service</name>
        <comment>IPSEC Authentication Header Protocol</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>tcp service</name>
        <comment>Discard Server Protocol (TCP)</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>udp service</name>
        <comment>Discard Server Protocol (UDP)</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <name>Service Group 1</name>
        <comment>New Service group</comment>
        <type>group</type>
        <member>
            <id>1</id>
        </member>
        <member>
            <id>2</id>
        </member>
    </service>
</services>


Response Messages:
201: Service was created.
200: Services were created.
400: There are no items to add.
400: Members IDs cannot be empty.
400: Invalid service type <TYPE>
400: Name <NAME> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: Cannot create an empty global group.
400: The group contains duplicate members.
400: ANY cannot be a member of a group.
400: Cannot have members from different applications.
400: Can not have application identity in group
403: Access is denied
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Service with ID <ID> was not found.
404: There is no application with the specified ID."},"response":[]},{"name":"Retrieve existing services","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services","description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the service [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services?name=Local service

Response Messages:
400: The application was already deleted.
403: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: There are no services with the name NAME."},"response":[]},{"name":"Update services","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t250\n\t\ticmp service updated\n\t\tUpdated comment\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\t251\n\t\tip service updated\n\t\tUpdated comment\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\t252\n\t\ttcp service updated\n\t\tUpdated comment\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t253\n\t\tudp service updated\n\t\tUpdated comment\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t254\n\t\tService Group 1 updated\n\t\tUpdated comment\n\t\tgroup\n\t\t\n\t\t\t3\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n\t\n\t\t255\n\t\tService Group 2 updated\n\t\tUpdated comment\n\t\tgroup\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services","description":"Parameters:
applicationId: The unique identifier of the application
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>250</id>
        <name>icmp service updated</name>
        <comment>Updated comment</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>251</id>
        <name>ip service updated</name>
        <comment>Updated comment</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>252</id>
        <name>tcp service updated</name>
        <comment>Updated comment</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>253</id>
        <name>udp service updated</name>
        <comment>Updated comment</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <id>254</id>
        <name>Service Group 1 updated</name>
        <comment>Updated comment</comment>
        <type>group</type>
        <member>
            <id>3</id>
        </member>
        <member>
            <id>4</id>
        </member>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <id>255</id>
        <name>Service Group 2 updated</name>
        <comment>Updated comment</comment>
        <type>group</type>
    </service>
</services>


Response Messages:
200: Services were modified.
400: Members IDs cannot be empty.
400: Service type must be either SingleServiceDTO or ServiceMemberDTO.
400: Local service must be associated with an application.
400: Service is locked for discovery.
400: Service is new.
400: Name <NAME> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: The group contains duplicate members.
400: ANY cannot be a member of a group.
400: Application identity cannot be a member of a group.
403: Access is denied
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Service with ID <ID> was not found."},"response":[]}]},{"name":"Application Users","item":[{"name":"Fetches users","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users","description":"Parameters:
name: The name of the user [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users?name=Local user 1

Response Messages:
404: There are no users with the name NAME.
403: Access is denied."},"response":[]},{"name":"Create users","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\tLocal user 1\n\t\tNew local user\n\t\t8.8.8.8\n\t\n\t\n\t\tLdap user 1\n\t\tNew ldap user\n\t\n\t\n\t\tUser group 1\n\t\tNew user group\n\t\t\n\t\t\t14\n\t\t\n\t\t\n\t\t\t15\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users","description":"Parameters:
body: List of users

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/users
BODY<users>
    <user>
        <name>Local user 1</name>
        <comment>New local user</comment>
        <ip>8.8.8.8</ip>
    </user>
    <user>
        <name>Ldap user 1</name>
        <comment>New ldap user</comment>
    </user>
    <user xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"userObjectGroupDTO\">
        <name>User group 1</name>
        <comment>New user group</comment>
        <member>
            <id>14</id>
        </member>
        <member>
            <id>15</id>
        </member>
    </user>
</users>


Response Messages:
201: User was created.
200: Users were created.
400: There are no items to add.
400: Members IDs cannot be empty.
404: User with id <ID> was not found.
400: Invalid user type <TYPE>
400: Name cannot be empty.
400: User with name <NAME> already exists.
400: Invalid ip
403: Access is denied."},"response":[]},{"name":"Delete unused user","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"userId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users/{{userId}}","description":"Parameters:
userId: The ID of the user

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users/10

Response Messages:
200: User was deleted.
404: User with ID <ID> was not found.
400: Cannot delete an object that is being referenced by other objects.
403: Access is denied."},"response":[]},{"name":"Fetches user by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"userId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users/{{userId}}","description":"Parameters:
userId: The ID of the user

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users/10

Response Messages:
404: User with ID <ID> was not found.
403: Access is denied."},"response":[]}]},{"name":"Applications","item":[{"name":"Move applications to another customer","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t \n\t\t\t1\n\t\t \n\t\t \n\t\t\t 2\n\t\t \n\t \n\t \n\t\t \n\t\t\t2\n\t\t \n\t\t \n\t\t\tDefault\n\t\t \n\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/move_applications","description":"Parameters:
body: List of applications and customers [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/move_applications
BODY<move_applications>
     <move_application>
         <application>
            <id>1</id>
         </application>
         <customer>
             <id>2</id>
         </customer>
     </move_application>
     <move_application>
         <application>
            <id>2</id>
         </application>
         <customer>
            <name>Default</name>
         </customer>
     </move_application>
</move_applications>


Response Messages:
200: Applications were moved successfully.
400: Multi-Customer mode is not enabled.
400: You cannot move an application pack to a different customer.
400: Reference to application is invalid.
400: APPLICATION already exists in CUSTOMER.
400: You must specify the name or ID of the customer.
400: The customer has no ID or name.
400: Reference to CUSTOMER is invalid.
400: CUSTOMER is not imported to SecureApp.
400: CUSTOMER was decommissioned.
400: You must delete virtual servers from CUSTOMER before you move APPLICATION to another customer.
400: You must remove virtual servers from the INTERFACE and publish it before you move APPLICATION to another customer.
400: You cannot move APPLICATION to CUSTOMER because the connection to application pack and the application pack cannot be in the same customer.
400: You cannot move APPLICATION to a different customer because the application interface and the application pack must be in the same customer.
400: You must remove INTERFACE from APPLICATION PACK and publish it before you can move APPLICATION to another customer.
400: CONNECTION TO APPLICATION from APPLICATION must use interface from CUSTOMER.
400: Sources in CONNECTION from APPLICATION must all be from applications in the same customer.
400: Destinations in CONNECTION in APPLICATION must all be from applications in the same customer.
400: Servers in CONNECTION from APPLICATION must all be from CUSTOMER.
400: Servers in CONNECTION TO APPLICATION from APPLICATION must be from applications in the same customer.
400: Servers in CONNECTION TO APPLICATION from APPLICATION must be from CUSTOMER.
400: Application or application pack with NAME already exists in CUSTOMER.
400: There are no applications to move.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]},{"name":"Retrieve an existing application by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}","description":"Parameters:
applicationId: The unique identifier of an application to retrieve

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1

Response Messages:
400: The application was already deleted.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: Access is denied
403: You do not have permission to access application with ID
404: There is no application with the specified ID."},"response":[]},{"name":"Change an application","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t 139\n\t UpdatedAppName\n\t UpdatedComment\n\t false\n\t \n\t\t 4\n\t \n\t \n\t\t \n\t\t\t 3\n\t\t \n\t \n\t \n\t\t \n\t\t\t 5\n\t\t \n\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}","description":"This API can be used to delete or decommission an application.
To decommission an application, send true in decommissioned tag.

Parameters:
applicationId: The unique identifier of an application to change
body: Application

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/139
BODY<application>
     <id>139</id>
     <name>UpdatedAppName</name>
     <comment>UpdatedComment</comment>
     <decommissioned>false</decommissioned>
     <owner>
         <id>4</id>
     </owner>
     <editors>
         <editor>
             <id>3</id>
         </editor>
     </editors>
     <viewers>
         <viewer>
             <id>5</id>
         </viewer>
     </viewers>
</application>


Response Messages:
400: The application was already deleted.
400: Application owner is missing.
400: Owner cannot be empty.
400: Reference to owner ID is invalid.
400: There is an editor without an ID or name.
400: The application owner cannot also be an editor of the application.
400: There is a viewer without an ID or name.
400: The application owner cannot also be a viewer of the application.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application.
403: Access is denied
403: You do not have permissions to change the owner of application ID.
403: You do not have permissions to change the editors and a viewer of application ID.
403: You do not have permissions to decommission this application.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]},{"name":"Delete an application","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}","description":"Parameters:
applicationId: The unique identifier of the application to delete

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1

Response Messages:
400: The application was already deleted.
400: The resources of application NAME are used in connections for other applications.
400: You cannot delete application NAME because its application interfaces are used in other applications.
400: You cannot delete application NAME because its application interfaces are used in other application packs.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
400: Application with ID ID was not found.
400: You cannot delete application NAME because there are connection changes pending a ticket in other application."},"response":[]},{"name":"Export application history to PDF","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"application_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/history/export_pdf","description":"Parameters:
application_id: The unique identifier of the application
start_date: States starting date to fetch history since. Date format expected: yyyy-mm-dd [optional]
end_date: Get history until this date. Date format expected: yyyy-mm-dd [optional]
count: History max rows [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?start_date=2015-07-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?start_date=2015-07-18&end_date=2015-12-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?start_date=2015-07-18&count=2

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?count=2

Response Messages:
403: Access is denied.
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
400: The date format must be: yyyy-mm-dd
400: Start date must be before End date"},"response":[]},{"name":"Retrieve security policy violations from SecureTrack","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/compliance_violations","description":"Parameters:
applicationId [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/compliance_violations

Response Messages:
400: No valid connections found in APPLICATION.
400: Security policy compliance check is not available because a security policy has not been defined.
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
503: Cannot connect to SecureTrack.
503: Timeout occurred while waiting for response from SecureTrack.
500: An error occurred in SecureTrack when running the security compliance check."},"response":[]},{"name":"Retrieve application history","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/history","description":"Parameters:
applicationId: The unique identifier of the application
start_date: States starting date to fetch history since. Date format expected: yyyy-mm-dd [optional]
end_date: Get history until this date. Date format expected: yyyy-mm-dd [optional]
count: History list length [optional]
start: Offset the count starting point [optional]
type: States the history type to fetch [optional]
user: The username of the user made the changes [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start_date=2015-07-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start_date=2015-07-18&end_date=2015-12-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start_date=2015-07-18&count=1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start=0&count=1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?type=SERVER

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?user=Jack

Response Messages:
400: The date format must be: yyyy-mm-dd
400: Start date must be before End date
400: Count parameter must be a number
400: Start parameter must be a number
400: Start parameter must be less than total
400: Type parameter must be either server, server_group, connection, application, application_interface, connection_interface or connection_to_application
400: User not found
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID."},"response":[]},{"name":"Export Impact Analysis to a CSV file.","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"application_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/impact_analysis_csv","description":"To prevent a CSV injection attack when exporting Impact Analysis to a CSV file, if a special character ( = - + @ ) appears at the beginning of any field, a single quote (') is added before the character.

Parameters:
application_id: The unique identifier of the application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/impact_analysis_csv

Response Messages:
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
404: There is no application with the specified ID."},"response":[]},{"name":"Create new applications","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t AppName\n\t\t Comment\n\t\t \n\t\t\t 3\n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 4\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 5\n\t\t\t \n\t\t \n\t\t \n\t\t\t 24\n\t\t \n\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/","description":"Parameters:
body: List all applications

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications
BODY<applications>
     <application>
         <name>AppName</name>
         <comment>Comment</comment>
         <owner>
             <id>3</id>
         </owner>
         <editors>
             <editor>
                 <id>4</id>
             </editor>
         </editors>
         <viewers>
             <viewer>
                 <id>5</id>
             </viewer>
         </viewers>
         <customer>
             <id>24</id>
         </customer>
     </application>
</applications>


Response Messages:
400: There are no items to add.
400: Application was already saved.
400: Application name must contain at least 2 and no more than 160 characters.
400: Owner cannot be empty.
400: The specified owner does not exist.
400: The owner NAME does not have permission to access applications.
400: There is an editor without an ID or name.
400: The application owner cannot also be an editor of the application.
400: There is a viewer without an ID or name.
400: The application owner cannot also be a viewer of the application.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application.
400: Application with NAME already exists.
400: Application owner is missing.
400: Reference to owner ID is invalid.
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to customer ID is invalid.
400: You must specify the name or ID of the customer.
400: The customer has no ID or name.
400: The specified customer does not exist.
400: There is an editor without an ID or name.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no editor with the name NAME."},"response":[]},{"name":"Update applications","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t 140\n\t\t App1\n\t\t true\n\t\t \n\t\t\t 4\n\t\t \n\t \n\t \n\t\t 139\n\t\t UpdatedAppName\n\t\t Updated Comment\n\t\t \n\t\t\t 4\n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 3\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 5\n\t\t\t \n\t\t \n\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/","description":"This API can be used to delete or decommission an application.
To decommission an application, send true in decommissioned tag.

Parameters:
body: List of applications

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications
BODY<applications>
     <application>
         <id>140</id>
         <name>App1</name>
         <decommissioned>true</decommissioned>
         <owner>
             <id>4</id>
         </owner>
     </application>
     <application>
         <id>139</id>
         <name>UpdatedAppName</name>
         <comment>Updated Comment</comment>
         <owner>
             <id>4</id>
         </owner>
         <editors>
             <editor>
                 <id>3</id>
             </editor>
         </editors>
         <viewers>
             <viewer>
                 <id>5</id>
             </viewer>
         </viewers>
     </application>
</applications>


Response Messages:
400: Application ID is missing.
400: Application ID is invalid
400: The application was already deleted.
400: You must include the owner field.
400: There is an editor without an ID or name.
400: The application owner cannot also be an editor of the application.
400: There is a viewer without an ID or name.
400: The application owner cannot also be a viewer of the application.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application.
403: Access is denied
403: You do not have permissions to change the owner of application ID.
403: You do not have permissions to change the editors and a viewer of application ID.
403: You do not have permissions to decommission this application.
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID."},"response":[]},{"name":"List all applications","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/","description":"Parameters:
userId: Applications by user ID, if not given the default is logged in user id [optional]
name: The name of the application [optional]
app_permissions: Filter applications by the given permissions (separated with commas):\napp_owner - returns applications where the user is the owner\napp_editor - returns applications where the user has been explicitly added as an editor\napp_viewer - returns applications where the user has been explicitly added as a viewer\napp_adminonly - returns applications where the user only has editor access because user has “edit all applications” permission, and does not include applications where this user is either the app_owner, app_editor, or app_viewer [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?name=App

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?userId=1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?app_permissions=app_owner,app_editor,app_viewer

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?name=App&app_permissions=app_adminonly

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications

Response Messages:
400: Invalid app_permissions value: 'appPermissions'.
403: Access is denied
403: You can't use the parameter 'userId' because you don't have 'View all applications' permission.
404: There are no applications matching your filter.
404: User with ID 'userId' was not found."},"response":[]}]},{"name":"Cloud Console","item":[{"name":"Auto associate cloud servers from SecureTrack with an application","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tApplication\n\ttrue\n\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/cloud_console/servers/auto_association_rule","description":"When auto-associate is enabled, user must enter key value

Parameters:
body: Auto association rule

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers/auto_association_rule
BODY<auto_association_rule>
    <key>Application</key>
    <enabled>true</enabled>
</auto_association_rule>


Response Messages:
200: Auto association rule is saved.
400: Enabled rule requires key value.
403: Access is denied
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to search for cloud servers."},"response":[]},{"name":"Retrieve cloud server listing from SecureTrack","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"vendor"},{"value":null,"type":"text","key":"search_string"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/cloud_console/servers/","description":"Parameters:
customer_id: Customer ID to be filtered by. [optional]
vendor: Vendor to be filtered by.
search_string: Search text.
start: Returning matching result starting from this element in the array (0-based). [optional]
count: Total number of matching servers to return. [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers?vendor=Amazon&search_string=WebServe

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers?vendor=Amazon&search_string=\"WebServer1\"

Response Messages:
403: Access is denied
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to search for cloud servers.
400: Illegal search string.
400: Start is bigger then possible result count.
400: Start and count cannot hold negative values.
400: Vendor query param is required.
400: Vendor should be one of the following: Amazon.
400: Search string query param is required.
400: Customer with ID does not exist in SecureApp
400: Customer with ID was decommissioned."},"response":[]},{"name":"Associate cloud servers from SecureTrack with an application","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t9\n\t\t\n\t\t\t{b503916e-4468-4dc8-981b-2ec534587352}\n\t\t\t{0cc947a5-276f-4a4a-9d12-df5284fce609}\n\t\t\n\t\n\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/cloud_console/servers/","description":"Parameters:
application_id: The ID of the application
body: List of device IDs and cloud server UIDs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers?application_id=87
BODY<devices_to_uids>
    <device_to_uids>
        <device_id>9</device_id>
        <uids>
            <uid>{b503916e-4468-4dc8-981b-2ec534587352}</uid>
            <uid>{0cc947a5-276f-4a4a-9d12-df5284fce609}</uid>
        </uids>
    </device_to_uids>
</devices_to_uids>


Response Messages:
201: Servers were imported to SecureApp.
403: Access is denied
400: There is no application with the specified ID.
401: No available licenses. Ask your SecureApp administrator for assistance.
400: You do not have permissions to edit this application.
400: You cannot associate servers with this application, because the application has been decommissioned.
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to add cloud servers.
403: UID does not exist in device ID.
403: Device with ID does not exist.
403: Device with ID does not exist in DOMAIN.
403: The AWS instance with UID and device ID has already been imported to application NAME. You cannot import the same instance multiple times."},"response":[]}]},{"name":"Customers","item":[{"name":"import customers","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t2\n\t\n\t\n\t\t3\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/import","description":"Only users with 'Create new applications' and 'View all applications' permissions can run this API.

Parameters:
body: Customers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/customers/import
BODY<customers>
    <customer>
        <id>2</id>
    </customer>
    <customer>
        <id>3</id>
    </customer>
</customers>


Response Messages:
400: Not available in single-customer mode.
400: ID can not be empty.
400: There are some id's that doesn't exist.
403: Access is denied
503: Not connected to SecureTrack."},"response":[]},{"name":"List all imported customers","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/imported","description":"

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/imported

Response Messages:
400: Not available in single-customer mode.
403: Access is denied"},"response":[]},{"name":"List all non-imported customers","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/not_imported","description":"Only users with 'Create new applications' and 'View all applications' permissions can run this API.



Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/not_imported

Response Messages:
400: Not available in single-customer mode.
403: Access is denied
503: Not connected to SecureTrack."},"response":[]},{"name":"List all customers","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/","description":"Parameters:
name: The name of the customer [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers?name=Customer 1

Response Messages:
400: Not available in single-customer mode.
404: There are no customers with the name NAME."},"response":[]},{"name":"Retrieve existing applications for specific domain","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/{{customer_id}}/applications","description":"Parameters:
customer_id: The ID of the customer

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/2/applications

Response Messages:
400: Not available in single-customer mode.
400: Customer with id ID was not found.
403: Access is denied"},"response":[]},{"name":"Update a customer","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tNOT_IMPORTED\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/{{customer_id}}","description":"Parameters:
customer_id: The ID of the customer
body: Customers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/customers/2
BODY<customer>
    <usage_mode>NOT_IMPORTED</usage_mode>
</customer>


Response Messages:
400: Not available in single-customer mode.
400: Customer with id ID was not found.
400: Can not update Default customer.
400: This customer is already not imported.
400: USAGE_MODE is not a valid state. The valid values are: USAGE_MODES
403: Access is denied
500: This customer is not imported.
400: You cannot delete this customer because there are connection changes pending a ticket in another customer.You must decommission this customer first, and then delete it."},"response":[]},{"name":"Fetches customer by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/{{customer_id}}","description":"Parameters:
customer_id: The ID of the customer

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/1

Response Messages:
400: Not available in single-customer mode.
400: Customer with id ID was not found."},"response":[]}]},{"name":"Domains","item":[{"name":"Fetches domain by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"domainId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/domains/{{domainId}}","description":"Parameters:
domainId: The ID of the domain

Usage Example


Response Messages:
400: Domain with id ID was not found."},"response":[]},{"name":"synchronize domains","request":{"method":"PUT","header":[],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/domains/synchronize","description":"Retrieves all the domains lists in ST , for use by SC. If a domain was deleted in ST, then it will be removed from SC



Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/domains/synchronize

Response Messages:
500: Multi-Domain mode is disabled in SecureChange. Unable to synchronize with SecureTrack domains"},"response":[]},{"name":"List all domains","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/domains/","description":"Parameters:
name: The name of the domain [optional]

Usage Example


Response Messages:
404: There are no domains with the name NAME."},"response":[]}]},{"name":"Load Balancers","item":[{"name":"Fetches virtual servers from SecureTrack","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"ip"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/external_resources/f5_virtual_servers","description":"Find virtual servers matching a given IP address.
You can search for the virtual server itself of any of its members.

Parameters:
ip: ip
domainId: The unique identifier of a domain [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/external_resources/f5_virtual_servers?ip=2.2.2.2

Response Messages:
400: Invalid IP
400: Invalid Subnet
400: There is no domain with the specified ID.
403: Access is denied
503: Not connected to SecureTrack."},"response":[]}]},{"name":"Rule Recertification","item":[{"name":"Run Update Metadata for given task","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/rule_recertification/update_metadata","description":"A link to the rule recertification field will returned in the location field of the header, for example: /securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/fields/72

Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/rule_recertification/update_metadata

Response Messages:
400: Update Metadata is not defined for the requested field.
400: Update Metadata is not available for the current ticket status.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a rule recertification request field.
403: You do not have permission to update this task. Contact your administrator for assistance."},"response":[]}]},{"name":"SecureChange Devices","item":[{"name":"Get suggested targets for a given access request","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"access_request\":{\n\t\t\"users\":{\n\t\t\t\"user\":[\n\t\t\t\t\"Any\"\n\t\t\t]\n\t\t},\n\t\t\"sources\":{\n\t\t\t\"source\":[\n\t\t\t\t{\n\t\t\t\t\t\"@type\":\"IP\",\n\t\t\t\t\t\"ip_address\":\"10.100.1.1\",\n\t\t\t\t\t\"netmask\":\"255.255.255.255\",\n\t\t\t\t\t\"cidr\":32\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"destinations\":{\n\t\t\t\"destination\":[\n\t\t\t\t{\n\t\t\t\t\t\"@type\":\"IP\",\n\t\t\t\t\t\"ip_address\":\"10.100.20.2\",\n\t\t\t\t\t\"netmask\":\"255.255.255.255\",\n\t\t\t\t\t\"cidr\":32\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"services\":{\n\t\t\t\"service\":[\n\t\t\t\t{\n\t\t\t\t\t\"@type\":\"ANY\",\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"action\":\"Accept\",\n\t}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/suggest_target","description":"Returns a list of suggested targets for a given access request, based on topology calculations.

Parameters:
body [optional]
domain_name: Domain Name
workflow_name: Workflow Name

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/suggest_target?domain_name=Default&workflow_name=AR
BODY{
    \"access_request\":{
        \"users\":{
            \"user\":[
                \"Any\"
            ]
        },
        \"sources\":{
            \"source\":[
                {
                    \"@type\":\"IP\",
                    \"ip_address\":\"10.100.1.1\",
                    \"netmask\":\"255.255.255.255\",
                    \"cidr\":32
                }
            ]
        },
        \"destinations\":{
            \"destination\":[
                {
                    \"@type\":\"IP\",
                    \"ip_address\":\"10.100.20.2\",
                    \"netmask\":\"255.255.255.255\",
                    \"cidr\":32
                }
            ]
        },
        \"services\":{
            \"service\":[
                {
                    \"@type\":\"ANY\",
                }
            ]
        },
        \"action\":\"Accept\",
    }
}
OUTPUT{
    \"multi_target\": {
        \"target\": {
            \"@type\": \"Object\",
            \"object_name\": \"Device-1\",
            \"object_type\": \"firewall\",
            \"object_details\": \"10.100.40.1\",
            \"management_id\": 250,
            \"management_name\": \"Panorama/Domain1\"
        }
    }
}


Response Messages:
200: Targets returned successfully
400: User does not have permissions to domain or domain does not exist
403: Access is denied"},"response":[]},{"name":"Update the whole list of excluded devices in SecureChange","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t1\n\t12\n\n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/excluded","description":"Parameters:
body [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded
BODY<device_ids>
    <id>1</id>
    <id>12</id>
</device_ids>

"},"response":[]},{"name":"Returns IDs for specified list of excluded parent management devices and child firewalls in SecureChange","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/excluded","description":"For example on this Panorama hierarchy:
DG1 - Excluded
  DG1.1
    FW1
    FW2
    FW3

Calling this API with false value will return only DG1’s id.
Calling this API with true value will return DG1, FW1, FW2, FW3 id’s.


Parameters:
show_all: When set to true - Displays the specified devices and all their child firewalls in the hierarchy, which will be excluded implicitly.
When set to false - Displays only the devices which were explicitly excluded.
Default value is false.
[optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded
OUTPUT<device_ids>
    <id>10</id>
    <id>11</id>
</device_ids>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded?show_all=false
OUTPUT<device_ids>
    <id>10</id>
    <id>11</id>
</device_ids>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded?show_all=true
OUTPUT<device_ids>
    <id>33</id>
    <id>10</id>
    <id>11</id>
    <id>35</id>
    <id>29</id>
    <id>31</id>
</device_ids>

"},"response":[]},{"name":"Returns the details of the devices that you can select as a target in SecureChange","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/","description":"Parameters:
name: device name or part of a name [optional]
show_targets: show devices as targets [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/devices?name=asa&show_targets=true

Response Messages:
404: Devices not found"},"response":[]}]},{"name":"Server Decommissioning","item":[{"name":"Get server decommission designer results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_server_decommission_request/{{fieldId}}/designer","description":"Use this API to retrieve designer results generated in R17-1 and earlier.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Server Decommission Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/multi_server_decommission_request/261/designer

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>."},"response":[]},{"name":"Get verifier results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_server_decommission_request/{{fieldId}}/verifier","description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Server Decommission Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/multi_server_decommission_request/261/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>."},"response":[]},{"name":"Run Verifier for given task","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/multi_server_decommission_request/verifier","description":"Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/multi_server_decommission_request/verifier

Response Messages:
400: Verifier is not defined for the requested field.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a decommission request field.
403: You do not have permission to update this task. Contact your administrator for assistance."},"response":[]},{"name":"Run Impact Analysis for given task","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/multi_server_decommission_request/impact_analysis","description":"Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/multi_server_decommission_request/impact_analysis

Response Messages:
400: Impact analysis is not defined for the requested field.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a decommission request field.
403: You do not have permission to update this task. Contact your administrator for assistance."},"response":[]},{"name":"Get impact analysis results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_server_decommission_request/{{fieldId}}/impact_analysis","description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Server Decommission Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/multi_server_decommission_request/261/impact_analysis

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>."},"response":[]},{"name":"Run server decommission designer for given task","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/multi_server_decommission_request/designer","description":"Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/multi_server_decommission_request/designer

Response Messages:
400: Server decommission designer is not defined for the requested field.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a decommission request field.
403: You do not have permission to update this task. Contact your administrator for assistance."},"response":[]}]},{"name":"System Configuration","item":[{"name":"Retrieve the SecureTrack connection settings and status","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/integration_with_secureTrack/","description":"

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/integration_with_secureTrack?testOnly=false
"},"response":[]},{"name":"Modify the SecureTrack connection settings and test the connection status","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\t\n\t\t \n\t\t\t192.168.11.1\n\t\t\tadmin\n\t\t\n\t\tfalse\n\t\t30\n\t\t192.168.2.2\n\t"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/integration_with_secureTrack/","description":"Parameters:
testOnly: Test the connection status using the specified settings. The new settings are not saved. The default value is false [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/integration_with_secureTrack
BODY    <secureTrack_settings>
        <host xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"remoteHost\">
            <IP_or_hostname>192.168.11.1</IP_or_hostname>
            <user_name>admin</user_name>
        </host>
        <show_link_to_secureTrack>false</show_link_to_secureTrack>
        <check_connection_interval>30</check_connection_interval>
        <internal_IP_of_secureChange_server>192.168.2.2</internal_IP_of_secureChange_server>
    </secureTrack_settings>


Response Messages:
400: Invalid host name or IP address.
400: show_link_to_secureTrack is invalid. It must be 'true', 'false' or empty."},"response":[]}]},{"name":"System Users","item":[{"name":"Return the list of users","request":{"method":"GET","header":[],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/","description":"user_name: case insensitive, search mode: contains text
exact_name: when set to true, user_name search mode is case sensitive and exact text
email: case insentitive, search mode: exact match
Logical OR between user_name and email.

Parameters:
showIndirectRelation: Members that belong to the selected group only indirectly [optional]
user_name: The user's login name [optional]
email: The user's email [optional]
exact_name: Search user_name as exact match [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/users?email=bob@tufin.com&user_name=bob&exact_name=true
"},"response":[]},{"name":"Import LDAP users to SecureChange by simulating login process","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tx\n\tLDAP\n\t\t\n\t\t\t1\n\t\t\n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/","description":"This API implicitly imports LDAP users to SecureChange by simulating their login.
To explicitly import LDAP entities- both users and groups, it is recommended to use /users/import API

Parameters:
body: partyDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/users
BODY<user xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"user\">
    <name>x</name>
    <origin_type>LDAP</origin_type>
        <ldap_configuration>
            <id>1</id>
        </ldap_configuration>
</user>


Response Messages:
403: Access is denied.
400: Name is missing.
400: Origin is missing.
400: User {login_name} already exists, with ID (id} and name {name}.
400: User {login_name} not found in LDAP.
400: Creating a user via REST API is available only if origin is LDAP.
400: Creating a user via REST API is available only if type is User.
400: Ldap configuration with ID {id} not found."},"response":[]},{"name":"Import user / group from LDAP","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"ldap_party\": {\n\t\t\"ldap_configuration_name\": \"ldap_name\",\n\t\t\"ldap_dn\": \"CN=alice,OU=Advertising,OU=Marketing,DC=testEnv,DC=com\"\n\t}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/import","description":"The imported user / group will be visible in SecureChange GUI under users section.
In multi domain mode, imported entity will be assigned with the domains of \"any user\" group.
Only users with 'view settings tab' permission can run this API.

Parameters:
body: ldapPartyDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/users/import
BODY{
    \"ldap_party\": {
        \"ldap_configuration_name\": \"ldap_name\",
        \"ldap_dn\": \"CN=alice,OU=Advertising,OU=Marketing,DC=testEnv,DC=com\"
    }
}


Response Messages:
400: The LDAP configuration name does not exist
400: The given ldap_dn does not exist
400: The given ldap_dn is already imported
400: Failed to create the selected user
400: Failed to create the selected group
400: Selected user already exists in SecureChange but is not synchronized with the LDAP server. Go to Settings > LDAP and synchronize with the LDAP
400: This group has a large number of users, and will not be expanded in the users console. To be able to configure roles and step participation for individual users from the group, add them explicitly.
400: Failed to update the selected group
400: Unsupported LDAP object class
400: Unable to establish a connection to server <SERVER_IP>:<SERVER_PORT> within the configured timeout of <TIMEOUT> milliseconds.
403: Access is denied"},"response":[]},{"name":"Change local group members","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"group_change\":{\n\t\t\"member_ids_to_add\": [1,2],\n\t\t\"member_ids_to_remove\":[3,4]\n\t}\n}\t"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/group/{{id}}","description":"Only users with 'view settings tab' permission can run this API.

Parameters:
id: Group ID
body: groupChangeDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/users/group/1
BODY{
    \"group_change\":{
        \"member_ids_to_add\": [1,2],
        \"member_ids_to_remove\":[3,4]
    }
}    


Response Messages:
400: Exceeded limit of {MAXIMUM} group member changes
400: These user IDs do not exist: {IDs}
400: These user IDs do not exist or are not group members: {IDs}
400: Group ID {ID} is not a local group
400: Group ID {ID} does not exist
400: Cannot add a group to itself
400: Cannot add a group to a group that it already contains. Group {ID1} contains group {ID2}"},"response":[]},{"name":"Return the specified user","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/{{id}}","description":"Parameters:
id: User ID
showIndirectRelation: Members that belong to the selected group only indirectly [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/users/5

Response Messages:
400: User or group was not found."},"response":[]},{"name":"Delete the specified User or Group","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/{{id}}","description":"Parameters:
id: User ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/users/5

Response Messages:
400: User with id {id} does not exist"},"response":[]},{"name":"Create local group","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"group\": {\n\t\t\"name\": \"name1\",\n\t\t\"description\": \"description1\",\n\t\t\"email\": \"email1@tufin.com\"\n\t}\n}\t"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/group","description":"Only users with 'view settings tab' permission can run this API.

Parameters:
body: CreateGroupDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/users/group
BODY{
    \"group\": {
        \"name\": \"name1\",
        \"description\": \"description1\",
        \"email\": \"email1@tufin.com\"
    }
}    


Response Messages:
400: Input Validation Error : {field name}: {input validation error message}
400: Name already exists"},"response":[]}]},{"name":"Ticket Lifecycle","item":[{"name":"Returns the specified ticket to the specified step","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tplease fix source \n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/redo/{{toStepId}}","description":"Values can only be updated for the current step.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
toStepId: To which step we the ticket will return
body: RedoCommentDto

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/redo/1
BODY<redo_step_comment>
    <comment>please fix source </comment>
</redo_step_comment>


Response Messages:
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Task <NAME> is no longer active
403: User has no permissions to redo ticket steps.
404: There is no ticket with ID.
404: No entity found for query"},"response":[]},{"name":"Change the requester of the specified ticket task to the specified user.","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tuser was deleted moving tickets to Bob\n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/change_requester/{{assigneeId}}","description":"Parameters:
id: Ticket ID
assigneeId: The assignee ID
body: CommentDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/change_requester/4
BODY<comment>
    <comment>user was deleted moving tickets to Bob</comment>
</comment>


Response Messages:
400: The change requester comment must be set in order to change the requester the ticket.
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
404: There is no ticket with ID.
404: There is no requester (User) with ID."},"response":[]},{"name":"Confirm the request","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tconfirmed\n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/confirm","description":"Parameters:
id: Ticket ID
requester_id: The user of the ticket's requester, when logged in user is confirm on behalf [optional]
body: Confirm comment

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/confirm?requester_id=5
BODY<confirm_comment>
    <comment>confirmed</comment>
</confirm_comment>


Response Messages:
400: User is trying to confirm a ticket that belongs to another user
400: User is not permitted to confirm this ticket on behalf another user
400: The user can not confirm the ticket, because he is not in the domain of the ticket
403: Access is denied.
404: There is no ticket with ID ."},"response":[]},{"name":"Cancel a ticket","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/cancel","description":"Parameters:
id: The ID of the ticket as shown in SecureChange
requester_id: The user of the ticket's requester, when logged in user is canceling on behalf [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/cancel?requester_id=5

Response Messages:
403: Access is denied.
404: Ticket is already closed
404: Ticket ID was not found"},"response":[]},{"name":"Reassigns the specified ticket task to the specified user.","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tPlease complete the AR\n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/reassign/{{assigneeId}}","description":"Values can only be updated for the current step.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
assigneeId: The assignee ID
body: ReassignTaskCommentDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/reassign/4
BODY<reassign_task_comment>
    <comment>Please complete the AR</comment>
</reassign_task_comment>


Response Messages:
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Task <NAME> is no longer active
404: There is no ticket with ID.
404: No entity found for query"},"response":[]},{"name":"Map rules to ticket","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/map_rules","description":"Maps the rules from the ticket to the relevant rules in SecureTrack.
Adds record set entries to the relevant rules metadata.
Link to history is found in the returned location header.
Applicable only for closed tickets in the following workflows: Access Request, Access Request and Modify Group, and Clone Server Policy.
Use handler_id for running on behalf of another user.
To get handler_id, use the System Users API.

Parameters:
id: The ID of the ticket as shown in SecureChange
handler_id: Run API on behalf of defined user id [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/map_rules

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/map_rules?handler_id=5

Response Messages:
201: Started asynchronous mapping of rules to ticket ID <ID>. Mapping status is displayed in ticket history.
400: Ticket's workflow type does not support this operation
403: Access is denied.
403: You do not have permission to access ticket <ID>
403: On behalf user do not have permission to access ticket <ID>
404: There is no ticket with ID <ID>.
404: There is no handler (User) with ID <ID>.
412: Ticket is not in closed status"},"response":[]},{"name":"Returns the history of the specified ticket","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/history","description":"Parameters:
id: Ticket ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/history

Response Messages:
403: User has no permissions to view ticket history
404: You do not have permission to view this task. Contact your administrator for assistance.
404: There is no ticket with ID."},"response":[]},{"name":"Reject a ticket","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\trejected\n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/reject","description":"Parameters:
id: The ID of the ticket as shown in SecureChange
handler_id: The user id, when logged in user is rejecting on behalf [optional]
body: Reject comment

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/reject?handler_id=5
BODY<reject_comment>
    <comment>rejected</comment>
</reject_comment>


Response Messages:
400: Ticket status <STATUS> is incorrect to perform this action
400: User <NAME> has no permissions to perform this action
400: Comment cannot be empty
403: User is not permitted to reject this ticket on behalf another user
403: You do not have permission to access ticket <ID>
403: On behalf user do not have permission to access ticket <ID>
403: Access is denied.
404: There is no ticket with ID <ID>.
404: There is no handler (User) with ID <ID>."},"response":[]}]},{"name":"Tickets","item":[{"name":"Returns a list of tickets by search parameters","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/search","description":"If the query is succesful but no results are found (for example, if there is no ticket for the specified Ticket ID) then the return code will be 200 and the results will be empty.

Parameters:
id: The ID number of the ticket as shown in SecureChange [optional]
subject: The subject of the ticket [optional]
requester: The requester of the ticket [optional]
group: The group handling the ticket [optional]
assigned_to: The user name of the person assigned to the ticket [optional]
priority: The priority of the ticket [optional]
status: The status of the ticket [optional]
sla_status: The SLA status of the ticket [optional]
field_name: Field name to search by [optional]
field_value: Field value to search by [optional]
current_step: Current step name [optional]
expiration_date_from: Search requests with expiration date from this date [optional]
expiration_date_to: Search requests with expiration date until this date [optional]
domain_name: The Domain of the ticket [optional]
start: Offset the count starting point [optional]
count: Ticket list length [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/search?id=1&status=IN_PROGRESS,REJECTED

Response Messages:
403: Access is denied.
400: Illegal ticket status entered. Permitted values are: IN_PROGRESS, REJECTED, CLOSED, CANCELLED, RESOLVED, WAITING_TO_BE_ASSIGNED, ASSIGNED, WAITING_FOR_MORE_INFO, DONE, INVALID, PENDING, PENDING_LICENS
400: Illegal ticket SLA status entered. Permitted values are: NA, OK, WARNING, ALERT, ESCALATION
400: Illegal ticket priority entered. Permitted values are: LOW, NORMAL, HIGH, CRITICAL
400: Illegal ticket expiration date entered. Permitted date format is: ddMMyyyy (ex. 20.11.2001)
400: Cannot find specified domain <DOMAIN_NAME>"},"response":[]},{"name":"Returns the details of a specified ticket stages","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2

Response Messages:
403: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID."},"response":[]},{"name":"Returns the details of the tasks","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks

Response Messages:
403: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID."},"response":[]},{"name":"Get rule decommision verifier results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/rule_decommission/verifier","description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/rule_decommission/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type <TYPE>.
404: Verifier results were not found in the request."},"response":[]},{"name":"Returns the details of a the fields","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
taskId: The ID number of the task as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields

Response Messages:
403: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.
404: Task with ID was not found in Stage ID in ticket ID ."},"response":[]},{"name":"Change multiple fields within a task of a ticket","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\"fields\": {\n\"field\": {\n\"@xsi.type\": \"rule_modification_field\",\n\"id\": 746,\n\"name\": \"rm\",\n\"devices\": {\n\t\"device\": {\n\t\"revision_id\": 24,\n\t\"management_id\": 5,\n\t\"bindings\": {\n\t\"binding\": {\n\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\"binding\": {\n\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t},\n\t\"rules\": {\n\t\t\"rule\": {\n\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t}\n\t}\n\t}\n\t}\n\t}\n},\n\"rule_modifications\": {\n\t\"rule_modification\": {\n\t\"@xsi.type\": \"modify_rule_modification\",\n\t\"rule_key\": {\n\t\"device_id\": 5,\n\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t},\n\t\"source_modifications\": {\n\t\"network_object_cell_modifications\": {\n\t\"network_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\"name\": \"NET_1\",\n\t\t\t\"comment\": \"\",\n\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t}\n\t\t]\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t}\n\t\t]\n\t\t}\n\t\t}\n\t]\n\t}\n\t},\n\t\"destination_modifications\": {\n\t\"network_object_cell_modifications\": {\n\t\"network_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"REMOVE\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\"name\": \"Host123\",\n\t\t\t\"comment\": \"cccHost\",\n\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t}\n\t\t]\n\t\t}\n\t\t}\n\t]\n\t}\n\t},\n\t\"service_modifications\": {\n\t\"service_object_cell_modifications\": {\n\t\"service_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"REMOVE\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\"name\": \"ICMP_1\",\n\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\"type\": {\n\t\t\t\"from\": 55,\n\t\t\t\"to\": 55\n\t\t}\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\"name\": \"TCP_1\",\n\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\"port\": {\n\t\t\t\"from\": 1234,\n\t\t\t\"to\": 1234\n\t\t},\n\t\t\"protocol\": \"TCP\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\"name\": \"UDP_1\",\n\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\"port\": {\n\t\t\t\"from\": 3,\n\t\t\t\"to\": 3\n\t\t},\n\t\t\"protocol\": \"UDP\"\n\t\t}\n\t\t}\n\t\t}\n\t]\n\t}\n\t}\n\t}\n}\n}\n}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldListDTO
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/2/tasks/4/fields
BODY<fields>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_network_object\">
         <id>7885</id>
         <name>n_obj</name>
         <network_object type=\"Object\">
             <object_name>Host_10.1.1.1</object_name>
             <management_name>cp239</management_name>
         </network_object>
         <network_object type=\"Object\">
             <st_uid>{55908141-c341-4990-9cc6-a3fd2dfb49e1}</st_uid>
             <management_id>2</management_id>
         </network_object>
         <network_object type=\"DNS\">
             <host_name>tufin.com</host_name>
         </network_object>
     <field>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_service\">
         <id>7887</id>
         <name>service</name>
         <service type=\"PROTOCOL\">
             <protocol>TCP</protocol>
             <port>80</port>
         </service>
         <service type=\"Object\">
             <object_name>AOL</object_name>
             <management_name>cp239</management_name>
         </service>
     </field>
</fields>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/fields
BODY{
\"fields\": {
\"field\": {
\"@xsi.type\": \"rule_modification_field\",
\"id\": 746,
\"name\": \"rm\",
\"devices\": {
    \"device\": {
    \"revision_id\": 24,
    \"management_id\": 5,
    \"bindings\": {
    \"binding\": {
    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
    \"binding\": {
        \"@xsi.type\": \"policy__binding\",
        \"policy_name\": \"FortiGate-VM64-111-10_3\"
    },
    \"rules\": {
        \"rule\": {
        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
        \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
        }
    }
    }
    }
    }
},
\"rule_modifications\": {
    \"rule_modification\": {
    \"@xsi.type\": \"modify_rule_modification\",
    \"rule_key\": {
    \"device_id\": 5,
    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
    \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
    },
    \"source_modifications\": {
    \"network_object_cell_modifications\": {
    \"network_object_cell_modification\": [
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
            \"name\": \"NET_1\",
            \"comment\": \"\",
            \"ip\": \"3.3.3.3\",
            \"netmask\": \"255.255.255.255\"
        }
        ]
        }
        },
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
            \"name\": \"RANGE_1\",
            \"comment\": \"EXAMPLE_RANGE\",
            \"min_ip\": \"3.3.3.3\",
            \"max_ip\": \"5.5.5.5\"
        }
        ]
        }
        }
    ]
    }
    },
    \"destination_modifications\": {
    \"network_object_cell_modifications\": {
    \"network_object_cell_modification\": [
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
        }
        }
        },
        {
        \"action\": \"REMOVE\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
            \"name\": \"Host123\",
            \"comment\": \"cccHost\",
            \"ip\": \"1.2.3.4\",
            \"netmask\": \"255.255.255.255\"
        }
        ]
        }
        }
    ]
    }
    },
    \"service_modifications\": {
    \"service_object_cell_modifications\": {
    \"service_object_cell_modification\": [
        {
        \"action\": \"REMOVE\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:icmp_service\",
        \"name\": \"ICMP_1\",
        \"comment\": \"EXAMPLE_ICMP\",
        \"type\": {
            \"from\": 55,
            \"to\": 55
        }
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:transport_service\",
        \"name\": \"TCP_1\",
        \"comment\": \"EXAMPLE_TCP\",
        \"port\": {
            \"from\": 1234,
            \"to\": 1234
        },
        \"protocol\": \"TCP\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:transport_service\",
        \"name\": \"UDP_1\",
        \"comment\": \"EXAMPLE_UDP\",
        \"port\": {
            \"from\": 3,
            \"to\": 3
        },
        \"protocol\": \"UDP\"
        }
        }
        }
    ]
    }
    }
    }
}
}
}
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket step does not exist, or is not the current step
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: There are multiple objects with this name in the network)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
403: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (Network Object with device ID <DEVICE_ID> and ST UID <ST_UID> is not available for the action specified. Check the Knowledge Center or API Implementation Notes for more information
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: Invalid value for field: <FIELD_NAME> (a valid object comment can have up to <MAX> characters)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value
406: Invalid format detected: <name|binding_uid|rule_uid> - This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags
406: Invalid format detected: name - <VALUE> is invalid. Text must include <1-255> characters
406: Invalid format detected: <rule_uid|binding_uid> - <VALUE> is invalid. Text must include <1-4096> characters
406: Invalid format detected: comment - <VALUE> is invalid. Text must include <0-4096> characters
406: Invalid format detected: name - <VALUE> is invalid. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters + - , _ # @ . : = ! ^ ( )
406: Invalid format detected: <rule_uid|binding_uid|comment> - <VALUE> is invalid. Text includes invalid expressions such as HTML tags or command line operations
406: Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP"},"response":[]},{"name":"Returns topology map image (png file) for specific verifier results","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_access_request/{{fieldId}}/verifier/topology_map","description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/multi_access_request/2022/verifier/topology_map

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.
404: Verifier results were not found in the access request.
404: Toplogy map was not found for this field."},"response":[]},{"name":"Change the ticket properties","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t\n\t\n\t\n\t\t\n\t\n\t\n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/ticket_properties","description":"Change the ticket properties listed in the TicketPropertiesDTO.
When specifying the notification_group property you must use the ID of the group or leave the ID empty to remove the group. This property can be updated on a closed ticket.
When specifying the referenced_ticket property you must use the ID of the ticket or leave the ID empty to remove the ticket.
When specifying the expiration_date property, you must use a yyyy-mm-dd format, or leave the value empty to remove the expiration date. To ignore the field, do not include it in the request. This property can be updated on a closed ticket.

Parameters:
body: ticketPropertiesDTO
id: The ID number of the ticket as shown in SecureChange

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/ticket_properties
BODY<ticket_properties>
    <referenced_ticket>
        <id>9</id>
    </referenced_ticket>
    <notification_group>
        <id>10</id>
    </notification_group>
    <expiration_date>2022-12-10</expiration_date>
</ticket_properties>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/ticket_properties
BODY<ticket_properties>
    <notification_group>
        <id/>
    </notification_group>
    <referenced_ticket>
        <id/>
    </referenced_ticket>
    <expiration_date/>
</ticket_properties>


Response Messages:
400: Notification Group <ID> is a user and not a user group
400: Notification Group <ID> exceeds the configured maximum allowed number of users for notifications
400: <ID> (“Any User”) is not allowed as a Notification Group
400: Notification Group <ID> does not have permission of 'Group members can perform actions on requests submitted by other members'
400: Notification Group <ID> is not a member in the first step of the workflow
400: Notification Group is not enabled in this workflow
403: You do not have permission to change the Notification Group
404: There is no group with ID <ID>.
404: There is no ticket with ID <ID>.
400: Referenced ticket id cannot be the same as ticket id
400: invalid id format for referenced ticket
400: Cannot update properties [<Property A>, <Property B>] for ticket with status <STATUS>
403: You do not have permission to update this ticket at this stage. Contact your administrator for assistance.
403: The user is not allowed to add the specified referenced ticket.
400: Workflow does not support referenced ticket
400: Cannot delete expiration date on this workflow due to it being a mandatory field
400: Invalid date. Cannot update expiration to a date that has passed
400: Invalid value for field: expiration_date (The date format must be: yyyy-mm-dd)
400: Invalid value for field: expiration_date (The date is not valid)
400: This workflow does not support expiration dates"},"response":[]},{"name":"Modify the Designer suggestions for Access Request or Clone Server Policy","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"rule_placement\": {\"new_value\":\"before\"}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/tasks/{{taskId}}/designer/instruction/{{instructionId}}","description":" GENERAL USE
1. Create a ticket using UI/API.
2. Run the designer using UI/API.
3. Use relevent API to get the designer results.
4. Run this API to modify the required parameters.

*Note: you can modify one parameter at a time.

Change rule location use
a. Modifying the rule order places the new rule before the rule with the specified identifier (rule name or number).
b. Modifying the rule placement to \"last\" places the new rule as last rule or last pre-rule (depending on the vendor convention for the device).
c. For vendors that support \"after\" placement, modifying the rule placement allows positioning the new rule before or after the suggested rule location.
d. For Check Point R80 and above releases, the indented rule numbering format can be applied to globally assigned policies (for example, “rule_order”: “4.5”).

track level permitted values:
NONE, LOG, ACCOUNT, ALERT, SNMP, MAIL, USER_DEFINED, EMERGENCIES, ALERTS, CRITICAL, ERRORS, WARNINGS, NOTIFICATIONS, INFORMATIONAL, DEBUGGING, DISABLED, DEFAULT, FULL_LOG, NETWORK_LOG, USER_ALERT_1, USER_ALERT_2, USER_ALERT_3

rule placement permitted values:
BEFORE, AFTER, LAST

Parameters:
body: DesignerInstructionChangeDTO
id: Ticket ID
taskId: Task ID
instructionId: Instruction ID
force: force update when new revision available [optional]

Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"comment\": {\"new_value\":\"new comment\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196?force=true
BODY{
    \"comment\": {\"new_value\":\"new comment\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_name\": {\"new_value\":\"new rule name\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"track_level\": {\"new_value\":\"LOG\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"object_name\": {\"new_value\":\"new object name\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"log_forwarding_profile\": {\"new_value\":\"new log forwarding profile\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"security_profile_group\": {\"new_value\":\"new security profile group\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"object_replace\": {
             \"new_value\":\"new object uid\",
             \"old_value\":\"old object uid\"
    }
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_order\": {\"new_value\":\"8\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"tags\": {\"values\":[\"tag1\", \"tag2\"]}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"tags\": {\"values\":[]}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_placement\": {\"new_value\":\"last\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_placement\": {\"new_value\":\"before\"}
}


Response Messages:
200: New rule will be shadowed
200: New rule will be shadowed or break acceleration
400: Modify Designer Results API is only supported for Access Request and Clone Server Policy workflows
412: Current instruction cannot be modified because either the implementation was successful or failed irrevocably.
412: Current step does not support Designer modification action
404: A ticket with ID <ID> cannot be found.
400: Task ID <ID> cannot be found in the current step with ID <ID>.
403: Changing <TYPE> is not supported on this device
403: This Change is not supported for <INSTRUCTION TYPE> instruction type\"
403: You do not have permission to update this task. Contact your administrator for assistance.
403: New revision is available, cannot modify the Designer results
404: Specified instruction, id: <ID> was not found
404: Designer results were not found in the access request.
400: a valid object name must start with an alphanumeric character and can contain alphanumeric characters, underscore '_'. Hypen '-', dot '.' or spaces
400: For this device, the comment must be less than 100 characters per line.
400: For this device, this field must be less than <NUMBER OF CHARACTERS> characters
400: For this device, this field is required.
400: For this device, a valid object name cannot be <OBJECT NAME> because it is a reserved word
409: Rule name already exists for this device. Please give this rule a unique name.
409: Rule name <NAME> already exists in the device group hierarchy. Choose a unique name for this rule.
400: Comment contains invalid characters.
400: <DEVICE> does not support tracking level <TRACKING LEVEL>
400: <TRACKING LEVEL> is not a valid rule track level value
400: a valid object name cannot contain any of the following characters: <CHARACTERS>
400: a valid object name must be less than <NUMBER OF CHARACTERS> characters
400: a valid object name cannot be empty
400: a valid object name must conform to the following pattern: <STRING PATTERN>
409: Object already exists
400: A security profile group cannot be empty.
404: The security profile group <SECURITY PROFILE GROUP> was not found.
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to validate the security profile group.
400: A log forwarding profile cannot be empty.
400: Tag list is longer than 20 items.
400: Tag list contains the same tag more than once.
400: These tags don't exist or aren't relevant to the rule on its DG location : <Tags>
404: The log forwarding profile <LOG FORWARDING PROFILE> was not found.
500: An error occurred in SecureTrack while trying to validate the log forwarding profile.
400: Object UID <OLD OBJECT UID> not found in the rule for this instruction.
400: Values of new object UID <NEW OBJECT UID> and old object UID <OLD OBJECT UID> do not match.
400: Rule placement can only be: \"before\", \"after\" or \"last\".
400: You can't change rule placement when there is no rule order. please add rule order first.
400: You can't change rule placement to \"After\" for this type of device.
400: You can't change rule placement to \"Last\" for this type of device."},"response":[]},{"name":"Returns the details of a specified tickets (max 100 tickets in a single query)","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
status: The status of the tickets [optional]
count: Tickets list max pagination length (max value is 100) [optional]
start: Offset the count starting point [optional]
desc: Get the list in descending order [optional]
expand_links: See expanded view of the objects [optional]
showStepsDetails: Include steps' details in the response [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets?status=In Progress&count=10&start=3&expand_links=false

Response Messages:
400: Status is not a valid. The valid values are: TICKET_STATUSES
400: Can not fetch more than 100 tickets in 1 time
403: Access is denied"},"response":[]},{"name":"Submit a new ticket to Secure Change","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\t\"ticket\": {\n\t\t\"subject\": \"RM_EXAMPLE\",\n\t\t\"requester\": \"m\",\n\t\t\"requester_id\": 4,\n\t\t\"priority\": \"Normal\",\n\t\t\"domain_name\": \"\",\n\t\t\"workflow\": {\n\t\t\t\"name\": \"RM\",\n\t\t},\n\t\t\"steps\": {\n\t\t\t\"step\": [\n\t\t\t\t{\n\t\t\t\t\t\"tasks\": {\n\t\t\t\t\t\t\"task\": {\n\t\t\t\t\t\t\t\"fields\": {\n\t\t\t\t\t\t\t\t\"field\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\t\t\t\t\t\t\"devices\": {\n\t\t\t\t\t\t\t\t\t\t\"device\": {\n\t\t\t\t\t\t\t\t\t\t\t\"revision_id\": 24,\n\t\t\t\t\t\t\t\t\t\t\t\"management_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"rule_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\t\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 11,\n\t\t\t\t\t\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 9,\n\t\t\t\t\t\t\t\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/","description":" GENERAL USE
When posting a Modify Group ticket, group scope must be configured for FortiManager advanced and Juniper SRX devices.
Juniper SRX devices:
Global address-book will be used unless an existing address-book is given.
Ticket validation will fail in case given Address Book is not configured on the device.
FortiManager advanced devices:
'Any' zone will be used unless an existing zone is given.
Ticket validation will fail in case given zone is not configured on the device.
*Note: Zones and address-books must not be configured for other devices.

Using newly created objects from a different group in the same ticket
The user can add a newly created object from a different group to the selected group, with object_UID equal to the name of the newly created object.
For management devices with hierarchies, the newly created object does not populate other levels of the hierarchies.

Permitted values for @type
Allowed values for @type property included in DestinationDTO and SourceDTO are:
ANY
IP
DNS
Object - Device's existing object
INTERNET
LDAP (SourceDTO only) - LDAP entity

To use a service object in a new request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id
2. Both object_name and management_name

To use a network object in a new request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both object_UID and object_name are defined, object_UID takes precedence over object_name

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: ticketDTO
closed: Cannot be done from the API [optional]
count [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY<ticket>
    <subject>topology mode_AR1-with topology_AR2-no topology</subject>
    <requester>u1</requester>
    <priority>Normal</priority>
    <domain_name>Default</domain_name>
    <workflow>
         <id>7</id>
         <name>Workflow with topology</name>
    </workflow>
    <steps>
         <step>
             <name>Open request</name>
             <tasks>
                 <task>
                     <fields>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_access_request\">
                             <name>Required Access</name>
                             <access_request>
                                 <use_topology>true</use_topology>
                                 <targets>
                                     <target type=\"Object\">
                                         <object_name>ASA</object_name>
                                         <management_name>ASA</management_name>
                                     </target>
                                 </targets>
                                 <users>
                                     <user>Any</user>
                                 </users>
                                 <sources>
                                     <source type=\"Object\">
                                         <object_name>host_10.100.10.140</object_name>
                                         <management_name>NetScreen</management_name>
                                     </source>
                                 <sources>
                                     <source type=\"Object\">
                                         <object_UID>{55908141-c341-4990-9cc6-a3fd2dfb49e1}</object_UID>
                                         <management_id>13</management_id>
                                     </source>
                                 </sources>
                                 <destinations>
                                     <destination type=\"Object\">
                                         <object_name>h_10.10.10.10</object_name>
                                         <management_name>ASA</management_name>
                                     </destination>
                                 </destinations>
                                 <services>
                                     <service type=\"PROTOCOL\">
                                         <protocol>TCP</protocol>
                                         <port>80</port>
                                     </service>
                                     <service type=\"APPLICATION_IDENTITY\">
                                         <application_name>Gmail</application_name>
                                     </service>
                                 </services>
                                 <action>Accept</action>
                                 <labels/>
                             </access_request>
                             <access_request>
                                 <use_topology>false</use_topology>
                                 <targets>
                                     <target type=\"Object\">
                                         <object_name>inside_access_in</object_name>
                                         <management_name>ASA</management_name>
                                     </target>
                                 </targets>
                                 <users>
                                     <user>Any</user>
                                 </users>
                                 <sources>
                                     <source type=\"Object\">
                                         <object_name>1.1.1.0</object_name>
                                         <management_name>NetScreen</management_name>
                                     </source>
                                 </sources>
                                 <destinations>
                                     <destination type=\"Object\">
                                         <object_name>network_regi3</object_name>
                                         <management_name>ASA</management_name>
                                     </destination>
                                 </destinations>
                                 <services>
                                     <service type=\"ANY\">
                                     </service>
                                 </services>
                                 <action>Accept</action>
                                 <labels/>
                             </access_request>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_area\">
                             <name>Business Justification</name>
                             <text>I need access to ftp </text>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_field\">
                             <name>Project Number</name>
                             <text>CR124560 </text>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"hyperlink\">
                             <name>Hyperlink</name>
                             <url>http://192.168.1.1/ticket</url>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"drop_down_list\">
                             <name>Change Window</name>
                             <selection>Monday</selection>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"manager\">
                             <name>manager email</name>
                             <text>manager@tufin.com</text>
                         </field>
                     </fields>
                 </task>
             </tasks>
        </step>
    </steps>
    <comments/>
</ticket>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY<ticket>
    <subject>New MG ticket</subject>
    <requester>a</requester>
    <requester_id>4</requester_id>
    <priority>Normal</priority>
    <status>In Progress</status>
    <domain_name/>
    <sla_status>NA</sla_status>
    <sla_outcome>NA</sla_outcome>
    <workflow>
        <id>6</id>
        <name>MG</name>
        <uses_topology>false</uses_topology>
    </workflow>
    <steps>
        <step>
            <id>72</id>
            <name>New step</name>
            <redone>false</redone>
            <skipped>false</skipped>
            <tasks>
                <task>
                    <id>72</id>
                    <assignee_id>4</assignee_id>
                    <assignee>a</assignee>
                    <status>ASSIGNED</status>
                    <fields>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_group_change\">
                            <id>262</id>
                            <name>MG</name>
                            <read_only>false</read_only>
                            <implementation_status>NOT_SUPPORTED</implementation_status>
                            <group_change>
                                <name>ExistingGroup</name>
                                <object_UID>{c862fb6f-1314-45da-9e01-56c9b85d001d}</object_UID>
                                <management_id>58</management_id>
                                <management_name>FMG/root</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>157</id>
                                        <name>10.100 net</name>
                                        <object_UID>{37cdc055-7aac-4385-b46b-cc54d95e4b6d}</object_UID>
                                        <object_type>Network</object_type>
                                        <object_details>10.100.0.0/255.255.0.0</object_details>
                                        <management_id>58</management_id>
                                        <management_name>FMG/root</management_name>
                                        <status>NOT_CHANGED</status>
                                        <object_updated_status>EXISTING_EDITED</object_updated_status>
                                        <comment>new_comment</comment>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                                <zone>
                                    <is_global>true</is_global>
                                    <name>any</name>
                                </zone>
                            </group_change>
                            <group_change>
                                <name>78.45.12.0</name>
                                <object_UID>{cac64d34-a05e-4a05-b271-64642eb976ff}</object_UID>
                                <management_id>28</management_id>
                                <management_name>SRX-root-lsys</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>158</id>
                                        <name>78.45.12.1</name>
                                        <object_UID>{7912c335-6dbe-47de-b872-1322f9015b2f}</object_UID>
                                        <object_type>Host</object_type>
                                        <object_details>78.45.12.1/255.255.255.255</object_details>
                                        <management_id>28</management_id>
                                        <management_name>SRX-root-lsys</management_name>
                                        <status>NOT_CHANGED</status>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                                <address_book>
                                    <name>global</name>
                                </address_book>
                            </group_change>
                            <group_change>
                                <name>10.10.0.0/16</name>
                                <object_UID>{5dff0bd8-51e4-4a83-8138-d54dd18ca52b}</object_UID>
                                <management_id>24</management_id>
                                <management_name>NSX-Distributed Firewall</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>161</id>
                                        <name>10.10.0.0/16</name>
                                        <object_UID>{5d7b826c-f053-40fd-81bd-7a6f44cf15ef}</object_UID>
                                        <object_type>Network</object_type>
                                        <object_details>10.10.0.0/255.255.0.0</object_details>
                                        <management_id>24</management_id>
                                        <management_name>NSX-Distributed Firewall</management_name>
                                        <status>NOT_CHANGED</status>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                            </group_change>
                        </field>
                    </fields>
                </task>
            </tasks>
        </step>
    </steps>
</ticket>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY<ticket>
    <subject>test API</subject>
    <requester>a</requester>
    <requester_id>4</requester_id>
    <priority>Normal</priority>
    <domain_name/>
    <sla_status>NA</sla_status>
    <sla_outcome>NA</sla_outcome>
    <workflow>
        <id>8</id>
        <name>Modify group</name>
        <uses_topology>false</uses_topology>
    </workflow>
    <steps>
        <step>
            <id>11</id>
            <name>Open request</name>
            <redone>false</redone>
            <skipped>false</skipped>
            <tasks>
                <task>
                    <id>11</id>
                    <assignee_id>4</assignee_id>
                    <assignee>a</assignee>                    <status>DONE</status>
                    <fields>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_group_change\">
                            <id>137</id>
                            <name>ff</name>
                            <read_only>false</read_only>
                            <implementation_status>NOT_SUPPORTED</implementation_status>
                            <group_change>
                                <name>port1Group</name>
                                <object_UID>{d5b4459b-6b27-4012-9924-b244c250520f}</object_UID>
                                <management_id>64</management_id>
                                <management_name>10.100.111.8/ADOM_5_2</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"HOST\">
                                        <id>69</id>
                                        <name>obj_1</name>
                                        <object_UID>obj_1</object_UID>
                                        <object_type>Host</object_type>
                                        <object_details>6.6.6.6/255.255.255.255</object_details>
                                        <management_id>64</management_id>
                                        <status>ADDED</status>
                                        <comment/>
                                        <object_updated_status>NEW</object_updated_status>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                            </group_change>
                            <group_change>
                                <name>gfd</name>
                                <management_id>64</management_id>
                                <management_name>10.100.111.8/ADOM_5_2</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>70</id>
                                        <name>obj_1</name>
                                        <object_UID>obj_1</object_UID>
                                        <object_type>Host</object_type>
                                        <object_details>6.6.6.6/255.255.255.255</object_details>
                                        <management_id>64</management_id>
                                        <management_name>10.100.111.8/ADOM_5_2</management_name>
                                        <status>ADDED</status>
                                        <object_updated_status>EXISTING_NOT_EDITED</object_updated_status>
                                    </member>
                                </members>
                                <change_action>CREATE</change_action>
                                <zone>
                                    <is_global>true</is_global>
                                    <name>any</name>
                                </zone>
                            </group_change>
                        </field>
                    </fields>
                </task>
            </tasks>
        </step>
    </steps>
    <current_step>
        <id>12</id>
        <name>Copy of Open request</name>
    </current_step>
    <comments/>
</ticket>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY{
    \"ticket\": {
        \"application_details\": { \"id\": \"1\" },
        \"referenced_ticket\": { \"id\": \"3\" },
        \"subject\": \"topology mode_AR1-with topology_AR2-no topology\",
        \"priority\": \"Normal\",
        \"workflow\": { \"name\": \"ar\" }
    }
}


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY{
    \"ticket\": {
        \"subject\": \"RM_EXAMPLE\",
        \"requester\": \"m\",
        \"requester_id\": 4,
        \"priority\": \"Normal\",
        \"domain_name\": \"\",
        \"workflow\": {
            \"name\": \"RM\",
        },
        \"steps\": {
            \"step\": [
                {
                    \"tasks\": {
                        \"task\": {
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"rule_modification_field\",
                                    \"devices\": {
                                        \"device\": {
                                            \"revision_id\": 24,
                                            \"management_id\": 5,
                                            \"bindings\": {
                                                \"binding\": {
                                                    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                                                    \"binding\": {
                                                        \"@xsi.type\": \"policy__binding\",
                                                        \"policy_name\": \"FortiGate-VM64-111-10_3\"
                                                    },
                                                    \"rules\": {
                                                        \"rule\": {
                                                            \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                                            \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    \"rule_modifications\": {
                                        \"rule_modification\": {
                                            \"@xsi.type\": \"modify_rule_modification\",
                                            \"rule_key\": {
                                                \"device_id\": 5,
                                                \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                                                \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                                            },
                                            \"source_modifications\": {
                                                \"network_object_cell_modifications\": {
                                                    \"network_object_cell_modification\": [
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"network_object\": [
                                                                    {
                                                                        \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                                        \"name\": \"RANGE_1\",
                                                                        \"comment\": \"EXAMPLE_RANGE\",
                                                                        \"min_ip\": \"3.3.3.3\",
                                                                        \"max_ip\": \"5.5.5.5\"
                                                                    }
                                                                ]
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"network_object\": [
                                                                    {
                                                                        \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                                        \"name\": \"NET_1\",
                                                                        \"comment\": \"\",
                                                                        \"ip\": \"3.3.3.3\",
                                                                        \"netmask\": \"255.255.255.255\"
                                                                    }
                                                                ]
                                                            }
                                                        }
                                                    ]
                                                }
                                            },
                                            \"destination_modifications\": {
                                                \"id\": 11,
                                                \"network_object_cell_modifications\": {
                                                    \"network_object_cell_modification\": [
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"existing\",
                                                                    \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"REMOVE\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"existing\",
                                                                    \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"network_object\": [
                                                                    {
                                                                        \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                                        \"name\": \"Host123\",
                                                                        \"comment\": \"cccHost\",
                                                                        \"ip\": \"1.2.3.4\",
                                                                        \"netmask\": \"255.255.255.255\"
                                                                    }
                                                                ]
                                                            }
                                                        }
                                                    ]
                                                }
                                            },
                                            \"service_modifications\": {
                                                \"id\": 9,
                                                \"service_object_cell_modifications\": {
                                                    \"service_object_cell_modification\": [
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"service_object\": {
                                                                    \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                                                    \"name\": \"ICMP_1\",
                                                                    \"comment\": \"EXAMPLE_ICMP\",
                                                                    \"type\": {
                                                                        \"from\": 55,
                                                                        \"to\": 55
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"service_object\": {
                                                                    \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                                    \"name\": \"UDP_1\",
                                                                    \"comment\": \"EXAMPLE_UDP\",
                                                                    \"port\": {
                                                                        \"from\": 3,
                                                                        \"to\": 3
                                                                    },
                                                                    \"protocol\": \"UDP\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"service_object\": {
                                                                    \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                                    \"name\": \"TCP_1\",
                                                                    \"comment\": \"EXAMPLE_TCP\",
                                                                    \"port\": {
                                                                        \"from\": 1234,
                                                                        \"to\": 1234
                                                                    },
                                                                    \"protocol\": \"TCP\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"existing\",
                                                                    \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"REMOVE\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"existing\",
                                                                    \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                                                }
                                                            }
                                                        }
                                                    ]
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            ]
        },
    }
}


Response Messages:
400: Application ID is missing.
400: Create closed ticket is enabled only from SecureApp application.
400: The application was already deleted.
400: The requester must be the currently logged in user.
400: Workflow was not found.
400: Workflow is not active.
400: Workflow configuration is not valid.
400: Workflow is not set
400: You cannot enter a status for a new ticket.
400: Requester cannot open a ticket in domain.
400: Invalid ticket priority.
400: You cannot open a new ticket with an empty subject.
400: Expiration field is required.
400: Submit ticket enabled only with the first step
400: First step can be only with one task
400: The specified workflow does not contain an access request field in the first step.
400: There are no changed connections that are ready for creating a ticket.
400: You cannot use an access request field to create a ticket from SecureApp.
400: The ticket fields do not match the fields in the current step of the workflow.
400: You cannot change the value of a field because it is read-only.
400: Managed tasks are not initialized or done
400: Application Change field cannot be managed via this REST API
400: Invalid value for field: <FIELD_NAME> (Rule Modification workflow is not supported for this device)
403: You do not have permissions to edit this application.
403: Logged in user: NAME do not have permission to perform on behalf actions
403: You are not a participant in the first step of this workflow
403: UNAUTHORIZED
404: There is no application with the specified ID
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (Network object cell modification missing action)
400: Invalid value for field: <FIELD_NAME> (Network object cell modification element cannot be empty)
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: Invalid value for field: <FIELD_NAME> (a valid object comment can have up to <MAX> characters)
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: There are multiple objects with this name in the network)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value
400: Workflow does not support referenced ticket
400: The referenced ticket cannot be the ticket itself
406: Invalid format detected: <subject|name|binding_uid|rule_uid> - This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags
406: Invalid format detected: <subject|name> - <VALUE> is invalid. Text must include <1-255> characters
406: Invalid format detected: <rule_uid|binding_uid> - <VALUE> is invalid. Text must include <1-4096> characters
406: Invalid format detected: comment - <VALUE> is invalid. Text must include <0-4096> characters
406: Invalid format detected: <subject|name> - <VALUE> is invalid. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters + - , _ # @ . : = ! ^ ( )
406: Invalid format detected: <rule_uid|binding_uid|comment> - <VALUE> is invalid. Text includes invalid expressions such as HTML tags or command line operations
406: Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP"},"response":[]},{"name":"Change a field within a task of a ticket at the current step","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\t\"rule_modification_field\": {\n\t\t\"devices\": {\n\t\t\t\"device\": {\n\t\t\t\t\"management_id\": 5,\n\t\t\t\t\"bindings\": {\n\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t\"rule_modifications\": {\n\t\t\t\"rule_modification\": {\n\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t},\n\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"uid\": \"551556da-22dc-46f4-9253-a7ceee70394b\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/fields/{{fieldId}}","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldDTO
id: Ticket ID
taskId: Task ID
fieldId: Field ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields/7642
BODY<field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"approve_reject\">
         <id>7661</id>
         <name>approve access</name>
         <approved>true</approved>
         <reason>Request approved</reason>
    </field>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields/71
BODY{
    \"rule_modification_field\": {
        \"devices\": {
            \"device\": {
                \"management_id\": 5,
                \"bindings\": {
                    \"binding\": {
                        \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                        \"binding\": {
                            \"@xsi.type\": \"policy__binding\",
                            \"policy_name\": \"FortiGate-VM64-111-10_3\"
                        },
                        \"rules\": {
                            \"rule\": {
                                \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                            }
                        }
                    }
                }
            }
        },
        \"rule_modifications\": {
            \"rule_modification\": {
                \"@xsi.type\": \"modify_rule_modification\",
                \"rule_key\": {
                    \"device_id\": 5,
                    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                    \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                },
                \"source_modifications\": {
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                            \"name\": \"NET_1\",
                                            \"comment\": \"\",
                                            \"ip\": \"3.3.3.3\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                            \"name\": \"RANGE_1\",
                                            \"comment\": \"EXAMPLE_RANGE\",
                                            \"min_ip\": \"3.3.3.3\",
                                            \"max_ip\": \"5.5.5.5\"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                \"destination_modifications\": {
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"name\": \"Host123\",
                                            \"comment\": \"cccHost\",
                                            \"ip\": \"1.2.3.4\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"action\": \"REMOVE\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                    }
                                }
                            }
                        ]
                    }
                },
                \"service_modifications\": {
                    \"service_object_cell_modifications\": {
                        \"service_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                        \"name\": \"TCP_1\",
                                        \"comment\": \"EXAMPLE_TCP\",
                                        \"port\": {
                                            \"from\": 1234,
                                            \"to\": 1234
                                        },
                                        \"protocol\": \"TCP\"
                                    }
                                }
                            },
                            {
                                \"action\": \"REMOVE\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"uid\": \"551556da-22dc-46f4-9253-a7ceee70394b\",
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                        \"name\": \"UDP_1\",
                                        \"comment\": \"EXAMPLE_UDP\",
                                        \"port\": {
                                            \"from\": 3,
                                            \"to\": 3
                                        },
                                        \"protocol\": \"UDP\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                        \"name\": \"ICMP_1\",
                                        \"comment\": \"EXAMPLE_ICMP\",
                                        \"type\": {
                                            \"from\": 55,
                                            \"to\": 55
                                        }
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                    }
                                }
                            }
                        ]
                    }
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: There are multiple objects with this name in the network)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
403: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: Invalid value for field: <FIELD_NAME> (a valid object comment can have up to <MAX> characters)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value
406: Invalid format detected: <name|binding_uid|rule_uid> - This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags
406: Invalid format detected: name - <VALUE> is invalid. Text must include <1-255> characters
406: Invalid format detected: <rule_uid|binding_uid> - <VALUE> is invalid. Text must include <1-4096> characters
406: Invalid format detected: comment - <VALUE> is invalid. Text must include <0-4096> characters
406: Invalid format detected: name - <VALUE> is invalid. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters + - , _ # @ . : = ! ^ ( )
406: Invalid format detected: <rule_uid|binding_uid|comment> - <VALUE> is invalid. Text includes invalid expressions such as HTML tags or command line operations
406: Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP"},"response":[]},{"name":"Change a task of a ticket at the current step","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\t\"task\": {\n\t\t\"status\": \"ASSIGNED\",\n\t\t\"fields\": {\n\t\t\t\"field\": {\n\t\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\t\"id\": 743,\n\t\t\t\t\"devices\": {\n\t\t\t\t\t\"device\": {\n\t\t\t\t\t\t\"revision_id\": 24,\n\t\t\t\t\t\t\"management_id\": 5,\n\t\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"rule_modifications\": {\n\t\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: ticketTaskDTO
id: Ticket ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4
BODY<task>
    <status>DONE</status>
    <fields/>
</task>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4
BODY{
    \"task\": {
        \"status\": \"ASSIGNED\",
        \"fields\": {
            \"field\": {
                \"@xsi.type\": \"rule_modification_field\",
                \"id\": 743,
                \"devices\": {
                    \"device\": {
                        \"revision_id\": 24,
                        \"management_id\": 5,
                        \"bindings\": {
                            \"binding\": {
                                \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                                \"binding\": {
                                    \"@xsi.type\": \"policy__binding\",
                                    \"policy_name\": \"FortiGate-VM64-111-10_3\"
                                },
                                \"rules\": {
                                    \"rule\": {
                                        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                        \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                                    }
                                }
                            }
                        }
                    }
                },
                \"rule_modifications\": {
                    \"rule_modification\": {
                        \"@xsi.type\": \"modify_rule_modification\",
                        \"rule_key\": {
                            \"device_id\": 5,
                            \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                            \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                        },
                        \"source_modifications\": {
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                    \"name\": \"RANGE_1\",
                                                    \"comment\": \"EXAMPLE_RANGE\",
                                                    \"min_ip\": \"3.3.3.3\",
                                                    \"max_ip\": \"5.5.5.5\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                    \"name\": \"NET_1\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"3.3.3.3\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        },
                        \"destination_modifications\": {
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                    \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"name\": \"Host123\",
                                                    \"comment\": \"cccHost\",
                                                    \"ip\": \"1.2.3.4\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"REMOVE\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                            }
                                        }
                                    }
                                ]
                            }
                        },
                        \"service_modifications\": {
                            \"service_object_cell_modifications\": {
                                \"service_object_cell_modification\": [
                                    {
                                        \"action\": \"REMOVE\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                                \"name\": \"ICMP_1\",
                                                \"comment\": \"EXAMPLE_ICMP\",
                                                \"type\": {
                                                    \"from\": 55,
                                                    \"to\": 55
                                                }
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                \"name\": \"TCP_1\",
                                                \"comment\": \"EXAMPLE_TCP\",
                                                \"port\": {
                                                    \"from\": 1234,
                                                    \"to\": 1234
                                                },
                                                \"protocol\": \"TCP\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                \"name\": \"UDP_1\",
                                                \"comment\": \"EXAMPLE_UDP\",
                                                \"port\": {
                                                    \"from\": 3,
                                                    \"to\": 3
                                                },
                                                \"protocol\": \"UDP\"
                                            }
                                        }
                                    }
                                ]
                            }
                        }
                    }
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Task status does not exist.
400: Task status is not set to ASSIGNED or DONE.
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: There are multiple objects with this name in the network)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
403: You do not have permission to update this task. Contact your administrator for assistance.
403: Task can not be done because there are unlicensed devices for change automation
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: Invalid value for field: <FIELD_NAME> (a valid object comment can have up to <MAX> characters)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value
406: Invalid format detected: <name|binding_uid|rule_uid> - This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags
406: Invalid format detected: name - <VALUE> is invalid. Text must include <1-255> characters
406: Invalid format detected: <rule_uid|binding_uid> - <VALUE> is invalid. Text must include <1-4096> characters
406: Invalid format detected: comment - <VALUE> is invalid. Text must include <0-4096> characters
406: Invalid format detected: name - <VALUE> is invalid. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters + - , _ # @ . : = ! ^ ( )
406: Invalid format detected: <rule_uid|binding_uid|comment> - <VALUE> is invalid. Text includes invalid expressions such as HTML tags or command line operations
406: Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP"},"response":[]},{"name":"Change multiple field within a task of a ticket in the current step","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\"fields\": {\n\"field\": {\n\"@xsi.type\": \"rule_modification_field\",\n\"id\": 746,\n\"name\": \"rm\",\n\"devices\": {\n\t\"device\": {\n\t\"revision_id\": 24,\n\t\"management_id\": 5,\n\t\"bindings\": {\n\t\"binding\": {\n\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\"binding\": {\n\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t},\n\t\"rules\": {\n\t\t\"rule\": {\n\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t}\n\t}\n\t}\n\t}\n\t}\n},\n\"rule_modifications\": {\n\t\"rule_modification\": {\n\t\"@xsi.type\": \"modify_rule_modification\",\n\t\"rule_key\": {\n\t\"device_id\": 5,\n\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t},\n\t\"source_modifications\": {\n\t\"network_object_cell_modifications\": {\n\t\"network_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\"name\": \"NET_1\",\n\t\t\t\"comment\": \"\",\n\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t}\n\t\t]\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t}\n\t\t]\n\t\t}\n\t\t}\n\t]\n\t}\n\t},\n\t\"destination_modifications\": {\n\t\"network_object_cell_modifications\": {\n\t\"network_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"REMOVE\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\"name\": \"Host123\",\n\t\t\t\"comment\": \"cccHost\",\n\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t}\n\t\t]\n\t\t}\n\t\t}\n\t]\n\t}\n\t},\n\t\"service_modifications\": {\n\t\"service_object_cell_modifications\": {\n\t\"service_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"REMOVE\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\"name\": \"ICMP_1\",\n\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\"type\": {\n\t\t\t\"from\": 55,\n\t\t\t\"to\": 55\n\t\t}\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\"name\": \"TCP_1\",\n\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\"port\": {\n\t\t\t\"from\": 1234,\n\t\t\t\"to\": 1234\n\t\t},\n\t\t\"protocol\": \"TCP\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\"name\": \"UDP_1\",\n\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\"port\": {\n\t\t\t\"from\": 3,\n\t\t\t\"to\": 3\n\t\t},\n\t\t\"protocol\": \"UDP\"\n\t\t}\n\t\t}\n\t\t}\n\t]\n\t}\n\t}\n\t}\n}\n}\n}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/fields","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldListDTO
id: Ticket ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields
BODY<fields>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_server_decommission_request\">
         <id>7591</id>
         <name>sd</name>
         <server_decommission_request>
             <id>7596</id>
             <order>DR1</order>
             <servers>
                 <server type=\"IP\">
                     <id>7593</id>
                     <ip_address>2.2.2.2</ip_address>
                     <netmask>255.255.255.255</netmask>
                 </server>
             </servers>
             <targets>
                 <target type=\"ANY\">
                     <id>7595</id>
                 </target>
             </targets>
             <comment>change ip from 1.1.1.1 to 2.2.2.2</comment>
         </server_decommission_request>
     </field>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"date\">
         <id>7786</id>
         <name>date</name>
         <value>2015-12-15</value>
     </field>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"time\">
         <id>7787</id>
         <name>time</name>
         <value>12:00</value>
     </field>
</fields>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields
BODY{
\"fields\": {
\"field\": {
\"@xsi.type\": \"rule_modification_field\",
\"id\": 746,
\"name\": \"rm\",
\"devices\": {
    \"device\": {
    \"revision_id\": 24,
    \"management_id\": 5,
    \"bindings\": {
    \"binding\": {
    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
    \"binding\": {
        \"@xsi.type\": \"policy__binding\",
        \"policy_name\": \"FortiGate-VM64-111-10_3\"
    },
    \"rules\": {
        \"rule\": {
        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
        \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
        }
    }
    }
    }
    }
},
\"rule_modifications\": {
    \"rule_modification\": {
    \"@xsi.type\": \"modify_rule_modification\",
    \"rule_key\": {
    \"device_id\": 5,
    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
    \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
    },
    \"source_modifications\": {
    \"network_object_cell_modifications\": {
    \"network_object_cell_modification\": [
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
            \"name\": \"NET_1\",
            \"comment\": \"\",
            \"ip\": \"3.3.3.3\",
            \"netmask\": \"255.255.255.255\"
        }
        ]
        }
        },
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
            \"name\": \"RANGE_1\",
            \"comment\": \"EXAMPLE_RANGE\",
            \"min_ip\": \"3.3.3.3\",
            \"max_ip\": \"5.5.5.5\"
        }
        ]
        }
        }
    ]
    }
    },
    \"destination_modifications\": {
    \"network_object_cell_modifications\": {
    \"network_object_cell_modification\": [
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
        }
        }
        },
        {
        \"action\": \"REMOVE\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
            \"name\": \"Host123\",
            \"comment\": \"cccHost\",
            \"ip\": \"1.2.3.4\",
            \"netmask\": \"255.255.255.255\"
        }
        ]
        }
        }
    ]
    }
    },
    \"service_modifications\": {
    \"service_object_cell_modifications\": {
    \"service_object_cell_modification\": [
        {
        \"action\": \"REMOVE\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:icmp_service\",
        \"name\": \"ICMP_1\",
        \"comment\": \"EXAMPLE_ICMP\",
        \"type\": {
            \"from\": 55,
            \"to\": 55
        }
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:transport_service\",
        \"name\": \"TCP_1\",
        \"comment\": \"EXAMPLE_TCP\",
        \"port\": {
            \"from\": 1234,
            \"to\": 1234
        },
        \"protocol\": \"TCP\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:transport_service\",
        \"name\": \"UDP_1\",
        \"comment\": \"EXAMPLE_UDP\",
        \"port\": {
            \"from\": 3,
            \"to\": 3
        },
        \"protocol\": \"UDP\"
        }
        }
        }
    ]
    }
    }
    }
}
}
}
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object / device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (<device network object / device service object> is invalid: There are multiple objects with this name in the network)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
403: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: Invalid value for field: <FIELD_NAME> (a valid object comment can have up to <MAX> characters)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value
406: Invalid format detected: <name|binding_uid|rule_uid> - This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags
406: Invalid format detected: name - <VALUE> is invalid. Text must include <1-255> characters
406: Invalid format detected: <rule_uid|binding_uid> - <VALUE> is invalid. Text must include <1-4096> characters
406: Invalid format detected: comment - <VALUE> is invalid. Text must include <0-4096> characters
406: Invalid format detected: name - <VALUE> is invalid. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters + - , _ # @ . : = ! ^ ( )
406: Invalid format detected: <rule_uid|binding_uid|comment> - <VALUE> is invalid. Text includes invalid expressions such as HTML tags or command line operations
406: Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP"},"response":[]},{"name":"Get commands for device from designer results of a specific field id","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"deviceId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/designer/device/{{deviceId}}/commands","description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
deviceId: Device ID
fieldId: Field ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/designer/device/136/commands

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: Specified field, id: <ID> , name: <NAME>, cannot contain designer result
404: Designer results were not found in the access request.
404: Device with ID <ID> was not found in Designer result.
404: Device with ID <ID> does not support Commands feature."},"response":[]},{"name":"Returns the details of a specified ticket stages","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps

Response Messages:
403: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found"},"response":[]},{"name":"Returns the results of the Commit action","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"},{"value":null,"type":"text","key":"managementId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/designer/commit_report/{{managementId}}","description":"GENERAL USE
The report returns the Commit results for the device with the specified management ID and for the devices suggested in the Designer results. The report also includes results for devices that are in the related hierarchy of these devices.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID
managementId: Management ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/designer/commit_report/3
OUTPUT{
    \"commit_report\": {
        \"ticketId\": 27,
        \"statTime\": \"24-Oct-2018 08:55 AM\",
        \"endTime\": \"24-Oct-2018 08:56 AM\",
        \"duration\": \"00:00:30\",
        \"vendorName\": \"PALO ALTO NETWORKS\",
        \"managmentName\": \"pano211\",
        \"devices\": {
            \"device\": [
                {
                    \"name\": \"DG1.1\",
                    \"status\": \"success_with_warnings\",
                    \"warnings\": {
                        \"warning\": \"Commit not performed: This device had no policies to install on its managed firewalls\"
                    },
                    \"policies\": \"\"
                },
                {
                    \"name\": \"DG1\",
                    \"status\": \"success_with_warnings\",
                    \"warnings\": {
                        \"warning\": \"Commit not performed: This device had no policies to install on its managed firewalls\"
                    },
                    \"policies\": \"\"
                }
            ]
        }
    }
}


Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: Specified field, id: <ID> , name: <NAME>, cannot contain designer result
404: Designer results were not found in the request."},"response":[]},{"name":"Returns the details of a specified field","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
taskId: The ID number of the task as shown in SecureChange
fieldId: The ID number of the field as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/229

Response Messages:
403: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.
404: Task with ID was not found in Stage ID in ticket ID .
404: Field ID was not found in Task ID in Stage ID in ticket ID ."},"response":[]},{"name":"Change a field within a task of a ticket","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\t\"rule_modification_field\": {\n\t\t\"devices\": {\n\t\t\t\"device\": {\n\t\t\t\t\"management_id\": 5,\n\t\t\t\t\"bindings\": {\n\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t\"rule_modifications\": {\n\t\t\t\"rule_modification\": {\n\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t},\n\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"uid\": \"551556da-22dc-46f4-9253-a7ceee70394b\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldDTO
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/2/tasks/4/fields/7742
BODY<field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multiple_selection\">
     <id>7742</id>
     <name>filter type</name>
     <selected_options>
         <selected_option>
             <value>FTP</value>
         </selected_option>
     </selected_options>
</field>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/fields/71
BODY{
    \"rule_modification_field\": {
        \"devices\": {
            \"device\": {
                \"management_id\": 5,
                \"bindings\": {
                    \"binding\": {
                        \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                        \"binding\": {
                            \"@xsi.type\": \"policy__binding\",
                            \"policy_name\": \"FortiGate-VM64-111-10_3\"
                        },
                        \"rules\": {
                            \"rule\": {
                                \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                            }
                        }
                    }
                }
            }
        },
        \"rule_modifications\": {
            \"rule_modification\": {
                \"@xsi.type\": \"modify_rule_modification\",
                \"rule_key\": {
                    \"device_id\": 5,
                    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                    \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                },
                \"source_modifications\": {
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                            \"name\": \"NET_1\",
                                            \"comment\": \"\",
                                            \"ip\": \"3.3.3.3\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                            \"name\": \"RANGE_1\",
                                            \"comment\": \"EXAMPLE_RANGE\",
                                            \"min_ip\": \"3.3.3.3\",
                                            \"max_ip\": \"5.5.5.5\"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                \"destination_modifications\": {
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"name\": \"Host123\",
                                            \"comment\": \"cccHost\",
                                            \"ip\": \"1.2.3.4\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"action\": \"REMOVE\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                    }
                                }
                            }
                        ]
                    }
                },
                \"service_modifications\": {
                    \"service_object_cell_modifications\": {
                        \"service_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                        \"name\": \"TCP_1\",
                                        \"comment\": \"EXAMPLE_TCP\",
                                        \"port\": {
                                            \"from\": 1234,
                                            \"to\": 1234
                                        },
                                        \"protocol\": \"TCP\"
                                    }
                                }
                            },
                            {
                                \"action\": \"REMOVE\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"uid\": \"551556da-22dc-46f4-9253-a7ceee70394b\",
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                        \"name\": \"UDP_1\",
                                        \"comment\": \"EXAMPLE_UDP\",
                                        \"port\": {
                                            \"from\": 3,
                                            \"to\": 3
                                        },
                                        \"protocol\": \"UDP\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                        \"name\": \"ICMP_1\",
                                        \"comment\": \"EXAMPLE_ICMP\",
                                        \"type\": {
                                            \"from\": 55,
                                            \"to\": 55
                                        }
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                    }
                                }
                            }
                        ]
                    }
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket step does not exist, or is not the current step
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: Deleting rule recertification info is not allowed
400: Application Change field cannot be managed via this REST API
400: Rule associated with successfully updated recertification info cannot be removed
400: Rule was already updated
400: Rule does not exist
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: There are multiple objects with this name in the network)
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
403: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: Invalid value for field: <FIELD_NAME> (a valid object comment can have up to <MAX> characters)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value
406: Invalid format detected: <name|binding_uid|rule_uid> - This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags
406: Invalid format detected: name - <VALUE> is invalid. Text must include <1-255> characters
406: Invalid format detected: <rule_uid|binding_uid> - <VALUE> is invalid. Text must include <1-4096> characters
406: Invalid format detected: comment - <VALUE> is invalid. Text must include <0-4096> characters
406: Invalid format detected: name - <VALUE> is invalid. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters + - , _ # @ . : = ! ^ ( )
406: Invalid format detected: <rule_uid|binding_uid|comment> - <VALUE> is invalid. Text includes invalid expressions such as HTML tags or command line operations
406: Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP"},"response":[]},{"name":"Get server clone policy verifier results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/clone_server_policy/verifier","description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/clone_server_policy/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.
404: Verifier results were not found in the server clone policy request."},"response":[]},{"name":"Get designer results according to field id","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/designer","description":"Use this API to retrieve designer results generated in R17-2 and later.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/designer

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: Specified field, id: <ID> , name: <NAME>, cannot contain designer result
404: Designer results were not found in the request."},"response":[]},{"name":"Get security zones according to field id","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/security_zones","description":"Use this API to retrieve security zones for multi access result field

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/security_zones

Response Messages:
404: There is no ticket with ID <ID>.
401: Cannot update ticket because it is either closed, rejected or waiting for requester confirmation
400: Task ID <ID> cannot be found in the current step with ID <ID>.
400: You can only update the current step of the ticket. Step ID <ID> does not match the current step ID <ID>.
400: The task with ID <ID> does not contain a field with ID <ID>.
400: The task with ID <ID> does not contain a field of type <ID>.
400: Security zones tool is not enabled for the requested field.
403: You do not have permission to view this task. Contact your administrator for assistance."},"response":[]},{"name":"Get access request verifier results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_access_request/{{fieldId}}/verifier","description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/multi_access_request/2022/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.
404: Verifier results were not found in the access request."},"response":[]},{"name":"Returns the details of a specified ticket","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
expand_links: See expanded view of the objects [optional]
showStepsDetails: Include steps' details in the response [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1
OUTPUT {
    \"ticket\": {
        \"id\": 1,
        \"subject\": \"AR-Ticket\",
        \"requester\": \"a\",
        \"requester_id\": 4,
        \"priority\": \"Normal\",
        \"status\": \"In Progress\",
        \"domain_name\": \"\",
        \"sla_status\": \"NA\",
        \"sla_outcome\": \"NA\",
        \"workflow\": {
            \"id\": 11,
            \"name\": \"AR & MG\",
            \"uses_topology\": true
        },
        \"steps\": {
            \"step\": [
                {
                    \"id\": 209,
                    \"name\": \"Open request\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 209,
                            \"assignee_id\": 4,
                            \"assignee\": \"a\",
                            \"status\": \"DONE\",
                            \"fields\": {
                                \"field\": [
                                    {
                                        \"@xsi.type\": \"multi_access_request\",
                                        \"id\": 1695,
                                        \"name\": \"AR\",
                                        \"read_only\": false,
                                        \"access_request\": {
                                            \"id\": 1706,
                                            \"order\": \"AR1\",
                                            \"risk_analysis_result\": {
                                                \"status\": \"not run\"
                                            },
                                            \"verifier_result\": {
                                                \"status\": \"not run\"
                                            },
                                            \"use_topology\": true,
                                            \"targets\": {
                                                \"target\": {
                                                    \"@type\": \"ANY\",
                                                    \"id\": 1705
                                                }
                                            },
                                            \"users\": {
                                                \"user\": [
                                                    \"Any\"
                                                ]
                                            },
                                            \"sources\": {
                                                \"source\": [
                                                    {
                                                        \"@type\": \"INTERNET\",
                                                        \"id\": 1701
                                                    },
                                                    {
                                                        \"@type\": \"DNS\",
                                                        \"id\": 1702,
                                                        \"host_name\": \"www.google.com\",
                                                        \"dns_ip_addresses\": {
                                                            \"ip_address\": \"216.58.214.100\"
                                                        }
                                                    },
                                                    {
                                                        \"@type\": \"IP\",
                                                        \"id\": 1703,
                                                        \"ip_address\": \"1.1.1.1\",
                                                        \"netmask\": \"255.255.255.255\",
                                                        \"nat_ip_address\": \"4.4.4.4\",
                                                        \"nat_netmask\": \"255.255.255.255\"
                                                    }
                                                ]
                                            },
                                            \"destinations\": {
                                                \"destination\": [
                                                    {
                                                        \"@type\": \"ANY\",
                                                        \"id\": 1697
                                                    }
                                                ]
                                            },
                                            \"services\": {
                                                \"service\": [
                                                    {
                                                        \"@type\": \"ANY\",
                                                        \"id\": 1699
                                                    }
                                                ]
                                            },
                                            \"action\": \"Accept\",
                                            \"labels\": \"\"
                                        }
                                    },
                                    {
                                        \"@xsi.type\": \"multi_group_change\",
                                        \"id\": 1707,
                                        \"name\": \"MG\",
                                        \"read_only\": false,
                                        \"implementation_status\": \"NOT_SUPPORTED\"
                                    }
                                ]
                            }
                        }
                    }
                },
                {
                    \"id\": 210,
                    \"name\": \"STEP2 - auto AR with designer /update /commit\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 210,
                            \"assignee_id\": 4,
                            \"assignee\": \"a\",
                            \"status\": \"ASSIGNED\",
                            \"unlicensed_devices_for_automation\": {
                                \"unlicensed_device_for_automation\": [
                                    {
                                        \"id\": \"2\",
                                        \"name\": \"asa\"
                                    }
                                ]
                            }
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"multi_access_request\",
                                    \"id\": 1709,
                                    \"name\": \"AR\",
                                    \"read_only\": false,
                                    \"access_request\": {
                                        \"id\": 1720,
                                        \"order\": \"AR1\",
                                        \"risk_analysis_result\": {
                                            \"status\": \"not run\"
                                        },
                                        \"verifier_result\": {
                                            \"status\": \"not run\"
                                        },
                                        \"use_topology\": true,
                                        \"targets\": {
                                            \"target\": {
                                                \"@type\": \"ANY\",
                                                \"id\": 1719
                                            }
                                        },
                                        \"users\": {
                                            \"user\": [
                                                \"Any\"
                                            ]
                                        },
                                        \"sources\": {
                                            \"source\": [
                                                {
                                                    \"@type\": \"INTERNET\",
                                                    \"id\": 1721
                                                },
                                                {
                                                    \"@type\": \"DNS\",
                                                    \"id\": 1722,
                                                    \"host_name\": \"www.google.com\",
                                                    \"dns_ip_addresses\": {
                                                        \"ip_address\": \"216.58.214.100\"
                                                    }
                                                },
                                                {
                                                    \"@type\": \"IP\",
                                                    \"id\": 1723,
                                                    \"ip_address\": \"1.1.1.1\",
                                                    \"netmask\": \"255.255.255.255\",
                                                    \"nat_ip_address\": \"4.4.4.4\",
                                                    \"nat_netmask\": \"255.255.255.255\"
                                                },
                                                {
                                                    \"@type\": \"RANGE\",
                                                    \"id\": 1724,
                                                    \"range_first_ip\": \"1.1.11.1\",
                                                    \"range_last_ip\": \"1.1.11.10\"
                                                }
                                            ]
                                        },
                                        \"destinations\": {
                                            \"destination\": [
                                                {
                                                    \"@type\": \"ANY\",
                                                    \"id\": 1711
                                                }
                                            ]
                                        },
                                        \"services\": {
                                            \"service\": [
                                                {
                                                    \"@type\": \"ANY\",
                                                    \"id\": 1713
                                                }
                                            ]
                                        },
                                        \"action\": \"Accept\",
                                        \"labels\": \"\"
                                    }
                                }
                            }
                        }
                    }
                }
            ]
        },
        \"current_step\": {
            \"id\": 210,
            \"name\": \"STEP2 - auto AR with designer /update /commit\"
        },
        \"comments\": \"\"
    }
}


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2
OUTPUT {
    \"ticket\": {
        \"id\": 2,
        \"subject\": \"Clone Server Policy Ticket\",
        \"requester\": \"a\",
        \"requester_id\": 12,
        \"priority\": \"Normal\",
        \"status\": \"In Progress\",
        \"referenced_ticket\": {
            \"id\": 1,
            \"name\": \"Ticket Subject Sample\",
            \"link\": {
                \"@href\": \"https://host/securechangeworkflow/api/securechange/tickets/1\"
            }
        },
        \"domain_name\": \"\",
        \"sla_status\": \"NA\",
        \"sla_outcome\": \"NA\",
        \"workflow\": {
            \"id\": 109,
            \"name\": \"sc_12705\",
            \"uses_topology\": false
        },
        \"steps\": {
            \"step\": [
                {
                    \"id\": 78,
                    \"name\": \"Open request\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 78,
                            \"assignee_id\": 12,
                            \"assignee\": \"a\",
                            \"status\": \"DONE\",
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"clone_server_policy_request\",
                                    \"id\": 872,
                                    \"name\": \"Clone Server Policy Field\",
                                    \"from_server\": {
                                        \"@type\": \"IP\",
                                        \"id\": 869,
                                        \"ip_address\": \"1.2.2.2\",
                                        \"cidr\": 32
                                    },
                                    \"to_servers\": {
                                        \"server\": {
                                            \"@type\": \"IP\",
                                            \"id\": 871,
                                            \"ip_address\": \"10.100.23.32\",
                                            \"netmask\": \"255.255.255.255\",
                                            \"cidr\": 32
                                        }
                                    },
                                    \"comment\": \"target servers to clone server policy to\"
                                }
                            }
                        }
                    }
                },
                {
                    \"id\": 79,
                    \"name\": \"Business Approval\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 79,
                            \"assignee_id\": 12,
                            \"assignee\": \"a\",
                            \"status\": \"ASSIGNED\",
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"clone_server_policy_request\",
                                    \"id\": 876,
                                    \"name\": \"Clone Server Policy Field\",
                                    \"from_server\": {
                                        \"@type\": \"IP\",
                                        \"id\": 873,
                                        \"ip_address\": \"1.2.2.2\",
                                        \"cidr\": 32
                                    },
                                    \"to_servers\": {
                                        \"server\": {
                                            \"@type\": \"IP\",
                                            \"id\": 875,
                                            \"ip_address\": \"10.100.23.32\",
                                            \"netmask\": \"255.255.255.255\",
                                            \"cidr\": 32
                                        }
                                    },
                                    \"comment\": \"target servers to clone server policy to\"
                                }
                            }
                        }
                    }
                }
            ]
        },
        \"current_step\": {
            \"id\": 79,
            \"name\": \"Business Approval\"
        },
        \"comments\": \"\"
    }
}


Response Messages:
403: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: No entity found for query"},"response":[]},{"name":"Returns a list of tickets by search parameters","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/free_text_search","description":"Parameters:
parameter: Free text search parameter (Search syntax details) [optional]
start: Offset the count starting point [optional]
count: Tickets list max length (max value is 1000) [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/free_text_search/?parameter=taskstatus:ASSIGNED AND priority:High

Response Messages:
400: Can not fetch more than 1000 tickets in 1 time
403: Access is denied.
404: Illegal ticket status entered. Permitted values are: IN_PROGRESS, REJECTED, CLOSED, CANCELLED, RESOLVED
404: Illegal ticket SLA status entered. Permitted values are: NA, OK, WARNING, ALERT, ESCALATION
404: Illegal ticket priority entered. Permitted values are: LOW, NORMAL, HIGH, CRITICAL
400: Illegal count value entered. Max value is 1000
404: Illegal ticket expiration date entered. Permitted date format is: ddMMyyyy (ex. 20.11.2001)
404: No entity found for query"},"response":[]},{"name":"Change a task of a ticket","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\t\"task\": {\n\t\t\"status\": \"ASSIGNED\",\n\t\t\"fields\": {\n\t\t\t\"field\": {\n\t\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\t\"id\": 743,\n\t\t\t\t\"devices\": {\n\t\t\t\t\t\"device\": {\n\t\t\t\t\t\t\"revision_id\": 24,\n\t\t\t\t\t\t\"management_id\": 5,\n\t\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"rule_modifications\": {\n\t\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ‘add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: ticketTaskDTO
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/2/tasks/4
BODY<task>
     <status>ASSIGNED</status>
     <fields>
         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_group_change\">
             <id>7599</id>
             <name>mf</name>
             <read_only>false</read_only>
             <implementation_status>NOT_STARTED</implementation_status>
             <group_change>
                        <name>ggg</name>
                        <st_uid>{A12AE330-0DBD-11E5-B841-7F0000010E0E}</st_uid>
                        <management_id>42</management_id>
                        <management_name>cp239</management_name>
                        <members>
                             <member type=\"Object\">
                                 <id>8</id>
                                 <name>yaakovs_host</name>
                                 <st_uid>{BDAA378C-C90B-4D12-B598-1AFED2D1DA14}</st_uid>
                                 <object_type>Host</object_type>
                                 <object_details>1.1.1.1/255.255.255.255</object_details>
                         <management_id>42</management_id>
                         <management_name>cp239</management_name>
                                 <status>NOT_CHANGED</status>
                             </member>
                             <member type=\"Object\">
                                 <id>9</id>
                                    <name>Avi_10.100.120.254</name>
                                    <st_uid>{8F195CDC-F426-47B6-9E8A-1FF14C17E54F}</st_uid>
                                     <object_type>Host</object_type>
                                     <object_details>10.100.120.254/255.255.255.255</object_details>
                                     <management_id>42</management_id>
                                     <management_name>cp239</management_name>
                                     <status>NOT_CHANGED</status>
                                 </member>
                                 <member type=\"HOST\">
                                     <id>10</id>
                                     <name>h22</name>
                                     <object_type>Host</object_type>
                                     <object_details>2.2.2.2/255.255.255.255</object_details>
                                     <status>ADDED</status>
                                     <comment/>
                                 </member>
                                 <member type=\"HOST\">
                                     <id>10</id>
                                     <name>h22</name>
                                     <object_type>Host</object_type>
                                     <object_details>3.3.3.3/255.255.255.255</object_details>
                                     <status>ADDED</status>
                                     <comment/>
                                 </member>
                 </members>
                 <change_implementation_status>NOT_RUN</change_implementation_status>
                    </group_change>
            </field>
     </fields>
</task>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4
BODY{
    \"task\": {
        \"status\": \"ASSIGNED\",
        \"fields\": {
            \"field\": {
                \"@xsi.type\": \"rule_modification_field\",
                \"id\": 743,
                \"devices\": {
                    \"device\": {
                        \"revision_id\": 24,
                        \"management_id\": 5,
                        \"bindings\": {
                            \"binding\": {
                                \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                                \"binding\": {
                                    \"@xsi.type\": \"policy__binding\",
                                    \"policy_name\": \"FortiGate-VM64-111-10_3\"
                                },
                                \"rules\": {
                                    \"rule\": {
                                        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                        \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                                    }
                                }
                            }
                        }
                    }
                },
                \"rule_modifications\": {
                    \"rule_modification\": {
                        \"@xsi.type\": \"modify_rule_modification\",
                        \"rule_key\": {
                            \"device_id\": 5,
                            \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                            \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                        },
                        \"source_modifications\": {
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                    \"name\": \"RANGE_1\",
                                                    \"comment\": \"EXAMPLE_RANGE\",
                                                    \"min_ip\": \"3.3.3.3\",
                                                    \"max_ip\": \"5.5.5.5\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                    \"name\": \"NET_1\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"3.3.3.3\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        },
                        \"destination_modifications\": {
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                    \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"name\": \"Host123\",
                                                    \"comment\": \"cccHost\",
                                                    \"ip\": \"1.2.3.4\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"REMOVE\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                            }
                                        }
                                    }
                                ]
                            }
                        },
                        \"service_modifications\": {
                            \"service_object_cell_modifications\": {
                                \"service_object_cell_modification\": [
                                    {
                                        \"action\": \"REMOVE\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                                \"name\": \"ICMP_1\",
                                                \"comment\": \"EXAMPLE_ICMP\",
                                                \"type\": {
                                                    \"from\": 55,
                                                    \"to\": 55
                                                }
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                \"name\": \"TCP_1\",
                                                \"comment\": \"EXAMPLE_TCP\",
                                                \"port\": {
                                                    \"from\": 1234,
                                                    \"to\": 1234
                                                },
                                                \"protocol\": \"TCP\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                \"name\": \"UDP_1\",
                                                \"comment\": \"EXAMPLE_UDP\",
                                                \"port\": {
                                                    \"from\": 3,
                                                    \"to\": 3
                                                },
                                                \"protocol\": \"UDP\"
                                            }
                                        }
                                    }
                                ]
                            }
                        }
                    }
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket step does not exist, or is not the current step
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Task status does not exist.
400: Task status is not set to ASSIGNED or DONE.
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: There are multiple objects with this name in the network)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
403: You do not have permission to update this task. Contact your administrator for assistance.
403: Task can not be done because there are unlicensed devices for change automation
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: Invalid value for field: <FIELD_NAME> (a valid object comment can have up to <MAX> characters)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value
406: Invalid format detected: <name|binding_uid|rule_uid> - This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags
406: Invalid format detected: name - <VALUE> is invalid. Text must include <1-255> characters
406: Invalid format detected: <rule_uid|binding_uid> - <VALUE> is invalid. Text must include <1-4096> characters
406: Invalid format detected: comment - <VALUE> is invalid. Text must include <0-4096> characters
406: Invalid format detected: name - <VALUE> is invalid. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters + - , _ # @ . : = ! ^ ( )
406: Invalid format detected: <rule_uid|binding_uid|comment> - <VALUE> is invalid. Text includes invalid expressions such as HTML tags or command line operations
406: Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP"},"response":[]},{"name":"Returns the details of a specified task","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
taskId: The ID number of the task as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2?expand_links=true

Response Messages:
403: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.
404: Task with ID was not found in Stage ID in ticket ID ."},"response":[]}]}]} \ No newline at end of file diff --git a/Postman Format v2/R20-2 postman collection/securetrack_R20-2-HF2-v2.json b/Postman Format v2/R20-2 postman collection/securetrack_R20-2-HF2-v2.json new file mode 100644 index 0000000..493eaac --- /dev/null +++ b/Postman Format v2/R20-2 postman collection/securetrack_R20-2-HF2-v2.json @@ -0,0 +1 @@ +{"info":{"_postman_id":"1","name":"Tufin Tufin SecureTrack R20-2-HF2","description":"Tufin Orchestration Suite - Tufin SecureTrack APIs.
For detailed information about the APIs please see the documentation at:
https://your-securetrack-server/securetrack/apidoc","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json"},"item":[{"name":"Additional Policy Fields","item":[{"name":"Get all URL Categories by revision.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/url_categories","description":"Fetches list of URL Categories defined in a revision given by ID.
This API is supported for Panorama in advanced mode and Panorama Device Groups.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/762/url_categories
"},"response":[]},{"name":"Get additional parameters identities by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/additional_parameters","description":"Some firewall vendors use special fields in their security policy.
For example: Palo Alto uses Tags, Security Profiles and Log Profiles and Fortinet uses NAT Pools and other NAT configurations.
SecureTrack refers to these fields as “Additional Parameters”.
The additional parameters API retrieves the possible values of these fields.
This API is currently supported for Palo Alto Networks firewalls and Fortinet devices managed by Fortimanager.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
type: Additional parameter type [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/162/additional_parameters?type=security_profile_group

Response Messages:
200: Successful
400: Invalid request"},"response":[]},{"name":"Get specific additional parameter identity","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/additional_parameters/{{ids}}","description":"Some firewall vendors use special fields in their security policy.
For example: Palo Alto uses Tags, Security Profiles and Log Profiles and Fortinet uses NAT Pools and other NAT configurations.
SecureTrack refers to these fields as “Additional Parameters”.
The additional parameters API retrieves the possible values of these fields.
This API is currently supported for Palo Alto Networks firewalls and Fortinet devices managed by Fortimanager.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Additional parameter IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/revisions/162/additional_parameters/242767,242768,242760
"},"response":[]},{"name":"Get a URL Category.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/url_categories/{{ids}}","description":"Fetches one or more URL Categories.
This API is supported for Panorama in advanced mode and Panorama Device Groups.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Url Category IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/revisions/762/url_categories/242767,242768,242760
"},"response":[]}]},{"name":"Application IDs","item":[{"name":"Get applications identities by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/applications","description":"Fetches list of applications defined in a revision given by ID.
This API is currently supported for Palo Alto Networks firewalls.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.
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.


Parameters:
context: Global MSSP context [optional]
id: Revision id
start: Starting page for query allowable value is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/762/applications?get_total=true
OUTPUT {
    \"applications\": {
        \"count\": 1,
        \"total\": 100,
        \"application\": [{
            \"@xsi.type\": \"singleApplicationDTO\",
            \"id\": 2095027,
            \"name\": \"any\",
            \"display_name\": \"any\",
            \"class_name\": \"application_object\",
            \"comment\": \"\",
            \"uid\": \"{61B7771C-8B0B-90D6-ED55-B6698691BEED}\",
            \"overrides\": false,
            \"service\": {
                \"id\": 5048925,
                \"uid\": \"{4BC8F8B5-7671-A61B-5DD2-8CA235955162}\",
                \"display_name\": \"any\",
                \"name\": \"any\"
            }
        }]
    }
}

"},"response":[]},{"name":"Get specific application identity","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/applications/{{ids}}","description":"Fetches one or more applications defined by a revision ID and Application Id or comma separated applications ids list.
This API is currently supported for Palo Alto Networks firewalls.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.


Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Application IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/revisions/762/applications/242767,242768,242760
"},"response":[]},{"name":"Get application identities by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/applications","description":"Fetches list of applications defined on device given by ID.
This API is currently supported for Palo Alto Networks firewalls.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.
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.


Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable values are numeric [optional]
count: Number of pages for query allowable values are numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/applications?get_total=true
OUTPUT {
    \"applications\": {
        \"count\": 50,
        \"total\": 100,
        \"application\": [{
            \"@xsi.type\": \"singleApplicationDTO\",
            \"id\": 2095027,
            \"name\": \"any\",
            \"display_name\": \"any\",
            \"class_name\": \"application_object\",
            \"comment\": \"\",
            \"uid\": \"{61B7771C-8B0B-90D6-ED55-B6698691BEED}\",
            \"overrides\": false,
            \"service\": {
                \"id\": 5048925,
                \"uid\": \"{4BC8F8B5-7671-A61B-5DD2-8CA235955162}\",
                \"display_name\": \"any\",
                \"name\": \"any\"
            }
        }]
    }
}

"},"response":[]},{"name":"Get specific application identity","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/applications/{{ids}}","description":"Fetches one or more applications defined by a device ID and Application Id or comma separated applications ids list.
This API is currently supported for Palo Alto Networks firewalls.
Note: This API retrieves the information from the latest revision.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.


Parameters:
context: Global MSSP context [optional]
id: Device ID
ids: Application IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/devices/1/applications/701
"},"response":[]}]},{"name":"Change Authorization","item":[{"name":"Compare revisions on two different devices in terms of traffic.","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"policy_traffic_comparison_request\": {\n\t\t\"oldVersionId\": \"234\",\n\t\t\"newVersionId\": \"179\",\n\t\t\"oldId2newIdMap\": [\n\t\t\t{\n\t\t\t\t\"oldId\": \"{037DEA62-A8D2-46F5-8DC9-DA404A60B96F}\",\n\t\t\t\t\"newId\" : \"{00-FACED0-00}\"\n\t\t\t}\n\t\t],\n\t\t\"withTraffic\": true\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/change_authorization/policyTrafficComparison","description":"This API compares two arbitrary revisions from any devices. The comparison will be done in terms of allowed/denied traffic.
The API returns authorized if and only if there are no differences between the traffic allowed/denied by the rules in the two revisions.
The API returns unauthorized if there is at least one difference in terms of allowed/denied traffic between the two revisions.
Note 1: To map policies from one revision to the other use oldId2newIdMap and provide the UIDs of the policies to be compared.
Note 2: Parameter in the request body specifies if the result will return traffic difference details for all incompatible rules
Note 3: The format of the result is the same as the one returned by /change_authorization
Note 4: The API accepts in request body only one pair of oldId - newId map
Note 5: The request is valid only if the mapping ids are found in the active policies

Parameters:
body: Request parameter containing the versions of the revisions to be compared and the policy mapping between the revisions.

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_authorization/policyTrafficComparison
BODY{
    \"policy_traffic_comparison_request\": {
        \"oldVersionId\": \"234\",
        \"newVersionId\": \"179\",
        \"oldId2newIdMap\": [
            {
                \"oldId\": \"{037DEA62-A8D2-46F5-8DC9-DA404A60B96F}\",
                \"newId\" : \"{00-FACED0-00}\"
            }
        ],
        \"withTraffic\": true
    }
}


Response Messages:
200: Policies diff was successfully calculated
400: Could not find the requested revisions for comparison"},"response":[]},{"name":"Determine if changes between two revisions are authorized","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"new_version"},{"value":null,"type":"text","key":"old_version"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/change_authorization/","description":"This API checks for unauthorized changes between any two versions of a firewall policy.
The API returns authorized if and only if all traffic changes between the two versions were authorized by SecureChange tickets.
The API returns unauthorized if there is at least one change that cannot be matched to a SecureChange ticket.

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).
The API returns the authorization status, the relevant tickets in SecureChange and the rules that implement unauthorized access changes.

Note 1: To use this API you must enable “Authorize Revisions with Tickets” in SecureTrack/Configuration/Ticketing.
Note 2: Use the ID returned by the /revisions API for new_version and old_version.
Note 3: The default value for traffic_details and ignore_tickets is false.
Note 4: Traffic that is handled by an implicit rule will not have a rule ID.

Parameters:
new_version: New version ID
old_version: Old version ID
traffic_details: Return unauthorized traffic change details for all modified rules [optional]
ignore_tickets: Ignore SecureChange tickets and consider all traffic changes unauthorized [optional]

Usage Example
https://192.168.1.1/securetrack/api/change_authorization?old_version=1&new_version=2

Usage Example
https://192.168.1.1/securetrack/api/change_authorization?old_version=1&new_version=2&traffic_details=true&ignore_tickets=true

Response Messages:
200: Change authorization has been successfully calculated
400: Input parameters are not valid
400: Could not find the requested revisions for comparison"},"response":[]}]},{"name":"Change Windows","item":[{"name":"Get scheduling and device details for a specific change window","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"uid"},{"value":null,"type":"text","key":"task_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/change_windows/{{uid}}/tasks/{{task_id}}","description":"Retrieves scheduling and device details for a specific change window.

Parameters:
context: Global MSSP context [optional]
uid: Change window uuid
task_id: Task Id

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_windows/fc7b167c-29ea-49a1-9ee3-efb6d1351343/tasks/1
OUTPUT {
    \"commit_task\": {
        \"id\": 1,
        \"start_date\": \"04-Nov-2018 01:30:00PM +0200\",
        \"end_date\": \"04-Nov-2018 01:32:01PM +0200\",
        \"errors\": \"\",
        \"device_commits\": {
            \"device_commit\": [
                {
                    \"id\": 1,
                    \"result\": {
                        \"errors\": {
                            \"error\": \"got_error_from_dcs\"
                        },
                        \"device\": {
                            \"id\": 17,
                            \"status\": \"FAILURE\",
                            \"revision_id\": 1,
                            \"errors\": {
                                \"error\": \"Login error\"
                            }
                        }
                    }
                },
                {
                    \"id\": 2,
                    \"result\": {
                        \"errors\": \"\",
                        \"device\": {
                            \"id\": 19,
                            \"status\": \"SUCCESS_WITH_WARNINGS\",
                            \"revision_id\": 1,
                            \"warnings\": {
                                \"warning\": \"Commit not performed: This device had no policies to install on its managed firewalls\"
                            }
                        }
                    }
                }
            ]
        }
    }
}


Response Messages:
200: OK
400: For correct pagination provide a value for the start and count parameters
400: Start parameter must be a non-negative value
400: Count parameter must be a positive value
403: Not permitted to access this context
404: Change window with uuid was not found
404: Change window with uuid was not found in domain
404: Fail to find task for change window "},"response":[]},{"name":"Get a list of completed policy changes for a specific change window","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"uid"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/change_windows/{{uid}}/tasks","description":"Retrieves a list of completed policy changes for a specific change window.
For valid pagination, both start and count should be provided. Otherwise, pagination is turned off.
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.


Parameters:
context: Global MSSP context [optional]
uid: Change window uuid
start: Starting result for query allowable value is numeric [optional]
count: Number of tasks for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_windows/fc7b167c-29ea-49a1-9ee3-efb6d1351343/tasks?start=0&count=50&get_total=true
OUTPUT {
    \"commit_tasks\": {
        \"count\": 1,
        \"total\": 1,
        \"commit_task\": {
            \"id\": 1,
            \"start_date\": \"04-Nov-2018 01:30:00PM +0200\",
            \"end_date\": \"04-Nov-2018 01:32:01PM +0200\",
            \"errors\": \"\"
        }
    }
}


Response Messages:
200: OK
400: For correct pagination provide a value for the start and count parameters
400: Start parameter must be a non-negative value
400: Count parameter must be a positive value
403: Not permitted to access this context
404: Change window with uuid was not found
404: Change window with uuid was not found in domain "},"response":[]},{"name":"Get name and status for all change windows","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/change_windows/","description":"Retrieves a list of all change windows.
For valid pagination, both start and count should be provided. Otherwise, pagination is turned off.
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.


Parameters:
context: Global MSSP context [optional]
start: Starting result for query allowable value is numeric [optional]
count: Number of change windows for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_windows?start=0&count=50&get_total=true
OUTPUT {
    \"change_windows\": {
        \"count\": 2,
        \"total\": 2,
        \"change_window\": [
            {
                \"uuid\": \"6ae41504-a95c-4f23-98a2-f18b2efadb9d\",
                \"name\": \"cw1\",
                \"domain_id\": 1,
                \"enabled\": true
            },
            {
                \"uuid\": \"fc7b167c-29ea-49a1-9ee3-efb6d1351343\",
                \"name\": \"cw2\",
                \"domain_id\": 1,
                \"enabled\": true
            }
        ]
    }
}


Response Messages:
200: OK
400: For correct pagination provide a value for the start and count parameters
400: Start parameter must be a non-negative value
400: Count parameter must be a positive value
403: Not permitted to access this context "},"response":[]}]},{"name":"Device Interfaces and Zones","item":[{"name":"Get device zones by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/zones","description":"Returns a list of the zones for the specified Juniper, Stonesoft, Fortinet or Palo Alto Networks device.
Note: this API returns device zones, not Tufin zones.

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/104/zones
"},"response":[]},{"name":"Get device zones by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/zones","description":"Returns a list of the zones for the specified Juniper, Stonesoft, Fortinet or Palo Alto Networks revision.
Note: this API returns device zones, not Tufin zones.

Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/787/zones
"},"response":[]},{"name":"Get network interfaces by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/interfaces","description":"Reflects static data from the running-config.
For dynamic information see the /topology_interfaces API.
This API is not applicable for Check Point.

Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/227/interfaces
"},"response":[]},{"name":"Get zones and network interfaces that participate in sub-policies","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/bindable_objects","description":"Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/104/bindable_objects
"},"response":[]},{"name":"Get network interfaces by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/interfaces","description":"Reflects static data from the running-config.
For dynamic information see the /topology_interfaces API.
This API is not applicable for Check Point.

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/10/interfaces
"},"response":[]}]},{"name":"Domains","item":[{"name":"Add a domain","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"domain\": {\n\t\t\"name\": \"domain1\",\n\t\t\"address\": \"address\",\n\t\t\"description\": \"description\"\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/domains/","description":"Parameters:
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/domains
BODY{
    \"domain\": {
        \"name\": \"domain1\",
        \"address\": \"address\",
        \"description\": \"description\"
    }
}


Response Messages:
403: User not permitted to access domains
400: Domain with this name already exists
400: Domain name is empty"},"response":[]},{"name":"Get all domains","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/domains/","description":"

Usage Example
https://192.168.1.1/securetrack/api/domains

Response Messages:
403: User not permitted to access domains"},"response":[]},{"name":"Get domain","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/domains/{{id}}","description":"Parameters:
context: Global MSSP context [optional]
id: Domain id

Usage Example
https://192.168.1.1/securetrack/api/domains/1

Response Messages:
403: User not permitted to access domains
400: Domain with ID was not found"},"response":[]},{"name":"Update a domain","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"domain\": {\n\t\t\"name\": \"edited name\",\n\t\t\"address\": \"edited address\",\n\t\t\"description\": \"edited description\"\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/domains/{{id}}","description":"Parameters:
id: Domain id
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/domains/2
BODY{
    \"domain\": {
        \"name\": \"edited name\",
        \"address\": \"edited address\",
        \"description\": \"edited description\"
    }
}


Response Messages:
403: User not permitted to access domains
400: Domain with ID was not found
400: Domain with this name already exists
400: Domain name is empty
400: Default domain cannot be changed"},"response":[]}]},{"name":"General Properties","item":[{"name":"Get general properties","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/properties/","description":"This API requires 'Super admin' privileges



Usage Example
URLhttps://192.168.1.1/securetrack/api/properties
OUTPUT{
    \"properties\": {
        \"sc_addresses\": {
            \"sc_address\": [
                {
                    \"ip_address\": \"127.0.0.1\",
                    \"type\": \"external\"
                },
                {
                    \"ip_address\": \"127.0.0.1\",
                    \"type\": \"internal\"
                }
            ]
        }
    }
}


Response Messages:
403: User not permitted to view properties"},"response":[]}]},{"name":"IPsec VPN","item":[{"name":"Get Check Point VPN (IPSec) communities and gateways","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/ipsec_communities","description":"Get Check Point VPN (IPSec) Communities and gateways that partcipant in those communities.
Works on clusters and gateways, not on management servers.

Parameters:
device_id: The unique identifier of target device

Usage Example
https://192.168.1.1/securetrack/api/bindings/20/ipsec_communities
"},"response":[]},{"name":"Get Cisco IPsec policy and peers","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"outputInterfaceName"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/ipsec_tunnels","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.
You can retrieve the interface names by calling the /devices/id/interfaces API.

Parameters:
device_id: The unique identifier of target device
outputInterfaceName: Interface name

Usage Example
https://192.168.1.1/securetrack/api/bindings/32/ipsec_tunnels?outputInterfaceName=GigabitEthernet1
"},"response":[]},{"name":"Get Cisco cryptographic maps by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/crypto_maps","description":"Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://191.168.1.1/securetrack/api/revisions/18/crypto_maps
"},"response":[]},{"name":"Get Cisco cryptographic maps by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/crypto_maps","description":"Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/19/crypto_maps
"},"response":[]}]},{"name":"Internet Objects","item":[{"name":"Get resolved Internet representation for device","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"deviceId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}/object","description":"The order of precedence used to resolve the Internet object is:
Step 1: Identify the Internet referral:
Search for a defined Internet referral on the specified device.
If it is not found on the device, search the parent and grandparents (up the device tree) for a defined Internet referral.
If a defined Internet referral is found, then match the name in the Internet referral to a network object, as defined in Step 2.
If an Internet referral is not found, it resolves to “Any”.
Step 2: Resolve the object by name:
Search the specified device for a defined network object that matches the name returned in Step 1.
If a matching network object is not found, an error will be returned.

Parameters:
deviceId: SecureTrack Device ID

Usage Example
https://192.168.1.1/securetrack/api/internet_referral/2/object

Response Messages:
200: Resolved Internet referral object for device is returned
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
404: Configured object was not found on the device
403: Access is denied."},"response":[]},{"name":"Update Internet representation for device","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"internet_referral\": {\n\t\t\"@xsi.type\": \"internetReferralObjectNameDTO\",\n\t\t\"device_id\": 2,\n\t\t\"object_name\": \"Host_10.11.73.1\"\n\t}\n}\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}","description":"Updates the Internet referral configuration for the device.
If there was no previous configuration, it will be created.

Parameters:
deviceId: SecureTrack Device ID
body: Internet referral configuration

Usage Example
URLhttps://192.168.1.1/securetrack/api/internet_referral
BODY{
    \"internet_referral\": {
        \"@xsi.type\": \"internetReferralObjectNameDTO\",
        \"device_id\": 2,
        \"object_name\": \"Host_10.11.73.1\"
    }
}


Response Messages:
200: Internet referral configuration was updated
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
400: Internet referral configuration was malformed
403: Access is denied."},"response":[]},{"name":"Get Internet representation for device","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"deviceId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}","description":"Parameters:
deviceId: SecureTrack Device ID

Usage Example
https://192.168.1.1/securetrack/api/internet_referral/2

Response Messages:
200: Internet referral configuration is returned
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
404: Internet referral configuration was not found for device ID
403: Access is denied."},"response":[]},{"name":"Delete Internet representation for device","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"deviceId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}","description":"Parameters:
deviceId: SecureTrack Device ID

Usage Example
https://192.168.1.1/securetrack/api/internet_referral/2

Response Messages:
200: Internet referral configuration was deleted
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
400: Internet referral configuration for device ID does not exist
403: Access is denied."},"response":[]},{"name":"Create new Internet representation for a device","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"internet_referral\": {\n\t\t\"@xsi.type\": \"internetReferralObjectNameDTO\",\n\t\t\"device_id\": 2,\n\t\t\"object_name\": \"Host_2.2.2.2\"\n\t}\n}\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/","description":"The internet referral lets you represent the Internet as an object on a device.
See REST API: /internet_referral/{deviceId:[0-9]+}/object for a description of how internet referral is resolved.

Parameters:
body: Internet referral configuration

Usage Example
URLhttps://192.168.1.1/securetrack/api/internet_referral
BODY{
    \"internet_referral\": {
        \"@xsi.type\": \"internetReferralObjectNameDTO\",
        \"device_id\": 2,
        \"object_name\": \"Host_2.2.2.2\"
    }
}


Response Messages:
201: Internet referral configuration was created
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
400: Internet referral configuration was malformed
400: Internet referral configuration for given device ID already exists
403: Access is denied."},"response":[]}]},{"name":"LDAP","item":[{"name":"Get LDAP entry details by DN","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"dn"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/getEntryByDN","description":"Returns the UID, DN and Name of a LDAP entry specified by the DN.

Parameters:
dn: LDAP DN

Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/getEntryByDN?dn=CN=Manufacturing,OU=RSA_Demo,DC=tufintest,DC=com
OUTPUT{
    \"ldap_entry\": {
        \"uid\": \"mYbWQms7p0q5YinEyW5Byw==\",
        \"dn\": \"CN=Manufacturing,OU=RSA_Demo,DC=tufintest,DC=com\",
        \"name\": \"Manufacturing\"
    }
}


Response Messages:
200: OK
400: Invalid DN format
404: Entry matching the DN cannot be found
501: LDAP server is not configured
503: No connection to LDAP server"},"response":[]},{"name":"Return LDAP entries which match the given search criteria","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"search_criteria\": {\n\t\t\"search_base_dn\": \"DC=tufintest,DC=com\",\n\t\t\"search_text\": \"test\",\n\t\t\"ldap_search_options\": {\n\t\t\t\"ldap_entry_types\": {\n\t\t\t\t\"ldap_entry_type\": [\n\t\t\t\t\t\"OU\",\n\t\t\t\t\t\"USER\"\n\t\t\t\t]\n\t\t\t},\n\t\t\t\"search_mode\": \"CONTAINS\",\n\t\t\t\"max_search_result\": 3\n\t\t}\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/search","description":"Return list of LDAP entries which match the given search criteria according to the search mode (EXACT, CONTAINS, STARTS_WITH, ENDS_WITH).
The search is case insensitive.
The limit of max_search_result is 1000.

Parameters:
body: Search criteria

Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/search
BODY{
    \"search_criteria\": {
        \"search_base_dn\": \"DC=tufintest,DC=com\",
        \"search_text\": \"test\",
        \"ldap_search_options\": {
            \"ldap_entry_types\": {
                \"ldap_entry_type\": [
                    \"OU\",
                    \"USER\"
                ]
            },
            \"search_mode\": \"CONTAINS\",
            \"max_search_result\": 3
        }
    }
}
OUTPUT{
    \"search_result\": {
        \"ldap_entries\": {
            \"ldap_entry\": [
            {
                \"dn\": \"CN=User15ATTesting1,OU=Testing1,OU=new OU,OU=SC_Users,DC=tufintest,DC=com\",
                \"uid\": \"ZRuKW3XqIEOIxCwlfgJQYA==\",
                \"displayName\": \"User15ATTesting1\"
            },
            {
                \"dn\": \"CN=IWAM_TEST2003,CN=Users,DC=tufintest,DC=com\",
                \"uid\": \"bYVqqcZXsUSF51hiP4W7Yw==\",
                \"displayName\": \"Testing1\"
            },
            {
                \"dn\": \"CN=User1ATTesting1,OU=Testing1,OU=new OU,OU=SC_Users,DC=tufintest,DC=com\",
                \"uid\": \"2ma3TrgeHEWQDITwvcRqlg==\",
                \"displayName\": \"test\"
            }
            ]
        },
            \"has_more_results_to_return\": \"true\"
        }
}


Response Messages:
200: OK
400: Bad request (one of the request fields has an illegal or invalid value)
501: LDAP server is not configured
503: No connection to LDAP server"},"response":[]},{"name":"Return entries that exactly match one of the given strings","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"search_by_name_criteria\": {\n\t\t\"search_texts\": {\n\t\t\t\"search_text\": [\n\t\t\t\t\"Finance\",\n\t\t\t\t\"Marketing\",\n\t\t\t\t\"Management\"\n\t\t\t]\n\t\t},\n\t\t\"ldap_entry_types\": {\n\t\t\t\"ldap_entry_type\": [\n\t\t\t\t\"GROUP\"\n\t\t\t]\n\t\t},\n\t\t\"max_search_result\": 20\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/getEntriesByNames","description":"Return list of LDAP entries which match the exact given multiple search_text.

Parameters:
body: Names to search

Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/getEntriesByNames
BODY{
    \"search_by_name_criteria\": {
        \"search_texts\": {
            \"search_text\": [
                \"Finance\",
                \"Marketing\",
                \"Management\"
            ]
        },
        \"ldap_entry_types\": {
            \"ldap_entry_type\": [
                \"GROUP\"
            ]
        },
        \"max_search_result\": 20
    }
}
OUTPUT{
    \"search_result\": {
        \"ldap_entries\": {
            \"ldap_entry\": [
                {
                    \"@xsi.type\": \"LdapGroup\",
                    \"dn\": \"CN=Finance,OU=SecureTrack,DC=tufintest,DC=com\",
                    \"uid\": \"uOvJTpYRD0aTjEENA87N5A==\",
                    \"displayName\": \"Finance\"
                },
                {
                    \"@xsi.type\": \"LdapGroup\",
                    \"dn\": \"CN=Management,OU=SecureTrack,DC=tufintest,DC=com\",
                    \"uid\": \"jdf778skfsgs730fksdHHs==\",
                    \"displayName\": \"Management\"
                }
            ]
        },
        \"has_more_results_to_return\": false
    }
}


Response Messages:
200: OK
400: Bad request (one of the request fields has an illegal value)
501: LDAP server is not configured
503: No connection to LDAP server"},"response":[]},{"name":"Get the base DN entry details","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/getBaseDNEntry","description":"The returned \"base DN\" is used by GetEntriesByNames API as the search start entry.



Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/getBaseDNEntry
OUTPUT{
    \"ldap_entry\": {
        \"dn\": \"DC=tufintest,DC=com\",
        \"uid\": \"nABbRP/lPUKlteNRI4j6iA==\"
    }
}


Response Messages:
200: OK
404: Base Entry cannot be found
501: LDAP server is not configured
503: No connection to LDAP server"},"response":[]}]},{"name":"Monitored Devices","item":[{"name":"Add devices to SecureTrack","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \n \t \"devices_list\":{ \n \t\t \"devices\": [{ \n \t\t\t \"model\":\"CMA\",\n \t\t\t \"vendor\":\"Checkpoint\",\n \t\t\t \"display_name\":\"Europe-CMA\",\n \t\t\t \"ip_address\":\"192.168.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"securetrack_domain\":\"Default\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"lea_authentication_port\":\"65000\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"opsec_application\":\"ST-Opsec\",\n \t\t\t\t \"activation_key\":\"ST-Activation\",\n \t\t\t\t \"r80_version\":\"false\"\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"model\":\"CMA\",\n \t\t\t \"vendor\":\"Checkpoint\",\n \t\t\t \"display_name\":\"Europe-CMA\",\n \t\t\t \"ip_address\":\"192.168.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"securetrack_domain\":\"Default\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"lea_authentication_port\":\"65000\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"opsec_application\":\"ST-Opsec\",\n \t\t\t\t \"activation_key\":\"ST-Activation\",\n \t\t\t\t \"user_name\":\"admin\",\n \t\t\t\t \"password\":\"1234\",\n \t\t\t\t \"r80_version\":\"true\"\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"model\":\"ASA\",\n \t\t\t \"vendor\":\"Cisco\",\n \t\t\t \"securetrack_domain\":\"Domain-A\",\n \t\t\t \"display_name\":\"Ireland-ASA\",\n \t\t\t \"ip_address\":\"172.16.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t \"enable_virtual_contexts\":\"true\",\n \t\t\t \"import_all\":\"false\",\n \t\t\t \"import_devices\": \n \t\t\t\t\t [\"VC1\",\"VC2\"],\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"false\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"user_name\":\"St-Super-use\",\n \t\t\t\t \"password\":\"st-super-password\",\n \t\t\t\t \"enable_password\":\"st-enable-password\"\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"model\":\"Panorama\",\n \t\t\t \"vendor\":\"PaloAltoNetworks\",\n \t\t\t \"display_name\":\"First-Device-example\",\n \t\t\t \"ip_address\":\"172.16.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"user_name\":\"St-Super-use\",\n \t\t\t\t \"password\":\"st-super-password\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"import_devices\":[\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG1\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"] \n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG2\",\n \t\t\t\t\t\t \"import_all\":\"true\"\n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG3\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [] \n \t\t\t\t\t }\n \t\t\t\t ]\n \t\t\t }\n \t\t },\n \t\t {\n \t\t\t \"model\":\"FortiManager\",\n \t\t\t \"vendor\":\"Fortinet\",\n \t\t\t \"display_name\":\"Spain-FortiManager\",\n \t\t\t \"securetrack_server\":\"RemoteControlServerName\",\n \t\t\t \"ip_address\":\"172.16.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"false\",\n \t\t\t\t \"user_name\":\"St-Super-use\",\n \t\t\t\t \"password\":\"st-super-password\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"import_all\": \"false\",\n \t\t\t\t \"import_devices\": [\n \t\t\t\t\t\t { \n \t\t\t\t \"name\": \"AdomX\",\n \t\t\t\t \"import_all\": \"false\", \n \t\t\t\t \"managed_devices\": [\"FW1\"]\n \t\t\t\t\t\t}\n \t\t\t\t\t]\n \t\t\t\t}\n \t\t\t}\n \t\t]\n \t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/","description":"Use this API to add a single device or a list of devices to SecureTrack.
The following devices can be added: Check Point CMA R77, CMA R80, SMC R77, SMC R80; Cisco ASA; Palo Alto Panorama NG; Fortinet FortiManager.
The API body should include a JSON file with the mandatory parameters for the operation.
String parameters contain only lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^().
Currently supported types: CMA, SMC, ASA, Panorama NG and FortiManager.

This API verifies connection to the provided device, before adding a device.
This is done by:
  Cisco - Connect with SSH and see that the credentials are correct.
  Check Point - Test OPSEC connectivity. For R80 devices, this also verifies the connectivity for API login.
  Panorama - Login through the API to check connectivity.
  Fortimanager - Login through the API to check connectivity.
If the connection test fails the device will not be added.
Only \"live\" device with correct credentials can be added using this API.
To add Checkpoint R77 devices, use \"r80_version\" : \"false\".


Parameters:
body: device_list

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/bulk
BODY{
     \"devices_list\":{
         \"devices\": [{
             \"model\":\"CMA\",
             \"vendor\":\"Checkpoint\",
             \"display_name\":\"Europe-CMA\",
             \"ip_address\":\"192.168.1.1\",
             \"enable_topology\": \"true\",
             \"securetrack_domain\":\"Default\",
             \"device_data\":{
                 \"lea_authentication_port\":\"65000\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"opsec_application\":\"ST-Opsec\",
                 \"activation_key\":\"ST-Activation\",
                 \"r80_version\":\"false\"
             }
         },
         {
             \"model\":\"CMA\",
             \"vendor\":\"Checkpoint\",
             \"display_name\":\"Europe-CMA\",
             \"ip_address\":\"192.168.1.1\",
             \"enable_topology\": \"true\",
             \"securetrack_domain\":\"Default\",
             \"device_data\":{
                 \"lea_authentication_port\":\"65000\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"opsec_application\":\"ST-Opsec\",
                 \"activation_key\":\"ST-Activation\",
                 \"user_name\":\"admin\",
                 \"password\":\"1234\",
                 \"r80_version\":\"true\"
             }
         },
         {
             \"model\":\"ASA\",
             \"vendor\":\"Cisco\",
             \"securetrack_domain\":\"Domain-A\",
             \"display_name\":\"Ireland-ASA\",
             \"ip_address\":\"172.16.1.1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
             \"enable_virtual_contexts\":\"true\",
             \"import_all\":\"false\",
             \"import_devices\":
                     [\"VC1\",\"VC2\"],
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"false\",
                 \"collect_dynamic_topology\":\"false\",
                 \"user_name\":\"St-Super-use\",
                 \"password\":\"st-super-password\",
                 \"enable_password\":\"st-enable-password\"
             }
         },
         {
             \"model\":\"Panorama\",
             \"vendor\":\"PaloAltoNetworks\",
             \"display_name\":\"First-Device-example\",
             \"ip_address\":\"172.16.1.1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"user_name\":\"St-Super-use\",
                 \"password\":\"st-super-password\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"collect_dynamic_topology\":\"false\",
                 \"import_devices\":[
                     {
                         \"name\":\"DG1\",
                         \"import_all\":\"false\",
                         \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"]
                     },
                     {
                         \"name\":\"DG2\",
                         \"import_all\":\"true\"
                     },
                     {
                         \"name\":\"DG3\",
                         \"import_all\":\"false\",
                         \"managed_devices\": []
                     }
                 ]
             }
         },
         {
             \"model\":\"FortiManager\",
             \"vendor\":\"Fortinet\",
             \"display_name\":\"Spain-FortiManager\",
             \"securetrack_server\":\"RemoteControlServerName\",
             \"ip_address\":\"172.16.1.1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"false\",
                 \"user_name\":\"St-Super-use\",
                 \"password\":\"st-super-password\",
                 \"collect_dynamic_topology\":\"false\",
                 \"import_all\": \"false\",
                 \"import_devices\": [
                         {
                 \"name\": \"AdomX\",
                 \"import_all\": \"false\",
                 \"managed_devices\": [\"FW1\"]
                        }
                    ]
                }
            }
        ]
    }
}


Response Messages:
202: Accepted
408: Request timed out
500: Internal server error
503: Task with UID already running"},"response":[]},{"name":"Edit Securetrack device","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \n \t \"devices_list\":{ \n\t\t \"devices\": [{\n\t\t\t \"device_id\": 1,\n\t\t\t \"display_name\": \"CheckPoint-R77-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"ip_address\": \"1.1.1.1\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"opsec_application\": \"ST-Opsec\",\n\t\t\t\t \"activation_key\": \"ST-Activation\",\n\t\t\t\t \"authentication_mode\": \"LEA\",\n\t\t\t\t \"lea_authentication_mode\": \"ssl_opsec\",\n\t\t\t\t \"lea_authentication_port\": \"2488\",\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 2,\n\t\t\t \"display_name\": \"CheckPoint-R80-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"ip_address\": \"1.1.1.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"opsec_application\": \"ST-Opsec\",\n\t\t\t\t \"activation_key\": \"ST-Activation\",\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\",\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 3,\n\t\t\t \"display_name\": \"Cisco-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"ip_address\": \"2.2.2.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\",\n\t\t\t\t \"enable_password\": \"st-super-password\",\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 4,\n\t\t\t \"display_name\": \"PaloAlto-PanoramaNg-Device\",\n\t\t\t \"ip_address\": \"2.2.2.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 5,\n\t\t\t \"display_name\": \"PaloAlto-DeviceGroup\"\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 6,\n\t\t\t \"display_name\": \"PaloAlto-FireWall-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_dynamic_topology\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 7,\n\t\t\t \"display_name\": \"Spain-FortiManager\",\n\t\t\t \"ip_address\": \"2.2.2.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 8,\n\t\t\t \"display_name\": \"FortiManager-Adom\"\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 9,\n\t\t\t \"display_name\": \"FortiManager-FireWall\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_dynamic_topology\": \"true\"\n\t\t\t }\n\t\t }\n\t\t]\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/","description":"Use this API to edit the settings of a management device, including changing multiple parameters in the same call.
The API body should include a JSON file with the mandatory parameters for the operation.
String parameters contain only lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^().
The following devices can be added: Check Point CMA R77, CMA R80, SMC R77, SMC R80; Cisco ASA; Palo Alto Panorama NG; Fortinet FortiManager.
Note: This API cannot be used to edit SecureTrack Domains and SecureTrack Servers.
This API verifies connection to the provided device, before updating a device.
This is done by:
  Cisco - Connect with SSH and see that the credentials are correct.
  Check Point - Test OPSEC connectivity. For R80 devices, this also verifies the connectivity for API login.
  Panorama - Login through the API to check connectivity.
  Fortimanager - Login through the API to check connectivity.
If the connection test fails the device will not be updated.
Only \"live\" device with correct credentials can be updated using this API.

Parameters:
body: device_list

Usage Example
URL https://192.168.1.1/securetrack/api/devices/bulk
BODY{
     \"devices_list\":{
         \"devices\": [{
             \"device_id\": 1,
             \"display_name\": \"CheckPoint-R77-Device\",
             \"enable_topology\": \"true\",
             \"ip_address\": \"1.1.1.1\",
             \"device_data\": {
                 \"opsec_application\": \"ST-Opsec\",
                 \"activation_key\": \"ST-Activation\",
                 \"authentication_mode\": \"LEA\",
                 \"lea_authentication_mode\": \"ssl_opsec\",
                 \"lea_authentication_port\": \"2488\",
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\"
             }
         },
         {
             \"device_id\": 2,
             \"display_name\": \"CheckPoint-R80-Device\",
             \"enable_topology\": \"true\",
             \"ip_address\": \"1.1.1.2\",
             \"device_data\": {
                 \"opsec_application\": \"ST-Opsec\",
                 \"activation_key\": \"ST-Activation\",
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\",
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\"
             }
         },
         {
             \"device_id\": 3,
             \"display_name\": \"Cisco-Device\",
             \"enable_topology\": \"true\",
             \"ip_address\": \"2.2.2.2\",
             \"device_data\": {
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\",
                 \"enable_password\": \"st-super-password\",
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\"
             }
         },
         {
             \"device_id\": 4,
             \"display_name\": \"PaloAlto-PanoramaNg-Device\",
             \"ip_address\": \"2.2.2.2\",
             \"device_data\": {
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\"
             }
         },
         {
             \"device_id\": 5,
             \"display_name\": \"PaloAlto-DeviceGroup\"
         },
         {
             \"device_id\": 6,
             \"display_name\": \"PaloAlto-FireWall-Device\",
             \"enable_topology\": \"true\",
             \"device_data\": {
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\",
                 \"collect_dynamic_topology\": \"true\"
             }
         },
         {
             \"device_id\": 7,
             \"display_name\": \"Spain-FortiManager\",
             \"ip_address\": \"2.2.2.2\",
             \"device_data\": {
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\"
             }
         },
         {
             \"device_id\": 8,
             \"display_name\": \"FortiManager-Adom\"
         },
         {
             \"device_id\": 9,
             \"display_name\": \"FortiManager-FireWall\",
             \"enable_topology\": \"true\",
             \"device_data\": {
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\",
                 \"collect_dynamic_topology\": \"true\"
             }
         }
        ]
    }
}


Response Messages:
202: Accepted
408: Request timed out
500: Internal server error
503: Task with UID already running"},"response":[]},{"name":"Get specific device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}","description":"Returns the vendor, model, name, domain and ID for the specified device.
For more information on supported devices, supported models and virtual types please refer to 'Device and Revision Resources' section in the Tufin Knowledge Center .

Parameters:
context: Global MSSP context [optional]
id: Device ID
show_os_version: Show os version as apart of the response [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/60

Usage Example
https://192.168.1.1/securetrack/api/devices/20?show_os_version=true
"},"response":[]},{"name":"Add offline device","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t asa \n\t Cisco\n\t 1\n\t Default\n\t API OFFLINE ASA1\n\t true\n\t true\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/","description":"You can choose to select the domain either by name or id using the domain_id or domain_name tags.\nDevice name should contain only Lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^()

Parameters:
body: Device to be added

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices
BODY<device>
     <model>asa</model>
     <vendor>Cisco</vendor>
     <domain_id>1</domain_id>
     <domain_name>Default</domain_name>
     <name>API OFFLINE ASA1</name>
     <offline>true</offline>
     <topology>true</topology>
</device>

"},"response":[]},{"name":"Get devices","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/","description":"Returns the list of devices that are configured in SecureTrack, including the vendor, model, name, domain and device ID.
The results can be sorted by ip, name, vendor and model.
For more information on supported devices, supported models and virtual types please refer to 'Device and Revision Resources' section in the Tufin Knowledge Center .

Parameters:
context: Global MSSP context [optional]
name: Device name [optional]
ip: Device IP address [optional]
vendor: Device vendor [optional]
model: Device model [optional]
sort: Sort ascending or descending allowable types are: asc or desc [optional]
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query starting from starting page allowable type in numeric [optional]
show_os_version: Show os version as apart of the response [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices

Usage Example
https://192.168.1.1/securetrack/api/devices?vendor=VMware

Usage Example
https://192.168.1.1/securetrack/api/devices?sort=ip:asc

Usage Example
https://192.168.1.1/securetrack/api/devices?show_os_version=true
"},"response":[]},{"name":"Import managed devices","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \n \t \"devices_list\":{ \n \t\t \"devices\":[ \n \t\t { \n \t\t\t \"device_id\":\"1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"import_devices\":[\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG1\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"] \n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG2\",\n \t\t\t\t\t\t \"import_all\":\"true\"\n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG3\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [] \n \t\t\t\t\t }\n \t\t\t\t ]\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"device_id\":\"2\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"import_devices\": [\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"Adom1\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [\"firewall1\", \"firewall2\"] \n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"Adom2\",\n \t\t\t\t\t\t \"import_all\":\"true\"\n \t\t\t\t\t }\n \t\t\t\t ]\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"device_id\":\"3\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"import_devices\": [\"wantedVirtualContext\", \"anotherWantedVirtualContext\"] \n \t\t\t }\n \t\t }\n \t\t]\n \t}\n} "},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/import","description":"Use this API to import more managed devices to SecureTrack.
The following devices can be added: Device Groups (for Panorama), Administrative Domains (for FortiManager).\nCurrently supported types: Panorama, FortiManager, Cisco ASA.
Please see examples below per device id: device id 1 for Panorama, device 2 for FortiManager, device id 3 for Cisco ASA.

Parameters:
body: device_list

Usage Example
URL https://192.168.1.1/securetrack/api/devices/bulk/import
BODY{
     \"devices_list\":{
         \"devices\":[
         {
             \"device_id\":\"1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"collect_dynamic_topology\":\"false\",
                 \"import_devices\":[
                     {
                         \"name\":\"DG1\",
                         \"import_all\":\"false\",
                         \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"]
                     },
                     {
                         \"name\":\"DG2\",
                         \"import_all\":\"true\"
                     },
                     {
                         \"name\":\"DG3\",
                         \"import_all\":\"false\",
                         \"managed_devices\": []
                     }
                 ]
             }
         },
         {
             \"device_id\":\"2\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"import_devices\": [
                     {
                         \"name\":\"Adom1\",
                         \"import_all\":\"false\",
                         \"managed_devices\": [\"firewall1\", \"firewall2\"]
                     },
                     {
                         \"name\":\"Adom2\",
                         \"import_all\":\"true\"
                     }
                 ]
             }
         },
         {
             \"device_id\":\"3\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"import_devices\": [\"wantedVirtualContext\", \"anotherWantedVirtualContext\"]
             }
         }
        ]
    }
}


Response Messages:
202: Accepted
408: Request timed out
500: Internal server error
503: Task with UID already running"},"response":[]},{"name":"Get specific task results of bulk operations on devices","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"task_uid"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/tasks/{{task_uid}}","description":"Use this API to track and display the current progress of the devices being edited or added to\nSecureTrack for a specific Task ID.
For a list of devices, the status of each device is displayed.

A device that was not added due to some reason will be added to \"failed\" list with status element containing a description.
For example:
\"description\": \"No connection to device\".

Parameters:
task_uid: Task UID

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/bulk/tasks/d7e88799-a6e5-45da-8c72-c979a5dbe235
OUTPUT{
    \"task_result\":{
        \"total_succeeded\":\"0\",
        \"total_in_progress\":\"2\",
        \"total_failed\":\"0\",
        \"succeeded\":{
            \"count\":\"0\"
        },
        \"in_progress\":{
            \"count\":\"2\",
            \"devices\":[
                {
                    \"device_id\":\"1\",
                    \"display_name\":\"Europe-CMA\",
                    \"ip_address\":\"192.168.1.1\",
                    \"status\":{
                    }
                },
                {
                    \"device_id\":\"2\",
                    \"display_name\":\"Ireland-ASA\",
                    \"ip_address\":\"172.16.1.1\",
                    \"status\":{
                    }
                }
            ]
        },
        \"failed\":{
            \"count\":\"0\"
        }
    }
}


Response Messages:
404: The task with the given UID was not found
400: Bad request
200: Accepted
408: Request timed out
500: Internal server error"},"response":[]},{"name":"Get textual configuration by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/config","description":"Get latest revision of running configuration for a given device Id.


Parameters:
context: global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/111/config
"},"response":[]},{"name":"Add configuration for offline device","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"configuration_file"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/tasks/add_device_config_task","description":"Parameters:
device_id: Device ID
configuration_file: Configuration File

Usage Example
curl -X POST -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F \"configuration_file=@/tmp/config.txt;type=application/octet-stream\" -F \"device_id=1\" https://192.168.1.1/securetrack/api/tasks/add_device_config_task

Response Messages:
200: Configuration added successfully."},"response":[]},{"name":"Update offline device","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t API OFFLINE ASA2\n\t true\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}","description":"Device name should contain only Lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^()

Parameters:
device_id: Device ID
body: Device to be updated

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/1
BODY<device>
     <name>API OFFLINE ASA2</name>
     <topology>true</topology>
</device>

"},"response":[]},{"name":"Get textual configuration by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/config","description":"Returns textual configuration for the specified revision Id.


Parameters:
context: Global MSSP context [optional]
id: Revision id

Usage Example
https://192.168.1.1/securetrack/api/revisions/227/config
"},"response":[]}]},{"name":"NAT Policies","item":[{"name":"Get NAT objects by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/nat_objects","description":"Fetches a list of NAT objects for a given revision
Note: NAT objects are only relevant for Check Point management servers and Juniper Netscreen devices.
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.


Parameters:
context: Global MSSP context [optional]
id: Version ID
start: Starting page for query allowable value is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/nat_objects

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/nat_objects?get_total=true
"},"response":[]},{"name":"Get NAT objects by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/nat_objects","description":"Fetches a list of NAT objects defined on device given by device ID
Note: NAT objects are only relevant for Check Point management servers and Juniper Netscreen devices.
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.


Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable value is numeric [optional]
count: Starting page for query allowable value is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/nat_objects

Usage Example
https://192.168.1.1/securetrack/api/devices/20/nat_objects?get_total=true
"},"response":[]},{"name":"Get NAT rules by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/nat_rules/bindings","description":"Fetches list of NAT rules for device given by device ID

input_interface and output_interface are not supported for Panorama running in Advanced management mode
nat_stage is supported for Netscreen and JunOS
nat_type is supported for FortiManager
Note: For Check Point, NAT rules are available from the modules (not managements)
Note: For Palo Alto, filtering NAT rules by interface is only available for firewall devices

Parameters:
context: Global MSSP context [optional]
id: Device ID
input_interface: Input interface for NAT rules, \"any\" for all interfaces [optional]
output_interface: output interface for NAT rules, \"any\" for all interfaces [optional]
nat_stage: NAT stage for NAT rules allowable values: \"pre_policy\" , \"post_policy\" or \"both\" [optional]
nat_type: NAT stage for NAT rules allowable values: \"vip\" or \"reverse_vip\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/10/nat_rules/bindings?input_interface=Any
"},"response":[]}]},{"name":"Network Objects","item":[{"name":"Get network groups containing specified network object","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/network_objects/{{id}}/groups","description":"Returns groups that contain the specified network object


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the network object.

Usage Example
https://192.168.1.1/securetrack/api/network_objects/69577/groups
"},"response":[]},{"name":"Get rules containing specified network object","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/network_objects/{{id}}/rules","description":"Returns the security rules that contain the specified network object


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the network object.
include_groups: You can add \"include_groups\" to find rules that include the network object and rules that include the groups that include the network object. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]

Usage Example
https://192.168.1.1/securetrack/api/network_objects/65078/rules?include_groups=true
"},"response":[]},{"name":"Get network objects by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/network_objects","description":"Fetches list of network objects defined on device given by ID
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.
The show_members parameter is only relevant if type=group.
If type=group, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.

Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
name: Network object name [optional]
type: Network object type [optional]
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
contains_ip: Get only network objects containing this IP [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]
typeOnDevice: Get EDL groups [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/network_objects

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?get_total=true
OUTPUT {
    \"network_objects\": {
    \"count\": 1,
    \"total\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"hostNetworkObjectDTO\",
                \"id\": 499226,
                \"name\": \"1.1.1.2 not shared\",
                \"display_name\": \"1.1.1.2 not shared\",
                \"class_name\": \"host_plain\",
                \"type\": \"host\",
                \"comment\": \"\",
                \"uid\": \"{EFE8E61B-EE2A-2F55-4C5C-56508661EAA7}\",
                \"implicit\": false,
                \"management_domain\": \"Shared\",
                \"overrides\": false,
                \"ip\": \"1.1.1.2\"
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"count\": 1
        \"network_object\": [
            {
                \"@xsi.type\": \"identityAwarenessDTO\",
                \"id\": 169178,
                \"name\": \"Access_role\",
                \"display_name\": \"Access_role\",
                \"class_name\": \"access_role\",
                \"type\": \"identity_awareness\",
                \"global\": false,
                \"comment\": \"\",
                \"uid\": \"{FC267948-DA8C-4FB6-A736-76B5254BF825}\",
                \"implicit\": false,
                \"overrides\": false,
                \"type_on_device\": \"\",
                \"networks\": {
                    \"network\": {
                        \"@xsi.type\": \"basicNetworkObjectDTO\",
                        \"id\": 168419,
                        \"name\": \"Any\",
                        \"display_name\": \"Any\",
                        \"class_name\": \"any_object\",
                        \"type\": \"basic\",
                        \"global\": false,
                        \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                        \"implicit\": false,
                        \"overrides\": false
                    }
                },
                \"users\": {
                    \"user\": {
                        \"id\": 14320,
                        \"name\": \"ad_group_auto_30K_grp1\",
                        \"display_name\": \"auto_30K_grp1\",
                        \"class_name\": \"ad_group\",
                        \"global\": false,
                        \"comment\": \"\",
                        \"uid\": \"{CAB92DCC-CF63-4E47-B8E3-1E1231996D5E}\",
                        \"dn\": \"CN=auto_30K_grp1,OU=OU_30K_Groups,DC=rnd,DC=local\"
                    }
                }
            },
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?type=group&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 105934,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?typeOnDevice=edl_ip_list&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 1,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 123123,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"type_on_device\": edl_ip_list,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Response Messages:
400: The typeOnDevice value is not valid"},"response":[]},{"name":"Get network objects by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/network_objects","description":"Fetches list of network objects from specific revision
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.
The show_members parameter is only relevant if type=group.
If type=group, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.

Parameters:
context: Global MSSP context [optional]
id: Revision id
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
name: Network object name [optional]
type: Network object type [optional]
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
contains_ip: Get only network objects containing this IP [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]
typeOnDevice: Get EDL groups [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/779/network_objects

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?get_total=true
OUTPUT {
    \"network_objects\": {
    \"count\": 1,
    \"total\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"hostNetworkObjectDTO\",
                \"id\": 499226,
                \"name\": \"1.1.1.2 not shared\",
                \"display_name\": \"1.1.1.2 not shared\",
                \"class_name\": \"host_plain\",
                \"type\": \"host\",
                \"comment\": \"\",
                \"uid\": \"{EFE8E61B-EE2A-2F55-4C5C-56508661EAA7}\",
                \"implicit\": false,
                \"management_domain\": \"Shared\",
                \"overrides\": false,
                \"ip\": \"1.1.1.2\"
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/779/network_objects?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
    \"count\": 1,
        \"network_object\": [
            {
                \"@xsi.type\": \"identityAwarenessDTO\",
                \"id\": 169183,
                \"name\": \"Access role 1\",
                \"display_name\": \"Access role 1\",
                \"class_name\": \"access_role\",
                \"type\": \"identity_awareness\",
                \"global\": true,
                \"comment\": \"\",
                \"uid\": \"{1E4C35A0-1FE4-4101-8A38-FDE656BCDCFB}\",
                \"implicit\": false,
                \"overrides\": false,
                \"type_on_device\": \"\",
                \"networks\": {
                    \"network\": {
                        \"@xsi.type\": \"basicNetworkObjectDTO\",
                        \"id\": 168419,
                        \"name\": \"Any\",
                        \"display_name\": \"Any\",
                        \"class_name\": \"any_object\",
                        \"type\": \"basic\",
                        \"global\": false,
                        \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                        \"implicit\": false,
                        \"overrides\": false
                    }
                },
                \"users\": {
                    \"user\": {
                        \"id\": 14346,
                        \"name\": \"all identified\",
                        \"display_name\": \"all identified\",
                        \"class_name\": \"all_identified\",
                        \"global\": false,
                        \"comment\": \"\",
                        \"uid\": \"{17A972AC-4B4A-4715-859F-867128707F59}\",
                        \"dn\": \"\"
                    }
                }
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/31/network_objects?type=group&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 105934,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/31/network_objects?typeOnDevice=edl_ip_list&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 1,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 123123,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"type_on_device\": edl_ip_list,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Response Messages:
400: The typeOnDevice value is not valid"},"response":[]},{"name":"Get network objects matching specified criteria","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"filter"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/network_objects/search","description":"You can search for network objects where the IP address, name or comment fields have a specified text string,
or you can search for network objects that have an IP address that matches, contains or is contained in a specified IP subnet,
or you can search for network objects by uid.

Parameters:
context: Returns results for the specified domain ID. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]
filter: “text” filter returns network objects where the IP address, name or comment fields have a specified text string. “subnet” filter returns network objects that have an IP address that matches, contains or is contained in a specified IP subnet. “uid“ filter returns network objects with the specified uid. If no filter is specified, the “text” filter is used.
device_id: Returns network objects belonging to the specified device_id. [optional]
ip: (For “text” filter) You can specify \"ip\" to find network objects with the specified text in the IP address field. [optional]
name: (For “text” filter) You can specify \"name\" to find network objects with the specified text in the name field. [optional]
comment: (For “text” filter) You can specify “comment” to find network objects with the specified text in the comment field. [optional]
any_field: (For “text” filter) You can specify \"any_field\" to find network objects with the specified text in the IP address, name or comment fields. [optional]
exact_match: (For “text” filter) You can add \"exact_match=true\" to find network objects with the specified text in the comment field. If this field is not specified, the query uses \"exact_match=false\". [optional]
contained_in: (For “subnet” filter) You can specify \"contained_in\" to find network objects that are contained in the specified IP subnet. For example, 10.1.0.0 is contained in 10.0.0.0. [optional]
contains: (For “subnet” filter) You can specify \"contains\" to find network objects that contain the specified IP subnet. For example, 10.0.0.0 contains 10.1.0.0. [optional]
exact_subnet: (For “subnet” filter) You can specify \"exact_subnet\" to find network objects that have the specified IP address. [optional]
uid: (for “uid“ filter) Returns network objects with the specified uid. [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]
typeOnDevice: You can specify \"typeOnDevice\" to find network object groups that are EDL. [optional]

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=text&name=host&exact_match=true

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=text&any_field=host&count=10&exact_match=true

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=subnet&contains=10.1.1.0

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=subnet&count=10&exact_subnet=1.1.1.1

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=uid&uid=24a8774d-24c1-4b3a-aae9-3c272a2b5191

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=uid&uid=24a8774d-24c1-4b3a-aae9-3c272a2b5191&device_id=4

Usage Example
URLhttps://192.168.1.1/securetrack/api/network_objects/search?filter=text&name=Access_Role&identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"count\": 1,
        \"total\": 1,
        \"network_object\": {
            \"@xsi.type\": \"identityAwarenessDTO\",
            \"id\": 169197,
            \"name\": \"Access_Role_aaa\",
            \"display_name\": \"Access_Role_aaa\",
            \"class_name\": \"access_role\",
            \"type\": \"identity_awareness\",
            \"global\": false,
            \"device_id\": 158,
            \"comment\": \"\",
            \"uid\": \"{9EDC2607-6BEC-43D7-A99D-B522BA694ADA}\",
            \"implicit\": false,
            \"overrides\": false,
            \"type_on_device\": \"\",
            \"networks\": {
                \"network\": {
                    \"@xsi.type\": \"basicNetworkObjectDTO\",
                    \"id\": 168419,
                    \"name\": \"Any\",
                    \"display_name\": \"Any\",
                    \"class_name\": \"any_object\",
                    \"type\": \"basic\",
                    \"global\": false,
                    \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                    \"implicit\": false,
                    \"overrides\": false
                }
            },
            \"users\": {
                \"user\": {
                    \"id\": 14317,
                    \"name\": \"ad_group_aaa\",
                    \"display_name\": \"aaa\",
                    \"class_name\": \"ad_group\",
                    \"global\": false,
                    \"comment\": \"\",
                    \"uid\": \"{5D16859C-0256-4673-A402-4254588B8F40}\",
                    \"dn\": \"CN=aaa,OU=SC_Users,DC=test,DC=com\"
                }
            }
        }
    }
}


Response Messages:
400: The typeOnDevice value is not valid.Use edl_ip_list as value to search EDL groups."},"response":[]},{"name":"Get specific network objects by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/network_objects/{{ids}}","description":"Fetches a single or partial list of the network objects for a given revision.
For group network objects, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision id
ids: Network object IDs separated by commas
show_members: Set to false to return only the name and ID of the members [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/779/network_objects/69548

Usage Example
https://192.168.1.1/securetrack/api/revisions/779/network_objects/69547,69548,69550

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/779/network_objects/69547?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"network_object\": {
            \"@xsi.type\": \"identityAwarenessDTO\",
            \"id\": 169185,
            \"name\": \"Access_Role_Domain Controllers\",
            \"display_name\": \"Access_Role_Domain Controllers\",
            \"class_name\": \"access_role\",
            \"type\": \"identity_awareness\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{140B8F32-188D-414C-A7BE-F4A7D7E9A169}\",
            \"implicit\": false,
            \"overrides\": false,
            \"type_on_device\": \"\",
            \"networks\": {
                \"network\": {
                    \"@xsi.type\": \"basicNetworkObjectDTO\",
                    \"id\": 168419,
                    \"name\": \"Any\",
                    \"display_name\": \"Any\",
                    \"class_name\": \"any_object\",
                    \"type\": \"basic\",
                    \"global\": false,
                    \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                    \"implicit\": false,
                    \"overrides\": false
                }
            },
            \"users\": {
                \"user\": {
                    \"id\": 14237,
                    \"name\": \"ad_group_Domain_Controllers\",
                    \"display_name\": \"Domain Controllers\",
                    \"class_name\": \"ad_group\",
                    \"global\": false,
                    \"comment\": \"\",
                    \"uid\": \"{0A8A459E-58E8-45DC-981E-16BBF2BD1922}\",
                    \"dn\": \"CN=Domain Controllers,CN=Users,DC=rnd,DC=local\"
                }
            }
        }
    }
}

"},"response":[]},{"name":"Get specific network object","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/network_objects/{{ids}}","description":"Fetches a single or partial list of the network objects for a given device ID.
For group network objects, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.
Note: This API retrieves the information from the latest revision.

Parameters:
context: Global MSSP context [optional]
device_id: Device ID
ids: Network object IDs separated by commas
show_members: Set to false to return only the name and ID of the members [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/network_objects/69548

Usage Example
https://192.168.1.1/securetrack/api/devices/31/network_objects/69547,69548,69550

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects/169184?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"network_object\": {
            \"@xsi.type\": \"identityAwarenessDTO\",
            \"id\": 169184,
            \"name\": \"Access_Role_@grp\",
            \"display_name\": \"Access_Role_@grp\",
            \"class_name\": \"access_role\",
            \"type\": \"identity_awareness\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{1870612C-0922-4AEE-81FF-5472DB7C32E1}\",
            \"implicit\": false,
            \"overrides\": false,
            \"type_on_device\": \"\",
            \"networks\": {
                \"network\": {
                    \"@xsi.type\": \"basicNetworkObjectDTO\",
                    \"id\": 168419,
                    \"name\": \"Any\",
                    \"display_name\": \"Any\",
                    \"class_name\": \"any_object\",
                    \"type\": \"basic\",
                    \"global\": false,
                    \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                    \"implicit\": false,
                    \"overrides\": false
                }
            },
            \"users\": {
                \"user\": {
                    \"id\": 14338,
                    \"name\": \"ad_group_grp\",
                    \"display_name\": \"@grp\",
                    \"class_name\": \"ad_group\",
                    \"global\": false,
                    \"comment\": \"\",
                    \"uid\": \"{C5740C23-F36E-4D2E-8B17-1F99C239C12A}\",
                    \"dn\": \"CN=@grp,OU=SC_Users,DC=test,DC=com\"
                }
            }
        }
    }
}

"},"response":[]}]},{"name":"Network Topology","item":[{"name":"Get generic devices that are configured in ST","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/","description":"Returns a list of the generic devices included in all the domains that the user has permission to.
Use context and/or name optional parameters to get more specific results.
To get context optional parameter, you can call /domains/ API and use the id included within the returned domain DTO.

Parameters:
context: Global MSSP context [optional]
name: Generic device name [optional]

Usage Example
https://192.168.1.1/securetrack/api/generic_devices
"},"response":[]},{"name":"Add generic device to Topology model","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"configuration_file"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/","description":"Upload a configuration file that will be used to add a generic device to the Topology model.
The context field is the domain ID to which the generic device is added: If not provided, the device is added to the global domain.
configuration_file must include a valid generic device configuration.
The specified path must point to a file on the computer being sue to make the REST API call.
If update update_topology = true, then the Topology model will be updated immediately after the device is added.
For maximum efficiency, if you are adding multiple generic devices in consecutive API calls, you can set update_topology = false on all API calls except for the last one. On the last call, set update_toplogy = true.Default value for update_topology = true.
For more information on input file formats, refer to Knowledge Center topic 'Adding and Updating a Generic Device'.

Parameters:
body: Generic device to be added
configuration_file: Configuration File for generic device
update_topology: Synchronize And Update Topology [optional]

Usage Example
curl -X POST -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F 'device_data={\"generic_device\":{\"name\": \"my_generic_device\", \"customer_id\": 1}};type=application/json' -F \"configuration_file=@/tmp/config.txt;type=application/octet-stream\" -F \"update_topology=true\" https://192.168.1.1/securetrack/api/generic_devices\n

Response Messages:
201: The generic device was created successfully
403: User is not permitted to access the specified domain
400: Failed to create generic device "},"response":[]},{"name":"Get cloud information","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"suggested_clouds\": {\n\t\t\"count\": 2,\n\t\t\"total\": 2,\n\t\t\"cloud\": [\n\t\t\t{\n\t\t\t\t\"management_name\": \"FW1\",\n\t\t\t\t\"management_id\": 20,\n\t\t\t\t\"cloud_name\": \"Cloud 10.100.0.1\",\n\t\t\t\t\"cloud_id\": 120,\n\t\t\t\t\"vertex_id\": 250,\n\t\t\t\t\"ip\": \"10.100.0.1\",\n\t\t\t\t\"routes_count\": 5,\n\t\t\t\t\"is_parent\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"management_name\": \"FW2\",\n\t\t\t\t\"management_id\": 21,\n\t\t\t\t\"cloud_name\": \"Cloud 172.16.0.1\",\n\t\t\t\t\"cloud_id\": 125,\n\t\t\t\t\"vertex_id\": 270,\n\t\t\t\t\"ip\": \"172.16.0.1\",\n\t\t\t\t\"routes_count\": 7,\n\t\t\t\t\"is_parent\": false,\n\t\t\t\t\"parent_vertex_id\": 40\n\t\t\t\t\"parent_cloud_id\": 45\n\t\t\t\t\"parent_cloud_name\": \"Cloud 172.16.0.1\",\n\t\t\t}\n\t\t]\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/cloud_suggestions","description":"Returns information about all clouds in the topology.
This API includes the ID of the cloud, the number of routes that point to the cloud, and the relevant devices (including the management_id) that have routes that point to the cloud.
This information can be used to identify missing devices that may need to be added to the topology or to identify clouds that are candidates for being joined.

Parameters:
context: Global MSSP context [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/cloud_suggestions
BODY{
    \"suggested_clouds\": {
        \"count\": 2,
        \"total\": 2,
        \"cloud\": [
            {
                \"management_name\": \"FW1\",
                \"management_id\": 20,
                \"cloud_name\": \"Cloud 10.100.0.1\",
                \"cloud_id\": 120,
                \"vertex_id\": 250,
                \"ip\": \"10.100.0.1\",
                \"routes_count\": 5,
                \"is_parent\": false
            },
            {
                \"management_name\": \"FW2\",
                \"management_id\": 21,
                \"cloud_name\": \"Cloud 172.16.0.1\",
                \"cloud_id\": 125,
                \"vertex_id\": 270,
                \"ip\": \"172.16.0.1\",
                \"routes_count\": 7,
                \"is_parent\": false,
                \"parent_vertex_id\": 40
                \"parent_cloud_id\": 45
                \"parent_cloud_name\": \"Cloud 172.16.0.1\",
            }
        ]
    }
}


Response Messages:
202: Accepted
403: User is not permitted to access the specified domain"},"response":[]},{"name":"Get topology network interfaces by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"mgmtId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/topology_interfaces","description":"The returned interfaces are taken from the topology data and will include only devices that are topology enabled.
When adding a device, the user can can choose whether to use dynamic or static topology for the device,
this choice will determine which kind of data is stored in the topology graph and returned by this API.

The parameter mgmtId should be a cluster or a gateway, not a management server.
You may provide a generic device Id (see generic_devices API under 'Monitored Devices' category) -
in this case make sure you set 'is_generic' parameter to 'true'

Parameters:
context: Global MSSP context [optional]
mgmtId: Management Id or Generic Device Id to query
is_generic: Should be set to 'true' if the provided mgmtId is related to generic device [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_interfaces?mgmtId=10

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_interfaces?mgmtId=1&is_generic=true
"},"response":[]},{"name":"Get most specific network interfaces from which a host IP is accessible","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"host"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/interfaces/last_hop","description":"Parameters:
context: Global MSSP context [optional]
host: IP address of device for a query

Usage Example
https://192.168.1.1/securetrack/api/devices/interfaces/last_hop?host=192.168.1.66
"},"response":[]},{"name":"Get topology routing tables for a given device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"mgmtId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/topology_routes","description":"The returned routing tables are taken from the topology data and will include only devices that are topology enabled.
When adding a device, the user can can choose whether to use dynamic or static topology for the device,
this choice will determine which kind of data is stored in the topology graph and returned by this API.

The parameter mgmtId should be a cluster or a gateway, not a management server.
You may provide a generic device Id (see generic_devices API under 'Monitored Devices' category) -
in this case make sure you set 'is_generic' parameter to 'true'

Parameters:
mgmtId: Management Id or Generic Device Id to query
is_generic: Should be set to 'true' if the provided mgmtId is related to generic device [optional]
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query from starting page, allowable type is numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_routes?mgmtId=10

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_routes?mgmtId=1&is_generic=true
"},"response":[]},{"name":"Get topology subnets","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/subnets","description":"Returns a list of the topology subnets for all the domains for which the user has permission to access.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
Use the optional name parameter to restrict the results to topology subnet names that match the search criteria provided, as follows:
1. If you provide only a mask, then an exact match search is done on the mask portion of the name
e.g. if name=/2, the results will include 1.2.3.4/2, but not 1.2.3.4/22
2. If you provide only a partial or complete IP address, then a contains search is done in the IPv4 block portion of the name
e.g. name=32, the results will include 192.168.205.32/24 and 55.192.32.22/16, but will not include 55.168.205.5/32
3. If you provide both an IPv4 address (either partial or complete) and a mask, then an exact match search is done
e.g. if name=23.4/2, then the results will include 192.168.23.4/2, but will not include 192.168.23.4/23 or 23.4.192.168/2

Use the optional ip parameter to restrict the results to topology subnets that contain this ip, see example below.

User can use ip or name parameter, not both.
The default pagination is start=0 and count=50.

Parameters:
context: Global MSSP context [optional]
name: Subnet name [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]
ip: Ip host [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/subnets?name=10.27
OUTPUT{
    \"topology_subnets\": {
        \"count\": 4,
        \"total\": 4,
        \"subnets\": [
            {
                \"id\": 615,
                \"name\": \"10.27.122.20/32\",
                \"ip\": \"10.27.122.20\",
                \"mask\": \"255.255.255.255\",
                \"domainIdTag\": 1
            },
            {
                \"id\": 616,
                \"name\": \"10.27.122.60/32\",
                \"ip\": \"10.27.122.60\",
                \"mask\": \"255.255.255.255\",
                \"domainIdTag\": 1
            },
            {
                \"id\": 619,
                \"name\": \"10.27.122.0/30\",
                \"ip\": \"10.27.122.0\",
                \"mask\": \"255.255.255.252\",
                \"domainIdTag\": 1
            },
            {
                \"id\": 620,
                \"name\": \"10.27.122.4/30\",
                \"ip\": \"10.27.122.4\",
                \"mask\": \"255.255.255.252\",
                \"domainIdTag\": 1
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/subnets?name=144/30
OUTPUT{
    \"topology_subnets\": {
        \"count\": 2,
        \"total\": 2,
        \"subnets\": [
            {
                \"id\": 773,
                \"name\": \"10.13.64.144/30\",
                \"ip\": \"10.13.64.144\",
                \"mask\": \"255.255.255.252\",
                \"domainIdTag\": 1
            },
            {
                \"id\": 825,
                \"name\": \"10.15.64.144/30\",
                \"ip\": \"10.15.64.144\",
                \"mask\": \"255.255.255.252\",
                \"domainIdTag\": 1
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/subnets?ip=10.27.122.3
OUTPUT{
    \"topology_subnets\": {
        \"count\": 4,
        \"total\": 4,
        \"subnets\": [
            {
                \"id\": 615,
                \"name\": \"10.27.122.0/24\",
                \"ip\": \"10.27.122.0\",
                \"mask\": \"255.255.255.0\",
                \"domainIdTag\": 1
            },
            {
                \"id\": 616,
                \"name\": \"10.27.0.0/16\",
                \"ip\": \"10.27.0.0\",
                \"mask\": \"255.255.0.0\",
                \"domainIdTag\": 1
            },
            {
                \"id\": 619,
                \"name\": \"10.0.0.0/8\",
                \"ip\": \"10.0.0.0\",
                \"mask\": \"255.0.0.0\",
                \"domainIdTag\": 1
            },
        ]
    }
}


Response Messages:
403: Access is denied
403: Only users with ‘Super admin’ permissions can access Global domain map
403: You do not have access permission to domain id: domainId
403: Using name and ip parameters is not allowed
403: Using Ipv6 in ip parameter is not supported
403: Ip parameter is not valid"},"response":[]},{"name":"Delete Join Cloud","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/join/clouds/{{cloudId}}","description":"Delete Join Cloud by Id.

Parameters:
cloudId [optional]
forceTopologyInit: Force Topology Init [optional]

Usage Example
https://{st_host}/securetrack/api/topology/join/clouds/67\n

Response Messages:
204: No Content.
400: Bad Request.
403: Access is denied.
404: Cloud Not Found.
500: General error occurred."},"response":[]},{"name":"Get Join Cloud","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/join/clouds/{{cloudId}}","description":"Get Join Cloud by Id.

Parameters:
cloudId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/join/clouds/67
OUTPUT{
    id: 67,
    name: \"Yami\",
    clouds: [
        1,
        2,
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Cloud Not Found.
500: General error occurred."},"response":[]},{"name":"Create generic Routes","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"GenericRoutes\": [\n\t{\n\t\t\"mgmtId\": 1,\n\t\t\"destination\": \"111.100.10.11\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"interfaceName\": \"YOLO3\",\n\t\t\"nextHop\": \"100.100.10.10\",\n\t\t\"nextHopType\": \"IP\",\n\t\t\"vrf\": \"V103-KO\"\n\t},\n\t{\n\t\t\"mgmtId\": 2,\n\t\t\"destination\": \"222.100.10.22\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"interfaceName\": \"catch22\",\n\t\t\"nextHop\": \"100.100.10.10\",\n\t\t\"nextHopType\": \"IP\",\n\t\t\"vrf\": \"V103-KO\"\n\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/","description":"Create generic Routes.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/route
BODY{
    \"GenericRoutes\": [
    {
        \"mgmtId\": 1,
        \"destination\": \"111.100.10.11\",
        \"mask\": \"255.255.0.0\",
        \"interfaceName\": \"YOLO3\",
        \"nextHop\": \"100.100.10.10\",
        \"nextHopType\": \"IP\",
        \"vrf\": \"V103-KO\"
    },
    {
        \"mgmtId\": 2,
        \"destination\": \"222.100.10.22\",
        \"mask\": \"255.255.0.0\",
        \"interfaceName\": \"catch22\",
        \"nextHop\": \"100.100.10.10\",
        \"nextHopType\": \"IP\",
        \"vrf\": \"V103-KO\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management Not Found.
500: General error occurred."},"response":[]},{"name":"Update generic Routes","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"GenericRoutes\": [\n\t{\n\t\t\"id\": 29,\n\t\t\"mgmtId\": 3,\n\t\t\"destination\": \"111.100.10.11\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"interfaceName\": \"YOLO3\",\n\t\t\"nextHop\": \"100.100.10.10\",\n\t\t\"nextHopType\": \"IP\",\n\t\t\"vrf\": \"V103-KO\"\n\t},\n\t{\n\t\t\"id\": 30,\n\t\t\"mgmtId\": 3,\n\t\t\"destination\": \"222.100.10.22\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"interfaceName\": \"catch22\",\n\t\t\"nextHop\": \"100.100.10.10\",\n\t\t\"nextHopType\": \"IP\",\n\t\t\"vrf\": \"V103-KO\"\n\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/","description":"Update generic Routes.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/route
BODY{
    \"GenericRoutes\": [
    {
        \"id\": 29,
        \"mgmtId\": 3,
        \"destination\": \"111.100.10.11\",
        \"mask\": \"255.255.0.0\",
        \"interfaceName\": \"YOLO3\",
        \"nextHop\": \"100.100.10.10\",
        \"nextHopType\": \"IP\",
        \"vrf\": \"V103-KO\"
    },
    {
        \"id\": 30,
        \"mgmtId\": 3,
        \"destination\": \"222.100.10.22\",
        \"mask\": \"255.255.0.0\",
        \"interfaceName\": \"catch22\",
        \"nextHop\": \"100.100.10.10\",
        \"nextHopType\": \"IP\",
        \"vrf\": \"V103-KO\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Interface/Management Not Found.
500: General error occurred."},"response":[]},{"name":"Delete generic Routes","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/mgmt/{{mgmtId}}","description":"Delete all generic Routes from management Id.

Parameters:
mgmtId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/route/mgmt/2\n

Response Messages:
200: 11 Generic Routes were deleted from mgmtId 2.
400: Bad Request.
403: Access is denied.
404: Management Not Found.
500: General error occurred."},"response":[]},{"name":"Get generic Routes","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/mgmt/{{mgmtId}}","description":"Get generic Routes of management Id.

Parameters:
mgmtId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/route/mgmt/2
OUTPUT{
    GenericRoutes: [
    {
        id: 27,
        mgmtId: 2,
        destination: \"10.4.4.4\",
        mask: \"255.0.0.0\",
        interfaceName: \"\",
        nextHop: \"AA\",
        nextHopType: \"VR\",
        vrf: \"V102-YO\"
    },
    {
        id: 28,
        mgmtId: 2,
        destination: \"10.4.5.5\",
        mask: \"255.0.0.0\",
        interfaceName: \"eeee\",
        nextHop: \"\",
        nextHopType: \"IP\",
        vrf: \"V101-PA\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management Not Found.
500: General error occurred."},"response":[]},{"name":"Update an existing generic device in the Topology model","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/{{id}}","description":"Modify an existing generic device by uploading a new configuration file and/or specifying a new name.
If name field is specified, the generic device will be renamed.
configuration_file is optional, if provided it must include a valid generic device configuration.
The specified path points to a file in the client machine.
If a generic device name is changed and a new configuration file is not provided, topology will not be synchronized (update_topology flag is ignored).
Default value for update_topology = true.
To save time when there are several consecutive api calls: For the last call, set update_topology = true (for all other calls, update_topology = false).
For more information on input file formats, refer to Knowledge Center topic 'Adding and Updating a Generic Device'.

Parameters:
id: Generic device id
body: Generic device to be updated [optional]
configuration_file: Configuration File for generic device [optional]
update_topology: Synchronize And Update Topology [optional]

Usage Example
curl -X PUT -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F \"configuration_file=@/tmp/config.txt;type=application/octet-stream\" -F \"update_topology=true\" https://192.168.1.1/securetrack/api/generic_devices/24

Usage Example
curl -X PUT -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F 'device_data={\"generic_device\":{\"name\": \"new_generic_device_name\"}};type=application/json' -F \"update_topology=false\" https://192.168.1.1/securetrack/api/generic_devices/72

Response Messages:
204: The generic device was updated successfully.
400: A new name or a new configuration file must be indicated in order to update generic device with id {}
400: Failed to update generic device with id {}
404: A 'Generic Device' with the specified ID was not found"},"response":[]},{"name":"Delete generic device from Topology model","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/{{id}}","description":"Delete a generic device from the Topology model.
The ID must be for a valid generic device listed in the Topology Model.
If update update_topology = true, then the Topology model will be updated immediately after the device is deleted.
For maximum efficiency, if you are deleting multiple generic devices in consecutive API calls, you can set update_topology = false on all API calls except for the last one. On the last call, set update_toplogy = true.
Default value for update_topology = true.

Parameters:
id: Generic device id
update_topology: Synchronize And Update Topology [optional]

Usage Example
https://192.168.1.1/securetrack/api/generic_devices/1

Usage Example
https://192.168.1.1/securetrack/api/generic_devices/10?update_topology=false

Response Messages:
204: Generic Device deleted successfully.
400: Failed to delete generic device with id {}
404: A 'Generic Device' with the specified ID was not found"},"response":[]},{"name":"Get path image for specified traffic","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"src"},{"value":null,"type":"text","key":"dst"},{"value":null,"type":"text","key":"service"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/path_image","description":"Returns an image containing one or more paths for the specified traffic.
src and dst parameters may contain multiple, comma separated values.
Service parameter can be a port (for example, “tcp:80”, “any”) or an application (for example, “Skype”, “Facebook”).
Application names are case sensitive.
Service parameter can also be a combination of ports and applications, for example “tcp:80, Skype, Facebook”
If sourceDomainIdTag is provided, the path starting points will be restricted to the specified domain ID. sourceDomainIdTag is valid only if overlapping IP mode is enabled.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is valid only if MSSP mode is enabled.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.
displayIncompletePaths parameter default value is false, if this parameter is set to true -
all nodes on the path will be displayed, even if the node cannot reach the destination, or if the source and destination are the same.
displayBlockedStatus parameter default value is false, if this parameter is set to true -
blocked traffic icons will be displayed next to devices blocking the traffic.
simulateNat parameter default value is true if this parameter is set to false - NAT simulation will not be used when calculating the path.
lastInstall parameter default value is true, which means simulation would use last installed policies. If this parameter is set to false - simulation would use last saved policies.
This API cannot be executed more than 10 times in parallel.

Parameters:
context: Global MSSP context [optional]
src: Source address/addresses
dst: Destination address/addresses
service: Service/services
sourceDomainIdTag: Path starting point Domain Id [optional]
displayIncompletePaths: Display incomplete paths [optional]
displayBlockedStatus: Display blocked traffic status icons [optional]
simulateNat: Simulate NAT [optional]
lastInstall: Last Installed [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/path_image?src=10.10.10.1&dst=3.3.3.3:32&service=any

Usage Example
https://192.168.1.1/securetrack/api/topology/path_image?src=10.10.10.1&dst=3.3.3.3:32&service=Facebook,tcp:80
"},"response":[]},{"name":"Delete generic Interface","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface/{{inId}}","description":"Delete a generic Interface by Id.

Parameters:
inId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/interface/5\n

Response Messages:
204: No Content.
400: Bad Request.
403: Access is denied.
404: Generic Interface Not Found.
500: General error occurred."},"response":[]},{"name":"Get generic Interface","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface/{{inId}}","description":"Get a generic Interface by Id.

Parameters:
inId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interface/212
OUTPUT{
    GenericInterface: {
        id: 212,
        mgmtId: 1,
        name: \"newApo5\",
        ip: \"100.103.33.33\",
        mask: \"255.255.255.0\",
        vrf: \"V101-PAL\",
        mpls: false,
        unnumbered: false,
        type: \"external\"
    }
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Generic Interface Not Found.
500: General error occurred."},"response":[]},{"name":"Get generic Interfaces","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface/mgmt/{{mgmtId}}","description":"Get generic Interfaces of management Id.

Parameters:
mgmtId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interface/mgmt/1
OUTPUT{
    GenericInterfaces: [
    {
        id: 206,
        mgmtId: 1,
        name: \"newApo3\",
        ip: \"100.103.33.33\",
        mask: \"255.255.255.0\",
        vrf: \"V101-PA\",
        mpls: false,
        unnumbered: false,
        type: \"external\"
    },
    {
        id: 208,
        mgmtId: 1,
        name: \"newApo4\",
        ip: \"100.103.33.34\",
        mask: \"255.255.255.0\",
        vrf: \"V101-PA\",
        mpls: false,
        unnumbered: false,
        type: \"internal\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management Not Found.
500: General error occurred."},"response":[]},{"name":"Delete generic Interfaces","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface/mgmt/{{mgmtId}}","description":"Delete all generic Interfaces from management Id.

Parameters:
mgmtId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/interface/mgmt/2\n

Response Messages:
200: 11 Generic Interfaces were deleted from mgmtId 2.
400: Bad Request.
403: Access is denied.
404: Management Not Found.
500: General error occurred."},"response":[]},{"name":"Update manual Interface CustomerTags","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"InterfaceCustomerTags\": \n\t[\n\t\t{\n\t\t\t\"id\": 73,\n\t\t\t\"generic\": false,\n\t\t\t\"deviceId\": 5,\n\t\t\t\"interfaceName\": \"port5\",\n\t\t\t\"customerId\": 2\n\t\t},\n\t\t{\n\t\t\t\"id\": 74,\n\t\t\t\"generic\": false,\n\t\t\t\"deviceId\": 5,\n\t\t\t\"interfaceName\": \"port3\",\n\t\t\t\"customerId\": 3\n\t\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/","description":"Update manual Interface CustomerTags.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interfacecustomer
BODY{
    \"InterfaceCustomerTags\":
    [
        {
            \"id\": 73,
            \"generic\": false,
            \"deviceId\": 5,
            \"interfaceName\": \"port5\",
            \"customerId\": 2
        },
        {
            \"id\": 74,
            \"generic\": false,
            \"deviceId\": 5,
            \"interfaceName\": \"port3\",
            \"customerId\": 3
        }
    ]
}


Response Messages:
200: OK.
400: Interface CustomerTag already exist for deviceId-InterfaceName/Interface not found on deviceId
403: Access is denied.
404: Management/GenericDevice Not Found./Customer Id not found.
500: General error occurred."},"response":[]},{"name":"Create manual Interface CustomerTags","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"InterfaceCustomerTags\": \n\t[\n\t\t{\n\t\t\t\"generic\": false,\n\t\t\t\"deviceId\": 5,\n\t\t\t\"interfaceName\": \"port4\",\n\t\t\t\"customerId\": 2\n\t\t},\n\t\t{\n\t\t\t\"generic\": false,\n\t\t\t\"deviceId\": 6,\n\t\t\t\"interfaceName\": \"port3\",\n\t\t\t\"customerId\": 3\n\t\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/","description":"Create manual Interface CustomerTags.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interfacecustomer
BODY{
    \"InterfaceCustomerTags\":
    [
        {
            \"generic\": false,
            \"deviceId\": 5,
            \"interfaceName\": \"port4\",
            \"customerId\": 2
        },
        {
            \"generic\": false,
            \"deviceId\": 6,
            \"interfaceName\": \"port3\",
            \"customerId\": 3
        }
    ]
}


Response Messages:
200: OK.
400: Interface CustomerTag already exist for deviceId-InterfaceName/Interface not found on deviceId
403: Access is denied.
404: Management/GenericDevice Not Found./Customer Id not found.
500: General error occurred."},"response":[]},{"name":"Delete manual Interface CustomerTags","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/device/{{deviceId}}","description":"Delete all manual Interface CustomerTags from management/genericDevice Id.

Parameters:
deviceId [optional]
generic [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/interfacecustomer/device/6?generic=false\n

Response Messages:
200: 2 Interface Customers were deleted from deviceId 6.
400: Bad Request.
403: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred."},"response":[]},{"name":"Get manual Interface CustomerTags","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/device/{{deviceId}}","description":"Get manual Interface CustomerTags of management/genericDevice Id.

Parameters:
deviceId [optional]
generic [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interfacecustomer/device/5?generic=false
OUTPUT{
    InterfaceCustomerTags: [
        {
            id: 73,
            generic: false,
            deviceId: 5,
            interfaceName: \"port4\",
            customerId: 2
        },
        {
            id: 74,
            generic: false,
            deviceId: 5,
            interfaceName: \"port4.1\",
            customerId: 3
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred."},"response":[]},{"name":"Update a cloud","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"cloud_data\":{\n\t\t\"cloud_name\" : \"new cloud\",\n\t\t\"cloud_members\" : [118,179,258]\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds/{{id}}","description":"Modify the name of a topology cloud, and add/remove members of a joined cloud.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
Multi-Domain user must have access permission to the domain context of the joined cloud, and any members specified in the body.
To change the name of a topology cloud, enter a value in the name field of the body.
To add/remove members of a joined cloud, specify the action and specify the clouds in the members list of the body.
The action is used only if the body contains a members list. If a members list is provided but no actions is specified, then the default action is ‘add’.
When adding cloud members, clouds included in the members list of the body must not be joined clouds or members of another joined cloud.
When removing cloud members, if only zero or one member remains in the joined cloud, it will be deleted from the Interactive Map.

Parameters:
id: cloud id
action: action [optional]
body: Cloud data
forceTopologyInit: Force Topology Init [optional]

Usage Example
URLfor renaming of any cloud - https://192.168.1.1/securetrack/api/topology/clouds/436
BODY{
    \"cloud_data\":{
        \"cloud_name\" : \"new cloud\"
    }
}


Usage Example
URLfor renaming and members updating of a joined cloud - https://192.168.1.1/securetrack/api/topology/clouds/436?action=remove
BODY{
    \"cloud_data\":{
        \"cloud_name\" : \"new cloud\",
        \"cloud_members\" : [118,179,258]
    }
}


Response Messages:
204: Cloud updated successfully
403: Access is denied
403: You do not have access permission to the domain for cloud with id ID
404: Cloud with id ID was not found in the provided MSSP domain
412: Cloud with id ID is a not joined cloud
412: Cloud id: cloudId does not belong to domain: Context
412: Provided clouds don't belongs to the same domain
412: Cloud with id ID is a joined cloud
412: Cloud with id ID is a member of a joined cloud
412: Member cloud with id ID cannot be removed - it is not a member of a joined cloud"},"response":[]},{"name":"Get Specific topology cloud","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds/{{id}}","description":"Returns the topology cloud data for the specified id.
This API requires 'Super admin' or 'Multi-Domain admin' privileges.
Multi-Domain user must have access permission to the domain where the cloud resides.

Parameters:
id: Cloud id

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds/48
OUTPUT{
    \"topology_cloud\": {
        \"id\": 48,
        \"name\": \"Cloud 69.70.120.155\",
        \"domain\": 1,
        \"type\": \"NON_JOINED\",
        \"ip\": \"69.70.120.155\"
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds/66
OUTPUT{
    \"topology_cloud\": {
        \"id\": 66,
        \"name\": \"Cloud 10.100.10.14\",
        \"domain\": 1,
        \"type\": \"JOINED\",
        \"members\": [
            {
                \"id\": 50,
                \"ip\": \"10.100.6.238\",
                \"name\": \"Cloud 10.100.6.238\"
            },
            {
                \"id\": 73,
                \"ip\": \"10.100.10.14\",
                \"name\": \"Cloud 10.100.10.14\"
            },
            {
                \"id\": 74,
                \"ip\": \"10.100.9.9\",
                \"name\": \"Cloud 10.100.9.9\"
            }
        ]
    }
}


Response Messages:
403: Access is denied
403: You do not have access permission to the domain for cloud with id ID
404: No cloud was found for the provided ID"},"response":[]},{"name":"Update generic Interfaces","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"GenericInterfaces\": [\n\t{\n\t\t\"id\": 204,\n\t\t\"mgmtId\": 1,\n\t\t\"name\": \"NewBob1\",\n\t\t\"ip\": \"100.100.45.55\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"vrf\": \"V101-LV\",\n\t\t\"mpls\": false,\n\t\t\"unnumbered\": false,\n\t\t\"type\": null\n\t},\n\t{\n\t\t\"id\": 205,\n\t\t\"mgmtId\": 2,\n\t\t\"name\": \"NewBob2\",\n\t\t\"ip\": \"100.100.45.55\",\n\t\t\"mask\": \"255.255.255.0\",\n\t\t\"vrf\": \"V101-LV\",\n\t\t\"mpls\": false,\n\t\t\"unnumbered\": false,\n\t\t\"type\": \"external\"\n\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface","description":"Update generic Interfaces.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interface
BODY{
    \"GenericInterfaces\": [
    {
        \"id\": 204,
        \"mgmtId\": 1,
        \"name\": \"NewBob1\",
        \"ip\": \"100.100.45.55\",
        \"mask\": \"255.255.0.0\",
        \"vrf\": \"V101-LV\",
        \"mpls\": false,
        \"unnumbered\": false,
        \"type\": null
    },
    {
        \"id\": 205,
        \"mgmtId\": 2,
        \"name\": \"NewBob2\",
        \"ip\": \"100.100.45.55\",
        \"mask\": \"255.255.255.0\",
        \"vrf\": \"V101-LV\",
        \"mpls\": false,
        \"unnumbered\": false,
        \"type\": \"external\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Interface/Management Not Found.
500: General error occurred."},"response":[]},{"name":"Create generic Interfaces","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"GenericInterfaces\": [\n\t{\n\t\t\"mgmtId\": 1,\n\t\t\"name\": \"Bob1\",\n\t\t\"ip\": \"100.100.45.55\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"vrf\": \"V101-PA\",\n\t\t\"mpls\": false,\n\t\t\"unnumbered\": false,\n\t\t\"type\": \"external\"\n\t},\n\t{\n\t\t\"mgmtId\": 2,\n\t\t\"name\": \"Bob2\",\n\t\t\"ip\": \"100.100.45.66\",\n\t\t\"mask\": \"255.255.255.0\",\n\t\t\"vrf\": \"V101-BA\",\n\t\t\"mpls\": false,\n\t\t\"unnumbered\": false,\n\t\t\"type\": \"external\"\n\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface","description":"Create generic Interfaces.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interface
BODY{
    \"GenericInterfaces\": [
    {
        \"mgmtId\": 1,
        \"name\": \"Bob1\",
        \"ip\": \"100.100.45.55\",
        \"mask\": \"255.255.0.0\",
        \"vrf\": \"V101-PA\",
        \"mpls\": false,
        \"unnumbered\": false,
        \"type\": \"external\"
    },
    {
        \"mgmtId\": 2,
        \"name\": \"Bob2\",
        \"ip\": \"100.100.45.66\",
        \"mask\": \"255.255.255.0\",
        \"vrf\": \"V101-BA\",
        \"mpls\": false,
        \"unnumbered\": false,
        \"type\": \"external\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management Not Found.
500: General error occurred."},"response":[]},{"name":"Get path domains for specified traffic","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"src"},{"value":null,"type":"text","key":"dst"},{"value":null,"type":"text","key":"service"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/path_domains","description":"Returns one or more domain entries for the specified traffic.
src and dst parameters may contain multiple, comma separated values.
Service parameter can be a port (for example, “tcp:80”, “any”) or an application (for example, “Skype”, “Facebook”).
Application names are case sensitive.
Service parameter can also be a combination of ports and applications, for example “tcp:80, Skype, Facebook”
If sourceDomainIdTag is provided, the path starting points will be restricted to the specified domain ID. sourceDomainIdTag is valid only if overlapping IP mode is enabled.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is valid only if MSSP mode is enabled.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.
includeIncompletePaths parameter default value is false, if this parameter is set to true -
all nodes on the path will be included, even if the node cannot reach the destination, or if the source and destination are the same.
simulateNat parameter default value is true if this parameter is set to false - NAT simulation will not be used when calculating the path.
lastInstall parameter default value is true, which means simulation would use last installed policies. If this parameter is set to false - simulation would use last saved policies.
This API cannot be executed more than 10 times in parallel.

Parameters:
context: Global MSSP context [optional]
src: Source address/addresses
dst: Destination address/addresses
service: Service/services
sourceDomainIdTag: Path starting point Domain Id [optional]
includeIncompletePaths: Include incomplete paths [optional]
simulateNat: Simulate NAT [optional]
lastInstall: Last Installed [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/path_domains?src=10.10.10.1&dst=3.3.3.3:32&service=any

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/path_domains?src=10.0.2.1&dst=10.0.1.1&service=Facebook,tcp:80
OUTPUT {
    \"path_domain_entries\": {
        \"path_domain_entry\": [
                {
                        \"domainId\": \"1\",
                        \"vertex\": \"Subnet 10.0.2.0/24\",
                        \"entryType\": \"STARTING_POINT\",
                }
                {
                        \"domainId\": \"1\",
                        \"vertex\": \"Subnet 10.0.1.0/24\",
                        \"entryType\": \"ENDING_POINT\",
                }
    ]
}

"},"response":[]},{"name":"Get manual Interface CustomerTag","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/{{interfaceCustomerId}}","description":"Get manual Interface CustomerTag by Id.

Parameters:
interfaceCustomerId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interfacecustomer/74
OUTPUT{
    InterfaceCustomerTag: {
        id: 74,
        generic: false,
        deviceId: 5,
        interfaceName: \"port4.1\",
        customerId: 3
    }
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: InterfaceCustomer Id 74 not found.
500: General error occurred."},"response":[]},{"name":"Delete manual Interface CustomerTag","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/{{interfaceCustomerId}}","description":"Delete a manual Interface CustomerTag by Id.

Parameters:
interfaceCustomerId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/interfacecustomer/66\n

Response Messages:
204: No Content.
400: Bad Request.
403: Access is denied.
404: InterfaceCustomer Id 66 not found
500: General error occurred."},"response":[]},{"name":"Get Ignored Interfaces.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/ignoredinterface/mgmt/{{mgmtId}}","description":"Get Ignored Interfaces by management id.

Parameters:
mgmtId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/ignoredinterface/mgmt/10
OUTPUT{
    IgnoredInterfaces: [
        {
            interfaceName: \"eth2\",
            mgmtId: 10,
            ip: \"0.0.0.0\"
        },
        {
            interfaceName: \"loopback100\",
            mgmtId: 10,
            ip: \"34.34.34.34\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
500: General error occurred."},"response":[]},{"name":"Delete Ignored Interfaces.","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/ignoredinterface/mgmt/{{mgmtId}}","description":"Delete Ignored Interfaces by management id.

Parameters:
mgmtId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/ignoredinterface/mgmt/10\n

Response Messages:
200: 2 entries deleted where mgmtId = 10
400: Bad Request.
403: Access is denied.
404: Management Id 10 not found.
500: General error occurred."},"response":[]},{"name":"Create Ignored Interfaces.","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"IgnoredInterfaces\": \n\t[\n\t\t{\n\t\t\t\"interfaceName\" : \"eth2\",\n\t\t\t\"mgmtId\" : 10,\n\t\t\t\"ip\" : \"0.0.0.0\"\n\t\t},\n\t\t{\n\t\t\t\"interfaceName\" : \"loopback100\",\n\t\t\t\"mgmtId\" : 10,\n\t\t\t\"ip\" : \"34.34.34.34\"\n\t\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/ignoredinterface","description":"Create Ignored Interfaces.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/ignoredinterface
BODY{
    \"IgnoredInterfaces\":
    [
        {
            \"interfaceName\" : \"eth2\",
            \"mgmtId\" : 10,
            \"ip\" : \"0.0.0.0\"
        },
        {
            \"interfaceName\" : \"loopback100\",
            \"mgmtId\" : 10,
            \"ip\" : \"34.34.34.34\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management Id 10 not found.
500: General error occurred."},"response":[]},{"name":"Update generic Vpns","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"GenericVpns\": [\n\t{\n\t\t\"id\": 24,\n\t\t\"generic\": true,\n\t\t\"deviceId\": 3,\n\t\t\"interfaceName\": \"new33\",\n\t\t\"vpnName\": null,\n\t\t\"tunnelSourceIpAddr\": \"3.3.3.33\",\n\t\t\"tunnelDestIpAddr\": \"1.1.1.11\"\n\t},\n\t{\n\t\t\"id\": 25,\n\t\t\"generic\": false,\n\t\t\"deviceId\": 1,\n\t\t\"interfaceName\": \"new111\",\n\t\t\"vpnName\": null,\n\t\t\"tunnelSourceIpAddr\": \"1.1.1.11\",\n\t\t\"tunnelDestIpAddr\": \"3.3.3.33\"\n\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/","description":"Update generic Vpns.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/vpn
BODY{
    \"GenericVpns\": [
    {
        \"id\": 24,
        \"generic\": true,
        \"deviceId\": 3,
        \"interfaceName\": \"new33\",
        \"vpnName\": null,
        \"tunnelSourceIpAddr\": \"3.3.3.33\",
        \"tunnelDestIpAddr\": \"1.1.1.11\"
    },
    {
        \"id\": 25,
        \"generic\": false,
        \"deviceId\": 1,
        \"interfaceName\": \"new111\",
        \"vpnName\": null,
        \"tunnelSourceIpAddr\": \"1.1.1.11\",
        \"tunnelDestIpAddr\": \"3.3.3.33\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Vpn/Management/GenericDevice Not Found.
500: General error occurred."},"response":[]},{"name":"Create generic Vpns","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"GenericVpns\": [\n\t{\n\t\t\"generic\": true,\n\t\t\"deviceId\": 3,\n\t\t\"interfaceName\": \"33\",\n\t\t\"vpnName\": null,\n\t\t\"tunnelSourceIpAddr\": \"3.3.3.33\",\n\t\t\"tunnelDestIpAddr\": \"1.1.1.11\"\n\t},\n\t{\n\t\t\"generic\": false,\n\t\t\"deviceId\": 1,\n\t\t\"interfaceName\": \"111\",\n\t\t\"vpnName\": null,\n\t\t\"tunnelSourceIpAddr\": \"1.1.1.11\",\n\t\t\"tunnelDestIpAddr\": \"3.3.3.33\"\n\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/","description":"Create generic Vpns.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/vpn
BODY{
    \"GenericVpns\": [
    {
        \"generic\": true,
        \"deviceId\": 3,
        \"interfaceName\": \"33\",
        \"vpnName\": null,
        \"tunnelSourceIpAddr\": \"3.3.3.33\",
        \"tunnelDestIpAddr\": \"1.1.1.11\"
    },
    {
        \"generic\": false,
        \"deviceId\": 1,
        \"interfaceName\": \"111\",
        \"vpnName\": null,
        \"tunnelSourceIpAddr\": \"1.1.1.11\",
        \"tunnelDestIpAddr\": \"3.3.3.33\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred."},"response":[]},{"name":"Create Transparent Firewalls","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"TransparentFirewalls\": \n\t[\n\t {\n\t\t\t\"outputL3DeviceId\" : 22,\n\t\t\t\"outputL3IsGenericDevice\" : false,\n\t\t\t\"outputL3InterfaceName\" : \"FastEthernet0/0\",\n\t\t\t\"outputL3InterfaceIp\" : \"\",\n\t\t\t\"layer2DeviceId\" : 21,\n\t\t\t\"inputL2InterfaceName\" : \"inside\",\n\t\t\t\"outputL2InterfaceName\" : \"outside\",\n\t\t\t\"inputL3DeviceId\" : 20,\n\t\t\t\"inputL3IsGenericDevice\" : false,\n\t\t\t\"inputL3InterfaceName\" : \"Loopback0\",\n\t\t\t\"inputL3InterfaceIp\" : \"\"\n\t\t},\n\t\t{\n\t\t\t\"outputL3DeviceId\" : 23,\n\t\t\t\"outputL3IsGenericDevice\" : false,\n\t\t\t\"outputL3InterfaceName\" : \"FastEthernet2/0\",\n\t\t\t\"outputL3InterfaceIp\" : \"\",\n\t\t\t\"layer2DeviceId\" : 9,\n\t\t\t\"inputL2InterfaceName\" : \"inside\",\n\t\t\t\"outputL2InterfaceName\" : \"outside\",\n\t\t\t\"inputL3DeviceId\" : 17,\n\t\t\t\"inputL3IsGenericDevice\" : false,\n\t\t\t\"inputL3InterfaceName\" : \"mgmt\",\n\t\t\t\"inputL3InterfaceIp\" : \"\"\n\t\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw","description":"Create Transparent Firewalls.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/transparentfw
BODY{
    \"TransparentFirewalls\":
    [
     {
            \"outputL3DeviceId\" : 22,
            \"outputL3IsGenericDevice\" : false,
            \"outputL3InterfaceName\" : \"FastEthernet0/0\",
            \"outputL3InterfaceIp\" : \"\",
            \"layer2DeviceId\" : 21,
            \"inputL2InterfaceName\" : \"inside\",
            \"outputL2InterfaceName\" : \"outside\",
            \"inputL3DeviceId\" : 20,
            \"inputL3IsGenericDevice\" : false,
            \"inputL3InterfaceName\" : \"Loopback0\",
            \"inputL3InterfaceIp\" : \"\"
        },
        {
            \"outputL3DeviceId\" : 23,
            \"outputL3IsGenericDevice\" : false,
            \"outputL3InterfaceName\" : \"FastEthernet2/0\",
            \"outputL3InterfaceIp\" : \"\",
            \"layer2DeviceId\" : 9,
            \"inputL2InterfaceName\" : \"inside\",
            \"outputL2InterfaceName\" : \"outside\",
            \"inputL3DeviceId\" : 17,
            \"inputL3IsGenericDevice\" : false,
            \"inputL3InterfaceName\" : \"mgmt\",
            \"inputL3InterfaceIp\" : \"\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Device Id 23 not found.
500: General error occurred."},"response":[]},{"name":"Update Transparent Firewalls","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"TransparentFirewalls\": \n\t[\n\t {\n\t\t\t\"id\" : 25,\n\t\t\t\"outputL3DeviceId\" : 22,\n\t\t\t\"outputL3IsGenericDevice\" : false,\n\t\t\t\"outputL3InterfaceName\" : \"FastEthernet0/0\",\n\t\t\t\"outputL3InterfaceIp\" : \"\",\n\t\t\t\"layer2DeviceId\" : 21,\n\t\t\t\"inputL2InterfaceName\" : \"inside\",\n\t\t\t\"outputL2InterfaceName\" : \"outside\",\n\t\t\t\"inputL3DeviceId\" : 20,\n\t\t\t\"inputL3IsGenericDevice\" : false,\n\t\t\t\"inputL3InterfaceName\" : \"Loopback2\",\n\t\t\t\"inputL3InterfaceIp\" : \"\"\n\t\t},\n\t\t{\n\t\t\t\"id\" : 27,\n\t\t\t\"outputL3DeviceId\" : 23,\n\t\t\t\"outputL3IsGenericDevice\" : false,\n\t\t\t\"outputL3InterfaceName\" : \"FastEthernet2/0\",\n\t\t\t\"outputL3InterfaceIp\" : \"\",\n\t\t\t\"layer2DeviceId\" : 9,\n\t\t\t\"inputL2InterfaceName\" : \"inside\",\n\t\t\t\"outputL2InterfaceName\" : \"outside\",\n\t\t\t\"inputL3DeviceId\" : 17,\n\t\t\t\"inputL3IsGenericDevice\" : false,\n\t\t\t\"inputL3InterfaceName\" : \"mgmt2\",\n\t\t\t\"inputL3InterfaceIp\" : \"\"\n\t\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw","description":"Update Transparent Firewalls.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/transparentfw
BODY{
    \"TransparentFirewalls\":
    [
     {
            \"id\" : 25,
            \"outputL3DeviceId\" : 22,
            \"outputL3IsGenericDevice\" : false,
            \"outputL3InterfaceName\" : \"FastEthernet0/0\",
            \"outputL3InterfaceIp\" : \"\",
            \"layer2DeviceId\" : 21,
            \"inputL2InterfaceName\" : \"inside\",
            \"outputL2InterfaceName\" : \"outside\",
            \"inputL3DeviceId\" : 20,
            \"inputL3IsGenericDevice\" : false,
            \"inputL3InterfaceName\" : \"Loopback2\",
            \"inputL3InterfaceIp\" : \"\"
        },
        {
            \"id\" : 27,
            \"outputL3DeviceId\" : 23,
            \"outputL3IsGenericDevice\" : false,
            \"outputL3InterfaceName\" : \"FastEthernet2/0\",
            \"outputL3InterfaceIp\" : \"\",
            \"layer2DeviceId\" : 9,
            \"inputL2InterfaceName\" : \"inside\",
            \"outputL2InterfaceName\" : \"outside\",
            \"inputL3DeviceId\" : 17,
            \"inputL3IsGenericDevice\" : false,
            \"inputL3InterfaceName\" : \"mgmt2\",
            \"inputL3InterfaceIp\" : \"\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Device Id 23 not found.
500: General error occurred."},"response":[]},{"name":"Get Transparent Firewalls","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw/device/{{deviceId}}","description":"Get Transparent Firewalls for participated managed/generic DeviceId

Parameters:
deviceId [optional]
generic [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/transparentfw/device/9?generic=false
OUTPUT{
    TransparentFirewalls: [
        {
            id: 17,
            outputL3DeviceId: 22,
            outputL3IsGenericDevice: false,
            outputL3InterfaceName: \"FastEthernet0/0\",
            layer2DeviceId: 9,
            inputL2InterfaceName: \"inside\",
            outputL2InterfaceName: \"outside\",
            inputL3DeviceId: 1,
            inputL3IsGenericDevice: true,
            inputL3InterfaceName: \"interface2\"
        },
        {
            id: 23,
            outputL3DeviceId: 23,
            outputL3IsGenericDevice: false,
            outputL3InterfaceName: \"FastEthernet2/0\",
            layer2DeviceId: 9,
            inputL2InterfaceName: \"inside\",
            outputL2InterfaceName: \"outside\",
            inputL3DeviceId: 17,
            inputL3IsGenericDevice: false,
            inputL3InterfaceName: \"mgmt\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred."},"response":[]},{"name":"Delete Transparent Firewalls.","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw/device/{{deviceId}}","description":"Delete Transparent Firewalls for participated layer 2 deviceId

Parameters:
deviceId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/transparentfw/device/9\n

Response Messages:
200: 4 entries deleted where layer2 deviceId = 9
400: Bad Request.
403: Access is denied.
404: DeviceId 9 not found.
500: General error occurred."},"response":[]},{"name":"Delete Transparent Firewall","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw/{{layer2DataId}}","description":"Delete Transparent Firewall by Id.

Parameters:
layer2DataId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/transparentfw/17\n

Response Messages:
200: layer2DataId 17 deleted.
400: Bad Request.
403: Access is denied.
404: Layer2Data Id 17 not found.
500: General error occurred."},"response":[]},{"name":"Get Specific topology subnet","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/subnets/{{id}}","description":"Returns the subnet for the specified id, including information regarding attached devices and join candidates.
This API requires 'Super admin' or 'Multi-Domain admin' privileges.
Multi-Domain user must have access permission to the domain where the subnet resides.

Parameters:
id: Subnet id

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/subnets/20
OUTPUT{
    \"subnet\": {
        \"id\": 18,
        \"name\": \"90.0.0.0/24\",
        \"ip\": \"90.0.0.0\",
        \"mask\": \"255.255.255.0\",
        \"attached_devices\": {
            \"attached_device\": [
                {
                    \"is_generic\": false,
                    \"id\": 10,
                    \"name\": \"srx\",
                    \"interface_id\": 4,
                    \"interface_name\": \"eth0\",
                    \"interface_ip\": \"90.0.0.1\"
                },
                {
                    \"is_generic\": false,
                    \"id\": 13,
                    \"name\": \"ZBFW\",
                    \"interface_id\": 5,
                    \"interface_name\": \"eth1\",
                    \"interface_ip\": \"90.0.0.124\"
                },
                {
                    \"is_generic\": false,
                    \"id\": 85,
                    \"name\": \"netscreen\",
                    \"interface_id\": 6,
                    \"interface_name\": \"eth2\",
                    \"interface_ip\": \"90.0.0.50\"
                }
            ]
        },
        \"join_candidates\": {
            \"join_candidate\": {
                \"is_generic\": false,
                \"id\": 72,
                \"name\": \"CP25\",
                \"interface_id\": 14,
                \"interface_name\": \"eth24/1\",
                \"interface_ip\": \"90.0.0.83\"
            }
        }
    }
}


Response Messages:
403: Access is denied
403: You do not have access permission to the domain for subnet with id ID
404: No subnet was found for the provided ID"},"response":[]},{"name":"Get Cloud Internal Networks","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/cloud_internal_networks/{{id}}","description":"Returns the internal networks for the specified Cloud management id.
This API requires 'Super admin' privileges.

Parameters:
id: Cloud management id

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/cloud_internal_networks/20
OUTPUT{
    \"network_list\":
    {
        \"count\": 3,
        \"total\": 3,
        \"network\":
        {
            \"ip\": \"10.27.122.20\",
            \"mask\": \"255.255.255.255\"
        },
        \"network\":
        {
            \"ip\": \"10.27.122.60\",
            \"mask\": \"255.255.255.255\"
        },
        \"network\":
        {
            \"ip\": \"10.27.122.4\",
            \"mask\": \"255.255.255.252\"
        }
    }
}


Response Messages:
403: Access is denied
403: You do not have access permission to the domain for NSX with id ID
403: Device ID specified is not supported
404: The specified device ID was not found
404: The specified device ID was not found in Topology"},"response":[]},{"name":"Get topology clouds","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds","description":"Returns a list of the topology clouds for all the domains for which the user has permission to access.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
Use the optional name parameter to restrict the results to topology clouds that contain the specified string.
The default pagination is start=0 and count=50.

Parameters:
context: Global MSSP context [optional]
type: Required clouds type [optional]
name: Cloud name [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds
OUTPUT{
    \"topology_clouds\": {
        \"count\": 3,
        \"total\": 3,
        \"topology_cloud\": [
            {
                \"id\": 48,
                \"name\": \"Cloud 69.70.120.155\",
                \"domain\": 1,
                \"type\": \"NON_JOINED\",
                \"ip\": \"69.70.120.155\"
            },
            {
                \"id\": 50,
                \"name\": \"Cloud 10.100.6.238\",
                \"domain\": 1,
                \"type\": \"MEMBER\",
                \"ip\": \"10.100.6.238\"
            },
            {
                \"id\": 66,
                \"name\": \"Cloud 10.100.10.14\",
                \"domain\": 1,
                \"type\": \"JOINED\",
                \"members\": [
                    {
                        \"id\": 50,
                        \"ip\": \"10.100.6.238\",
                        \"name\": \"Cloud 10.100.6.238\"
                    },
                    {
                        \"id\": 73,
                        \"ip\": \"10.100.10.14\",
                        \"name\": \"Cloud 10.100.10.14\"
                    },
                    {
                        \"id\": 74,
                        \"ip\": \"10.100.9.9\",
                        \"name\": \"Cloud 10.100.9.9\"
                    }
                ]
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds?type=non-joined
OUTPUT{
    \"topology_clouds\": {
        \"count\": 2,
        \"total\": 3,
        \"topology_cloud\": [
            {
                \"id\": 48,
                \"name\": \"Cloud 69.70.120.155\",
                \"domain\": 1,
                \"type\": \"NON_JOINED\",
                \"ip\": \"69.70.120.155\"
            },
            {
                \"id\": 50,
                \"name\": \"Cloud 10.100.6.238\",
                \"domain\": 1,
                \"type\": \"NON_JOINED\",
                \"ip\": \"10.100.6.238\"
            }
        ]
    }
}


Response Messages:
403: Access is denied
403: Only users with ‘Super admin’ permissions can access Global domain map
403: You do not have access permission to domain id: domainId
400: Wrong type provided - allowable values are: joined or non-joined"},"response":[]},{"name":"Create a joined topology cloud","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"cloud_data\":{\n\t\t\"cloud_name\" : \"optional new cloud name\",\n\t\t\"cloud_members\" : [118,179,258]\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds","description":"Create a new topology cloud in the Interactive Map by joining existing clouds together.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
The body must include at least two topology cloud ids that are on a single domain.
If the context parameter is not provided, then the API will use the context id of the first member of the members list in the body.
Clouds included in the members list of the body must not be joined clouds or members of another joined cloud.
If the provided body does not specify a joined cloud name, the newly created topology cloud will be given the name of the first member of the members list in the body.


Parameters:
context: Global MSSP context [optional]
body: Cloud data
forceTopologyInit: Force Topology Init [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds
BODY{
    \"cloud_data\":{
        \"cloud_name\" : \"optional new cloud name\",
        \"cloud_members\" : [118,179,258]
    }
}


Response Messages:
201: Joined cloud created successfully
403: Access is denied
403: You do not have access permission to the domain for cloud with id ID
404: Cloud with id ID was not found in the provided MSSP domain
412: You must provide 2 or more clouds
412: Cloud id: cloudId does not belong to domain: Context
412: Cloud with id ID is a joined cloud
412: Cloud with id ID is a member of a joined cloud"},"response":[]},{"name":"Delete generic Route","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/{{routeId}}","description":"Delete a generic Route by Id.

Parameters:
routeId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/route/5\n

Response Messages:
204: No Content.
400: Bad Request.
403: Access is denied.
404: Generic Route Not Found.
500: General error occurred."},"response":[]},{"name":"Get generic Route","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/{{routeId}}","description":"Get a generic Route by Id.

Parameters:
routeId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/route/30
OUTPUT{
    GenericRoute: {
        id: 30,
        mgmtId: 2,
        destination: \"222.100.10.22\",
        mask: \"255.255.0.0\",
        interfaceName: \"catch22\",
        nextHop: \"100.100.10.10\",
        nextHopType: \"IP\",
        vrf: \"V102-YO\"
    }
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Generic Route Not Found.
500: General error occurred."},"response":[]},{"name":"Create Join Cloud","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \n\t\"JoinCloud\" : \n\t{\n\t\t\"name\" : \"Yami\",\n\t\t\"clouds\" : [1, 2]\n\t}\n} "},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/join/clouds/","description":"Create Join Cloud.

Parameters:
body [optional]
forceTopologyInit: Force Topology Init [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/join/clouds
BODY{
    \"JoinCloud\" :
    {
        \"name\" : \"Yami\",
        \"clouds\" : [1, 2]
    }
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Cloud Not Found.
500: General error occurred."},"response":[]},{"name":"Update Join Cloud","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \n\t\"JoinCloud\" : \n\t{\n\t\t\"id\" : 67,\n\t\t\"name\" : \"Yamile\",\n\t\t\"clouds\" : [1, 2, 57]\n\t}\n} "},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/join/clouds/","description":"Update Join Clouds.

Parameters:
body [optional]
forceTopologyInit: Force Topology Init [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/join/clouds
BODY{
    \"JoinCloud\" :
    {
        \"id\" : 67,
        \"name\" : \"Yamile\",
        \"clouds\" : [1, 2, 57]
    }
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Cloud Not Found.
500: General error occurred."},"response":[]},{"name":"Get cloud information","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"suggested_clouds\": {\n\t\t\"count\": 1,\n\t\t\"total\": 1,\n\t\t\"cloud\": {\n\t\t\t\"management_name\": \"FW1\",\n\t\t\t\"management_id\": 20,\n\t\t\t\"cloud_name\": \"Cloud 10.100.0.1\",\n\t\t\t\"cloud_id\": 120,\n\t\t\t\"vertex_id\": 250,\n\t\t\t\"ip\": \"10.100.0.1\",\n\t\t\t\"routes_count\": 5,\n\t\t\t\"is_parent\": false\n\t\t}\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/cloud_suggestions/{{cloud_id}}","description":"Returns information about a specific cloud in the topology.
This API includes the ID of the cloud, the number of routes that point to the cloud, and the relevant devices (including the management_id) that have routes that point to the cloud.
This information can be used to identify missing devices that may need to be added to the topology or to identify clouds that are candidates for being joined.

Parameters:
cloud_id: cloud id
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/cloud_suggestions/120
BODY{
    \"suggested_clouds\": {
        \"count\": 1,
        \"total\": 1,
        \"cloud\": {
            \"management_name\": \"FW1\",
            \"management_id\": 20,
            \"cloud_name\": \"Cloud 10.100.0.1\",
            \"cloud_id\": 120,
            \"vertex_id\": 250,
            \"ip\": \"10.100.0.1\",
            \"routes_count\": 5,
            \"is_parent\": false
        }
    }
}


Response Messages:
202: Accepted
403: User is not permitted to access the specified domain"},"response":[]},{"name":"Get Topology Synchronization status","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/synchronize/status","description":"Returns the progress status of the Topology Model Synchronization.



Usage Example
https://192.168.1.1/securetrack/api/topology/synchronize/status

Response Messages:
200: The topology synchronization was invoked successfully.
403: Access is denied
500: Error getting synchronize progress"},"response":[]},{"name":"Get path for specified traffic","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"src"},{"value":null,"type":"text","key":"dst"},{"value":null,"type":"text","key":"service"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/path","description":"Returns one or more paths for the specified traffic.
src and dst parameters may contain multiple, comma separated values.
Service parameter can be a port (for example, “tcp:80”, “any”) or an application (for example, “Skype”, “Facebook”).
Application names are case sensitive.
Service parameter can also be a combination of ports and applications, for example “tcp:80, Skype, Facebook”
If sourceDomainIdTag is provided, the path starting points will be restricted to the specified domain ID. sourceDomainIdTag is valid only if overlapping IP mode is enabled.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is valid only if MSSP mode is enabled.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.
includeIncompletePaths parameter default value is false, if this parameter is set to true -
all nodes on the path will be included, even if the node cannot reach the destination, or if the source and destination are the same.
simulateNat parameter default value is true if this parameter is set to false - NAT simulation will not be used when calculating the path.
lastInstall parameter default value is true, which means simulation would use last installed policies. If this parameter is set to false - simulation would use last saved policies.
This API cannot be executed more than 10 times in parallel.

Parameters:
context: Global MSSP context [optional]
src: Source address/addresses
dst: Destination address/addresses
service: Service/services
sourceDomainIdTag: Path starting point Domain Id [optional]
includeIncompletePaths: Include incomplete paths [optional]
simulateNat: Simulate NAT [optional]
lastInstall: Last Installed [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/path?src=10.10.10.1&dst=3.3.3.3:32&service=any

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/path?src=29.29.29.1&dst=25.25.25.1&service=Facebook,tcp:80
OUTPUT {
    \"path_calc_results\": {
        \"traffic_allowed\": false,
        \"device_info\": {
            \"id\": \"17\",
            \"name\": \"PA-VM-111.6 (Cluster)\",
            \"type\": \"mgmt\",
            \"vendor\": \"Palo Alto Networks\",
            \"incomingInterfaces\": {
                \"incomingVrf\": \"default\",
                \"ip\": \"29.29.29.1/255.255.255.252\",
                \"name\": \"tunnel.11\"
            },
            \"nextDevices\": {
                \"name\": \"DIRECTLY_CONNECTED\",
                \"routes\": {
                    \"outgoingInterfaceName\": \"ethernet1/5\",
                    \"outgoingVrf\": \"default\",
                    \"routeDestination\": \"25.25.25.1/255.255.255.0\"
                }
            },
            \"bindings\": {
                \"name\": \"\",
                \"rules\": [
                    {
                        \"action\": \"Accept\",
                        \"applications\": \"facebook\",
                        \"destNegated\": false,
                        \"destinations\": \"Any\",
                        \"ruleIdentifier\": 43,
                        \"serviceNegated\": false,
                        \"services\": \"Any\",
                        \"sourceNegated\": false,
                        \"sources\": \"Any\",
                        \"users\": \"Any\"
                    },
                    {
                        \"action\": \"Deny\",
                        \"applications\": \"Any\",
                        \"destNegated\": false,
                        \"destinations\": \"Any\",
                        \"ruleIdentifier\": 62,
                        \"serviceNegated\": false,
                        \"services\": \"Any\",
                        \"sourceNegated\": false,
                        \"sources\": \"Any\",
                        \"users\": \"Any\"
                    }
                ]
            }
        }
    }
}

"},"response":[]},{"name":"Get generic Vpn","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/{{vpnId}}","description":"Get a generic Vpn by Id.

Parameters:
vpnId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/vpn/18
OUTPUT{
    GenericVpn: {
        id: 18,
        generic: false,
        deviceId: 2,
        interfaceName: \"777\",
        tunnelSourceIpAddr: \"1.1.1.77\",
        tunnelDestIpAddr: \"1.1.1.88\"
    }
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Generic Vpn Not Found.
500: General error occurred."},"response":[]},{"name":"Delete generic Vpn","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/{{vpnId}}","description":"Delete a generic Vpn by Id.

Parameters:
vpnId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/vpn/5\n

Response Messages:
204: No Content.
400: Bad Request.
403: Access is denied.
404: Generic Vpn Not Found.
500: General error occurred."},"response":[]},{"name":"Get topology generic VPN connections","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic_vpns{device_id:(/device_id)?}","protocol":"https","host":["{{SecureTrack_IP}}"],"path":["securetrack","api","topology","generic_vpns{device_id:(","device_id)"],"query":[{"key":"}","value":null}]},"description":"Returns a list of the generic vpn connections in the Topology map, for all the domains for which the user has permission to access.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
Use the optional name parameter to restrict the results to topology generic vpn connections that contain the specified string.
The default pagination is start=0 and count=50.

Parameters:
context: Global MSSP context [optional]
is_generic: Get generic devices [optional]
device_id: Device id [optional]
name: VPN connection name (accepts '*', '?' as wildcards) [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/generic_vpns
OUTPUT{
    \"generic_vpns\": {
        \"count\": 3,
        \"total\": 3,
        \"generic_vpn\": [
            {
                \"device_id\": 222,
                \"generic\": false,
                \"id\": 3,
                \"interface_name\": \"tunnel.2\",
                \"tunnel_dest_ip\": \"54.239.63.155\",
                \"tunnel_src_ip\": \"84.200.6.1\",
                \"vpn_name\": \"Palo_to_AWS\"
            },
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 4,
                \"interface_name\": \"tunnel.1\",
                \"tunnel_dest_ip\": \"54.239.63.156\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 5,
                \"interface_name\": \"tunnel.2\",
                \"tunnel_dest_ip\": \"54.239.63.157\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/generic_vpns?is_generic=true
OUTPUT{
    \"generic_vpns\": {
        \"count\": 2,
        \"total\": 2,
        \"generic_vpn\": [
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 4,
                \"interface_name\": \"tunnel.1\",
                \"tunnel_dest_ip\": \"54.239.63.156\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 5,
                \"interface_name\": \"tunnel.2\",
                \"tunnel_dest_ip\": \"54.239.63.157\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
        ]
    }
}


Response Messages:
403: Access is denied
403: Only users with ‘Super admin’ permissions can access Global domain map
403: You do not have access permission to domain id: domainId
400: Wrong type provided - allowable values are: joined or non-joined"},"response":[]},{"name":"Delete generic Vpns","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/device/{{deviceId}}","description":"Delete all generic Vpns from management/genericDevice Id.

Parameters:
deviceId [optional]
generic [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/vpn/device/2?generic=false\n

Response Messages:
200: 4 Generic Vpns were deleted from mgmtId 2.
400: Bad Request.
403: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred."},"response":[]},{"name":"Get generic Vpns","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/device/{{deviceId}}","description":"Get generic Vpns of management/genericDevice Id.

Parameters:
deviceId [optional]
generic [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/vpn/device/3?generic=true
OUTPUT{
    GenericVpns: [
    {
        id: 17,
        generic: true,
        deviceId: 3,
        interfaceName: \"777\",
        tunnelSourceIpAddr: \"1.1.1.177\",
        tunnelDestIpAddr: \"1.1.1.188\"
    },
    {
        id: 22,
        generic: true,
        deviceId: 3,
        interfaceName: \"111\",
        tunnelSourceIpAddr: \"1.1.1.188\",
        tunnelDestIpAddr: \"1.1.1.177\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred."},"response":[]},{"name":"Synchronize the Topology model","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/synchronize","description":"Invoke of the Topology Model Synchronization.
full_sync=false - Builds the topology model from the information stored in the Tufin database.
full_sync=true - Retrieves the current data from devices and builds the topology model.
Default value for full_sync = false.

Parameters:
full_sync: Perform full sync [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/synchronize

Usage Example
https://192.168.1.1/securetrack/api/topology/synchronize?full_sync=true

Response Messages:
200: The topology synchronization was invoked successfully.
403: Access is denied
500: Error Synchronizing Topology Model
503: Service unavailable, Graph builder is currently running"},"response":[]}]},{"name":"Network Zone Manager - Patterns","item":[{"name":"Get all pattern entries for specific zones","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\n\t\n\t\t0\n\t\t2\n\t\t2\n\t\n\t\n\t\t\n\t\t\t2\n\t\t\tsecurity_group_by_name\n\t\t\tThis is a comment\n\t\t\tWEB\n\t\t\t1\n\t\t\n\t\t\n\t\t\t3\n\t\t\tsecurity_group_by_name\n\t\t\tThis is a comment\n\t\t\tWEo\n\t\t\t2\n\t\t\n\t\n\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/pattern-entries","description":"Get the list of zone pattern entries for specific zones by identifiers

Parameters:
context: Global MSSP context. [optional]
ids: Filter by IDs for the pattern entry results. [optional]
pattern: Filter by pattern string for the zone entry results. [optional]
name: Filter by zone name for the pattern entry results. [optional]
comment: Filter by comment for the pattern entry results. [optional]
sort: Sort ascending or descending. [optional]
start: Starting page number for query results. [optional]
count: Number of pages to return for the query, starting from the specified starting page. [optional]
children: Include child zones in the results. [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/1,2/pattern-entries
BODY<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<pattern_match_entries_find_result>
    <paging_info>
        <start>0</start>
        <count>2</count>
        <total>2</total>
    </paging_info>
    <pattern_match_entries>
        <pattern_match_entry>
            <id>2</id>
            <type>security_group_by_name</type>
            <comment>This is a comment</comment>
            <pattern>WEB</pattern>
            <zone_id>1</zone_id>
        </pattern_match_entry>
        <pattern_match_entry>
            <id>3</id>
            <type>security_group_by_name</type>
            <comment>This is a comment</comment>
            <pattern>WEo</pattern>
            <zone_id>2</zone_id>
        </pattern_match_entry>
    </pattern_match_entries>
</pattern_match_entries_find_result>


Response Messages:
200: The zone pattern entries were successfully retrieved.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Get a specific zone pattern entry for a specific zone","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\n\t2\tsecurity_group_by_name\n\tThis is a comment\n\tWEB\n\t75\n\tZone_10_0_0_1\n\t\n\t\t
koko
\n\t\tbobo\n\t\t1\n\t\tDefault\n\t\n\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/pattern-entries/{{id}}","description":"Get a specific zone pattern entry for a specific zone by identifier

Parameters:
context: Global MSSP context. [optional]
zone_id: Identifier of the zone containing the zone entry.
id: Identifier of the zone pattern entry.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/75/pattern-entries/2
BODY<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<pattern_match_entry>
    <id>2</id>    <type>security_group_by_name</type>
    <comment>This is a comment</comment>
    <pattern>WEB</pattern>
    <zone_id>75</zone_id>
    <zone_name>Zone_10_0_0_1</zone_name>
    <domain>
        <address>koko</address>
        <description>bobo</description>
        <id>1</id>
        <name>Default</name>
    </domain>
</pattern_match_entry>


Response Messages:
200: The zone pattern entry was successfully retrieved.
403: User is not permitted to access the specified domain
404: A zone with the specified identifier was not found.
404: A zone pattern entry with the specified identifier was not found."},"response":[]},{"name":"Create a zone pattern entry in a specific zone","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\n\t\n\t\t1\n\t\t2\n\t\t\n\t\t\t1\n\t\t\tDefault\n\t\t\n\t\tWEB\n\t\tsecurity_group_by_name\n\t\tThis is a comment\n\t\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/pattern-entries","description":"Create a zone pattern entry in a specific zone by identifier

Parameters:
context: Global MSSP context. [optional]
zone_id: Identifier of the zone containing the zone pattern entry.
body: The zone pattern entry to create.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/pattern-entries
BODY<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<create_pattern_match_entry>
    <pattern_match_entry>
        <id>1</id>
        <zone_id>2</zone_id>
        <domain>
            <id>1</id>
            <name>Default</name>
        </domain>
        <pattern>WEB</pattern>
        <type>security_group_by_name</type>
        <comment>This is a comment</comment>
    </pattern_match_entry>
</create_pattern_match_entry>


Response Messages:
201: The zone pattern entry was created successfully.
403: User is not permitted to access the specified domain
400: Some of pattern entry parameters were invalid or missing
404: A zone with the specified identifier was not found."},"response":[]}]},{"name":"Network Zone Manager - Subnets","item":[{"name":"Get entries for a zone","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/entries","description":"Get the list of zone entries for a zone.

Parameters:
context: Global MSSP context. [optional]
ids: Filter by IDs for the zone entry results. [optional]
name: Filter by name for the zone entry results. [optional]
ip: Filter by IP for the zone entry results. [optional]
netmask: Filter by netmask for the zone entry results. [optional]
prefix: Filter by prefix for the zone entry results. [optional]
comment: Filter by comment for the zone entry results. [optional]
group: Filter by device group for the zone entry results. [optional]
sort: Sort ascending or descending. [optional]
start: Starting page number for query results. [optional]
count: Number of pages to return for the query, starting from the specified starting page. [optional]
children: Include child zones in the results. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/2/entries

Response Messages:
200: The zone entries were successfully retrieved.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Modify a zone entry","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"zone_entry\": {\n\t\"ip\": \"1b98:c72:1f00:0000::\",\n\t\"prefix\": \"52\"\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries/{{id}}","description":"For IPv4 entry provide IP and netmask/prefix (see Usage Example #1 and #2).
For IPv6 provide IP and prefix only, netmask is not allowed(see Usage Example #3).

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
id: The ID of the zone entry.
body: The modified zone entry.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries/1
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"netmask\": \"255.255.255.0\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries/1
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"prefix\": \"24\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries/1
BODY{
\"zone_entry\": {
    \"ip\": \"1b98:c72:1f00:0000::\",
    \"prefix\": \"52\"
    }
}


Response Messages:
200: The zone entry was modified successfully.
403: User is not permitted to access the specified domain
400: The zone entry parameters were invalid
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found."},"response":[]},{"name":"Get a specific zone entry","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"zone_id"},{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries/{{id}}","description":"Get a specific zone entry by ID for a zone.

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
id: The ID of the zone entry.

Usage Example
https://192.168.1.1/securetrack/api/zones/2/entries/123

Response Messages:
200: The zone entry was successfully retrieved.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found."},"response":[]},{"name":"Delete zone entries","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"zone_id"},{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries/{{id}}","description":"Delete existing zone entries.

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
id: The ID of the zone entry to delete.

Usage Example
https://192.168.1.1/securetrack/api/zones/2/entries/10

Response Messages:
200: The zone entry was deleted successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found."},"response":[]},{"name":"Modify multiple existing zone entries","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"zone_entries\" : {\n\t\t\"zone_entry\": [\n\t\t\t{\n\t\t\t\t\"id\": 120,\n\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\"prefix\": 32,\n\t\t\t\t\"new_zone_id\": 85\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": 139,\n\t\t\t\t\"ip\": \"1b98:c72:1f00:0001::\",\n\t\t\t\t\"prefix\": \"52\",\n\t\t\t\t\"new_zone_id\": 98\n\t\t\t}\n\t\t]\n}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_ids}}/entries/{{ids}}","description":"For IPv4 entry provide IP and netmask/prefix.
For IPv6 provide IP and prefix only, netmask is not allowed.
new_zone_id is not optional, it may be the same as the present zoneId.

Parameters:
context: Global MSSP context. [optional]
zone_ids: The ID(s) of the zones containing the zone entries.
ids: The ID(s) of the zone entries to modify.
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/85,98/entries/120,139
BODY{
\"zone_entries\" : {
        \"zone_entry\": [
            {
                \"id\": 120,
                \"ip\": \"3.3.3.3\",
                \"prefix\": 32,
                \"new_zone_id\": 85
            },
            {
                \"id\": 139,
                \"ip\": \"1b98:c72:1f00:0001::\",
                \"prefix\": \"52\",
                \"new_zone_id\": 98
            }
        ]
}
}


Response Messages:
200: The zone entry was modified successfully.
403: User is not permitted to access the specified domain
400: The zone entry parameters were invalid
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found."},"response":[]},{"name":"Create a zone entry","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"zone_entry\": {\n\t\"ip\": \"1b98:c72:1f00:0000::\",\n\t\"prefix\": \"52\"\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries","description":"For IPv4 entry provide IP and netmask/prefix (see Usage Example #1 and #2).
For IPv6 provide IP and prefix only, netmask is not allowed(see Usage Example #3).

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
body: The zone entry to create.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"netmask\": \"255.255.255.0\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"prefix\": \"24\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries
BODY{
\"zone_entry\": {
    \"ip\": \"1b98:c72:1f00:0000::\",
    \"prefix\": \"52\"
    }
}


Response Messages:
201: The zone entry was created successfully.
403: User is not permitted to access the specified domain
400: The zone entry parameters were invalid
404: A zone with the specified ID was not found."},"response":[]},{"name":"Modify a zone entry","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"zone_ids"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_ids}}/entries/{{ids}}","description":"Modify an existing zone entry.

Parameters:
context: Global MSSP context. [optional]
zone_ids: The ID(s) of the zones containing the zone entry.
ids: The ID(s) of the zone entries to delete.

Usage Example
https://192.168.1.1/securetrack/api/zones/2,3/entries/10,20

Response Messages:
200: The zone entry was deleted successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found."},"response":[]}]},{"name":"Network Zone Manager - Zones","item":[{"name":"Create a zone","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\n\tDMZ\n\tAll DMZ addresses\n\tfalse\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/","description":"Create a zone.

Parameters:
context: Global MSSP context. [optional]
body: The zone to add.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones
BODY<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<zone>
    <name>DMZ</name>
    <comment>All DMZ addresses</comment>
    <shared>false</shared>
</zone>


Response Messages:
201: The zone was created successfully.
403: User is not permitted to access the specified domain
400: The zone parameters were invalid"},"response":[]},{"name":"Get all zones","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/","description":"Gets a list of all zones.

Parameters:
context: Global MSSP context. [optional]
name: Filter by zone name for the zone results. [optional]
comment: Filter by zone comment for the zone results. [optional]
imported: List domains that imported zones. [optional]
includeInternet: Include the Internet zone. [optional]
includeImported: Include imported zones. [optional]
sort: Sort ascending or descending. [optional]
start: Starting page number for query results. [optional]
count: Number of pages to return for the query, starting from the specified starting page. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones

Response Messages:
200: The zones were retrieved successfully.
403: User is not permitted to access the specified domain"},"response":[]},{"name":"Delete all zones","request":{"method":"DELETE","header":[],"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/","description":"Delete all existing zones.

Parameters:
context: Global MSSP context. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones

Response Messages:
204: All zones were successfully deleted.
403: User is not permitted to access the specified domain"},"response":[]},{"name":"Get descendant zones for a zone","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/descendants","description":"Get a list of zones descended from the specified zone(s).

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones for which to look for descendant zones.

Usage Example
https://192.168.1.1/securetrack/api/zones/10,20/descendants

Response Messages:
200: The zone descendants were retrieved successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Add a zone as a descendant to a zone","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"parent_id"},{"value":null,"type":"text","key":"child_ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{parent_id}}/descendants/{{child_ids}}","description":"Add a zone(s) as a descendant to a existing zone.

Parameters:
context: Global MSSP context. [optional]
parent_id: The ID of the zone for which to add descendant zone(s).
child_ids: The ID(s) of the zones to add as descendants.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/descendants/10,20

Response Messages:
200: The zone was added as an descendant successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Remove a zone as an descendants to a zone","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"parent_id"},{"value":null,"type":"text","key":"child_ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{parent_id}}/descendants/{{child_ids}}","description":"Remove a zone(s) as an descendants to a existing zone.

Parameters:
context: Global MSSP context. [optional]
parent_id: The ID of the zone for which to remove descendant zone(s).
child_ids: The ID(s) of the zone to remove as a descendant.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/descendants/10,20

Response Messages:
200: The zone was removed as an descendant successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Remove a zone as an ancestor to a zone","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"child_id"},{"value":null,"type":"text","key":"parent_ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{child_id}}/ancestors/{{parent_ids}}","description":"Remove a zone(s) as an ancestor to a existing zone.

Parameters:
context: Global MSSP context. [optional]
child_id: The ID of the zone for which to remove ancestors zone(s).
parent_ids: The ID(s) of the zones to remove as ancestors.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/ancestors/10,20

Response Messages:
200: The zone was removed as an ancestor successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Add a zone as an ancestor to a zone","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"child_id"},{"value":null,"type":"text","key":"parent_ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{child_id}}/ancestors/{{parent_ids}}","description":"Add a zone(s) as an ancestor to a existing zone.

Parameters:
context: Global MSSP context. [optional]
child_id: The ID of the zone for which to add ancestors zone(s).
parent_ids: The ID(s) of the zones to add as ancestors.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/ancestors/10,20

Response Messages:
200: The zone was added as an ancestor successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Get shared zones","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/shared","description":"Get a list of shared zones.

Parameters:
context: Global MSSP context. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/shared

Response Messages:
200: The list of shared zones was retrieved successfully.
403: User is not permitted to access the specified domain"},"response":[]},{"name":"Map network elements to security zones","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t \n\t\t 10.8.8.0\n\t\t 255.255.255.0\n\t\t \n\t \n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_zones/","description":"This API maps each network element in the AccessRequestNetworkListDTO (such as IP address, IP address range, object, or group) to all matching Tufin security zones. If the network element is a group, then each zone also identifies all matching group members. The internet referral object can be included in the list, and will always map to the predefined Internet security zone. If the 'Any' element is included in the list it will map to all zones.
Note: if multi-domain mode is enabled, the API calls only checks zones that are in the “Default” domain.

Parameters:
body: AccessRequestNetworkListDTO

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_zones
BODY<network_objects>
     <network_object xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"ip_network\">
         <network xsi:type=\"raw_network_subnet\">
         <ip>10.8.8.0</ip>
         <mask>255.255.255.0</mask>
         </network>
     </network_object>
</network_objects>


Response Messages:
200: Returns mapping of network elements to security zones
400: Access Request Network List is malformed.
403: Access is denied."},"response":[]},{"name":"Delete a zone","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}","description":"Delete an existing zone.

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zone to delete.

Usage Example
https://192.168.1.1/securetrack/api/zones/1,2

Response Messages:
204: The specified zone was successfully deleted.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Modify a zone","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\n\t2\n\tDMZ\n\tAll DMZ hosts\n\tfalse\n\tfalse\n\tfalse\n\tfalse\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{id}}","description":"Modify an existing zone.

Parameters:
context: Global MSSP context. [optional]
id: The ID of the zone to modify.
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2
BODY<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<zone>
    <id>2</id>
    <name>DMZ</name>
    <comment>All DMZ hosts</comment>
    <shared>false</shared>
    <internet>false</internet>
    <user_networks>false</user_networks>
    <unassociated_networks>false</unassociated_networks>
</zone>


Response Messages:
204: The specified zone was successfully modified.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
400: The zone parameters were invalid"},"response":[]},{"name":"Get a specific zone","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{id}}","description":"Get the zone with the specified ID.

Parameters:
context: Global MSSP context. [optional]
id: The ID of the zone to get.
imported: List domains that imported zones. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/2

Response Messages:
200: The zone was retrieved successfully.
403: User is not permitted to access the specified domain
403: A zone with the specified ID does not exist."},"response":[]},{"name":"Get configuration usages for a zone","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/dependencies","description":"Get a list of configuration usages for the specified zone(s).

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones for which to look for configuration dependencies.

Usage Example
https://192.168.1.1/securetrack/api/zones/2,3/dependencies

Response Messages:
200: The zone dependencies were retrieved successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Import a zone","request":{"method":"POST","header":[],"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/import/{{ids}}","description":"Import a shared zone into the specified domain

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones to import. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/import/10,20

Response Messages:
200: The zone was imported successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Get ancestor zones for a zone","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/ancestors","description":"Get a list of ancestor zones for the specified zone(s).

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones for which to look for ancestor zones.

Usage Example
https://192.168.1.1/securetrack/api/zones/123,234/ancestors

Response Messages:
200: The zone ancestors were retrieved successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]}]},{"name":"Policies and Sub-Policies","item":[{"name":"Get rules by input and output interfaces","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/topology_interfaces","description":"Parameters:
device_id: The unique identifier of target device
inputInterfaceName: Input interface name [optional]
outputInterfaceName: Output interface name [optional]
isIpv6: Is ipv6 policy [optional]

Usage Example
https://192.168.1.1/securetrack/api/bindings/2/topology_interfaces?inputInterfaceName=ethernet1/1&outputInterfaceName=ethernet1/2
"},"response":[]},{"name":"Get sub-policies (bindings) by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/bindings","description":"Returns a list of all of the subpolicies (bindings) for a given revision.
The definition of subpolicy is different for each vendor:
Check Point - policy package and inline layer (inline layer will be returned only when the optional include_subpolicy parameter is set to true)
Cisco - ACL
Juniper/Fortinet/Palo Alto/Stonesoft - zone-to-zone policy
Cloud platforms - Security Groups


Parameters:
context: Global MSSP context [optional]
id: Revision ID
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
include_subpolicy: when set to true, includes sub policies in the returned result, supported only for Checkpoint [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/bindings

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/bindings? include_subpolicy=true
"},"response":[]},{"name":"Get policies by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/policies","description":"Fetches list of policies defined on a given revision ID

Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/policies
"},"response":[]},{"name":"Get sub-policies (bindings) by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/bindings","description":"Returns a list of all of the subpolicies (bindings) for a given device.
The definition of subpolicy is different for each vendor:
Check Point - policy package and inline layer (inline layer will be returned only when the optional include_subpolicy parameter is set to true)
Cisco - ACL
Juniper/Fortinet/Palo Alto/Stonesoft - zone-to-zone policy
Cloud platforms - Security Groups


Parameters:
context: Global MSSP context [optional]
id: Device ID
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
include_subpolicy: when set to true, includes sub policies in the returned result, supported only for Checkpoint [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/bindings

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/bindings? include_subpolicy=true
"},"response":[]},{"name":"Get policies by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/policies","description":"Fetches list of policies defined on a given device ID.
Supported devices: CheckPoint, Panorama Advanced, FortiManager Basic and Advanced, FMC and NSX.

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/20/policies
"},"response":[]},{"name":"Get list of sub-policies (bindings) with input and/or output interfaces","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"supremum_version_id"},{"value":null,"type":"text","key":"inputInterfaceName"},{"value":null,"type":"text","key":"outputInterfaceName"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/binding_query","description":"Retrieve list of bindings of input and/or output interfaces

Parameters:
device_id: The unique identifier of target device
supremum_version_id: The unique identifier of target revision
inputInterfaceName: Input interface name
outputInterfaceName: Output interface name

Usage Example
https://192.168.1.1/securetrack/api/bindings/20/binding_query?supremum_version_id=785&inputInterfaceName=Any&outputInterfaceName=Any
"},"response":[]}]},{"name":"Policy Analysis","item":[{"name":"Run Policy Analysis query","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_ids"},{"value":null,"type":"text","key":"sources"},{"value":null,"type":"text","key":"destinations"},{"value":null,"type":"text","key":"services"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/policy_analysis/query/matching_rules","description":"Parameters:
device_ids: Device ids
sources: Source list
destinations: Destination list
services: Service list
exclude_any: Exclude any in the specified, comma-separated fields of source, destination or service. For example: exclude_any = destination,service [optional]
action: Action [optional]

Usage Example
https://192.168.1.1/securetrack/api/policy_analysis/query/matching_rules?device_ids=41&sources=33.33.33.0:24,113.113.113.100&destinations=114.1.1.0:24&services=tcp:80&exclude_any=source,destination

Response Messages:
200: Returns request results.
400: Error in request syntax."},"response":[]}]},{"name":"Policy Browser (formerly Rule Documentation)","item":[{"name":"Get specific rule documentation","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"rule_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules/{{rule_id}}/documentation","description":"Fetches rule documentation for a single rule given by revision ID and rule ID.

Parameters:
context: Global MSSP context [optional]
id: Revision id
rule_id: Id of the requested rule

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules/16373/documentation
"},"response":[]},{"name":"Modify specific rule documentation","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t admin\n\t Comment text\n\t false\n\t true\n\t \n\t\t user@company.com\n\t\t Business Owner\n\t\t 2013-01-08T00:00:00+02:00\n\t\t 172\n\t\t 789111\n\t \n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules/{{rule_id}}/documentation","description":"Modify rule documentation for a single rule identified by revision ID and rule ID.
A single rule can be set as either a stealth rule or legacy rule. If both flags are set, an error will be returned (error 400, Bad request).
If no rule documentation exists for the rule, the specified documentation is added to the rule and the response code is: 201 Created.
If rule documentation already exists for the rule, the specified documentation replaces the existing documentation and the response code is: 204 No Content.
Record set entries that are automatically created or calculated, for example automatic mapping to a SecureChange ticket, cannot be modified.
The following fields are automatically calculated, and cannot be modified:
Permissiveness, Violations, Last Hit, Last Modified, Shadowing Status, Certification Status, Certification Date, Certification Expiration Date, Application Name, Application Owner

Parameters:
context: Global MSSP context [optional]
id: Revision id
rule_id: Id of the changed rule
body: RuleDocumentationDTO

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/173/rules/3373/documentation
BODY<rule_documentation>
     <tech_owner>admin</tech_owner>
     <comment>Comment text</comment>
     <legacy_rule>false</legacy_rule>
     <stealth_rule>true</stealth_rule>
     <record_set>
         <businessOwnerEmail>user@company.com</businessOwnerEmail>
         <businessOwnerName>Business Owner</businessOwnerName>
         <expireDate>2013-01-08T00:00:00+02:00</expireDate>
         <id>172</id>
         <ticketCr>789111</ticketCr>
     </record_set>
</rule_documentation>

"},"response":[]},{"name":"Delete specific rule documentation","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"rule_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules/{{rule_id}}/documentation","description":"Delete rule documentation for a single rule given by revision ID and rule ID.
If the rule has automatic mapping to a ticket, the record is not deleted.

Parameters:
context: Global MSSP context [optional]
id: Revision id
rule_id: Rule id

Usage Example
https://192.168.1.1/securetrack/api/revisions/173/rules/3373/documentation
"},"response":[]},{"name":"Modify specific rule documentation","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t admin\n\t Comment text\n\t false\n\t true\n\t \n\t\t user@company.com\n\t\t Business Owner\n\t\t 2013-01-08T00:00:00+02:00\n\t\t 173\n\t\t 789112\n\t \n\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules/{{rule_id}}/documentation","description":"Modify rule documentation for a single rule given by device ID and rule ID
A single rule can be set as either a stealth rule or legacy rule. If both flags are set, an error will be returned (error 400, Bad request).
If there is no existing rule documentation for the rule, the specified documentation is added to the rule and the response code is: 201 Created.
If there is existing rule documentation for the rule, the specified documentation replaces the existing documentation and the response code is: 204 No Content.

Parameters:
context: Global MSSP context [optional]
id: Device ID
rule_id: Rule ID
body: RuleDocumentationDTO

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/20/rules/3040/documentation
BODY<rule_documentation>
     <tech_owner>admin</tech_owner>
     <comment>Comment text</comment>
     <legacy_rule>false</legacy_rule>
     <stealth_rule>true</stealth_rule>
     <record_set>
         <businessOwnerEmail>user@company.com</businessOwnerEmail>
         <businessOwnerName>Business Owner</businessOwnerName>
         <expireDate>2013-01-08T00:00:00+02:00</expireDate>
         <id>173</id>
         <ticketCr>789112</ticketCr>
     </record_set>
</rule_documentation>

"},"response":[]},{"name":"Delete specific rule documentation","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"rule_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules/{{rule_id}}/documentation","description":"Delete rule documentation for a single rule given by device ID and rule ID

Parameters:
context: Global MSSP context [optional]
id: Device ID
rule_id: Rule ID

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules/3040/documentation
"},"response":[]},{"name":"Get specific rule documentation","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"rule_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules/{{rule_id}}/documentation","description":"Fetches rule documentation for a single rule given by device ID and rule ID

Parameters:
context: Global MSSP context [optional]
id: Device ID
rule_id: Rule ID

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules/16373/documentation
"},"response":[]}]},{"name":"Policy Optimization","item":[{"name":"Get cleanups results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/cleanup/","description":"Parameters:
context: Global MSSP context [optional]
devices: Devices ids [optional]

Usage Example
https://192.168.1.1/securetrack/api/cleanup
"},"response":[]},{"name":"Get shadowing rules by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"shadowed_uids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/shadowing_rules","description":"Find shadowing rules for given shadowed rules of a specific device

Parameters:
device_id: Device ID
shadowed_uids: UIDs of shadowed rules separated by commas

Usage Example
https://192.168.1.1/securetrack/api/devices/31/shadowing_rules?shadowed_uids=78786a0d-b9cc-478e-b7a2-dea953c976c7
"},"response":[]},{"name":"Get the specific objects or rules identified for the cleanup results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"cleanup_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/cleanup/{{cleanup_id}}/instances","description":"Parameters:
context: Global MSSP context [optional]
cleanup_id: Cleanup id
devices: Devices ids [optional]
start: Start [optional]
count: Results count [optional]

Usage Example
https://192.168.1.1/securetrack/api/cleanup/1/instances
"},"response":[]},{"name":"Get devices in cleanup results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"cleanup_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/cleanup/{{cleanup_id}}/devices","description":"Parameters:
context: Global MSSP context [optional]
cleanup_id: Cleanup id

Usage Example
https://192.168.1.1/securetrack/api/cleanup/1/devices
"},"response":[]},{"name":"Get devices in risk results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"risk_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/risk/{{risk_id}}/devices","description":"Parameters:
context: Global MSSP context [optional]
risk_id: Risk id

Usage Example
https://192.168.1.1/securetrack/api/risk/1/devices
"},"response":[]},{"name":"Get the specific objects or rules identified for the risk results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"risk_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/risk/{{risk_id}}/instances","description":"Parameters:
context: Global MSSP context [optional]
risk_id: Risk id
devices: Devices ids [optional]
start: Start [optional]
count: Results count [optional]

Usage Example
https://192.168.1.1/securetrack/api/risk/1/instances
"},"response":[]},{"name":"Get risks results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/risk/","description":"Parameters:
context: Global MSSP context [optional]
devices: Devices ids [optional]

Usage Example
https://192.168.1.1/securetrack/api/risk
"},"response":[]},{"name":"Get cleanups by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"code"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/cleanups","description":"Fetches set of Cleanup calculation results for a device given by ID.
Only fully shadowed rules (cleanup code C01) are supported.

Parameters:
context: Global MSSP context [optional]
device_id: Device ID
code: Cleanup category code
start: Starting page for query allowable values are numeric [optional]
count: Number of pages for query result allowable values are numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/cleanups?code=C01
"},"response":[]}]},{"name":"Revisions","item":[{"name":"Get specific revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revId}}","description":"Fetches a revision specified by revision Id.
To get revId for this API, use the 'id' property of RevisionDTO that is returned by 'Get revisions by device' or 'Get latest revision by device' APIs

Parameters:
context: Global MSSP context [optional]
revId: Id of fetched revision

Usage Example
https://192.168.1.1/securetrack/api/revisions/785
"},"response":[]},{"name":"Get latest revision by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/latest_revision","description":"Fetches latest revision for a given device

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/105/latest_revision
"},"response":[]},{"name":"Get revisions by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/revisions","description":"Fetches revisions for a given device

Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query starting from starting page allowable type is numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/105/revisions
"},"response":[]}]},{"name":"Rule Usage","item":[{"name":"Get last hits for all rules by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/rule_last_usage/find_all/{{device_id}}","description":"Get last hit dates for all rules in a given device.
For Palo Alto firewalls, this also returns last hits for users and applications in the rule.

Parameters:
device_id: device id

Usage Example
https://192.168.1.1/securetrack/api/rule_last_usage/find_all/20
"},"response":[]},{"name":"Get last hit for a specific rule","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"rule_uid"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/rule_last_usage/find/{{device_id}}/{{rule_uid}}","description":"Get last hit dates for all rules in a given device.
For Palo Alto firewalls, this also returns last hits for users and applications in the rule.
The rule_uid is the value from the uid field returned by the /rules API: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Parameters:
device_id: device_id
rule_uid: rule_uid

Usage Example
https://192.168.1.1/securetrack/api/rule_last_usage/find/20/ea9db13e-d058-45c6-a2f0-cd731027c22b
"},"response":[]}]},{"name":"Security Rules","item":[{"name":"Create a CSV file for rules search results","request":{"method":"GET","header":[],"url":"https://{{SecureTrack_IP}}/securetrack/api/rule_search/export","description":"The search_text parameter provides the same capabilities as the Policy Browser feature in SecureTrack.
You can search for a string across all rule fields, or you can search for a combination of specific strings in specific fields.
The text format is for a field is : for example uid:9259f6ee-47a0-4996-a214-ab7edc14a916.
See the search info documentation in Securetrack Policy Browser page for more information.
This API exports the results data as a CSV file in the SecureTrack Reports Repository.

Parameters:
context: Global MSSP context [optional]
search_text: Search text [optional]

Usage Example
https://192.168.1.1/securetrack/api/rule_search/export

Usage Example
https://192.168.1.1/securetrack/api/rule_search/export?search_text=shadowed:true
"},"response":[]},{"name":"Get a specific rule","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"ruleId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/rules/{{ruleId}}","description":"Parameters:
ruleId: Rule ID

Usage Example
https://192.168.1.1/securetrack/api/rules/60
"},"response":[]},{"name":"Get rules by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules","description":"Returns a list of all of the security rules for the specified device.
Use add=documentation to retrieve rule documentation.
The is_global parameter is device dependent. For ACL devices, only global rules are returned when set to true. For Check Point R80, only global layers are returned when set to true, and specify a layer name in the subpolicy_name parameter This parameter is ignored for all other vendors. The default value is false.
The subpolicy_name parameter is device dependent. For Check Point R80, only rules that use the specified layer are returned. You can only specify the name of a single layer. This parameter is ignored for all other vendors.
For Cisco ASA devices, when applying a filter you must also add the direction.


Parameters:
context: Global MSSP context [optional]
id: Device ID
policyId: Policy ID [optional]
policy: Policy Name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules (Only for: ACL devices) [optional]
add: If set to \"documentation\" result will include rule documentation [optional]
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
groupBy: Show rules grouping criteria. Can be set only to \"bindings\". Output will be grouped by bindings and section header for Check Point devices, ACL for Cisco devices, and Zones for Juniper, Palo Alto, and Fortinet device [optional]
with_zb: Include zone based rules, values can be 'true' or 'false' [optional]
uid: Binding UID [optional]
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
subpolicy_name: Filter by sub policy name (see implementation notes) [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules?subpolicy_name=layer1&is_global=true

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules?interface=Loopback99:INSIDE
"},"response":[]},{"name":"Find rules","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/rule_search/{{device_id}}","description":"The search_text parameter provides the same capabilities as the Policy Browser feature in SecureTrack.
You can search for a string across all rule fields, or you can search for a combination of specific strings in specific fields.
The text format is for a field is <fieldname>:<text> for example uid:9259f6ee-47a0-4996-a214-ab7edc14a916.
See the search info documentation in Securetrack Policy Browser page for more information.To get more information regarding objects included in the returned rules (like src_network or dst_network) use their uid, as the objects’ ID might change.
\n By default, if there are less than 3,000 rules - the API will return all the rules.\nIn case there are more than 3,000 rules the API will return an error code 413 with the error message “There are more than 3000 rules, you must use pagination”
“display_rule_number” should return only for Check Point R80 and higher devices.

Parameters:
context: Global MSSP context [optional]
search_text: Search text [optional]
device_id: Device id
start: The starting rule to include in the returned results [optional]
count: Number of rules to include in the results [optional]

Usage Example
https://192.168.1.1/securetrack/api/rule_search/31?search_text=source:Sales_192.168.2.60 fromzone:sales tozone:External

Usage Example
https://192.168.1.1/securetrack/api/rule_search/20?search_text=Mobile Access hascomment:false

Usage Example
https://192.168.1.1/securetrack/api/rule_search/87?search_text=web_server&start=0&count=10

Usage Example
URLhttps://192.168.1.1/securetrack/api/rule_search/59?search_text=uid:9259f6ee-47a0-4996-a214-ab7edc14a916
OUTPUT {
    \"rules\":{
        \"count\":1,
        \"total\":1,
        \"rule\":{
            \"@xsi.type\":\"securityRuleDTO\",
            \"id\":21,
            \"cp_uid\":\"\",
            \"uid\":\"{9259f6ee-47a0-4996-a214-ab7edc14a916}\",
            \"order\":2,
            \"binding\":{
                \"default\":true,
                \"policy\":{
                    \"@xsi.type\":\"managementDomainPolicyDTO\",
                    \"id\":2,
                    \"name\":\"Standard\",
                    \"installable_targets\":\"\"
                },
                \"rule_count\":19,
                \"security_rule_count\":19,
                \"uid\":\"{00-FACED0-00}\"
                },
            \"acceleration_breaker\":false,
            \"action\":\"Accept\",
            \"application\":{
                \"id\":4735,
                \"display_name\":\"ssh\",
                \"name\":\"ssh\"
            },
            \"authentication_rule\":false,
            \"comment\":\"DO NOT DELETE OR EDIT\",
            \"dst_network\":{
                \"id\":39,
                \"display_name\":\"Net_10.110.65.0\",
                \"name\":\"Net_10.110.65.0\"
                \"uid\":\"{1290f6ee-47a1-4996-a214-ab2edc26a916}\"
            },
            \"dest_networks_negated\":false,
            \"dst_service\":{
                \"id\":7420,
                \"display_name\":\"ssh\",
                \"name\":\"ssh\"
                \"uid\":\"{2904f6ee-47a1-4996-a214-ab2edc26a916}\"
            },
            \"dest_services_negated\":false,
            \"dst_zone\":\"any\",
            \"disabled\":false,
            \"external\":false,
            \"implicit\":false,
            \"dst_zone_any\":true,
            \"src_zone_any\":true,
            \"name\":\"Accept SSHG\",
            \"option\":\"LOG_SESSION\",
            \"documentation\":{
                \"permissiveness_level\":\"LOW\",
                \"shadowed\":\"Not shadowed\",
                \"last_modified\":\"Today\",
                \"last_hit\":\"N/A\",
                \"violations\":\"\"
            },
            \"rule_location\":\"Shared\",
            \"rule_location_display\":\"Shared - Pre Rule\",
            \"rule_number\":2,
            \"display_rule_number\":\"2.1\",
            \"rule_type\":\"universal\",
            \"src_zone\":\"any\",
            \"src_network\":{
                \"id\":38,
                \"display_name\":\"Net_10.110.64.0\",
                \"name\":\"Net_10.110.64.0\"
                \"uid\":\"{4934f6ee-47a1-4996-a214-ab2edc26a916}\"
            },
            \"src_networks_negated\":false,
            \"src_services_negated\":false,
            \"track\":{
                \"level\":\"LOG\"
            },
            \"type\":\"rule\",
            \"users\":{
                \"id\":5,
                \"display_name\":\"tufin\\\\regina\",
                \"name\":\"tufin\\\\regina@ldap\"
            }
        }
    }
}


Response Messages:
400: Value for start parameter is missing or not valid
400: Value for count parameter is missing or not valid
413: Max supported count is 3000
413: There are more than 3000 rules, you must use pagination"},"response":[]},{"name":"Get specific rule","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/rules/{{ids}}","description":"Returns a list of rules by revision ID, rule IDs and additional criteria

Parameters:
context: Global MSSP context [optional]
revision_id: Revision id
ids: Rule IDs
policy: Policy name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules (Only for: ACL devices) [optional]
add: If set to \\\"documentation\\\" result will include rule documentation [optional]
groupBy: Rules grouping criteria, can be set only to \\\"bindings\\\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules/16370
"},"response":[]},{"name":"Get rules by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules","description":"Returns a list of all of the security rules for the specified revision.
Use add=documentation to retrieve rule documentation.
The is_global parameter is device dependent. For ACL devices, only global rules are returned when set to true. For Check Point R80, only global layers are returned when set to true, and specify a layer name in the subpolicy_name parameter This parameter is ignored for all other vendors. The default value is false.
The subpolicy_name parameter is device dependent. For Check Point R80, only rules that use the specified layer are returned. You can only specify the name of a single layer. This parameter is ignored for all other vendors.
For Cisco ASA devices, when applying a filter you must also add the direction.


Parameters:
context: Global MSSP context [optional]
id: Revision id
policyId: Policy id [optional]
policy: Policy name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules only(device dependent, see implementation Notes) [optional]
add: If set to \"documentation\" result will include rule documentation [optional]
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
groupBy: Rules grouping criteria, can be set only to \"bindings\" [optional]
with_zb: Include zone-based rules [optional]
uid: Binding UID [optional]
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
subpolicy_name: Filter by sub policy name (see implementation notes) [optional]
is_alternate_order: OrderBy alternate order, for display Aci rules by contracts [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules?subpolicy_name=layer1&is_global=true

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules?interface=Loopback99:INSIDE
"},"response":[]},{"name":"Get rule count per device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/rule_search/","description":"The search_text parameter provides the same capabilities as the Policy Browser feature in SecureTrack.
You can search for a string across all rule fields, or you can search for a combination of specific strings in specific fields.
The text format is for a field is <fieldname>:<text> for example uid:9259f6ee-47a0-4996-a214-ab7edc14a916.
See the search info documentation in Securetrack Policy Browser page for more information.
This API will return a list of all the devices, the devices that has rules that match the search criteria will have rule_count that is bigger than 0

Parameters:
context: Global MSSP context [optional]
search_text: Search text [optional]
devices: Devices ids [optional]

Usage Example
https://192.168.1.1/securetrack/api/rule_search/87

Usage Example
https://192.168.1.1/securetrack/api/rule_search/87?search_text=ICMP application:facebook

Usage Example
URLhttps://192.168.1.1/securetrack/api/rule_search?search_text=uid:9259f6ee-47a0-4996-a214-ab7edc14a916
OUTPUT{
    \"device_list\":{
        \"device\":[
            {
                \"device_id\":512,
                \"revision_id\":6864,
                \"rule_count\":1
            },
            {
                \"device_id\":59,
                \"revision_id\":543,
                \"rule_count\":0
            }
        ]
    }
}

"},"response":[]},{"name":"Get specific rule","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/rules/{{ids}}","description":"Returns a list of rules by device ID, rule IDs and additional criteria.
Note: This API retrieves the information from the latest revision.


Parameters:
context: Global MSSP context [optional]
device_id: Device ID
ids: Rule IDs
policy: Policy Name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules only(device dependent, see implementation Notes) [optional]
add: If set to \"documentation\" result will include rule documentation [optional]
groupBy: Rules grouping criteria, can be set only to \"bindings\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules/16370
"},"response":[]}]},{"name":"Services and Ports","item":[{"name":"Get specific service","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/services/{{ids}}","description":"Fetches list of specific service objects defined in revision given by revision ID and specified by their IDs

Parameters:
context: Global MSSP context [optional]
revision_id: Revision id
ids: Rule IDs
show_members: Set to false to return only the name and ID of the members [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/services/959888
"},"response":[]},{"name":"Get service groups containing specified service objects","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/services/{{id}}/groups","description":"Returns groups that contain the specified service objects


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the service object.

Usage Example
https://192.168.1.1/securetrack/api/services/69577/groups
"},"response":[]},{"name":"Get specific service","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/services/{{ids}}","description":"Fetches list of specific service objects defined in device given by device ID and specified by their IDs.
Note: This API retrieves the information from the latest revision.

Parameters:
context: Global MSSP context [optional]
device_id: Device ID
ids: Service object IDs separated by commas
show_members: Set to false to return only the name and ID of the members [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/services/959888,959966
"},"response":[]},{"name":"Get rules containing specified service object","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/services/{{id}}/rules","description":"Returns the security rules that contain the specified service object


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the service object.
include_groups: You can add \"include_groups\" to find rules that include the service object and rules that include the groups that include the service object. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]

Usage Example
https://192.168.1.1/securetrack/api/services/65078/rules?include_groups=true
"},"response":[]},{"name":"Get services objects matching specified criteria","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"services\": {\n\t\t\"count\": 1,\n\t\t\"total\": 1,\n\t\t\"service:\": {\n\t\t\t\"id\": 169197,\n\t\t\t\"name\": \"tcp_10\",\n\t\t\t\"display_name\": \"tcp_10\",\n\t\t\t\"class_name\": \"access_role\",\n\t\t\t\"global\": false,\n\t\t\t\"device_id\": 158,\n\t\t\t\"comment\": \"\",\n\t\t\t\"uid\": \"{9EDC2607-6BEC-43D7-A99D-B522BA694ADA}\",\n\t\t\t\"implicit\": false,\n\t\t\t\"max\": false,\n\t\t\t\"min\": false,\n\t\t\t\"protocol\": 6,\n\t\t\t\"timeout\": \"\",\n\t\t\t\"type\": \"tcp_service\",\n\t\t\t}\n\t\t}\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/services/search","description":"You can search for service objects where the name or comment fields have a specified text string,
or you can search for service objects that have an Port or protocol that matches,
or you can search for service objects by uid.

Parameters:
context: Returns results for the specified domain ID. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]
filter: “text” filter returns service objects where the name or comment fields have a specified text string. \n“protocol” filter returns service objects that have a protocol that matches specified IP protocol number.\n“port” filter returns service objects that have a port that matches specified port number.\n “uid“ filter returns service objects with the specified uid.\n If no filter is specified, the “text” filter is used.
device_id: Returns service objects belonging to the specified device_id. [optional]
name: (For “text” filter) You can specify \"name\" to find service objects with the specified text in the name field. [optional]
comment: (For “text” filter) You can specify “comment” to find service objects with the specified text in the comment field. [optional]
protocol: Specify Protocolto find service objects that have the specified IP Protocol. [optional]
port: Specify Portto find service objects that have the specified Port. [optional]
uid: (for “uid“ filter) Returns service objects with the specified uid. [optional]

Usage Example
https://192.168.1.1/securetrack/api/services/search?filter=protocol&protocol=6&device_id=68

Usage Example
https://192.168.1.1/securetrack/api/services/search?filter=port&port=80

Usage Example
https://192.168.1.1/securetrack/api/services/search?filter=uid&uid=24a8774d-24c1-4b3a-aae9-3c272a2b5191

Usage Example
URLhttps://192.168.1.1/securetrack/api/services/search?filter=text&name=tcp_10
BODY{
    \"services\": {
        \"count\": 1,
        \"total\": 1,
        \"service:\": {
            \"id\": 169197,
            \"name\": \"tcp_10\",
            \"display_name\": \"tcp_10\",
            \"class_name\": \"access_role\",
            \"global\": false,
            \"device_id\": 158,
            \"comment\": \"\",
            \"uid\": \"{9EDC2607-6BEC-43D7-A99D-B522BA694ADA}\",
            \"implicit\": false,
            \"max\": false,
            \"min\": false,
            \"protocol\": 6,
            \"timeout\": \"\",
            \"type\": \"tcp_service\",
            }
        }
    }
}

"},"response":[]},{"name":"Get services by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/services","description":"Fetches list of service objects defined on device given by device ID.
The default value for get_total is false. For APIF 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.


Parameters:
context: Global MSSP context [optional]
id: Device ID
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
start: Starting page for query allowable types are numeric [optional]
count: Number of pages for query allowable values are numeric [optional]
name: Service name [optional]
type: Service type, allowable values are: tcp, udp, ip or icmp [optional]
port: Service port [optional]
icmp_type: Service ICMP type allowable values are numeric between 0 to 40 [optional]
protocol: Service protocol, allowable values are numeric between 0 to 255 [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/20/services?get_total=true
OUTPUT {
    \"services\": {
        \"count\": 50,
        \"total\": 100,
        \"service\": [{
            \"@xsi.type\": \"singleServiceDTO\",
            \"id\": 5129479,
            \"name\": \"Tcp30025\",
            \"display_name\": \"Tcp30025\",
            \"class_name\": \"tcp_service\",
            \"type\": \"tcp_service\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{079F15A5-009E-7E47-BBD0-E65973646562}\",
            \"implicit\": false,
            \"overrides\": false,
            \"max\": 30025,
            \"min\": 30025,
            \"negate\": false,
            \"protocol\": 6,
            \"timeout\": 0
        }]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/services?type=group&show_members=false
OUTPUT{
    \"services\": {
    \"count\": 100,
        \"service\": [
            {
                \"@xsi.type\": \"serviceGroupDTO\",
                \"id\": 1359066,
                \"name\": \"#Shared Domain@DNS\",
                \"display_name\": \"DNS\",
                \"class_name\": \"service_group\",
                \"type\": \"group\",
                \"global\": \"false\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": false,
                \"overrides\": \"false\",
                \"type_on_device\": gen_service_group,
                \"is_device_predefined\": true,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"DNS\",
                    \"name\": \"#Shared Domain@DNS\",
            }
        ]
    }
}

"},"response":[]},{"name":"Get services by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/services","description":"Fetches list of service objects defined in revision given by revision ID
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.


Parameters:
context: Global MSSP context [optional]
id: Revision id
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
start: Starting page for query allowable types are numeric [optional]
count: Number of pages for query allowable values are numeric [optional]
name: Service name [optional]
type: Service type, allowable values are: tcp, udp, ip or icmp [optional]
port: Service port [optional]
icmp_type: Service ICMP type allowable values are numeric between 0 to 40 [optional]
protocol: Service protocol, allowable values are numeric betweenm 0 to 255 [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/785/services?get_total=true
OUTPUT {
    \"services\": {
        \"count\": 50,
        \"total\": 100,
        \"service\": [{
            \"@xsi.type\": \"singleServiceDTO\",
            \"id\": 5129479,
            \"name\": \"Tcp30025\",
            \"display_name\": \"Tcp30025\",
            \"class_name\": \"tcp_service\",
            \"type\": \"tcp_service\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{079F15A5-009E-7E47-BBD0-E65973646562}\",
            \"implicit\": false,
            \"overrides\": false,
            \"max\": 30025,
            \"min\": 30025,
            \"negate\": false,
            \"protocol\": 6,
            \"timeout\": 0
        }]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/31/services?type=group&show_members=false
OUTPUT{
    \"services\": {
    \"count\": 100,
        \"service\": [
            {
                \"@xsi.type\": \"serviceGroupDTO\",
                \"id\": 1359066,
                \"name\": \"#Shared Domain@DNS\",
                \"display_name\": \"DNS\",
                \"class_name\": \"service_group\",
                \"type\": \"group\",
                \"global\": \"false\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": false,
                \"overrides\": \"false\",
                \"type_on_device\": gen_service_group,
                \"is_device_predefined\": true,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"DNS\",
                    \"name\": \"#Shared Domain@DNS\",
            }
        ]
    }
}

"},"response":[]}]},{"name":"Time Objects","item":[{"name":"Get specific time object","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/time_objects/{{ids}}","description":"Fetches list of time objects by revision ID and rule ID

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Rule IDs

Usage Example
https://192.168.1.1/securetrack/api/revisions/7/time_objects/9
"},"response":[]},{"name":"Get time objects by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/time_objects","description":"Returns the time objects used in the specified revision.

Parameters:
context: Global MSSP context [optional]
id: Revision ID
start: Starting page for query allowable value is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/time_objects
"},"response":[]},{"name":"Get time objects by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/time_objects","description":"Returns the time objects used in the specified device.

Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable values are numeric [optional]
count: Starting page for query allowable values are numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/time_objects
"},"response":[]}]},{"name":"Traffic Policy Matcher","item":[{"name":"Get policy relevance metrics for traffic","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"relevance_metrics\": {\n\t\t\"source_ips\": {\n\t\t\t\"source\":[\"10.10.253.0/24\", \"172.31.50.99/32\"]\n\t\t},\n\t\t\"dest_ips\": {\n\t\t\t\"dest\": [\"172.31.150.0/24\", \"172.31.50.99/32\"]\n\t\t},\n\t\t\"targets\": {\n\t\t\t\"target\": [4, 10]\n\t\t}\n\t}\n}\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/traffic_policy/","description":"The response lists all the relevant security groups, tags, relevant instances, and count of unrelated instances for each Amazon VPC in the specified traffic path.
A relevant security group contains at least one instance including either the source or destination IP address.
An unrelated instance is included in the security group but not part of the specified traffic path.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is used only if MSSP mode is enabled. If MSSP mode is disabled context is ignored.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.

Parameters:
context: Global MSSP context [optional]
body: Relevance metrics request

Usage Example
URLhttps://192.168.1.1/securetrack/api/traffic_policy
BODY{
    \"relevance_metrics\": {
        \"source_ips\": {
            \"source\":[\"10.10.253.0/24\", \"172.31.50.99/32\"]
        },
        \"dest_ips\": {
            \"dest\": [\"172.31.150.0/24\", \"172.31.50.99/32\"]
        },
        \"targets\": {
            \"target\": [4, 10]
        }
    }
}


Response Messages:
200: Successful
403: Insufficient user permissions
404: Device not found
400: Invalid parameters"},"response":[]}]},{"name":"Unified Security Policy - Access Request Violations","item":[{"name":"Get violations for an access request","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t false\n\t 0\n\t \n\t \n\t\t \n\t\t false\n\t\t 10.100.0.1\n\t\t 255.255.255.255\n\t\t \n\t \n\t \n\t\t ssh\n\t\t \n\t\t\t true\n\t\t\t 6\n\t\t\t 6\n\t\t\t 22\n\t\t\t 22\n\t\t\t false\n\t\t \n\t \n\t ACCEPT\n\t\n\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/sync","description":"Calculate the violations for the given access request.
Note: this API may take a while to complete.
See the asynchronous API /violations/access_request/task as an alternative.

Parameters:
body: AccessRequestListDTO
use_topology: Use topology to determine access request domains. [optional]
ar_domain_mode: The access request supports multiple domains. [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/violations/access_requests/sync?use_topology=false&ar_domain_mode=false
BODY<access_requests>
    <access_request>
     <use_topology>false</use_topology>
     <access_request_order>0</access_request_order>
     <access_request_source xsi:type=\"internet\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"/>
     <access_request_destination xsi:type=\"ip_network\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <network xsi:type=\"raw_network_subnet\">
         <negate>false</negate>
         <ip>10.100.0.1</ip>
         <mask>255.255.255.255</mask>
         </network>
     </access_request_destination>
     <access_request_service xsi:type=\"implicit_service\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <name>ssh</name>
         <service>
             <predefined>true</predefined>
             <min_protocol>6</min_protocol>
             <max_protocol>6</max_protocol>
             <min_port>22</min_port>
             <max_port>22</max_port>
             <negate>false</negate>
         </service>
     </access_request_service>
     <action>ACCEPT</action>
    </access_request>
</access_requests>


Response Messages:
200: Access request violations were calculated.
400: Access request order is not unique.
400: Domain cannot be specified when domain mode is false.
400: Cannot specify both ticket domain id and source and destination domains.
400: No domain specified in MSSP mode.
400: Domain does not exist.
400: Access request is malformed.
400: No valid access requests (Access requests cannot have topology enabled and the Internet object in the Source/Destination).
403: Access is denied."},"response":[]},{"name":"Get violation task results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/result/{{taskId}}","description":"Get result of access requests violations task.

Parameters:
taskId: The unique identifier of the access request violations task.

Usage Example
https://192.168.1.1/securetrack/api/violations/access_requests/result/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Access request violations task results were received.
403: Access is denied.
404: An error occurred during the calculation.
404: The calculation for the task has not finished yet."},"response":[]},{"name":"Cancel violation task","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/task/{{taskId}}","description":"Delete an access request violations task.

Parameters:
taskId: The unique identifier of the access request violations task.

Usage Example
https://192.168.1.1/securetrack/api/violations/access_requests/task/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
204: Access request violations task has been aborted successfully.
403: Access is denied.
404: Access request violations task was not found."},"response":[]},{"name":"Start a task to calculate violations for an access request","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t false\n\t 0\n\t \n\t \n\t\t \n\t\t false\n\t\t 10.100.0.1\n\t\t 255.255.255.255\n\t\t \n\t \n\t \n\t\t ssh\n\t\t \n\t\t\t true\n\t\t\t 6\n\t\t\t 6\n\t\t\t 22\n\t\t\t 22\n\t\t\t false\n\t\t \n\t \n\t ACCEPT\n\t\n\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/task","description":"Create a calculation task to find access requests violations.
Returns a task Id that can be used to check the task status and get the task results

Parameters:
body [optional]
use_topology: Use topology to determine access request domains. [optional]
ar_domain_mode: The access request uses resources from multiple domains. [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/violations/access_requests/task?use_topology=false&ar_domain_mode=false
BODY<access_requests>
    <access_request>
     <use_topology>false</use_topology>
     <access_request_order>0</access_request_order>
     <access_request_source xsi:type=\"internet\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"/>
     <access_request_destination xsi:type=\"ip_network\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <network xsi:type=\"raw_network_subnet\">
         <negate>false</negate>
         <ip>10.100.0.1</ip>
         <mask>255.255.255.255</mask>
         </network>
     </access_request_destination>
     <access_request_service xsi:type=\"implicit_service\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <name>ssh</name>
         <service>
             <predefined>true</predefined>
             <min_protocol>6</min_protocol>
             <max_protocol>6</max_protocol>
             <min_port>22</min_port>
             <max_port>22</max_port>
             <negate>false</negate>
         </service>
     </access_request_service>
     <action>ACCEPT</action>
    </access_request>
</access_requests>


Response Messages:
202: Access request violations task was accepted.
400: Access request order is not unique.
400: Domain cannot be specified when domain mode is false.
400: Cannot specify both ticket domain id and source and destination domains.
400: No domain specified in MSSP mode.
400: Domain does not exist.
400: Access request is malformed.
400: No valid access requests (Access requests cannot have topology enabled and the Internet object in the Source/Destination)
400: No network source were specified.
400: No network destination were specified.
403: Access is denied.
503: Access request violations task was rejected."},"response":[]},{"name":"Get violation task status","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/status/{{taskId}}","description":"Get access requests violations task status.

Parameters:
taskId: The unique identifier of the access request violations task.

Usage Example
https://192.168.1.1/securetrack/api/violations/access_requests/status/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Access request violations task status was received.
403: Access is denied.
404: Access request violations task status was not found."},"response":[]}]},{"name":"Unified Security Policy - Alerts","item":[{"name":"Get alerts","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"start"},{"value":null,"type":"text","key":"count"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/","description":"Returns a list of all alerts. If an empty list is returned, it implies that there are no configured alerts for that context.
You must set start and count parameters to limit the number of returned alerts.
Start is zero based - to start from the second rule use start=1, to get rules 51-60 use start=50 and count=10.

Parameters:
context: MSSP context [optional]
start: Returns the results beginning with the specified result number
count: Returns the specified number of results

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts?start=10&count=25

Response Messages:
400: Value for start parameter is missing or not valid
400: Value for count parameter is missing or not valid"},"response":[]},{"name":"Create an alert","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"usp_alert_configuration\": {\n\t\t\"name\": \"uspAlert\",\n\t\t\"description\": \"description\",\n\t\t\"status\": \"ACTIVE\",\n\t\t\"domain_id\": 6,\n\t\t\"all_devices\": false,\n\t\t\"device_ids\": {\n\t\t\t\"device_id\": [\n\t\t\t\t1,\n\t\t\t\t2,\n\t\t\t\t3,\n\t\t\t\t4\n\t\t\t]\n\t\t},\n\t\t\"low_severity\": true,\n\t\t\"medium_severity\": true,\n\t\t\"high_severity\": true,\n\t\t\"critical_severity\": false,\n\t\t\"user_ids\": {\n\t\t\t\"user_id\": [\n\t\t\t\t\"moshe\",\n\t\t\t\t\"admin\"\n\t\t\t\t]\n\t\t},\n\t\t\"emails\": \"user@doamin.com\",\n\t\t\"send_syslog\": true\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/","description":"Create an alert for unified security policies.
Returns location with the alert id to get the alert.
Alerts can be defined for all devices (all_devices:true) or for specified device IDs.
An email and/or user name must be defined. For multiple entries of emails or user names, use a semicolon to separate values. For SecureTrack, users in the collection are populated with \"user_ids\". The alert will be sent to the users (according to the addresses configured in SecureTrack) and to the emails.
To get the domain_id (optional parameter), call /domains/ API and use the ID included within the returned domain DTO.
At least one severity should be marked as 'true'.
There are no default values

Parameters:
context: Global MSSP context [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_policies/alerts
BODY{
    \"usp_alert_configuration\": {
        \"name\": \"uspAlert\",
        \"description\": \"description\",
        \"status\": \"ACTIVE\",
        \"domain_id\": 6,
        \"all_devices\": false,
        \"device_ids\": {
            \"device_id\": [
                1,
                2,
                3,
                4
            ]
        },
        \"low_severity\": true,
        \"medium_severity\": true,
        \"high_severity\": true,
        \"critical_severity\": false,
        \"user_ids\": {
            \"user_id\": [
                \"moshe\",
                \"admin\"
                ]
        },
        \"emails\": \"user@doamin.com\",
        \"send_syslog\": true
    }
}


Response Messages:
201: Security policy alert id :|'alertId'| , name : 'alertName'
412: Alert name not specified
409: Alert name specified already exists
412: Status not specified
412: Domain not specified
404: Domain specified does not exist
403: User is not authorized to configure alerts for domain 'domainId'
412: Device not specified
404: Device ID specified does not exist or belongs to a different domain
403: Device: 'deviceId' not supported for USP
412: Severity not specified
412: No recipient details entered for alert
412: Invalid email address. Format must be name@domain.com
404: Username: 'userName' does not exist
403: User is not authorized to configure alerts for Super Admin user: 'userName'
403: Username: 'userName' not valid for the specified domain"},"response":[]},{"name":"Delete alerts by ids","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/{{ids}}","description":"Delete specified alerts by IDs
To delete multiple alert_ids, use a comma between each ID

Parameters:
context: Delete alerts in the specified domain ID. [optional]
ids: The alert Ids for deletion

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts/87

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts/86,87,88

Response Messages:
200:
403: Security Policy Alert Ids: :|'alert ids'| don't exist"},"response":[]},{"name":"Get a specific alert","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/{{id}}","description":"Returns a specified alert.
If the alert_id does not exist, an error message is returned.

Parameters:
context: MSSP context [optional]
id: The alert Id

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts/1

Response Messages:
403: Alert ID does not exist"},"response":[]},{"name":"Update an alert","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"usp_alert_configuration\": {\n\t\t\"name\": \"uspAlert\",\n\t\t\"description\": \"description\",\n\t\t\"status\": \"ACTIVE\",\n\t\t\"domain_id\": 6,\n\t\t\"all_devices\": false,\n\t\t\"device_ids\": {\n\t\t\t\"device_id\": [\n\t\t\t\t1,\n\t\t\t\t2,\n\t\t\t\t3,\n\t\t\t\t4\n\t\t\t]\n\t\t},\n\t\t\"low_severity\": true,\n\t\t\"medium_severity\": true,\n\t\t\"high_severity\": true,\n\t\t\"critical_severity\": false,\n\t\t\"user_ids\": {\n\t\t\t\"user_id\": [\n\t\t\t\t\"moshe\",\n\t\t\t\t\"admin\"\n\t\t\t\t]\n\t\t},\n\t\t\"emails\": \"user@doamin.com\",\n\t\t\"send_syslog\": true\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/{{id}}","description":"Update an alert for unified security policies.
Alerts can be defined for all devices (all_devices:true) or for specified device IDs.
An email and/or user name must be defined. For multiple entries of emails or user names, use a semicolon to separate values. For SecureTrack, users in the collection are populated with \"user_ids\". The alert will be sent to the users (according to the addresses configured in SecureTrack) and to the emails.
To get the domain_id (optional parameter), call /domains/ API and use the ID included within the returned domain DTO.
At least one severity should be marked as 'true'.
There are no default values

Parameters:
context: Global MSSP context [optional]
id: The alert ID for updating [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_policies/alerts/1
BODY{
    \"usp_alert_configuration\": {
        \"name\": \"uspAlert\",
        \"description\": \"description\",
        \"status\": \"ACTIVE\",
        \"domain_id\": 6,
        \"all_devices\": false,
        \"device_ids\": {
            \"device_id\": [
                1,
                2,
                3,
                4
            ]
        },
        \"low_severity\": true,
        \"medium_severity\": true,
        \"high_severity\": true,
        \"critical_severity\": false,
        \"user_ids\": {
            \"user_id\": [
                \"moshe\",
                \"admin\"
                ]
        },
        \"emails\": \"user@doamin.com\",
        \"send_syslog\": true
    }
}


Response Messages:
204: Alert ID: 'alertId' was updated successfully
404: Alert ID: 'alertId' does not exist
412: Alert name not specified
409: Alert name specified already exists
412: Status not specified
412: Domain not specified
404: Domain specified does not exist
403: User is not authorized to configure alerts for domain 'domainId'
412: Device not specified
404: Device ID specified does not exist or belongs to a different domain
403: Device: 'deviceId' not supported for USP
412: Severity not specified
412: No recipient details entered for alert
412: Invalid email address. Format must be name@domain.com
404: Username: 'userName' does not exist
403: User is not authorized to configure alerts for Super Admin user: 'userName'
403: Username: 'userName' not valid for the specified domain"},"response":[]}]},{"name":"Unified Security Policy - Cloud Tag Policy","item":[{"name":"Check if tags are compliant with cloud tag policies","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":" {\n\t\"type\": \"vm\",\n\t\"name\": \"CRM-FE\",\n\t\"os\": \"ubuntu14.4\",\n\t\"image\": \"AMI-12345\",\n\t\"tags\": {\n\t\t\"Role\": \"webserver\",\n\t\t\"Budget\": \"corporate\",\n\t\t\"Owner\": \"Steve.Smith\"\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/violation_check/","description":"Check if the tags of a cloud resource are compliant with the specified cloud tag policy. Specify the tag policy to validate in the TagPolicyViolationsCheckRequestDTO. The tags of a cloud resource are specified as a json object with the attribute 'tags' at the root level. 'tags' attributes can be a list of tag names or a map including both the tag name and value. If no tags are specified or if the tag is specified incorrectly, The compliance check will treat the resource as if it has no tags. If no cloud tag policy violations are found the API returns an empty violations list.

Parameters:
context: Returns results for the specified domain ID [optional]
policy_external_id: Tag policy external identifier
body: Tag policy violation check request

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/violation_check?policy_external_id=policyId
BODY {
    \"type\": \"vm\",
    \"name\": \"CRM-FE\",
    \"os\": \"ubuntu14.4\",
    \"image\": \"AMI-12345\",
    \"tags\": {
        \"Role\": \"webserver\",
        \"Budget\": \"corporate\",
        \"Owner\": \"Steve.Smith\"
    }
}


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions
404: Resource not found"},"response":[]},{"name":"Replace a cloud tag policy","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"policy_name\": \"myPolicyName\",\n\t\"requirements\": [\n\t\t{\n\t\t\t\"requirement_type\": \"mandatory_tags\",\n\t\t\t\"requirement_name\": \"mandatory_requirement1\",\n\t\t\t\"requirement_severity\": \"CRTICAL\",\n\t\t\t\"tags\": [\n\t\t\t\t\"Owner\",\n\t\t\t\t\"Role\"\n\t\t\t]\n\t\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","description":"Replace the cloud tag policy specified by policyID with the new policy attributes.

Use PATCH in order to partially modify a policy. If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Replace policy of the specified domain ID [optional]
policyId: cloud tag policy id [optional]
body: cloud tag policy dTO [optional]

Usage Example
URLhttps://{ip}/securetrack/api/tagpolicy/policies/policyId
BODY{
    \"policy_name\": \"myPolicyName\",
    \"requirements\": [
        {
            \"requirement_type\": \"mandatory_tags\",
            \"requirement_name\": \"mandatory_requirement1\",
            \"requirement_severity\": \"CRTICAL\",
            \"tags\": [
                \"Owner\",
                \"Role\"
            ]
        }
    ]
}
OUTPUT{
        \"status\": \"OK\",
        \"policy_id\": \"tp-123\"
}

"},"response":[]},{"name":"Get cloud tag policy","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","description":"This API retrieves the details of the cloud tag policy specified by policyId.

User must have admin permissions to the policy affiliated domain. If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Returns results for the specified domain ID [optional]
policyId: cloud tag policy id [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/policyId
OUTPUT{
        \"status\": \"OK\",
        \"result\": [
                {
                        \"policy_id\": \"tp-101\",
                        \"policy_name\": \"myPolicyName\",
                        \"requirements\": [
                                {
                                        \"requirement_type\": \"mandatory_tags\",
                                        \"requirement_name\": \"myMandatoryTagsRequirement\",
                                    \"requirement_severity\": \"CRTICAL\",
                                        \"tags\": [
                                                \"Owner\",
                                                \"Name\"
                                        ]
                                },
                                {
                                        \"requirement_type\": \"valid_values\",
                                        \"requirement_name\": \"myValidValueRequirement\",
                                    \"requirement_severity\": \"CRTICAL\",
                                        \"tag\": \"Budget\",
                                        \"values\": [
                                                \"R&D\",
                                                \"HR\"
                                        ]
                                }
                        ]
                }
        ]
}


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions
404: Resource not found"},"response":[]},{"name":"Modify a cloud tag policy","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"policy_name\": \"myPolicyName\",\n\t\"requirements\": [\n\t\t{\n\t\t\t\"requirement_type\": \"mandatory_tags\",\n\t\t\t\"requirement_name\": \"mandatory_requirement1\",\n\t\t\t\"requirement_severity\": \"CRTICAL\",\n\t\t\t\"tags\": [\n\t\t\t\t\"Owner\",\n\t\t\t\t\"Role\"\n\t\t\t]\n\t\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","description":"Partially modify a cloud tag policy by stating the modified attributes. Providing requirements replaces the entire list.

Specifying an empty requirement list is not permitted. Modify some attributes of the cloud tag policy specified by policyID with the attributes provided. If one or more \"requirement\" objects is provided, the exsiting \"requirement\" objects will be deleted and replaced with the new objetcs. Specifying an empty requirement list is not permitted.If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Rename policy of the specified domain ID [optional]
policyId: cloud tag policy id [optional]
body: cloud tag policy dTO [optional]

Usage Example
URLhttps://{ip}/securetrack/api/tagpolicy/policies/policyId
BODY{
    \"policy_name\": \"myPolicyName\",
    \"requirements\": [
        {
            \"requirement_type\": \"mandatory_tags\",
            \"requirement_name\": \"mandatory_requirement1\",
            \"requirement_severity\": \"CRTICAL\",
            \"tags\": [
                \"Owner\",
                \"Role\"
            ]
        }
    ]
}
OUTPUT{
        \"status\": \"OK\",
        \"policy_id\": \"tp-123\"
}


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions
404: Resource not found"},"response":[]},{"name":"Delete cloud tag policy","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","description":"Delete the cloud tag policy specified by policyId.

If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Delete policy of the specified domain ID [optional]
policyId: cloud tag policy id [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/policyId
OUTPUT {
        \"status\": \"OK\",
        \"policy_name\": \"myPolicyName\"
}


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions
404: Resource not found"},"response":[]},{"name":"Get all cloud tag policies","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/policies/","description":"This API returns the details of all the tag policies.

Results are filtered according to user domain permissions and request context. If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Returns results for the specified domain ID [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/
OUTPUT{
        \"status\": \"OK\",
        \"result\": [
                {
                        \"policy_id\": \"tp-101\",
                        \"policy_name\": \"myPolicy1\",
                        \"requirements\": [
                                {
                                        \"requirement_type\": \"mandatory_tags\",
                                        \"requirement_name\": \"myMandatoryRequirement\",
                                        \"requirement_severity\": \"HIGH\",
                                        \"tags\": [
                                                \"Owner\",
                                                \"Name\"
                                        ]
                                },
                                {
                                        \"requirement_type\": \"valid_values\",
                                        \"requirement_name\": \"myValidValueRequirement\",
                                        \"requirement_severity\": \"CRTICAL\",
                                        \"tag\": \"Budget\",
                                        \"values\": [
                                                \"R&D\",
                                                \"HR\"
                                        ]
                                }
                        ]
                },
                {
                        \"policy_id\": \"tp-102\",
                        \"policy_name\": \"myPolicy2\",
                        \"requirements\": [
                                {
                                        \"requirement_type\": \"mandatory_tags\",
                                        \"requirement_name\": \"myMandatoryRequirement\",
                                        \"requirement_severity\": \"HIGH\",
                                        \"tags\": [
                                                \"Owner\"
                                        ]
                                },
                                {
                                        \"requirement_type\": \"valid_values\",
                                        \"requirement_name\": \"myValidValueRequirement\",
                                        \"requirement_severity\": \"CRTICAL\",
                                        \"tag\": \"Budget\",
                                        \"values\": [
                                                \"R&D\",
                                                \"HR\"
                                        ]
                                }
                        ]
                }
        ]
}


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions"},"response":[]},{"name":"Create a cloud tag policy","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":" {\n\t\"policy_name\": \"Production-VPC-Tag-Policy\",\n\t\"policy_description\": \"Instances tags in production\",\n\t\"requirements\": [\n\t\t{\n\t\t\t\"requirement_type\": \"mandatory_tags\",\n\t\t\t\"requirement_name\": \"mandatory_financial_tags\",\n\t\t\t\"requirement_severity\": \"HIGH\",\n\t\t\t\"tags\": [\n\t\t\t\t\"Owner\",\n\t\t\t\t\"Budget\"\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"requirement_type\": \"valid_values\",\n\t\t\t\"requirement_name\": \"budget_valid_values\",\n\t\t\t\"requirement_severity\": \"CRITICAL\",\n\t\t\t\"tag\": \"Budget\",\n\t\t\t\"values\": [\n\t\t\t\t\"Corporate\",\n\t\t\t\t\"Dev\"\n\t\t\t]\n\t\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/policies/","description":"Create a new cloud tag policy. The policyName field specified in the TagPolicyDTO must be unique. Define the requirements enforced by the cloud tag policy in the requirements field of the TagPolicyDTO. The supported value for the \"requirement_type\" field are \"mandatory_tags\" and \"valid_values\"If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Create policy for the specified domain ID [optional]
body: cloud tag policy DTO [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/
BODY {
    \"policy_name\": \"Production-VPC-Tag-Policy\",
    \"policy_description\": \"Instances tags in production\",
    \"requirements\": [
        {
            \"requirement_type\": \"mandatory_tags\",
            \"requirement_name\": \"mandatory_financial_tags\",
            \"requirement_severity\": \"HIGH\",
            \"tags\": [
                \"Owner\",
                \"Budget\"
            ]
        },
        {
            \"requirement_type\": \"valid_values\",
            \"requirement_name\": \"budget_valid_values\",
            \"requirement_severity\": \"CRITICAL\",
            \"tag\": \"Budget\",
            \"values\": [
                \"Corporate\",
                \"Dev\"
            ]
        }
    ]
}
OUTPUT{
        \"status\": \"OK\",
        \"policy_id\": \"tp-123\"
}


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions
409: Policy name already exists"},"response":[]},{"name":"Get all cloud tag policy violations for a VPC","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"deviceId"},{"value":null,"type":"text","key":"severity"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/tag_violations/","description":"Retrieve all cloud tag policy violations for the specified VPC and severity level.

Parameters:
context: Global MSSP context. [optional]
deviceId: The device ID for which to get violations
severity: Return only violations of this severity
resourceId: The id of the VM instance [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses \"count=100\". [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tag_violations?deviceId=123&severity=CRITICAL
OUTPUT<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<tag_policy_device_violations>
    <violating_resources_count>2</violating_resources_count>
    <device_name>Amazon Test VPC </device_name>
    <severity>critical</severity>
    <violating_resources>
        <violating_resource>
            <tag_violations>
                <tag_violation>
                    <violation_message>Tag 'Name' value 'email server' is not valid. Valid values are [R&D, HR]</violation_message>
                    <policy_id>tp-100</policy_id>
                    <policy_name>Tag policy 1</policy_name>
                    <requirement_name>validValue_constraint2</requirement_name>
                    <requirement_severity>high</requirement_severity>
                    <violation_attributes xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"valid_values\">
                        <tag>Name</tag>
                        <valid_values>
                            <valid_value>R&D</valid_value>
                            <valid_value>HR</valid_value>
                        </valid_values>
                        <invalid_value>email server</invalid_value>
                    </violation_attributes>
                </tag_violation>
            </tag_violations>
            <resource_id>i-abc12345</resource_id>
            <resource_name>email server</resource_name>
        </violating_resource>
        <violating_resource>
            <tag_violations>
                <tag_violation>
                    <violation_message>Tag 'Application' is missing</violation_message>
                    <policy_id>tp-105</policy_id>
                    <policy_name>Tag policy 1</policy_name>
                    <requirement_name>mandatory_constraint1</requirement_name>
                    <requirement_severity>critical</requirement_severity>
                    <violation_attributes xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"mandatory_tags\">
                        <missing_tag>Application</missing_tag>
                    </violation_attributes>
                </tag_violation>
            </tag_violations>
            <resource_id>i-12345678</resource_id>
            <resource_name>Violations tests server</resource_name>
        </violating_resource>
    </violating_resources>
</tag_policy_device_violations>


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions
404: A device with the specified ID was not found"},"response":[]}]},{"name":"Unified Security Policy - Exceptions","item":[{"name":"Get a specific exception","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"exceptionId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/{{exceptionId}}","description":"Gets a specific exception for unified security policies.

Parameters:
exceptionId: The ID of the exception to get.
context: Global MSSP context [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/14

Response Messages:
403: User not permitted to access the specified domain
404: A security policy exception with the specified ID was not found."},"response":[]},{"name":"Delete an exception","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"exceptionId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/{{exceptionId}}","description":"Delete the specific unified security policy exceptions

Parameters:
exceptionId: The ID of the exception to delete.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/14

Response Messages:
404: The security policy with the specified ID does not exist
403: User not permitted to access the specified domain."},"response":[]},{"name":"Start a task to calculate matching rules for an exception","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"exceptionId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/{{exceptionId}}/matching_rules/start","description":"Create a calculation task to find matching rules.
The results will be on the relevant devices for each access.
Returns a task Id that can be used to check the task status and get the task results

Parameters:
exceptionId: Security policy Exception ID on which to run the API.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/1/matching_rules/start

Response Messages:
403: User not permitted to Security policy exceptions.
404: A security policy exception with the specified ID was not found."},"response":[]},{"name":"Get matching rules task status","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/matching_rules/status/{{taskId}}","description":"Parameters:
taskId: The unique identifier of the matching rules task.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/matching_rules/status/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Matching rules task status was received.
403: User not permitted to Security policy exceptions.
404: Matching rules task status was not found."},"response":[]},{"name":"Create an exception","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\n\tadmin\n\tst_user\n\t2015-01-01\n\tAllow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321\n\t\n\t\t\n\t\t\tCreating USP exception for ticket 123\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t192.168.1.2\n\t\t\t\t\t\t255.255.255.255\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\tLAN\n\t\t\t\t\tcorporate security policy\n\t\t\t\t\tDMZ\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t4321\n\t\t\t\t\t\ttcp\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t1\n\t\t\t\t\t\t{5aa1c104-bd4d-4635-a281-b3a5442639ba}\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\thttp\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t10\n\t\t\t\t\t\t20\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t192.168.1.1\n\t\t\t\t\t\t255.255.255.255\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\t2025-01-01\n\tAllow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321\n\tadmin\n\t123\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/","description":"Create an exception for unified security policies.

Parameters:
context: Global MSSP context [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_policies/exceptions
BODY<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<security_policy_exception>
    <approved_by>admin</approved_by>
    <created_by>st_user</created_by>
    <creation_date>2015-01-01</creation_date>
    <description>Allow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321</description>
    <exempted_traffic_list>
        <exempted_traffic>
            <comment>Creating USP exception for ticket 123</comment>
            <dest_network_collection>
                <network_items>
                    <network_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"subnet\">
                        <ip>192.168.1.2</ip>
                        <netmask>255.255.255.255</netmask>
                    </network_item>
                </network_items>
            </dest_network_collection>
            <security_requirements>
                <zone_to_zone_security_requirement>
                    <from_zone>LAN</from_zone>
                    <policy_name>corporate security policy</policy_name>
                    <to_zone>DMZ</to_zone>
                </zone_to_zone_security_requirement>
            </security_requirements>
            <service_collection>
                <service_items>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"custom\">
                        <port>4321</port>
                        <protocol>tcp</protocol>
                    </service_item>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"device_service\">
                        <mgmt_id>1</mgmt_id>
                        <service_uid>{5aa1c104-bd4d-4635-a281-b3a5442639ba}</service_uid>
                    </service_item>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"predefined\">
                        <predefined_service_name>http</predefined_service_name>
                    </service_item>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"range_service\">
                        <minProtocol>10</minProtocol>
                        <maxProtocol>20</maxProtocol>
                    </service_item>
                </service_items>
            </service_collection>
            <source_network_collection>
                <network_items>
                    <network_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"subnet\">
                        <ip>192.168.1.1</ip>
                        <netmask>255.255.255.255</netmask>
                    </network_item>
                </network_items>
            </source_network_collection>
        </exempted_traffic>
    </exempted_traffic_list>
    <expiration_date>2025-01-01</expiration_date>
    <name>Allow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321</name>
    <requested_by>admin</requested_by>
    <ticket_id>123</ticket_id>
</security_policy_exception>


Response Messages:
400: The specified network item is not valid.
400: The specified zone name does not exist.
400: The security policy with the specified name does not exist
400: The security policy 'created by' user is not valid.
400: The security policy with the specified name already exists.
403: User not permitted to access the specified domain."},"response":[]},{"name":"Get all exceptions","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/","description":"Gets a list of all unified security policy exceptions.

Parameters:
context: Global MSSP context [optional]
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query starting from starting page allowable type in numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions

Response Messages:
403: User not permitted to access the specified domain"},"response":[]},{"name":"Get matching rules task results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/matching_rules/result/{{taskId}}","description":"Parameters:
taskId: The unique identifier of the matching rules task.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/matching_rules/result/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Matching rules task results were received.
403: User not permitted to Security policy exceptions.
404: An error occurred during the calculation.
404: The calculation for the task has not finished yet."},"response":[]},{"name":"Cancel Matching rules task","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/matching_rules/{{taskId}}","description":"Parameters:
taskId: The unique identifier of the matching rules task.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/matching_rules/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
204: Matching rules task has been aborted successfully.
403: User not permitted to Security policy exceptions.
404: Matching rules task was not found."},"response":[]}]},{"name":"Unified Security Policy - Security Zone Matrix","item":[{"name":"Delete unified security policy","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/{{id}}","description":"Delete a Security Policy Matrix

Parameters:
context: Returns results for the specified domain ID. [optional]
id: The unique identifier of the security policy matrix to delete

Usage Example
https://192.168.1.1/securetrack/api/security_policies/1
"},"response":[]},{"name":"Get zone to interface mapping","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"deviceId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/{{deviceId}}/mapping","description":"Fetches mapping of SecureTrack zones to device interfaces

Parameters:
context: Global MSSP context [optional]
deviceId: Device ID

Usage Example
https://127.0.0.1/securetrack/api/security_policies/9/mapping

Response Messages:
200: Successful
400: This device does not support zone to interface mapping
403: User not permitted to access the specified domain
404: Device ID: <deviceId> does not exist
404: Access denied for device with ID: <deviceId>"},"response":[]},{"name":"Get unified security policy as CSV","request":{"method":"GET","header":[],"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/{{id}}/export","description":"Exports a Security Policy in CSV format

Parameters:
context: Returns results for the specified domain ID. [optional]
id: ID of the security policy. [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies/1/export

Response Messages:
403: User not permitted to access the specified domain
404: Security Policy does not exist"},"response":[]},{"name":"Get unified security policies","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/","description":"Fetches the security zone matrices defined under Unified Security Policy.

Parameters:
context: Returns results for the specified domain ID. [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies

Response Messages:
403: User not permitted to access the specified domain"},"response":[]},{"name":"Get global unified security policies","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/global","description":"Fetches the global security zone matrices defined under Unified Security Policy.



Usage Example
https://192.168.1.1/securetrack/api/security_policies/global

Response Messages:
403: User not permitted to access global security policies"},"response":[]},{"name":"Set manual device mapping","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n \n Vlan_30\n \n \n 10\n add\n \n \n \n\n "},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/{{deviceId}}/manual_mapping","description":"Add or remove a zone on a device interface

Parameters:
context: Global MSSP context [optional]
deviceId: Device ID
body: InterfacesManualMappingsDTO

Usage Example
URLhttps://127.0.0.1/securetrack/api/security_policies/10/manual_mapping
BODY<interfaces_manual_mappings>
<interface_manual_mapping>
<interface_name>Vlan_30</interface_name>
<zones_user_actions>
<zone_user_action>
<zoneId>10</zoneId>
<action>add</action>
</zone_user_action>
</zones_user_actions>
</interface_manual_mapping>
</interfaces_manual_mappings>


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions
404: Not found error
404: User action not valid (only add/remove)
404: No interface with name for device with id
404: No zone with id
404: No revision for device with id
404: Device ID: <deviceId> does not exist
404: Access denied for device with ID: <deviceId>
404: InterfacesManualMappingsDTO is empty
404: Error on updating security_policy_interface_zone_mapping_user_action table for device with ID"},"response":[]}]},{"name":"Unified Security Policy - Violations","item":[{"name":"Get the amount of violating rules for the specified device.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"deviceId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/violating_rules/{{deviceId}}/count","description":"Parameters:
deviceId: The device ID for which to get violations.

Usage Example
https://192.168.1.1/securetrack/api/violating_rules/1/count

Response Messages:
200: The violation count was successfully retrieved
404: Device with id: <deviceId> doesn't exist"},"response":[]},{"name":"Get the violating rules for the specified device.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"deviceId"},{"value":null,"type":"text","key":"severity"},{"value":null,"type":"text","key":"type"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/violating_rules/{{deviceId}}/device_violations","description":"policyName is supported for management devices running in Advanced management mode.

Parameters:
deviceId: The device ID for which to get violations
policyName: Return only violations that match this policy [optional]
severity: Return only violations of this severity
type: Return only violations of this type

Usage Example
https://192.168.1.1/securetrack/api/violating_rules/1/device_violations?policy=policy_name&type=SECURITY_POLICY&severity=MEDIUM

Response Messages:
200: The violations were successfully retrieved
400: The specified value for the violation severity is invalid
400: The specified value for the violation type is invalid
400: You cannot specify a policyName because the device is not running in Advanced management mode
404: A device with the specified ID was not found
404: A policy with the specified policyName was not found for this device"},"response":[]}]}]} \ No newline at end of file diff --git a/Postman Format v2/R20-2 postman collection/tufin.postman_environment b/Postman Format v2/R20-2 postman collection/tufin.postman_environment new file mode 100644 index 0000000..c031d2b --- /dev/null +++ b/Postman Format v2/R20-2 postman collection/tufin.postman_environment @@ -0,0 +1 @@ +{"name":"Tufin environment","values":[{"type":"text","key":"SecureApp_IP"},{"type":"text","key":"SecureChange_IP"},{"type":"text","key":"SecureTrack_IP"},{"type":"text","key":"applicationId"},{"type":"text","key":"applicationInterfaceId"},{"type":"text","key":"application_id"},{"type":"text","key":"application_pack_id"},{"type":"text","key":"assigneeId"},{"type":"text","key":"child_id"},{"type":"text","key":"child_ids"},{"type":"text","key":"cleanup_id"},{"type":"text","key":"cloudId"},{"type":"text","key":"cloud_id"},{"type":"text","key":"connectionId"},{"type":"text","key":"connectionInterfaceId"},{"type":"text","key":"connectionToApplicationId"},{"type":"text","key":"connection_id"},{"type":"text","key":"connection_to_application_pack_id"},{"type":"text","key":"customer_id"},{"type":"text","key":"deviceId"},{"type":"text","key":"device_id"},{"type":"text","key":"domainId"},{"type":"text","key":"exceptionId"},{"type":"text","key":"fieldId"},{"type":"text","key":"id"},{"type":"text","key":"ids"},{"type":"text","key":"inId"},{"type":"text","key":"instructionId"},{"type":"text","key":"interfaceCustomerId"},{"type":"text","key":"layer2DataId"},{"type":"text","key":"managementId"},{"type":"text","key":"mgmtId"},{"type":"text","key":"parent_id"},{"type":"text","key":"parent_ids"},{"type":"text","key":"policyId"},{"type":"text","key":"requestId"},{"type":"text","key":"revId"},{"type":"text","key":"revision_id"},{"type":"text","key":"risk_id"},{"type":"text","key":"routeId"},{"type":"text","key":"ruleId"},{"type":"text","key":"rule_id"},{"type":"text","key":"rule_uid"},{"type":"text","key":"serverId"},{"type":"text","key":"serviceId"},{"type":"text","key":"sourceApplicationId"},{"type":"text","key":"stepId"},{"type":"text","key":"tag_id"},{"type":"text","key":"targetApplicationId"},{"type":"text","key":"taskId"},{"type":"text","key":"task_id"},{"type":"text","key":"task_uid"},{"type":"text","key":"toStepId"},{"type":"text","key":"uid"},{"type":"text","key":"userId"},{"type":"text","key":"vpnId"},{"type":"text","key":"zone_id"},{"type":"text","key":"zone_ids"}]} \ No newline at end of file diff --git a/Postman Format v2/R21-1 postman collection/securechangeworkflow_R21-1-RC1-v2.json b/Postman Format v2/R21-1 postman collection/securechangeworkflow_R21-1-RC1-v2.json new file mode 100644 index 0000000..42c8681 --- /dev/null +++ b/Postman Format v2/R21-1 postman collection/securechangeworkflow_R21-1-RC1-v2.json @@ -0,0 +1 @@ +{"info":{"_postman_id":"2","name":"Tufin Tufin SecureChange/SecureApp R21-1-RC1","description":"Tufin Orchestration Suite - Tufin SecureChange/SecureApp APIs.
For detailed information about the APIs please see the documentation at:
https://your-securetrack-server/securechangeworkflow/apidoc","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json"},"item":[{"name":"Access Portal","item":[{"name":"Update application access requests","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t1\n\t\tAPPROVE\n\t\n\t\n\t\t2\n\t\tREJECT\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests","description":"Use this API to approve or reject application access requests

Parameters:
applicationId: The unique identifier of the application
body: application access requests

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests
BODY<application_access_requests>
    <application_access_request>
        <id>1</id>
        <action>APPROVE</action>
    </application_access_request>
    <application_access_request>
        <id>2</id>
        <action>REJECT</action>
    </application_access_request>
</application_access_requests>


Response Messages:
200: Application access requests were updated.
400: The application was already deleted.
400: Invalid ID for access request
400: Cannot update access request with id ID
400: Action cannot be empty in request with id ID
400: Invalid action in request with id ID
400: The Server group is lock for discovery
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]},{"name":"Create application access request","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t1\n\t1.1.1.1\n\tRequest to join the WebServers server group\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests","description":"Parameters:
applicationId: The unique identifier of the application
body: application access request

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests
BODY<application_access_request>
    <server_group_id>1</server_group_id>
    <server_ip>1.1.1.1</server_ip>
    <comment>Request to join the WebServers server group</comment>
</application_access_request>


Response Messages:
201: Application access request was submitted.
400: The application was already deleted.
400: Server id cannot be empty.
400: Hostname or IP cannot be empty.
400: The provided server does not exist in application.
400: The provided server is not allowed to access.
400: Request already created
400: Requester cannot be null
400: Group cannot be empty
400: Invalid ip
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]},{"name":"Retrieve existing application access requests","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests","description":"Parameters:
applicationId: The unique identifier of the application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests

Response Messages:
400: The application was already deleted.
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID."},"response":[]},{"name":"Update an application access request","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tAPPROVE\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests/{{requestId}}","description":"Use this API to approve or reject application access requests

Parameters:
applicationId: The unique identifier of the application
requestId: The unique identifier of the application access request
body: application access request

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests/1
BODY<application_access_request>
    <action>APPROVE</action>
</application_access_request>


Response Messages:
200: Application access request was updated.
400: The application was already deleted.
400: Invalid ID for access request
400: Cannot update access request with id ID
400: Action cannot be empty in request with id ID
400: Invalid action in request with id ID
400: The Server group is lock for discovery
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]},{"name":"Retrieve an existing application access request by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"requestId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_access_requests/{{requestId}}","description":"Parameters:
applicationId: The unique identifier of the application
requestId: The unique identifier of the application access request

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_access_requests/1

Response Messages:
400: The application was already deleted.
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Access request with id ID was not found in application with id ID"},"response":[]}]},{"name":"Application Connections","item":[{"name":"Retrieve existing connections, with extended resources information","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_extended","description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the connection [optional]
start: Return results starting only from the specified index; 0-based index; default value = 0 [optional]
count: Return the specified number of results. Returns all results if no value specified [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended?name=Connection Name

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_extended?name=Connection Name&start=50&count=100

Response Messages:
400: Start value cannot be a negative number.
400: Count value must be greater than 0.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: Access is denied.
404: There is no application with the specified ID.
404: There are no connections with the name NAME."},"response":[]},{"name":"Create a ticket to repair a connection","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tRepair connection 2\n\tu1\n\tNormal\n\t\n\t\tWorkflow with topology\n\t\n\t\n\t\t\n\t\t\tOpen request\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tBusiness Justification\n\t\t\t\t\t\t\tI need access to ftp \n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tProject Number\n\t\t\t\t\t\t\tCR124560\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tHyperlink\n\t\t\t\t\t\t\thttp://192.168.1.1/ticket\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tChange Window\n\t\t\t\t\t\t\tMonday\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\tmanager email\n\t\t\t\t\t\t\tmanager@tufin.com\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connections/{{connection_id}}/repair","description":"Parameters:
application_id: The application ID
connection_id: The connection ID
body: Ticket

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/2/repair
BODY<ticket>
    <subject>Repair connection 2</subject>
    <requester>u1</requester>
    <priority>Normal</priority>
    <workflow>
        <name>Workflow with topology</name>
    </workflow>
    <steps>
        <step>
            <name>Open request</name>
            <tasks>
                <task>
                    <fields>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_area\">
                            <name>Business Justification</name>
                            <text>I need access to ftp </text>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_field\">
                            <name>Project Number</name>
                            <text>CR124560</text>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"hyperlink\">
                            <name>Hyperlink</name>
                            <url>http://192.168.1.1/ticket</url>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"drop_down_list\">
                            <name>Change Window</name>
                            <selection>Monday</selection>
                        </field>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"manager\">
                            <name>manager email</name>
                            <text>manager@tufin.com</text>
                        </field>
                    </fields>
                </task>
            </tasks>
        </step>
    </steps>
    <comments/>
</ticket>


Response Messages:
201: Ticket was created.
400: The requester must be the currently logged in user.
400: Workflow was not found.
400: Workflow is not active.
400: Workflow configuration is not valid.
400: Workflow is not set.
400: You cannot enter a status for a new ticket.
400: Requester cannot open a ticket in domain.
400: Invalid ticket priority.
400: Expiration field is required.
400: Submit ticket enabled only with the first step.
400: First step can be only with one task.
400: The specified workflow does not contain an access request field in the first step.
400: You cannot use an access request field to create a ticket from SecureApp.
400: The ticket fields do not match the fields in the current step of the workflow.
400: You cannot change the value of a field because it is read-only.
403: Logged in user: NAME do not have permission to perform on behalf actions.
403: You are not a participant in the first step of this workflow.
403: Access is denied.
403: To create a ticket you must purchase a valid SecureChange license.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: Cannot create a ticket to repair this connection because the connection status is not disconnected.
403: Cannot create a ticket to repair this connection because the connection was edited but a ticket has not been created yet.
403: Cannot create a ticket to repair this connection because there are other open tickets for an application that includes this connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID."},"response":[]},{"name":"Update a connection","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":" \n\t Connection A\n\t Connection A comment\n\t \n\t\t \n\t\t\t 2\n\t\t \n\t\t \n\t\t\t 3\n\t\t \n\t \n\t \n\t\t \n\t\t\t 1\n\t\t \n\t \n\t \n\t\t \n\t\t\t 1\n\t\t \n\t \n "},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}","description":"Parameters:
applicationId: The unique identifier of the application
connectionId: The unique identifier of the connection
body: Connection

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections/1
BODY <connection>
     <name>Connection A</name>
     <comment>Connection A comment</comment>
     <sources>
         <source>
             <id>2</id>
         </source>
         <source>
             <id>3</id>
         </source>
     </sources>
     <services>
         <service>
             <id>1</id>
         </service>
     </services>
     <destinations>
         <destination>
             <id>1</id>
         </destination>
     </destinations>
</connection>


Response Messages:
200: Connection was modified.
400: Reference to service ID is invalid.
400: Reference to source/destination with ID is invalid.
400: Connection name cannot be empty.
400: Connection name already exists.
400: Connection NAME contains duplicate destinations.
400: Destination cannot contain users.
400: Resource cannot contain other objects along with Any.
400: Connection NAME contains duplicate sources.
400: You cannot add external resources to interface connections.
400: You cannot have Any in both the source and destination.
400: You cannot add external resources to interface connections.
400: Source cannot contain both users and servers.
400: Connection NAME contains duplicate services.
400: Cannot contain other services along with ANY.
400: Connections can only include objects within the same customer.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permission to access application that contains the server ID
403: You do not have permissions to edit this application.
403: Access is denied
403: You cannot edit or delete an external connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID."},"response":[]},{"name":"Delete connection","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"connectionId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}","description":"Parameters:
applicationId: The unique identifier of the application
connectionId: The unique identifier of the connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/1

Response Messages:
200: Connection was deleted.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: Access is denied
403: You cannot edit or delete an external connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID."},"response":[]},{"name":"Retrieve an existing connection by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"connectionId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections/{{connectionId}}","description":"Parameters:
applicationId: The unique identifier of the application
connectionId: The unique identifier of the connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections/1

Response Messages:
401: No available licenses. Ask your SecureApp administrator for assistance.
403: Access is denied
403: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID."},"response":[]},{"name":"Update connections","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t 1\n\t\t Connection A\n\t\t Connection A comment\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t\t \n\t\t\t\t 3\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t \n\t \n\t\t 2\n\t\t Connection B\n\t \n\t \n\t\t 3\n\t\t Connection C\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t \n\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections","description":"Parameters:
applicationId: The unique identifier of the application
body: List of connections

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections
BODY<connections>
     <connection>
         <id>1</id>
         <name>Connection A</name>
         <comment>Connection A comment</comment>
         <sources>
             <source>
                 <id>2</id>
             </source>
             <source>
                 <id>3</id>
             </source>
         </sources>
         <services>
             <service>
                 <id>1</id>
             </service>
         </services>
         <destinations>
             <destination>
                 <id>1</id>
             </destination>
         </destinations>
     </connection>
     <connection>
         <id>2</id>
         <name>Connection B</name>
     </connection>
     <connection>
         <id>3</id>
         <name>Connection C</name>
         <sources>
             <source>
                 <id>2</id>
             </source>
         </sources>
     </connection>
</connections>


Response Messages:
200: Connections were modified.
400: Reference to service ID is invalid.
400: Reference to source/destination with ID is invalid.
400: Connection name cannot be empty.
400: Connection name already exists.
400: Connection NAME contains duplicate destinations.
400: Destination cannot contain users.
400: Resource cannot contain other objects along with Any.
400: Connection NAME contains duplicate sources.
400: You cannot add external resources to interface connections.
400: You cannot have Any in both the source and destination.
400: You cannot add external resources to interface connections.
400: Source cannot contain both users and servers.
400: Connection NAME contains duplicate services.
400: Cannot contain other services along with ANY.
400: Connections can only include objects within the same customer.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permission to access application that contains the server ID
403: You do not have permissions to edit this application.
403: Access is denied
403: You cannot edit or delete an external connection.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection with ID was not found for application with ID."},"response":[]},{"name":"Retrieve existing connections","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections","description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the connection [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections?name=Connection Name

Response Messages:
401: No available licenses. Ask your SecureApp administrator for assistance.
403: Access is denied
403: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: There are no connections with the name NAME."},"response":[]},{"name":"Create connections","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t Connection A\n\t\t Connection A comment\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t\t \n\t\t\t\t 3\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 1\n\t\t\t \n\t\t \n\t \n\t \n\t\t Connection B\n\t \n\t \n\t\t Connection C\n\t\t \n\t\t\t \n\t\t\t\t 2\n\t\t\t \n\t\t \n\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections","description":"Parameters:
applicationId: The unique identifier of the application
body: The list of the connections

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/connections
BODY<connections>
     <connection>
         <name>Connection A</name>
         <comment>Connection A comment</comment>
         <sources>
             <source>
                 <id>2</id>
             </source>
             <source>
                 <id>3</id>
             </source>
         </sources>
         <services>
             <service>
                 <id>1</id>
             </service>
         </services>
         <destinations>
             <destination>
                 <id>1</id>
             </destination>
         </destinations>
     </connection>
     <connection>
         <name>Connection B</name>
     </connection>
     <connection>
         <name>Connection C</name>
         <sources>
             <source>
                 <id>2</id>
             </source>
         </sources>
     </connection>
</connections>


Response Messages:
200: Connections were created.
201: Connection was created.
400: There are no items to add.
400: You cannot add to application NAME because it was decommissioned.
400: Connection name already exists.
400: Reference to service ID is invalid.
400: Reference to source/destination with ID is invalid.
400: Connection NAME contains duplicate destinations.
400: Destination cannot contain users.
400: Resource cannot contain other objects along with Any.
400: Connection NAME contains duplicate sources.
400: You cannot add external resources to interface connections.
400: You cannot have Any in both the source and destination.
400: You cannot add external resources to interface connections.
400: Source cannot contain both users and servers.
400: Connection NAME contains duplicate services.
400: Cannot contain other services along with ANY.
400: Connections can only include objects within the same customer.
403: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: Access is denied
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]}]},{"name":"Application Identities","item":[{"name":"Fetches application identities","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/application_identities","description":"Fetches the list of pre-defined application identities (like facebook) that can be used in a connection.

Parameters:
name: The name of the service [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/application_identities

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/application_identities?name=facebook

Response Messages:
404: There are no application identities with the name NAME.
403: Access is denied."},"response":[]}]},{"name":"Application Interfaces","item":[{"name":"Create interface connections","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\tConnection 1\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\t\n\t\t\t\tFacebook\n\t\t\t\n\t\t\n\t\tNew connection\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections","description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
body: The interface connections

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections
BODY<interface_connections>
    <interface_connection>
        <name>Connection 1</name>
        <sources>
            <source>
                <id>3</id>
            </source>
        </sources>
        <services>
            <service>
                <id>3</id>
            </service>
            <service>
                <id>Facebook</id>
            </service>
        </services>
        <comment>New connection</comment>
    </interface_connection>
</interface_connections>


Response Messages:
200: Interface connections were created.
201: Interface connection was created.
400: There are no items to add.
400: Cannot create interface connection without a name.
400: Connection name already exists.
400: You cannot add user to connection interface.
400: You cannot add Any to connection interface.
400: You cannot add Internet to connection interface.
400: Cannot have external servers.
400: Cannot have both sources and destinations.
400: Connection NAME contains duplicate sources.
400: Connection NAME contains duplicate services.
400: Connection NAME contains duplicate destinations.
400: Reference to source/destination with ID is invalid.
400: Reference to service ID is invalid.
403: Access is denied.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID."},"response":[]},{"name":"Retrieve existing interface connections","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"applicationInterfaceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections","description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
name: The name of the interface connection [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections?name=Connection 1

Response Messages:
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There are no connection interfaces with the name NAME.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID."},"response":[]},{"name":"Retrieve existing application interfaces","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces","description":"To improve response time, set 'calculateIsPublished = false' to avoid calculating 'is_published'.

Parameters:
applicationId: The unique identifier of the application
name: The name of the application interface [optional]
calculateIsPublished: Should calculate is_published value [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces?name=Interface to Application 1

Response Messages:
400: There is no application with the specified ID.
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There are no application interfaces with the name NAME."},"response":[]},{"name":"Create application interface","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tInterface to Application 1\n\tNew application interface\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces","description":"Parameters:
applicationId: The unique identifier of the application
body: The application interface

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces
BODY<application_interface>
    <name>Interface to Application 1</name>
    <comment>New application interface</comment>
</application_interface>


Response Messages:
201: Application interface was created.
400: You cannot add to application NAME because it was decommissioned.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID."},"response":[]},{"name":"Delete interface connection","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"applicationInterfaceId"},{"value":null,"type":"text","key":"connectionInterfaceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}","description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
connectionInterfaceId: The unique identifier of the interface connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections/1

Response Messages:
200: Interface connection was deleted.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID."},"response":[]},{"name":"Update an interface connection","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tUpdated name\n\t\n\t\t\n\t\t\t19\n\t\t\n\t\n\t\n\t\t\n\t\t\t9\n\t\t\n\t\n\tUpdated connection\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}","description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
connectionInterfaceId: The unique identifier of the interface connection
body: The interface connection

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections/1
BODY<interface_connection>
    <name>Updated name</name>
    <sources>
        <source>
            <id>19</id>
        </source>
    </sources>
    <services>
        <service>
            <id>9</id>
        </service>
    </services>
    <comment>Updated connection</comment>
</interface_connection>


Response Messages:
200: Interface connection was modified.
400: Interface connection name cannot be empty.
400: Connection name already exists.
400: You cannot add user to connection interface.
400: You cannot add Any to connection interface.
400: You cannot add Internet to connection interface.
400: Cannot have external servers.
400: Cannot have both sources and destinations.
400: Connection NAME contains duplicate sources.
400: Connection NAME contains duplicate services.
400: Connection NAME contains duplicate destinations.
400: Reference to source/destination with ID is invalid.
400: Reference to service ID is invalid.
403: Access is denied.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID."},"response":[]},{"name":"Retrieve an existing interface connection by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"applicationInterfaceId"},{"value":null,"type":"text","key":"connectionInterfaceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}/interface_connections/{{connectionInterfaceId}}","description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface
connectionInterfaceId: The unique identifier of the interface connection

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1/interface_connections/1

Response Messages:
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID."},"response":[]},{"name":"Retrieve an existing connection to application by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"connectionToApplicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications/{{connectionToApplicationId}}","description":"Parameters:
applicationId: The unique identifier of the application
connectionToApplicationId: The unique identifier of the connection to application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications/1

Response Messages:
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Connection to application with ID was not found for application interface with ID."},"response":[]},{"name":"Delete connection to application","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"connectionToApplicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications/{{connectionToApplicationId}}","description":"Parameters:
applicationId: The unique identifier of the application
connectionToApplicationId: The unique identifier of the connection to application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications/1

Response Messages:
200: Connection to application was deleted.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection to application with ID was not found for application interface with ID."},"response":[]},{"name":"Update a connection to application","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tUpdated name\n\tUpdated connection to application\n\t\n\t\t\n\t\t\t4\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications/{{connectionToApplicationId}}","description":"Parameters:
applicationId: The unique identifier of the application
connectionToApplicationId: The unique identifier of the connection to application
body: The connection to application

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications/1
BODY<connection_to_application>
    <name>Updated name</name>
    <comment>Updated connection to application</comment>
    <servers>
        <server>
            <id>4</id>
        </server>
    </servers>
</connection_to_application>


Response Messages:
200: Connection to application was modified.
400: Name cannot be empty.
400: Name already exists.
400: Reference to source/destination with ID is invalid.
400: You cannot add ANY to connection to application.
400: You cannot add user to connection to application.
400: You cannot add Internet to connection to application.
403: Access is denied
403: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Connection to application with ID was not found for application interface with ID."},"response":[]},{"name":"Retrieve existing connections to application","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications","description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the connection to application [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications?name=Connection to Application 1

Response Messages:
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID.
404: Connection interface with ID was not found for application interface with ID."},"response":[]},{"name":"Create connection to application","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tConnection to Application 1\n\tNew connection to application\n\t1\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/connections_to_applications","description":"Create a connection from this application to an application interface.

Parameters:
applicationId: The unique identifier of the application
body: The connection to application

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connections_to_applications
BODY<connection_to_application>
    <name>Connection to Application 1</name>
    <comment>New connection to application</comment>
    <application_interface_id>1</application_interface_id>
    <servers>
        <server>
            <id>3</id>
        </server>
    </servers>
</connection_to_application>


Response Messages:
201: Connection to application was created.
400: You cannot add to application NAME because it was decommissioned.
400: The selected interface cannot be used more than once in the application.
400: Name cannot be empty.
400: Cannot create from local interface.
400: ApplicationInterface didn't got published.
400: Name already exists.
400: Cannot create connection to application without servers, there should be at least one server.
400: Reference to source/destination with ID is invalid.
400: You can use only interface from the same customer.
400: You cannot add ANY to connection to application.
400: You cannot add user to connection to application.
400: You cannot add Internet to connection to application.
403: Access is denied
403: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found."},"response":[]},{"name":"Update an application interface","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tupdated name\n\tUpdated application interface\n\ttrue\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}","description":"Update the application interface properties. If is_published is set to true, the application interface is published for use by other users.

Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of The application interface
body: The application interface

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1
BODY<application_interface>
    <name>updated name</name>
    <comment>Updated application interface</comment>
    <is_published>true</is_published>
</application_interface>


Response Messages:
200: Application interface was modified.
400: Application interface is not complete for publish.
400: Name cannot be empty.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID."},"response":[]},{"name":"Retrieve an existing application interface by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"applicationInterfaceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}","description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1

Response Messages:
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID."},"response":[]},{"name":"Delete application interface","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"applicationInterfaceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/application_interfaces/{{applicationInterfaceId}}","description":"Parameters:
applicationId: The unique identifier of the application
applicationInterfaceId: The unique identifier of the application interface

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/application_interfaces/1

Response Messages:
200: Application interface was deleted.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Application interface with ID was not found for application with ID."},"response":[]}]},{"name":"Application Migration","item":[{"name":"Update server mappings for source and target applications","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n\t\n\t\t\n\t\t\t5\n\t\t\n\t\t\n\t\t\t-1\n\t\t\n\t\n\t\n\t\t\n\t\t\t6\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/servers_mapping","description":"Use id=-1 for target_network_object if new mapping is ���Not Needed���.
If the source is specified and the target is empty, the mapping that is currently configured will be deleted.

Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application
body: The server mapping list [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/servers_mapping
BODY<servers_mapping>
    <server_mapping>
        <source_network_object>
            <id>3</id>
        </source_network_object>
        <target_network_object>
            <id>4</id>
        </target_network_object>
    </server_mapping>
    <server_mapping>
        <source_network_object>
            <id>5</id>
        </source_network_object>
        <target_network_object>
            <id>-1</id>
        </target_network_object>
    </server_mapping>
    <server_mapping>
        <source_network_object>
            <id>6</id>
        </source_network_object>
    </server_mapping>
</servers_mapping>


Response Messages:
200: Server mappings were modified.
400: Source network object cannot be empty.
400: Source network object is not valid
400: Target network object is not valid
400: Source and target network objects must be internal or external both.
400: Cannot use DEVICE application resources as external network objects.
400: Source network object with ID must be used by any connection.
400: Cannot remove mapping of network object with ID because it has never been mapped.
400: Cannot migrate application to itself.
400: Cannot map to ANY network object.
400: Cannot map Internet network object.
400: Cannot map to Internet network object.
400: Target network object ID must be in the same customer as the target application.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Server with ID was not found."},"response":[]},{"name":"Retrieve server mappings for source and target applications","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"sourceApplicationId"},{"value":null,"type":"text","key":"targetApplicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/servers_mapping","description":"Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application
search_servers_type: Search server type [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/servers_mapping

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/servers_mapping?search_servers_type=EXTERNAL

Response Messages:
400: Search migrated servers type parameter must be either internal, external or both.
400: Cannot get mappings between application to itself.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permission to access application with ID
403: You do not have permissions to edit this application.
404: There is no application with the specified ID."},"response":[]},{"name":"Copy application servers and connections to another application.","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"sourceApplicationId"},{"value":null,"type":"text","key":"targetApplicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}","description":"This API can be used to:
1. Create applications based on a blueprint (template).
2. Copy applications between environments (dev, test, prod).
3. Migrate applications between data-centers.

Before migrating make sure to map servers and connections to applications (if any exist).\nThis migration uses the configuration specified in the other API calls.

Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2

Response Messages:
200: Application was migrated.
400: Cannot migrate a decommissioned application.
400: Cannot migrate to a decommissioned application.
400: Cannot migrate an application to itself.
400: Cannot edit target DEVICE application.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
400: The source application has no connections to migrate.
409: You cannot migrate the application because not all servers are mapped.
409: You cannot migrate the application because not all connections to application are mapped.
409: You cannot migrate the application because one of the interfaces in the original application has been changed and has not been published."},"response":[]},{"name":"Update connection to application mappings for source and target applications","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n\t\n\t\t\n\t\t\t2\n\t\t\n\t\t\n\t\t\t-1\n\t\t\n\t\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/connections_to_applications_mapping","description":"Use id=-1 for target_application_interface if new mapping is ���Not Needed���.
If the source is specified and the target is empty, the mapping that is currently configured will be deleted.

Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application
body: The interface instance mapping list [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/connections_to_applications_mapping
BODY<connections_to_applications_mapping>
    <connection_to_application_mapping>
        <source_connection_to_application>
            <id>1</id>
        </source_connection_to_application>
        <target_application_interface>
            <id>4</id>
        </target_application_interface>
    </connection_to_application_mapping>
    <connection_to_application_mapping>
        <source_connection_to_application>
            <id>2</id>
        </source_connection_to_application>
        <target_application_interface>
            <id>-1</id>
        </target_application_interface>
    </connection_to_application_mapping>
    <connection_to_application_mapping>
        <source_connection_to_application>
            <id>3</id>
        </source_connection_to_application>
    </connection_to_application_mapping>
</connections_to_applications_mapping>


Response Messages:
200: Connection to application mappings were modified.
400: Source interface instance cannot be empty.
400: Source interface instance object is not valid
400: Target application interface is not valid
400: Connection to application with ID: ID was not found.
400: Interface with ID: ID was not found.
400: Cannot remove mapping of instance with ID because it has never been mapped.
400: Cannot migrate application to itself.
400: Cannot map instance to interface with ID ID because the interface exists in target application.
400: Cannot map to duplicate application interfaces
400: Application interface didn't got published
400: Connection to application with id: ID must used by source application
400: You cannot map connection to application ID, because it is contained in a connection to application pack.
400: Application interface ID must be in the same customer as the target application.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]},{"name":"Retrieve connection to application mappings for source and target applications","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"sourceApplicationId"},{"value":null,"type":"text","key":"targetApplicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/migrate/{{sourceApplicationId}},{{targetApplicationId}}/connections_to_applications_mapping","description":"Parameters:
sourceApplicationId: The unique identifier of the source application
targetApplicationId: The unique identifier of the target application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/migrate/1,2/connections_to_applications_mapping

Response Messages:
400: Cannot get mappings between application to itself.
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID."},"response":[]}]},{"name":"Application Packs","item":[{"name":"Update application interfaces and tag mapping","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t3\n\t\t\n\t\n\t\n\t\t\n\t\t\t2\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/application_interfaces","description":"Add application interfaces to application pack, and map a tag to the application interface. If a tag is not specified for the interface, the tag will be set to ���No Tag���.

Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
body: List of interface tag mapping to be added or modified

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/application_interfaces
BODY<application_interface_tags>
    <application_interface_tag>
        <application_interface>
            <id>1</id>
        </application_interface>
        <tag>
            <id>3</id>
        </tag>
    </application_interface_tag>
    <application_interface_tag>
        <application_interface>
            <id>2</id>
        </application_interface>
    </application_interface_tag>
</application_interface_tags>


Response Messages:
403: Access is denied
404: There are no application packs with the NAME in customer with ID.
403: You do not have permissions to edit this application pack.
403: You do not have permission to access application that contains the interface ID
400: You cannot edit APPLICATION PACK because it was decommissioned.
400: Application Interface can't be null.
400: Empty interface ID is not valid."},"response":[]},{"name":"Remove application interfaces from application pack","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"},{"value":null,"type":"text","key":"application_pack_id"},{"value":null,"type":"text","key":"application_interface_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/application_interfaces","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
application_interface_id: IDs of application interfaces to remove

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/application_interfaces?application_interface_id=1&application_interface_id=2

Response Messages:
200: Application Interface was deleted.
403: Access is denied
403: You do not have permissions to edit this application pack.
404: There are no application packs with the ID in customer with ID.
404: Application Package ID was not found.
404: Application interface ID was not found in application pack ID."},"response":[]},{"name":"Delete tags from application pack","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"},{"value":null,"type":"text","key":"application_pack_id"},{"value":null,"type":"text","key":"tag_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
tag_id: IDs of tags to remove

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/21/tags?tag_id=1&tag_id=2

Response Messages:
200: Tags were deleted.
403: Access is denied
403: You do not have permissions to edit this application pack.
404: There are no application packs with the ID in customer with ID.
404: Application Package ID was not found.
404: Tag ID was not found in application pack ID.
404: Tag ID is in use so can't be deleted.
404: Removed tag ID can't be empty."},"response":[]},{"name":"List all application pack tags","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"},{"value":null,"type":"text","key":"application_pack_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags

Response Messages:
403: Access is denied
404: There is no application pack with the ID."},"response":[]},{"name":"Modify tags of an application pack","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t1\n\t\tTag 1\n\t\n\t\n\t\t2\t\n\t\tTag 2\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
body: Tags to modify

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags
BODY<tags>
    <tag>
        <id>1</id>
        <name>Tag 1</name>
    </tag>
    <tag>
        <id>2</id>    
        <name>Tag 2</name>
    </tag>
</tags>


Response Messages:
403: Access is denied
403: You do not have permissions to edit this application pack.
404: Customer with ID was not found.
404: There is no application pack with the ID in customer with ID.
400: Tag with NAME already exists in application pack ID.
400: Updated tag ID can't be empty
400: Updated Tag ID doesn't exist on application pack ID."},"response":[]},{"name":"Create new Tag under an application pack ","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\tTag 1\n\t\n\t\n\t\tTag 2\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack
body: List of tags

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags
BODY<tags>
    <tag>
        <name>Tag 1</name>
    </tag>
    <tag>
        <name>Tag 2</name>
    </tag>
</tags>


Response Messages:
403: Access is denied
404: There is no application pack with the ID in customer with ID.
400: You cannot edit APPLICATION PACK because it was decommissioned.
400: Tag name must contain at least 2 and no more than 160 characters.
400: Tag with NAME already exists in application pack ID."},"response":[]},{"name":"Retrieve a list of all connection to application pack by application ID.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"application_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/","description":"Parameters:
application_id: The unique identifier of application
name: The name of the connection to application pack [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs?name=Connection to application pack 1

Response Messages:
403: Access is denied
403: You do not have permission to access application with ID
404: There are no connection to application pack with the NAME in application with ID."},"response":[]},{"name":"Create new connection to application packs","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\tConnection to application pack 1\n\t\tNew Connection to application pack\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t1\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t3\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\tTag 1\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t4\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/","description":"Parameters:
application_id: The unique identifier of application
body: List of connection to application packs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs
BODY<connection_to_application_packs>
    <connection_to_application_pack>
        <name>Connection to application pack 1</name>
        <comment>New Connection to application pack</comment>
        <application_pack>
            <id>1</id>
        </application_pack>
        <tags_servers>
            <tag_servers>
                <tag>
                    <id>1</id>
                </tag>
                <servers>
                    <server>
                        <id>3</id>
                    </server>
                </servers>
            </tag_servers>
            <tag_servers>
                <tag>
                    <name>Tag 1</name>
                </tag>
                <servers>
                    <server>
                        <id>4</id>
                    </server>
                </servers>
            </tag_servers>
        </tags_servers>
    </connection_to_application_pack>
</connection_to_application_packs>


Response Messages:
400: There are no connection to application packs to add.
400: Application pack ID cannot be empty.
400: Application with ID was not found.
400: There is no application with the specified ID.
400: There is no application pack with the specified ID.
400: Application pack with ID was decommissioned.
400: Application pack with ID was not published.
400: Connection to application pack cannot be created in the domain of the application pack.
400: The application pack cannot be used more than once in the application.
400: Name cannot be empty.
400: Name must contain at least 2 and no more than 160 characters.
400: Name already exists.
400: Tag cannot be empty.
400: Tag ID or name is missing.
400: Tag ID does not exist.
400: Server ID does not exist.
400: Tag ID is not in use in connection to application pack ID, so it cannot be updated.
400: Servers cannot be null.
400: You cannot add ANY to connection to application pack.
400: You cannot add user to connection to application pack.
400: You cannot add Internet to connection to application pack.
403: Access is denied.
403: You do not have permission to access application that contains the server ID
403: You do not have permission to access application pack with ID
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Tag with NAME was not found."},"response":[]},{"name":"List all application packs","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/","description":"Parameters:
customer_id: The unique identifier of customer
name: The name of the application pack [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs?name=Application pack 1

Response Messages:
403: Access is denied
404: There are no application packs with the NAME in customer with ID."},"response":[]},{"name":"Update application packs","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t1\n\t\tUpdated name\n\t\tUpdated application pack\n\t\t\n\t\t\t4\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\n\t\tfalse\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/","description":"Update the application packs properties. If is_published is set to true, the application pack is published for use by other users.

Parameters:
customer_id: The unique identifier of customer
body: List of application packs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs
BODY<application_packs>
    <application_pack>
        <id>1</id>
        <name>Updated name</name>
        <comment>Updated application pack</comment>
        <owner>
            <id>4</id>
        </owner>
        <editors>
            <editor>
                <id>3</id>
            </editor>
        </editors>
        <is_published>false</is_published>
    </application_pack>
</application_packs>


Response Messages:
400: There are no application packs to edit.
400: Application pack ID cannot be empty.
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to owner ID is invalid.
400: The owner NAME does not have permission to access applications.
400: There is an editor without an ID or name.
400: The application pack owner cannot also be an editor of the application pack.
400: There is a viewer without an ID or name.
400: The application pack owner cannot also be a viewer of the application pack.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application pack.
400: Application pack NAME already exists.
400: Application pack name must contain at least 2 and no more than 160 characters.
400: Customer NAME is not imported to SecureApp.
400: Customer NAME was decommissioned.
400: Application pack with ID is not ready for publish, or has no changes from the last publish.
403: Access is denied
403: You do not have permission to access application that contains the interface ID
403: You do not have permissions to edit this application pack.
403: You do not have permissions to change the owner of application pack ID.
403: You do not have permissions to change the editors and viewers of application pack ID.
404: There are no application packs with the NAME in customer with ID."},"response":[]},{"name":"Create new application packs","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\tApplication pack 1\n\t\tNew application pack\n\t\t\n\t\t\t4\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t3\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t5\n\t\t\t\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/","description":"Parameters:
customer_id: The unique identifier of customer
body: List of application packs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs
BODY<application_packs>
    <application_pack>
        <name>Application pack 1</name>
        <comment>New application pack</comment>
        <owner>
            <id>4</id>
        </owner>
        <editors>
            <editor>
                <id>3</id>
            </editor>
        </editors>
        <viewers>
            <viewer>
                <id>5</id>
            </viewer>
        </viewers>
    </application_pack>
</application_packs>


Response Messages:
403: Access is denied
403: You do not have permission to access application that contains the interface ID
400: There are no application packs to add.
400: Application pack can be created only in meshed domain mode.
404: Customer with ID was not found.
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to owner ID is invalid.
400: There is an editor without an ID or name.
400: The application pack owner cannot also be an editor of the application pack.
400: There is a viewer without an ID or name.
400: The application pack owner cannot also be a viewer of the application pack.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application pack.
400: The owner NAME does not have permission to access applications.
400: Application pack was already saved.
400: Application pack NAME already exists.
400: Application pack name must contain at least 2 and no more than 160 characters.
400: Customer NAME is not imported to SecureApp.
400: Customer NAME was decommissioned."},"response":[]},{"name":"Retrieve an existing application pack by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"},{"value":null,"type":"text","key":"application_pack_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to retrieve

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1

Response Messages:
403: Access is denied
403: You do not have permission to access application pack with ID
404: Application pack with ID was not found for customer with ID."},"response":[]},{"name":"Delete application pack","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"},{"value":null,"type":"text","key":"application_pack_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1

Response Messages:
200: Application pack wes deleted.
403: You do not have permissions to delete this application pack.
400: There is no application pack with the specified ID.
400: Customer with ID doesn't own an application pack with ID.
400: Application Pack ID cannot be deleted. It is in use by applications IDs."},"response":[]},{"name":"Update an application pack","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tUpdated name\n\tUpdated application pack\n\t\n\t\t4\n\t\n\t\n\t\t\n\t\t\t3\n\t\t\n\t\n\t\n\t\t\n\t\t\t5\n\t\t\n\t\n\ttrue\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}","description":"Update the application pack properties. If is_published is set to true, the application pack is published for use by other users.

Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack to change
body: Application pack

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1
BODY<application_pack>
    <name>Updated name</name>
    <comment>Updated application pack</comment>
    <owner>
        <id>4</id>
    </owner>
    <editors>
        <editor>
            <id>3</id>
        </editor>
    </editors>
    <viewers>
        <viewer>
            <id>5</id>
        </viewer>
    </viewers>
    <is_published>true</is_published>
</application_pack>


Response Messages:
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to owner ID is invalid.
400: The owner NAME does not have permission to access applications.
400: There is an editor without an ID or name.
400: The application pack owner cannot also be an editor of the application pack.
400: There is a viewer without an ID or name.
400: The application pack owner cannot also be a viewer of the application pack.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application pack.
400: Application pack NAME already exists.
400: Application pack name must contain at least 2 and no more than 160 characters.
400: Customer NAME is not imported to SecureApp.
400: Customer NAME was decommissioned.
400: Application pack with ID is not ready for publish, or has no changes from the last publish.
403: Access is denied
403: You do not have permission to access application that contains the interface ID
403: You do not have permissions to edit this application pack.
403: You do not have permissions to change the owner of application pack ID.
403: You do not have permissions to change the editors and viewers of application pack ID.
404: There are no application packs with the NAME in customer with ID."},"response":[]},{"name":"Get tag by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"},{"value":null,"type":"text","key":"application_pack_id"},{"value":null,"type":"text","key":"tag_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/customers/{{customer_id}}/application_packs/{{application_pack_id}}/tags/{{tag_id}}","description":"Parameters:
customer_id: The unique identifier of customer
application_pack_id: The unique identifier of an application pack
tag_id: The unique identifier of a tag

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/customers/1/application_packs/1/tags/1

Response Messages:
403: Access is denied
404: There is no tag with ID.
404: Customer with ID doesn't own a tag with ID.
404: Application Pack with ID doesn't own a tag with ID."},"response":[]},{"name":"Delete a connection to application pack","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"application_id"},{"value":null,"type":"text","key":"connection_to_application_pack_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/{{connection_to_application_pack_id}}","description":"Parameters:
application_id: The unique identifier of application
connection_to_application_pack_id: The unique identifier of the connection to application pack to delete

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs/1

Response Messages:
400: Connection to application pack with ID was not found for application with ID.
400: The connection to application pack was already deleted.
403: Access is denied.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed."},"response":[]},{"name":"Retrieve an existing connection to application pack by ID.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"application_id"},{"value":null,"type":"text","key":"connection_to_application_pack_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/{{connection_to_application_pack_id}}","description":"Parameters:
application_id: The unique identifier of application
connection_to_application_pack_id: The unique identifier of the connection to application pack

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs/1

Response Messages:
403: Access is denied
403: You do not have permission to access application with ID
404: There is no connection to application pack with the specified ID.
400: Application with ID doesn't own a connection to application pack with ID."},"response":[]},{"name":"Update an application pack","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tUpdated name\n\tUpdated Connection to application pack\n\t\n\t\t\n\t\t\t\n\t\t\t\t1\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t3\n\t\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\tTag 1\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/connection_to_application_packs/{{connection_to_application_pack_id}}","description":"Parameters:
application_id: The unique identifier of application
connection_to_application_pack_id: The unique identifier of the connection to application pack to update
body: Connection to application pack

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/connection_to_application_packs/1
BODY<connection_to_application_pack>
    <name>Updated name</name>
    <comment>Updated Connection to application pack</comment>
    <tags_servers>
        <tag_servers>
            <tag>
                <id>1</id>
            </tag>
            <servers>
                <server>
                    <id>3</id>
                </server>
            </servers>
        </tag_servers>
        <tag_servers>
            <tag>
                <name>Tag 1</name>
            </tag>
            <servers>
            </servers>
        </tag_servers>
    </tags_servers>
</connection_to_application_pack>


Response Messages:
400: There is no application with the specified ID.
400: There is no connection to application pack with the specified ID.
400: Application with ID doesn't own a connection to application pack with ID.
400: Name cannot be empty.
400: Name must contain at least 2 and no more than 160 characters.
400: Name already exists.
400: Tag cannot be empty.
400: Tag ID or name is required.
400: Tag with Name was not found.
400: Server ID cannot be empty.
400: Servers cannot be null.
400: You cannot add ANY to connection to application pack.
400: You cannot add user to connection to application pack.
400: You cannot add Internet to connection to application pack.
403: Access is denied.
403: You do not have permission to access application that contains the server ID
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed."},"response":[]}]},{"name":"Application Pending Changes","item":[{"name":"Retrieve existing access rules","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/access_requests","description":"Parameters:
applicationId: The unique identifier of the application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/87/access_requests

Response Messages:
400: The application was already deleted.
400: There are no changed connections that are ready for creating a ticket.
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
400: Application with ID ID was not found."},"response":[]}]},{"name":"Application Servers (across all applications)","item":[{"name":"Fetches server by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"serverId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/network_objects/{{serverId}}","description":"Parameters:
serverId: The ID of the server

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects/87

Response Messages:
400: Server with id ID was not found.
400: Application with ID ID was not found.
400: The application was already deleted.
403: Access is denied
403: You do not have permission to access application that contains the server ID
401: No available licenses. Ask your SecureApp administrator for assistance."},"response":[]},{"name":"Fetches servers","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/network_objects","description":"Parameters:
name: The name of the servers [optional]
typeOnDevice: The typeOnDevice of the servers [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects?name=server1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/network_objects?typeOnDevice=edl_ip_list

Response Messages:
400: Server with name NAME was not found.
400: Parameter typeOnDevice is not valid.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There are no servers with the name NAME
404: There are no servers with the typeOnDevice TYPEONDEVICE "},"response":[]}]},{"name":"Application Servers (by application)","item":[{"name":"Move server","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"application_id"},{"value":null,"type":"text","key":"server_id"},{"value":null,"type":"text","key":"target_application_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/move_server","description":"Parameters:
application_id: The unique identifier of the application
server_id: The unique identifier of the server
target_application_id: The unique identifier of the target application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/move_server?server_id=5&target_application_id=3

Response Messages:
400: Server ID is missing.
400: Target application ID is missing.
400: You cannot move a predefined object.
400: Server with ID is already associated to application with ID.
400: Cannot move server to a different customer.
400: The application was already deleted.
400: You cannot add to application APPLICATION_NAME because it was decommissioned.
400: Group/Server cannot be moved because there is no other application to move it to.
400: Group/Server cannot be moved because it or at least one of its group members is part of these groups: GROUPS_NAME.
400: Group/Server cannot be moved because it or at least one of its group members is locked for discovery.
400: Group/Server cannot be moved because it or at least one of its group members is used in these application interfaces: APPLICATION_INTERFACE_NAME.
400: Group/Server cannot be moved because it or at least one of its group members is used in these connections with another external resource: CONNECTION_NAME
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]},{"name":"Create servers","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t host comment\n\t\t host1\n\t\t 1.1.1.1\n\t \n\t \n\t\t range comment\n\t\t range1\n\t\t 2.2.2.2\n \t\t 2.2.2.22\n\t \n\t \n\t\t subnet comment\n\t\t subnet1\n\t\t 3.3.3.3\n\t\t 255.255.255.0\n\t \n\t \n\t\t virtual server comment\n\t\t {e1a7722f-e92e-48f2-9087-9cb1711eb8b9}\n\t\t 12\n\t \n\t \n\t\t group comment\n\t\t group1\n\t\t true\n\t\t \n\t\t\t 3\n\t\t \n\t\tedl_ip_list\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects","description":"Parameters:
applicationId: The unique identifier of the application
body: List of servers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects
BODY<network_objects xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
     <network_object xsi:type=\"hostNetworkObjectDTO\">
         <comment>host comment</comment>
         <name>host1</name>
         <ip>1.1.1.1</ip>
     </network_object>
     <network_object xsi:type=\"rangeNetworkObjectDTO\">
         <comment>range comment</comment>
         <name>range1</name>
         <first_ip>2.2.2.2</first_ip>
         <last_ip>2.2.2.22</last_ip>
     </network_object>
     <network_object xsi:type=\"subnetNetworkObjectDTO\">
         <comment>subnet comment</comment>
         <name>subnet1</name>
         <ip>3.3.3.3</ip>
         <netmask>255.255.255.0</netmask>
     </network_object>
     <network_object xsi:type=\"networkObjectVirtualServerDTO\">
         <comment>virtual server comment</comment>
         <uid>{e1a7722f-e92e-48f2-9087-9cb1711eb8b9}</uid>
         <device_id>12</device_id>
     </network_object>
     <network_object xsi:type=\"networkObjectGroupDTO\">
         <comment>group comment</comment>
         <name>group1</name>
         <access_allowed>true</access_allowed>
         <member>
             <id>3</id>
         </member>
        <type_on_device>edl_ip_list</type_on_device>     </network_object>
</network_objects>


Response Messages:
400: There are no items to add.
400: The application was already deleted.
400: You cannot add to application NAME because it was decommissioned.
400: Network object was already saved
400: Name cannot be empty
400: Server with NAME already exists.
400: IP is missing
400: Mask is missing
400: Invalid IP
400: Invalid mask
400: Max IP is missing
400: Min IP is missing
400: Invalid min IP
400: Invalid max IP
400: Min IP cannot be larger than max IP
400: Invalid network object type CLASS_NAME.
400: Invalid uid
400: Invalid device ID
400: Virtual server does not exist in SecureTrack
400: The virtual server already exists in SecureApp as resource NAME: VIRTUAL SERVER NAME VIRTUAL SERVER DEVICE NAME.
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Internet cannot be a member of a group.
400: Cannot save the server because the virtual server does not exist.
400: Cannot save the server because an error occurred
400: The type_on_device value is not valid
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID.
404: Virtual server was not found in SecureTrack.
503: Not connected to SecureTrack."},"response":[]},{"name":"Update servers","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t 1\n\t\t host comment\n\t\t host1\n\t\t 1.1.1.1\n\t\t host\n\t \n\t \n\t\t 2\n\t\t range comment\n\t\t range1\n\t\t 2.2.2.2\n\t\t 2.2.2.22\n\t\t range\n\t \n\t \n\t\t 3\n\t\t subnet comment\n\t\t subnet1\n\t\t 3.3.3.3\n\t\t 255.255.255.0\n\t\t subnet\n\t \n\t \n\t\t 4\n\t\t virtual server comment\n\t\t {e1a7722f-e92e-48f2-9087-9cb1711eb8b9}\n\t\t 12\n\t\t virtual-server\n\t \n\t \n\t\t 5\n\t\t vm1\n\t\t vm instance comment\n\t\t vm_instance\n\t \n\t \n\t\t 6\n\t\t group comment\n\t\t group1\n\t\t true\n\t\t group\n\t\t \n\t\t\t 3\n\t\t \n\t\tedl_ip_list\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects","description":"Parameters:
applicationId: The unique identifier of the application
body: List of servers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects
BODY<network_objects xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
     <network_object xsi:type=\"hostNetworkObjectDTO\">
         <id>1</id>
         <comment>host comment</comment>
         <name>host1</name>
         <ip>1.1.1.1</ip>
         <type>host</type>
     </network_object>
     <network_object xsi:type=\"rangeNetworkObjectDTO\">
         <id>2</id>
         <comment>range comment</comment>
         <name>range1</name>
         <first_ip>2.2.2.2</first_ip>
         <last_ip>2.2.2.22</last_ip>
         <type>range</type>
     </network_object>
     <network_object xsi:type=\"subnetNetworkObjectDTO\">
         <id>3</id>
         <comment>subnet comment</comment>
         <name>subnet1</name>
         <ip>3.3.3.3</ip>
         <netmask>255.255.255.0</netmask>
         <type>subnet</type>
     </network_object>
     <network_object xsi:type=\"networkObjectVirtualServerDTO\">
         <id>4</id>
         <comment>virtual server comment</comment>
         <uid>{e1a7722f-e92e-48f2-9087-9cb1711eb8b9}</uid>
         <device_id>12</device_id>
         <type>virtual-server</type>
     </network_object>
     <network_object xsi:type=\"vmInstanceDTO\">
         <id>5</id>
         <name>vm1</name>
         <comment>vm instance comment</comment>
         <type>vm_instance</type>
     </network_object>
     <network_object xsi:type=\"networkObjectGroupDTO\">
         <id>6</id>
         <comment>group comment</comment>
         <name>group1</name>
         <access_allowed>true</access_allowed>
         <type>group</type>
         <member>
             <id>3</id>
         </member>
        <type_on_device>edl_ip_list</type_on_device>     </network_object>
</network_objects>


Response Messages:
400: The application was already deleted.
400: You cannot update a predefined object.
400: Invalid type in server with id ID.
400: Invalid member with id ID
400: Invalid ID
400: Invalid uid
400: Invalid network object type NAME
400: Cannot update user
400: Network object is new
400: Name cannot be empty
400: Server is in discovery
400: Ip is missing
400: Mask is missing
400: Invalid ip
400: Invalid mask
400: Max ip is missing
400: Min ip is missing
400: Invalid min ip
400: Invalid max ip
400: Min ip cannot be larger than max ip
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Internet cannot be a member of a group.
400: Server with NAME already exists.
400: Invalid device ID
400: The type_on_device value is not valid
400: An EDL group can not be modified to a regular group
400: The virtual server already exists in SecureApp as resource NAME: VIRTUAL SERVER NAME VIRTUAL SERVER DEVICE NAME.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: DTO type used for server id ID is incompatible with this vendor.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Virtual server was not found in ST.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID.
503: Not connected to SecureTrack."},"response":[]},{"name":"Retrieve existing servers","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects","description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the server [optional]
typeOnDevice: The typeOnDevice of the servers [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects?name=ServerName

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects?typeOnDevice=edl_ip_list

Response Messages:
400: The application was already deleted.
400: Parameter typeOnDevice is not valid.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: There are no servers with the name NAME.
404: There are no servers with the typeOnDevice TYPEONDEVICE "},"response":[]},{"name":"Export Server Impact Analysis to a CSV file.","request":{"method":"GET","header":[],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}/impact_analysis_csv","description":"Parameters:
applicationId [optional]
serverId [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/6/impact_analysis_csv

Response Messages:
400: Server with ID was not found.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
404: There is no application with the specified ID."},"response":[]},{"name":"If the identified server is a group, return a list of its members. When the media type is 'text/plain' (default), print each member on a separate line.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}/members","description":"Parameters:
applicationId [optional]
serverId [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/6/members

Response Messages:
400: Server with ID is not of type group
403: Access is denied
403: You do not have permissions to view this application
403: No available licenses. Ask your SecureApp administrator for assistance
404: There is no application with the specified ID
404: Server with ID was not found"},"response":[]},{"name":"Retrieve an existing server by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"serverId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}","description":"Parameters:
applicationId: The unique identifier of the application
serverId: The unique identifier of the server

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/3

Response Messages:
400: The application was already deleted.
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID."},"response":[]},{"name":"Delete server","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"serverId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/network_objects/{{serverId}}","description":"To decommission a serer use force=true.

Parameters:
applicationId: The unique identifier of the application
serverId: The unique identifier of the server
force: Force delete [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/4

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/network_objects/4?force=true

Response Messages:
400: The application was already deleted.
400: You cannot delete a predefined object.
400: Cannot delete an object that is being referenced by other objects
400: Cannot delete a predefined object.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Server with ID was not found in application with ID."},"response":[]}]},{"name":"Application Services (global)","item":[{"name":"Fetches service by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"serviceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services/{{serviceId}}","description":"Parameters:
serviceId: The ID of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services/2

Response Messages:
404: Service with ID <ID> was not found.
403: Access is denied."},"response":[]},{"name":"Delete unused and non predefined global service","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"serviceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services/{{serviceId}}","description":"Parameters:
serviceId: The ID of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services/260

Response Messages:
200: Service was deleted.
404: Global Service with ID was not found.
400: Cannot delete an object that is being referenced by other objects.
400: You cannot delete a predefined object.
403: Access is denied."},"response":[]},{"name":"Modify unused and non predefined global services","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t250\n\t\ticmp service updated\n\t\tUpdated comment\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\t251\n\t\tip service updated\n\t\tUpdated comment\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\t252\n\t\ttcp service updated\n\t\tUpdated comment\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t253\n\t\tudp service updated\n\t\tUpdated comment\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t254\n\t\tService Group 1 updated\n\t\tUpdated comment\n\t\tgroup\n\t\t\n\t\t\t3\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services/","description":"Parameters:
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>250</id>
        <name>icmp service updated</name>
        <comment>Updated comment</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>251</id>
        <name>ip service updated</name>
        <comment>Updated comment</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>252</id>
        <name>tcp service updated</name>
        <comment>Updated comment</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>253</id>
        <name>udp service updated</name>
        <comment>Updated comment</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <id>254</id>
        <name>Service Group 1 updated</name>
        <comment>Updated comment</comment>
        <type>group</type>
        <member>
            <id>3</id>
        </member>
        <member>
            <id>4</id>
        </member>
    </service>
</services>


Response Messages:
200: Services were modified.
400: Members IDs cannot be empty.
404: Service with ID <ID> was not found.
400: Service type must be either SingleServiceDTO or ServiceMemberDTO.
400: Service is new.
400: You cannot update a predefined object.
400: Name <NAME> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: Invalid protocol
400: Global Service cannot be associated with an application.
400: Cannot update a global service that is being referenced by other objects.
400: Cannot update an empty global group.
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Cannot have a local member in global group.
400: Group cannot contain itself as a member.
400: Application identity cannot be a member of a group.
403: Access is denied."},"response":[]},{"name":"Fetches services","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services","description":"Parameters:
globals_only: get only globals [optional]
name: The name of the service [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?name=AH

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?globals_only=true

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?globals_only=true&name=AH

Response Messages:
404: There are no services with the name NAME.
403: Access is denied."},"response":[]},{"name":"Create global services","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\ticmp service\n\t\tNew service\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\tip service\n\t\tIPSEC Authentication Header Protocol\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\ttcp service\n\t\tDiscard Server Protocol (TCP)\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tudp service\n\t\tDiscard Server Protocol (UDP)\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tService Group 1\n\t\tNew Service group\n\t\tgroup\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t2\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services","description":"Parameters:
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>icmp service</name>
        <comment>New service</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>ip service</name>
        <comment>IPSEC Authentication Header Protocol</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>tcp service</name>
        <comment>Discard Server Protocol (TCP)</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>udp service</name>
        <comment>Discard Server Protocol (UDP)</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <name>Service Group 1</name>
        <comment>New Service group</comment>
        <type>group</type>
        <member>
            <id>1</id>
        </member>
        <member>
            <id>2</id>
        </member>
    </service>
</services>


Response Messages:
201: Service was created.
200: Services were created.
400: There are no items to add.
400: Members IDs cannot be empty.
404: Service with ID <ID> was not found.
400: Invalid service type <TYPE>
400: Name <NAME> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: Global Service cannot be associated with an application.
400: Cannot create an empty global group.
400: The group contains duplicate members.
400: Any cannot be a member of a group.
400: Cannot have a local member in global group.
400: Application identity cannot be a member of a group.
403: Access is denied."},"response":[]},{"name":"Delete unused and non predefined global service by name","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"name"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/services","description":"Parameters:
name: The name of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/services?name=Global service

Response Messages:
200: Service was deleted.
404: Service name has not been provided.
404: There are no services with the name NAME.
400: Cannot delete ANY.
400: Cannot delete an object that is being referenced by other objects.
400: Cannot delete a predefined object.
403: Access is denied."},"response":[]}]},{"name":"Application Services (local)","item":[{"name":"Retrieve existing services","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services","description":"Parameters:
applicationId: The unique identifier of the application
name: The name of the service [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services?name=Local service

Response Messages:
400: The application was already deleted.
403: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: There are no services with the name NAME."},"response":[]},{"name":"Create services","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\ticmp service\n\t\tNew service\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\tip service\n\t\tIPSEC Authentication Header Protocol\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\ttcp service\n\t\tDiscard Server Protocol (TCP)\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tudp service\n\t\tDiscard Server Protocol (UDP)\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\tService Group 1\n\t\tNew Service group\n\t\tgroup\n\t\t\n\t\t\t1\n\t\t\n\t\t\n\t\t\t2\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services","description":"Parameters:
applicationId: The unique identifier of the application
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>icmp service</name>
        <comment>New service</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>ip service</name>
        <comment>IPSEC Authentication Header Protocol</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>tcp service</name>
        <comment>Discard Server Protocol (TCP)</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <name>udp service</name>
        <comment>Discard Server Protocol (UDP)</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <name>Service Group 1</name>
        <comment>New Service group</comment>
        <type>group</type>
        <member>
            <id>1</id>
        </member>
        <member>
            <id>2</id>
        </member>
    </service>
</services>


Response Messages:
201: Service was created.
200: Services were created.
400: There are no items to add.
400: Members IDs cannot be empty.
400: Invalid service type <TYPE>
400: Name <NAME> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: Cannot create an empty global group.
400: The group contains duplicate members.
400: ANY cannot be a member of a group.
400: Cannot have members from different applications.
400: Can not have application identity in group
403: Access is denied
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Service with ID <ID> was not found.
404: There is no application with the specified ID."},"response":[]},{"name":"Update services","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t250\n\t\ticmp service updated\n\t\tUpdated comment\n\t\ticmp_service\n\t\t3\n\t\t3\n\t\t1\n\t\n\t\n\t\t251\n\t\tip service updated\n\t\tUpdated comment\n\t\tip_service\n\t\t51\n\t\t51\n\t\tdefault\n\t\n\t\n\t\t252\n\t\ttcp service updated\n\t\tUpdated comment\n\t\ttcp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t253\n\t\tudp service updated\n\t\tUpdated comment\n\t\tudp_service\n\t\t9\n\t\t9\n\t\tdefault\n\t\n\t\n\t\t254\n\t\tService Group 1 updated\n\t\tUpdated comment\n\t\tgroup\n\t\t\n\t\t\t3\n\t\t\n\t\t\n\t\t\t4\n\t\t\n\t\n\t\n\t\t255\n\t\tService Group 2 updated\n\t\tUpdated comment\n\t\tgroup\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services","description":"Parameters:
applicationId: The unique identifier of the application
body: List of services

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services
BODY<services>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>250</id>
        <name>icmp service updated</name>
        <comment>Updated comment</comment>
        <type>icmp_service</type>
        <max>3</max>
        <min>3</min>
        <timeout>1</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>251</id>
        <name>ip service updated</name>
        <comment>Updated comment</comment>
        <type>ip_service</type>
        <max>51</max>
        <min>51</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>252</id>
        <name>tcp service updated</name>
        <comment>Updated comment</comment>
        <type>tcp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"singleServiceDTO\">
        <id>253</id>
        <name>udp service updated</name>
        <comment>Updated comment</comment>
        <type>udp_service</type>
        <max>9</max>
        <min>9</min>
        <timeout>default</timeout>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <id>254</id>
        <name>Service Group 1 updated</name>
        <comment>Updated comment</comment>
        <type>group</type>
        <member>
            <id>3</id>
        </member>
        <member>
            <id>4</id>
        </member>
    </service>
    <service xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"serviceGroupDTO\">
        <id>255</id>
        <name>Service Group 2 updated</name>
        <comment>Updated comment</comment>
        <type>group</type>
    </service>
</services>


Response Messages:
200: Services were modified.
400: Members IDs cannot be empty.
400: Service type must be either SingleServiceDTO or ServiceMemberDTO.
400: Local service must be associated with an application.
400: Service is locked for discovery.
400: Service is new.
400: Name <NAME> already exists.
400: Name cannot be empty.
400: Invalid max protocol
400: Invalid min protocol
400: Invalid min icmp type
400: Invalid max icmp type
400: Invalid min port
400: Invalid max port
400: Invalid protocol
400: The group contains duplicate members.
400: ANY cannot be a member of a group.
400: Application identity cannot be a member of a group.
403: Access is denied
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: Service with ID <ID> was not found."},"response":[]},{"name":"Delete service","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"serviceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services/{{serviceId}}","description":"Use force=true to delete a service with decommission.

Parameters:
applicationId: The unique identifier of the application
serviceId: The unique identifier of the service
force: Force delete [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services/250

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services/250?force=true

Response Messages:
400: The application was already deleted.
400: Cannot delete an object that is being referenced by other objects.
400: Cannot delete a predefined object.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID.
404: Service with ID <SERVICE_ID> was not found in application with id <APPLICATION_ID>"},"response":[]},{"name":"Retrieve an existing service by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"},{"value":null,"type":"text","key":"serviceId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/services/{{serviceId}}","description":"Parameters:
applicationId: The unique identifier of the application
serviceId: The unique identifier of the service

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/services/250

Response Messages:
400: The application was already deleted.
403: You do not have permission to access application with ID
404: There is no application with the specified ID.
404: Service with ID was not found."},"response":[]}]},{"name":"Application Users","item":[{"name":"Delete unused user","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"userId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users/{{userId}}","description":"Parameters:
userId: The ID of the user

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users/10

Response Messages:
200: User was deleted.
404: User with ID <ID> was not found.
400: Cannot delete an object that is being referenced by other objects.
403: Access is denied."},"response":[]},{"name":"Fetches user by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"userId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users/{{userId}}","description":"Parameters:
userId: The ID of the user

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users/10

Response Messages:
404: User with ID <ID> was not found.
403: Access is denied."},"response":[]},{"name":"Create users","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\tLocal user 1\n\t\tNew local user\n\t\t8.8.8.8\n\t\n\t\n\t\tLdap user 1\n\t\tNew ldap user\n\t\n\t\n\t\tUser group 1\n\t\tNew user group\n\t\t\n\t\t\t14\n\t\t\n\t\t\n\t\t\t15\n\t\t\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users","description":"Parameters:
body: List of users

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/users
BODY<users>
    <user>
        <name>Local user 1</name>
        <comment>New local user</comment>
        <ip>8.8.8.8</ip>
    </user>
    <user>
        <name>Ldap user 1</name>
        <comment>New ldap user</comment>
    </user>
    <user xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"userObjectGroupDTO\">
        <name>User group 1</name>
        <comment>New user group</comment>
        <member>
            <id>14</id>
        </member>
        <member>
            <id>15</id>
        </member>
    </user>
</users>


Response Messages:
201: User was created.
200: Users were created.
400: There are no items to add.
400: Members IDs cannot be empty.
404: User with id <ID> was not found.
400: Invalid user type <TYPE>
400: Name cannot be empty.
400: User with name <NAME> already exists.
400: Invalid ip
403: Access is denied."},"response":[]},{"name":"Fetches users","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/users","description":"Parameters:
name: The name of the user [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/users?name=Local user 1

Response Messages:
404: There are no users with the name NAME.
403: Access is denied."},"response":[]}]},{"name":"Applications","item":[{"name":"Move applications to another customer","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t \n\t\t\t1\n\t\t \n\t\t \n\t\t\t 2\n\t\t \n\t \n\t \n\t\t \n\t\t\t2\n\t\t \n\t\t \n\t\t\tDefault\n\t\t \n\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/move_applications","description":"Parameters:
body: List of applications and customers [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/move_applications
BODY<move_applications>
     <move_application>
         <application>
            <id>1</id>
         </application>
         <customer>
             <id>2</id>
         </customer>
     </move_application>
     <move_application>
         <application>
            <id>2</id>
         </application>
         <customer>
            <name>Default</name>
         </customer>
     </move_application>
</move_applications>


Response Messages:
200: Applications were moved successfully.
400: Multi-Customer mode is not enabled.
400: You cannot move an application pack to a different customer.
400: Reference to application is invalid.
400: APPLICATION already exists in CUSTOMER.
400: You must specify the name or ID of the customer.
400: The customer has no ID or name.
400: Reference to CUSTOMER is invalid.
400: CUSTOMER is not imported to SecureApp.
400: CUSTOMER was decommissioned.
400: You must delete virtual servers from CUSTOMER before you move APPLICATION to another customer.
400: You must remove virtual servers from the INTERFACE and publish it before you move APPLICATION to another customer.
400: You cannot move APPLICATION to CUSTOMER because the connection to application pack and the application pack cannot be in the same customer.
400: You cannot move APPLICATION to a different customer because the application interface and the application pack must be in the same customer.
400: You must remove INTERFACE from APPLICATION PACK and publish it before you can move APPLICATION to another customer.
400: CONNECTION TO APPLICATION from APPLICATION must use interface from CUSTOMER.
400: Sources in CONNECTION from APPLICATION must all be from applications in the same customer.
400: Destinations in CONNECTION in APPLICATION must all be from applications in the same customer.
400: Servers in CONNECTION from APPLICATION must all be from CUSTOMER.
400: Servers in CONNECTION TO APPLICATION from APPLICATION must be from applications in the same customer.
400: Servers in CONNECTION TO APPLICATION from APPLICATION must be from CUSTOMER.
400: Application or application pack with NAME already exists in CUSTOMER.
400: There are no applications to move.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]},{"name":"Export Impact Analysis to a CSV file.","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"application_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/impact_analysis_csv","description":"To prevent a CSV injection attack when exporting Impact Analysis to a CSV file, if a special character ( = - + @ ) appears at the beginning of any field, a single quote (') is added before the character.

Parameters:
application_id: The unique identifier of the application

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/2/impact_analysis_csv

Response Messages:
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
403: You do not have permissions to edit this application.
404: There is no application with the specified ID."},"response":[]},{"name":"Retrieve security policy violations from SecureTrack","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/compliance_violations","description":"Parameters:
applicationId [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/compliance_violations

Response Messages:
400: No valid connections found in APPLICATION.
400: Security policy compliance check is not available because a security policy has not been defined.
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
503: Cannot connect to SecureTrack.
503: Timeout occurred while waiting for response from SecureTrack.
500: An error occurred in SecureTrack when running the security compliance check."},"response":[]},{"name":"Export application history to PDF","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"application_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{application_id}}/history/export_pdf","description":"Parameters:
application_id: The unique identifier of the application
start_date: States starting date to fetch history since. Date format expected: yyyy-mm-dd [optional]
end_date: Get history until this date. Date format expected: yyyy-mm-dd [optional]
count: History max rows [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?start_date=2015-07-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?start_date=2015-07-18&end_date=2015-12-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?start_date=2015-07-18&count=2

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history/export_pdf?count=2

Response Messages:
403: Access is denied.
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID.
400: The date format must be: yyyy-mm-dd
400: Start date must be before End date"},"response":[]},{"name":"Retrieve application history","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}/history","description":"Parameters:
applicationId: The unique identifier of the application
start_date: States starting date to fetch history since. Date format expected: yyyy-mm-dd [optional]
end_date: Get history until this date. Date format expected: yyyy-mm-dd [optional]
count: History list length [optional]
start: Offset the count starting point [optional]
type: States the history type to fetch [optional]
user: The username of the user made the changes [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start_date=2015-07-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start_date=2015-07-18&end_date=2015-12-18

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start_date=2015-07-18&count=1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?start=0&count=1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?type=SERVER

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1/history?user=Jack

Response Messages:
400: The date format must be: yyyy-mm-dd
400: Start date must be before End date
400: Count parameter must be a number
400: Start parameter must be a number
400: Start parameter must be less than total
400: Type parameter must be either server, server_group, connection, application, application_interface, connection_interface or connection_to_application
400: User not found
403: Access is denied
403: You do not have permission to access application with ID
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID."},"response":[]},{"name":"Change an application","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t 139\n\t UpdatedAppName\n\t UpdatedComment\n\t false\n\t \n\t\t 4\n\t \n\t \n\t\t \n\t\t\t 3\n\t\t \n\t \n\t \n\t\t \n\t\t\t 5\n\t\t \n\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}","description":"This API can be used to delete or decommission an application.
To decommission an application, send true in decommissioned tag.

Parameters:
applicationId: The unique identifier of an application to change
body: Application

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/139
BODY<application>
     <id>139</id>
     <name>UpdatedAppName</name>
     <comment>UpdatedComment</comment>
     <decommissioned>false</decommissioned>
     <owner>
         <id>4</id>
     </owner>
     <editors>
         <editor>
             <id>3</id>
         </editor>
     </editors>
     <viewers>
         <viewer>
             <id>5</id>
         </viewer>
     </viewers>
</application>


Response Messages:
400: The application was already deleted.
400: Application owner is missing.
400: Owner cannot be empty.
400: Reference to owner ID is invalid.
400: There is an editor without an ID or name.
400: The application owner cannot also be an editor of the application.
400: There is a viewer without an ID or name.
400: The application owner cannot also be a viewer of the application.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application.
403: Access is denied
403: You do not have permissions to change the owner of application ID.
403: You do not have permissions to change the editors and a viewer of application ID.
403: You do not have permissions to decommission this application.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: This application is publishing and therefore cannot be edited. Redo your changes after publishing is completed.
404: There is no application with the specified ID."},"response":[]},{"name":"Delete an application","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}","description":"Parameters:
applicationId: The unique identifier of the application to delete

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1

Response Messages:
400: The application was already deleted.
400: The resources of application NAME are used in connections for other applications.
400: You cannot delete application NAME because its application interfaces are used in other applications.
400: You cannot delete application NAME because its application interfaces are used in other application packs.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
400: Application with ID ID was not found.
400: You cannot delete application NAME because there are connection changes pending a ticket in other application."},"response":[]},{"name":"Retrieve an existing application by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"applicationId"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/{{applicationId}}","description":"Parameters:
applicationId: The unique identifier of an application to retrieve

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications/1

Response Messages:
400: The application was already deleted.
401: No available licenses. Ask your SecureApp administrator for assistance.
403: Access is denied
403: You do not have permission to access application with ID
404: There is no application with the specified ID."},"response":[]},{"name":"Create new applications","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t AppName\n\t\t Comment\n\t\t \n\t\t\t 3\n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 4\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 5\n\t\t\t \n\t\t \n\t\t \n\t\t\t 24\n\t\t \n\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/","description":"Parameters:
body: List all applications

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications
BODY<applications>
     <application>
         <name>AppName</name>
         <comment>Comment</comment>
         <owner>
             <id>3</id>
         </owner>
         <editors>
             <editor>
                 <id>4</id>
             </editor>
         </editors>
         <viewers>
             <viewer>
                 <id>5</id>
             </viewer>
         </viewers>
         <customer>
             <id>24</id>
         </customer>
     </application>
</applications>


Response Messages:
400: There are no items to add.
400: Application was already saved.
400: Application name must contain at least 2 and no more than 160 characters.
400: Owner cannot be empty.
400: The specified owner does not exist.
400: The owner NAME does not have permission to access applications.
400: There is an editor without an ID or name.
400: The application owner cannot also be an editor of the application.
400: There is a viewer without an ID or name.
400: The application owner cannot also be a viewer of the application.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application.
400: Application with NAME already exists.
400: Application owner is missing.
400: Reference to owner ID is invalid.
400: You must include the owner field.
400: The Owner has no ID or name.
400: Reference to customer ID is invalid.
400: You must specify the name or ID of the customer.
400: The customer has no ID or name.
400: The specified customer does not exist.
400: There is an editor without an ID or name.
403: Access is denied
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no editor with the name NAME."},"response":[]},{"name":"Update applications","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t 140\n\t\t App1\n\t\t true\n\t\t \n\t\t\t 4\n\t\t \n\t \n\t \n\t\t 139\n\t\t UpdatedAppName\n\t\t Updated Comment\n\t\t \n\t\t\t 4\n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 3\n\t\t\t \n\t\t \n\t\t \n\t\t\t \n\t\t\t\t 5\n\t\t\t \n\t\t \n\t \n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/","description":"This API can be used to delete or decommission an application.
To decommission an application, send true in decommissioned tag.

Parameters:
body: List of applications

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications
BODY<applications>
     <application>
         <id>140</id>
         <name>App1</name>
         <decommissioned>true</decommissioned>
         <owner>
             <id>4</id>
         </owner>
     </application>
     <application>
         <id>139</id>
         <name>UpdatedAppName</name>
         <comment>Updated Comment</comment>
         <owner>
             <id>4</id>
         </owner>
         <editors>
             <editor>
                 <id>3</id>
             </editor>
         </editors>
         <viewers>
             <viewer>
                 <id>5</id>
             </viewer>
         </viewers>
     </application>
</applications>


Response Messages:
400: Application ID is missing.
400: Application ID is invalid
400: The application was already deleted.
400: You must include the owner field.
400: There is an editor without an ID or name.
400: The application owner cannot also be an editor of the application.
400: There is a viewer without an ID or name.
400: The application owner cannot also be a viewer of the application.
400: User ID was not found.
400: User ID does not have permission to access applications.
400: User cannot be both an editor and a viewer of the application.
403: Access is denied
403: You do not have permissions to change the owner of application ID.
403: You do not have permissions to change the editors and a viewer of application ID.
403: You do not have permissions to decommission this application.
401: No available licenses. Ask your SecureApp administrator for assistance.
404: There is no application with the specified ID."},"response":[]},{"name":"List all applications","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/repository/applications/","description":"Parameters:
userId: Applications by user ID, if not given the default is logged in user id [optional]
name: The name of the application [optional]
app_permissions: Filter applications by the given permissions (separated with commas):\napp_owner - returns applications where the user is the owner\napp_editor - returns applications where the user has been explicitly added as an editor\napp_viewer - returns applications where the user has been explicitly added as a viewer\napp_adminonly - returns applications where the user only has editor access because user has ���edit all applications��� permission, and does not include applications where this user is either the app_owner, app_editor, or app_viewer [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?name=App

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?userId=1

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?app_permissions=app_owner,app_editor,app_viewer

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications?name=App&app_permissions=app_adminonly

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/repository/applications

Response Messages:
400: Invalid app_permissions value: 'appPermissions'.
403: Access is denied
403: You can't use the parameter 'userId' because you don't have 'View all applications' permission.
404: There are no applications matching your filter.
404: User with ID 'userId' was not found."},"response":[]}]},{"name":"Cloud Console","item":[{"name":"Auto associate cloud servers from SecureTrack with an application","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tApplication\n\ttrue\n\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/cloud_console/servers/auto_association_rule","description":"When auto-associate is enabled, user must enter key value

Parameters:
body: Auto association rule

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers/auto_association_rule
BODY<auto_association_rule>
    <key>Application</key>
    <enabled>true</enabled>
</auto_association_rule>


Response Messages:
200: Auto association rule is saved.
400: Enabled rule requires key value.
403: Access is denied
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to search for cloud servers."},"response":[]},{"name":"Associate cloud servers from SecureTrack with an application","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t9\n\t\t\n\t\t\t{b503916e-4468-4dc8-981b-2ec534587352}\n\t\t\t{0cc947a5-276f-4a4a-9d12-df5284fce609}\n\t\t\n\t\n\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/cloud_console/servers/","description":"Parameters:
application_id: The ID of the application
body: List of device IDs and cloud server UIDs

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers?application_id=87
BODY<devices_to_uids>
    <device_to_uids>
        <device_id>9</device_id>
        <uids>
            <uid>{b503916e-4468-4dc8-981b-2ec534587352}</uid>
            <uid>{0cc947a5-276f-4a4a-9d12-df5284fce609}</uid>
        </uids>
    </device_to_uids>
</devices_to_uids>


Response Messages:
201: Servers were imported to SecureApp.
403: Access is denied
400: There is no application with the specified ID.
401: No available licenses. Ask your SecureApp administrator for assistance.
400: You do not have permissions to edit this application.
400: You cannot associate servers with this application, because the application has been decommissioned.
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to add cloud servers.
403: UID does not exist in device ID.
403: Device with ID does not exist.
403: Device with ID does not exist in DOMAIN.
403: The AWS instance with UID and device ID has already been imported to application NAME. You cannot import the same instance multiple times."},"response":[]},{"name":"Retrieve cloud server listing from SecureTrack","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"vendor"},{"value":null,"type":"text","key":"search_string"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/cloud_console/servers/","description":"Parameters:
customer_id: Customer ID to be filtered by. [optional]
vendor: Vendor to be filtered by.
search_string: Search text.
start: Returning matching result starting from this element in the array (0-based). [optional]
count: Total number of matching servers to return. [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers?vendor=Amazon&search_string=WebServe

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/cloud_console/servers?vendor=Amazon&search_string=\"WebServer1\"

Response Messages:
403: Access is denied
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to search for cloud servers.
400: Illegal search string.
400: Start is bigger then possible result count.
400: Start and count cannot hold negative values.
400: Vendor query param is required.
400: Vendor should be one of the following: Amazon.
400: Search string query param is required.
400: Customer with ID does not exist in SecureApp
400: Customer with ID was decommissioned."},"response":[]}]},{"name":"Customers","item":[{"name":"List all customers","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/","description":"Parameters:
name: The name of the customer [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers?name=Customer 1

Response Messages:
400: Not available in single-customer mode.
404: There are no customers with the name NAME."},"response":[]},{"name":"List all imported customers","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/imported","description":"

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/imported

Response Messages:
400: Not available in single-customer mode.
403: Access is denied"},"response":[]},{"name":"Retrieve existing applications for specific domain","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/{{customer_id}}/applications","description":"Parameters:
customer_id: The ID of the customer

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/2/applications

Response Messages:
400: Not available in single-customer mode.
400: Customer with id ID was not found.
403: Access is denied"},"response":[]},{"name":"import customers","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t2\n\t\n\t\n\t\t3\n\t\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/import","description":"Only users with 'Create new applications' and 'View all applications' permissions can run this API.

Parameters:
body: Customers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/customers/import
BODY<customers>
    <customer>
        <id>2</id>
    </customer>
    <customer>
        <id>3</id>
    </customer>
</customers>


Response Messages:
400: Not available in single-customer mode.
400: ID can not be empty.
400: There are some id's that doesn't exist.
403: Access is denied
503: Not connected to SecureTrack."},"response":[]},{"name":"Fetches customer by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"customer_id"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/{{customer_id}}","description":"Parameters:
customer_id: The ID of the customer

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/1

Response Messages:
400: Not available in single-customer mode.
400: Customer with id ID was not found."},"response":[]},{"name":"Update a customer","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tNOT_IMPORTED\n"},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/{{customer_id}}","description":"Parameters:
customer_id: The ID of the customer
body: Customers

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/secureapp/customers/2
BODY<customer>
    <usage_mode>NOT_IMPORTED</usage_mode>
</customer>


Response Messages:
400: Not available in single-customer mode.
400: Customer with id ID was not found.
400: Can not update Default customer.
400: This customer is already not imported.
400: USAGE_MODE is not a valid state. The valid values are: USAGE_MODES
403: Access is denied
500: This customer is not imported.
400: You cannot delete this customer because there are connection changes pending a ticket in another customer.You must decommission this customer first, and then delete it."},"response":[]},{"name":"List all non-imported customers","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/customers/not_imported","description":"Only users with 'Create new applications' and 'View all applications' permissions can run this API.



Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/customers/not_imported

Response Messages:
400: Not available in single-customer mode.
403: Access is denied
503: Not connected to SecureTrack."},"response":[]}]},{"name":"Domains","item":[{"name":"List all domains","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/domains/","description":"Parameters:
name: The name of the domain [optional]

Usage Example


Response Messages:
404: There are no domains with the name NAME."},"response":[]},{"name":"synchronize domains","request":{"method":"PUT","header":[],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/domains/synchronize","description":"Retrieves all the domains lists in ST , for use by SC. If a domain was deleted in ST, then it will be removed from SC



Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/domains/synchronize

Response Messages:
500: Multi-Domain mode is disabled in SecureChange. Unable to synchronize with SecureTrack domains"},"response":[]},{"name":"Fetches domain by ID","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"domainId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/domains/{{domainId}}","description":"Parameters:
domainId: The ID of the domain

Usage Example


Response Messages:
400: Domain with id ID was not found."},"response":[]}]},{"name":"External Provider","item":[{"name":"Returns a detailed list of the external network resources available to SeucreChange from external provider (SecureCloud or alternate)","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/externalprovider/resources","description":"Parameters:
name: Filter by name (substring, case insensitive) [optional]
uid: Filter by resource ref ID (exact match, case sensitive) [optional]
count: Limit number of results (default is 100) [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/externalprovider/resources?count=2
OUTPUT{
\"external_resources\":{
    \"external_resource\":[
     {
         \"resource_ref\":{
             \"id\":\"df67af5c-87b3-3e7a-bd50-371f76e9bdf5\",
             \"name\":\"ASG1\",
             \"type\":\"APPLICATION_SECURITY_GROUP\"
         },
         \"ips\":[
             \"2.0.0.0/15\",
             \"3.0.0.0/15\"
         ],
         \"account_ref\":{
             \"id\":\"5fcf0c94-6789-4fae-adb3-6e4226389069\",
             \"name\":\"app-group-prod-account\",
             \"cloud_vendor\":\"AZURE\"
         }
    },
    {
         \"resource_ref\":{
             \"id\":\"1cb7accb-f947-3e7f-b9b0-0b63973b2220\",
             \"name\":\"PM_ASG\",
             \"type\":\"APPLICATION_SECURITY_GROUP\"
         },
         \"ips\":[
             \"2.2.0.0/16\",
             \"3.5.0.0/16\"
         ],
         \"account_ref\":{
             \"id\":\"5fcf0c94-6789-4fae-adb3-6e4226389069\",
             \"name\":\"app-group-prod-account\",
             \"cloud_vendor\":\"AZURE\"
         }
    }
    ]
}}


Response Messages:
403: User has no permissions to view SecureCloud/Alternate provider resources
404: SecureCloud/Alternate provider disabled. Contact your administrator for assistance.
400: name and uid parameters cannot be used in same query."},"response":[]}]},{"name":"Load Balancers","item":[{"name":"Fetches virtual servers from SecureTrack","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"ip"}]},"url":"https://{{SecureApp_IP}}/securechangeworkflow/api/secureapp/external_resources/f5_virtual_servers","description":"Find virtual servers matching a given IP address.
You can search for the virtual server itself of any of its members.

Parameters:
ip: ip
domainId: The unique identifier of a domain [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/secureapp/external_resources/f5_virtual_servers?ip=2.2.2.2

Response Messages:
400: Invalid IP
400: Invalid Subnet
400: There is no domain with the specified ID.
403: Access is denied
503: Not connected to SecureTrack."},"response":[]}]},{"name":"Rule Recertification","item":[{"name":"Run Update Metadata for given task","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/rule_recertification/update_metadata","description":"A link to the rule recertification field will returned in the location field of the header, for example: /securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/fields/72

Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/rule_recertification/update_metadata

Response Messages:
400: Update Metadata is not defined for the requested field.
400: Update Metadata is not available for the current ticket status.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a rule recertification request field.
403: You do not have permission to update this task. Contact your administrator for assistance."},"response":[]}]},{"name":"SecureChange Devices","item":[{"name":"Returns IDs for specified list of excluded parent management devices and child firewalls in SecureChange","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/excluded","description":"For example on this Panorama hierarchy:
DG1 - Excluded
  DG1.1
    FW1
    FW2
    FW3

Calling this API with false value will return only DG1���s id.
Calling this API with true value will return DG1, FW1, FW2, FW3 id���s.


Parameters:
show_all: When set to true - Displays the specified devices and all their child firewalls in the hierarchy, which will be excluded implicitly.
When set to false - Displays only the devices which were explicitly excluded.
Default value is false.
[optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded
OUTPUT<device_ids>
    <id>10</id>
    <id>11</id>
</device_ids>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded?show_all=false
OUTPUT<device_ids>
    <id>10</id>
    <id>11</id>
</device_ids>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded?show_all=true
OUTPUT<device_ids>
    <id>33</id>
    <id>10</id>
    <id>11</id>
    <id>35</id>
    <id>29</id>
    <id>31</id>
</device_ids>

"},"response":[]},{"name":"Update the whole list of excluded devices in SecureChange","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t1\n\t12\n\n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/excluded","description":"Parameters:
body [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/excluded
BODY<device_ids>
    <id>1</id>
    <id>12</id>
</device_ids>

"},"response":[]},{"name":"Get suggested targets for a given access request","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"access_request\":{\n\t\t\"users\":{\n\t\t\t\"user\":[\n\t\t\t\t\"Any\"\n\t\t\t]\n\t\t},\n\t\t\"sources\":{\n\t\t\t\"source\":[\n\t\t\t\t{\n\t\t\t\t\t\"@type\":\"IP\",\n\t\t\t\t\t\"ip_address\":\"10.100.1.1\",\n\t\t\t\t\t\"netmask\":\"255.255.255.255\",\n\t\t\t\t\t\"cidr\":32\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"destinations\":{\n\t\t\t\"destination\":[\n\t\t\t\t{\n\t\t\t\t\t\"@type\":\"IP\",\n\t\t\t\t\t\"ip_address\":\"10.100.20.2\",\n\t\t\t\t\t\"netmask\":\"255.255.255.255\",\n\t\t\t\t\t\"cidr\":32\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"services\":{\n\t\t\t\"service\":[\n\t\t\t\t{\n\t\t\t\t\t\"@type\":\"ANY\",\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t\"action\":\"Accept\",\n\t}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/suggest_target","description":"Returns a list of suggested targets for a given access request, based on topology calculations.

Parameters:
body [optional]
domain_name: Domain Name
workflow_name: Workflow Name

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/devices/suggest_target?domain_name=Default&workflow_name=AR
BODY{
    \"access_request\":{
        \"users\":{
            \"user\":[
                \"Any\"
            ]
        },
        \"sources\":{
            \"source\":[
                {
                    \"@type\":\"IP\",
                    \"ip_address\":\"10.100.1.1\",
                    \"netmask\":\"255.255.255.255\",
                    \"cidr\":32
                }
            ]
        },
        \"destinations\":{
            \"destination\":[
                {
                    \"@type\":\"IP\",
                    \"ip_address\":\"10.100.20.2\",
                    \"netmask\":\"255.255.255.255\",
                    \"cidr\":32
                }
            ]
        },
        \"services\":{
            \"service\":[
                {
                    \"@type\":\"ANY\",
                }
            ]
        },
        \"action\":\"Accept\",
    }
}
OUTPUT{
    \"multi_target\": {
        \"target\": {
            \"@type\": \"Object\",
            \"object_name\": \"Device-1\",
            \"object_type\": \"firewall\",
            \"object_details\": \"10.100.40.1\",
            \"management_id\": 250,
            \"management_name\": \"Panorama/Domain1\"
        }
    }
}


Response Messages:
200: Targets returned successfully
400: User does not have permissions to domain or domain does not exist
403: Access is denied"},"response":[]},{"name":"Get details of target devices","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/devices/","description":"Parameters:
name: device name or part of a name [optional]
show_targets: show_targets true: Returns the details of devices that can be selected as a target
show_targets false: Returns the details of devices with objects that can be used in tickets [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/devices?name=asa&show_targets=true

Response Messages:
404: Devices not found"},"response":[]}]},{"name":"Server Decommissioning","item":[{"name":"Run Impact Analysis for given task","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/multi_server_decommission_request/impact_analysis","description":"Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/multi_server_decommission_request/impact_analysis

Response Messages:
400: Impact analysis is not defined for the requested field.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a decommission request field.
403: You do not have permission to update this task. Contact your administrator for assistance."},"response":[]},{"name":"Run server decommission designer for given task","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/multi_server_decommission_request/designer","description":"Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/multi_server_decommission_request/designer

Response Messages:
400: Server decommission designer is not defined for the requested field.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a decommission request field.
403: You do not have permission to update this task. Contact your administrator for assistance."},"response":[]},{"name":"Get server decommission designer results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_server_decommission_request/{{fieldId}}/designer","description":"Use this API to retrieve designer results generated in R17-1 and earlier.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Server Decommission Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/multi_server_decommission_request/261/designer

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>."},"response":[]},{"name":"Get verifier results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_server_decommission_request/{{fieldId}}/verifier","description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Server Decommission Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/multi_server_decommission_request/261/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>."},"response":[]},{"name":"Get impact analysis results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_server_decommission_request/{{fieldId}}/impact_analysis","description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Server Decommission Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/multi_server_decommission_request/261/impact_analysis

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>."},"response":[]},{"name":"Run Verifier for given task","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/multi_server_decommission_request/verifier","description":"Parameters:
id: Ticket ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/multi_server_decommission_request/verifier

Response Messages:
400: Verifier is not defined for the requested field.
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided task lacks a decommission request field.
403: You do not have permission to update this task. Contact your administrator for assistance."},"response":[]}]},{"name":"System Configuration","item":[{"name":"Modify the SecureTrack connection settings and test the connection status","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\t\n\t\t \n\t\t\tadmin\n\t\t\n\t\tfalse\n\t\t30\n\t"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/integration_with_secureTrack/","description":"Parameters:
testOnly: Test the connection status using the specified settings. The new settings are not saved. The default value is false [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/integration_with_secureTrack
BODY    <secureTrack_settings>
        <host xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"remoteHost\">
            <IP_or_hostname>192.168.11.1</IP_or_hostname>
            <user_name>admin</user_name>
        </host>
        <show_link_to_secureTrack>false</show_link_to_secureTrack>
        <check_connection_interval>30</check_connection_interval>
        <internal_IP_of_secureChange_server>192.168.2.2</internal_IP_of_secureChange_server>
    </secureTrack_settings>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/integration_with_secureTrack
BODY    <secureTrack_settings>
        <host xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"localHost\">
            <user_name>admin</user_name>
        </host>
        <show_link_to_secureTrack>false</show_link_to_secureTrack>
        <check_connection_interval>30</check_connection_interval>
    </secureTrack_settings>


Response Messages:
400: Invalid host name or IP address.
400: show_link_to_secureTrack is invalid. It must be 'true', 'false' or empty."},"response":[]},{"name":"Retrieve the SecureTrack connection settings and status","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/integration_with_secureTrack/","description":"

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/integration_with_secureTrack?testOnly=false
"},"response":[]}]},{"name":"System Users","item":[{"name":"Import LDAP users to SecureChange by simulating login process","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tx\n\tLDAP\n\t\t\n\t\t\t1\n\t\t\n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/","description":"This API implicitly imports LDAP users to SecureChange by simulating their login.
To explicitly import LDAP entities- both users and groups, it is recommended to use /users/import API

Parameters:
body: partyDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/users
BODY<user xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"user\">
    <name>x</name>
    <origin_type>LDAP</origin_type>
        <ldap_configuration>
            <id>1</id>
        </ldap_configuration>
</user>


Response Messages:
403: Access is denied.
400: Name is missing.
400: Origin is missing.
400: User {login_name} already exists, with ID (id} and name {name}.
400: User {login_name} not found in LDAP.
400: Creating a user via REST API is available only if origin is LDAP.
400: Creating a user via REST API is available only if type is User.
400: Ldap configuration with ID {id} not found."},"response":[]},{"name":"Return the list of users","request":{"method":"GET","header":[],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/","description":"user_name: case insensitive, search mode: contains text
exact_name: when set to true, user_name search mode is case sensitive and exact text
email: case insentitive, search mode: exact match
Logical OR between user_name and email.

Parameters:
showIndirectRelation: Members that belong to the selected group only indirectly [optional]
user_name: The user's login name [optional]
email: The user's email [optional]
exact_name: Search user_name as exact match [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/users?email=bob@tufin.com&user_name=bob&exact_name=true
"},"response":[]},{"name":"Import user / group from LDAP","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"ldap_party\": {\n\t\t\"ldap_configuration_name\": \"ldap_name\",\n\t\t\"ldap_dn\": \"CN=alice,OU=Advertising,OU=Marketing,DC=testEnv,DC=com\"\n\t}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/import","description":"The imported user / group will be visible in SecureChange GUI under users section.
In multi domain mode, imported entity will be assigned with the domains of \"any user\" group.
Only users with 'view settings tab' permission can run this API.

Parameters:
body: ldapPartyDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/users/import
BODY{
    \"ldap_party\": {
        \"ldap_configuration_name\": \"ldap_name\",
        \"ldap_dn\": \"CN=alice,OU=Advertising,OU=Marketing,DC=testEnv,DC=com\"
    }
}


Response Messages:
400: The LDAP configuration name does not exist
400: The given ldap_dn does not exist
400: The given ldap_dn is already imported
400: Failed to create the selected user
400: Failed to create the selected group
400: Selected user already exists in SecureChange but is not synchronized with the LDAP server. Go to Settings > LDAP and synchronize with the LDAP
400: This group has a large number of users, and will not be expanded in the users console. To be able to configure roles and step participation for individual users from the group, add them explicitly.
400: Failed to update the selected group
400: Unsupported LDAP object class
400: Unable to establish a connection to server <SERVER_IP>:<SERVER_PORT> within the configured timeout of <TIMEOUT> milliseconds.
403: Access is denied"},"response":[]},{"name":"Change local group members","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"group_change\":{\n\t\t\"member_ids_to_add\": [1,2],\n\t\t\"member_ids_to_remove\":[3,4]\n\t}\n}\t"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/group/{{id}}","description":"Only users with 'view settings tab' permission can run this API.
Only local or imported LDAP users can be added to local groups.

Parameters:
id: Group ID
body: groupChangeDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/users/group/1
BODY{
    \"group_change\":{
        \"member_ids_to_add\": [1,2],
        \"member_ids_to_remove\":[3,4]
    }
}    


Response Messages:
400: Exceeded limit of {MAXIMUM} group member changes
400: These user IDs do not exist: {IDs}
400: These user IDs do not exist or are not group members: {IDs}
400: Group ID {ID} is not a local group
400: Group ID {ID} does not exist
400: Cannot add a group to itself
400: Cannot add a group to a group that it already contains. Group {ID1} contains group {ID2}"},"response":[]},{"name":"Delete the specified User or Group","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/{{id}}","description":"Parameters:
id: User ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/users/5

Response Messages:
400: User with id {id} does not exist"},"response":[]},{"name":"Return the specified user","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/{{id}}","description":"Parameters:
id: User ID
showIndirectRelation: Members that belong to the selected group only indirectly [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/users/5

Response Messages:
400: User or group was not found."},"response":[]},{"name":"Create local group","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"group\": {\n\t\t\"name\": \"name1\",\n\t\t\"description\": \"description1\",\n\t\t\"email\": \"email1@tufin.com\"\n\t}\n}\t"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/users/group","description":"Only users with 'view settings tab' permission can run this API.

Parameters:
body: CreateGroupDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/users/group
BODY{
    \"group\": {
        \"name\": \"name1\",
        \"description\": \"description1\",
        \"email\": \"email1@tufin.com\"
    }
}    


Response Messages:
400: Input Validation Error : {field name}: {input validation error message}
400: Name already exists"},"response":[]}]},{"name":"Ticket Lifecycle","item":[{"name":"Cancel a ticket","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/cancel","description":"Parameters:
id: The ID of the ticket as shown in SecureChange
requester_id: The user of the ticket's requester, when logged in user is canceling on behalf [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/cancel?requester_id=5

Response Messages:
403: Access is denied.
404: Ticket is already closed
404: Ticket ID was not found"},"response":[]},{"name":"Returns the specified ticket to the specified step","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tplease fix source \n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/redo/{{toStepId}}","description":"Values can only be updated for the current step.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
toStepId: To which step we the ticket will return
body: RedoCommentDto

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/redo/1
BODY<redo_step_comment>
    <comment>please fix source </comment>
</redo_step_comment>


Response Messages:
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Task <NAME> is no longer active
403: User has no permissions to redo ticket steps.
404: There is no ticket with ID.
404: No entity found for query"},"response":[]},{"name":"Change the requester of the specified ticket task to the specified user.","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tuser was deleted moving tickets to Bob\n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/change_requester/{{assigneeId}}","description":"Parameters:
id: Ticket ID
assigneeId: The assignee ID
body: CommentDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/change_requester/4
BODY<comment>
    <comment>user was deleted moving tickets to Bob</comment>
</comment>


Response Messages:
400: The change requester comment must be set in order to change the requester the ticket.
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
404: There is no ticket with ID.
404: There is no requester (User) with ID."},"response":[]},{"name":"Returns the history of the specified ticket","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/history","description":"Parameters:
id: Ticket ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/history

Response Messages:
403: User has no permissions to view ticket history
404: You do not have permission to view this task. Contact your administrator for assistance.
404: There is no ticket with ID."},"response":[]},{"name":"Map rules to ticket","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/map_rules","description":"Maps the rules from the ticket to the relevant rules in SecureTrack.
Adds record set entries to the relevant rules metadata.
Link to history is found in the returned location header.
Applicable only for closed tickets in the following workflows: Access Request, Access Request and Modify Group, and Clone Server Policy.
Use handler_id for running on behalf of another user.
To get handler_id, use the System Users API.

Parameters:
id: The ID of the ticket as shown in SecureChange
handler_id: Run API on behalf of defined user id [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/map_rules

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/map_rules?handler_id=5

Response Messages:
201: Started asynchronous mapping of rules to ticket ID <ID>. Mapping status is displayed in ticket history.
400: Ticket's workflow type does not support this operation
403: Access is denied.
403: You do not have permission to access ticket <ID>
403: On behalf user do not have permission to access ticket <ID>
404: There is no ticket with ID <ID>.
404: There is no handler (User) with ID <ID>.
412: Ticket is not in closed status"},"response":[]},{"name":"Confirm the request","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tconfirmed\n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/confirm","description":"Parameters:
id: Ticket ID
requester_id: The user of the ticket's requester, when logged in user is confirm on behalf [optional]
body: Confirm comment

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/confirm?requester_id=5
BODY<confirm_comment>
    <comment>confirmed</comment>
</confirm_comment>


Response Messages:
400: User is trying to confirm a ticket that belongs to another user
400: User is not permitted to confirm this ticket on behalf another user
400: The user can not confirm the ticket, because he is not in the domain of the ticket
403: Access is denied.
404: There is no ticket with ID ."},"response":[]},{"name":"Reassigns the specified ticket task to the specified user.","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\tPlease complete the AR\n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/reassign/{{assigneeId}}","description":"Values can only be updated for the current step.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
assigneeId: The assignee ID
body: ReassignTaskCommentDTO

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/reassign/4
BODY<reassign_task_comment>
    <comment>Please complete the AR</comment>
</reassign_task_comment>


Response Messages:
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Task <NAME> is no longer active
404: There is no ticket with ID.
404: No entity found for query"},"response":[]},{"name":"Reject a ticket","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\trejected\n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/reject","description":"Parameters:
id: The ID of the ticket as shown in SecureChange
handler_id: The user id, when logged in user is rejecting on behalf [optional]
body: Reject comment

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/reject?handler_id=5
BODY<reject_comment>
    <comment>rejected</comment>
</reject_comment>


Response Messages:
400: Ticket status <STATUS> is incorrect to perform this action
400: User <NAME> has no permissions to perform this action
400: Comment cannot be empty
403: User is not permitted to reject this ticket on behalf another user
403: You do not have permission to access ticket <ID>
403: On behalf user do not have permission to access ticket <ID>
403: Access is denied.
404: There is no ticket with ID <ID>.
404: There is no handler (User) with ID <ID>."},"response":[]}]},{"name":"Tickets","item":[{"name":"Returns topology map image (png file) for specific verifier results","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_access_request/{{fieldId}}/verifier/topology_map","description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/multi_access_request/2022/verifier/topology_map

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.
404: Verifier results were not found in the access request.
404: Toplogy map was not found for this field."},"response":[]},{"name":"Get security zones according to field id","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/security_zones","description":"Use this API to retrieve security zones for multi access result field

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/security_zones

Response Messages:
404: There is no ticket with ID <ID>.
401: Cannot update ticket because it is either closed, rejected or waiting for requester confirmation
400: Task ID <ID> cannot be found in the current step with ID <ID>.
400: You can only update the current step of the ticket. Step ID <ID> does not match the current step ID <ID>.
400: The task with ID <ID> does not contain a field with ID <ID>.
400: The task with ID <ID> does not contain a field of type <ID>.
400: Security zones tool is not enabled for the requested field.
403: You do not have permission to view this task. Contact your administrator for assistance."},"response":[]},{"name":"Modify the Designer suggestions for Access Request or Clone Server Policy","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"rule_placement\": {\"new_value\":\"before\"}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/tasks/{{taskId}}/designer/instruction/{{instructionId}}","description":" GENERAL USE
1. Create a ticket using UI/API.
2. Run the designer using UI/API.
3. Use relevent API to get the designer results.
4. Run this API to modify the required parameters.

*Note: you can modify one parameter at a time.

Change rule location use
a. Modifying the rule order places the new rule before the rule with the specified identifier (rule name or number).
b. Modifying the rule placement to \"last\" places the new rule as last rule or last pre-rule (depending on the vendor convention for the device).
c. For vendors that support \"after\" placement, modifying the rule placement allows positioning the new rule before or after the suggested rule location.
d. For Check Point R80 and above releases, the indented rule numbering format can be applied to globally assigned policies (for example, ���rule_order���: ���4.5���).

track level permitted values:
NONE, LOG, ACCOUNT, ALERT, SNMP, MAIL, USER_DEFINED, EMERGENCIES, ALERTS, CRITICAL, ERRORS, WARNINGS, NOTIFICATIONS, INFORMATIONAL, DEBUGGING, DISABLED, DEFAULT, FULL_LOG, NETWORK_LOG, USER_ALERT_1, USER_ALERT_2, USER_ALERT_3

rule placement permitted values:
BEFORE, AFTER, LAST

Parameters:
body: DesignerInstructionChangeDTO
id: Ticket ID
taskId: Task ID
instructionId: Instruction ID
force: force update when new revision available [optional]

Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"comment\": {\"new_value\":\"new comment\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196?force=true
BODY{
    \"comment\": {\"new_value\":\"new comment\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_name\": {\"new_value\":\"new rule name\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"track_level\": {\"new_value\":\"LOG\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"object_name\": {\"new_value\":\"new object name\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"log_forwarding_profile\": {\"new_value\":\"new log forwarding profile\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"security_profile_group\": {\"new_value\":\"new security profile group\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"object_replace\": {
             \"new_value\":\"new object uid\",
             \"old_value\":\"old object uid\"
    }
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_order\": {\"new_value\":\"8\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"tags\": {\"values\":[\"tag1\", \"tag2\"]}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"tags\": {\"values\":[]}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_placement\": {\"new_value\":\"last\"}
}


Usage Example
URLhttps://172.16.203.10/securechangeworkflow/api/securechange/tickets/29/tasks/63/designer/instruction/196
BODY{
    \"rule_placement\": {\"new_value\":\"before\"}
}


Response Messages:
200: New rule will be shadowed
200: New rule will be shadowed or break acceleration
400: Modify Designer Results API is only supported for Access Request and Clone Server Policy workflows
412: Current instruction cannot be modified because either the implementation was successful or failed irrevocably.
412: Current step does not support Designer modification action
404: A ticket with ID <ID> cannot be found.
400: Task ID <ID> cannot be found in the current step with ID <ID>.
403: Changing <TYPE> is not supported on this device
403: This Change is not supported for <INSTRUCTION TYPE> instruction type\"
403: You do not have permission to update this task. Contact your administrator for assistance.
403: New revision is available, cannot modify the Designer results
404: Specified instruction, id: <ID> was not found
404: Designer results were not found in the access request.
400: a valid object name must start with an alphanumeric character and can contain alphanumeric characters, underscore '_'. Hypen '-', dot '.' or spaces
400: For this device, the comment must be less than 100 characters per line.
400: For this device, this field must be less than <NUMBER OF CHARACTERS> characters
400: For this device, this field is required.
400: For this device, a valid object name cannot be <OBJECT NAME> because it is a reserved word
409: Rule name already exists for this device. Please give this rule a unique name.
409: Rule name <NAME> already exists in the device group hierarchy. Choose a unique name for this rule.
400: Comment contains invalid characters.
400: <DEVICE> does not support tracking level <TRACKING LEVEL>
400: <TRACKING LEVEL> is not a valid rule track level value
400: a valid object name cannot contain any of the following characters: <CHARACTERS>
400: a valid object name must be less than <NUMBER OF CHARACTERS> characters
400: a valid object name cannot be empty
400: a valid object name must conform to the following pattern: <STRING PATTERN>
409: Object already exists
400: A security profile group cannot be empty.
404: The security profile group <SECURITY PROFILE GROUP> was not found.
503: Not connected to SecureTrack.
500: An error occurred in SecureTrack while trying to validate the security profile group.
400: A log forwarding profile cannot be empty.
400: Tag list is longer than 20 items.
400: Tag list contains the same tag more than once.
400: These tags don't exist or aren't relevant to the rule on its DG location : <Tags>
404: The log forwarding profile <LOG FORWARDING PROFILE> was not found.
500: An error occurred in SecureTrack while trying to validate the log forwarding profile.
400: Object UID <OLD OBJECT UID> not found in the rule for this instruction.
400: Values of new object UID <NEW OBJECT UID> and old object UID <OLD OBJECT UID> do not match.
400: Rule placement can only be: \"before\", \"after\" or \"last\".
400: You can't change rule placement when there is no rule order. please add rule order first.
400: You can't change rule placement to \"After\" for this type of device.
400: You can't change rule placement to \"Last\" for this type of device."},"response":[]},{"name":"Returns the details of a specified ticket","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
expand_links: See expanded view of the objects [optional]
showStepsDetails: Include steps' details in the response [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1
OUTPUT {
    \"ticket\": {
        \"id\": 1,
        \"subject\": \"AR-Ticket\",
        \"requester\": \"a\",
        \"requester_id\": 4,
        \"priority\": \"Normal\",
        \"status\": \"In Progress\",
        \"domain_name\": \"\",
        \"sla_status\": \"NA\",
        \"sla_outcome\": \"NA\",
        \"workflow\": {
            \"id\": 11,
            \"name\": \"AR & MG\",
            \"uses_topology\": true
        },
        \"steps\": {
            \"step\": [
                {
                    \"id\": 209,
                    \"name\": \"Open request\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 209,
                            \"assignee_id\": 4,
                            \"assignee\": \"a\",
                            \"status\": \"DONE\",
                            \"fields\": {
                                \"field\": [
                                    {
                                        \"@xsi.type\": \"multi_access_request\",
                                        \"id\": 1695,
                                        \"name\": \"AR\",
                                        \"read_only\": false,
                                        \"access_request\": {
                                            \"id\": 1706,
                                            \"order\": \"AR1\",
                                            \"risk_analysis_result\": {
                                                \"status\": \"not run\"
                                            },
                                            \"verifier_result\": {
                                                \"status\": \"not run\"
                                            },
                                            \"use_topology\": true,
                                            \"targets\": {
                                                \"target\": {
                                                    \"@type\": \"ANY\",
                                                    \"id\": 1705
                                                }
                                            },
                                            \"users\": {
                                                \"user\": [
                                                    \"Any\"
                                                ]
                                            },
                                            \"sources\": {
                                                \"source\": [
                                                    {
                                                        \"@type\": \"INTERNET\",
                                                        \"id\": 1701
                                                    },
                                                    {
                                                        \"@type\": \"DNS\",
                                                        \"id\": 1702,
                                                        \"host_name\": \"www.google.com\",
                                                        \"dns_ip_addresses\": {
                                                            \"ip_address\": \"216.58.214.100\"
                                                        }
                                                    },
                                                    {
                                                        \"@type\": \"IP\",
                                                        \"id\": 1703,
                                                        \"ip_address\": \"1.1.1.1\",
                                                        \"netmask\": \"255.255.255.255\",
                                                        \"nat_ip_address\": \"4.4.4.4\",
                                                        \"nat_netmask\": \"255.255.255.255\"
                                                    }
                                                ]
                                            },
                                            \"destinations\": {
                                                \"destination\": [
                                                    {
                                                        \"@type\": \"ANY\",
                                                        \"id\": 1697
                                                    }
                                                ]
                                            },
                                            \"services\": {
                                                \"service\": [
                                                    {
                                                        \"@type\": \"ANY\",
                                                        \"id\": 1699
                                                    }
                                                ]
                                            },
                                            \"action\": \"Accept\",
                                            \"labels\": \"\"
                                        }
                                    },
                                    {
                                        \"@xsi.type\": \"multi_group_change\",
                                        \"id\": 1707,
                                        \"name\": \"MG\",
                                        \"read_only\": false,
                                        \"implementation_status\": \"NOT_SUPPORTED\"
                                    }
                                ]
                            }
                        }
                    }
                },
                {
                    \"id\": 210,
                    \"name\": \"STEP2 - auto AR with designer /update /commit\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 210,
                            \"assignee_id\": 4,
                            \"assignee\": \"a\",
                            \"status\": \"ASSIGNED\",
                            \"unlicensed_devices_for_automation\": {
                                \"unlicensed_device_for_automation\": [
                                    {
                                        \"id\": \"2\",
                                        \"name\": \"asa\"
                                    }
                                ]
                            }
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"multi_access_request\",
                                    \"id\": 1709,
                                    \"name\": \"AR\",
                                    \"read_only\": false,
                                    \"access_request\": {
                                        \"id\": 1720,
                                        \"order\": \"AR1\",
                                        \"risk_analysis_result\": {
                                            \"status\": \"not run\"
                                        },
                                        \"verifier_result\": {
                                            \"status\": \"not run\"
                                        },
                                        \"use_topology\": true,
                                        \"targets\": {
                                            \"target\": {
                                                \"@type\": \"ANY\",
                                                \"id\": 1719
                                            }
                                        },
                                        \"users\": {
                                            \"user\": [
                                                \"Any\"
                                            ]
                                        },
                                        \"sources\": {
                                            \"source\": [
                                                {
                                                    \"@type\": \"INTERNET\",
                                                    \"id\": 1721
                                                },
                                                {
                                                    \"@type\": \"DNS\",
                                                    \"id\": 1722,
                                                    \"host_name\": \"www.google.com\",
                                                    \"dns_ip_addresses\": {
                                                        \"ip_address\": \"216.58.214.100\"
                                                    }
                                                },
                                                {
                                                    \"@type\": \"IP\",
                                                    \"id\": 1723,
                                                    \"ip_address\": \"1.1.1.1\",
                                                    \"netmask\": \"255.255.255.255\",
                                                    \"nat_ip_address\": \"4.4.4.4\",
                                                    \"nat_netmask\": \"255.255.255.255\"
                                                },
                                                {
                                                    \"@type\": \"RANGE\",
                                                    \"id\": 1724,
                                                    \"range_first_ip\": \"1.1.11.1\",
                                                    \"range_last_ip\": \"1.1.11.10\"
                                                }
                                                {
                                                    \"@type\": \"EXTERNAL_RESOURCE\"\",
                                                    \"id\": 436,
                                                    \"resource_ref\": {
                                                        \"id\": \"4786115a-97c2-3a25-8e31-1d6166263fdd\",
                                                        \"name\": \"asg-web\",
                                                        \"type\": \"APPLICATION_SECURITY_GROUP\"
                                                    },
                                                    \"ips\": {
                                                        \"ip\": [
                                                            \"9.0.0.0/16\"
                                                        ]
                                                    },
                                                    \"account_ref\": {
                                                        \"cloud_vendor\": \"AZURE\",
                                                        \"id\": \"f0499890-708c-46a9-a44a-b7da0d433de3\",
                                                        \"name\": \"app-name\",
                                                    }
                                                }
                                            ]
                                        },
                                        \"destinations\": {
                                            \"destination\": [
                                                {
                                                    \"@type\": \"ANY\",
                                                    \"id\": 1711
                                                }
                                            ]
                                        },
                                        \"services\": {
                                            \"service\": [
                                                {
                                                    \"@type\": \"ANY\",
                                                    \"id\": 1713
                                                }
                                            ]
                                        },
                                        \"action\": \"Accept\",
                                        \"labels\": \"\"
                                    }
                                }
                            }
                        }
                    }
                }
            ]
        },
        \"current_step\": {
            \"id\": 210,
            \"name\": \"STEP2 - auto AR with designer /update /commit\"
        },
        \"comments\": \"\"
    }
}


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2
OUTPUT {
    \"ticket\": {
        \"id\": 2,
        \"subject\": \"Clone Server Policy Ticket\",
        \"requester\": \"a\",
        \"requester_id\": 12,
        \"priority\": \"Normal\",
        \"status\": \"In Progress\",
        \"referenced_ticket\": {
            \"id\": 1,
            \"name\": \"Ticket Subject Sample\",
            \"link\": {
                \"@href\": \"https://host/securechangeworkflow/api/securechange/tickets/1\"
            }
        },
        \"domain_name\": \"\",
        \"sla_status\": \"NA\",
        \"sla_outcome\": \"NA\",
        \"workflow\": {
            \"id\": 109,
            \"name\": \"sc_12705\",
            \"uses_topology\": false
        },
        \"steps\": {
            \"step\": [
                {
                    \"id\": 78,
                    \"name\": \"Open request\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 78,
                            \"assignee_id\": 12,
                            \"assignee\": \"a\",
                            \"status\": \"DONE\",
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"clone_server_policy_request\",
                                    \"id\": 872,
                                    \"name\": \"Clone Server Policy Field\",
                                    \"from_server\": {
                                        \"@type\": \"IP\",
                                        \"id\": 869,
                                        \"ip_address\": \"1.2.2.2\",
                                        \"cidr\": 32
                                    },
                                    \"to_servers\": {
                                        \"server\": {
                                            \"@type\": \"IP\",
                                            \"id\": 871,
                                            \"ip_address\": \"10.100.23.32\",
                                            \"netmask\": \"255.255.255.255\",
                                            \"cidr\": 32
                                        }
                                    },
                                    \"comment\": \"target servers to clone server policy to\"
                                }
                            }
                        }
                    }
                },
                {
                    \"id\": 79,
                    \"name\": \"Business Approval\",
                    \"redone\": false,
                    \"skipped\": false,
                    \"tasks\": {
                        \"task\": {
                            \"id\": 79,
                            \"assignee_id\": 12,
                            \"assignee\": \"a\",
                            \"status\": \"ASSIGNED\",
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"clone_server_policy_request\",
                                    \"id\": 876,
                                    \"name\": \"Clone Server Policy Field\",
                                    \"from_server\": {
                                        \"@type\": \"IP\",
                                        \"id\": 873,
                                        \"ip_address\": \"1.2.2.2\",
                                        \"cidr\": 32
                                    },
                                    \"to_servers\": {
                                        \"server\": {
                                            \"@type\": \"IP\",
                                            \"id\": 875,
                                            \"ip_address\": \"10.100.23.32\",
                                            \"netmask\": \"255.255.255.255\",
                                            \"cidr\": 32
                                        }
                                    },
                                    \"comment\": \"target servers to clone server policy to\"
                                }
                            }
                        }
                    }
                }
            ]
        },
        \"current_step\": {
            \"id\": 79,
            \"name\": \"Business Approval\"
        },
        \"comments\": \"\"
    }
}


Response Messages:
403: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: No entity found for query"},"response":[]},{"name":"Change multiple field within a task of a ticket in the current step","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\"fields\": {\n\"field\": {\n\"@xsi.type\": \"rule_modification_field\",\n\"id\": 746,\n\"name\": \"rm\",\n\"devices\": {\n\t\"device\": {\n\t\"revision_id\": 24,\n\t\"management_id\": 5,\n\t\"bindings\": {\n\t\"binding\": {\n\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\"binding\": {\n\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t},\n\t\"rules\": {\n\t\t\"rule\": {\n\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t}\n\t}\n\t}\n\t}\n\t}\n},\n\"rule_modifications\": {\n\t\"rule_modification\": {\n\t\"@xsi.type\": \"modify_rule_modification\",\n\t\"rule_key\": {\n\t\"device_id\": 5,\n\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t},\n\t\"source_modifications\": {\n\t\"network_object_cell_modifications\": {\n\t\"network_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\"name\": \"NET_1\",\n\t\t\t\"comment\": \"\",\n\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t}\n\t\t]\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t}\n\t\t]\n\t\t}\n\t\t}\n\t]\n\t}\n\t},\n\t\"destination_modifications\": {\n\t\"network_object_cell_modifications\": {\n\t\"network_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"REMOVE\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\"name\": \"Host123\",\n\t\t\t\"comment\": \"cccHost\",\n\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t}\n\t\t]\n\t\t}\n\t\t}\n\t]\n\t}\n\t},\n\t\"service_modifications\": {\n\t\"service_object_cell_modifications\": {\n\t\"service_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"REMOVE\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\"name\": \"ICMP_1\",\n\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\"type\": {\n\t\t\t\"from\": 55,\n\t\t\t\"to\": 55\n\t\t}\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\"name\": \"TCP_1\",\n\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\"port\": {\n\t\t\t\"from\": 1234,\n\t\t\t\"to\": 1234\n\t\t},\n\t\t\"protocol\": \"TCP\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\"name\": \"UDP_1\",\n\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\"port\": {\n\t\t\t\"from\": 3,\n\t\t\t\"to\": 3\n\t\t},\n\t\t\"protocol\": \"UDP\"\n\t\t}\n\t\t}\n\t\t}\n\t]\n\t}\n\t}\n\t}\n}\n}\n}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/fields","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ���add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldListDTO
id: Ticket ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields
BODY<fields>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_server_decommission_request\">
         <id>7591</id>
         <name>sd</name>
         <server_decommission_request>
             <id>7596</id>
             <order>DR1</order>
             <servers>
                 <server type=\"IP\">
                     <id>7593</id>
                     <ip_address>2.2.2.2</ip_address>
                     <netmask>255.255.255.255</netmask>
                 </server>
             </servers>
             <targets>
                 <target type=\"ANY\">
                     <id>7595</id>
                 </target>
             </targets>
             <comment>change ip from 1.1.1.1 to 2.2.2.2</comment>
         </server_decommission_request>
     </field>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"date\">
         <id>7786</id>
         <name>date</name>
         <value>2015-12-15</value>
     </field>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"time\">
         <id>7787</id>
         <name>time</name>
         <value>12:00</value>
     </field>
</fields>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields
BODY{
\"fields\": {
\"field\": {
\"@xsi.type\": \"rule_modification_field\",
\"id\": 746,
\"name\": \"rm\",
\"devices\": {
    \"device\": {
    \"revision_id\": 24,
    \"management_id\": 5,
    \"bindings\": {
    \"binding\": {
    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
    \"binding\": {
        \"@xsi.type\": \"policy__binding\",
        \"policy_name\": \"FortiGate-VM64-111-10_3\"
    },
    \"rules\": {
        \"rule\": {
        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
        \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
        }
    }
    }
    }
    }
},
\"rule_modifications\": {
    \"rule_modification\": {
    \"@xsi.type\": \"modify_rule_modification\",
    \"rule_key\": {
    \"device_id\": 5,
    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
    \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
    },
    \"source_modifications\": {
    \"network_object_cell_modifications\": {
    \"network_object_cell_modification\": [
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
            \"name\": \"NET_1\",
            \"comment\": \"\",
            \"ip\": \"3.3.3.3\",
            \"netmask\": \"255.255.255.255\"
        }
        ]
        }
        },
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
            \"name\": \"RANGE_1\",
            \"comment\": \"EXAMPLE_RANGE\",
            \"min_ip\": \"3.3.3.3\",
            \"max_ip\": \"5.5.5.5\"
        }
        ]
        }
        }
    ]
    }
    },
    \"destination_modifications\": {
    \"network_object_cell_modifications\": {
    \"network_object_cell_modification\": [
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
        }
        }
        },
        {
        \"action\": \"REMOVE\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
            \"name\": \"Host123\",
            \"comment\": \"cccHost\",
            \"ip\": \"1.2.3.4\",
            \"netmask\": \"255.255.255.255\"
        }
        ]
        }
        }
    ]
    }
    },
    \"service_modifications\": {
    \"service_object_cell_modifications\": {
    \"service_object_cell_modification\": [
        {
        \"action\": \"REMOVE\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:icmp_service\",
        \"name\": \"ICMP_1\",
        \"comment\": \"EXAMPLE_ICMP\",
        \"type\": {
            \"from\": 55,
            \"to\": 55
        }
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:transport_service\",
        \"name\": \"TCP_1\",
        \"comment\": \"EXAMPLE_TCP\",
        \"port\": {
            \"from\": 1234,
            \"to\": 1234
        },
        \"protocol\": \"TCP\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:transport_service\",
        \"name\": \"UDP_1\",
        \"comment\": \"EXAMPLE_UDP\",
        \"port\": {
            \"from\": 3,
            \"to\": 3
        },
        \"protocol\": \"UDP\"
        }
        }
        }
    ]
    }
    }
    }
}
}
}
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object / device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (<device network object / device service object> is invalid: There are multiple objects with this name in the network)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
403: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: Invalid value for field: <FIELD_NAME> (a valid object comment can have up to <MAX> characters)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value
406: Invalid format detected: <name|binding_uid|rule_uid> - This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags
406: Invalid format detected: name - <VALUE> is invalid. Text must include <1-255> characters
406: Invalid format detected: <rule_uid|binding_uid> - <VALUE> is invalid. Text must include <1-4096> characters
406: Invalid format detected: comment - <VALUE> is invalid. Text must include <0-4096> characters
406: Invalid format detected: name - <VALUE> is invalid. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters + - , _ # @ . : = ! ^ ( )
406: Invalid format detected: <rule_uid|binding_uid|comment> - <VALUE> is invalid. Text includes invalid expressions such as HTML tags or command line operations
406: Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP"},"response":[]},{"name":"Returns the details of a specified ticket stages","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2

Response Messages:
403: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID."},"response":[]},{"name":"Get designer results according to field id","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/designer","description":"Use this API to retrieve designer results generated in R17-2 and later.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/designer

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: Specified field, id: <ID> , name: <NAME>, cannot contain designer result
404: Designer results were not found in the request."},"response":[]},{"name":"Submit a new ticket to Secure Change","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\t\"ticket\": {\n\t\t\"subject\": \"RM_EXAMPLE\",\n\t\t\"requester\": \"m\",\n\t\t\"requester_id\": 4,\n\t\t\"priority\": \"Normal\",\n\t\t\"domain_name\": \"\",\n\t\t\"workflow\": {\n\t\t\t\"name\": \"RM\",\n\t\t},\n\t\t\"steps\": {\n\t\t\t\"step\": [\n\t\t\t\t{\n\t\t\t\t\t\"tasks\": {\n\t\t\t\t\t\t\"task\": {\n\t\t\t\t\t\t\t\"fields\": {\n\t\t\t\t\t\t\t\t\"field\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\t\t\t\t\t\t\"devices\": {\n\t\t\t\t\t\t\t\t\t\t\"device\": {\n\t\t\t\t\t\t\t\t\t\t\t\"revision_id\": 24,\n\t\t\t\t\t\t\t\t\t\t\t\"management_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"rule_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\t\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 11,\n\t\t\t\t\t\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"id\": 9,\n\t\t\t\t\t\t\t\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/","description":" GENERAL USE
When posting a Modify Group ticket, group scope must be configured for FortiManager advanced and Juniper SRX devices.
Juniper SRX devices:
Global address-book will be used unless an existing address-book is given.
Ticket validation will fail in case given Address Book is not configured on the device.
FortiManager advanced devices:
'Any' zone will be used unless an existing zone is given.
Ticket validation will fail in case given zone is not configured on the device.
*Note: Zones and address-books must not be configured for other devices.

Using newly created objects from a different group in the same ticket
The user can add a newly created object from a different group to the selected group, with object_UID equal to the name of the newly created object.
For management devices with hierarchies, the newly created object does not populate other levels of the hierarchies.

Permitted values for @type
Allowed values for @type property included in DestinationDTO and SourceDTO are:
ANY
IP
DNS
Object - Device's existing object
INTERNET
LDAP (SourceDTO only) - LDAP entity

To use a service object in a new request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id
2. Both object_name and management_name

To use a network object in a new request you must use two parameters to specify the object. The parameter options are:
1. Both object_UID and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both object_UID and object_name are defined, object_UID takes precedence over object_name

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ���add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: ticketDTO
closed: Cannot be done from the API [optional]
count [optional]

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY<ticket>
    <subject>topology mode_AR1-with topology_AR2-no topology</subject>
    <requester>u1</requester>
    <priority>Normal</priority>
    <domain_name>Default</domain_name>
    <workflow>
         <id>7</id>
         <name>Workflow with topology</name>
    </workflow>
    <steps>
         <step>
             <name>Open request</name>
             <tasks>
                 <task>
                     <fields>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_access_request\">
                             <name>Required Access</name>
                             <access_request>
                                 <use_topology>true</use_topology>
                                 <targets>
                                     <target type=\"Object\">
                                         <object_name>ASA</object_name>
                                         <management_name>ASA</management_name>
                                     </target>
                                 </targets>
                                 <users>
                                     <user>Any</user>
                                 </users>
                                 <sources>
                                     <source type=\"Object\">
                                         <object_name>host_10.100.10.140</object_name>
                                         <management_name>NetScreen</management_name>
                                     </source>
                                 <sources>
                                     <source type=\"Object\">
                                         <object_UID>{55908141-c341-4990-9cc6-a3fd2dfb49e1}</object_UID>
                                         <management_id>13</management_id>
                                     </source>
                                 </sources>
                                 <destinations>
                                     <destination type=\"Object\">
                                         <object_name>h_10.10.10.10</object_name>
                                         <management_name>ASA</management_name>
                                     </destination>
                                 </destinations>
                                 <services>
                                     <service type=\"PROTOCOL\">
                                         <protocol>TCP</protocol>
                                         <port>80</port>
                                     </service>
                                     <service type=\"APPLICATION_IDENTITY\">
                                         <application_name>Gmail</application_name>
                                     </service>
                                 </services>
                                 <action>Accept</action>
                                 <labels/>
                             </access_request>
                             <access_request>
                                 <use_topology>false</use_topology>
                                 <targets>
                                     <target type=\"Object\">
                                         <object_name>inside_access_in</object_name>
                                         <management_name>ASA</management_name>
                                     </target>
                                 </targets>
                                 <users>
                                     <user>Any</user>
                                 </users>
                                 <sources>
                                     <source type=\"Object\">
                                         <object_name>1.1.1.0</object_name>
                                         <management_name>NetScreen</management_name>
                                     </source>
                                     <source type=\"EXTERNAL_RESOURCE\">
                                         <resource_ref>
                                             <name>asg15-api-test</name>
                                         </resource_ref>
                                     </source>
                                 </sources>
                                 <destinations>
                                     <destination type=\"Object\">
                                         <object_name>network_regi3</object_name>
                                         <management_name>ASA</management_name>
                                     </destination>
                                     <destination type=\"EXTERNAL_RESOURCE\">
                                         <resource_ref>
                                             <id>916ca6a9-76e2-3d9f-a35c-134f0981791a</id>
                                         </resource_ref>
                                     </destination>
                                 </destinations>
                                 <services>
                                     <service type=\"ANY\">
                                     </service>
                                 </services>
                                 <action>Accept</action>
                                 <labels/>
                             </access_request>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_area\">
                             <name>Business Justification</name>
                             <text>I need access to ftp </text>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"text_field\">
                             <name>Project Number</name>
                             <text>CR124560 </text>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"hyperlink\">
                             <name>Hyperlink</name>
                             <url>http://192.168.1.1/ticket</url>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"drop_down_list\">
                             <name>Change Window</name>
                             <selection>Monday</selection>
                         </field>
                         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"manager\">
                             <name>manager email</name>
                             <text>manager@tufin.com</text>
                         </field>
                     </fields>
                 </task>
             </tasks>
        </step>
    </steps>
    <comments/>
</ticket>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY<ticket>
    <subject>New MG ticket</subject>
    <requester>a</requester>
    <requester_id>4</requester_id>
    <priority>Normal</priority>
    <status>In Progress</status>
    <domain_name/>
    <sla_status>NA</sla_status>
    <sla_outcome>NA</sla_outcome>
    <workflow>
        <id>6</id>
        <name>MG</name>
        <uses_topology>false</uses_topology>
    </workflow>
    <steps>
        <step>
            <id>72</id>
            <name>New step</name>
            <redone>false</redone>
            <skipped>false</skipped>
            <tasks>
                <task>
                    <id>72</id>
                    <assignee_id>4</assignee_id>
                    <assignee>a</assignee>
                    <status>ASSIGNED</status>
                    <fields>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_group_change\">
                            <id>262</id>
                            <name>MG</name>
                            <read_only>false</read_only>
                            <implementation_status>NOT_SUPPORTED</implementation_status>
                            <group_change>
                                <name>ExistingGroup</name>
                                <object_UID>{c862fb6f-1314-45da-9e01-56c9b85d001d}</object_UID>
                                <management_id>58</management_id>
                                <management_name>FMG/root</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>157</id>
                                        <name>10.100 net</name>
                                        <object_UID>{37cdc055-7aac-4385-b46b-cc54d95e4b6d}</object_UID>
                                        <object_type>Network</object_type>
                                        <object_details>10.100.0.0/255.255.0.0</object_details>
                                        <management_id>58</management_id>
                                        <management_name>FMG/root</management_name>
                                        <status>NOT_CHANGED</status>
                                        <object_updated_status>EXISTING_EDITED</object_updated_status>
                                        <comment>new_comment</comment>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                                <zone>
                                    <is_global>true</is_global>
                                    <name>any</name>
                                </zone>
                            </group_change>
                            <group_change>
                                <name>78.45.12.0</name>
                                <object_UID>{cac64d34-a05e-4a05-b271-64642eb976ff}</object_UID>
                                <management_id>28</management_id>
                                <management_name>SRX-root-lsys</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>158</id>
                                        <name>78.45.12.1</name>
                                        <object_UID>{7912c335-6dbe-47de-b872-1322f9015b2f}</object_UID>
                                        <object_type>Host</object_type>
                                        <object_details>78.45.12.1/255.255.255.255</object_details>
                                        <management_id>28</management_id>
                                        <management_name>SRX-root-lsys</management_name>
                                        <status>NOT_CHANGED</status>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                                <address_book>
                                    <name>global</name>
                                </address_book>
                            </group_change>
                            <group_change>
                                <name>10.10.0.0/16</name>
                                <object_UID>{5dff0bd8-51e4-4a83-8138-d54dd18ca52b}</object_UID>
                                <management_id>24</management_id>
                                <management_name>NSX-Distributed Firewall</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>161</id>
                                        <name>10.10.0.0/16</name>
                                        <object_UID>{5d7b826c-f053-40fd-81bd-7a6f44cf15ef}</object_UID>
                                        <object_type>Network</object_type>
                                        <object_details>10.10.0.0/255.255.0.0</object_details>
                                        <management_id>24</management_id>
                                        <management_name>NSX-Distributed Firewall</management_name>
                                        <status>NOT_CHANGED</status>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                            </group_change>
                        </field>
                    </fields>
                </task>
            </tasks>
        </step>
    </steps>
</ticket>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY<ticket>
    <subject>test API</subject>
    <requester>a</requester>
    <requester_id>4</requester_id>
    <priority>Normal</priority>
    <domain_name/>
    <sla_status>NA</sla_status>
    <sla_outcome>NA</sla_outcome>
    <workflow>
        <id>8</id>
        <name>Modify group</name>
        <uses_topology>false</uses_topology>
    </workflow>
    <steps>
        <step>
            <id>11</id>
            <name>Open request</name>
            <redone>false</redone>
            <skipped>false</skipped>
            <tasks>
                <task>
                    <id>11</id>
                    <assignee_id>4</assignee_id>
                    <assignee>a</assignee>                    <status>DONE</status>
                    <fields>
                        <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_group_change\">
                            <id>137</id>
                            <name>ff</name>
                            <read_only>false</read_only>
                            <implementation_status>NOT_SUPPORTED</implementation_status>
                            <group_change>
                                <name>port1Group</name>
                                <object_UID>{d5b4459b-6b27-4012-9924-b244c250520f}</object_UID>
                                <management_id>64</management_id>
                                <management_name>10.100.111.8/ADOM_5_2</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"HOST\">
                                        <id>69</id>
                                        <name>obj_1</name>
                                        <object_UID>obj_1</object_UID>
                                        <object_type>Host</object_type>
                                        <object_details>6.6.6.6/255.255.255.255</object_details>
                                        <management_id>64</management_id>
                                        <status>ADDED</status>
                                        <comment/>
                                        <object_updated_status>NEW</object_updated_status>
                                    </member>
                                </members>
                                <change_action>UPDATE</change_action>
                            </group_change>
                            <group_change>
                                <name>gfd</name>
                                <management_id>64</management_id>
                                <management_name>10.100.111.8/ADOM_5_2</management_name>
                                <change_implementation_status>NOT_SUPPORTED</change_implementation_status>
                                <members>
                                    <member type=\"Object\">
                                        <id>70</id>
                                        <name>obj_1</name>
                                        <object_UID>obj_1</object_UID>
                                        <object_type>Host</object_type>
                                        <object_details>6.6.6.6/255.255.255.255</object_details>
                                        <management_id>64</management_id>
                                        <management_name>10.100.111.8/ADOM_5_2</management_name>
                                        <status>ADDED</status>
                                        <object_updated_status>EXISTING_NOT_EDITED</object_updated_status>
                                    </member>
                                </members>
                                <change_action>CREATE</change_action>
                                <zone>
                                    <is_global>true</is_global>
                                    <name>any</name>
                                </zone>
                            </group_change>
                        </field>
                    </fields>
                </task>
            </tasks>
        </step>
    </steps>
    <current_step>
        <id>12</id>
        <name>Copy of Open request</name>
    </current_step>
    <comments/>
</ticket>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY{
    \"ticket\": {
        \"application_details\": { \"id\": \"1\" },
        \"referenced_ticket\": { \"id\": \"3\" },
        \"subject\": \"topology mode_AR1-with topology_AR2-no topology\",
        \"priority\": \"Normal\",
        \"workflow\": { \"name\": \"ar\" }
    }
}


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets
BODY{
    \"ticket\": {
        \"subject\": \"RM_EXAMPLE\",
        \"requester\": \"m\",
        \"requester_id\": 4,
        \"priority\": \"Normal\",
        \"domain_name\": \"\",
        \"workflow\": {
            \"name\": \"RM\",
        },
        \"steps\": {
            \"step\": [
                {
                    \"tasks\": {
                        \"task\": {
                            \"fields\": {
                                \"field\": {
                                    \"@xsi.type\": \"rule_modification_field\",
                                    \"devices\": {
                                        \"device\": {
                                            \"revision_id\": 24,
                                            \"management_id\": 5,
                                            \"bindings\": {
                                                \"binding\": {
                                                    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                                                    \"binding\": {
                                                        \"@xsi.type\": \"policy__binding\",
                                                        \"policy_name\": \"FortiGate-VM64-111-10_3\"
                                                    },
                                                    \"rules\": {
                                                        \"rule\": {
                                                            \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                                            \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    },
                                    \"rule_modifications\": {
                                        \"rule_modification\": {
                                            \"@xsi.type\": \"modify_rule_modification\",
                                            \"rule_key\": {
                                                \"device_id\": 5,
                                                \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                                                \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                                            },
                                            \"source_modifications\": {
                                                \"network_object_cell_modifications\": {
                                                    \"network_object_cell_modification\": [
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"network_object\": [
                                                                    {
                                                                        \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                                        \"name\": \"RANGE_1\",
                                                                        \"comment\": \"EXAMPLE_RANGE\",
                                                                        \"min_ip\": \"3.3.3.3\",
                                                                        \"max_ip\": \"5.5.5.5\"
                                                                    }
                                                                ]
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"network_object\": [
                                                                    {
                                                                        \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                                        \"name\": \"NET_1\",
                                                                        \"comment\": \"\",
                                                                        \"ip\": \"3.3.3.3\",
                                                                        \"netmask\": \"255.255.255.255\"
                                                                    }
                                                                ]
                                                            }
                                                        }
                                                    ]
                                                }
                                            },
                                            \"destination_modifications\": {
                                                \"id\": 11,
                                                \"network_object_cell_modifications\": {
                                                    \"network_object_cell_modification\": [
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"existing\",
                                                                    \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"REMOVE\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"existing\",
                                                                    \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_network_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"network_object\": [
                                                                    {
                                                                        \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                                        \"name\": \"Host123\",
                                                                        \"comment\": \"cccHost\",
                                                                        \"ip\": \"1.2.3.4\",
                                                                        \"netmask\": \"255.255.255.255\"
                                                                    }
                                                                ]
                                                            }
                                                        }
                                                    ]
                                                }
                                            },
                                            \"service_modifications\": {
                                                \"id\": 9,
                                                \"service_object_cell_modifications\": {
                                                    \"service_object_cell_modification\": [
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"service_object\": {
                                                                    \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                                                    \"name\": \"ICMP_1\",
                                                                    \"comment\": \"EXAMPLE_ICMP\",
                                                                    \"type\": {
                                                                        \"from\": 55,
                                                                        \"to\": 55
                                                                    }
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"service_object\": {
                                                                    \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                                    \"name\": \"UDP_1\",
                                                                    \"comment\": \"EXAMPLE_UDP\",
                                                                    \"port\": {
                                                                        \"from\": 3,
                                                                        \"to\": 3
                                                                    },
                                                                    \"protocol\": \"UDP\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"new\"
                                                                },
                                                                \"service_object\": {
                                                                    \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                                    \"name\": \"TCP_1\",
                                                                    \"comment\": \"EXAMPLE_TCP\",
                                                                    \"port\": {
                                                                        \"from\": 1234,
                                                                        \"to\": 1234
                                                                    },
                                                                    \"protocol\": \"TCP\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"ADD\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"existing\",
                                                                    \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                                                }
                                                            }
                                                        },
                                                        {
                                                            \"action\": \"REMOVE\",
                                                            \"device_service_object\": {
                                                                \"device_id\": 5,
                                                                \"status\": {
                                                                    \"@xsi.type\": \"existing\",
                                                                    \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                                                }
                                                            }
                                                        }
                                                    ]
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            ]
        },
    }
}


Response Messages:
400: Application ID is missing.
400: Create closed ticket is enabled only from SecureApp application.
400: The application was already deleted.
400: The requester must be the currently logged in user.
400: Workflow was not found.
400: Workflow is not active.
400: Workflow configuration is not valid.
400: Workflow is not set
400: You cannot enter a status for a new ticket.
400: Requester cannot open a ticket in domain.
400: Invalid ticket priority.
400: You cannot open a new ticket with an empty subject.
400: Expiration field is required.
400: Submit ticket enabled only with the first step
400: First step can be only with one task
400: The specified workflow does not contain an access request field in the first step.
400: There are no changed connections that are ready for creating a ticket.
400: You cannot use an access request field to create a ticket from SecureApp.
400: The ticket fields do not match the fields in the current step of the workflow.
400: You cannot change the value of a field because it is read-only.
400: Managed tasks are not initialized or done
400: Application Change field cannot be managed via this REST API
400: Invalid value for field: <FIELD_NAME> (Rule Modification workflow is not supported for this device)
403: You do not have permissions to edit this application.
403: Logged in user: NAME do not have permission to perform on behalf actions
403: You are not a participant in the first step of this workflow
403: UNAUTHORIZED
404: There is no application with the specified ID
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (Network object cell modification missing action)
400: Invalid value for field: <FIELD_NAME> (Network object cell modification element cannot be empty)
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: Invalid value for field: <FIELD_NAME> (a valid object comment can have up to <MAX> characters)
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: There are multiple objects with this name in the network)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value
400: Workflow does not support referenced ticket
400: The referenced ticket cannot be the ticket itself
406: Invalid format detected: <subject|name|binding_uid|rule_uid> - This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags
406: Invalid format detected: <subject|name> - <VALUE> is invalid. Text must include <1-255> characters
406: Invalid format detected: <rule_uid|binding_uid> - <VALUE> is invalid. Text must include <1-4096> characters
406: Invalid format detected: comment - <VALUE> is invalid. Text must include <0-4096> characters
406: Invalid format detected: <subject|name> - <VALUE> is invalid. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters + - , _ # @ . : = ! ^ ( )
406: Invalid format detected: <rule_uid|binding_uid|comment> - <VALUE> is invalid. Text includes invalid expressions such as HTML tags or command line operations
406: Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP"},"response":[]},{"name":"Returns the details of a specified tickets (max 100 tickets in a single query)","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
status: The status of the tickets [optional]
count: Tickets list max pagination length (max value is 100) [optional]
start: Offset the count starting point [optional]
desc: Get the list in descending order [optional]
expand_links: See expanded view of the objects [optional]
showStepsDetails: Include steps' details in the response [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets?status=In Progress&count=10&start=3&expand_links=false

Response Messages:
400: Status is not a valid. The valid values are: TICKET_STATUSES
400: Can not fetch more than 100 tickets in 1 time
403: Access is denied"},"response":[]},{"name":"Returns the details of a specified task","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
taskId: The ID number of the task as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2?expand_links=true

Response Messages:
403: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.
404: Task with ID was not found in Stage ID in ticket ID ."},"response":[]},{"name":"Change a task of a ticket","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\t\"task\": {\n\t\t\"status\": \"ASSIGNED\",\n\t\t\"fields\": {\n\t\t\t\"field\": {\n\t\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\t\"id\": 743,\n\t\t\t\t\"devices\": {\n\t\t\t\t\t\"device\": {\n\t\t\t\t\t\t\"revision_id\": 24,\n\t\t\t\t\t\t\"management_id\": 5,\n\t\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"rule_modifications\": {\n\t\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ���add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: ticketTaskDTO
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/2/tasks/4
BODY<task>
     <status>ASSIGNED</status>
     <fields>
         <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_group_change\">
             <id>7599</id>
             <name>mf</name>
             <read_only>false</read_only>
             <implementation_status>NOT_STARTED</implementation_status>
             <group_change>
                        <name>ggg</name>
                        <st_uid>{A12AE330-0DBD-11E5-B841-7F0000010E0E}</st_uid>
                        <management_id>42</management_id>
                        <management_name>cp239</management_name>
                        <members>
                             <member type=\"Object\">
                                 <id>8</id>
                                 <name>yaakovs_host</name>
                                 <st_uid>{BDAA378C-C90B-4D12-B598-1AFED2D1DA14}</st_uid>
                                 <object_type>Host</object_type>
                                 <object_details>1.1.1.1/255.255.255.255</object_details>
                         <management_id>42</management_id>
                         <management_name>cp239</management_name>
                                 <status>NOT_CHANGED</status>
                             </member>
                             <member type=\"Object\">
                                 <id>9</id>
                                    <name>Avi_10.100.120.254</name>
                                    <st_uid>{8F195CDC-F426-47B6-9E8A-1FF14C17E54F}</st_uid>
                                     <object_type>Host</object_type>
                                     <object_details>10.100.120.254/255.255.255.255</object_details>
                                     <management_id>42</management_id>
                                     <management_name>cp239</management_name>
                                     <status>NOT_CHANGED</status>
                                 </member>
                                 <member type=\"HOST\">
                                     <id>10</id>
                                     <name>h22</name>
                                     <object_type>Host</object_type>
                                     <object_details>2.2.2.2/255.255.255.255</object_details>
                                     <status>ADDED</status>
                                     <comment/>
                                 </member>
                                 <member type=\"HOST\">
                                     <id>10</id>
                                     <name>h22</name>
                                     <object_type>Host</object_type>
                                     <object_details>3.3.3.3/255.255.255.255</object_details>
                                     <status>ADDED</status>
                                     <comment/>
                                 </member>
                 </members>
                 <change_implementation_status>NOT_RUN</change_implementation_status>
                    </group_change>
            </field>
     </fields>
</task>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4
BODY{
    \"task\": {
        \"status\": \"ASSIGNED\",
        \"fields\": {
            \"field\": {
                \"@xsi.type\": \"rule_modification_field\",
                \"id\": 743,
                \"devices\": {
                    \"device\": {
                        \"revision_id\": 24,
                        \"management_id\": 5,
                        \"bindings\": {
                            \"binding\": {
                                \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                                \"binding\": {
                                    \"@xsi.type\": \"policy__binding\",
                                    \"policy_name\": \"FortiGate-VM64-111-10_3\"
                                },
                                \"rules\": {
                                    \"rule\": {
                                        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                        \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                                    }
                                }
                            }
                        }
                    }
                },
                \"rule_modifications\": {
                    \"rule_modification\": {
                        \"@xsi.type\": \"modify_rule_modification\",
                        \"rule_key\": {
                            \"device_id\": 5,
                            \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                            \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                        },
                        \"source_modifications\": {
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                    \"name\": \"RANGE_1\",
                                                    \"comment\": \"EXAMPLE_RANGE\",
                                                    \"min_ip\": \"3.3.3.3\",
                                                    \"max_ip\": \"5.5.5.5\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                    \"name\": \"NET_1\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"3.3.3.3\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        },
                        \"destination_modifications\": {
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                    \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"name\": \"Host123\",
                                                    \"comment\": \"cccHost\",
                                                    \"ip\": \"1.2.3.4\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"REMOVE\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                            }
                                        }
                                    }
                                ]
                            }
                        },
                        \"service_modifications\": {
                            \"service_object_cell_modifications\": {
                                \"service_object_cell_modification\": [
                                    {
                                        \"action\": \"REMOVE\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                                \"name\": \"ICMP_1\",
                                                \"comment\": \"EXAMPLE_ICMP\",
                                                \"type\": {
                                                    \"from\": 55,
                                                    \"to\": 55
                                                }
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                \"name\": \"TCP_1\",
                                                \"comment\": \"EXAMPLE_TCP\",
                                                \"port\": {
                                                    \"from\": 1234,
                                                    \"to\": 1234
                                                },
                                                \"protocol\": \"TCP\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                \"name\": \"UDP_1\",
                                                \"comment\": \"EXAMPLE_UDP\",
                                                \"port\": {
                                                    \"from\": 3,
                                                    \"to\": 3
                                                },
                                                \"protocol\": \"UDP\"
                                            }
                                        }
                                    }
                                ]
                            }
                        }
                    }
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket step does not exist, or is not the current step
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Task status does not exist.
400: Task status is not set to ASSIGNED or DONE.
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: There are multiple objects with this name in the network)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
403: You do not have permission to update this task. Contact your administrator for assistance.
403: Task can not be done because there are unlicensed devices for change automation
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: Invalid value for field: <FIELD_NAME> (a valid object comment can have up to <MAX> characters)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value
406: Invalid format detected: <name|binding_uid|rule_uid> - This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags
406: Invalid format detected: name - <VALUE> is invalid. Text must include <1-255> characters
406: Invalid format detected: <rule_uid|binding_uid> - <VALUE> is invalid. Text must include <1-4096> characters
406: Invalid format detected: comment - <VALUE> is invalid. Text must include <0-4096> characters
406: Invalid format detected: name - <VALUE> is invalid. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters + - , _ # @ . : = ! ^ ( )
406: Invalid format detected: <rule_uid|binding_uid|comment> - <VALUE> is invalid. Text includes invalid expressions such as HTML tags or command line operations
406: Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP"},"response":[]},{"name":"Change a field within a task of a ticket at the current step","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\t\"rule_modification_field\": {\n\t\t\"devices\": {\n\t\t\t\"device\": {\n\t\t\t\t\"management_id\": 5,\n\t\t\t\t\"bindings\": {\n\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t\"rule_modifications\": {\n\t\t\t\"rule_modification\": {\n\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t},\n\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"uid\": \"551556da-22dc-46f4-9253-a7ceee70394b\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}/fields/{{fieldId}}","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ���add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldDTO
id: Ticket ID
taskId: Task ID
fieldId: Field ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields/7642
BODY<field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"approve_reject\">
         <id>7661</id>
         <name>approve access</name>
         <approved>true</approved>
         <reason>Request approved</reason>
    </field>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4/fields/71
BODY{
    \"rule_modification_field\": {
        \"devices\": {
            \"device\": {
                \"management_id\": 5,
                \"bindings\": {
                    \"binding\": {
                        \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                        \"binding\": {
                            \"@xsi.type\": \"policy__binding\",
                            \"policy_name\": \"FortiGate-VM64-111-10_3\"
                        },
                        \"rules\": {
                            \"rule\": {
                                \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                            }
                        }
                    }
                }
            }
        },
        \"rule_modifications\": {
            \"rule_modification\": {
                \"@xsi.type\": \"modify_rule_modification\",
                \"rule_key\": {
                    \"device_id\": 5,
                    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                    \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                },
                \"source_modifications\": {
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                            \"name\": \"NET_1\",
                                            \"comment\": \"\",
                                            \"ip\": \"3.3.3.3\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                            \"name\": \"RANGE_1\",
                                            \"comment\": \"EXAMPLE_RANGE\",
                                            \"min_ip\": \"3.3.3.3\",
                                            \"max_ip\": \"5.5.5.5\"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                \"destination_modifications\": {
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"name\": \"Host123\",
                                            \"comment\": \"cccHost\",
                                            \"ip\": \"1.2.3.4\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"action\": \"REMOVE\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                    }
                                }
                            }
                        ]
                    }
                },
                \"service_modifications\": {
                    \"service_object_cell_modifications\": {
                        \"service_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                        \"name\": \"TCP_1\",
                                        \"comment\": \"EXAMPLE_TCP\",
                                        \"port\": {
                                            \"from\": 1234,
                                            \"to\": 1234
                                        },
                                        \"protocol\": \"TCP\"
                                    }
                                }
                            },
                            {
                                \"action\": \"REMOVE\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"uid\": \"551556da-22dc-46f4-9253-a7ceee70394b\",
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                        \"name\": \"UDP_1\",
                                        \"comment\": \"EXAMPLE_UDP\",
                                        \"port\": {
                                            \"from\": 3,
                                            \"to\": 3
                                        },
                                        \"protocol\": \"UDP\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                        \"name\": \"ICMP_1\",
                                        \"comment\": \"EXAMPLE_ICMP\",
                                        \"type\": {
                                            \"from\": 55,
                                            \"to\": 55
                                        }
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                    }
                                }
                            }
                        ]
                    }
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: There are multiple objects with this name in the network)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
403: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: Invalid value for field: <FIELD_NAME> (a valid object comment can have up to <MAX> characters)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value
406: Invalid format detected: <name|binding_uid|rule_uid> - This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags
406: Invalid format detected: name - <VALUE> is invalid. Text must include <1-255> characters
406: Invalid format detected: <rule_uid|binding_uid> - <VALUE> is invalid. Text must include <1-4096> characters
406: Invalid format detected: comment - <VALUE> is invalid. Text must include <0-4096> characters
406: Invalid format detected: name - <VALUE> is invalid. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters + - , _ # @ . : = ! ^ ( )
406: Invalid format detected: <rule_uid|binding_uid|comment> - <VALUE> is invalid. Text includes invalid expressions such as HTML tags or command line operations
406: Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP"},"response":[]},{"name":"Change a task of a ticket at the current step","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\t\"task\": {\n\t\t\"status\": \"ASSIGNED\",\n\t\t\"fields\": {\n\t\t\t\"field\": {\n\t\t\t\t\"@xsi.type\": \"rule_modification_field\",\n\t\t\t\t\"id\": 743,\n\t\t\t\t\"devices\": {\n\t\t\t\t\t\"device\": {\n\t\t\t\t\t\t\"revision_id\": 24,\n\t\t\t\t\t\t\"management_id\": 5,\n\t\t\t\t\t\t\"bindings\": {\n\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"rule_modifications\": {\n\t\t\t\t\t\"rule_modification\": {\n\t\t\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/current/tasks/{{taskId}}","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ���add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: ticketTaskDTO
id: Ticket ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4
BODY<task>
    <status>DONE</status>
    <fields/>
</task>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/current/tasks/4
BODY{
    \"task\": {
        \"status\": \"ASSIGNED\",
        \"fields\": {
            \"field\": {
                \"@xsi.type\": \"rule_modification_field\",
                \"id\": 743,
                \"devices\": {
                    \"device\": {
                        \"revision_id\": 24,
                        \"management_id\": 5,
                        \"bindings\": {
                            \"binding\": {
                                \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                                \"binding\": {
                                    \"@xsi.type\": \"policy__binding\",
                                    \"policy_name\": \"FortiGate-VM64-111-10_3\"
                                },
                                \"rules\": {
                                    \"rule\": {
                                        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                        \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                                    }
                                }
                            }
                        }
                    }
                },
                \"rule_modifications\": {
                    \"rule_modification\": {
                        \"@xsi.type\": \"modify_rule_modification\",
                        \"rule_key\": {
                            \"device_id\": 5,
                            \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                            \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                        },
                        \"source_modifications\": {
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                                    \"name\": \"RANGE_1\",
                                                    \"comment\": \"EXAMPLE_RANGE\",
                                                    \"min_ip\": \"3.3.3.3\",
                                                    \"max_ip\": \"5.5.5.5\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                                    \"name\": \"NET_1\",
                                                    \"comment\": \"\",
                                                    \"ip\": \"3.3.3.3\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    }
                                ]
                            }
                        },
                        \"destination_modifications\": {
                            \"network_object_cell_modifications\": {
                                \"network_object_cell_modification\": [
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                    \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"network_object\": [
                                                {
                                                    \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                                    \"name\": \"Host123\",
                                                    \"comment\": \"cccHost\",
                                                    \"ip\": \"1.2.3.4\",
                                                    \"netmask\": \"255.255.255.255\"
                                                }
                                            ]
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"REMOVE\",
                                        \"device_network_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                            }
                                        }
                                    }
                                ]
                            }
                        },
                        \"service_modifications\": {
                            \"service_object_cell_modifications\": {
                                \"service_object_cell_modification\": [
                                    {
                                        \"action\": \"REMOVE\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                                \"name\": \"ICMP_1\",
                                                \"comment\": \"EXAMPLE_ICMP\",
                                                \"type\": {
                                                    \"from\": 55,
                                                    \"to\": 55
                                                }
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"existing\",
                                                \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                \"name\": \"TCP_1\",
                                                \"comment\": \"EXAMPLE_TCP\",
                                                \"port\": {
                                                    \"from\": 1234,
                                                    \"to\": 1234
                                                },
                                                \"protocol\": \"TCP\"
                                            }
                                        }
                                    },
                                    {
                                        \"action\": \"ADD\",
                                        \"device_service_object\": {
                                            \"device_id\": 5,
                                            \"status\": {
                                                \"@xsi.type\": \"new\"
                                            },
                                            \"service_object\": {
                                                \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                                \"name\": \"UDP_1\",
                                                \"comment\": \"EXAMPLE_UDP\",
                                                \"port\": {
                                                    \"from\": 3,
                                                    \"to\": 3
                                                },
                                                \"protocol\": \"UDP\"
                                            }
                                        }
                                    }
                                ]
                            }
                        }
                    }
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Task status does not exist.
400: Task status is not set to ASSIGNED or DONE.
400: The API is not available for ticket with a status of pending, or if the pre-assignment script is currently executing
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: There are multiple objects with this name in the network)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
403: You do not have permission to update this task. Contact your administrator for assistance.
403: Task can not be done because there are unlicensed devices for change automation
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: Invalid value for field: <FIELD_NAME> (a valid object comment can have up to <MAX> characters)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value
406: Invalid format detected: <name|binding_uid|rule_uid> - This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags
406: Invalid format detected: name - <VALUE> is invalid. Text must include <1-255> characters
406: Invalid format detected: <rule_uid|binding_uid> - <VALUE> is invalid. Text must include <1-4096> characters
406: Invalid format detected: comment - <VALUE> is invalid. Text must include <0-4096> characters
406: Invalid format detected: name - <VALUE> is invalid. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters + - , _ # @ . : = ! ^ ( )
406: Invalid format detected: <rule_uid|binding_uid|comment> - <VALUE> is invalid. Text includes invalid expressions such as HTML tags or command line operations
406: Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP"},"response":[]},{"name":"Get commands for device from designer results of a specific field id","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"deviceId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/designer/device/{{deviceId}}/commands","description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
deviceId: Device ID
fieldId: Field ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/designer/device/136/commands

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: Specified field, id: <ID> , name: <NAME>, cannot contain designer result
404: Designer results were not found in the access request.
404: Device with ID <ID> was not found in Designer result.
404: Device with ID <ID> does not support Commands feature."},"response":[]},{"name":"Returns the details of the tasks","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks

Response Messages:
403: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID."},"response":[]},{"name":"Change multiple fields within a task of a ticket","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\"fields\": {\n\"field\": {\n\"@xsi.type\": \"rule_modification_field\",\n\"id\": 746,\n\"name\": \"rm\",\n\"devices\": {\n\t\"device\": {\n\t\"revision_id\": 24,\n\t\"management_id\": 5,\n\t\"bindings\": {\n\t\"binding\": {\n\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\"binding\": {\n\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t},\n\t\"rules\": {\n\t\t\"rule\": {\n\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t}\n\t}\n\t}\n\t}\n\t}\n},\n\"rule_modifications\": {\n\t\"rule_modification\": {\n\t\"@xsi.type\": \"modify_rule_modification\",\n\t\"rule_key\": {\n\t\"device_id\": 5,\n\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t},\n\t\"source_modifications\": {\n\t\"network_object_cell_modifications\": {\n\t\"network_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\"name\": \"NET_1\",\n\t\t\t\"comment\": \"\",\n\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t}\n\t\t]\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t}\n\t\t]\n\t\t}\n\t\t}\n\t]\n\t}\n\t},\n\t\"destination_modifications\": {\n\t\"network_object_cell_modifications\": {\n\t\"network_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"REMOVE\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_network_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"network_object\": [\n\t\t{\n\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\"name\": \"Host123\",\n\t\t\t\"comment\": \"cccHost\",\n\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t}\n\t\t]\n\t\t}\n\t\t}\n\t]\n\t}\n\t},\n\t\"service_modifications\": {\n\t\"service_object_cell_modifications\": {\n\t\"service_object_cell_modification\": [\n\t\t{\n\t\t\"action\": \"REMOVE\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"existing\",\n\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\"name\": \"ICMP_1\",\n\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\"type\": {\n\t\t\t\"from\": 55,\n\t\t\t\"to\": 55\n\t\t}\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\"name\": \"TCP_1\",\n\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\"port\": {\n\t\t\t\"from\": 1234,\n\t\t\t\"to\": 1234\n\t\t},\n\t\t\"protocol\": \"TCP\"\n\t\t}\n\t\t}\n\t\t},\n\t\t{\n\t\t\"action\": \"ADD\",\n\t\t\"device_service_object\": {\n\t\t\"device_id\": 5,\n\t\t\"status\": {\n\t\t\"@xsi.type\": \"new\"\n\t\t},\n\t\t\"service_object\": {\n\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\"name\": \"UDP_1\",\n\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\"port\": {\n\t\t\t\"from\": 3,\n\t\t\t\"to\": 3\n\t\t},\n\t\t\"protocol\": \"UDP\"\n\t\t}\n\t\t}\n\t\t}\n\t]\n\t}\n\t}\n\t}\n}\n}\n}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ���add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldListDTO
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/2/tasks/4/fields
BODY<fields>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_network_object\">
         <id>7885</id>
         <name>n_obj</name>
         <network_object type=\"Object\">
             <object_name>Host_10.1.1.1</object_name>
             <management_name>cp239</management_name>
         </network_object>
         <network_object type=\"Object\">
             <st_uid>{55908141-c341-4990-9cc6-a3fd2dfb49e1}</st_uid>
             <management_id>2</management_id>
         </network_object>
         <network_object type=\"DNS\">
             <host_name>tufin.com</host_name>
         </network_object>
     <field>
     <field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multi_service\">
         <id>7887</id>
         <name>service</name>
         <service type=\"PROTOCOL\">
             <protocol>TCP</protocol>
             <port>80</port>
         </service>
         <service type=\"Object\">
             <object_name>AOL</object_name>
             <management_name>cp239</management_name>
         </service>
     </field>
</fields>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/fields
BODY{
\"fields\": {
\"field\": {
\"@xsi.type\": \"rule_modification_field\",
\"id\": 746,
\"name\": \"rm\",
\"devices\": {
    \"device\": {
    \"revision_id\": 24,
    \"management_id\": 5,
    \"bindings\": {
    \"binding\": {
    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
    \"binding\": {
        \"@xsi.type\": \"policy__binding\",
        \"policy_name\": \"FortiGate-VM64-111-10_3\"
    },
    \"rules\": {
        \"rule\": {
        \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
        \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
        }
    }
    }
    }
    }
},
\"rule_modifications\": {
    \"rule_modification\": {
    \"@xsi.type\": \"modify_rule_modification\",
    \"rule_key\": {
    \"device_id\": 5,
    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
    \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
    },
    \"source_modifications\": {
    \"network_object_cell_modifications\": {
    \"network_object_cell_modification\": [
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
            \"name\": \"NET_1\",
            \"comment\": \"\",
            \"ip\": \"3.3.3.3\",
            \"netmask\": \"255.255.255.255\"
        }
        ]
        }
        },
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
            \"name\": \"RANGE_1\",
            \"comment\": \"EXAMPLE_RANGE\",
            \"min_ip\": \"3.3.3.3\",
            \"max_ip\": \"5.5.5.5\"
        }
        ]
        }
        }
    ]
    }
    },
    \"destination_modifications\": {
    \"network_object_cell_modifications\": {
    \"network_object_cell_modification\": [
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
        }
        }
        },
        {
        \"action\": \"REMOVE\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_network_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"network_object\": [
        {
            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
            \"name\": \"Host123\",
            \"comment\": \"cccHost\",
            \"ip\": \"1.2.3.4\",
            \"netmask\": \"255.255.255.255\"
        }
        ]
        }
        }
    ]
    }
    },
    \"service_modifications\": {
    \"service_object_cell_modifications\": {
    \"service_object_cell_modification\": [
        {
        \"action\": \"REMOVE\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"existing\",
        \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:icmp_service\",
        \"name\": \"ICMP_1\",
        \"comment\": \"EXAMPLE_ICMP\",
        \"type\": {
            \"from\": 55,
            \"to\": 55
        }
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:transport_service\",
        \"name\": \"TCP_1\",
        \"comment\": \"EXAMPLE_TCP\",
        \"port\": {
            \"from\": 1234,
            \"to\": 1234
        },
        \"protocol\": \"TCP\"
        }
        }
        },
        {
        \"action\": \"ADD\",
        \"device_service_object\": {
        \"device_id\": 5,
        \"status\": {
        \"@xsi.type\": \"new\"
        },
        \"service_object\": {
        \"@xsi.type\": \"ns_sc_policy:transport_service\",
        \"name\": \"UDP_1\",
        \"comment\": \"EXAMPLE_UDP\",
        \"port\": {
            \"from\": 3,
            \"to\": 3
        },
        \"protocol\": \"UDP\"
        }
        }
        }
    ]
    }
    }
    }
}
}
}
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket step does not exist, or is not the current step
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: There are multiple objects with this name in the network)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
403: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (Network Object with device ID <DEVICE_ID> and ST UID <ST_UID> is not available for the action specified. Check the Knowledge Center or API Implementation Notes for more information
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: Invalid value for field: <FIELD_NAME> (a valid object comment can have up to <MAX> characters)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value
406: Invalid format detected: <name|binding_uid|rule_uid> - This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags
406: Invalid format detected: name - <VALUE> is invalid. Text must include <1-255> characters
406: Invalid format detected: <rule_uid|binding_uid> - <VALUE> is invalid. Text must include <1-4096> characters
406: Invalid format detected: comment - <VALUE> is invalid. Text must include <0-4096> characters
406: Invalid format detected: name - <VALUE> is invalid. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters + - , _ # @ . : = ! ^ ( )
406: Invalid format detected: <rule_uid|binding_uid|comment> - <VALUE> is invalid. Text includes invalid expressions such as HTML tags or command line operations
406: Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP"},"response":[]},{"name":"Returns the details of a the fields","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
taskId: The ID number of the task as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields

Response Messages:
403: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.
404: Task with ID was not found in Stage ID in ticket ID ."},"response":[]},{"name":"Returns a list of tickets by search parameters","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/free_text_search","description":"Parameters:
parameter: Free text search parameter (Search syntax details) [optional]
start: Offset the count starting point [optional]
count: Tickets list max length (max value is 1000) [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/free_text_search/?parameter=taskstatus:ASSIGNED AND priority:High

Response Messages:
400: Can not fetch more than 1000 tickets in 1 time
403: Access is denied.
404: Illegal ticket status entered. Permitted values are: IN_PROGRESS, REJECTED, CLOSED, CANCELLED, RESOLVED
404: Illegal ticket SLA status entered. Permitted values are: NA, OK, WARNING, ALERT, ESCALATION
404: Illegal ticket priority entered. Permitted values are: LOW, NORMAL, HIGH, CRITICAL
400: Illegal count value entered. Max value is 1000
404: Illegal ticket expiration date entered. Permitted date format is: ddMMyyyy (ex. 20.11.2001)
404: No entity found for query"},"response":[]},{"name":"Get access request verifier results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/multi_access_request/{{fieldId}}/verifier","description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Request ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/multi_access_request/2022/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.
404: Verifier results were not found in the access request."},"response":[]},{"name":"Get rule decommision verifier results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/rule_decommission/verifier","description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/rule_decommission/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type <TYPE>.
404: Verifier results were not found in the request."},"response":[]},{"name":"Get server clone policy verifier results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/clone_server_policy/verifier","description":"Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/clone_server_policy/verifier

Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: The given TYPE does not contain a field with ID <ID>.
404: Verifier results were not found in the server clone policy request."},"response":[]},{"name":"Change the ticket properties","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t\t\n\t\n\t\n\t\t\n\t\n\t\n"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/ticket_properties","description":"Change the ticket properties listed in the TicketPropertiesDTO.
When specifying the notification_group property you must use the ID of the group or leave the ID empty to remove the group. This property can be updated on a closed ticket.
When specifying the referenced_ticket property you must use the ID of the ticket or leave the ID empty to remove the ticket.
When specifying the expiration_date property, you must use a yyyy-mm-dd format, or leave the value empty to remove the expiration date. To ignore the field, do not include it in the request. This property can be updated on a closed ticket.

Parameters:
body: ticketPropertiesDTO
id: The ID number of the ticket as shown in SecureChange

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/ticket_properties
BODY<ticket_properties>
    <referenced_ticket>
        <id>9</id>
    </referenced_ticket>
    <notification_group>
        <id>10</id>
    </notification_group>
    <expiration_date>2022-12-10</expiration_date>
</ticket_properties>


Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/ticket_properties
BODY<ticket_properties>
    <notification_group>
        <id/>
    </notification_group>
    <referenced_ticket>
        <id/>
    </referenced_ticket>
    <expiration_date/>
</ticket_properties>


Response Messages:
400: Notification Group <ID> is a user and not a user group
400: Notification Group <ID> exceeds the configured maximum allowed number of users for notifications
400: <ID> (���Any User���) is not allowed as a Notification Group
400: Notification Group <ID> does not have permission of 'Group members can perform actions on requests submitted by other members'
400: Notification Group <ID> is not a member in the first step of the workflow
400: Notification Group is not enabled in this workflow
403: You do not have permission to change the Notification Group
404: There is no group with ID <ID>.
404: There is no ticket with ID <ID>.
400: Referenced ticket id cannot be the same as ticket id
400: invalid id format for referenced ticket
400: Cannot update properties [<Property A>, <Property B>] for ticket with status <STATUS>
403: You do not have permission to update this ticket at this stage. Contact your administrator for assistance.
403: The user is not allowed to add the specified referenced ticket.
400: Workflow does not support referenced ticket
400: Cannot delete expiration date on this workflow due to it being a mandatory field
400: Invalid date. Cannot update expiration to a date that has passed
400: Invalid value for field: expiration_date (The date format must be: yyyy-mm-dd)
400: Invalid value for field: expiration_date (The date is not valid)
400: This workflow does not support expiration dates"},"response":[]},{"name":"Change a field within a task of a ticket","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"{\n\t\"rule_modification_field\": {\n\t\t\"devices\": {\n\t\t\t\"device\": {\n\t\t\t\t\"management_id\": 5,\n\t\t\t\t\"bindings\": {\n\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\t\"binding\": {\n\t\t\t\t\t\t\t\"@xsi.type\": \"policy__binding\",\n\t\t\t\t\t\t\t\"policy_name\": \"FortiGate-VM64-111-10_3\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"rules\": {\n\t\t\t\t\t\t\t\"rule\": {\n\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",\n\t\t\t\t\t\t\t\t\"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t},\n\t\t\"rule_modifications\": {\n\t\t\t\"rule_modification\": {\n\t\t\t\t\"@xsi.type\": \"modify_rule_modification\",\n\t\t\t\t\"rule_key\": {\n\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",\n\t\t\t\t\t\"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"\n\t\t\t\t},\n\t\t\t\t\"source_modifications\": {\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:subnet_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"NET_1\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:range_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"RANGE_1\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_RANGE\",\n\t\t\t\t\t\t\t\t\t\t\t\"min_ip\": \"3.3.3.3\",\n\t\t\t\t\t\t\t\t\t\t\t\"max_ip\": \"5.5.5.5\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"destination_modifications\": {\n\t\t\t\t\t\"network_object_cell_modifications\": {\n\t\t\t\t\t\t\"network_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"network_object\": [\n\t\t\t\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:host_network_object\",\n\t\t\t\t\t\t\t\t\t\t\t\"name\": \"Host123\",\n\t\t\t\t\t\t\t\t\t\t\t\"comment\": \"cccHost\",\n\t\t\t\t\t\t\t\t\t\t\t\"ip\": \"1.2.3.4\",\n\t\t\t\t\t\t\t\t\t\t\t\"netmask\": \"255.255.255.255\"\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t]\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_network_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t\"service_modifications\": {\n\t\t\t\t\t\"service_object_cell_modifications\": {\n\t\t\t\t\t\t\"service_object_cell_modification\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"TCP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_TCP\",\n\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 1234,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 1234\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"protocol\": \"TCP\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"REMOVE\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"uid\": \"551556da-22dc-46f4-9253-a7ceee70394b\",\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:transport_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"UDP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_UDP\",\n\t\t\t\t\t\t\t\t\t\t\"port\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 3,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 3\n\t\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\t\"protocol\": \"UDP\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"new\"\n\t\t\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t\t\t\"service_object\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"ns_sc_policy:icmp_service\",\n\t\t\t\t\t\t\t\t\t\t\"name\": \"ICMP_1\",\n\t\t\t\t\t\t\t\t\t\t\"comment\": \"EXAMPLE_ICMP\",\n\t\t\t\t\t\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\t\t\t\t\t\"from\": 55,\n\t\t\t\t\t\t\t\t\t\t\t\"to\": 55\n\t\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"action\": \"ADD\",\n\t\t\t\t\t\t\t\t\"device_service_object\": {\n\t\t\t\t\t\t\t\t\t\"device_id\": 5,\n\t\t\t\t\t\t\t\t\t\"status\": {\n\t\t\t\t\t\t\t\t\t\t\"@xsi.type\": \"existing\",\n\t\t\t\t\t\t\t\t\t\t\"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"\n\t\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}"},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}","description":"
To use a service object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id
2. Both object_name and management_name

To use a network object in an existing request you must use two parameters to specify the object. The parameter options are:
1. Both st_uid and management_id (for Access Request and Group Change workflow)
2. Both object_name and management_name (only for Access Request workflow)
3. Both object_name and management_id (only for Group Change workflow)
**Note: If both st_uid and object_name are defined, st_uid takes precedence over object_name

For the Modify Group workflow, verifies that the fields listed in the API call have valid values.
Other fields that are included in the step are not affected by the validation and retain their existing values.
Updates applied to values in global fields are carried forward from this step and do not affect values in previous steps.

The Rule Modification workflow supports adding an existing device network object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Network object types:
    SecureTrack API element <class_name> includes one of the following types:
    gateway_ckp, host_ckp, connectra, interspect, gateway_cluster, cluster_member, sofaware_gateway, sofaware_gateway_profile, vsx_box, vs_cluster_member, vs_cluster_netobj, vsx_cluster_member, vsx_cluster_netobj, vs_netobj, mygw_EVR, vsx_netobj, embedded_device, host_plain, interface, network, network_object_group, group_with_exception, gsn_handover_group, address_range
* Device network object types:
    SecureTrack API element <type_on_device> cannot include the following types:
    netlink, Vnic, VirtualMachine, VirtualApp, ResourcePool, Datacenter, DistributedVirtualPortgroup, ClusterComputeResource, VirtualWire, LogicalSwitch, Segment, LogicalPort, VirtualNetwork, ALL_EDGES, APPLIED_TO_ANY, DISTRIBUTED_FIREWALL, Edge, HostSystem, edl_ip_list, edl_generic
* Network object IP types:
    SecureTrack API element <ip_type> includes one of the following types:
    IPv4, Other, IPv4_IPv6
* The device network object is available in the latest revision

The Rule Modification workflow supports adding an existing device service object to the rule when the object meets the following conditions:
* Explicit object:
    SecureTrack API element <implicit> is false
* Service object types:
    SecureTrack API element <class_name> includes one of the following types:
    icmp_service, service_group, sctp_service, other_service, tcp_service, udp_service
* Device service object types:
    SecureTrack API element <type_on_device> cannot include rpc_service_group device object type
* The device service object is available in the latest revision

The Rule Modification workflow supports adding the same new object to more than one rule by defining an ���add new object' action for each of the relevant rules, with the same object properties. SecureChange will identify that the same object properties are specified for all the rules and so will create it only once, before adding it to all relevant rules. This will only work if the object has the same name and identical properties for all the rules, otherwise the action will fail due to a name uniqueness violation and no rules will be updated.

Parameters:
body: fieldDTO
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/2/tasks/4/fields/7742
BODY<field xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"multiple_selection\">
     <id>7742</id>
     <name>filter type</name>
     <selected_options>
         <selected_option>
             <value>FTP</value>
         </selected_option>
     </selected_options>
</field>



Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/2/steps/4/tasks/4/fields/71
BODY{
    \"rule_modification_field\": {
        \"devices\": {
            \"device\": {
                \"management_id\": 5,
                \"bindings\": {
                    \"binding\": {
                        \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                        \"binding\": {
                            \"@xsi.type\": \"policy__binding\",
                            \"policy_name\": \"FortiGate-VM64-111-10_3\"
                        },
                        \"rules\": {
                            \"rule\": {
                                \"@xsi.type\": \"ns3:slimRuleWithMetadataDTO\",
                                \"uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                            }
                        }
                    }
                }
            }
        },
        \"rule_modifications\": {
            \"rule_modification\": {
                \"@xsi.type\": \"modify_rule_modification\",
                \"rule_key\": {
                    \"device_id\": 5,
                    \"binding_uid\": \"{103f17d1-ef87-422d-a145-c6a195752808}\",
                    \"rule_uid\": \"{d2ba3026-cab9-43f8-9812-fa7ea45db974}\"
                },
                \"source_modifications\": {
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:subnet_network_object\",
                                            \"name\": \"NET_1\",
                                            \"comment\": \"\",
                                            \"ip\": \"3.3.3.3\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:range_network_object\",
                                            \"name\": \"RANGE_1\",
                                            \"comment\": \"EXAMPLE_RANGE\",
                                            \"min_ip\": \"3.3.3.3\",
                                            \"max_ip\": \"5.5.5.5\"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                },
                \"destination_modifications\": {
                    \"network_object_cell_modifications\": {
                        \"network_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"network_object\": [
                                        {
                                            \"@xsi.type\": \"ns_sc_policy:host_network_object\",
                                            \"name\": \"Host123\",
                                            \"comment\": \"cccHost\",
                                            \"ip\": \"1.2.3.4\",
                                            \"netmask\": \"255.255.255.255\"
                                        }
                                    ]
                                }
                            },
                            {
                                \"action\": \"REMOVE\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{7826af84-23b6-4d55-ae51-613a0d32697b}\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_network_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{aa7f8a4e-056a-4b1a-baa7-916785f5ce5e}\"
                                    }
                                }
                            }
                        ]
                    }
                },
                \"service_modifications\": {
                    \"service_object_cell_modifications\": {
                        \"service_object_cell_modification\": [
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                        \"name\": \"TCP_1\",
                                        \"comment\": \"EXAMPLE_TCP\",
                                        \"port\": {
                                            \"from\": 1234,
                                            \"to\": 1234
                                        },
                                        \"protocol\": \"TCP\"
                                    }
                                }
                            },
                            {
                                \"action\": \"REMOVE\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{6b9300af-9f9e-4901-8c9c-1ba5cf82b619}\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"uid\": \"551556da-22dc-46f4-9253-a7ceee70394b\",
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:transport_service\",
                                        \"name\": \"UDP_1\",
                                        \"comment\": \"EXAMPLE_UDP\",
                                        \"port\": {
                                            \"from\": 3,
                                            \"to\": 3
                                        },
                                        \"protocol\": \"UDP\"
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"new\"
                                    },
                                    \"service_object\": {
                                        \"@xsi.type\": \"ns_sc_policy:icmp_service\",
                                        \"name\": \"ICMP_1\",
                                        \"comment\": \"EXAMPLE_ICMP\",
                                        \"type\": {
                                            \"from\": 55,
                                            \"to\": 55
                                        }
                                    }
                                }
                            },
                            {
                                \"action\": \"ADD\",
                                \"device_service_object\": {
                                    \"device_id\": 5,
                                    \"status\": {
                                        \"@xsi.type\": \"existing\",
                                        \"st_uid\": \"{9ad89ab6-95ff-48e4-a4e3-b737a19224ea}\"
                                    }
                                }
                            }
                        ]
                    }
                }
            }
        }
    }
}


Response Messages:
400: The provided ticket does not exist.
400: The provided ticket step does not exist, or is not the current step
400: The provided ticket task does not exist in the current step
400: The provided field does not exist in the task.
400: The name or type of the field does not match the field in workflow.
400: You cannot change the value of the field because it is read-only.
400: Approved value of the Approve/Reject field must be either true or false
400: Checkbox field must be either true or false
400: The date format must be: yyyy-mm-dd
400: The date is not valid
400: The time format must be: hh:mm
400: general_invalid_field is not a valid target type)
400: Invalid value for the field and is not a valid NetworkObject type.
400: Range is not a valid type for NetworkObject field.
400: Not a valid service type.
400: Not a valid protocol type.
400: Predefined is not a valid type for service field.
400: Other is not a valid protocol type for service field.
400: You cannot open an access request with this action.
400: Field is not type of MultiChangeGroupField
400: Application Change field cannot be managed via this REST API
400: Deleting rule recertification info is not allowed
400: Application Change field cannot be managed via this REST API
400: Rule associated with successfully updated recertification info cannot be removed
400: Rule was already updated
400: Rule does not exist
400: Invalid value for field: <FIELD_NAME> (The new <DEVICE_OBJECT> (<NAME>) device ID (<DEVICE_ID>) does not match the rule key device ID (<DEVICE_ID>). The device IDs must be the same.)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <NAME> (name))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: status=new is not allowed for action=REMOVE on a <CELL_MODIFICATION>)
400: Invalid value for field: <FIELD_NAME> (Network Object appears more than once in same rule modification action: Check <source / destination> for <ST_UID> (st_uid))
400: Invalid value for field: <FIELD_NAME> (<cell> for rule modification with rule key: (device id: <ID>, binding uid: <UUID>, rule uid: <UUID>) cannot be empty. (cell))
400: Invalid value for field: <FIELD_NAME> (<device network object /device service object> is invalid: There are multiple objects with this name in the network)
400: Network object cell modification missing action
400: Network object cell modification element cannot be empty
403: You do not have permission to update this task. Contact your administrator for assistance.
400: Invalid value for field: <FIELD_NAME> (<OBJECT> is missing the required property: <PROPERTY>)
400: Invalid value for field: <FIELD_NAME> (<DEVICE_OBJECT> with device ID <DEVICE_ID> and ST UID <ST_UID> is not eligible for the specified action. See the Knowledge Center or API Implementation Notes for more information.
400: Invalid value for field: <FIELD_NAME> (<Source|Destination|Service> for a Rule Modification ticket cannot be empty)
400: Invalid value for field: <FIELD_NAME> (Invalid icmp type <TYPE>)
400: Invalid value for field: <FIELD_NAME> (Invalid service protocol <PROTOCOL>)
400: Invalid value for field: <FIELD_NAME> (Invalid service port <PORT>)
400: Invalid value for field: <FIELD_NAME> (Unsupported type: <TYPE>)
400: Invalid value for field: <FIELD_NAME> (a valid object comment can have up to <MAX> characters)
400: The lower bound is greater then upper!
400: The \"from\" or \"to\" field cannot be a string or a null value. Enter a positive integer value
406: Invalid format detected: <name|binding_uid|rule_uid> - This field cannot be empty / contain only spaces / have a null value. Enter a value with the relevant tags
406: Invalid format detected: name - <VALUE> is invalid. Text must include <1-255> characters
406: Invalid format detected: <rule_uid|binding_uid> - <VALUE> is invalid. Text must include <1-4096> characters
406: Invalid format detected: comment - <VALUE> is invalid. Text must include <0-4096> characters
406: Invalid format detected: name - <VALUE> is invalid. Enter a value that uses alphanumeric characters, digits, spaces, or any of the following characters + - , _ # @ . : = ! ^ ( )
406: Invalid format detected: <rule_uid|binding_uid|comment> - <VALUE> is invalid. Text includes invalid expressions such as HTML tags or command line operations
406: Invalid format detected: <ip|netMask|minIp|maxIp> - <VALUE> is an invalid IP"},"response":[]},{"name":"Returns the details of a specified field","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
stepId: The ID number of the step as shown in SecureChange
taskId: The ID number of the task as shown in SecureChange
fieldId: The ID number of the field as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/229

Response Messages:
403: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found
404: Stage ID was not found in ticket ID.
404: Task with ID was not found in Stage ID in ticket ID .
404: Field ID was not found in Task ID in Stage ID in ticket ID ."},"response":[]},{"name":"Returns a list of tickets by search parameters","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/search","description":"If the query is succesful but no results are found (for example, if there is no ticket for the specified Ticket ID) then the return code will be 200 and the results will be empty.

Parameters:
id: The ID number of the ticket as shown in SecureChange [optional]
subject: The subject of the ticket [optional]
requester: The requester of the ticket [optional]
group: The group handling the ticket [optional]
assigned_to: The user name of the person assigned to the ticket [optional]
priority: The priority of the ticket [optional]
status: The status of the ticket [optional]
sla_status: The SLA status of the ticket [optional]
field_name: Field name to search by [optional]
field_value: Field value to search by [optional]
current_step: Current step name [optional]
expiration_date_from: Search requests with expiration date from this date [optional]
expiration_date_to: Search requests with expiration date until this date [optional]
domain_name: The Domain of the ticket [optional]
start: Offset the count starting point [optional]
count: Ticket list length [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/search?id=1&status=IN_PROGRESS,REJECTED

Response Messages:
403: Access is denied.
400: Illegal ticket status entered. Permitted values are: IN_PROGRESS, REJECTED, CLOSED, CANCELLED, RESOLVED, WAITING_TO_BE_ASSIGNED, ASSIGNED, WAITING_FOR_MORE_INFO, DONE, INVALID, PENDING, PENDING_LICENS
400: Illegal ticket SLA status entered. Permitted values are: NA, OK, WARNING, ALERT, ESCALATION
400: Illegal ticket priority entered. Permitted values are: LOW, NORMAL, HIGH, CRITICAL
400: Illegal ticket expiration date entered. Permitted date format is: ddMMyyyy (ex. 20.11.2001)
400: Cannot find specified domain <DOMAIN_NAME>"},"response":[]},{"name":"Returns the results of the Commit action","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"stepId"},{"value":null,"type":"text","key":"taskId"},{"value":null,"type":"text","key":"fieldId"},{"value":null,"type":"text","key":"managementId"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps/{{stepId}}/tasks/{{taskId}}/fields/{{fieldId}}/designer/commit_report/{{managementId}}","description":"GENERAL USE
The report returns the Commit results for the device with the specified management ID and for the devices suggested in the Designer results. The report also includes results for devices that are in the related hierarchy of these devices.

Parameters:
id: Ticket ID
stepId: Step ID
taskId: Task ID
fieldId: Field ID
managementId: Management ID

Usage Example
URLhttps://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps/2/tasks/2/fields/3/designer/commit_report/3
OUTPUT{
    \"commit_report\": {
        \"ticketId\": 27,
        \"statTime\": \"24-Oct-2018 08:55 AM\",
        \"endTime\": \"24-Oct-2018 08:56 AM\",
        \"duration\": \"00:00:30\",
        \"vendorName\": \"PALO ALTO NETWORKS\",
        \"managmentName\": \"pano211\",
        \"devices\": {
            \"device\": [
                {
                    \"name\": \"DG1.1\",
                    \"status\": \"success_with_warnings\",
                    \"warnings\": {
                        \"warning\": \"Commit not performed: This device had no policies to install on its managed firewalls\"
                    },
                    \"policies\": \"\"
                },
                {
                    \"name\": \"DG1\",
                    \"status\": \"success_with_warnings\",
                    \"warnings\": {
                        \"warning\": \"Commit not performed: This device had no policies to install on its managed firewalls\"
                    },
                    \"policies\": \"\"
                }
            ]
        }
    }
}


Response Messages:
404: There is no ticket with ID <ID>.
404: Stage ID <ID> was not found in ticket ID <ID>.
404: Task with ID <ID> was not found in Stage ID <ID> in ticket ID <ID>.
404: The task with ID <ID> does not contain a field of type TYPE.
404: Specified field, id: <ID> , name: <NAME>, cannot contain designer result
404: Designer results were not found in the request."},"response":[]},{"name":"Returns the details of a specified ticket stages","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureChange_IP}}/securechangeworkflow/api/securechange/tickets/{{id}}/steps","description":"For a ticket that includes Commit Now Results, when the expand_links parameter is true, the API does not return a link for the Commit Now Results report

Parameters:
id: The ID number of the ticket as shown in SecureChange
expand_links: See expanded view of the objects [optional]

Usage Example
https://192.168.1.1/securechangeworkflow/api/securechange/tickets/1/steps

Response Messages:
403: You do not have permission to view this task. Contact your administrator for assistance.
404: Ticket ID was not found"},"response":[]}]}]} \ No newline at end of file diff --git a/Postman Format v2/R21-1 postman collection/securetrack_R21-1-RC1-v2.json b/Postman Format v2/R21-1 postman collection/securetrack_R21-1-RC1-v2.json new file mode 100644 index 0000000..4602be6 --- /dev/null +++ b/Postman Format v2/R21-1 postman collection/securetrack_R21-1-RC1-v2.json @@ -0,0 +1 @@ +{"info":{"_postman_id":"1","name":"Tufin Tufin SecureTrack R21-1-RC1","description":"Tufin Orchestration Suite - Tufin SecureTrack APIs.
For detailed information about the APIs please see the documentation at:
https://your-securetrack-server/securetrack/apidoc","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json"},"item":[{"name":"Additional Policy Fields","item":[{"name":"Get all URL Categories by revision.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/url_categories","description":"Fetches list of URL Categories defined in a revision given by ID.
This API is supported for Panorama in advanced mode and Panorama Device Groups.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/762/url_categories
"},"response":[]},{"name":"Get additional parameters identities by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/additional_parameters","description":"Some firewall vendors use special fields in their security policy.
For example: Palo Alto uses Tags, Security Profiles and Log Profiles and Fortinet uses NAT Pools and other NAT configurations.
SecureTrack refers to these fields as “Additional Parameters”.
The additional parameters API retrieves the possible values of these fields.
This API is currently supported for Palo Alto Networks firewalls and Fortinet devices managed by Fortimanager.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
type: Additional parameter type [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/162/additional_parameters?type=security_profile_group

Response Messages:
200: Successful
400: Invalid request"},"response":[]},{"name":"Get specific additional parameter identity","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/additional_parameters/{{ids}}","description":"Some firewall vendors use special fields in their security policy.
For example: Palo Alto uses Tags, Security Profiles and Log Profiles and Fortinet uses NAT Pools and other NAT configurations.
SecureTrack refers to these fields as “Additional Parameters”.
The additional parameters API retrieves the possible values of these fields.
This API is currently supported for Palo Alto Networks firewalls and Fortinet devices managed by Fortimanager.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Additional parameter IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/revisions/162/additional_parameters/242767,242768,242760
"},"response":[]},{"name":"Get a URL Category.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/url_categories/{{ids}}","description":"Fetches one or more URL Categories.
This API is supported for Panorama in advanced mode and Panorama Device Groups.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Url Category IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/revisions/762/url_categories/242767,242768,242760
"},"response":[]}]},{"name":"Application IDs","item":[{"name":"Get applications identities by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/applications","description":"Fetches list of applications defined in a revision given by ID.
This API is currently supported for Palo Alto Networks firewalls.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.
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.


Parameters:
context: Global MSSP context [optional]
id: Revision id
start: Starting page for query allowable value is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/762/applications?get_total=true
OUTPUT {
    \"applications\": {
        \"count\": 1,
        \"total\": 100,
        \"application\": [{
            \"@xsi.type\": \"singleApplicationDTO\",
            \"id\": 2095027,
            \"name\": \"any\",
            \"display_name\": \"any\",
            \"class_name\": \"application_object\",
            \"comment\": \"\",
            \"uid\": \"{61B7771C-8B0B-90D6-ED55-B6698691BEED}\",
            \"overrides\": false,
            \"service\": {
                \"id\": 5048925,
                \"uid\": \"{4BC8F8B5-7671-A61B-5DD2-8CA235955162}\",
                \"display_name\": \"any\",
                \"name\": \"any\"
            }
        }]
    }
}

"},"response":[]},{"name":"Get specific application identity","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/applications/{{ids}}","description":"Fetches one or more applications defined by a revision ID and Application Id or comma separated applications ids list.
This API is currently supported for Palo Alto Networks firewalls.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.


Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Application IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/revisions/762/applications/242767,242768,242760
"},"response":[]},{"name":"Get application identities by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/applications","description":"Fetches list of applications defined on device given by ID.
This API is currently supported for Palo Alto Networks firewalls.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.
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.


Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable values are numeric [optional]
count: Number of pages for query allowable values are numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/applications?get_total=true
OUTPUT {
    \"applications\": {
        \"count\": 50,
        \"total\": 100,
        \"application\": [{
            \"@xsi.type\": \"singleApplicationDTO\",
            \"id\": 2095027,
            \"name\": \"any\",
            \"display_name\": \"any\",
            \"class_name\": \"application_object\",
            \"comment\": \"\",
            \"uid\": \"{61B7771C-8B0B-90D6-ED55-B6698691BEED}\",
            \"overrides\": false,
            \"service\": {
                \"id\": 5048925,
                \"uid\": \"{4BC8F8B5-7671-A61B-5DD2-8CA235955162}\",
                \"display_name\": \"any\",
                \"name\": \"any\"
            }
        }]
    }
}

"},"response":[]},{"name":"Get specific application identity","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/applications/{{ids}}","description":"Fetches one or more applications defined by a device ID and Application Id or comma separated applications ids list.
This API is currently supported for Palo Alto Networks firewalls.
Note: This API retrieves the information from the latest revision.
In Panorama NG, overrides property in returned ApplicationDTO will be set to true, if the application overrides an original value.


Parameters:
context: Global MSSP context [optional]
id: Device ID
ids: Application IDs separated by commas

Usage Example
https://192.168.1.1/securetrack/api/devices/1/applications/701
"},"response":[]}]},{"name":"Change Authorization","item":[{"name":"Compare revisions on two different devices in terms of traffic.","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"policy_traffic_comparison_request\": {\n\t\t\"oldVersionId\": \"234\",\n\t\t\"newVersionId\": \"179\",\n\t\t\"oldId2newIdMap\": [\n\t\t\t{\n\t\t\t\t\"oldId\": \"{037DEA62-A8D2-46F5-8DC9-DA404A60B96F}\",\n\t\t\t\t\"newId\" : \"{00-FACED0-00}\"\n\t\t\t}\n\t\t],\n\t\t\"withTraffic\": true\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/change_authorization/policyTrafficComparison","description":"This API compares two arbitrary revisions from any devices. The comparison will be done in terms of allowed/denied traffic.
The API returns authorized if and only if there are no differences between the traffic allowed/denied by the rules in the two revisions.
The API returns unauthorized if there is at least one difference in terms of allowed/denied traffic between the two revisions.
Note 1: To map policies from one revision to the other use oldId2newIdMap and provide the UIDs of the policies to be compared.
Note 2: Parameter in the request body specifies if the result will return traffic difference details for all incompatible rules
Note 3: The format of the result is the same as the one returned by /change_authorization
Note 4: The API accepts in request body only one pair of oldId - newId map
Note 5: The request is valid only if the mapping ids are found in the active policies

Parameters:
body: Request parameter containing the versions of the revisions to be compared and the policy mapping between the revisions.

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_authorization/policyTrafficComparison
BODY{
    \"policy_traffic_comparison_request\": {
        \"oldVersionId\": \"234\",
        \"newVersionId\": \"179\",
        \"oldId2newIdMap\": [
            {
                \"oldId\": \"{037DEA62-A8D2-46F5-8DC9-DA404A60B96F}\",
                \"newId\" : \"{00-FACED0-00}\"
            }
        ],
        \"withTraffic\": true
    }
}


Response Messages:
200: Policies diff was successfully calculated
400: Could not find the requested revisions for comparison"},"response":[]},{"name":"Determine if changes between two revisions are authorized","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"new_version"},{"value":null,"type":"text","key":"old_version"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/change_authorization/","description":"This API checks for unauthorized changes between any two versions of a firewall policy.
The API returns authorized if and only if all traffic changes between the two versions were authorized by SecureChange tickets.
The API returns unauthorized if there is at least one change that cannot be matched to a SecureChange ticket.

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).
The API returns the authorization status, the relevant tickets in SecureChange and the rules that implement unauthorized access changes.

Note 1: To use this API you must enable “Authorize Revisions with Tickets” in SecureTrack/Configuration/Ticketing.
Note 2: Use the ID returned by the /revisions API for new_version and old_version.
Note 3: The default value for traffic_details and ignore_tickets is false.
Note 4: Traffic that is handled by an implicit rule will not have a rule ID.

Parameters:
new_version: New version ID
old_version: Old version ID
traffic_details: Return unauthorized traffic change details for all modified rules [optional]
ignore_tickets: Ignore SecureChange tickets and consider all traffic changes unauthorized [optional]

Usage Example
https://192.168.1.1/securetrack/api/change_authorization?old_version=1&new_version=2

Usage Example
https://192.168.1.1/securetrack/api/change_authorization?old_version=1&new_version=2&traffic_details=true&ignore_tickets=true

Response Messages:
200: Change authorization has been successfully calculated
400: Input parameters are not valid
400: Could not find the requested revisions for comparison"},"response":[]}]},{"name":"Change Windows","item":[{"name":"Get scheduling and device details for a specific change window","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"uid"},{"value":null,"type":"text","key":"task_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/change_windows/{{uid}}/tasks/{{task_id}}","description":"Retrieves scheduling and device details for a specific change window.

Parameters:
context: Global MSSP context [optional]
uid: Change window uuid
task_id: Task Id

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_windows/fc7b167c-29ea-49a1-9ee3-efb6d1351343/tasks/1
OUTPUT {
    \"commit_task\": {
        \"id\": 1,
        \"start_date\": \"04-Nov-2018 01:30:00PM +0200\",
        \"end_date\": \"04-Nov-2018 01:32:01PM +0200\",
        \"errors\": \"\",
        \"device_commits\": {
            \"device_commit\": [
                {
                    \"id\": 1,
                    \"result\": {
                        \"errors\": {
                            \"error\": \"got_error_from_dcs\"
                        },
                        \"device\": {
                            \"id\": 17,
                            \"status\": \"FAILURE\",
                            \"revision_id\": 1,
                            \"errors\": {
                                \"error\": \"Login error\"
                            }
                        }
                    }
                },
                {
                    \"id\": 2,
                    \"result\": {
                        \"errors\": \"\",
                        \"device\": {
                            \"id\": 19,
                            \"status\": \"SUCCESS_WITH_WARNINGS\",
                            \"revision_id\": 1,
                            \"warnings\": {
                                \"warning\": \"Commit not performed: This device had no policies to install on its managed firewalls\"
                            }
                        }
                    }
                }
            ]
        }
    }
}


Response Messages:
200: OK
400: For correct pagination provide a value for the start and count parameters
400: Start parameter must be a non-negative value
400: Count parameter must be a positive value
403: Not permitted to access this context
404: Change window with uuid was not found
404: Change window with uuid was not found in domain
404: Fail to find task for change window "},"response":[]},{"name":"Get a list of completed policy changes for a specific change window","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"uid"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/change_windows/{{uid}}/tasks","description":"Retrieves a list of completed policy changes for a specific change window.
For valid pagination, both start and count should be provided. Otherwise, pagination is turned off.
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.


Parameters:
context: Global MSSP context [optional]
uid: Change window uuid
start: Starting result for query allowable value is numeric [optional]
count: Number of tasks for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_windows/fc7b167c-29ea-49a1-9ee3-efb6d1351343/tasks?start=0&count=50&get_total=true
OUTPUT {
    \"commit_tasks\": {
        \"count\": 1,
        \"total\": 1,
        \"commit_task\": {
            \"id\": 1,
            \"start_date\": \"04-Nov-2018 01:30:00PM +0200\",
            \"end_date\": \"04-Nov-2018 01:32:01PM +0200\",
            \"errors\": \"\"
        }
    }
}


Response Messages:
200: OK
400: For correct pagination provide a value for the start and count parameters
400: Start parameter must be a non-negative value
400: Count parameter must be a positive value
403: Not permitted to access this context
404: Change window with uuid was not found
404: Change window with uuid was not found in domain "},"response":[]},{"name":"Get name and status for all change windows","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/change_windows/","description":"Retrieves a list of all change windows.
For valid pagination, both start and count should be provided. Otherwise, pagination is turned off.
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.


Parameters:
context: Global MSSP context [optional]
start: Starting result for query allowable value is numeric [optional]
count: Number of change windows for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/change_windows?start=0&count=50&get_total=true
OUTPUT {
    \"change_windows\": {
        \"count\": 2,
        \"total\": 2,
        \"change_window\": [
            {
                \"uuid\": \"6ae41504-a95c-4f23-98a2-f18b2efadb9d\",
                \"name\": \"cw1\",
                \"domain_id\": 1,
                \"enabled\": true
            },
            {
                \"uuid\": \"fc7b167c-29ea-49a1-9ee3-efb6d1351343\",
                \"name\": \"cw2\",
                \"domain_id\": 1,
                \"enabled\": true
            }
        ]
    }
}


Response Messages:
200: OK
400: For correct pagination provide a value for the start and count parameters
400: Start parameter must be a non-negative value
400: Count parameter must be a positive value
403: Not permitted to access this context "},"response":[]}]},{"name":"Device Interfaces and Zones","item":[{"name":"Get device zones by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/zones","description":"Returns a list of the zones for the specified Juniper, Stonesoft, Fortinet or Palo Alto Networks device.
Note: this API returns device zones, not Tufin zones.

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/104/zones
"},"response":[]},{"name":"Get device zones by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/zones","description":"Returns a list of the zones for the specified Juniper, Stonesoft, Fortinet or Palo Alto Networks revision.
Note: this API returns device zones, not Tufin zones.

Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/787/zones
"},"response":[]},{"name":"Get network interfaces by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/interfaces","description":"Reflects static data from the running-config.
For dynamic information see the /topology_interfaces API.
This API is not applicable for Check Point.

Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/227/interfaces
"},"response":[]},{"name":"Get zones and network interfaces that participate in sub-policies","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/bindable_objects","description":"Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/104/bindable_objects
"},"response":[]},{"name":"Get network interfaces by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/interfaces","description":"Reflects static data from the running-config.
For dynamic information see the /topology_interfaces API.
This API is not applicable for Check Point.

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/10/interfaces
"},"response":[]}]},{"name":"Domains","item":[{"name":"Get all domains","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/domains/","description":"

Usage Example
https://192.168.1.1/securetrack/api/domains

Response Messages:
403: User not permitted to access domains"},"response":[]},{"name":"Add a domain","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"domain\": {\n\t\t\"name\": \"domain1\",\n\t\t\"address\": \"address\",\n\t\t\"description\": \"description\"\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/domains/","description":"Parameters:
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/domains
BODY{
    \"domain\": {
        \"name\": \"domain1\",
        \"address\": \"address\",
        \"description\": \"description\"
    }
}


Response Messages:
403: User not permitted to access domains
400: Domain with this name already exists
400: Domain name is empty"},"response":[]},{"name":"Get domain","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/domains/{{id}}","description":"Parameters:
context: Global MSSP context [optional]
id: Domain id

Usage Example
https://192.168.1.1/securetrack/api/domains/1

Response Messages:
403: User not permitted to access domains
400: Domain with ID was not found"},"response":[]},{"name":"Update a domain","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"domain\": {\n\t\t\"name\": \"edited name\",\n\t\t\"address\": \"edited address\",\n\t\t\"description\": \"edited description\"\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/domains/{{id}}","description":"Parameters:
id: Domain id
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/domains/2
BODY{
    \"domain\": {
        \"name\": \"edited name\",
        \"address\": \"edited address\",
        \"description\": \"edited description\"
    }
}


Response Messages:
403: User not permitted to access domains
400: Domain with ID was not found
400: Domain with this name already exists
400: Domain name is empty
400: Default domain cannot be changed"},"response":[]}]},{"name":"General Properties","item":[{"name":"Get general properties","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/properties/","description":"This API requires 'Super admin' privileges



Usage Example
URLhttps://192.168.1.1/securetrack/api/properties
OUTPUT{
    \"properties\": {
        \"sc_addresses\": {
            \"sc_address\": [
                {
                    \"ip_address\": \"127.0.0.1\",
                    \"type\": \"external\"
                },
                {
                    \"ip_address\": \"127.0.0.1\",
                    \"type\": \"internal\"
                }
            ]
        }
    }
}


Response Messages:
403: User not permitted to view properties"},"response":[]}]},{"name":"IPsec VPN","item":[{"name":"Get Check Point VPN (IPSec) communities and gateways","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/ipsec_communities","description":"Get Check Point VPN (IPSec) Communities and gateways that partcipant in those communities.
Works on clusters and gateways, not on management servers.

Parameters:
device_id: The unique identifier of target device

Usage Example
https://192.168.1.1/securetrack/api/bindings/20/ipsec_communities
"},"response":[]},{"name":"Get Cisco IPsec policy and peers","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"outputInterfaceName"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/ipsec_tunnels","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.
You can retrieve the interface names by calling the /devices/id/interfaces API.

Parameters:
device_id: The unique identifier of target device
outputInterfaceName: Interface name

Usage Example
https://192.168.1.1/securetrack/api/bindings/32/ipsec_tunnels?outputInterfaceName=GigabitEthernet1
"},"response":[]},{"name":"Get Cisco cryptographic maps by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/crypto_maps","description":"Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://191.168.1.1/securetrack/api/revisions/18/crypto_maps
"},"response":[]},{"name":"Get Cisco cryptographic maps by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/crypto_maps","description":"Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/19/crypto_maps
"},"response":[]}]},{"name":"Internet Objects","item":[{"name":"Get resolved Internet representation for device","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"deviceId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}/object","description":"The order of precedence used to resolve the Internet object is:
Step 1: Identify the Internet referral:
Search for a defined Internet referral on the specified device.
If it is not found on the device, search the parent and grandparents (up the device tree) for a defined Internet referral.
If a defined Internet referral is found, then match the name in the Internet referral to a network object, as defined in Step 2.
If an Internet referral is not found, it resolves to “Any”.
Step 2: Resolve the object by name:
Search the specified device for a defined network object that matches the name returned in Step 1.
If a matching network object is not found, an error will be returned.

Parameters:
deviceId: SecureTrack Device ID

Usage Example
https://192.168.1.1/securetrack/api/internet_referral/2/object

Response Messages:
200: Resolved Internet referral object for device is returned
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
404: Configured object was not found on the device
403: Access is denied."},"response":[]},{"name":"Update Internet representation for device","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"internet_referral\": {\n\t\t\"@xsi.type\": \"internetReferralObjectNameDTO\",\n\t\t\"device_id\": 2,\n\t\t\"object_name\": \"Host_10.11.73.1\"\n\t}\n}\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}","description":"Updates the Internet referral configuration for the device.
If there was no previous configuration, it will be created.

Parameters:
deviceId: SecureTrack Device ID
body: Internet referral configuration

Usage Example
URLhttps://192.168.1.1/securetrack/api/internet_referral
BODY{
    \"internet_referral\": {
        \"@xsi.type\": \"internetReferralObjectNameDTO\",
        \"device_id\": 2,
        \"object_name\": \"Host_10.11.73.1\"
    }
}


Response Messages:
200: Internet referral configuration was updated
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
400: Internet referral configuration was malformed
403: Access is denied."},"response":[]},{"name":"Get Internet representation for device","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"deviceId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}","description":"Parameters:
deviceId: SecureTrack Device ID

Usage Example
https://192.168.1.1/securetrack/api/internet_referral/2

Response Messages:
200: Internet referral configuration is returned
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
404: Internet referral configuration was not found for device ID
403: Access is denied."},"response":[]},{"name":"Delete Internet representation for device","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"deviceId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/{{deviceId}}","description":"Parameters:
deviceId: SecureTrack Device ID

Usage Example
https://192.168.1.1/securetrack/api/internet_referral/2

Response Messages:
200: Internet referral configuration was deleted
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
400: Internet referral configuration for device ID does not exist
403: Access is denied."},"response":[]},{"name":"Create new Internet representation for a device","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"internet_referral\": {\n\t\t\"@xsi.type\": \"internetReferralObjectNameDTO\",\n\t\t\"device_id\": 2,\n\t\t\"object_name\": \"Host_2.2.2.2\"\n\t}\n}\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/internet_referral/","description":"The internet referral lets you represent the Internet as an object on a device.
See REST API: /internet_referral/{deviceId:[0-9]+}/object for a description of how internet referral is resolved.

Parameters:
body: Internet referral configuration

Usage Example
URLhttps://192.168.1.1/securetrack/api/internet_referral
BODY{
    \"internet_referral\": {
        \"@xsi.type\": \"internetReferralObjectNameDTO\",
        \"device_id\": 2,
        \"object_name\": \"Host_2.2.2.2\"
    }
}


Response Messages:
201: Internet referral configuration was created
400: Device with given ID does not exist
400: Internet referral object can only be configured for StoneSoft (except master engine) or Check Point SMC/CMA devices
400: Internet referral configuration was malformed
400: Internet referral configuration for given device ID already exists
403: Access is denied."},"response":[]}]},{"name":"LDAP","item":[{"name":"Get LDAP entry details by DN","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"dn"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/getEntryByDN","description":"Returns the UID, DN and Name of a LDAP entry specified by the DN.

Parameters:
dn: LDAP DN

Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/getEntryByDN?dn=CN=Manufacturing,OU=RSA_Demo,DC=tufintest,DC=com
OUTPUT{
    \"ldap_entry\": {
        \"uid\": \"mYbWQms7p0q5YinEyW5Byw==\",
        \"dn\": \"CN=Manufacturing,OU=RSA_Demo,DC=tufintest,DC=com\",
        \"name\": \"Manufacturing\"
    }
}


Response Messages:
200: OK
400: Invalid DN format
404: Entry matching the DN cannot be found
501: LDAP server is not configured
503: No connection to LDAP server"},"response":[]},{"name":"Return entries that exactly match one of the given strings","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"search_by_name_criteria\": {\n\t\t\"search_texts\": {\n\t\t\t\"search_text\": [\n\t\t\t\t\"Finance\",\n\t\t\t\t\"Marketing\",\n\t\t\t\t\"Management\"\n\t\t\t]\n\t\t},\n\t\t\"ldap_entry_types\": {\n\t\t\t\"ldap_entry_type\": [\n\t\t\t\t\"GROUP\"\n\t\t\t]\n\t\t},\n\t\t\"max_search_result\": 20\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/getEntriesByNames","description":"Return list of LDAP entries which match the exact given multiple search_text.

Parameters:
body: Names to search

Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/getEntriesByNames
BODY{
    \"search_by_name_criteria\": {
        \"search_texts\": {
            \"search_text\": [
                \"Finance\",
                \"Marketing\",
                \"Management\"
            ]
        },
        \"ldap_entry_types\": {
            \"ldap_entry_type\": [
                \"GROUP\"
            ]
        },
        \"max_search_result\": 20
    }
}
OUTPUT{
    \"search_result\": {
        \"ldap_entries\": {
            \"ldap_entry\": [
                {
                    \"@xsi.type\": \"LdapGroup\",
                    \"dn\": \"CN=Finance,OU=SecureTrack,DC=tufintest,DC=com\",
                    \"uid\": \"uOvJTpYRD0aTjEENA87N5A==\",
                    \"displayName\": \"Finance\"
                },
                {
                    \"@xsi.type\": \"LdapGroup\",
                    \"dn\": \"CN=Management,OU=SecureTrack,DC=tufintest,DC=com\",
                    \"uid\": \"jdf778skfsgs730fksdHHs==\",
                    \"displayName\": \"Management\"
                }
            ]
        },
        \"has_more_results_to_return\": false
    }
}


Response Messages:
200: OK
400: Bad request (one of the request fields has an illegal value)
501: LDAP server is not configured
503: No connection to LDAP server"},"response":[]},{"name":"Return LDAP entries which match the given search criteria","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"search_criteria\": {\n\t\t\"search_base_dn\": \"DC=tufintest,DC=com\",\n\t\t\"search_text\": \"test\",\n\t\t\"ldap_search_options\": {\n\t\t\t\"ldap_entry_types\": {\n\t\t\t\t\"ldap_entry_type\": [\n\t\t\t\t\t\"OU\",\n\t\t\t\t\t\"USER\"\n\t\t\t\t]\n\t\t\t},\n\t\t\t\"search_mode\": \"CONTAINS\",\n\t\t\t\"max_search_result\": 3\n\t\t}\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/search","description":"Return list of LDAP entries which match the given search criteria according to the search mode (EXACT, CONTAINS, STARTS_WITH, ENDS_WITH).
The search is case insensitive.
The limit of max_search_result is 1000.

Parameters:
body: Search criteria

Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/search
BODY{
    \"search_criteria\": {
        \"search_base_dn\": \"DC=tufintest,DC=com\",
        \"search_text\": \"test\",
        \"ldap_search_options\": {
            \"ldap_entry_types\": {
                \"ldap_entry_type\": [
                    \"OU\",
                    \"USER\"
                ]
            },
            \"search_mode\": \"CONTAINS\",
            \"max_search_result\": 3
        }
    }
}
OUTPUT{
    \"search_result\": {
        \"ldap_entries\": {
            \"ldap_entry\": [
            {
                \"dn\": \"CN=User15ATTesting1,OU=Testing1,OU=new OU,OU=SC_Users,DC=tufintest,DC=com\",
                \"uid\": \"ZRuKW3XqIEOIxCwlfgJQYA==\",
                \"displayName\": \"User15ATTesting1\"
            },
            {
                \"dn\": \"CN=IWAM_TEST2003,CN=Users,DC=tufintest,DC=com\",
                \"uid\": \"bYVqqcZXsUSF51hiP4W7Yw==\",
                \"displayName\": \"Testing1\"
            },
            {
                \"dn\": \"CN=User1ATTesting1,OU=Testing1,OU=new OU,OU=SC_Users,DC=tufintest,DC=com\",
                \"uid\": \"2ma3TrgeHEWQDITwvcRqlg==\",
                \"displayName\": \"test\"
            }
            ]
        },
            \"has_more_results_to_return\": \"true\"
        }
}


Response Messages:
200: OK
400: Bad request (one of the request fields has an illegal or invalid value)
501: LDAP server is not configured
503: No connection to LDAP server"},"response":[]},{"name":"Get the base DN entry details","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/ldap/getBaseDNEntry","description":"The returned \"base DN\" is used by GetEntriesByNames API as the search start entry.



Usage Example
URLhttps://192.168.1.1/securetrack/api/ldap/getBaseDNEntry
OUTPUT{
    \"ldap_entry\": {
        \"dn\": \"DC=tufintest,DC=com\",
        \"uid\": \"nABbRP/lPUKlteNRI4j6iA==\"
    }
}


Response Messages:
200: OK
404: Base Entry cannot be found
501: LDAP server is not configured
503: No connection to LDAP server"},"response":[]}]},{"name":"Monitored Devices","item":[{"name":"Add devices to SecureTrack","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \n \t \"devices_list\":{ \n \t\t \"devices\": [{ \n \t\t\t \"model\":\"CMA\",\n \t\t\t \"vendor\":\"Checkpoint\",\n \t\t\t \"display_name\":\"Europe-CMA\",\n \t\t\t \"ip_address\":\"192.168.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"securetrack_domain\":\"Default\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"lea_authentication_port\":\"65000\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"opsec_application\":\"ST-Opsec\",\n \t\t\t\t \"activation_key\":\"ST-Activation\",\n \t\t\t\t \"r80_version\":\"false\"\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"model\":\"CMA\",\n \t\t\t \"vendor\":\"Checkpoint\",\n \t\t\t \"display_name\":\"Europe-CMA\",\n \t\t\t \"ip_address\":\"192.168.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"securetrack_domain\":\"Default\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"lea_authentication_port\":\"65000\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"opsec_application\":\"ST-Opsec\",\n \t\t\t\t \"activation_key\":\"ST-Activation\",\n \t\t\t\t \"user_name\":\"admin\",\n \t\t\t\t \"password\":\"1234\",\n \t\t\t\t \"r80_version\":\"true\"\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"model\":\"ASA\",\n \t\t\t \"vendor\":\"Cisco\",\n \t\t\t \"securetrack_domain\":\"Domain-A\",\n \t\t\t \"display_name\":\"Ireland-ASA\",\n \t\t\t \"ip_address\":\"172.16.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t \"enable_virtual_contexts\":\"true\",\n \t\t\t \"import_all\":\"false\",\n \t\t\t \"import_devices\": \n \t\t\t\t\t [\"VC1\",\"VC2\"],\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"false\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"user_name\":\"St-Super-use\",\n \t\t\t\t \"password\":\"st-super-password\",\n \t\t\t\t \"enable_password\":\"st-enable-password\"\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"model\":\"Panorama\",\n \t\t\t \"vendor\":\"PaloAltoNetworks\",\n \t\t\t \"display_name\":\"First-Device-example\",\n \t\t\t \"ip_address\":\"172.16.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"user_name\":\"St-Super-use\",\n \t\t\t\t \"password\":\"st-super-password\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"import_devices\":[\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG1\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"] \n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG2\",\n \t\t\t\t\t\t \"import_all\":\"true\"\n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG3\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [] \n \t\t\t\t\t }\n \t\t\t\t ]\n \t\t\t }\n \t\t },\n \t\t {\n \t\t\t \"model\":\"FortiManager\",\n \t\t\t \"vendor\":\"Fortinet\",\n \t\t\t \"display_name\":\"Spain-FortiManager\",\n \t\t\t \"securetrack_server\":\"RemoteControlServerName\",\n \t\t\t \"ip_address\":\"172.16.1.1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"false\",\n \t\t\t\t \"user_name\":\"St-Super-use\",\n \t\t\t\t \"password\":\"st-super-password\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"import_all\": \"false\",\n \t\t\t\t \"import_devices\": [\n \t\t\t\t\t\t { \n \t\t\t\t \"name\": \"AdomX\",\n \t\t\t\t \"import_all\": \"false\", \n \t\t\t\t \"managed_devices\": [\"FW1\"]\n \t\t\t\t\t\t}\n \t\t\t\t\t]\n \t\t\t\t}\n \t\t\t}\n \t\t]\n \t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/","description":"Use this API to add a single device or a list of devices to SecureTrack.
The following devices can be added: Check Point CMA R77, CMA R80, SMC R77, SMC R80; Cisco ASA; Palo Alto Panorama NG; Fortinet FortiManager.
The API body should include a JSON file with the mandatory parameters for the operation.
String parameters contain only lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^().
Currently supported types: CMA, SMC, ASA, Panorama NG and FortiManager.

This API verifies connection to the provided device, before adding a device.
This is done by:
  Cisco - Connect with SSH and see that the credentials are correct.
  Check Point - Test OPSEC connectivity. For R80 devices, this also verifies the connectivity for API login.
  Panorama - Login through the API to check connectivity.
  Fortimanager - Login through the API to check connectivity.
If the connection test fails the device will not be added.
Only \"live\" device with correct credentials can be added using this API.
To add Checkpoint R77 devices, use \"r80_version\" : \"false\".


Parameters:
body: device_list

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/bulk
BODY{
     \"devices_list\":{
         \"devices\": [{
             \"model\":\"CMA\",
             \"vendor\":\"Checkpoint\",
             \"display_name\":\"Europe-CMA\",
             \"ip_address\":\"192.168.1.1\",
             \"enable_topology\": \"true\",
             \"securetrack_domain\":\"Default\",
             \"device_data\":{
                 \"lea_authentication_port\":\"65000\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"opsec_application\":\"ST-Opsec\",
                 \"activation_key\":\"ST-Activation\",
                 \"r80_version\":\"false\"
             }
         },
         {
             \"model\":\"CMA\",
             \"vendor\":\"Checkpoint\",
             \"display_name\":\"Europe-CMA\",
             \"ip_address\":\"192.168.1.1\",
             \"enable_topology\": \"true\",
             \"securetrack_domain\":\"Default\",
             \"device_data\":{
                 \"lea_authentication_port\":\"65000\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"opsec_application\":\"ST-Opsec\",
                 \"activation_key\":\"ST-Activation\",
                 \"user_name\":\"admin\",
                 \"password\":\"1234\",
                 \"r80_version\":\"true\"
             }
         },
         {
             \"model\":\"ASA\",
             \"vendor\":\"Cisco\",
             \"securetrack_domain\":\"Domain-A\",
             \"display_name\":\"Ireland-ASA\",
             \"ip_address\":\"172.16.1.1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
             \"enable_virtual_contexts\":\"true\",
             \"import_all\":\"false\",
             \"import_devices\":
                     [\"VC1\",\"VC2\"],
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"false\",
                 \"collect_dynamic_topology\":\"false\",
                 \"user_name\":\"St-Super-use\",
                 \"password\":\"st-super-password\",
                 \"enable_password\":\"st-enable-password\"
             }
         },
         {
             \"model\":\"Panorama\",
             \"vendor\":\"PaloAltoNetworks\",
             \"display_name\":\"First-Device-example\",
             \"ip_address\":\"172.16.1.1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"user_name\":\"St-Super-use\",
                 \"password\":\"st-super-password\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"collect_dynamic_topology\":\"false\",
                 \"import_devices\":[
                     {
                         \"name\":\"DG1\",
                         \"import_all\":\"false\",
                         \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"]
                     },
                     {
                         \"name\":\"DG2\",
                         \"import_all\":\"true\"
                     },
                     {
                         \"name\":\"DG3\",
                         \"import_all\":\"false\",
                         \"managed_devices\": []
                     }
                 ]
             }
         },
         {
             \"model\":\"FortiManager\",
             \"vendor\":\"Fortinet\",
             \"display_name\":\"Spain-FortiManager\",
             \"securetrack_server\":\"RemoteControlServerName\",
             \"ip_address\":\"172.16.1.1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"false\",
                 \"user_name\":\"St-Super-use\",
                 \"password\":\"st-super-password\",
                 \"collect_dynamic_topology\":\"false\",
                 \"import_all\": \"false\",
                 \"import_devices\": [
                         {
                 \"name\": \"AdomX\",
                 \"import_all\": \"false\",
                 \"managed_devices\": [\"FW1\"]
                        }
                    ]
                }
            }
        ]
    }
}


Response Messages:
202: Accepted
408: Request timed out
500: Internal server error
503: Task with UID already running"},"response":[]},{"name":"Edit Securetrack device","request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \n \t \"devices_list\":{ \n\t\t \"devices\": [{\n\t\t\t \"device_id\": 1,\n\t\t\t \"display_name\": \"CheckPoint-R77-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"ip_address\": \"1.1.1.1\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"opsec_application\": \"ST-Opsec\",\n\t\t\t\t \"activation_key\": \"ST-Activation\",\n\t\t\t\t \"authentication_mode\": \"LEA\",\n\t\t\t\t \"lea_authentication_mode\": \"ssl_opsec\",\n\t\t\t\t \"lea_authentication_port\": \"2488\",\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 2,\n\t\t\t \"display_name\": \"CheckPoint-R80-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"ip_address\": \"1.1.1.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"opsec_application\": \"ST-Opsec\",\n\t\t\t\t \"activation_key\": \"ST-Activation\",\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\",\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 3,\n\t\t\t \"display_name\": \"Cisco-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"ip_address\": \"2.2.2.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\",\n\t\t\t\t \"enable_password\": \"st-super-password\",\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 4,\n\t\t\t \"display_name\": \"PaloAlto-PanoramaNg-Device\",\n\t\t\t \"ip_address\": \"2.2.2.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 5,\n\t\t\t \"display_name\": \"PaloAlto-DeviceGroup\"\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 6,\n\t\t\t \"display_name\": \"PaloAlto-FireWall-Device\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_dynamic_topology\": \"true\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 7,\n\t\t\t \"display_name\": \"Spain-FortiManager\",\n\t\t\t \"ip_address\": \"2.2.2.2\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"user_name\": \"St-Super-use\",\n\t\t\t\t \"password\": \"st-super-password\"\n\t\t\t }\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 8,\n\t\t\t \"display_name\": \"FortiManager-Adom\"\n\t\t },\n\t\t { \n\t\t\t \"device_id\": 9,\n\t\t\t \"display_name\": \"FortiManager-FireWall\",\n\t\t\t \"enable_topology\": \"true\",\n\t\t\t \"device_data\": {\n\t\t\t\t \"collect_rule_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_object_usage_traffic_logs\": \"true\",\n\t\t\t\t \"collect_dynamic_topology\": \"true\"\n\t\t\t }\n\t\t }\n\t\t]\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/","description":"Use this API to edit the settings of a management device, including changing multiple parameters in the same call.
The API body should include a JSON file with the mandatory parameters for the operation.
String parameters contain only lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^().
The following devices can be edited: Check Point CMA R77, Check Point SMC R77, Cisco ASA, Panorama NG and FortiManager.
Note: This API cannot be used to edit SecureTrack Domains and SecureTrack Servers.
This API verifies connection to the provided device, before updating a device.
This is done by:
  Cisco - Connect with SSH and see that the credentials are correct.
  Check Point - Test OPSEC connectivity. For R80 devices, this also verifies the connectivity for API login.
  Panorama - Login through the API to check connectivity.
  Fortimanager - Login through the API to check connectivity.
If the connection test fails the device will not be updated.
Only \"live\" device with correct credentials can be updated using this API.

Parameters:
body: device_list

Usage Example
URL https://192.168.1.1/securetrack/api/devices/bulk
BODY{
     \"devices_list\":{
         \"devices\": [{
             \"device_id\": 1,
             \"display_name\": \"CheckPoint-R77-Device\",
             \"enable_topology\": \"true\",
             \"ip_address\": \"1.1.1.1\",
             \"device_data\": {
                 \"opsec_application\": \"ST-Opsec\",
                 \"activation_key\": \"ST-Activation\",
                 \"authentication_mode\": \"LEA\",
                 \"lea_authentication_mode\": \"ssl_opsec\",
                 \"lea_authentication_port\": \"2488\",
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\"
             }
         },
         {
             \"device_id\": 2,
             \"display_name\": \"CheckPoint-R80-Device\",
             \"enable_topology\": \"true\",
             \"ip_address\": \"1.1.1.2\",
             \"device_data\": {
                 \"opsec_application\": \"ST-Opsec\",
                 \"activation_key\": \"ST-Activation\",
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\",
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\"
             }
         },
         {
             \"device_id\": 3,
             \"display_name\": \"Cisco-Device\",
             \"enable_topology\": \"true\",
             \"ip_address\": \"2.2.2.2\",
             \"device_data\": {
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\",
                 \"enable_password\": \"st-super-password\",
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\"
             }
         },
         {
             \"device_id\": 4,
             \"display_name\": \"PaloAlto-PanoramaNg-Device\",
             \"ip_address\": \"2.2.2.2\",
             \"device_data\": {
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\"
             }
         },
         {
             \"device_id\": 5,
             \"display_name\": \"PaloAlto-DeviceGroup\"
         },
         {
             \"device_id\": 6,
             \"display_name\": \"PaloAlto-FireWall-Device\",
             \"enable_topology\": \"true\",
             \"device_data\": {
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\",
                 \"collect_dynamic_topology\": \"true\"
             }
         },
         {
             \"device_id\": 7,
             \"display_name\": \"Spain-FortiManager\",
             \"ip_address\": \"2.2.2.2\",
             \"device_data\": {
                 \"user_name\": \"St-Super-use\",
                 \"password\": \"st-super-password\"
             }
         },
         {
             \"device_id\": 8,
             \"display_name\": \"FortiManager-Adom\"
         },
         {
             \"device_id\": 9,
             \"display_name\": \"FortiManager-FireWall\",
             \"enable_topology\": \"true\",
             \"device_data\": {
                 \"collect_rule_usage_traffic_logs\": \"true\",
                 \"collect_object_usage_traffic_logs\": \"true\",
                 \"collect_dynamic_topology\": \"true\"
             }
         }
        ]
    }
}


Response Messages:
202: Accepted
408: Request timed out
500: Internal server error
503: Task with UID already running"},"response":[]},{"name":"Get specific device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}","description":"Returns the vendor, model, name, domain and ID for the specified device.
For more information on supported devices, supported models and virtual types please refer to 'Device and Revision Resources' section in the Tufin Knowledge Center .

Parameters:
context: Global MSSP context [optional]
id: Device ID
show_os_version: Show os version as apart of the response [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/60

Usage Example
https://192.168.1.1/securetrack/api/devices/20?show_os_version=true
"},"response":[]},{"name":"Get textual configuration by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/config","description":"Get latest revision of running configuration for a given device Id.


Parameters:
context: global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/111/config
"},"response":[]},{"name":"Import managed devices","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \n \t \"devices_list\":{ \n \t\t \"devices\":[ \n \t\t { \n \t\t\t \"device_id\":\"1\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_dynamic_topology\":\"false\",\n \t\t\t\t \"import_devices\":[\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG1\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"] \n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG2\",\n \t\t\t\t\t\t \"import_all\":\"true\"\n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"DG3\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [] \n \t\t\t\t\t }\n \t\t\t\t ]\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"device_id\":\"2\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"import_devices\": [\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"Adom1\",\n \t\t\t\t\t\t \"import_all\":\"false\",\n \t\t\t\t\t\t \"managed_devices\": [\"firewall1\", \"firewall2\"] \n \t\t\t\t\t },\n \t\t\t\t\t { \n \t\t\t\t\t\t \"name\":\"Adom2\",\n \t\t\t\t\t\t \"import_all\":\"true\"\n \t\t\t\t\t }\n \t\t\t\t ]\n \t\t\t }\n \t\t },\n \t\t { \n \t\t\t \"device_id\":\"3\",\n \t\t\t \"enable_topology\": \"true\",\n \t\t\t \"device_data\":{ \n \t\t\t\t \"import_all\":\"false\",\n \t\t\t\t \"collect_rule_usage_traffic_logs\":\"true\",\n \t\t\t\t \"collect_object_usage_traffic_logs\":\"true\",\n \t\t\t\t \"import_devices\": [\"wantedVirtualContext\", \"anotherWantedVirtualContext\"] \n \t\t\t }\n \t\t }\n \t\t]\n \t}\n} "},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/import","description":"Use this API to import more managed devices to SecureTrack.
The following devices can be added: Device Groups (for Panorama), Administrative Domains (for FortiManager).\nCurrently supported types: Panorama, FortiManager, Cisco ASA.
Please see examples below per device id: device id 1 for Panorama, device 2 for FortiManager, device id 3 for Cisco ASA.

Parameters:
body: device_list

Usage Example
URL https://192.168.1.1/securetrack/api/devices/bulk/import
BODY{
     \"devices_list\":{
         \"devices\":[
         {
             \"device_id\":\"1\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"collect_dynamic_topology\":\"false\",
                 \"import_devices\":[
                     {
                         \"name\":\"DG1\",
                         \"import_all\":\"false\",
                         \"managed_devices\": [\"wantedDg\", \"anotherWantedDg\"]
                     },
                     {
                         \"name\":\"DG2\",
                         \"import_all\":\"true\"
                     },
                     {
                         \"name\":\"DG3\",
                         \"import_all\":\"false\",
                         \"managed_devices\": []
                     }
                 ]
             }
         },
         {
             \"device_id\":\"2\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"import_devices\": [
                     {
                         \"name\":\"Adom1\",
                         \"import_all\":\"false\",
                         \"managed_devices\": [\"firewall1\", \"firewall2\"]
                     },
                     {
                         \"name\":\"Adom2\",
                         \"import_all\":\"true\"
                     }
                 ]
             }
         },
         {
             \"device_id\":\"3\",
             \"enable_topology\": \"true\",
             \"device_data\":{
                 \"import_all\":\"false\",
                 \"collect_rule_usage_traffic_logs\":\"true\",
                 \"collect_object_usage_traffic_logs\":\"true\",
                 \"import_devices\": [\"wantedVirtualContext\", \"anotherWantedVirtualContext\"]
             }
         }
        ]
    }
}


Response Messages:
202: Accepted
408: Request timed out
500: Internal server error
503: Task with UID already running"},"response":[]},{"name":"Get specific task results of bulk operations on devices","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"task_uid"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/bulk/tasks/{{task_uid}}","description":"Use this API to track and display the current progress of the devices being edited or added to\nSecureTrack for a specific Task ID.
For a list of devices, the status of each device is displayed.

A device that was not added due to some reason will be added to \"failed\" list with status element containing a description.
For example:
\"description\": \"No connection to device\".

Parameters:
task_uid: Task UID

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/bulk/tasks/d7e88799-a6e5-45da-8c72-c979a5dbe235
OUTPUT{
    \"task_result\":{
        \"total_succeeded\":\"0\",
        \"total_in_progress\":\"2\",
        \"total_failed\":\"0\",
        \"succeeded\":{
            \"count\":\"0\"
        },
        \"in_progress\":{
            \"count\":\"2\",
            \"devices\":[
                {
                    \"device_id\":\"1\",
                    \"display_name\":\"Europe-CMA\",
                    \"ip_address\":\"192.168.1.1\",
                    \"status\":{
                    }
                },
                {
                    \"device_id\":\"2\",
                    \"display_name\":\"Ireland-ASA\",
                    \"ip_address\":\"172.16.1.1\",
                    \"status\":{
                    }
                }
            ]
        },
        \"failed\":{
            \"count\":\"0\"
        }
    }
}


Response Messages:
404: The task with the given UID was not found
400: Bad request
200: Accepted
408: Request timed out
500: Internal server error"},"response":[]},{"name":"Add configuration for offline device","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"configuration_file"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/tasks/add_device_config_task","description":"Parameters:
device_id: Device ID
configuration_file: Configuration File

Usage Example
curl -X POST -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F \"configuration_file=@/tmp/config.txt;type=application/octet-stream\" -F \"device_id=1\" https://192.168.1.1/securetrack/api/tasks/add_device_config_task

Response Messages:
200: Configuration added successfully."},"response":[]},{"name":"Update offline device","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t API OFFLINE ASA2\n\t true\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}","description":"Device name should contain only Lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^()

Parameters:
device_id: Device ID
body: Device to be updated

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/1
BODY<device>
     <name>API OFFLINE ASA2</name>
     <topology>true</topology>
</device>

"},"response":[]},{"name":"Get devices","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/","description":"Returns the list of devices that are configured in SecureTrack, including the vendor, model, name, domain and device ID.
The results can be sorted by ip, name, vendor and model.
For more information on supported devices, supported models and virtual types please refer to 'Device and Revision Resources' section in the Tufin Knowledge Center .

Parameters:
context: Global MSSP context [optional]
name: Device name [optional]
ip: Device IP address [optional]
vendor: Device vendor [optional]
model: Device model [optional]
sort: Sort ascending or descending allowable types are: asc or desc [optional]
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query starting from starting page allowable type in numeric [optional]
show_os_version: Show os version as apart of the response [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices

Usage Example
https://192.168.1.1/securetrack/api/devices?vendor=VMware

Usage Example
https://192.168.1.1/securetrack/api/devices?sort=ip:asc

Usage Example
https://192.168.1.1/securetrack/api/devices?show_os_version=true
"},"response":[]},{"name":"Add offline device","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t asa \n\t Cisco\n\t 1\n\t Default\n\t API OFFLINE ASA1\n\t true\n\t true\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/","description":"You can choose to select the domain either by name or id using the domain_id or domain_name tags.\nDevice name should contain only Lower and upper case letters, digits, space, dot, backward slash, forward slash, underscore or one of the following signs: #@:;=!^()

Parameters:
body: Device to be added

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices
BODY<device>
     <model>asa</model>
     <vendor>Cisco</vendor>
     <domain_id>1</domain_id>
     <domain_name>Default</domain_name>
     <name>API OFFLINE ASA1</name>
     <offline>true</offline>
     <topology>true</topology>
</device>

"},"response":[]},{"name":"Get textual configuration by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/config","description":"Returns textual configuration for the specified revision Id.


Parameters:
context: Global MSSP context [optional]
id: Revision id

Usage Example
https://192.168.1.1/securetrack/api/revisions/227/config
"},"response":[]}]},{"name":"NAT Policies","item":[{"name":"Get NAT objects by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/nat_objects","description":"Fetches a list of NAT objects for a given revision
Note: NAT objects are only relevant for Check Point management servers and Juniper Netscreen devices.
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.


Parameters:
context: Global MSSP context [optional]
id: Version ID
start: Starting page for query allowable value is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/nat_objects

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/nat_objects?get_total=true
"},"response":[]},{"name":"Get NAT objects by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/nat_objects","description":"Fetches a list of NAT objects defined on device given by device ID
Note: NAT objects are only relevant for Check Point management servers and Juniper Netscreen devices.
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.


Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable value is numeric [optional]
count: Starting page for query allowable value is numeric [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/nat_objects

Usage Example
https://192.168.1.1/securetrack/api/devices/20/nat_objects?get_total=true
"},"response":[]},{"name":"Get NAT rules by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/nat_rules/bindings","description":"Fetches list of NAT rules for device given by device ID

input_interface and output_interface are not supported for Panorama running in Advanced management mode
nat_stage is supported for Netscreen and JunOS
nat_type is supported for FortiManager
Note: For Check Point, NAT rules are available from the modules (not managements)
Note: For Palo Alto, filtering NAT rules by interface is only available for firewall devices

Parameters:
context: Global MSSP context [optional]
id: Device ID
input_interface: Input interface for NAT rules, \"any\" for all interfaces [optional]
output_interface: output interface for NAT rules, \"any\" for all interfaces [optional]
nat_stage: NAT stage for NAT rules allowable values: \"pre_policy\" , \"post_policy\" or \"both\" [optional]
nat_type: NAT stage for NAT rules allowable values: \"vip\" or \"reverse_vip\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/10/nat_rules/bindings?input_interface=Any
"},"response":[]}]},{"name":"Network Objects","item":[{"name":"Get network groups containing specified network object","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/network_objects/{{id}}/groups","description":"Returns groups that contain the specified network object


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the network object.

Usage Example
https://192.168.1.1/securetrack/api/network_objects/69577/groups
"},"response":[]},{"name":"Get rules containing specified network object","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/network_objects/{{id}}/rules","description":"Returns the security rules that contain the specified network object


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the network object.
include_groups: You can add \"include_groups\" to find rules that include the network object and rules that include the groups that include the network object. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]

Usage Example
https://192.168.1.1/securetrack/api/network_objects/65078/rules?include_groups=true
"},"response":[]},{"name":"Get network objects by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/network_objects","description":"Fetches list of network objects defined on device given by ID
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.
The show_members parameter is only relevant if type=group.
If type=group, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.

Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
name: Network object name [optional]
type: Network object type [optional]
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
contains_ip: Get only network objects containing this IP [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]
typeOnDevice: Get EDL groups [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]
add_parent_objects: Panorama only: Get objects from parent DGs (default true) [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/network_objects

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?get_total=true
OUTPUT {
    \"network_objects\": {
    \"count\": 1,
    \"total\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"hostNetworkObjectDTO\",
                \"id\": 499226,
                \"name\": \"1.1.1.2 not shared\",
                \"display_name\": \"1.1.1.2 not shared\",
                \"class_name\": \"host_plain\",
                \"type\": \"host\",
                \"comment\": \"\",
                \"uid\": \"{EFE8E61B-EE2A-2F55-4C5C-56508661EAA7}\",
                \"implicit\": false,
                \"management_domain\": \"Shared\",
                \"overrides\": false,
                \"ip\": \"1.1.1.2\"
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"count\": 1
        \"network_object\": [
            {
                \"@xsi.type\": \"identityAwarenessDTO\",
                \"id\": 169178,
                \"name\": \"Access_role\",
                \"display_name\": \"Access_role\",
                \"class_name\": \"access_role\",
                \"type\": \"identity_awareness\",
                \"global\": false,
                \"comment\": \"\",
                \"uid\": \"{FC267948-DA8C-4FB6-A736-76B5254BF825}\",
                \"implicit\": false,
                \"overrides\": false,
                \"type_on_device\": \"\",
                \"networks\": {
                    \"network\": {
                        \"@xsi.type\": \"basicNetworkObjectDTO\",
                        \"id\": 168419,
                        \"name\": \"Any\",
                        \"display_name\": \"Any\",
                        \"class_name\": \"any_object\",
                        \"type\": \"basic\",
                        \"global\": false,
                        \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                        \"implicit\": false,
                        \"overrides\": false
                    }
                },
                \"users\": {
                    \"user\": {
                        \"id\": 14320,
                        \"name\": \"ad_group_auto_30K_grp1\",
                        \"display_name\": \"auto_30K_grp1\",
                        \"class_name\": \"ad_group\",
                        \"global\": false,
                        \"comment\": \"\",
                        \"uid\": \"{CAB92DCC-CF63-4E47-B8E3-1E1231996D5E}\",
                        \"dn\": \"CN=auto_30K_grp1,OU=OU_30K_Groups,DC=rnd,DC=local\"
                    }
                }
            },
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?type=group&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 105934,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?typeOnDevice=edl_ip_list&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 1,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 123123,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"type_on_device\": edl_ip_list,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Response Messages:
400: The typeOnDevice value is not valid"},"response":[]},{"name":"Get network objects by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/network_objects","description":"Fetches list of network objects from specific revision
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.
The show_members parameter is only relevant if type=group.
If type=group, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.

Parameters:
context: Global MSSP context [optional]
id: Revision id
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
name: Network object name [optional]
type: Network object type [optional]
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
contains_ip: Get only network objects containing this IP [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]
typeOnDevice: Get EDL groups [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]
add_parent_objects: Panorama only: Get objects from parent DGs (default true) [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/779/network_objects

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects?get_total=true
OUTPUT {
    \"network_objects\": {
    \"count\": 1,
    \"total\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"hostNetworkObjectDTO\",
                \"id\": 499226,
                \"name\": \"1.1.1.2 not shared\",
                \"display_name\": \"1.1.1.2 not shared\",
                \"class_name\": \"host_plain\",
                \"type\": \"host\",
                \"comment\": \"\",
                \"uid\": \"{EFE8E61B-EE2A-2F55-4C5C-56508661EAA7}\",
                \"implicit\": false,
                \"management_domain\": \"Shared\",
                \"overrides\": false,
                \"ip\": \"1.1.1.2\"
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/779/network_objects?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
    \"count\": 1,
        \"network_object\": [
            {
                \"@xsi.type\": \"identityAwarenessDTO\",
                \"id\": 169183,
                \"name\": \"Access role 1\",
                \"display_name\": \"Access role 1\",
                \"class_name\": \"access_role\",
                \"type\": \"identity_awareness\",
                \"global\": true,
                \"comment\": \"\",
                \"uid\": \"{1E4C35A0-1FE4-4101-8A38-FDE656BCDCFB}\",
                \"implicit\": false,
                \"overrides\": false,
                \"type_on_device\": \"\",
                \"networks\": {
                    \"network\": {
                        \"@xsi.type\": \"basicNetworkObjectDTO\",
                        \"id\": 168419,
                        \"name\": \"Any\",
                        \"display_name\": \"Any\",
                        \"class_name\": \"any_object\",
                        \"type\": \"basic\",
                        \"global\": false,
                        \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                        \"implicit\": false,
                        \"overrides\": false
                    }
                },
                \"users\": {
                    \"user\": {
                        \"id\": 14346,
                        \"name\": \"all identified\",
                        \"display_name\": \"all identified\",
                        \"class_name\": \"all_identified\",
                        \"global\": false,
                        \"comment\": \"\",
                        \"uid\": \"{17A972AC-4B4A-4715-859F-867128707F59}\",
                        \"dn\": \"\"
                    }
                }
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/31/network_objects?type=group&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 100,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 105934,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/31/network_objects?typeOnDevice=edl_ip_list&show_members=false
OUTPUT{
    \"network_objects\": {
    \"count\": 1,
        \"network_object\": [
            {
                \"@xsi.type\": \"networkObjectGroupDTO\",
                \"id\": 123123,
                \"name\": \"aW50ZXJmYWNlAA==;aW50ZXJmYWNlIG1nbXQA\",
                \"display_name\": \"group_1\",
                \"class_name\": \"network_object_group\",
                \"type\": \"group\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": true,
                \"ip_type\": \"other\",
                \"overrides\": false,
                \"member\":
                    \"id\": 105936,
                    \"type_on_device\": edl_ip_list,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"interface_1\",
            }
        ]
    }
}


Response Messages:
400: The typeOnDevice value is not valid"},"response":[]},{"name":"Get specific network objects by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/network_objects/{{ids}}","description":"Fetches a single or partial list of the network objects for a given revision.
For group network objects, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.

Parameters:
context: Global MSSP context [optional]
revision_id: Revision id
ids: Network object IDs separated by commas
show_members: Set to false to return only the name and ID of the members [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/779/network_objects/69548

Usage Example
https://192.168.1.1/securetrack/api/revisions/779/network_objects/69547,69548,69550

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/779/network_objects/69547?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"network_object\": {
            \"@xsi.type\": \"identityAwarenessDTO\",
            \"id\": 169185,
            \"name\": \"Access_Role_Domain Controllers\",
            \"display_name\": \"Access_Role_Domain Controllers\",
            \"class_name\": \"access_role\",
            \"type\": \"identity_awareness\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{140B8F32-188D-414C-A7BE-F4A7D7E9A169}\",
            \"implicit\": false,
            \"overrides\": false,
            \"type_on_device\": \"\",
            \"networks\": {
                \"network\": {
                    \"@xsi.type\": \"basicNetworkObjectDTO\",
                    \"id\": 168419,
                    \"name\": \"Any\",
                    \"display_name\": \"Any\",
                    \"class_name\": \"any_object\",
                    \"type\": \"basic\",
                    \"global\": false,
                    \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                    \"implicit\": false,
                    \"overrides\": false
                }
            },
            \"users\": {
                \"user\": {
                    \"id\": 14237,
                    \"name\": \"ad_group_Domain_Controllers\",
                    \"display_name\": \"Domain Controllers\",
                    \"class_name\": \"ad_group\",
                    \"global\": false,
                    \"comment\": \"\",
                    \"uid\": \"{0A8A459E-58E8-45DC-981E-16BBF2BD1922}\",
                    \"dn\": \"CN=Domain Controllers,CN=Users,DC=rnd,DC=local\"
                }
            }
        }
    }
}

"},"response":[]},{"name":"Get network objects matching specified criteria","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"filter"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/network_objects/search","description":"You can search for network objects where the IP address, name or comment fields have a specified text string,
or you can search for network objects that have an IP address that matches, contains or is contained in a specified IP subnet,
or you can search for network objects by uid.

Parameters:
context: Returns results for the specified domain ID. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]
filter: “text” filter returns network objects where the IP address, name or comment fields have a specified text string. “subnet” filter returns network objects that have an IP address that matches, contains or is contained in a specified IP subnet. “uid“ filter returns network objects with the specified uid. If no filter is specified, the “text” filter is used.
device_id: Returns network objects belonging to the specified device_id. [optional]
ip: (For “text” filter) You can specify \"ip\" to find network objects with the specified text in the IP address field. [optional]
name: (For “text” filter) You can specify \"name\" to find network objects with the specified text in the name field. [optional]
comment: (For “text” filter) You can specify “comment” to find network objects with the specified text in the comment field. [optional]
any_field: (For “text” filter) You can specify \"any_field\" to find network objects with the specified text in the IP address, name or comment fields. [optional]
exact_match: (For “text” filter) You can add \"exact_match=true\" to find network objects with the specified text in the comment field. If this field is not specified, the query uses \"exact_match=false\". [optional]
contained_in: (For “subnet” filter) You can specify \"contained_in\" to find network objects that are contained in the specified IP subnet. For example, 10.1.0.0 is contained in 10.0.0.0. [optional]
contains: (For “subnet” filter) You can specify \"contains\" to find network objects that contain the specified IP subnet. For example, 10.0.0.0 contains 10.1.0.0. [optional]
exact_subnet: (For “subnet” filter) You can specify \"exact_subnet\" to find network objects that have the specified IP address. [optional]
uid: (for “uid“ filter) Returns network objects with the specified uid. [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]
typeOnDevice: You can specify \"typeOnDevice\" to find network object groups that are EDL. [optional]

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=text&name=host&exact_match=true

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=text&any_field=host&count=10&exact_match=true

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=subnet&contains=10.1.1.0

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=subnet&count=10&exact_subnet=1.1.1.1

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=uid&uid=24a8774d-24c1-4b3a-aae9-3c272a2b5191

Usage Example
https://192.168.1.1/securetrack/api/network_objects/search?filter=uid&uid=24a8774d-24c1-4b3a-aae9-3c272a2b5191&device_id=4

Usage Example
URLhttps://192.168.1.1/securetrack/api/network_objects/search?filter=text&name=Access_Role&identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"count\": 1,
        \"total\": 1,
        \"network_object\": {
            \"@xsi.type\": \"identityAwarenessDTO\",
            \"id\": 169197,
            \"name\": \"Access_Role_aaa\",
            \"display_name\": \"Access_Role_aaa\",
            \"class_name\": \"access_role\",
            \"type\": \"identity_awareness\",
            \"global\": false,
            \"device_id\": 158,
            \"comment\": \"\",
            \"uid\": \"{9EDC2607-6BEC-43D7-A99D-B522BA694ADA}\",
            \"implicit\": false,
            \"overrides\": false,
            \"type_on_device\": \"\",
            \"networks\": {
                \"network\": {
                    \"@xsi.type\": \"basicNetworkObjectDTO\",
                    \"id\": 168419,
                    \"name\": \"Any\",
                    \"display_name\": \"Any\",
                    \"class_name\": \"any_object\",
                    \"type\": \"basic\",
                    \"global\": false,
                    \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                    \"implicit\": false,
                    \"overrides\": false
                }
            },
            \"users\": {
                \"user\": {
                    \"id\": 14317,
                    \"name\": \"ad_group_aaa\",
                    \"display_name\": \"aaa\",
                    \"class_name\": \"ad_group\",
                    \"global\": false,
                    \"comment\": \"\",
                    \"uid\": \"{5D16859C-0256-4673-A402-4254588B8F40}\",
                    \"dn\": \"CN=aaa,OU=SC_Users,DC=test,DC=com\"
                }
            }
        }
    }
}


Response Messages:
400: The typeOnDevice value is not valid.Use edl_ip_list as value to search EDL groups."},"response":[]},{"name":"Get specific network object","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/network_objects/{{ids}}","description":"Fetches a single or partial list of the network objects for a given device ID.
For group network objects, the returned results will also include full details of every group member.
Set show_members=false to return only the name and ID of the members, and omit the full details of the group members.
Note: This API retrieves the information from the latest revision.

Parameters:
context: Global MSSP context [optional]
device_id: Device ID
ids: Network object IDs separated by commas
show_members: Set to false to return only the name and ID of the members [optional]
identity_awareness: Get access role objects as \"identity_awareness\" if identity_awareness parameter is \"supported\". Default type returned is \"identity_role\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/network_objects/69548

Usage Example
https://192.168.1.1/securetrack/api/devices/31/network_objects/69547,69548,69550

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/network_objects/169184?identity_awareness=supported
OUTPUT{
    \"network_objects\": {
        \"network_object\": {
            \"@xsi.type\": \"identityAwarenessDTO\",
            \"id\": 169184,
            \"name\": \"Access_Role_@grp\",
            \"display_name\": \"Access_Role_@grp\",
            \"class_name\": \"access_role\",
            \"type\": \"identity_awareness\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{1870612C-0922-4AEE-81FF-5472DB7C32E1}\",
            \"implicit\": false,
            \"overrides\": false,
            \"type_on_device\": \"\",
            \"networks\": {
                \"network\": {
                    \"@xsi.type\": \"basicNetworkObjectDTO\",
                    \"id\": 168419,
                    \"name\": \"Any\",
                    \"display_name\": \"Any\",
                    \"class_name\": \"any_object\",
                    \"type\": \"basic\",
                    \"global\": false,
                    \"uid\": \"{97AEB369-9AEA-11D5-BD16-0090272CCB30}\",
                    \"implicit\": false,
                    \"overrides\": false
                }
            },
            \"users\": {
                \"user\": {
                    \"id\": 14338,
                    \"name\": \"ad_group_grp\",
                    \"display_name\": \"@grp\",
                    \"class_name\": \"ad_group\",
                    \"global\": false,
                    \"comment\": \"\",
                    \"uid\": \"{C5740C23-F36E-4D2E-8B17-1F99C239C12A}\",
                    \"dn\": \"CN=@grp,OU=SC_Users,DC=test,DC=com\"
                }
            }
        }
    }
}

"},"response":[]}]},{"name":"Network Topology","item":[{"name":"Get generic devices that are configured in ST","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/","description":"Returns a list of the generic devices included in all the domains that the user has permission to.
Use context and/or name optional parameters to get more specific results.
To get context optional parameter, you can call /domains/ API and use the id included within the returned domain DTO.

Parameters:
context: Global MSSP context [optional]
name: Generic device name [optional]

Usage Example
https://192.168.1.1/securetrack/api/generic_devices
"},"response":[]},{"name":"Add generic device to Topology model","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"configuration_file"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/","description":"Upload a configuration file that will be used to add a generic device to the Topology model.
The context field is the domain ID to which the generic device is added: If not provided, the device is added to the global domain.
configuration_file must include a valid generic device configuration.
The specified path must point to a file on the computer being sue to make the REST API call.
If update update_topology = true, then the Topology model will be updated immediately after the device is added.
For maximum efficiency, if you are adding multiple generic devices in consecutive API calls, you can set update_topology = false on all API calls except for the last one. On the last call, set update_toplogy = true.Default value for update_topology = true.
For more information on input file formats, refer to Knowledge Center topic 'Adding and Updating a Generic Device'.

Parameters:
body: Generic device to be added
configuration_file: Configuration File for generic device
update_topology: Synchronize And Update Topology [optional]

Usage Example
curl -X POST -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F 'device_data={\"generic_device\":{\"name\": \"my_generic_device\", \"customer_id\": 1}};type=application/json' -F \"configuration_file=@/tmp/config.txt;type=application/octet-stream\" -F \"update_topology=true\" https://192.168.1.1/securetrack/api/generic_devices\n

Response Messages:
201: The generic device was created successfully
403: User is not permitted to access the specified domain
400: Failed to create generic device "},"response":[]},{"name":"Get topology subnets","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/subnets","description":"Returns a list of the topology subnets for all the domains for which the user has permission to access.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
Use the optional name parameter to restrict the results to topology subnet names that match the search criteria provided, as follows:
1. If you provide only a mask, then an exact match search is done on the mask portion of the name
e.g. if name=/2, the results will include 1.2.3.4/2, but not 1.2.3.4/22
2. If you provide only a partial or complete IP address, then a contains search is done in the IPv4 block portion of the name
e.g. name=32, the results will include 192.168.205.32/24 and 55.192.32.22/16, but will not include 55.168.205.5/32
3. If you provide both an IPv4 address (either partial or complete) and a mask, then an exact match search is done
e.g. if name=23.4/2, then the results will include 192.168.23.4/2, but will not include 192.168.23.4/23 or 23.4.192.168/2

Use the optional ip parameter to restrict the results to topology subnets that contain this ip, see example below.

User can use ip or name parameter, not both.
The default pagination is start=0 and count=50.

Parameters:
context: Global MSSP context [optional]
name: Subnet name [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]
ip: Ip host [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/subnets?name=10.27
OUTPUT{
    \"topology_subnets\": {
        \"count\": 4,
        \"total\": 4,
        \"subnets\": [
            {
                \"id\": 615,
                \"name\": \"10.27.122.20/32\",
                \"ip\": \"10.27.122.20\",
                \"mask\": \"255.255.255.255\",
                \"domainIdTag\": 1
            },
            {
                \"id\": 616,
                \"name\": \"10.27.122.60/32\",
                \"ip\": \"10.27.122.60\",
                \"mask\": \"255.255.255.255\",
                \"domainIdTag\": 1
            },
            {
                \"id\": 619,
                \"name\": \"10.27.122.0/30\",
                \"ip\": \"10.27.122.0\",
                \"mask\": \"255.255.255.252\",
                \"domainIdTag\": 1
            },
            {
                \"id\": 620,
                \"name\": \"10.27.122.4/30\",
                \"ip\": \"10.27.122.4\",
                \"mask\": \"255.255.255.252\",
                \"domainIdTag\": 1
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/subnets?name=144/30
OUTPUT{
    \"topology_subnets\": {
        \"count\": 2,
        \"total\": 2,
        \"subnets\": [
            {
                \"id\": 773,
                \"name\": \"10.13.64.144/30\",
                \"ip\": \"10.13.64.144\",
                \"mask\": \"255.255.255.252\",
                \"domainIdTag\": 1
            },
            {
                \"id\": 825,
                \"name\": \"10.15.64.144/30\",
                \"ip\": \"10.15.64.144\",
                \"mask\": \"255.255.255.252\",
                \"domainIdTag\": 1
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/subnets?ip=10.27.122.3
OUTPUT{
    \"topology_subnets\": {
        \"count\": 4,
        \"total\": 4,
        \"subnets\": [
            {
                \"id\": 615,
                \"name\": \"10.27.122.0/24\",
                \"ip\": \"10.27.122.0\",
                \"mask\": \"255.255.255.0\",
                \"domainIdTag\": 1
            },
            {
                \"id\": 616,
                \"name\": \"10.27.0.0/16\",
                \"ip\": \"10.27.0.0\",
                \"mask\": \"255.255.0.0\",
                \"domainIdTag\": 1
            },
            {
                \"id\": 619,
                \"name\": \"10.0.0.0/8\",
                \"ip\": \"10.0.0.0\",
                \"mask\": \"255.0.0.0\",
                \"domainIdTag\": 1
            },
        ]
    }
}


Response Messages:
403: Access is denied
403: Only users with ‘Super admin’ permissions can access Global domain map
403: You do not have access permission to domain id: domainId
403: Using name and ip parameters is not allowed
403: Using Ipv6 in ip parameter is not supported
403: Ip parameter is not valid"},"response":[]},{"name":"Get topology generic VPN connections","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic_vpns{device_id:(/device_id)?}","protocol":"https","host":["{{SecureTrack_IP}}"],"path":["securetrack","api","topology","generic_vpns{device_id:(","device_id)"],"query":[{"key":"}","value":null}]},"description":"Returns a list of the generic vpn connections in the Topology map, for all the domains for which the user has permission to access.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
Use the optional name parameter to restrict the results to topology generic vpn connections that contain the specified string.
The default pagination is start=0 and count=50.

Parameters:
context: Global MSSP context [optional]
is_generic: Get generic devices [optional]
device_id: Device id [optional]
name: VPN connection name (accepts '*', '?' as wildcards) [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/generic_vpns
OUTPUT{
    \"generic_vpns\": {
        \"count\": 3,
        \"total\": 3,
        \"generic_vpn\": [
            {
                \"device_id\": 222,
                \"generic\": false,
                \"id\": 3,
                \"interface_name\": \"tunnel.2\",
                \"tunnel_dest_ip\": \"54.239.63.155\",
                \"tunnel_src_ip\": \"84.200.6.1\",
                \"vpn_name\": \"Palo_to_AWS\"
            },
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 4,
                \"interface_name\": \"tunnel.1\",
                \"tunnel_dest_ip\": \"54.239.63.156\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 5,
                \"interface_name\": \"tunnel.2\",
                \"tunnel_dest_ip\": \"54.239.63.157\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/generic_vpns?is_generic=true
OUTPUT{
    \"generic_vpns\": {
        \"count\": 2,
        \"total\": 2,
        \"generic_vpn\": [
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 4,
                \"interface_name\": \"tunnel.1\",
                \"tunnel_dest_ip\": \"54.239.63.156\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
            {
                \"device_id\": 13,
                \"generic\": true,
                \"id\": 5,
                \"interface_name\": \"tunnel.2\",
                \"tunnel_dest_ip\": \"54.239.63.157\",
                \"tunnel_src_ip\": \"84.200.66.1\",
                \"vpn_name\": \"Generic_to_AWS\"
            },
        ]
    }
}


Response Messages:
403: Access is denied
403: Only users with ‘Super admin’ permissions can access Global domain map
403: You do not have access permission to domain id: domainId
400: Wrong type provided - allowable values are: joined or non-joined"},"response":[]},{"name":"Get Cloud Internal Networks","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/cloud_internal_networks/{{id}}","description":"Returns the internal networks for the specified Cloud management id.
This API requires 'Super admin' privileges.

Parameters:
id: Cloud management id

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/cloud_internal_networks/20
OUTPUT{
    \"network_list\":
    {
        \"count\": 3,
        \"total\": 3,
        \"network\":
        {
            \"ip\": \"10.27.122.20\",
            \"mask\": \"255.255.255.255\"
        },
        \"network\":
        {
            \"ip\": \"10.27.122.60\",
            \"mask\": \"255.255.255.255\"
        },
        \"network\":
        {
            \"ip\": \"10.27.122.4\",
            \"mask\": \"255.255.255.252\"
        }
    }
}


Response Messages:
403: Access is denied
403: You do not have access permission to the domain for NSX with id ID
403: Device ID specified is not supported
404: The specified device ID was not found
404: The specified device ID was not found in Topology"},"response":[]},{"name":"Get most specific network interfaces from which a host IP is accessible","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"host"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/interfaces/last_hop","description":"Parameters:
context: Global MSSP context [optional]
host: IP address of device for a query

Usage Example
https://192.168.1.1/securetrack/api/devices/interfaces/last_hop?host=192.168.1.66
"},"response":[]},{"name":"Create generic Vpns","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"GenericVpns\": [\n\t{\n\t\t\"generic\": true,\n\t\t\"deviceId\": 3,\n\t\t\"interfaceName\": \"33\",\n\t\t\"vpnName\": null,\n\t\t\"tunnelSourceIpAddr\": \"3.3.3.33\",\n\t\t\"tunnelDestIpAddr\": \"1.1.1.11\"\n\t},\n\t{\n\t\t\"generic\": false,\n\t\t\"deviceId\": 1,\n\t\t\"interfaceName\": \"111\",\n\t\t\"vpnName\": null,\n\t\t\"tunnelSourceIpAddr\": \"1.1.1.11\",\n\t\t\"tunnelDestIpAddr\": \"3.3.3.33\"\n\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/","description":"Create generic Vpns.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/vpn
BODY{
    \"GenericVpns\": [
    {
        \"generic\": true,
        \"deviceId\": 3,
        \"interfaceName\": \"33\",
        \"vpnName\": null,
        \"tunnelSourceIpAddr\": \"3.3.3.33\",
        \"tunnelDestIpAddr\": \"1.1.1.11\"
    },
    {
        \"generic\": false,
        \"deviceId\": 1,
        \"interfaceName\": \"111\",
        \"vpnName\": null,
        \"tunnelSourceIpAddr\": \"1.1.1.11\",
        \"tunnelDestIpAddr\": \"3.3.3.33\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred."},"response":[]},{"name":"Update generic Vpns","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"GenericVpns\": [\n\t{\n\t\t\"id\": 24,\n\t\t\"generic\": true,\n\t\t\"deviceId\": 3,\n\t\t\"interfaceName\": \"new33\",\n\t\t\"vpnName\": null,\n\t\t\"tunnelSourceIpAddr\": \"3.3.3.33\",\n\t\t\"tunnelDestIpAddr\": \"1.1.1.11\"\n\t},\n\t{\n\t\t\"id\": 25,\n\t\t\"generic\": false,\n\t\t\"deviceId\": 1,\n\t\t\"interfaceName\": \"new111\",\n\t\t\"vpnName\": null,\n\t\t\"tunnelSourceIpAddr\": \"1.1.1.11\",\n\t\t\"tunnelDestIpAddr\": \"3.3.3.33\"\n\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/","description":"Update generic Vpns.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/vpn
BODY{
    \"GenericVpns\": [
    {
        \"id\": 24,
        \"generic\": true,
        \"deviceId\": 3,
        \"interfaceName\": \"new33\",
        \"vpnName\": null,
        \"tunnelSourceIpAddr\": \"3.3.3.33\",
        \"tunnelDestIpAddr\": \"1.1.1.11\"
    },
    {
        \"id\": 25,
        \"generic\": false,
        \"deviceId\": 1,
        \"interfaceName\": \"new111\",
        \"vpnName\": null,
        \"tunnelSourceIpAddr\": \"1.1.1.11\",
        \"tunnelDestIpAddr\": \"3.3.3.33\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Vpn/Management/GenericDevice Not Found.
500: General error occurred."},"response":[]},{"name":"Get Specific topology subnet","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/subnets/{{id}}","description":"Returns the subnet for the specified id, including information regarding attached devices and join candidates.
This API requires 'Super admin' or 'Multi-Domain admin' privileges.
Multi-Domain user must have access permission to the domain where the subnet resides.

Parameters:
id: Subnet id

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/subnets/20
OUTPUT{
    \"subnet\": {
        \"id\": 18,
        \"name\": \"90.0.0.0/24\",
        \"ip\": \"90.0.0.0\",
        \"mask\": \"255.255.255.0\",
        \"attached_devices\": {
            \"attached_device\": [
                {
                    \"is_generic\": false,
                    \"id\": 10,
                    \"name\": \"srx\",
                    \"interface_id\": 4,
                    \"interface_name\": \"eth0\",
                    \"interface_ip\": \"90.0.0.1\"
                },
                {
                    \"is_generic\": false,
                    \"id\": 13,
                    \"name\": \"ZBFW\",
                    \"interface_id\": 5,
                    \"interface_name\": \"eth1\",
                    \"interface_ip\": \"90.0.0.124\"
                },
                {
                    \"is_generic\": false,
                    \"id\": 85,
                    \"name\": \"netscreen\",
                    \"interface_id\": 6,
                    \"interface_name\": \"eth2\",
                    \"interface_ip\": \"90.0.0.50\"
                }
            ]
        },
        \"join_candidates\": {
            \"join_candidate\": {
                \"is_generic\": false,
                \"id\": 72,
                \"name\": \"CP25\",
                \"interface_id\": 14,
                \"interface_name\": \"eth24/1\",
                \"interface_ip\": \"90.0.0.83\"
            }
        }
    }
}


Response Messages:
403: Access is denied
403: You do not have access permission to the domain for subnet with id ID
404: No subnet was found for the provided ID"},"response":[]},{"name":"Create generic Routes","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"GenericRoutes\": [\n\t{\n\t\t\"mgmtId\": 1,\n\t\t\"destination\": \"111.100.10.11\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"interfaceName\": \"YOLO3\",\n\t\t\"nextHop\": \"100.100.10.10\",\n\t\t\"nextHopType\": \"IP\",\n\t\t\"vrf\": \"V103-KO\"\n\t},\n\t{\n\t\t\"mgmtId\": 2,\n\t\t\"destination\": \"222.100.10.22\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"interfaceName\": \"catch22\",\n\t\t\"nextHop\": \"100.100.10.10\",\n\t\t\"nextHopType\": \"IP\",\n\t\t\"vrf\": \"V103-KO\"\n\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/","description":"Create generic Routes.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/route
BODY{
    \"GenericRoutes\": [
    {
        \"mgmtId\": 1,
        \"destination\": \"111.100.10.11\",
        \"mask\": \"255.255.0.0\",
        \"interfaceName\": \"YOLO3\",
        \"nextHop\": \"100.100.10.10\",
        \"nextHopType\": \"IP\",
        \"vrf\": \"V103-KO\"
    },
    {
        \"mgmtId\": 2,
        \"destination\": \"222.100.10.22\",
        \"mask\": \"255.255.0.0\",
        \"interfaceName\": \"catch22\",
        \"nextHop\": \"100.100.10.10\",
        \"nextHopType\": \"IP\",
        \"vrf\": \"V103-KO\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management Not Found.
500: General error occurred."},"response":[]},{"name":"Update generic Routes","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"GenericRoutes\": [\n\t{\n\t\t\"id\": 29,\n\t\t\"mgmtId\": 3,\n\t\t\"destination\": \"111.100.10.11\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"interfaceName\": \"YOLO3\",\n\t\t\"nextHop\": \"100.100.10.10\",\n\t\t\"nextHopType\": \"IP\",\n\t\t\"vrf\": \"V103-KO\"\n\t},\n\t{\n\t\t\"id\": 30,\n\t\t\"mgmtId\": 3,\n\t\t\"destination\": \"222.100.10.22\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"interfaceName\": \"catch22\",\n\t\t\"nextHop\": \"100.100.10.10\",\n\t\t\"nextHopType\": \"IP\",\n\t\t\"vrf\": \"V103-KO\"\n\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/","description":"Update generic Routes.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/route
BODY{
    \"GenericRoutes\": [
    {
        \"id\": 29,
        \"mgmtId\": 3,
        \"destination\": \"111.100.10.11\",
        \"mask\": \"255.255.0.0\",
        \"interfaceName\": \"YOLO3\",
        \"nextHop\": \"100.100.10.10\",
        \"nextHopType\": \"IP\",
        \"vrf\": \"V103-KO\"
    },
    {
        \"id\": 30,
        \"mgmtId\": 3,
        \"destination\": \"222.100.10.22\",
        \"mask\": \"255.255.0.0\",
        \"interfaceName\": \"catch22\",
        \"nextHop\": \"100.100.10.10\",
        \"nextHopType\": \"IP\",
        \"vrf\": \"V103-KO\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Interface/Management Not Found.
500: General error occurred."},"response":[]},{"name":"Get cloud information","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"suggested_clouds\": {\n\t\t\"count\": 2,\n\t\t\"total\": 2,\n\t\t\"cloud\": [\n\t\t\t{\n\t\t\t\t\"management_name\": \"FW1\",\n\t\t\t\t\"management_id\": 20,\n\t\t\t\t\"cloud_name\": \"Cloud 10.100.0.1\",\n\t\t\t\t\"cloud_id\": 120,\n\t\t\t\t\"vertex_id\": 250,\n\t\t\t\t\"ip\": \"10.100.0.1\",\n\t\t\t\t\"routes_count\": 5,\n\t\t\t\t\"is_parent\": false\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"management_name\": \"FW2\",\n\t\t\t\t\"management_id\": 21,\n\t\t\t\t\"cloud_name\": \"Cloud 172.16.0.1\",\n\t\t\t\t\"cloud_id\": 125,\n\t\t\t\t\"vertex_id\": 270,\n\t\t\t\t\"ip\": \"172.16.0.1\",\n\t\t\t\t\"routes_count\": 7,\n\t\t\t\t\"is_parent\": false,\n\t\t\t\t\"parent_vertex_id\": 40\n\t\t\t\t\"parent_cloud_id\": 45\n\t\t\t\t\"parent_cloud_name\": \"Cloud 172.16.0.1\",\n\t\t\t}\n\t\t]\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/cloud_suggestions","description":"Returns information about all clouds in the topology.
This API includes the ID of the cloud, the number of routes that point to the cloud, and the relevant devices (including the management_id) that have routes that point to the cloud.
This information can be used to identify missing devices that may need to be added to the topology or to identify clouds that are candidates for being joined.

Parameters:
context: Global MSSP context [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/cloud_suggestions
BODY{
    \"suggested_clouds\": {
        \"count\": 2,
        \"total\": 2,
        \"cloud\": [
            {
                \"management_name\": \"FW1\",
                \"management_id\": 20,
                \"cloud_name\": \"Cloud 10.100.0.1\",
                \"cloud_id\": 120,
                \"vertex_id\": 250,
                \"ip\": \"10.100.0.1\",
                \"routes_count\": 5,
                \"is_parent\": false
            },
            {
                \"management_name\": \"FW2\",
                \"management_id\": 21,
                \"cloud_name\": \"Cloud 172.16.0.1\",
                \"cloud_id\": 125,
                \"vertex_id\": 270,
                \"ip\": \"172.16.0.1\",
                \"routes_count\": 7,
                \"is_parent\": false,
                \"parent_vertex_id\": 40
                \"parent_cloud_id\": 45
                \"parent_cloud_name\": \"Cloud 172.16.0.1\",
            }
        ]
    }
}


Response Messages:
202: Accepted
403: User is not permitted to access the specified domain"},"response":[]},{"name":"Update an existing generic device in the Topology model","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/{{id}}","description":"Modify an existing generic device by uploading a new configuration file and/or specifying a new name.
If name field is specified, the generic device will be renamed.
configuration_file is optional, if provided it must include a valid generic device configuration.
The specified path points to a file in the client machine.
If a generic device name is changed and a new configuration file is not provided, topology will not be synchronized (update_topology flag is ignored).
Default value for update_topology = true.
To save time when there are several consecutive api calls: For the last call, set update_topology = true (for all other calls, update_topology = false).
For more information on input file formats, refer to Knowledge Center topic 'Adding and Updating a Generic Device'.

Parameters:
id: Generic device id
body: Generic device to be updated [optional]
configuration_file: Configuration File for generic device [optional]
update_topology: Synchronize And Update Topology [optional]

Usage Example
curl -X PUT -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F \"configuration_file=@/tmp/config.txt;type=application/octet-stream\" -F \"update_topology=true\" https://192.168.1.1/securetrack/api/generic_devices/24

Usage Example
curl -X PUT -u user:password -H \"Content-Type: multipart/form-data\" --tlsv1 -L -k1 --http1.0 -F 'device_data={\"generic_device\":{\"name\": \"new_generic_device_name\"}};type=application/json' -F \"update_topology=false\" https://192.168.1.1/securetrack/api/generic_devices/72

Response Messages:
204: The generic device was updated successfully.
400: A new name or a new configuration file must be indicated in order to update generic device with id {}
400: Failed to update generic device with id {}
404: A 'Generic Device' with the specified ID was not found"},"response":[]},{"name":"Delete generic device from Topology model","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/generic_devices/{{id}}","description":"Delete a generic device from the Topology model.
The ID must be for a valid generic device listed in the Topology Model.
If update update_topology = true, then the Topology model will be updated immediately after the device is deleted.
For maximum efficiency, if you are deleting multiple generic devices in consecutive API calls, you can set update_topology = false on all API calls except for the last one. On the last call, set update_toplogy = true.
Default value for update_topology = true.

Parameters:
id: Generic device id
update_topology: Synchronize And Update Topology [optional]

Usage Example
https://192.168.1.1/securetrack/api/generic_devices/1

Usage Example
https://192.168.1.1/securetrack/api/generic_devices/10?update_topology=false

Response Messages:
204: Generic Device deleted successfully.
400: Failed to delete generic device with id {}
404: A 'Generic Device' with the specified ID was not found"},"response":[]},{"name":"Get path image for specified traffic","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"src"},{"value":null,"type":"text","key":"dst"},{"value":null,"type":"text","key":"service"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/path_image","description":"Returns an image containing one or more paths for the specified traffic.
src and dst parameters may contain multiple, comma separated values.
Service parameter can be a port (for example, “tcp:80”, “any”) or an application (for example, “Skype”, “Facebook”).
Application names are case sensitive.
Service parameter can also be a combination of ports and applications, for example “tcp:80, Skype, Facebook”
If sourceDomainIdTag is provided, the path starting points will be restricted to the specified domain ID. sourceDomainIdTag is valid only if overlapping IP mode is enabled.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is valid only if MSSP mode is enabled.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.
displayIncompletePaths parameter default value is false, if this parameter is set to true -
all nodes on the path will be displayed, even if the node cannot reach the destination, or if the source and destination are the same.
displayBlockedStatus parameter default value is false, if this parameter is set to true -
blocked traffic icons will be displayed next to devices blocking the traffic.
simulateNat parameter default value is true if this parameter is set to false - NAT simulation will not be used when calculating the path.
lastInstall parameter default value is true, which means simulation would use last installed policies. If this parameter is set to false - simulation would use last saved policies.
This API cannot be executed more than 10 times in parallel.

Parameters:
context: Global MSSP context [optional]
src: Source address/addresses
dst: Destination address/addresses
service: Service/services
sourceDomainIdTag: Path starting point Domain Id [optional]
displayIncompletePaths: Display incomplete paths [optional]
displayBlockedStatus: Display blocked traffic status icons [optional]
simulateNat: Simulate NAT [optional]
lastInstall: Last Installed [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/path_image?src=10.10.10.1&dst=3.3.3.3:32&service=any

Usage Example
https://192.168.1.1/securetrack/api/topology/path_image?src=10.10.10.1&dst=3.3.3.3:32&service=Facebook,tcp:80

Usage Example
https://192.168.1.1/securetrack/api/topology/path_image?src=netobj:422:GW_123.120&dst=netobj:483:uni/tn-common/out-CommonL3Out/lnodep-LNP&service=any
"},"response":[]},{"name":"Get generic Route","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/{{routeId}}","description":"Get a generic Route by Id.

Parameters:
routeId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/route/30
OUTPUT{
    GenericRoute: {
        id: 30,
        mgmtId: 2,
        destination: \"222.100.10.22\",
        mask: \"255.255.0.0\",
        interfaceName: \"catch22\",
        nextHop: \"100.100.10.10\",
        nextHopType: \"IP\",
        vrf: \"V102-YO\"
    }
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Generic Route Not Found.
500: General error occurred."},"response":[]},{"name":"Delete generic Route","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/{{routeId}}","description":"Delete a generic Route by Id.

Parameters:
routeId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/route/5\n

Response Messages:
204: No Content.
400: Bad Request.
403: Access is denied.
404: Generic Route Not Found.
500: General error occurred."},"response":[]},{"name":"Create generic Interfaces","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"GenericInterfaces\": [\n\t{\n\t\t\"mgmtId\": 1,\n\t\t\"name\": \"Bob1\",\n\t\t\"ip\": \"100.100.45.55\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"vrf\": \"V101-PA\",\n\t\t\"mpls\": false,\n\t\t\"unnumbered\": false,\n\t\t\"type\": \"external\"\n\t},\n\t{\n\t\t\"mgmtId\": 2,\n\t\t\"name\": \"Bob2\",\n\t\t\"ip\": \"100.100.45.66\",\n\t\t\"mask\": \"255.255.255.0\",\n\t\t\"vrf\": \"V101-BA\",\n\t\t\"mpls\": false,\n\t\t\"unnumbered\": false,\n\t\t\"type\": \"external\"\n\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface","description":"Create generic Interfaces.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interface
BODY{
    \"GenericInterfaces\": [
    {
        \"mgmtId\": 1,
        \"name\": \"Bob1\",
        \"ip\": \"100.100.45.55\",
        \"mask\": \"255.255.0.0\",
        \"vrf\": \"V101-PA\",
        \"mpls\": false,
        \"unnumbered\": false,
        \"type\": \"external\"
    },
    {
        \"mgmtId\": 2,
        \"name\": \"Bob2\",
        \"ip\": \"100.100.45.66\",
        \"mask\": \"255.255.255.0\",
        \"vrf\": \"V101-BA\",
        \"mpls\": false,
        \"unnumbered\": false,
        \"type\": \"external\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management Not Found.
500: General error occurred."},"response":[]},{"name":"Update generic Interfaces","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"GenericInterfaces\": [\n\t{\n\t\t\"id\": 204,\n\t\t\"mgmtId\": 1,\n\t\t\"name\": \"NewBob1\",\n\t\t\"ip\": \"100.100.45.55\",\n\t\t\"mask\": \"255.255.0.0\",\n\t\t\"vrf\": \"V101-LV\",\n\t\t\"mpls\": false,\n\t\t\"unnumbered\": false,\n\t\t\"type\": null\n\t},\n\t{\n\t\t\"id\": 205,\n\t\t\"mgmtId\": 2,\n\t\t\"name\": \"NewBob2\",\n\t\t\"ip\": \"100.100.45.55\",\n\t\t\"mask\": \"255.255.255.0\",\n\t\t\"vrf\": \"V101-LV\",\n\t\t\"mpls\": false,\n\t\t\"unnumbered\": false,\n\t\t\"type\": \"external\"\n\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface","description":"Update generic Interfaces.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interface
BODY{
    \"GenericInterfaces\": [
    {
        \"id\": 204,
        \"mgmtId\": 1,
        \"name\": \"NewBob1\",
        \"ip\": \"100.100.45.55\",
        \"mask\": \"255.255.0.0\",
        \"vrf\": \"V101-LV\",
        \"mpls\": false,
        \"unnumbered\": false,
        \"type\": null
    },
    {
        \"id\": 205,
        \"mgmtId\": 2,
        \"name\": \"NewBob2\",
        \"ip\": \"100.100.45.55\",
        \"mask\": \"255.255.255.0\",
        \"vrf\": \"V101-LV\",
        \"mpls\": false,
        \"unnumbered\": false,
        \"type\": \"external\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Interface/Management Not Found.
500: General error occurred."},"response":[]},{"name":"Delete generic Interfaces","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface/mgmt/{{mgmtId}}","description":"Delete all generic Interfaces from management Id.

Parameters:
mgmtId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/interface/mgmt/2\n

Response Messages:
200: 11 Generic Interfaces were deleted from mgmtId 2.
400: Bad Request.
403: Access is denied.
404: Management Not Found.
500: General error occurred."},"response":[]},{"name":"Get generic Interfaces","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface/mgmt/{{mgmtId}}","description":"Get generic Interfaces of management Id.

Parameters:
mgmtId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interface/mgmt/1
OUTPUT{
    GenericInterfaces: [
    {
        id: 206,
        mgmtId: 1,
        name: \"newApo3\",
        ip: \"100.103.33.33\",
        mask: \"255.255.255.0\",
        vrf: \"V101-PA\",
        mpls: false,
        unnumbered: false,
        type: \"external\"
    },
    {
        id: 208,
        mgmtId: 1,
        name: \"newApo4\",
        ip: \"100.103.33.34\",
        mask: \"255.255.255.0\",
        vrf: \"V101-PA\",
        mpls: false,
        unnumbered: false,
        type: \"internal\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management Not Found.
500: General error occurred."},"response":[]},{"name":"Get generic Interface","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface/{{inId}}","description":"Get a generic Interface by Id.

Parameters:
inId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interface/212
OUTPUT{
    GenericInterface: {
        id: 212,
        mgmtId: 1,
        name: \"newApo5\",
        ip: \"100.103.33.33\",
        mask: \"255.255.255.0\",
        vrf: \"V101-PAL\",
        mpls: false,
        unnumbered: false,
        type: \"external\"
    }
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Generic Interface Not Found.
500: General error occurred."},"response":[]},{"name":"Delete generic Interface","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interface/{{inId}}","description":"Delete a generic Interface by Id.

Parameters:
inId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/interface/5\n

Response Messages:
204: No Content.
400: Bad Request.
403: Access is denied.
404: Generic Interface Not Found.
500: General error occurred."},"response":[]},{"name":"Update a cloud","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"cloud_data\":{\n\t\t\"cloud_name\" : \"new cloud\",\n\t\t\"cloud_members\" : [118,179,258]\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds/{{id}}","description":"Modify the name of a topology cloud, and add/remove members of a joined cloud.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
Multi-Domain user must have access permission to the domain context of the joined cloud, and any members specified in the body.
To change the name of a topology cloud, enter a value in the name field of the body.
To add/remove members of a joined cloud, specify the action and specify the clouds in the members list of the body.
The action is used only if the body contains a members list. If a members list is provided but no actions is specified, then the default action is ‘add’.
When adding cloud members, clouds included in the members list of the body must not be joined clouds or members of another joined cloud.
When removing cloud members, if only zero or one member remains in the joined cloud, it will be deleted from the Interactive Map.

Parameters:
id: cloud id
action: action [optional]
body: Cloud data
forceTopologyInit: Force Topology Init [optional]

Usage Example
URLfor renaming of any cloud - https://192.168.1.1/securetrack/api/topology/clouds/436
BODY{
    \"cloud_data\":{
        \"cloud_name\" : \"new cloud\"
    }
}


Usage Example
URLfor renaming and members updating of a joined cloud - https://192.168.1.1/securetrack/api/topology/clouds/436?action=remove
BODY{
    \"cloud_data\":{
        \"cloud_name\" : \"new cloud\",
        \"cloud_members\" : [118,179,258]
    }
}


Response Messages:
204: Cloud updated successfully
403: Access is denied
403: You do not have access permission to the domain for cloud with id ID
404: Cloud with id ID was not found in the provided MSSP domain
412: Cloud with id ID is a not joined cloud
412: Cloud id: cloudId does not belong to domain: Context
412: Provided clouds don't belongs to the same domain
412: Cloud with id ID is a joined cloud
412: Cloud with id ID is a member of a joined cloud
412: Member cloud with id ID cannot be removed - it is not a member of a joined cloud"},"response":[]},{"name":"Get Specific topology cloud","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds/{{id}}","description":"Returns the topology cloud data for the specified id.
This API requires 'Super admin' or 'Multi-Domain admin' privileges.
Multi-Domain user must have access permission to the domain where the cloud resides.

Parameters:
id: Cloud id

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds/48
OUTPUT{
    \"topology_cloud\": {
        \"id\": 48,
        \"name\": \"Cloud 69.70.120.155\",
        \"domain\": 1,
        \"type\": \"NON_JOINED\",
        \"ip\": \"69.70.120.155\"
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds/66
OUTPUT{
    \"topology_cloud\": {
        \"id\": 66,
        \"name\": \"Cloud 10.100.10.14\",
        \"domain\": 1,
        \"type\": \"JOINED\",
        \"members\": [
            {
                \"id\": 50,
                \"ip\": \"10.100.6.238\",
                \"name\": \"Cloud 10.100.6.238\"
            },
            {
                \"id\": 73,
                \"ip\": \"10.100.10.14\",
                \"name\": \"Cloud 10.100.10.14\"
            },
            {
                \"id\": 74,
                \"ip\": \"10.100.9.9\",
                \"name\": \"Cloud 10.100.9.9\"
            }
        ]
    }
}


Response Messages:
403: Access is denied
403: You do not have access permission to the domain for cloud with id ID
404: No cloud was found for the provided ID"},"response":[]},{"name":"Get generic Routes","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/mgmt/{{mgmtId}}","description":"Get generic Routes of management Id.

Parameters:
mgmtId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/route/mgmt/2
OUTPUT{
    GenericRoutes: [
    {
        id: 27,
        mgmtId: 2,
        destination: \"10.4.4.4\",
        mask: \"255.0.0.0\",
        interfaceName: \"\",
        nextHop: \"AA\",
        nextHopType: \"VR\",
        vrf: \"V102-YO\"
    },
    {
        id: 28,
        mgmtId: 2,
        destination: \"10.4.5.5\",
        mask: \"255.0.0.0\",
        interfaceName: \"eeee\",
        nextHop: \"\",
        nextHopType: \"IP\",
        vrf: \"V101-PA\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management Not Found.
500: General error occurred."},"response":[]},{"name":"Delete generic Routes","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/route/mgmt/{{mgmtId}}","description":"Delete all generic Routes from management Id.

Parameters:
mgmtId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/route/mgmt/2\n

Response Messages:
200: 11 Generic Routes were deleted from mgmtId 2.
400: Bad Request.
403: Access is denied.
404: Management Not Found.
500: General error occurred."},"response":[]},{"name":"Get path domains for specified traffic","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"src"},{"value":null,"type":"text","key":"dst"},{"value":null,"type":"text","key":"service"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/path_domains","description":"Returns one or more domain entries for the specified traffic.
src and dst parameters may contain multiple, comma separated values.
Service parameter can be a port (for example, “tcp:80”, “any”) or an application (for example, “Skype”, “Facebook”).
Application names are case sensitive.
Service parameter can also be a combination of ports and applications, for example “tcp:80, Skype, Facebook”
If sourceDomainIdTag is provided, the path starting points will be restricted to the specified domain ID. sourceDomainIdTag is valid only if overlapping IP mode is enabled.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is valid only if MSSP mode is enabled.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.
includeIncompletePaths parameter default value is false, if this parameter is set to true -
all nodes on the path will be included, even if the node cannot reach the destination, or if the source and destination are the same.
simulateNat parameter default value is true if this parameter is set to false - NAT simulation will not be used when calculating the path.
lastInstall parameter default value is true, which means simulation would use last installed policies. If this parameter is set to false - simulation would use last saved policies.
This API cannot be executed more than 10 times in parallel.

Parameters:
context: Global MSSP context [optional]
src: Source address/addresses
dst: Destination address/addresses
service: Service/services
sourceDomainIdTag: Path starting point Domain Id [optional]
includeIncompletePaths: Include incomplete paths [optional]
simulateNat: Simulate NAT [optional]
lastInstall: Last Installed [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/path_domains?src=10.10.10.1&dst=3.3.3.3:32&service=any

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/path_domains?src=10.0.2.1&dst=10.0.1.1&service=Facebook,tcp:80
OUTPUT {
    \"path_domain_entries\": {
        \"path_domain_entry\": [
                {
                        \"domainId\": \"1\",
                        \"vertex\": \"Subnet 10.0.2.0/24\",
                        \"entryType\": \"STARTING_POINT\",
                }
                {
                        \"domainId\": \"1\",
                        \"vertex\": \"Subnet 10.0.1.0/24\",
                        \"entryType\": \"ENDING_POINT\",
                }
    ]
}

"},"response":[]},{"name":"Update manual Interface CustomerTags","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"InterfaceCustomerTags\": \n\t[\n\t\t{\n\t\t\t\"id\": 73,\n\t\t\t\"generic\": false,\n\t\t\t\"deviceId\": 5,\n\t\t\t\"interfaceName\": \"port5\",\n\t\t\t\"customerId\": 2\n\t\t},\n\t\t{\n\t\t\t\"id\": 74,\n\t\t\t\"generic\": false,\n\t\t\t\"deviceId\": 5,\n\t\t\t\"interfaceName\": \"port3\",\n\t\t\t\"customerId\": 3\n\t\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/","description":"Update manual Interface CustomerTags.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interfacecustomer
BODY{
    \"InterfaceCustomerTags\":
    [
        {
            \"id\": 73,
            \"generic\": false,
            \"deviceId\": 5,
            \"interfaceName\": \"port5\",
            \"customerId\": 2
        },
        {
            \"id\": 74,
            \"generic\": false,
            \"deviceId\": 5,
            \"interfaceName\": \"port3\",
            \"customerId\": 3
        }
    ]
}


Response Messages:
200: OK.
400: Interface CustomerTag already exist for deviceId-InterfaceName/Interface not found on deviceId
403: Access is denied.
404: Management/GenericDevice Not Found./Customer Id not found.
500: General error occurred."},"response":[]},{"name":"Create manual Interface CustomerTags","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"InterfaceCustomerTags\": \n\t[\n\t\t{\n\t\t\t\"generic\": false,\n\t\t\t\"deviceId\": 5,\n\t\t\t\"interfaceName\": \"port4\",\n\t\t\t\"customerId\": 2\n\t\t},\n\t\t{\n\t\t\t\"generic\": false,\n\t\t\t\"deviceId\": 6,\n\t\t\t\"interfaceName\": \"port3\",\n\t\t\t\"customerId\": 3\n\t\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/","description":"Create manual Interface CustomerTags.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interfacecustomer
BODY{
    \"InterfaceCustomerTags\":
    [
        {
            \"generic\": false,
            \"deviceId\": 5,
            \"interfaceName\": \"port4\",
            \"customerId\": 2
        },
        {
            \"generic\": false,
            \"deviceId\": 6,
            \"interfaceName\": \"port3\",
            \"customerId\": 3
        }
    ]
}


Response Messages:
200: OK.
400: Interface CustomerTag already exist for deviceId-InterfaceName/Interface not found on deviceId
403: Access is denied.
404: Management/GenericDevice Not Found./Customer Id not found.
500: General error occurred."},"response":[]},{"name":"Delete Transparent Firewall","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw/{{layer2DataId}}","description":"Delete Transparent Firewall by Id.

Parameters:
layer2DataId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/transparentfw/17\n

Response Messages:
200: layer2DataId 17 deleted.
400: Bad Request.
403: Access is denied.
404: Layer2Data Id 17 not found.
500: General error occurred."},"response":[]},{"name":"Delete Ignored Interfaces.","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/ignoredinterface/mgmt/{{mgmtId}}","description":"Delete Ignored Interfaces by management id.

Parameters:
mgmtId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/ignoredinterface/mgmt/10\n

Response Messages:
200: 2 entries deleted where mgmtId = 10
400: Bad Request.
403: Access is denied.
404: Management Id 10 not found.
500: General error occurred."},"response":[]},{"name":"Get Ignored Interfaces.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/ignoredinterface/mgmt/{{mgmtId}}","description":"Get Ignored Interfaces by management id.

Parameters:
mgmtId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/ignoredinterface/mgmt/10
OUTPUT{
    IgnoredInterfaces: [
        {
            interfaceName: \"eth2\",
            mgmtId: 10,
            ip: \"0.0.0.0\"
        },
        {
            interfaceName: \"loopback100\",
            mgmtId: 10,
            ip: \"34.34.34.34\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
500: General error occurred."},"response":[]},{"name":"Delete manual Interface CustomerTags","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/device/{{deviceId}}","description":"Delete all manual Interface CustomerTags from management/genericDevice Id.

Parameters:
deviceId [optional]
generic [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/interfacecustomer/device/6?generic=false\n

Response Messages:
200: 2 Interface Customers were deleted from deviceId 6.
400: Bad Request.
403: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred."},"response":[]},{"name":"Get manual Interface CustomerTags","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/device/{{deviceId}}","description":"Get manual Interface CustomerTags of management/genericDevice Id.

Parameters:
deviceId [optional]
generic [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interfacecustomer/device/5?generic=false
OUTPUT{
    InterfaceCustomerTags: [
        {
            id: 73,
            generic: false,
            deviceId: 5,
            interfaceName: \"port4\",
            customerId: 2
        },
        {
            id: 74,
            generic: false,
            deviceId: 5,
            interfaceName: \"port4.1\",
            customerId: 3
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred."},"response":[]},{"name":"Create Transparent Firewalls","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"TransparentFirewalls\": \n\t[\n\t {\n\t\t\t\"outputL3DeviceId\" : 22,\n\t\t\t\"outputL3IsGenericDevice\" : false,\n\t\t\t\"outputL3InterfaceName\" : \"FastEthernet0/0\",\n\t\t\t\"outputL3InterfaceIp\" : \"\",\n\t\t\t\"layer2DeviceId\" : 21,\n\t\t\t\"inputL2InterfaceName\" : \"inside\",\n\t\t\t\"outputL2InterfaceName\" : \"outside\",\n\t\t\t\"inputL3DeviceId\" : 20,\n\t\t\t\"inputL3IsGenericDevice\" : false,\n\t\t\t\"inputL3InterfaceName\" : \"Loopback0\",\n\t\t\t\"inputL3InterfaceIp\" : \"\"\n\t\t},\n\t\t{\n\t\t\t\"outputL3DeviceId\" : 23,\n\t\t\t\"outputL3IsGenericDevice\" : false,\n\t\t\t\"outputL3InterfaceName\" : \"FastEthernet2/0\",\n\t\t\t\"outputL3InterfaceIp\" : \"\",\n\t\t\t\"layer2DeviceId\" : 9,\n\t\t\t\"inputL2InterfaceName\" : \"inside\",\n\t\t\t\"outputL2InterfaceName\" : \"outside\",\n\t\t\t\"inputL3DeviceId\" : 17,\n\t\t\t\"inputL3IsGenericDevice\" : false,\n\t\t\t\"inputL3InterfaceName\" : \"mgmt\",\n\t\t\t\"inputL3InterfaceIp\" : \"\"\n\t\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw","description":"Create Transparent Firewalls.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/transparentfw
BODY{
    \"TransparentFirewalls\":
    [
     {
            \"outputL3DeviceId\" : 22,
            \"outputL3IsGenericDevice\" : false,
            \"outputL3InterfaceName\" : \"FastEthernet0/0\",
            \"outputL3InterfaceIp\" : \"\",
            \"layer2DeviceId\" : 21,
            \"inputL2InterfaceName\" : \"inside\",
            \"outputL2InterfaceName\" : \"outside\",
            \"inputL3DeviceId\" : 20,
            \"inputL3IsGenericDevice\" : false,
            \"inputL3InterfaceName\" : \"Loopback0\",
            \"inputL3InterfaceIp\" : \"\"
        },
        {
            \"outputL3DeviceId\" : 23,
            \"outputL3IsGenericDevice\" : false,
            \"outputL3InterfaceName\" : \"FastEthernet2/0\",
            \"outputL3InterfaceIp\" : \"\",
            \"layer2DeviceId\" : 9,
            \"inputL2InterfaceName\" : \"inside\",
            \"outputL2InterfaceName\" : \"outside\",
            \"inputL3DeviceId\" : 17,
            \"inputL3IsGenericDevice\" : false,
            \"inputL3InterfaceName\" : \"mgmt\",
            \"inputL3InterfaceIp\" : \"\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Device Id 23 not found.
500: General error occurred."},"response":[]},{"name":"Update Transparent Firewalls","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"TransparentFirewalls\": \n\t[\n\t {\n\t\t\t\"id\" : 25,\n\t\t\t\"outputL3DeviceId\" : 22,\n\t\t\t\"outputL3IsGenericDevice\" : false,\n\t\t\t\"outputL3InterfaceName\" : \"FastEthernet0/0\",\n\t\t\t\"outputL3InterfaceIp\" : \"\",\n\t\t\t\"layer2DeviceId\" : 21,\n\t\t\t\"inputL2InterfaceName\" : \"inside\",\n\t\t\t\"outputL2InterfaceName\" : \"outside\",\n\t\t\t\"inputL3DeviceId\" : 20,\n\t\t\t\"inputL3IsGenericDevice\" : false,\n\t\t\t\"inputL3InterfaceName\" : \"Loopback2\",\n\t\t\t\"inputL3InterfaceIp\" : \"\"\n\t\t},\n\t\t{\n\t\t\t\"id\" : 27,\n\t\t\t\"outputL3DeviceId\" : 23,\n\t\t\t\"outputL3IsGenericDevice\" : false,\n\t\t\t\"outputL3InterfaceName\" : \"FastEthernet2/0\",\n\t\t\t\"outputL3InterfaceIp\" : \"\",\n\t\t\t\"layer2DeviceId\" : 9,\n\t\t\t\"inputL2InterfaceName\" : \"inside\",\n\t\t\t\"outputL2InterfaceName\" : \"outside\",\n\t\t\t\"inputL3DeviceId\" : 17,\n\t\t\t\"inputL3IsGenericDevice\" : false,\n\t\t\t\"inputL3InterfaceName\" : \"mgmt2\",\n\t\t\t\"inputL3InterfaceIp\" : \"\"\n\t\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw","description":"Update Transparent Firewalls.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/transparentfw
BODY{
    \"TransparentFirewalls\":
    [
     {
            \"id\" : 25,
            \"outputL3DeviceId\" : 22,
            \"outputL3IsGenericDevice\" : false,
            \"outputL3InterfaceName\" : \"FastEthernet0/0\",
            \"outputL3InterfaceIp\" : \"\",
            \"layer2DeviceId\" : 21,
            \"inputL2InterfaceName\" : \"inside\",
            \"outputL2InterfaceName\" : \"outside\",
            \"inputL3DeviceId\" : 20,
            \"inputL3IsGenericDevice\" : false,
            \"inputL3InterfaceName\" : \"Loopback2\",
            \"inputL3InterfaceIp\" : \"\"
        },
        {
            \"id\" : 27,
            \"outputL3DeviceId\" : 23,
            \"outputL3IsGenericDevice\" : false,
            \"outputL3InterfaceName\" : \"FastEthernet2/0\",
            \"outputL3InterfaceIp\" : \"\",
            \"layer2DeviceId\" : 9,
            \"inputL2InterfaceName\" : \"inside\",
            \"outputL2InterfaceName\" : \"outside\",
            \"inputL3DeviceId\" : 17,
            \"inputL3IsGenericDevice\" : false,
            \"inputL3InterfaceName\" : \"mgmt2\",
            \"inputL3InterfaceIp\" : \"\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Device Id 23 not found.
500: General error occurred."},"response":[]},{"name":"Create Ignored Interfaces.","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"IgnoredInterfaces\": \n\t[\n\t\t{\n\t\t\t\"interfaceName\" : \"eth2\",\n\t\t\t\"mgmtId\" : 10,\n\t\t\t\"ip\" : \"0.0.0.0\"\n\t\t},\n\t\t{\n\t\t\t\"interfaceName\" : \"loopback100\",\n\t\t\t\"mgmtId\" : 10,\n\t\t\t\"ip\" : \"34.34.34.34\"\n\t\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/ignoredinterface","description":"Create Ignored Interfaces.

Parameters:
body [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/ignoredinterface
BODY{
    \"IgnoredInterfaces\":
    [
        {
            \"interfaceName\" : \"eth2\",
            \"mgmtId\" : 10,
            \"ip\" : \"0.0.0.0\"
        },
        {
            \"interfaceName\" : \"loopback100\",
            \"mgmtId\" : 10,
            \"ip\" : \"34.34.34.34\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management Id 10 not found.
500: General error occurred."},"response":[]},{"name":"Delete manual Interface CustomerTag","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/{{interfaceCustomerId}}","description":"Delete a manual Interface CustomerTag by Id.

Parameters:
interfaceCustomerId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/interfacecustomer/66\n

Response Messages:
204: No Content.
400: Bad Request.
403: Access is denied.
404: InterfaceCustomer Id 66 not found
500: General error occurred."},"response":[]},{"name":"Get manual Interface CustomerTag","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/interfacecustomer/{{interfaceCustomerId}}","description":"Get manual Interface CustomerTag by Id.

Parameters:
interfaceCustomerId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/interfacecustomer/74
OUTPUT{
    InterfaceCustomerTag: {
        id: 74,
        generic: false,
        deviceId: 5,
        interfaceName: \"port4.1\",
        customerId: 3
    }
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: InterfaceCustomer Id 74 not found.
500: General error occurred."},"response":[]},{"name":"Get topology routing tables for a given device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"mgmtId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/topology_routes","description":"The returned routing tables are taken from the topology data and will include only devices that are topology enabled.
When adding a device, the user can can choose whether to use dynamic or static topology for the device,
this choice will determine which kind of data is stored in the topology graph and returned by this API.

The parameter mgmtId should be a cluster or a gateway, not a management server.
You may provide a generic device Id (see generic_devices API under 'Monitored Devices' category) -
in this case make sure you set 'is_generic' parameter to 'true'

Parameters:
mgmtId: Management Id or Generic Device Id to query
is_generic: Should be set to 'true' if the provided mgmtId is related to generic device [optional]
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query from starting page, allowable type is numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_routes?mgmtId=10

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_routes?mgmtId=1&is_generic=true
"},"response":[]},{"name":"Get topology network interfaces by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"mgmtId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/topology_interfaces","description":"The returned interfaces are taken from the topology data and will include only devices that are topology enabled.
When adding a device, the user can can choose whether to use dynamic or static topology for the device,
this choice will determine which kind of data is stored in the topology graph and returned by this API.

The parameter mgmtId should be a cluster or a gateway, not a management server.
You may provide a generic device Id (see generic_devices API under 'Monitored Devices' category) -
in this case make sure you set 'is_generic' parameter to 'true'

Parameters:
context: Global MSSP context [optional]
mgmtId: Management Id or Generic Device Id to query
is_generic: Should be set to 'true' if the provided mgmtId is related to generic device [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_interfaces?mgmtId=10

Usage Example
https://192.168.1.1/securetrack/api/devices/topology_interfaces?mgmtId=1&is_generic=true
"},"response":[]},{"name":"Get path for specified traffic","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"src"},{"value":null,"type":"text","key":"dst"},{"value":null,"type":"text","key":"service"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/path","description":"Returns one or more paths for the specified traffic.
src and dst parameters may contain multiple, comma separated values.
Service parameter can be a port (for example, “tcp:80”, “any”) or an application (for example, “Skype”, “Facebook”).
Application names are case sensitive.
Service parameter can also be a combination of ports and applications, for example “tcp:80, Skype, Facebook”
If sourceDomainIdTag is provided, the path starting points will be restricted to the specified domain ID. sourceDomainIdTag is valid only if overlapping IP mode is enabled.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is valid only if MSSP mode is enabled.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.
includeIncompletePaths parameter default value is false, if this parameter is set to true -
all nodes on the path will be included, even if the node cannot reach the destination, or if the source and destination are the same.
simulateNat parameter default value is true if this parameter is set to false - NAT simulation will not be used when calculating the path.
lastInstall parameter default value is true, which means simulation would use last installed policies. If this parameter is set to false - simulation would use last saved policies.
This API cannot be executed more than 10 times in parallel.

Parameters:
context: Global MSSP context [optional]
src: Source address/addresses
dst: Destination address/addresses
service: Service/services
sourceDomainIdTag: Path starting point Domain Id [optional]
includeIncompletePaths: Include incomplete paths [optional]
simulateNat: Simulate NAT [optional]
lastInstall: Last Installed [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/path?src=10.10.10.1&dst=3.3.3.3:32&service=any

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/path?src=29.29.29.1&dst=25.25.25.1&service=Facebook,tcp:80
OUTPUT {
    \"path_calc_results\": {
        \"traffic_allowed\": false,
        \"device_info\": {
            \"id\": \"17\",
            \"name\": \"PA-VM-111.6 (Cluster)\",
            \"type\": \"mgmt\",
            \"vendor\": \"Palo Alto Networks\",
            \"incomingInterfaces\": {
                \"incomingVrf\": \"default\",
                \"ip\": \"29.29.29.1/255.255.255.252\",
                \"name\": \"tunnel.11\"
            },
            \"nextDevices\": {
                \"name\": \"DIRECTLY_CONNECTED\",
                \"routes\": {
                    \"outgoingInterfaceName\": \"ethernet1/5\",
                    \"outgoingVrf\": \"default\",
                    \"routeDestination\": \"25.25.25.1/255.255.255.0\"
                }
            },
            \"bindings\": {
                \"name\": \"\",
                \"rules\": [
                    {
                        \"action\": \"Accept\",
                        \"applications\": \"facebook\",
                        \"destNegated\": false,
                        \"destinations\": \"Any\",
                        \"ruleIdentifier\": 43,
                        \"serviceNegated\": false,
                        \"services\": \"Any\",
                        \"sourceNegated\": false,
                        \"sources\": \"Any\",
                        \"users\": \"Any\"
                    },
                    {
                        \"action\": \"Deny\",
                        \"applications\": \"Any\",
                        \"destNegated\": false,
                        \"destinations\": \"Any\",
                        \"ruleIdentifier\": 62,
                        \"serviceNegated\": false,
                        \"services\": \"Any\",
                        \"sourceNegated\": false,
                        \"sources\": \"Any\",
                        \"users\": \"Any\"
                    }
                ]
            }
        }
    }
}


Usage Example
https://192.168.1.1/securetrack/api/topology/path?src=netobj:422:GW_123.120&dst=netobj:483:uni/tn-common/out-CommonL3Out/lnodep-LNP&service=any
"},"response":[]},{"name":"Get Join Cloud","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/join/clouds/{{cloudId}}","description":"Get Join Cloud by Id.

Parameters:
cloudId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/join/clouds/67
OUTPUT{
    id: 67,
    name: \"Yami\",
    clouds: [
        1,
        2,
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Cloud Not Found.
500: General error occurred."},"response":[]},{"name":"Delete Join Cloud","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/join/clouds/{{cloudId}}","description":"Delete Join Cloud by Id.

Parameters:
cloudId [optional]
forceTopologyInit: Force Topology Init [optional]

Usage Example
https://{st_host}/securetrack/api/topology/join/clouds/67\n

Response Messages:
204: No Content.
400: Bad Request.
403: Access is denied.
404: Cloud Not Found.
500: General error occurred."},"response":[]},{"name":"Get cloud information","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"suggested_clouds\": {\n\t\t\"count\": 1,\n\t\t\"total\": 1,\n\t\t\"cloud\": {\n\t\t\t\"management_name\": \"FW1\",\n\t\t\t\"management_id\": 20,\n\t\t\t\"cloud_name\": \"Cloud 10.100.0.1\",\n\t\t\t\"cloud_id\": 120,\n\t\t\t\"vertex_id\": 250,\n\t\t\t\"ip\": \"10.100.0.1\",\n\t\t\t\"routes_count\": 5,\n\t\t\t\"is_parent\": false\n\t\t}\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/cloud_suggestions/{{cloud_id}}","description":"Returns information about a specific cloud in the topology.
This API includes the ID of the cloud, the number of routes that point to the cloud, and the relevant devices (including the management_id) that have routes that point to the cloud.
This information can be used to identify missing devices that may need to be added to the topology or to identify clouds that are candidates for being joined.

Parameters:
cloud_id: cloud id
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/cloud_suggestions/120
BODY{
    \"suggested_clouds\": {
        \"count\": 1,
        \"total\": 1,
        \"cloud\": {
            \"management_name\": \"FW1\",
            \"management_id\": 20,
            \"cloud_name\": \"Cloud 10.100.0.1\",
            \"cloud_id\": 120,
            \"vertex_id\": 250,
            \"ip\": \"10.100.0.1\",
            \"routes_count\": 5,
            \"is_parent\": false
        }
    }
}


Response Messages:
202: Accepted
403: User is not permitted to access the specified domain"},"response":[]},{"name":"Get path pdf report for specified traffic","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"src"},{"value":null,"type":"text","key":"dst"},{"value":null,"type":"text","key":"service"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/export_path_results.pdf","description":"Returns an pdf report containing one or more paths for the specified traffic.
src and dst parameters may contain multiple, comma separated values.
Service parameter can be a port (for example, “tcp:80”, “any”) or an application (for example, “Skype”, “Facebook”).
Application names are case sensitive.
Service parameter can also be a combination of ports and applications, for example “tcp:80, Skype, Facebook”
If sourceDomainIdTag is provided, the path starting points will be restricted to the specified domain ID. sourceDomainIdTag is valid only if overlapping IP mode is enabled.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is valid only if MSSP mode is enabled.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.
displayIncompletePaths parameter default value is false, if this parameter is set to true -
all nodes on the path will be displayed, even if the node cannot reach the destination, or if the source and destination are the same.
displayBlockedStatus parameter default value is false, if this parameter is set to true -
blocked traffic icons will be displayed next to devices blocking the traffic.
simulateNat parameter default value is true if this parameter is set to false - NAT simulation will not be used when calculating the path.
lastInstall parameter default value is true, which means simulation would use last installed policies. If this parameter is set to false - simulation would use last saved policies.
pathIds parameter default value is empty, which means that all paths would be exported to the report.
This API cannot be executed more than 10 times in parallel.

Parameters:
context: Global MSSP context [optional]
src: Source address/addresses
dst: Destination address/addresses
service: Service/services
sourceDomainIdTag: Path starting point Domain Id [optional]
displayIncompletePaths: Display incomplete paths [optional]
displayBlockedStatus: Display blocked traffic status icons [optional]
simulateNat: Simulate NAT [optional]
lastInstall: Last Installed [optional]
pathIds: Path Ids [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/export_path_results.pdf?src=10.10.10.1&dst=3.3.3.3:32&service=any

Usage Example
https://192.168.1.1/securetrack/api/topology/export_path_results.pdf?src=10.10.10.1&dst=3.3.3.3:32&service=Facebook,tcp:80&pathIds=1,3

Usage Example
https://192.168.1.1/securetrack/api/topology/export_path_results.pdf?src=10.10.10.1&dst=3.3.3.3:32&service=Facebook,tcp:80&pathIds=3

Usage Example
https://192.168.1.1/securetrack/api/topology/export_path_results.pdf?src=netobj:422:GW_123.120&dst=netobj:483:uni/tn-common/out-CommonL3Out/lnodep-LNP&service=any
"},"response":[]},{"name":"Delete Transparent Firewalls.","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw/device/{{deviceId}}","description":"Delete Transparent Firewalls for participated layer 2 deviceId

Parameters:
deviceId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/transparentfw/device/9\n

Response Messages:
200: 4 entries deleted where layer2 deviceId = 9
400: Bad Request.
403: Access is denied.
404: DeviceId 9 not found.
500: General error occurred."},"response":[]},{"name":"Get Transparent Firewalls","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/transparentfw/device/{{deviceId}}","description":"Get Transparent Firewalls for participated managed/generic DeviceId

Parameters:
deviceId [optional]
generic [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/transparentfw/device/9?generic=false
OUTPUT{
    TransparentFirewalls: [
        {
            id: 17,
            outputL3DeviceId: 22,
            outputL3IsGenericDevice: false,
            outputL3InterfaceName: \"FastEthernet0/0\",
            layer2DeviceId: 9,
            inputL2InterfaceName: \"inside\",
            outputL2InterfaceName: \"outside\",
            inputL3DeviceId: 1,
            inputL3IsGenericDevice: true,
            inputL3InterfaceName: \"interface2\"
        },
        {
            id: 23,
            outputL3DeviceId: 23,
            outputL3IsGenericDevice: false,
            outputL3InterfaceName: \"FastEthernet2/0\",
            layer2DeviceId: 9,
            inputL2InterfaceName: \"inside\",
            outputL2InterfaceName: \"outside\",
            inputL3DeviceId: 17,
            inputL3IsGenericDevice: false,
            inputL3InterfaceName: \"mgmt\"
        }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred."},"response":[]},{"name":"Create a joined topology cloud","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"cloud_data\":{\n\t\t\"cloud_name\" : \"optional new cloud name\",\n\t\t\"cloud_members\" : [118,179,258]\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds","description":"Create a new topology cloud in the Interactive Map by joining existing clouds together.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
The body must include at least two topology cloud ids that are on a single domain.
If the context parameter is not provided, then the API will use the context id of the first member of the members list in the body.
Clouds included in the members list of the body must not be joined clouds or members of another joined cloud.
If the provided body does not specify a joined cloud name, the newly created topology cloud will be given the name of the first member of the members list in the body.


Parameters:
context: Global MSSP context [optional]
body: Cloud data
forceTopologyInit: Force Topology Init [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds
BODY{
    \"cloud_data\":{
        \"cloud_name\" : \"optional new cloud name\",
        \"cloud_members\" : [118,179,258]
    }
}


Response Messages:
201: Joined cloud created successfully
403: Access is denied
403: You do not have access permission to the domain for cloud with id ID
404: Cloud with id ID was not found in the provided MSSP domain
412: You must provide 2 or more clouds
412: Cloud id: cloudId does not belong to domain: Context
412: Cloud with id ID is a joined cloud
412: Cloud with id ID is a member of a joined cloud"},"response":[]},{"name":"Get topology clouds","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/clouds","description":"Returns a list of the topology clouds for all the domains for which the user has permission to access.
This API requires either 'Super admin' or 'Multi-Domain admin' privileges.
For users with ‘Super admin’ permission, the context parameter is optional. If a context is not specified, the Global context will be used.
For users with ‘Multi-Domain’ privilege, the context parameter is required.
To get the context parameter, call the /domains/ API and use the id included in the returned domain DTO.
Use the optional name parameter to restrict the results to topology clouds that contain the specified string.
The default pagination is start=0 and count=50.

Parameters:
context: Global MSSP context [optional]
type: Required clouds type [optional]
name: Cloud name [optional]
start: The starting element to include in the returned results [optional]
count: Number of elements to include in the results [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds
OUTPUT{
    \"topology_clouds\": {
        \"count\": 3,
        \"total\": 3,
        \"topology_cloud\": [
            {
                \"id\": 48,
                \"name\": \"Cloud 69.70.120.155\",
                \"domain\": 1,
                \"type\": \"NON_JOINED\",
                \"ip\": \"69.70.120.155\"
            },
            {
                \"id\": 50,
                \"name\": \"Cloud 10.100.6.238\",
                \"domain\": 1,
                \"type\": \"MEMBER\",
                \"ip\": \"10.100.6.238\"
            },
            {
                \"id\": 66,
                \"name\": \"Cloud 10.100.10.14\",
                \"domain\": 1,
                \"type\": \"JOINED\",
                \"members\": [
                    {
                        \"id\": 50,
                        \"ip\": \"10.100.6.238\",
                        \"name\": \"Cloud 10.100.6.238\"
                    },
                    {
                        \"id\": 73,
                        \"ip\": \"10.100.10.14\",
                        \"name\": \"Cloud 10.100.10.14\"
                    },
                    {
                        \"id\": 74,
                        \"ip\": \"10.100.9.9\",
                        \"name\": \"Cloud 10.100.9.9\"
                    }
                ]
            }
        ]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/topology/clouds?type=non-joined
OUTPUT{
    \"topology_clouds\": {
        \"count\": 2,
        \"total\": 3,
        \"topology_cloud\": [
            {
                \"id\": 48,
                \"name\": \"Cloud 69.70.120.155\",
                \"domain\": 1,
                \"type\": \"NON_JOINED\",
                \"ip\": \"69.70.120.155\"
            },
            {
                \"id\": 50,
                \"name\": \"Cloud 10.100.6.238\",
                \"domain\": 1,
                \"type\": \"NON_JOINED\",
                \"ip\": \"10.100.6.238\"
            }
        ]
    }
}


Response Messages:
403: Access is denied
403: Only users with ‘Super admin’ permissions can access Global domain map
403: You do not have access permission to domain id: domainId
400: Wrong type provided - allowable values are: joined or non-joined"},"response":[]},{"name":"Synchronize the Topology model","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/synchronize","description":"Invoke of the Topology Model Synchronization.
full_sync=false - Builds the topology model from the information stored in the Tufin database.
full_sync=true - Retrieves the current data from devices and builds the topology model.
Default value for full_sync = false.

Parameters:
full_sync: Perform full sync [optional]

Usage Example
https://192.168.1.1/securetrack/api/topology/synchronize

Usage Example
https://192.168.1.1/securetrack/api/topology/synchronize?full_sync=true

Response Messages:
200: The topology synchronization was invoked successfully.
403: Access is denied
500: Error Synchronizing Topology Model
503: Service unavailable, Graph builder is currently running"},"response":[]},{"name":"Get Topology Synchronization status","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/synchronize/status","description":"Returns the progress status of the Topology Model Synchronization.



Usage Example
https://192.168.1.1/securetrack/api/topology/synchronize/status

Response Messages:
200: The topology synchronization was invoked successfully.
403: Access is denied
500: Error getting synchronize progress"},"response":[]},{"name":"Create Join Cloud","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \n\t\"JoinCloud\" : \n\t{\n\t\t\"name\" : \"Yami\",\n\t\t\"clouds\" : [1, 2]\n\t}\n} "},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/join/clouds/","description":"Create Join Cloud.

Parameters:
body [optional]
forceTopologyInit: Force Topology Init [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/join/clouds
BODY{
    \"JoinCloud\" :
    {
        \"name\" : \"Yami\",
        \"clouds\" : [1, 2]
    }
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Cloud Not Found.
500: General error occurred."},"response":[]},{"name":"Update Join Cloud","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \n\t\"JoinCloud\" : \n\t{\n\t\t\"id\" : 67,\n\t\t\"name\" : \"Yamile\",\n\t\t\"clouds\" : [1, 2, 57]\n\t}\n} "},"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/join/clouds/","description":"Update Join Clouds.

Parameters:
body [optional]
forceTopologyInit: Force Topology Init [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/join/clouds
BODY{
    \"JoinCloud\" :
    {
        \"id\" : 67,
        \"name\" : \"Yamile\",
        \"clouds\" : [1, 2, 57]
    }
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Cloud Not Found.
500: General error occurred."},"response":[]},{"name":"Get generic Vpn","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/{{vpnId}}","description":"Get a generic Vpn by Id.

Parameters:
vpnId [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/vpn/18
OUTPUT{
    GenericVpn: {
        id: 18,
        generic: false,
        deviceId: 2,
        interfaceName: \"777\",
        tunnelSourceIpAddr: \"1.1.1.77\",
        tunnelDestIpAddr: \"1.1.1.88\"
    }
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Generic Vpn Not Found.
500: General error occurred."},"response":[]},{"name":"Delete generic Vpn","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/{{vpnId}}","description":"Delete a generic Vpn by Id.

Parameters:
vpnId [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/vpn/5\n

Response Messages:
204: No Content.
400: Bad Request.
403: Access is denied.
404: Generic Vpn Not Found.
500: General error occurred."},"response":[]},{"name":"Delete generic Vpns","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/device/{{deviceId}}","description":"Delete all generic Vpns from management/genericDevice Id.

Parameters:
deviceId [optional]
generic [optional]

Usage Example
https://{st_host}/securetrack/api/topology/generic/vpn/device/2?generic=false\n

Response Messages:
200: 4 Generic Vpns were deleted from mgmtId 2.
400: Bad Request.
403: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred."},"response":[]},{"name":"Get generic Vpns","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/topology/generic/vpn/device/{{deviceId}}","description":"Get generic Vpns of management/genericDevice Id.

Parameters:
deviceId [optional]
generic [optional]

Usage Example
URLhttps://{st_host}/securetrack/api/topology/generic/vpn/device/3?generic=true
OUTPUT{
    GenericVpns: [
    {
        id: 17,
        generic: true,
        deviceId: 3,
        interfaceName: \"777\",
        tunnelSourceIpAddr: \"1.1.1.177\",
        tunnelDestIpAddr: \"1.1.1.188\"
    },
    {
        id: 22,
        generic: true,
        deviceId: 3,
        interfaceName: \"111\",
        tunnelSourceIpAddr: \"1.1.1.188\",
        tunnelDestIpAddr: \"1.1.1.177\"
    }
    ]
}


Response Messages:
200: OK.
400: Bad Request.
403: Access is denied.
404: Management/GenericDevice Not Found.
500: General error occurred."},"response":[]}]},{"name":"Network Zone Manager - Patterns","item":[{"name":"Create a zone pattern entry in a specific zone","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\n\t\n\t\t1\n\t\t2\n\t\t\n\t\t\t1\n\t\t\tDefault\n\t\t\n\t\tWEB\n\t\tsecurity_group_by_name\n\t\tThis is a comment\n\t\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/pattern-entries","description":"Create a zone pattern entry in a specific zone by identifier

Parameters:
context: Global MSSP context. [optional]
zone_id: Identifier of the zone containing the zone pattern entry.
body: The zone pattern entry to create.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/pattern-entries
BODY<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<create_pattern_match_entry>
    <pattern_match_entry>
        <id>1</id>
        <zone_id>2</zone_id>
        <domain>
            <id>1</id>
            <name>Default</name>
        </domain>
        <pattern>WEB</pattern>
        <type>security_group_by_name</type>
        <comment>This is a comment</comment>
    </pattern_match_entry>
</create_pattern_match_entry>


Response Messages:
201: The zone pattern entry was created successfully.
403: User is not permitted to access the specified domain
400: Some of pattern entry parameters were invalid or missing
404: A zone with the specified identifier was not found."},"response":[]},{"name":"Get all pattern entries for specific zones","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\n\t\n\t\t0\n\t\t2\n\t\t2\n\t\n\t\n\t\t\n\t\t\t2\n\t\t\tsecurity_group_by_name\n\t\t\tThis is a comment\n\t\t\tWEB\n\t\t\t1\n\t\t\n\t\t\n\t\t\t3\n\t\t\tsecurity_group_by_name\n\t\t\tThis is a comment\n\t\t\tWEo\n\t\t\t2\n\t\t\n\t\n\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/pattern-entries","description":"Get the list of zone pattern entries for specific zones by identifiers

Parameters:
context: Global MSSP context. [optional]
ids: Filter by IDs for the pattern entry results. [optional]
pattern: Filter by pattern string for the zone entry results. [optional]
name: Filter by zone name for the pattern entry results. [optional]
comment: Filter by comment for the pattern entry results. [optional]
sort: Sort ascending or descending. [optional]
start: Starting page number for query results. [optional]
count: Number of pages to return for the query, starting from the specified starting page. [optional]
children: Include child zones in the results. [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/1,2/pattern-entries
BODY<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<pattern_match_entries_find_result>
    <paging_info>
        <start>0</start>
        <count>2</count>
        <total>2</total>
    </paging_info>
    <pattern_match_entries>
        <pattern_match_entry>
            <id>2</id>
            <type>security_group_by_name</type>
            <comment>This is a comment</comment>
            <pattern>WEB</pattern>
            <zone_id>1</zone_id>
        </pattern_match_entry>
        <pattern_match_entry>
            <id>3</id>
            <type>security_group_by_name</type>
            <comment>This is a comment</comment>
            <pattern>WEo</pattern>
            <zone_id>2</zone_id>
        </pattern_match_entry>
    </pattern_match_entries>
</pattern_match_entries_find_result>


Response Messages:
200: The zone pattern entries were successfully retrieved.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Get a specific zone pattern entry for a specific zone","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\n\t2\tsecurity_group_by_name\n\tThis is a comment\n\tWEB\n\t75\n\tZone_10_0_0_1\n\t\n\t\t
koko
\n\t\tbobo\n\t\t1\n\t\tDefault\n\t\n\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/pattern-entries/{{id}}","description":"Get a specific zone pattern entry for a specific zone by identifier

Parameters:
context: Global MSSP context. [optional]
zone_id: Identifier of the zone containing the zone entry.
id: Identifier of the zone pattern entry.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/75/pattern-entries/2
BODY<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<pattern_match_entry>
    <id>2</id>    <type>security_group_by_name</type>
    <comment>This is a comment</comment>
    <pattern>WEB</pattern>
    <zone_id>75</zone_id>
    <zone_name>Zone_10_0_0_1</zone_name>
    <domain>
        <address>koko</address>
        <description>bobo</description>
        <id>1</id>
        <name>Default</name>
    </domain>
</pattern_match_entry>


Response Messages:
200: The zone pattern entry was successfully retrieved.
403: User is not permitted to access the specified domain
404: A zone with the specified identifier was not found.
404: A zone pattern entry with the specified identifier was not found."},"response":[]}]},{"name":"Network Zone Manager - Subnets","item":[{"name":"Get entries for a zone","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/entries","description":"Get the list of zone entries for a zone.

Parameters:
context: Global MSSP context. [optional]
ids: Filter by IDs for the zone entry results. [optional]
name: Filter by name for the zone entry results. [optional]
ip: Filter by IP for the zone entry results. [optional]
netmask: Filter by netmask for the zone entry results. [optional]
prefix: Filter by prefix for the zone entry results. [optional]
comment: Filter by comment for the zone entry results. [optional]
group: Filter by device group for the zone entry results. [optional]
sort: Sort ascending or descending. [optional]
start: Starting page number for query results. [optional]
count: Number of pages to return for the query, starting from the specified starting page. [optional]
children: Include child zones in the results. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/2/entries

Response Messages:
200: The zone entries were successfully retrieved.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Get a specific zone entry","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"zone_id"},{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries/{{id}}","description":"Get a specific zone entry by ID for a zone.

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
id: The ID of the zone entry.

Usage Example
https://192.168.1.1/securetrack/api/zones/2/entries/123

Response Messages:
200: The zone entry was successfully retrieved.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found."},"response":[]},{"name":"Delete zone entries","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"zone_id"},{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries/{{id}}","description":"Delete existing zone entries.

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
id: The ID of the zone entry to delete.

Usage Example
https://192.168.1.1/securetrack/api/zones/2/entries/10

Response Messages:
200: The zone entry was deleted successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found."},"response":[]},{"name":"Create a zone entry","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"zone_entry\": {\n\t\"ip\": \"1b98:c72:1f00:0000::\",\n\t\"prefix\": \"52\"\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries","description":"For IPv4 entry provide IP and netmask/prefix (see Usage Example #1 and #2).
For IPv6 provide IP and prefix only, netmask is not allowed(see Usage Example #3).

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
body: The zone entry to create.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"netmask\": \"255.255.255.0\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"prefix\": \"24\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries
BODY{
\"zone_entry\": {
    \"ip\": \"1b98:c72:1f00:0000::\",
    \"prefix\": \"52\"
    }
}


Response Messages:
201: The zone entry was created successfully.
403: User is not permitted to access the specified domain
400: The zone entry parameters were invalid
404: A zone with the specified ID was not found."},"response":[]},{"name":"Modify multiple existing zone entries","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"zone_entries\" : {\n\t\t\"zone_entry\": [\n\t\t\t{\n\t\t\t\t\"id\": 120,\n\t\t\t\t\"ip\": \"3.3.3.3\",\n\t\t\t\t\"prefix\": 32,\n\t\t\t\t\"new_zone_id\": 85\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"id\": 139,\n\t\t\t\t\"ip\": \"1b98:c72:1f00:0001::\",\n\t\t\t\t\"prefix\": \"52\",\n\t\t\t\t\"new_zone_id\": 98\n\t\t\t}\n\t\t]\n}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_ids}}/entries/{{ids}}","description":"For IPv4 entry provide IP and netmask/prefix.
For IPv6 provide IP and prefix only, netmask is not allowed.
new_zone_id is not optional, it may be the same as the present zoneId.

Parameters:
context: Global MSSP context. [optional]
zone_ids: The ID(s) of the zones containing the zone entries.
ids: The ID(s) of the zone entries to modify.
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/85,98/entries/120,139
BODY{
\"zone_entries\" : {
        \"zone_entry\": [
            {
                \"id\": 120,
                \"ip\": \"3.3.3.3\",
                \"prefix\": 32,
                \"new_zone_id\": 85
            },
            {
                \"id\": 139,
                \"ip\": \"1b98:c72:1f00:0001::\",
                \"prefix\": \"52\",
                \"new_zone_id\": 98
            }
        ]
}
}


Response Messages:
200: The zone entry was modified successfully.
403: User is not permitted to access the specified domain
400: The zone entry parameters were invalid
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found."},"response":[]},{"name":"Modify a zone entry","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"zone_ids"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_ids}}/entries/{{ids}}","description":"Modify an existing zone entry.

Parameters:
context: Global MSSP context. [optional]
zone_ids: The ID(s) of the zones containing the zone entry.
ids: The ID(s) of the zone entries to delete.

Usage Example
https://192.168.1.1/securetrack/api/zones/2,3/entries/10,20

Response Messages:
200: The zone entry was deleted successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found."},"response":[]},{"name":"Modify a zone entry","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"zone_entry\": {\n\t\"ip\": \"1b98:c72:1f00:0000::\",\n\t\"prefix\": \"52\"\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{zone_id}}/entries/{{id}}","description":"For IPv4 entry provide IP and netmask/prefix (see Usage Example #1 and #2).
For IPv6 provide IP and prefix only, netmask is not allowed(see Usage Example #3).

Parameters:
context: Global MSSP context. [optional]
zone_id: The ID of the zone containing the zone entry.
id: The ID of the zone entry.
body: The modified zone entry.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries/1
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"netmask\": \"255.255.255.0\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries/1
BODY{
\"zone_entry\": {
    \"ip\": \"192.168.2.3\",
    \"prefix\": \"24\",
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2/entries/1
BODY{
\"zone_entry\": {
    \"ip\": \"1b98:c72:1f00:0000::\",
    \"prefix\": \"52\"
    }
}


Response Messages:
200: The zone entry was modified successfully.
403: User is not permitted to access the specified domain
400: The zone entry parameters were invalid
404: A zone with the specified ID was not found.
404: A zone entry with the specified ID was not found."},"response":[]}]},{"name":"Network Zone Manager - Zones","item":[{"name":"Get all zones","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/","description":"Gets a list of all zones.

Parameters:
context: Global MSSP context. [optional]
name: Filter by zone name for the zone results. [optional]
comment: Filter by zone comment for the zone results. [optional]
imported: List domains that imported zones. [optional]
includeInternet: Include the Internet zone. [optional]
includeImported: Include imported zones. [optional]
sort: Sort ascending or descending. [optional]
start: Starting page number for query results. [optional]
count: Number of pages to return for the query, starting from the specified starting page. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones

Response Messages:
200: The zones were retrieved successfully.
403: User is not permitted to access the specified domain"},"response":[]},{"name":"Create a zone","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\n\tDMZ\n\tAll DMZ addresses\n\tfalse\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/","description":"Create a zone.

Parameters:
context: Global MSSP context. [optional]
body: The zone to add.

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones
BODY<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<zone>
    <name>DMZ</name>
    <comment>All DMZ addresses</comment>
    <shared>false</shared>
</zone>


Response Messages:
201: The zone was created successfully.
403: User is not permitted to access the specified domain
400: The zone parameters were invalid"},"response":[]},{"name":"Delete all zones","request":{"method":"DELETE","header":[],"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/","description":"Delete all existing zones.

Parameters:
context: Global MSSP context. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones

Response Messages:
204: All zones were successfully deleted.
403: User is not permitted to access the specified domain"},"response":[]},{"name":"Get ancestor zones for a zone","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/ancestors","description":"Get a list of ancestor zones for the specified zone(s).

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones for which to look for ancestor zones.

Usage Example
https://192.168.1.1/securetrack/api/zones/123,234/ancestors

Response Messages:
200: The zone ancestors were retrieved successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Get configuration usages for a zone","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/dependencies","description":"Get a list of configuration usages for the specified zone(s).

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones for which to look for configuration dependencies.

Usage Example
https://192.168.1.1/securetrack/api/zones/2,3/dependencies

Response Messages:
200: The zone dependencies were retrieved successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Add a zone as an ancestor to a zone","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"child_id"},{"value":null,"type":"text","key":"parent_ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{child_id}}/ancestors/{{parent_ids}}","description":"Add a zone(s) as an ancestor to a existing zone.

Parameters:
context: Global MSSP context. [optional]
child_id: The ID of the zone for which to add ancestors zone(s).
parent_ids: The ID(s) of the zones to add as ancestors.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/ancestors/10,20

Response Messages:
200: The zone was added as an ancestor successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Remove a zone as an ancestor to a zone","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"child_id"},{"value":null,"type":"text","key":"parent_ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{child_id}}/ancestors/{{parent_ids}}","description":"Remove a zone(s) as an ancestor to a existing zone.

Parameters:
context: Global MSSP context. [optional]
child_id: The ID of the zone for which to remove ancestors zone(s).
parent_ids: The ID(s) of the zones to remove as ancestors.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/ancestors/10,20

Response Messages:
200: The zone was removed as an ancestor successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Get shared zones","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/shared","description":"Get a list of shared zones.

Parameters:
context: Global MSSP context. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/shared

Response Messages:
200: The list of shared zones was retrieved successfully.
403: User is not permitted to access the specified domain"},"response":[]},{"name":"Map network elements to security zones","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t \n\t\t \n\t\t 10.8.8.0\n\t\t 255.255.255.0\n\t\t \n\t \n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_zones/","description":"This API maps each network element in the AccessRequestNetworkListDTO (such as IP address, IP address range, object, or group) to all matching Tufin security zones. If the network element is a group, then each zone also identifies all matching group members. The internet referral object can be included in the list, and will always map to the predefined Internet security zone. If the 'Any' element is included in the list it will map to all zones.
Note: if multi-domain mode is enabled, the API calls only checks zones that are in the “Default” domain.

Parameters:
body: AccessRequestNetworkListDTO

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_zones
BODY<network_objects>
     <network_object xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"ip_network\">
         <network xsi:type=\"raw_network_subnet\">
         <ip>10.8.8.0</ip>
         <mask>255.255.255.0</mask>
         </network>
     </network_object>
</network_objects>


Response Messages:
200: Returns mapping of network elements to security zones
400: Access Request Network List is malformed.
403: Access is denied."},"response":[]},{"name":"Import a zone","request":{"method":"POST","header":[],"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/import/{{ids}}","description":"Import a shared zone into the specified domain

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones to import. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/import/10,20

Response Messages:
200: The zone was imported successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Modify a zone","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\n\t2\n\tDMZ\n\tAll DMZ hosts\n\tfalse\n\tfalse\n\tfalse\n\tfalse\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{id}}","description":"Modify an existing zone.

Parameters:
context: Global MSSP context. [optional]
id: The ID of the zone to modify.
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/zones/2
BODY<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<zone>
    <id>2</id>
    <name>DMZ</name>
    <comment>All DMZ hosts</comment>
    <shared>false</shared>
    <internet>false</internet>
    <user_networks>false</user_networks>
    <unassociated_networks>false</unassociated_networks>
</zone>


Response Messages:
204: The specified zone was successfully modified.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found.
400: The zone parameters were invalid"},"response":[]},{"name":"Get a specific zone","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{id}}","description":"Get the zone with the specified ID.

Parameters:
context: Global MSSP context. [optional]
id: The ID of the zone to get.
imported: List domains that imported zones. [optional]

Usage Example
https://192.168.1.1/securetrack/api/zones/2

Response Messages:
200: The zone was retrieved successfully.
403: User is not permitted to access the specified domain
403: A zone with the specified ID does not exist."},"response":[]},{"name":"Get descendant zones for a zone","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}/descendants","description":"Get a list of zones descended from the specified zone(s).

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zones for which to look for descendant zones.

Usage Example
https://192.168.1.1/securetrack/api/zones/10,20/descendants

Response Messages:
200: The zone descendants were retrieved successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Remove a zone as an descendants to a zone","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"parent_id"},{"value":null,"type":"text","key":"child_ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{parent_id}}/descendants/{{child_ids}}","description":"Remove a zone(s) as an descendants to a existing zone.

Parameters:
context: Global MSSP context. [optional]
parent_id: The ID of the zone for which to remove descendant zone(s).
child_ids: The ID(s) of the zone to remove as a descendant.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/descendants/10,20

Response Messages:
200: The zone was removed as an descendant successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Add a zone as a descendant to a zone","request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"parent_id"},{"value":null,"type":"text","key":"child_ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{parent_id}}/descendants/{{child_ids}}","description":"Add a zone(s) as a descendant to a existing zone.

Parameters:
context: Global MSSP context. [optional]
parent_id: The ID of the zone for which to add descendant zone(s).
child_ids: The ID(s) of the zones to add as descendants.

Usage Example
https://192.168.1.1/securetrack/api/zones/1/descendants/10,20

Response Messages:
200: The zone was added as an descendant successfully.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]},{"name":"Delete a zone","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/zones/{{ids}}","description":"Delete an existing zone.

Parameters:
context: Global MSSP context. [optional]
ids: The ID(s) of the zone to delete.

Usage Example
https://192.168.1.1/securetrack/api/zones/1,2

Response Messages:
204: The specified zone was successfully deleted.
403: User is not permitted to access the specified domain
404: A zone with the specified ID was not found."},"response":[]}]},{"name":"Policies and Sub-Policies","item":[{"name":"Get policies by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/policies","description":"Fetches list of policies defined on a given revision ID

Parameters:
context: Global MSSP context [optional]
id: Revision ID

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/policies
"},"response":[]},{"name":"Get rules by input and output interfaces","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/topology_interfaces","description":"Parameters:
device_id: The unique identifier of target device
inputInterfaceName: Input interface name [optional]
outputInterfaceName: Output interface name [optional]
isIpv6: Is ipv6 policy [optional]

Usage Example
https://192.168.1.1/securetrack/api/bindings/2/topology_interfaces?inputInterfaceName=ethernet1/1&outputInterfaceName=ethernet1/2
"},"response":[]},{"name":"Get policies by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/policies","description":"Fetches list of policies defined on a given device ID.
Supported devices: CheckPoint, Panorama Advanced, FortiManager Basic and Advanced, FMC and NSX.

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/20/policies
"},"response":[]},{"name":"Get list of sub-policies (bindings) with input and/or output interfaces","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"supremum_version_id"},{"value":null,"type":"text","key":"inputInterfaceName"},{"value":null,"type":"text","key":"outputInterfaceName"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/bindings/{{device_id}}/binding_query","description":"Retrieve list of bindings of input and/or output interfaces

Parameters:
device_id: The unique identifier of target device
supremum_version_id: The unique identifier of target revision
inputInterfaceName: Input interface name
outputInterfaceName: Output interface name

Usage Example
https://192.168.1.1/securetrack/api/bindings/20/binding_query?supremum_version_id=785&inputInterfaceName=Any&outputInterfaceName=Any
"},"response":[]},{"name":"Get sub-policies (bindings) by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/bindings","description":"Returns a list of all of the subpolicies (bindings) for a given revision.
The definition of subpolicy is different for each vendor:
Check Point - policy package and inline layer (inline layer will be returned only when the optional include_subpolicy parameter is set to true)
Cisco - ACL
Juniper/Fortinet/Palo Alto/Stonesoft - zone-to-zone policy
Cloud platforms - Security Groups


Parameters:
context: Global MSSP context [optional]
id: Revision ID
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
include_subpolicy: when set to true, includes sub policies in the returned result, supported only for Checkpoint [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/bindings

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/bindings? include_subpolicy=true
"},"response":[]},{"name":"Get sub-policies (bindings) by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/bindings","description":"Returns a list of all of the subpolicies (bindings) for a given device.
The definition of subpolicy is different for each vendor:
Check Point - policy package and inline layer (inline layer will be returned only when the optional include_subpolicy parameter is set to true)
Cisco - ACL
Juniper/Fortinet/Palo Alto/Stonesoft - zone-to-zone policy
Cloud platforms - Security Groups


Parameters:
context: Global MSSP context [optional]
id: Device ID
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
include_subpolicy: when set to true, includes sub policies in the returned result, supported only for Checkpoint [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/bindings

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/bindings? include_subpolicy=true
"},"response":[]}]},{"name":"Policy Analysis","item":[{"name":"Run Policy Analysis query","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_ids"},{"value":null,"type":"text","key":"sources"},{"value":null,"type":"text","key":"destinations"},{"value":null,"type":"text","key":"services"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/policy_analysis/query/matching_rules","description":"Parameters:
device_ids: Device ids
sources: Source list
destinations: Destination list
services: Service list
exclude_any: Exclude any in the specified, comma-separated fields of source, destination or service. For example: exclude_any = destination,service [optional]
action: Action [optional]

Usage Example
https://192.168.1.1/securetrack/api/policy_analysis/query/matching_rules?device_ids=41&sources=33.33.33.0:24,113.113.113.100&destinations=114.1.1.0:24&services=tcp:80&exclude_any=source,destination

Response Messages:
200: Returns request results.
400: Error in request syntax."},"response":[]}]},{"name":"Policy Browser (formerly Rule Documentation)","item":[{"name":"Get specific rule documentation","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"rule_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules/{{rule_id}}/documentation","description":"Fetches rule documentation for a single rule given by revision ID and rule ID.

Parameters:
context: Global MSSP context [optional]
id: Revision id
rule_id: Id of the requested rule

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules/16373/documentation
"},"response":[]},{"name":"Modify specific rule documentation","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t admin\n\t Comment text\n\t false\n\t true\n\t \n\t\t user@company.com\n\t\t Business Owner\n\t\t 2013-01-08T00:00:00+02:00\n\t\t 172\n\t\t 789111\n\t \n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules/{{rule_id}}/documentation","description":"Modify rule documentation for a single rule identified by revision ID and rule ID.
A single rule can be set as either a stealth rule or legacy rule. If both flags are set, an error will be returned (error 400, Bad request).
If no rule documentation exists for the rule, the specified documentation is added to the rule and the response code is: 201 Created.
If rule documentation already exists for the rule, the specified documentation replaces the existing documentation and the response code is: 204 No Content.
Record set entries that are automatically created or calculated, for example automatic mapping to a SecureChange ticket, cannot be modified.
The following fields are automatically calculated, and cannot be modified:
Permissiveness, Violations, Last Hit, Last Modified, Shadowing Status, Certification Status, Certification Date, Certification Expiration Date, Application Name, Application Owner

Parameters:
context: Global MSSP context [optional]
id: Revision id
rule_id: Id of the changed rule
body: RuleDocumentationDTO

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/173/rules/3373/documentation
BODY<rule_documentation>
     <tech_owner>admin</tech_owner>
     <comment>Comment text</comment>
     <legacy_rule>false</legacy_rule>
     <stealth_rule>true</stealth_rule>
     <record_set>
         <businessOwnerEmail>user@company.com</businessOwnerEmail>
         <businessOwnerName>Business Owner</businessOwnerName>
         <expireDate>2013-01-08T00:00:00+02:00</expireDate>
         <id>172</id>
         <ticketCr>789111</ticketCr>
     </record_set>
</rule_documentation>

"},"response":[]},{"name":"Delete specific rule documentation","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"rule_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules/{{rule_id}}/documentation","description":"Delete rule documentation for a single rule given by revision ID and rule ID.
If the rule has automatic mapping to a ticket, the record is not deleted.

Parameters:
context: Global MSSP context [optional]
id: Revision id
rule_id: Rule id

Usage Example
https://192.168.1.1/securetrack/api/revisions/173/rules/3373/documentation
"},"response":[]},{"name":"Get specific rule documentation","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"rule_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules/{{rule_id}}/documentation","description":"Fetches rule documentation for a single rule given by device ID and rule ID

Parameters:
context: Global MSSP context [optional]
id: Device ID
rule_id: Rule ID

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules/16373/documentation
"},"response":[]},{"name":"Modify specific rule documentation","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t admin\n\t Comment text\n\t false\n\t true\n\t \n\t\t user@company.com\n\t\t Business Owner\n\t\t 2013-01-08T00:00:00+02:00\n\t\t 173\n\t\t 789112\n\t \n\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules/{{rule_id}}/documentation","description":"Modify rule documentation for a single rule given by device ID and rule ID
A single rule can be set as either a stealth rule or legacy rule. If both flags are set, an error will be returned (error 400, Bad request).
If there is no existing rule documentation for the rule, the specified documentation is added to the rule and the response code is: 201 Created.
If there is existing rule documentation for the rule, the specified documentation replaces the existing documentation and the response code is: 204 No Content.

Parameters:
context: Global MSSP context [optional]
id: Device ID
rule_id: Rule ID
body: RuleDocumentationDTO

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/20/rules/3040/documentation
BODY<rule_documentation>
     <tech_owner>admin</tech_owner>
     <comment>Comment text</comment>
     <legacy_rule>false</legacy_rule>
     <stealth_rule>true</stealth_rule>
     <record_set>
         <businessOwnerEmail>user@company.com</businessOwnerEmail>
         <businessOwnerName>Business Owner</businessOwnerName>
         <expireDate>2013-01-08T00:00:00+02:00</expireDate>
         <id>173</id>
         <ticketCr>789112</ticketCr>
     </record_set>
</rule_documentation>

"},"response":[]},{"name":"Delete specific rule documentation","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"},{"value":null,"type":"text","key":"rule_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules/{{rule_id}}/documentation","description":"Delete rule documentation for a single rule given by device ID and rule ID

Parameters:
context: Global MSSP context [optional]
id: Device ID
rule_id: Rule ID

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules/3040/documentation
"},"response":[]}]},{"name":"Policy Optimization","item":[{"name":"Get cleanups results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/cleanup/","description":"Parameters:
context: Global MSSP context [optional]
devices: Devices ids [optional]

Usage Example
https://192.168.1.1/securetrack/api/cleanup
"},"response":[]},{"name":"Get the specific objects or rules identified for the cleanup results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"cleanup_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/cleanup/{{cleanup_id}}/instances","description":"Parameters:
context: Global MSSP context [optional]
cleanup_id: Cleanup id
devices: Devices ids [optional]
start: Start [optional]
count: Results count [optional]

Usage Example
https://192.168.1.1/securetrack/api/cleanup/1/instances
"},"response":[]},{"name":"Get risks results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/risk/","description":"Parameters:
context: Global MSSP context [optional]
devices: Devices ids [optional]

Usage Example
https://192.168.1.1/securetrack/api/risk
"},"response":[]},{"name":"Get cleanups by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"code"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/cleanups","description":"Fetches set of Cleanup calculation results for a device given by ID.
Only fully shadowed rules (cleanup code C01) are supported.

Parameters:
context: Global MSSP context [optional]
device_id: Device ID
code: Cleanup category code
start: Starting page for query allowable values are numeric [optional]
count: Number of pages for query result allowable values are numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/31/cleanups?code=C01
"},"response":[]},{"name":"Get devices in cleanup results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"cleanup_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/cleanup/{{cleanup_id}}/devices","description":"Parameters:
context: Global MSSP context [optional]
cleanup_id: Cleanup id

Usage Example
https://192.168.1.1/securetrack/api/cleanup/1/devices
"},"response":[]},{"name":"Get devices in risk results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"risk_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/risk/{{risk_id}}/devices","description":"Parameters:
context: Global MSSP context [optional]
risk_id: Risk id

Usage Example
https://192.168.1.1/securetrack/api/risk/1/devices
"},"response":[]},{"name":"Get shadowing rules by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"shadowed_uids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/shadowing_rules","description":"Find shadowing rules for given shadowed rules of a specific device

Parameters:
device_id: Device ID
shadowed_uids: UIDs of shadowed rules separated by commas

Usage Example
https://192.168.1.1/securetrack/api/devices/31/shadowing_rules?shadowed_uids=78786a0d-b9cc-478e-b7a2-dea953c976c7
"},"response":[]},{"name":"Get the specific objects or rules identified for the risk results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"risk_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/risk/{{risk_id}}/instances","description":"Parameters:
context: Global MSSP context [optional]
risk_id: Risk id
devices: Devices ids [optional]
start: Start [optional]
count: Results count [optional]

Usage Example
https://192.168.1.1/securetrack/api/risk/1/instances
"},"response":[]}]},{"name":"Revisions","item":[{"name":"Get revisions by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/revisions","description":"Fetches revisions for a given device

Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query starting from starting page allowable type is numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/105/revisions
"},"response":[]},{"name":"Get specific revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revId}}","description":"Fetches a revision specified by revision Id.
To get revId for this API, use the 'id' property of RevisionDTO that is returned by 'Get revisions by device' or 'Get latest revision by device' APIs

Parameters:
context: Global MSSP context [optional]
revId: Id of fetched revision

Usage Example
https://192.168.1.1/securetrack/api/revisions/785
"},"response":[]},{"name":"Get latest revision by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/latest_revision","description":"Fetches latest revision for a given device

Parameters:
context: Global MSSP context [optional]
id: Device ID

Usage Example
https://192.168.1.1/securetrack/api/devices/105/latest_revision
"},"response":[]}]},{"name":"Rule Usage","item":[{"name":"Get last hit for a specific rule","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"rule_uid"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/rule_last_usage/find/{{device_id}}/{{rule_uid}}","description":"Get last hit dates for all rules in a given device.
For Palo Alto firewalls, this also returns last hits for users and applications in the rule.
The rule_uid is the value from the uid field returned by the /rules API: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Parameters:
device_id: device_id
rule_uid: rule_uid

Usage Example
https://192.168.1.1/securetrack/api/rule_last_usage/find/20/ea9db13e-d058-45c6-a2f0-cd731027c22b
"},"response":[]},{"name":"Get last hits for all rules by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/rule_last_usage/find_all/{{device_id}}","description":"Get last hit dates for all rules in a given device.
For Palo Alto firewalls, this also returns last hits for users and applications in the rule.

Parameters:
device_id: device id

Usage Example
https://192.168.1.1/securetrack/api/rule_last_usage/find_all/20
"},"response":[]}]},{"name":"Security Rules","item":[{"name":"Get specific rule","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/rules/{{ids}}","description":"Returns a list of rules by device ID, rule IDs and additional criteria.
Note: This API retrieves the information from the latest revision.


Parameters:
context: Global MSSP context [optional]
device_id: Device ID
ids: Rule IDs
policy: Policy Name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules only(device dependent, see implementation Notes) [optional]
add: If set to \"documentation\" result will include rule documentation [optional]
groupBy: Rules grouping criteria, can be set only to \"bindings\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules/16370
"},"response":[]},{"name":"Get rules by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/rules","description":"Returns a list of all of the security rules for the specified device.
Use add=documentation to retrieve rule documentation.
The is_global parameter is device dependent. For ACL devices, only global rules are returned when set to true. For Check Point R80, only global layers are returned when set to true, and specify a layer name in the subpolicy_name parameter This parameter is ignored for all other vendors. The default value is false.
The subpolicy_name parameter is device dependent. For Check Point R80, only rules that use the specified layer are returned. You can only specify the name of a single layer. This parameter is ignored for all other vendors.
For Cisco ASA devices, when applying a filter you must also add the direction.


Parameters:
context: Global MSSP context [optional]
id: Device ID
policyId: Policy ID [optional]
policy: Policy Name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules (Only for: ACL devices) [optional]
add: If set to \"documentation\" result will include rule documentation [optional]
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
groupBy: Show rules grouping criteria. Can be set only to \"bindings\". Output will be grouped by bindings and section header for Check Point devices, ACL for Cisco devices, and Zones for Juniper, Palo Alto, and Fortinet device [optional]
with_zb: Include zone based rules, values can be 'true' or 'false' [optional]
uid: Binding UID [optional]
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
subpolicy_name: Filter by sub policy name (see implementation notes) [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules?subpolicy_name=layer1&is_global=true

Usage Example
https://192.168.1.1/securetrack/api/devices/20/rules?interface=Loopback99:INSIDE
"},"response":[]},{"name":"Get a specific rule","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"ruleId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/rules/{{ruleId}}","description":"Parameters:
ruleId: Rule ID

Usage Example
https://192.168.1.1/securetrack/api/rules/60
"},"response":[]},{"name":"Find rules","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/rule_search/{{device_id}}","description":"The search_text parameter provides the same capabilities as the Policy Browser feature in SecureTrack.
You can search for a string across all rule fields, or you can search for a combination of specific strings in specific fields.
The text format is for a field is <fieldname>:<text> for example uid:9259f6ee-47a0-4996-a214-ab7edc14a916.
See the search info documentation in Securetrack Policy Browser page for more information.To get more information regarding objects included in the returned rules (like src_network or dst_network) use their uid, as the objects’ ID might change.
\n By default, if there are less than 3,000 rules - the API will return all the rules.\nIn case there are more than 3,000 rules the API will return an error code 413 with the error message “There are more than 3000 rules, you must use pagination”
“display_rule_number” should return only for Check Point R80 and higher devices.

Parameters:
context: Global MSSP context [optional]
search_text: Search text [optional]
device_id: Device id
start: The starting rule to include in the returned results [optional]
count: Number of rules to include in the results [optional]

Usage Example
https://192.168.1.1/securetrack/api/rule_search/31?search_text=source:Sales_192.168.2.60 fromzone:sales tozone:External

Usage Example
https://192.168.1.1/securetrack/api/rule_search/20?search_text=Mobile Access hascomment:false

Usage Example
https://192.168.1.1/securetrack/api/rule_search/87?search_text=web_server&start=0&count=10

Usage Example
URLhttps://192.168.1.1/securetrack/api/rule_search/59?search_text=uid:9259f6ee-47a0-4996-a214-ab7edc14a916
OUTPUT {
    \"rules\":{
        \"count\":1,
        \"total\":1,
        \"rule\":{
            \"@xsi.type\":\"securityRuleDTO\",
            \"id\":21,
            \"cp_uid\":\"\",
            \"uid\":\"{9259f6ee-47a0-4996-a214-ab7edc14a916}\",
            \"order\":2,
            \"binding\":{
                \"default\":true,
                \"policy\":{
                    \"@xsi.type\":\"managementDomainPolicyDTO\",
                    \"id\":2,
                    \"name\":\"Standard\",
                    \"installable_targets\":\"\"
                },
                \"rule_count\":19,
                \"security_rule_count\":19,
                \"uid\":\"{00-FACED0-00}\"
                },
            \"acceleration_breaker\":false,
            \"action\":\"Accept\",
            \"application\":{
                \"id\":4735,
                \"display_name\":\"ssh\",
                \"name\":\"ssh\"
            },
            \"authentication_rule\":false,
            \"comment\":\"DO NOT DELETE OR EDIT\",
            \"dst_network\":{
                \"id\":39,
                \"display_name\":\"Net_10.110.65.0\",
                \"name\":\"Net_10.110.65.0\"
                \"uid\":\"{1290f6ee-47a1-4996-a214-ab2edc26a916}\"
            },
            \"dest_networks_negated\":false,
            \"dst_service\":{
                \"id\":7420,
                \"display_name\":\"ssh\",
                \"name\":\"ssh\"
                \"uid\":\"{2904f6ee-47a1-4996-a214-ab2edc26a916}\"
            },
            \"dest_services_negated\":false,
            \"dst_zone\":\"any\",
            \"disabled\":false,
            \"external\":false,
            \"implicit\":false,
            \"dst_zone_any\":true,
            \"src_zone_any\":true,
            \"name\":\"Accept SSHG\",
            \"option\":\"LOG_SESSION\",
            \"documentation\":{
                \"permissiveness_level\":\"LOW\",
                \"shadowed\":\"Not shadowed\",
                \"last_modified\":\"Today\",
                \"last_hit\":\"N/A\",
                \"violations\":\"\"
            },
            \"rule_location\":\"Shared\",
            \"rule_location_display\":\"Shared - Pre Rule\",
            \"rule_number\":2,
            \"display_rule_number\":\"2.1\",
            \"rule_type\":\"universal\",
            \"src_zone\":\"any\",
            \"src_network\":{
                \"id\":38,
                \"display_name\":\"Net_10.110.64.0\",
                \"name\":\"Net_10.110.64.0\"
                \"uid\":\"{4934f6ee-47a1-4996-a214-ab2edc26a916}\"
            },
            \"src_networks_negated\":false,
            \"src_services_negated\":false,
            \"track\":{
                \"level\":\"LOG\"
            },
            \"type\":\"rule\",
            \"users\":{
                \"id\":5,
                \"display_name\":\"tufin\\\\regina\",
                \"name\":\"tufin\\\\regina@ldap\"
            }
        }
    }
}


Response Messages:
400: Value for start parameter is missing or not valid
400: Value for count parameter is missing or not valid
413: Max supported count is 3000
413: There are more than 3000 rules, you must use pagination"},"response":[]},{"name":"Get specific rule","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/rules/{{ids}}","description":"Returns a list of rules by revision ID, rule IDs and additional criteria

Parameters:
context: Global MSSP context [optional]
revision_id: Revision id
ids: Rule IDs
policy: Policy name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules (Only for: ACL devices) [optional]
add: If set to \\\"documentation\\\" result will include rule documentation [optional]
groupBy: Rules grouping criteria, can be set only to \\\"bindings\\\" [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules/16370
"},"response":[]},{"name":"Get rules by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/rules","description":"Returns a list of all of the security rules for the specified revision.
Use add=documentation to retrieve rule documentation.
The is_global parameter is device dependent. For ACL devices, only global rules are returned when set to true. For Check Point R80, only global layers are returned when set to true, and specify a layer name in the subpolicy_name parameter This parameter is ignored for all other vendors. The default value is false.
The subpolicy_name parameter is device dependent. For Check Point R80, only rules that use the specified layer are returned. You can only specify the name of a single layer. This parameter is ignored for all other vendors.
For Cisco ASA devices, when applying a filter you must also add the direction.


Parameters:
context: Global MSSP context [optional]
id: Revision id
policyId: Policy id [optional]
policy: Policy name [optional]
interface: Interfaces to query [optional]
zone: Zone name [optional]
is_global: Get global rules only(device dependent, see implementation Notes) [optional]
add: If set to \"documentation\" result will include rule documentation [optional]
start: Starting page for query, allowable type is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]
groupBy: Rules grouping criteria, can be set only to \"bindings\" [optional]
with_zb: Include zone-based rules [optional]
uid: Binding UID [optional]
ipType: Policy ip Type, values can be 'ipv4' or 'ipv6', supported only for Stonesoft [optional]
subpolicy_name: Filter by sub policy name (see implementation notes) [optional]
fetchMigratedCalculations [optional]
is_alternate_order: OrderBy alternate order, for display Aci rules by contracts [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules?subpolicy_name=layer1&is_global=true

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/rules?interface=Loopback99:INSIDE
"},"response":[]},{"name":"Create a CSV file for rules search results","request":{"method":"GET","header":[],"url":"https://{{SecureTrack_IP}}/securetrack/api/rule_search/export","description":"The search_text parameter provides the same capabilities as the Policy Browser feature in SecureTrack.
You can search for a string across all rule fields, or you can search for a combination of specific strings in specific fields.
The text format is for a field is : for example uid:9259f6ee-47a0-4996-a214-ab7edc14a916.
See the search info documentation in Securetrack Policy Browser page for more information.
This API exports the results data as a CSV file in the SecureTrack Reports Repository.

Parameters:
context: Global MSSP context [optional]
search_text: Search text [optional]

Usage Example
https://192.168.1.1/securetrack/api/rule_search/export

Usage Example
https://192.168.1.1/securetrack/api/rule_search/export?search_text=shadowed:true
"},"response":[]},{"name":"Get rule count per device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/rule_search/","description":"The search_text parameter provides the same capabilities as the Policy Browser feature in SecureTrack.
You can search for a string across all rule fields, or you can search for a combination of specific strings in specific fields.
The text format is for a field is <fieldname>:<text> for example uid:9259f6ee-47a0-4996-a214-ab7edc14a916.
See the search info documentation in Securetrack Policy Browser page for more information.
This API will return a list of all the devices, the devices that has rules that match the search criteria will have rule_count that is bigger than 0

Parameters:
context: Global MSSP context [optional]
search_text: Search text [optional]
devices: Devices ids [optional]

Usage Example
https://192.168.1.1/securetrack/api/rule_search/87

Usage Example
https://192.168.1.1/securetrack/api/rule_search/87?search_text=ICMP application:facebook

Usage Example
URLhttps://192.168.1.1/securetrack/api/rule_search?search_text=uid:9259f6ee-47a0-4996-a214-ab7edc14a916
OUTPUT{
    \"device_list\":{
        \"device\":[
            {
                \"device_id\":512,
                \"revision_id\":6864,
                \"rule_count\":1
            },
            {
                \"device_id\":59,
                \"revision_id\":543,
                \"rule_count\":0
            }
        ]
    }
}

"},"response":[]}]},{"name":"Services and Ports","item":[{"name":"Get services objects matching specified criteria","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"services\": {\n\t\t\"count\": 1,\n\t\t\"total\": 1,\n\t\t\"service:\": {\n\t\t\t\"id\": 169197,\n\t\t\t\"name\": \"tcp_10\",\n\t\t\t\"display_name\": \"tcp_10\",\n\t\t\t\"class_name\": \"access_role\",\n\t\t\t\"global\": false,\n\t\t\t\"device_id\": 158,\n\t\t\t\"comment\": \"\",\n\t\t\t\"uid\": \"{9EDC2607-6BEC-43D7-A99D-B522BA694ADA}\",\n\t\t\t\"implicit\": false,\n\t\t\t\"max\": false,\n\t\t\t\"min\": false,\n\t\t\t\"protocol\": 6,\n\t\t\t\"timeout\": \"\",\n\t\t\t\"type\": \"tcp_service\",\n\t\t\t}\n\t\t}\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/services/search","description":"You can search for service objects where the name or comment fields have a specified text string,
or you can search for service objects that have an Port or protocol that matches,
or you can search for service objects by uid.

Parameters:
context: Returns results for the specified domain ID. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]
filter: “text” filter returns service objects where the name or comment fields have a specified text string. \n“protocol” filter returns service objects that have a protocol that matches specified IP protocol number.\n“port” filter returns service objects that have a port that matches specified port number.\n “uid“ filter returns service objects with the specified uid.\n If no filter is specified, the “text” filter is used.
device_id: Returns service objects belonging to the specified device_id. [optional]
name: (For “text” filter) You can specify \"name\" to find service objects with the specified text in the name field. [optional]
comment: (For “text” filter) You can specify “comment” to find service objects with the specified text in the comment field. [optional]
protocol: Specify Protocolto find service objects that have the specified IP Protocol. [optional]
port: Specify Portto find service objects that have the specified Port. [optional]
uid: (for “uid“ filter) Returns service objects with the specified uid. [optional]

Usage Example
https://192.168.1.1/securetrack/api/services/search?filter=protocol&protocol=6&device_id=68

Usage Example
https://192.168.1.1/securetrack/api/services/search?filter=port&port=80

Usage Example
https://192.168.1.1/securetrack/api/services/search?filter=uid&uid=24a8774d-24c1-4b3a-aae9-3c272a2b5191

Usage Example
URLhttps://192.168.1.1/securetrack/api/services/search?filter=text&name=tcp_10
BODY{
    \"services\": {
        \"count\": 1,
        \"total\": 1,
        \"service:\": {
            \"id\": 169197,
            \"name\": \"tcp_10\",
            \"display_name\": \"tcp_10\",
            \"class_name\": \"access_role\",
            \"global\": false,
            \"device_id\": 158,
            \"comment\": \"\",
            \"uid\": \"{9EDC2607-6BEC-43D7-A99D-B522BA694ADA}\",
            \"implicit\": false,
            \"max\": false,
            \"min\": false,
            \"protocol\": 6,
            \"timeout\": \"\",
            \"type\": \"tcp_service\",
            }
        }
    }
}

"},"response":[]},{"name":"Get rules containing specified service object","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/services/{{id}}/rules","description":"Returns the security rules that contain the specified service object


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the service object.
include_groups: You can add \"include_groups\" to find rules that include the service object and rules that include the groups that include the service object. [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses “count=100”. [optional]

Usage Example
https://192.168.1.1/securetrack/api/services/65078/rules?include_groups=true
"},"response":[]},{"name":"Get specific service","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/services/{{ids}}","description":"Fetches list of specific service objects defined in revision given by revision ID and specified by their IDs

Parameters:
context: Global MSSP context [optional]
revision_id: Revision id
ids: Rule IDs
show_members: Set to false to return only the name and ID of the members [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/services/959888
"},"response":[]},{"name":"Get service groups containing specified service objects","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/services/{{id}}/groups","description":"Returns groups that contain the specified service objects


Parameters:
context: Returns results for the specified domain ID. [optional]
id: The SecureTrack object ID of the service object.

Usage Example
https://192.168.1.1/securetrack/api/services/69577/groups
"},"response":[]},{"name":"Get specific service","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"device_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{device_id}}/services/{{ids}}","description":"Fetches list of specific service objects defined in device given by device ID and specified by their IDs.
Note: This API retrieves the information from the latest revision.

Parameters:
context: Global MSSP context [optional]
device_id: Device ID
ids: Service object IDs separated by commas
show_members: Set to false to return only the name and ID of the members [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/services/959888,959966
"},"response":[]},{"name":"Get services by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/services","description":"Fetches list of service objects defined on device given by device ID.
The default value for get_total is false. For APIF 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.


Parameters:
context: Global MSSP context [optional]
id: Device ID
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
start: Starting page for query allowable types are numeric [optional]
count: Number of pages for query allowable values are numeric [optional]
name: Service name [optional]
type: Service type, allowable values are: tcp, udp, ip or icmp [optional]
port: Service port [optional]
icmp_type: Service ICMP type allowable values are numeric between 0 to 40 [optional]
protocol: Service protocol, allowable values are numeric between 0 to 255 [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]
add_parent_objects: Panorama only: Get objects from parent DGs (default true) [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/20/services?get_total=true
OUTPUT {
    \"services\": {
        \"count\": 50,
        \"total\": 100,
        \"service\": [{
            \"@xsi.type\": \"singleServiceDTO\",
            \"id\": 5129479,
            \"name\": \"Tcp30025\",
            \"display_name\": \"Tcp30025\",
            \"class_name\": \"tcp_service\",
            \"type\": \"tcp_service\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{079F15A5-009E-7E47-BBD0-E65973646562}\",
            \"implicit\": false,
            \"overrides\": false,
            \"max\": 30025,
            \"min\": 30025,
            \"negate\": false,
            \"protocol\": 6,
            \"timeout\": 0
        }]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/devices/31/services?type=group&show_members=false
OUTPUT{
    \"services\": {
    \"count\": 100,
        \"service\": [
            {
                \"@xsi.type\": \"serviceGroupDTO\",
                \"id\": 1359066,
                \"name\": \"#Shared Domain@DNS\",
                \"display_name\": \"DNS\",
                \"class_name\": \"service_group\",
                \"type\": \"group\",
                \"global\": \"false\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": false,
                \"overrides\": \"false\",
                \"type_on_device\": gen_service_group,
                \"is_device_predefined\": true,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"DNS\",
                    \"name\": \"#Shared Domain@DNS\",
            }
        ]
    }
}

"},"response":[]},{"name":"Get services by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/services","description":"Fetches list of service objects defined in revision given by revision ID
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.


Parameters:
context: Global MSSP context [optional]
id: Revision id
show_members: Set to false to return only the name and ID of the members for relevant types like \"group\" [optional]
start: Starting page for query allowable types are numeric [optional]
count: Number of pages for query allowable values are numeric [optional]
name: Service name [optional]
type: Service type, allowable values are: tcp, udp, ip or icmp [optional]
port: Service port [optional]
icmp_type: Service ICMP type allowable values are numeric between 0 to 40 [optional]
protocol: Service protocol, allowable values are numeric betweenm 0 to 255 [optional]
get_total: Set to true to get the total number of items that can be retrieved [optional]
add_parent_objects: Panorama only: Get objects from parent DGs (default true) [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/785/services?get_total=true
OUTPUT {
    \"services\": {
        \"count\": 50,
        \"total\": 100,
        \"service\": [{
            \"@xsi.type\": \"singleServiceDTO\",
            \"id\": 5129479,
            \"name\": \"Tcp30025\",
            \"display_name\": \"Tcp30025\",
            \"class_name\": \"tcp_service\",
            \"type\": \"tcp_service\",
            \"global\": false,
            \"comment\": \"\",
            \"uid\": \"{079F15A5-009E-7E47-BBD0-E65973646562}\",
            \"implicit\": false,
            \"overrides\": false,
            \"max\": 30025,
            \"min\": 30025,
            \"negate\": false,
            \"protocol\": 6,
            \"timeout\": 0
        }]
    }
}


Usage Example
URLhttps://192.168.1.1/securetrack/api/revisions/31/services?type=group&show_members=false
OUTPUT{
    \"services\": {
    \"count\": 100,
        \"service\": [
            {
                \"@xsi.type\": \"serviceGroupDTO\",
                \"id\": 1359066,
                \"name\": \"#Shared Domain@DNS\",
                \"display_name\": \"DNS\",
                \"class_name\": \"service_group\",
                \"type\": \"group\",
                \"global\": \"false\",
                \"comment\": \"\",
                \"uid\": \"{83c8512c-2a4a-43f4-bef2-dd96276611e8}\",
                \"implicit\": false,
                \"overrides\": \"false\",
                \"type_on_device\": gen_service_group,
                \"is_device_predefined\": true,
                \"member\":
                    \"id\": 105936,
                    \"uid\": \"{ed46ff90-11c8-4425-b8da-85852ee3e5b0}\",
                    \"display_name\": \"DNS\",
                    \"name\": \"#Shared Domain@DNS\",
            }
        ]
    }
}

"},"response":[]}]},{"name":"Time Objects","item":[{"name":"Get specific time object","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"revision_id"},{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{revision_id}}/time_objects/{{ids}}","description":"Fetches list of time objects by revision ID and rule ID

Parameters:
context: Global MSSP context [optional]
revision_id: Revision ID
ids: Rule IDs

Usage Example
https://192.168.1.1/securetrack/api/revisions/7/time_objects/9
"},"response":[]},{"name":"Get time objects by device","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/devices/{{id}}/time_objects","description":"Returns the time objects used in the specified device.

Parameters:
context: Global MSSP context [optional]
id: Device ID
start: Starting page for query allowable values are numeric [optional]
count: Starting page for query allowable values are numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/devices/20/time_objects
"},"response":[]},{"name":"Get time objects by revision","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/revisions/{{id}}/time_objects","description":"Returns the time objects used in the specified revision.

Parameters:
context: Global MSSP context [optional]
id: Revision ID
start: Starting page for query allowable value is numeric [optional]
count: Number of pages for query starting from starting page, allowable type is numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/revisions/785/time_objects
"},"response":[]}]},{"name":"Traffic Policy Matcher","item":[{"name":"Get policy relevance metrics for traffic","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"relevance_metrics\": {\n\t\t\"source_ips\": {\n\t\t\t\"source\":[\"10.10.253.0/24\", \"172.31.50.99/32\"]\n\t\t},\n\t\t\"dest_ips\": {\n\t\t\t\"dest\": [\"172.31.150.0/24\", \"172.31.50.99/32\"]\n\t\t},\n\t\t\"targets\": {\n\t\t\t\"target\": [4, 10]\n\t\t}\n\t}\n}\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/traffic_policy/","description":"The response lists all the relevant security groups, tags, relevant instances, and count of unrelated instances for each Amazon VPC in the specified traffic path.
A relevant security group contains at least one instance including either the source or destination IP address.
An unrelated instance is included in the security group but not part of the specified traffic path.
If context is provided, path will be calculated for the specified domain context, otherwise the default domain context is used. context is used only if MSSP mode is enabled. If MSSP mode is disabled context is ignored.
To get the context, call the /domains/ API and use the ID included within the returned domain DTO.

Parameters:
context: Global MSSP context [optional]
body: Relevance metrics request

Usage Example
URLhttps://192.168.1.1/securetrack/api/traffic_policy
BODY{
    \"relevance_metrics\": {
        \"source_ips\": {
            \"source\":[\"10.10.253.0/24\", \"172.31.50.99/32\"]
        },
        \"dest_ips\": {
            \"dest\": [\"172.31.150.0/24\", \"172.31.50.99/32\"]
        },
        \"targets\": {
            \"target\": [4, 10]
        }
    }
}


Response Messages:
200: Successful
403: Insufficient user permissions
404: Device not found
400: Invalid parameters"},"response":[]}]},{"name":"Unified Security Policy - Access Request Violations","item":[{"name":"Get violation task status","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/status/{{taskId}}","description":"Get access requests violations task status.

Parameters:
taskId: The unique identifier of the access request violations task.

Usage Example
https://192.168.1.1/securetrack/api/violations/access_requests/status/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Access request violations task status was received.
403: Access is denied.
404: Access request violations task status was not found."},"response":[]},{"name":"Get violations for an access request","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t false\n\t 0\n\t \n\t \n\t\t \n\t\t false\n\t\t 10.100.0.1\n\t\t 255.255.255.255\n\t\t \n\t \n\t \n\t\t ssh\n\t\t \n\t\t \n\t \n\t \n\t\t \n\t\t\t false\n\t\t\t 6\n\t\t\t 6\n\t\t\t 22\n\t\t\t 22\n\t\t\t false\n\t\t \n\t \n\t \n\t\t Gmail\n\t \n\t \n\t\t CustomApp\n\t\t \n\t\t\t \n\t\t\t\t false\n\t\t\t\t 6\n\t\t\t\t 6\n\t\t\t\t 80\n\t\t\t\t 80\n\t\t\t\t false\n\t\t\t \n\t\t \n\t \n\t ACCEPT\n\t\n\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/sync","description":"Calculate the violations for the given access request.
Note: this API may take a while to complete.
See the asynchronous API /violations/access_request/task as an alternative.

Parameters:
body: AccessRequestListDTO
use_topology: Use topology to determine access request domains. [optional]
ar_domain_mode: The access request supports multiple domains. [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/violations/access_requests/sync?use_topology=false&ar_domain_mode=false
BODY<access_requests>
    <access_request>
     <use_topology>false</use_topology>
     <access_request_order>0</access_request_order>
     <access_request_source xsi:type=\"internet\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"/>
     <access_request_destination xsi:type=\"ip_network\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <network xsi:type=\"raw_network_subnet\">
         <negate>false</negate>
         <ip>10.100.0.1</ip>
         <mask>255.255.255.255</mask>
         </network>
     </access_request_destination>
     <access_request_service xsi:type=\"implicit_service\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <name>ssh</name>
         <service>
         </service>
     </access_request_service>
     <access_request_service xsi:type=\"implicit_service\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <service>
             <predefined>false</predefined>
             <min_protocol>6</min_protocol>
             <max_protocol>6</max_protocol>
             <min_port>22</min_port>
             <max_port>22</max_port>
             <negate>false</negate>
         </service>
     </access_request_service>
     <access_request_application xsi:type=\"access_request_application_identity\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <name>Gmail</name>
     </access_request_application>
     <access_request_application xsi:type=\"access_request_application_identity\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <name>CustomApp</name>
         <application_service xsi:type=\"implicit_service\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
             <service>
                 <predefined>false</predefined>
                 <min_protocol>6</min_protocol>
                 <max_protocol>6</max_protocol>
                 <min_port>80</min_port>
                 <max_port>80</max_port>
                 <negate>false</negate>
             </service>
         </application_service>
     </access_request_application>
     <action>ACCEPT</action>
    </access_request>
</access_requests>


Response Messages:
200: Access request violations were calculated.
400: Access request order is not unique.
400: Domain cannot be specified when domain mode is false.
400: Cannot specify both ticket domain id and source and destination domains.
400: No domain specified in MSSP mode.
400: Domain does not exist.
400: Access request is malformed.
400: No valid access requests (Access requests cannot have topology enabled and the Internet object in the Source/Destination).
403: Access is denied.
400: Custom applications must have their services configured."},"response":[]},{"name":"Cancel violation task","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/task/{{taskId}}","description":"Delete an access request violations task.

Parameters:
taskId: The unique identifier of the access request violations task.

Usage Example
https://192.168.1.1/securetrack/api/violations/access_requests/task/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
204: Access request violations task has been aborted successfully.
403: Access is denied.
404: Access request violations task was not found."},"response":[]},{"name":"Get violation task results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/result/{{taskId}}","description":"Get result of access requests violations task.

Parameters:
taskId: The unique identifier of the access request violations task.

Usage Example
https://192.168.1.1/securetrack/api/violations/access_requests/result/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Access request violations task results were received.
403: Access is denied.
404: An error occurred during the calculation.
404: The calculation for the task has not finished yet."},"response":[]},{"name":"Start a task to calculate violations for an access request","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\t\n\t false\n\t 0\n\t \n\t \n\t\t \n\t\t false\n\t\t 10.100.0.1\n\t\t 255.255.255.255\n\t\t \n\t \n\t \n\t\t ssh\n\t\t \n\t\t \n\t \n\t \n\t\t \n\t\t\t false\n\t\t\t 6\n\t\t\t 6\n\t\t\t 22\n\t\t\t 22\n\t\t\t false\n\t\t \n\t \n\t \n\t\t Gmail\n\t \n\t \n\t\t CustomApp\n\t\t \n\t\t\t \n\t\t\t\t false\n\t\t\t\t 6\n\t\t\t\t 6\n\t\t\t\t 80\n\t\t\t\t 80\n\t\t\t\t false\n\t\t\t \n\t\t \n\t \n\t ACCEPT\n\t\n\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/violations/access_requests/task","description":"Create a calculation task to find access requests violations.
Returns a task Id that can be used to check the task status and get the task results

Parameters:
body [optional]
use_topology: Use topology to determine access request domains. [optional]
ar_domain_mode: The access request uses resources from multiple domains. [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/violations/access_requests/task?use_topology=false&ar_domain_mode=false
BODY<access_requests>
    <access_request>
     <use_topology>false</use_topology>
     <access_request_order>0</access_request_order>
     <access_request_source xsi:type=\"internet\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"/>
     <access_request_destination xsi:type=\"ip_network\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <network xsi:type=\"raw_network_subnet\">
         <negate>false</negate>
         <ip>10.100.0.1</ip>
         <mask>255.255.255.255</mask>
         </network>
     </access_request_destination>
     <access_request_service xsi:type=\"implicit_service\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <name>ssh</name>
         <service>
         </service>
     </access_request_service>
     <access_request_service xsi:type=\"implicit_service\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <service>
             <predefined>false</predefined>
             <min_protocol>6</min_protocol>
             <max_protocol>6</max_protocol>
             <min_port>22</min_port>
             <max_port>22</max_port>
             <negate>false</negate>
         </service>
     </access_request_service>
     <access_request_application xsi:type=\"access_request_application_identity\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <name>Gmail</name>
     </access_request_application>
     <access_request_application xsi:type=\"access_request_application_identity\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
         <name>CustomApp</name>
         <application_service xsi:type=\"implicit_service\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
             <service>
                 <predefined>false</predefined>
                 <min_protocol>6</min_protocol>
                 <max_protocol>6</max_protocol>
                 <min_port>80</min_port>
                 <max_port>80</max_port>
                 <negate>false</negate>
             </service>
         </application_service>
     </access_request_application>
     <action>ACCEPT</action>
    </access_request>
</access_requests>


Response Messages:
202: Access request violations task was accepted.
400: Access request order is not unique.
400: Domain cannot be specified when domain mode is false.
400: Cannot specify both ticket domain id and source and destination domains.
400: No domain specified in MSSP mode.
400: Domain does not exist.
400: Access request is malformed.
400: No valid access requests (Access requests cannot have topology enabled and the Internet object in the Source/Destination)
400: No network source were specified.
400: No network destination were specified.
403: Access is denied.
503: Access request violations task was rejected.
400: Custom applications must have their services configured."},"response":[]}]},{"name":"Unified Security Policy - Alerts","item":[{"name":"Get a specific alert","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/{{id}}","description":"Returns a specified alert.
If the alert_id does not exist, an error message is returned.

Parameters:
context: MSSP context [optional]
id: The alert Id

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts/1

Response Messages:
403: Alert ID does not exist"},"response":[]},{"name":"Update an alert","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"usp_alert_configuration\": {\n\t\t\"name\": \"uspAlert\",\n\t\t\"description\": \"description\",\n\t\t\"status\": \"ACTIVE\",\n\t\t\"domain_id\": 6,\n\t\t\"all_devices\": false,\n\t\t\"device_ids\": {\n\t\t\t\"device_id\": [\n\t\t\t\t1,\n\t\t\t\t2,\n\t\t\t\t3,\n\t\t\t\t4\n\t\t\t]\n\t\t},\n\t\t\"low_severity\": true,\n\t\t\"medium_severity\": true,\n\t\t\"high_severity\": true,\n\t\t\"critical_severity\": false,\n\t\t\"user_ids\": {\n\t\t\t\"user_id\": [\n\t\t\t\t\"moshe\",\n\t\t\t\t\"admin\"\n\t\t\t\t]\n\t\t},\n\t\t\"emails\": \"user@doamin.com\",\n\t\t\"send_syslog\": true\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/{{id}}","description":"Update an alert for unified security policies.
Alerts can be defined for all devices (all_devices:true) or for specified device IDs.
An email and/or user name must be defined. For multiple entries of emails or user names, use a semicolon to separate values. For SecureTrack, users in the collection are populated with \"user_ids\". The alert will be sent to the users (according to the addresses configured in SecureTrack) and to the emails.
To get the domain_id (optional parameter), call /domains/ API and use the ID included within the returned domain DTO.
At least one severity should be marked as 'true'.
There are no default values

Parameters:
context: Global MSSP context [optional]
id: The alert ID for updating [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_policies/alerts/1
BODY{
    \"usp_alert_configuration\": {
        \"name\": \"uspAlert\",
        \"description\": \"description\",
        \"status\": \"ACTIVE\",
        \"domain_id\": 6,
        \"all_devices\": false,
        \"device_ids\": {
            \"device_id\": [
                1,
                2,
                3,
                4
            ]
        },
        \"low_severity\": true,
        \"medium_severity\": true,
        \"high_severity\": true,
        \"critical_severity\": false,
        \"user_ids\": {
            \"user_id\": [
                \"moshe\",
                \"admin\"
                ]
        },
        \"emails\": \"user@doamin.com\",
        \"send_syslog\": true
    }
}


Response Messages:
204: Alert ID: 'alertId' was updated successfully
404: Alert ID: 'alertId' does not exist
412: Alert name not specified
409: Alert name specified already exists
412: Status not specified
412: Domain not specified
404: Domain specified does not exist
403: User is not authorized to configure alerts for domain 'domainId'
412: Device not specified
404: Device ID specified does not exist or belongs to a different domain
403: Device: 'deviceId' not supported for USP
412: Severity not specified
412: No recipient details entered for alert
412: Invalid email address. Format must be name@domain.com
404: Username: 'userName' does not exist
403: User is not authorized to configure alerts for Super Admin user: 'userName'
403: Username: 'userName' not valid for the specified domain"},"response":[]},{"name":"Get alerts","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"start"},{"value":null,"type":"text","key":"count"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/","description":"Returns a list of all alerts. If an empty list is returned, it implies that there are no configured alerts for that context.
You must set start and count parameters to limit the number of returned alerts.
Start is zero based - to start from the second rule use start=1, to get rules 51-60 use start=50 and count=10.

Parameters:
context: MSSP context [optional]
start: Returns the results beginning with the specified result number
count: Returns the specified number of results

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts?start=10&count=25

Response Messages:
400: Value for start parameter is missing or not valid
400: Value for count parameter is missing or not valid"},"response":[]},{"name":"Create an alert","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"usp_alert_configuration\": {\n\t\t\"name\": \"uspAlert\",\n\t\t\"description\": \"description\",\n\t\t\"status\": \"ACTIVE\",\n\t\t\"domain_id\": 6,\n\t\t\"all_devices\": false,\n\t\t\"device_ids\": {\n\t\t\t\"device_id\": [\n\t\t\t\t1,\n\t\t\t\t2,\n\t\t\t\t3,\n\t\t\t\t4\n\t\t\t]\n\t\t},\n\t\t\"low_severity\": true,\n\t\t\"medium_severity\": true,\n\t\t\"high_severity\": true,\n\t\t\"critical_severity\": false,\n\t\t\"user_ids\": {\n\t\t\t\"user_id\": [\n\t\t\t\t\"moshe\",\n\t\t\t\t\"admin\"\n\t\t\t\t]\n\t\t},\n\t\t\"emails\": \"user@doamin.com\",\n\t\t\"send_syslog\": true\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/","description":"Create an alert for unified security policies.
Returns location with the alert id to get the alert.
Alerts can be defined for all devices (all_devices:true) or for specified device IDs.
An email and/or user name must be defined. For multiple entries of emails or user names, use a semicolon to separate values. For SecureTrack, users in the collection are populated with \"user_ids\". The alert will be sent to the users (according to the addresses configured in SecureTrack) and to the emails.
To get the domain_id (optional parameter), call /domains/ API and use the ID included within the returned domain DTO.
At least one severity should be marked as 'true'.
There are no default values

Parameters:
context: Global MSSP context [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_policies/alerts
BODY{
    \"usp_alert_configuration\": {
        \"name\": \"uspAlert\",
        \"description\": \"description\",
        \"status\": \"ACTIVE\",
        \"domain_id\": 6,
        \"all_devices\": false,
        \"device_ids\": {
            \"device_id\": [
                1,
                2,
                3,
                4
            ]
        },
        \"low_severity\": true,
        \"medium_severity\": true,
        \"high_severity\": true,
        \"critical_severity\": false,
        \"user_ids\": {
            \"user_id\": [
                \"moshe\",
                \"admin\"
                ]
        },
        \"emails\": \"user@doamin.com\",
        \"send_syslog\": true
    }
}


Response Messages:
201: Security policy alert id :|'alertId'| , name : 'alertName'
412: Alert name not specified
409: Alert name specified already exists
412: Status not specified
412: Domain not specified
404: Domain specified does not exist
403: User is not authorized to configure alerts for domain 'domainId'
412: Device not specified
404: Device ID specified does not exist or belongs to a different domain
403: Device: 'deviceId' not supported for USP
412: Severity not specified
412: No recipient details entered for alert
412: Invalid email address. Format must be name@domain.com
404: Username: 'userName' does not exist
403: User is not authorized to configure alerts for Super Admin user: 'userName'
403: Username: 'userName' not valid for the specified domain"},"response":[]},{"name":"Delete alerts by ids","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"ids"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/alerts/{{ids}}","description":"Delete specified alerts by IDs
To delete multiple alert_ids, use a comma between each ID

Parameters:
context: Delete alerts in the specified domain ID. [optional]
ids: The alert Ids for deletion

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts/87

Usage Example
https://192.168.1.1/securetrack/api/security_policies/alerts/86,87,88

Response Messages:
200:
403: Security Policy Alert Ids: :|'alert ids'| don't exist"},"response":[]}]},{"name":"Unified Security Policy - Cloud Tag Policy","item":[{"name":"Delete cloud tag policy","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","description":"Delete the cloud tag policy specified by policyId.

If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Delete policy of the specified domain ID [optional]
policyId: cloud tag policy id [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/policyId
OUTPUT {
        \"status\": \"OK\",
        \"policy_name\": \"myPolicyName\"
}


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions
404: Resource not found"},"response":[]},{"name":"Get cloud tag policy","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","description":"This API retrieves the details of the cloud tag policy specified by policyId.

User must have admin permissions to the policy affiliated domain. If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Returns results for the specified domain ID [optional]
policyId: cloud tag policy id [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/policyId
OUTPUT{
        \"status\": \"OK\",
        \"result\": [
                {
                        \"policy_id\": \"tp-101\",
                        \"policy_name\": \"myPolicyName\",
                        \"requirements\": [
                                {
                                        \"requirement_type\": \"mandatory_tags\",
                                        \"requirement_name\": \"myMandatoryTagsRequirement\",
                                    \"requirement_severity\": \"CRTICAL\",
                                        \"tags\": [
                                                \"Owner\",
                                                \"Name\"
                                        ]
                                },
                                {
                                        \"requirement_type\": \"valid_values\",
                                        \"requirement_name\": \"myValidValueRequirement\",
                                    \"requirement_severity\": \"CRTICAL\",
                                        \"tag\": \"Budget\",
                                        \"values\": [
                                                \"R&D\",
                                                \"HR\"
                                        ]
                                }
                        ]
                }
        ]
}


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions
404: Resource not found"},"response":[]},{"name":"Replace a cloud tag policy","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"policy_name\": \"myPolicyName\",\n\t\"requirements\": [\n\t\t{\n\t\t\t\"requirement_type\": \"mandatory_tags\",\n\t\t\t\"requirement_name\": \"mandatory_requirement1\",\n\t\t\t\"requirement_severity\": \"CRTICAL\",\n\t\t\t\"tags\": [\n\t\t\t\t\"Owner\",\n\t\t\t\t\"Role\"\n\t\t\t]\n\t\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","description":"Replace the cloud tag policy specified by policyID with the new policy attributes.

Use PATCH in order to partially modify a policy. If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Replace policy of the specified domain ID [optional]
policyId: cloud tag policy id [optional]
body: cloud tag policy dTO [optional]

Usage Example
URLhttps://{ip}/securetrack/api/tagpolicy/policies/policyId
BODY{
    \"policy_name\": \"myPolicyName\",
    \"requirements\": [
        {
            \"requirement_type\": \"mandatory_tags\",
            \"requirement_name\": \"mandatory_requirement1\",
            \"requirement_severity\": \"CRTICAL\",
            \"tags\": [
                \"Owner\",
                \"Role\"
            ]
        }
    ]
}
OUTPUT{
        \"status\": \"OK\",
        \"policy_id\": \"tp-123\"
}

"},"response":[]},{"name":"Modify a cloud tag policy","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"policy_name\": \"myPolicyName\",\n\t\"requirements\": [\n\t\t{\n\t\t\t\"requirement_type\": \"mandatory_tags\",\n\t\t\t\"requirement_name\": \"mandatory_requirement1\",\n\t\t\t\"requirement_severity\": \"CRTICAL\",\n\t\t\t\"tags\": [\n\t\t\t\t\"Owner\",\n\t\t\t\t\"Role\"\n\t\t\t]\n\t\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/policies/{{policyId}}","description":"Partially modify a cloud tag policy by stating the modified attributes. Providing requirements replaces the entire list.

Specifying an empty requirement list is not permitted. Modify some attributes of the cloud tag policy specified by policyID with the attributes provided. If one or more \"requirement\" objects is provided, the exsiting \"requirement\" objects will be deleted and replaced with the new objetcs. Specifying an empty requirement list is not permitted.If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Rename policy of the specified domain ID [optional]
policyId: cloud tag policy id [optional]
body: cloud tag policy dTO [optional]

Usage Example
URLhttps://{ip}/securetrack/api/tagpolicy/policies/policyId
BODY{
    \"policy_name\": \"myPolicyName\",
    \"requirements\": [
        {
            \"requirement_type\": \"mandatory_tags\",
            \"requirement_name\": \"mandatory_requirement1\",
            \"requirement_severity\": \"CRTICAL\",
            \"tags\": [
                \"Owner\",
                \"Role\"
            ]
        }
    ]
}
OUTPUT{
        \"status\": \"OK\",
        \"policy_id\": \"tp-123\"
}


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions
404: Resource not found"},"response":[]},{"name":"Get all cloud tag policies","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/policies/","description":"This API returns the details of all the tag policies.

Results are filtered according to user domain permissions and request context. If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Returns results for the specified domain ID [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/
OUTPUT{
        \"status\": \"OK\",
        \"result\": [
                {
                        \"policy_id\": \"tp-101\",
                        \"policy_name\": \"myPolicy1\",
                        \"requirements\": [
                                {
                                        \"requirement_type\": \"mandatory_tags\",
                                        \"requirement_name\": \"myMandatoryRequirement\",
                                        \"requirement_severity\": \"HIGH\",
                                        \"tags\": [
                                                \"Owner\",
                                                \"Name\"
                                        ]
                                },
                                {
                                        \"requirement_type\": \"valid_values\",
                                        \"requirement_name\": \"myValidValueRequirement\",
                                        \"requirement_severity\": \"CRTICAL\",
                                        \"tag\": \"Budget\",
                                        \"values\": [
                                                \"R&D\",
                                                \"HR\"
                                        ]
                                }
                        ]
                },
                {
                        \"policy_id\": \"tp-102\",
                        \"policy_name\": \"myPolicy2\",
                        \"requirements\": [
                                {
                                        \"requirement_type\": \"mandatory_tags\",
                                        \"requirement_name\": \"myMandatoryRequirement\",
                                        \"requirement_severity\": \"HIGH\",
                                        \"tags\": [
                                                \"Owner\"
                                        ]
                                },
                                {
                                        \"requirement_type\": \"valid_values\",
                                        \"requirement_name\": \"myValidValueRequirement\",
                                        \"requirement_severity\": \"CRTICAL\",
                                        \"tag\": \"Budget\",
                                        \"values\": [
                                                \"R&D\",
                                                \"HR\"
                                        ]
                                }
                        ]
                }
        ]
}


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions"},"response":[]},{"name":"Create a cloud tag policy","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":" {\n\t\"policy_name\": \"Production-VPC-Tag-Policy\",\n\t\"policy_description\": \"Instances tags in production\",\n\t\"requirements\": [\n\t\t{\n\t\t\t\"requirement_type\": \"mandatory_tags\",\n\t\t\t\"requirement_name\": \"mandatory_financial_tags\",\n\t\t\t\"requirement_severity\": \"HIGH\",\n\t\t\t\"tags\": [\n\t\t\t\t\"Owner\",\n\t\t\t\t\"Budget\"\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"requirement_type\": \"valid_values\",\n\t\t\t\"requirement_name\": \"budget_valid_values\",\n\t\t\t\"requirement_severity\": \"CRITICAL\",\n\t\t\t\"tag\": \"Budget\",\n\t\t\t\"values\": [\n\t\t\t\t\"Corporate\",\n\t\t\t\t\"Dev\"\n\t\t\t]\n\t\t}\n\t]\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/policies/","description":"Create a new cloud tag policy. The policyName field specified in the TagPolicyDTO must be unique. Define the requirements enforced by the cloud tag policy in the requirements field of the TagPolicyDTO. The supported value for the \"requirement_type\" field are \"mandatory_tags\" and \"valid_values\"If the return code is not OK, the errorMessage field of the TagPolicyResponseDTO may contain additional details describing the cause of the error.

Parameters:
context: Create policy for the specified domain ID [optional]
body: cloud tag policy DTO [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/policies/
BODY {
    \"policy_name\": \"Production-VPC-Tag-Policy\",
    \"policy_description\": \"Instances tags in production\",
    \"requirements\": [
        {
            \"requirement_type\": \"mandatory_tags\",
            \"requirement_name\": \"mandatory_financial_tags\",
            \"requirement_severity\": \"HIGH\",
            \"tags\": [
                \"Owner\",
                \"Budget\"
            ]
        },
        {
            \"requirement_type\": \"valid_values\",
            \"requirement_name\": \"budget_valid_values\",
            \"requirement_severity\": \"CRITICAL\",
            \"tag\": \"Budget\",
            \"values\": [
                \"Corporate\",
                \"Dev\"
            ]
        }
    ]
}
OUTPUT{
        \"status\": \"OK\",
        \"policy_id\": \"tp-123\"
}


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions
409: Policy name already exists"},"response":[]},{"name":"Check if tags are compliant with cloud tag policies","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":" {\n\t\"type\": \"vm\",\n\t\"name\": \"CRM-FE\",\n\t\"os\": \"ubuntu14.4\",\n\t\"image\": \"AMI-12345\",\n\t\"tags\": {\n\t\t\"Role\": \"webserver\",\n\t\t\"Budget\": \"corporate\",\n\t\t\"Owner\": \"Steve.Smith\"\n\t}\n}"},"url":"https://{{SecureTrack_IP}}/securetrack/api/violation_check/","description":"Check if the tags of a cloud resource are compliant with the specified cloud tag policy. Specify the tag policy to validate in the TagPolicyViolationsCheckRequestDTO. The tags of a cloud resource are specified as a json object with the attribute 'tags' at the root level. 'tags' attributes can be a list of tag names or a map including both the tag name and value. If no tags are specified or if the tag is specified incorrectly, The compliance check will treat the resource as if it has no tags. If no cloud tag policy violations are found the API returns an empty violations list.

Parameters:
context: Returns results for the specified domain ID [optional]
policy_external_id: Tag policy external identifier
body: Tag policy violation check request

Usage Example
URLhttps://192.168.1.1/securetrack/api/tagpolicy/violation_check?policy_external_id=policyId
BODY {
    \"type\": \"vm\",
    \"name\": \"CRM-FE\",
    \"os\": \"ubuntu14.4\",
    \"image\": \"AMI-12345\",
    \"tags\": {
        \"Role\": \"webserver\",
        \"Budget\": \"corporate\",
        \"Owner\": \"Steve.Smith\"
    }
}


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions
404: Resource not found"},"response":[]},{"name":"Get all cloud tag policy violations for a VPC","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"deviceId"},{"value":null,"type":"text","key":"severity"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/tag_violations/","description":"Retrieve all cloud tag policy violations for the specified VPC and severity level.

Parameters:
context: Global MSSP context. [optional]
deviceId: The device ID for which to get violations
severity: Return only violations of this severity
resourceId: The id of the VM instance [optional]
start: Returns the results beginning with the specified result number. [optional]
count: Returns the specified number of results. If this field is not added or if a number greater than 100 is specified, the query uses \"count=100\". [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/tag_violations?deviceId=123&severity=CRITICAL
OUTPUT<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>
<tag_policy_device_violations>
    <violating_resources_count>2</violating_resources_count>
    <device_name>Amazon Test VPC </device_name>
    <severity>critical</severity>
    <violating_resources>
        <violating_resource>
            <tag_violations>
                <tag_violation>
                    <violation_message>Tag 'Name' value 'email server' is not valid. Valid values are [R&D, HR]</violation_message>
                    <policy_id>tp-100</policy_id>
                    <policy_name>Tag policy 1</policy_name>
                    <requirement_name>validValue_constraint2</requirement_name>
                    <requirement_severity>high</requirement_severity>
                    <violation_attributes xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"valid_values\">
                        <tag>Name</tag>
                        <valid_values>
                            <valid_value>R&D</valid_value>
                            <valid_value>HR</valid_value>
                        </valid_values>
                        <invalid_value>email server</invalid_value>
                    </violation_attributes>
                </tag_violation>
            </tag_violations>
            <resource_id>i-abc12345</resource_id>
            <resource_name>email server</resource_name>
        </violating_resource>
        <violating_resource>
            <tag_violations>
                <tag_violation>
                    <violation_message>Tag 'Application' is missing</violation_message>
                    <policy_id>tp-105</policy_id>
                    <policy_name>Tag policy 1</policy_name>
                    <requirement_name>mandatory_constraint1</requirement_name>
                    <requirement_severity>critical</requirement_severity>
                    <violation_attributes xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"mandatory_tags\">
                        <missing_tag>Application</missing_tag>
                    </violation_attributes>
                </tag_violation>
            </tag_violations>
            <resource_id>i-12345678</resource_id>
            <resource_name>Violations tests server</resource_name>
        </violating_resource>
    </violating_resources>
</tag_policy_device_violations>


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions
404: A device with the specified ID was not found"},"response":[]}]},{"name":"Unified Security Policy - Exceptions","item":[{"name":"Delete an exception","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"exceptionId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/{{exceptionId}}","description":"Delete the specific unified security policy exceptions

Parameters:
exceptionId: The ID of the exception to delete.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/14

Response Messages:
404: The security policy with the specified ID does not exist
403: Not permitted to access this context."},"response":[]},{"name":"Get a specific exception","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"exceptionId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/{{exceptionId}}","description":"Gets a specific exception for unified security policies.

Parameters:
context: Global MSSP context [optional]
exceptionId: The ID of the exception to get.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/14

Response Messages:
403: Not permitted to access this context.
404: A security policy exception with the specified ID was not found."},"response":[]},{"name":"Get matching rules task status","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/matching_rules/status/{{taskId}}","description":"Parameters:
taskId: The unique identifier of the matching rules task.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/matching_rules/status/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Matching rules task status was received.
403: Not permitted to Security policy exceptions.
404: Matching rules task status was not found."},"response":[]},{"name":"Start a task to calculate matching rules for an exception","request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"exceptionId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/{{exceptionId}}/matching_rules/start","description":"Create a calculation task to find matching rules.
The results will be on the relevant devices for each access.
Returns a task Id that can be used to check the task status and get the task results

Parameters:
exceptionId: Security policy Exception ID on which to run the API.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/1/matching_rules/start

Response Messages:
403: Not permitted to Security policy exceptions.
404: A security policy exception with the specified ID was not found."},"response":[]},{"name":"Create an exception","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n\n\tadmin\n\tst_user\n\t2015-01-01\n\tAllow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321\n\t\n\t\t\n\t\t\tCreating USP exception for ticket 123\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t192.168.1.2\n\t\t\t\t\t\t255.255.255.255\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\tLAN\n\t\t\t\t\tcorporate security policy\n\t\t\t\t\tDMZ\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t4321\n\t\t\t\t\t\ttcp\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t1\n\t\t\t\t\t\t{5aa1c104-bd4d-4635-a281-b3a5442639ba}\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\thttp\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t10\n\t\t\t\t\t\t20\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t192.168.1.1\n\t\t\t\t\t\t255.255.255.255\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\t2025-01-01\n\tAllow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321\n\tadmin\n\t123\n"},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/","description":"Create an exception for unified security policies.

Parameters:
context: Global MSSP context [optional]
body [optional]

Usage Example
URLhttps://192.168.1.1/securetrack/api/security_policies/exceptions
BODY<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<security_policy_exception>
    <approved_by>admin</approved_by>
    <created_by>st_user</created_by>
    <creation_date>2015-01-01</creation_date>
    <description>Allow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321</description>
    <exempted_traffic_list>
        <exempted_traffic>
            <comment>Creating USP exception for ticket 123</comment>
            <dest_network_collection>
                <network_items>
                    <network_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"subnet\">
                        <ip>192.168.1.2</ip>
                        <netmask>255.255.255.255</netmask>
                    </network_item>
                </network_items>
            </dest_network_collection>
            <security_requirements>
                <zone_to_zone_security_requirement>
                    <from_zone>LAN</from_zone>
                    <policy_name>corporate security policy</policy_name>
                    <to_zone>DMZ</to_zone>
                </zone_to_zone_security_requirement>
            </security_requirements>
            <service_collection>
                <service_items>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"custom\">
                        <port>4321</port>
                        <protocol>tcp</protocol>
                    </service_item>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"device_service\">
                        <mgmt_id>1</mgmt_id>
                        <service_uid>{5aa1c104-bd4d-4635-a281-b3a5442639ba}</service_uid>
                    </service_item>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"predefined\">
                        <predefined_service_name>http</predefined_service_name>
                    </service_item>
                    <service_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"range_service\">
                        <minProtocol>10</minProtocol>
                        <maxProtocol>20</maxProtocol>
                    </service_item>
                </service_items>
            </service_collection>
            <source_network_collection>
                <network_items>
                    <network_item xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"subnet\">
                        <ip>192.168.1.1</ip>
                        <netmask>255.255.255.255</netmask>
                    </network_item>
                </network_items>
            </source_network_collection>
        </exempted_traffic>
    </exempted_traffic_list>
    <expiration_date>2025-01-01</expiration_date>
    <name>Allow traffic from 192.168.1.1 to 192.168.1.2 on TCP port 4321</name>
    <requested_by>admin</requested_by>
    <ticket_id>123</ticket_id>
</security_policy_exception>


Response Messages:
400: The specified network item is not valid.
400: The specified zone name does not exist.
400: The security policy with the specified name does not exist
400: The security policy 'created by' user is not valid.
400: The security policy with the specified name already exists.
400: Network Object of device id =|device_id| , with uid = |domain_id| does not exist
400: The from zone name = |from_zone_name| does not exist
400: The to zone name = |to_zone_name| does not exist
400: The security policy name = |security_policy_name| does not exist
400: The security policy 'created by' user = |user_name| is not valid
400: The security policy exception cannot be created
403: Not permitted to access this context.
401: The user does not have permission to this action."},"response":[]},{"name":"Get all exceptions","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/","description":"Gets a list of all unified security policy exceptions.

Parameters:
context: Global MSSP context [optional]
start: Starting page for query allowable type is numeric [optional]
count: Number of pages for query starting from starting page allowable type in numeric [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions?context=1&start=0&count=1

Response Messages:
403: Not permitted to access this context."},"response":[]},{"name":"Get matching rules task results","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/matching_rules/result/{{taskId}}","description":"Parameters:
taskId: The unique identifier of the matching rules task.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/matching_rules/result/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
200: Matching rules task results were received.
403: Not permitted to Security policy exceptions.
404: An error occurred during the calculation.
404: The calculation for the task has not finished yet."},"response":[]},{"name":"Cancel Matching rules task","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"taskId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/exceptions/matching_rules/{{taskId}}","description":"Parameters:
taskId: The unique identifier of the matching rules task.

Usage Example
https://192.168.1.1/securetrack/api/security_policies/exceptions/matching_rules/2d8e0a3c-2b07-42b8-b501-336fe74080a3

Response Messages:
204: Matching rules task has been aborted successfully.
403: Not permitted to Security policy exceptions.
404: Matching rules task was not found."},"response":[]}]},{"name":"Unified Security Policy - Security Zone Matrix","item":[{"name":"Delete unified security policy","request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"id"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/{{id}}","description":"Delete a Security Policy Matrix

Parameters:
context: Returns results for the specified domain ID. [optional]
id: The unique identifier of the security policy matrix to delete
ignoreSecureTrack2Data [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies/1
"},"response":[]},{"name":"Get global unified security policies","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/global","description":"Fetches the global security zone matrices defined under Unified Security Policy.

Parameters:
ignoreSecureTrack2Data [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies/global

Response Messages:
403: User not permitted to access global security policies"},"response":[]},{"name":"Get zone to interface mapping","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"deviceId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/{{deviceId}}/mapping","description":"Fetches mapping of SecureTrack zones to device interfaces

Parameters:
context: Global MSSP context [optional]
deviceId: Device ID

Usage Example
https://127.0.0.1/securetrack/api/security_policies/9/mapping

Response Messages:
200: Successful
400: This device does not support zone to interface mapping
403: User not permitted to access the specified domain
404: Device ID: <deviceId> does not exist
404: Access denied for device with ID: <deviceId>"},"response":[]},{"name":"Set manual device mapping","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/xml"}],"body":{"mode":"raw","raw":"\n \n Vlan_30\n \n \n 10\n add\n \n \n \n\n "},"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/{{deviceId}}/manual_mapping","description":"Add or remove a zone on a device interface

Parameters:
context: Global MSSP context [optional]
deviceId: Device ID
body: InterfacesManualMappingsDTO

Usage Example
URLhttps://127.0.0.1/securetrack/api/security_policies/10/manual_mapping
BODY<interfaces_manual_mappings>
<interface_manual_mapping>
<interface_name>Vlan_30</interface_name>
<zones_user_actions>
<zone_user_action>
<zoneId>10</zoneId>
<action>add</action>
</zone_user_action>
</zones_user_actions>
</interface_manual_mapping>
</interfaces_manual_mappings>


Response Messages:
200: Successful
400: Invalid request
403: Insufficient user permissions
404: Not found error
404: User action not valid (only add/remove)
404: No interface with name for device with id
404: No zone with id
404: No revision for device with id
404: Device ID: <deviceId> does not exist
404: Access denied for device with ID: <deviceId>
404: InterfacesManualMappingsDTO is empty
404: Error on updating security_policy_interface_zone_mapping_user_action table for device with ID"},"response":[]},{"name":"Get unified security policy as CSV","request":{"method":"GET","header":[],"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/{{id}}/export","description":"Exports a Security Policy in CSV format

Parameters:
context: Returns results for the specified domain ID. [optional]
id: ID of the security policy. [optional]
ignoreSecureTrack2Data [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies/1/export

Response Messages:
403: User not permitted to access the specified domain
404: Security Policy does not exist"},"response":[]},{"name":"Get unified security policies","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://{{SecureTrack_IP}}/securetrack/api/security_policies/","description":"Fetches the security zone matrices defined under Unified Security Policy.

Parameters:
context: Returns results for the specified domain ID. [optional]
ignoreSecureTrack2Data [optional]

Usage Example
https://192.168.1.1/securetrack/api/security_policies

Response Messages:
403: User not permitted to access the specified domain"},"response":[]}]},{"name":"Unified Security Policy - Violations","item":[{"name":"Get the violating rules for the specified device.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"deviceId"},{"value":null,"type":"text","key":"severity"},{"value":null,"type":"text","key":"type"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/violating_rules/{{deviceId}}/device_violations","description":"policyName is supported for management devices running in Advanced management mode.

Parameters:
deviceId: The device ID for which to get violations
policyName: Return only violations that match this policy [optional]
severity: Return only violations of this severity
type: Return only violations of this type
ignoreSecureTrack2Data [optional]

Usage Example
https://192.168.1.1/securetrack/api/violating_rules/1/device_violations?policyName=policy_name&type=SECURITY_POLICY&severity=MEDIUM

Response Messages:
200: The violations were successfully retrieved
400: The specified value for the violation severity is invalid
400: The specified value for the violation type is invalid
400: You cannot specify a policyName because the device is not running in Advanced management mode
404: A device with the specified ID was not found
404: A policy with the specified policyName was not found for this device"},"response":[]},{"name":"Get the amount of violating rules for the specified device.","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"value":null,"type":"text","key":"deviceId"}]},"url":"https://{{SecureTrack_IP}}/securetrack/api/violating_rules/{{deviceId}}/count","description":"Parameters:
deviceId: The device ID for which to get violations.
ignoreSecureTrack2Data [optional]

Usage Example
https://192.168.1.1/securetrack/api/violating_rules/1/count

Response Messages:
200: The violation count was successfully retrieved
404: Device with id: <deviceId> doesn't exist"},"response":[]}]}]} \ No newline at end of file diff --git a/Postman Format v2/R21-1 postman collection/tufin.postman_environment b/Postman Format v2/R21-1 postman collection/tufin.postman_environment new file mode 100644 index 0000000..c031d2b --- /dev/null +++ b/Postman Format v2/R21-1 postman collection/tufin.postman_environment @@ -0,0 +1 @@ +{"name":"Tufin environment","values":[{"type":"text","key":"SecureApp_IP"},{"type":"text","key":"SecureChange_IP"},{"type":"text","key":"SecureTrack_IP"},{"type":"text","key":"applicationId"},{"type":"text","key":"applicationInterfaceId"},{"type":"text","key":"application_id"},{"type":"text","key":"application_pack_id"},{"type":"text","key":"assigneeId"},{"type":"text","key":"child_id"},{"type":"text","key":"child_ids"},{"type":"text","key":"cleanup_id"},{"type":"text","key":"cloudId"},{"type":"text","key":"cloud_id"},{"type":"text","key":"connectionId"},{"type":"text","key":"connectionInterfaceId"},{"type":"text","key":"connectionToApplicationId"},{"type":"text","key":"connection_id"},{"type":"text","key":"connection_to_application_pack_id"},{"type":"text","key":"customer_id"},{"type":"text","key":"deviceId"},{"type":"text","key":"device_id"},{"type":"text","key":"domainId"},{"type":"text","key":"exceptionId"},{"type":"text","key":"fieldId"},{"type":"text","key":"id"},{"type":"text","key":"ids"},{"type":"text","key":"inId"},{"type":"text","key":"instructionId"},{"type":"text","key":"interfaceCustomerId"},{"type":"text","key":"layer2DataId"},{"type":"text","key":"managementId"},{"type":"text","key":"mgmtId"},{"type":"text","key":"parent_id"},{"type":"text","key":"parent_ids"},{"type":"text","key":"policyId"},{"type":"text","key":"requestId"},{"type":"text","key":"revId"},{"type":"text","key":"revision_id"},{"type":"text","key":"risk_id"},{"type":"text","key":"routeId"},{"type":"text","key":"ruleId"},{"type":"text","key":"rule_id"},{"type":"text","key":"rule_uid"},{"type":"text","key":"serverId"},{"type":"text","key":"serviceId"},{"type":"text","key":"sourceApplicationId"},{"type":"text","key":"stepId"},{"type":"text","key":"tag_id"},{"type":"text","key":"targetApplicationId"},{"type":"text","key":"taskId"},{"type":"text","key":"task_id"},{"type":"text","key":"task_uid"},{"type":"text","key":"toStepId"},{"type":"text","key":"uid"},{"type":"text","key":"userId"},{"type":"text","key":"vpnId"},{"type":"text","key":"zone_id"},{"type":"text","key":"zone_ids"}]} \ No newline at end of file diff --git a/R19-3 postman collection.zip b/R19-3 postman collection.zip deleted file mode 100644 index 7546144..0000000 Binary files a/R19-3 postman collection.zip and /dev/null differ diff --git a/R20-1 postman collection.zip b/R20-1 postman collection.zip deleted file mode 100644 index cdf2363..0000000 Binary files a/R20-1 postman collection.zip and /dev/null differ diff --git a/R20-2 postman collection.zip b/R20-2 postman collection.zip deleted file mode 100644 index 4e5524b..0000000 Binary files a/R20-2 postman collection.zip and /dev/null differ diff --git a/R21-1 postman collection.zip b/R21-1 postman collection.zip deleted file mode 100644 index c7a8f5d..0000000 Binary files a/R21-1 postman collection.zip and /dev/null differ