{ "openapi": "3.0.1", "info": { "title": "AppViz REST Web Services", "description": "The endpoints provided here are applicable to the on-premises version of AppViz.\nFor APIs related to the SaaS-based version of AppViz, refer to Welcome to the AppViz API Reference | AppViz (SaaS) APIs (algosec.com)|\n\nUse the AlgoSec AppViz Web Services APIs to manage remote AppViz operations, such as retrieving or editing AppViz applications, flows, and objects.\n\nSwagger is accessed from inside ASMS. Click Username > API Documentation.\n\nNote: You must be logged in to ASMS to execute these APIs.", "version": "A33.00" }, "servers": [{ "url": "/BusinessFlow", "description": "Default Server URL" }], "paths": { "/rest/v1/settings/permissions/user": { "get": { "tags": ["Permissions"], "summary": "Retrieve user permissions for a user name", "operationId": "getUserPermissions", "parameters": [{ "name": "name", "in": "query", "description": "Case-sensitive user name", "required": true, "schema": { "type": "string" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Cannot find user", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIUserEntityPermissions" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } }, "post": { "tags": ["Permissions"], "summary": "Update permissions for a user", "operationId": "changeUserPermissions", "parameters": [{ "name": "name", "in": "query", "description": "Case-sensitive user name", "required": true, "schema": { "type": "string" } }], "requestBody": { "description": "apiPermissionChanges - Permissions data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPermissionChanges" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIUserEntityPermissions" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Invalid request parameters", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/settings/permissions/role": { "get": { "tags": ["Permissions"], "summary": "Retrieve permissions of a role name", "operationId": "getRole", "parameters": [{ "name": "name", "in": "query", "description": "Case-sensitive role name", "required": true, "schema": { "type": "string" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Cannot find role", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIRoleEntityPermissions" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } }, "post": { "tags": ["Permissions"], "summary": "Update permissions and users for a role", "operationId": "changeRolePermissions", "parameters": [{ "name": "name", "in": "query", "description": "Case-sensitive role name", "required": true, "schema": { "type": "string" } }], "requestBody": { "description": "apiRolePermChanges - Data for role change", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIRolePermissionChanges" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIRoleEntityPermissions" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Invalid request parameters", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } }, "delete": { "tags": ["Permissions"], "summary": "Remove a role", "operationId": "deleteRole", "parameters": [{ "name": "name", "in": "query", "description": "Case-sensitive role name", "required": true, "schema": { "type": "string" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Cannot find role", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/settings/permissions/role/new": { "post": { "tags": ["Permissions"], "summary": "Create a new role", "operationId": "createRole", "requestBody": { "description": "apiNewRole - Case-sensitive role name", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APINewRole" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIRoleEntityPermissions" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Invalid request parameters", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/network_services/{id}": { "get": { "tags": ["Services"], "summary": "Retrieve a network service by ID", "operationId": "getNetworkServiceById", "parameters": [{ "name": "id", "in": "path", "description": "Network service ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Network service not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/APINetworkService" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } }, "post": { "tags": ["Services"], "summary": "Edit a network service object", "operationId": "editNetworkService", "parameters": [{ "name": "id", "in": "path", "description": "Network service ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "requestBody": { "description": "request - Data for network service", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIEditNetworkServiceRequest" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Network service not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APINetworkService" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Invalid request parameters", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } }, "delete": { "tags": ["Services"], "summary": "Remove a network service", "operationId": "deleteNetworkServiceById", "parameters": [{ "name": "id", "in": "path", "description": "Network service ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Failed to delete network service", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Network service not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/network_services/{id}/sync": { "post": { "tags": ["Services"], "summary": "Syncing (update) an service object from device", "operationId": "syncServiceObject", "parameters": [{ "name": "id", "in": "path", "description": "Service object ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } } }, "403": { "description": "User is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Illegal request parameters", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/network_services/new": { "post": { "tags": ["Services"], "summary": "Create a new network service", "operationId": "createNewNetworkService", "requestBody": { "description": "networkServiceRequest - Data for new network service", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APINetworkServiceRequest" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APINetworkService" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Invalid request parameters", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/network_objects/{id}": { "get": { "tags": ["Network Objects"], "summary": "Retrieve a network object by ID", "operationId": "getNetworkObjectById", "parameters": [{ "name": "id", "in": "path", "description": "Network object id", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Network object not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/APINetworkObject" } } } }, "403": { "description": "Access Denied", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } }, "post": { "tags": ["Network Objects"], "summary": "Edit a network object", "operationId": "editEndpoint", "parameters": [{ "name": "id", "in": "path", "description": "Network object id", "required": true, "schema": { "type": "integer", "format": "int32" } }], "requestBody": { "description": "networkObjectsEditContent - Network object content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIEditEndpointRequest" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIEditedEndpoint" } } } }, "403": { "description": "User is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Illegal request parameters", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } }, "delete": { "tags": ["Network Objects"], "summary": "Remove a network object by ID", "operationId": "deleteNetworkObjectById", "parameters": [{ "name": "id", "in": "path", "description": "Network object id", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Object deletion failed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Network object not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/APIDeleteResponse" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/network_objects/{id}/sync": { "post": { "tags": ["Network Objects"], "summary": "Syncing (update) an network object from device", "operationId": "syncEndpoint", "parameters": [{ "name": "id", "in": "path", "description": "Network object ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } } }, "403": { "description": "User is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Illegal request parameters", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/network_objects/{id}/save_labels": { "post": { "tags": ["Network Objects"], "operationId": "saveEndpointLabels", "parameters": [{ "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }], "requestBody": { "description": "labelsRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIEditEndpointLabelsRequest" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/network_objects/{id}/replace": { "post": { "tags": ["Network Objects"], "summary": "Replace an abstract network object", "operationId": "replaceAbstractEndpoint", "parameters": [{ "name": "id", "in": "path", "description": "Network object ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "requestBody": { "description": "replaceObjectInformation - Data for replacement of abstract object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIReplaceAbstractObjectRequest" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIReplaceAbstractObjectResponse" } } } }, "403": { "description": "User is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Illegal request parameters", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/network_objects/new": { "post": { "tags": ["Network Objects"], "summary": "Create a new network object", "operationId": "createNewEndpoint", "parameters": [{ "name": "csv", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }], "requestBody": { "description": "networkObjectContent - Data for network object. Examples models: 'New host/range network object' | 'New network object group' | 'New abstract network object'", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APINetworkObjectContent" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkEntitySaveResponse" } } } }, "403": { "description": "User is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Illegal request parameters", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/applications/{id}/resolve": { "post": { "tags": ["Applications"], "summary": "Issue a change request for blocked connectivity", "operationId": "resolveApplication", "parameters": [{ "name": "id", "in": "path", "description": "Application revision ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "summary", "in": "query", "description": "Change request subject", "required": false, "schema": { "type": "string" } }], "responses": { "500": { "description": "Resolve application failed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/RestChangeApplicationResponse" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/applications/{id}/labels": { "get": { "tags": ["Applications"], "summary": "Retrieve a list of tags for an application", "operationId": "getApplicationLabels", "parameters": [{ "name": "id", "in": "path", "description": "Application revision ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/APILabel" } } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } }, "post": { "tags": ["Applications"], "summary": "Edit the tags for an application", "operationId": "editApplicationLabels", "parameters": [{ "name": "id", "in": "path", "description": "Application revision ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "requestBody": { "description": "request - Data to set for application tags", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIEditApplicationLabelsRequest" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIEditApplicationLabelsResponse" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Illegal request parameters", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } }, "delete": { "tags": ["Applications"], "summary": "Remove all user-defined tags for an application; system tags are excluded", "operationId": "removeAllApplicationLabels", "parameters": [{ "name": "id", "in": "path", "description": "Application revision ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "type": "string" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Illegal request parameters", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/applications/{id}/flows": { "get": { "tags": ["Flows"], "summary": "Retrieve a list of application flows by application ID", "operationId": "getApplicationFlows", "parameters": [{ "name": "id", "in": "path", "description": "Application revision ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "includeVulnerabilityInformation", "in": "query", "description": "Include vulnerability information. set to false to improve performance", "required": false, "schema": { "type": "boolean", "default": true }, "example": true }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/APIFlow" } } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } }, "post": { "tags": ["Flows"], "summary": "Edit the flows for an application", "operationId": "editApplicationFlow", "parameters": [{ "name": "id", "in": "path", "description": "Application revision ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "requestBody": { "description": "editFlowRequests - List of flow changes", "content": { "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/APIEditFlowRequest" } } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIEditFlowsResponse" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Illegal request parameters", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/applications/{id}/flows/{flowId}/check_connectivity": { "post": { "tags": ["Flows"], "summary": "Check flow connectivity by application ID and flow ID", "operationId": "runConnectivityOnFlow", "parameters": [{ "name": "id", "in": "path", "description": "Application revision ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "flowId", "in": "path", "description": "Flow ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application or flow not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/APIFlowConnectivity" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/applications/{id}/flows/new": { "post": { "tags": ["Flows"], "summary": "Create new flows in application", "description": "Usage example:
[
 {
  \"type\" : \"APPLICATION\",
  \"name\": \"string\",
  \"sources\": [
   {
    \"name\": \"string\", \"device\": \"string\"
   }
  ],
  \"destinations\": [
   {
    \"name\": \"string\", \"device\": \"string\"
   }
  ],
  \"services\": [
   {
    \"name\": \"string\", \"device\": \"string\"
   }
  ],
  \"users\": [
   {
    \"string\"
   }
  ],
  \"network_applications\": [
   {
    \"name\": \"string\", \"device\": \"string\"
   }
  ],
  \"comment\": \"string\",
  \"custom_fields\": [
   {
    \"name\": \"string\", \"value\": \"string\"
   }
  ]
 },
 {
  \"type\": \"SHARED\",
  \"name\": \"string\",
  \"sources\": [
   {
    \"name\": \"string\", \"device\": \"string\"
   }
  ],
  \"services\": [
   {
    \"name\": \"string\", \"device\": \"string\"
   }
  ]
 },
 {
  \"type\": \"SUBSCRIBED\",
  \"shared_application_name\": \"string\",
  \"subscribed_flows\": [
   {
    \"shared_flow_name\": \"string\",
    \"placeholder_network_object\": [
     {
      \"name\": \"string\", \"device\": \"string\"
     }
    ]
   }
  ]
 }
]

Source/Destination examples: { \"name\": string, \"device\": string } OR { \"objectID\": number }", "operationId": "createApplicationFlow", "parameters": [{ "name": "id", "in": "path", "description": "Application revision ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "requestBody": { "description": "flowRequests - List of new flows", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [{ "$ref": "#/components/schemas/APIFlowRequest" }, { "$ref": "#/components/schemas/APISubscribedFlowRequest" }] } } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIFlow" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Illegal request parameters", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/applications/{id}/discard": { "post": { "tags": ["Applications"], "summary": "Discard the draft revision for an application", "operationId": "discardRevision", "parameters": [{ "name": "id", "in": "path", "description": "Application revision ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Discard application draft failed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/applications/{id}/decommission": { "post": { "tags": ["Applications"], "summary": "Decommission an application and issue a change request", "operationId": "decomissionApplication", "parameters": [{ "name": "id", "in": "path", "description": "Application revision ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "summary", "in": "query", "description": "Change request subject", "required": false, "schema": { "type": "string" } }], "responses": { "500": { "description": "Application decommission failed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/RestChangeApplicationResponse" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/applications/{id}/custom_fields": { "post": { "tags": ["Applications"], "summary": "Edit custom fields for an application", "operationId": "editCustomFields", "parameters": [{ "name": "id", "in": "path", "description": "Application revision ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "requestBody": { "description": "request - Data to set for application custom fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIEditApplicationCustomFieldRequest" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIEditApplicationCustomFieldResponse" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Illegal request parameters", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } }, "delete": { "tags": ["Applications"], "summary": "Remove all custom fields for an application; system fields are excluded", "operationId": "clearAllApplicationCustomFields", "parameters": [{ "name": "id", "in": "path", "description": "Application revision ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "type": "string" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Illegal request parameters", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/applications/{id}/contacts": { "get": { "tags": ["Applications"], "summary": "Retrieve a list of contacts for an application", "operationId": "getApplicationContacts", "parameters": [{ "name": "id", "in": "path", "description": "Application revision ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RestApplicationPersonRole" } } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } }, "post": { "tags": ["Applications"], "summary": "Edit contacts for an application", "operationId": "editApplicationContacts", "parameters": [{ "name": "id", "in": "path", "description": "Application revision ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "requestBody": { "description": "request - Application contacts to add and remove", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIEditApplicationContactsRequest" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIEditApplicationContactsResponse" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Illegal request parameters", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } }, "delete": { "tags": ["Applications"], "summary": "Remove all contacts for an application", "operationId": "clearAllApplicationContacts", "parameters": [{ "name": "id", "in": "path", "description": "Application revision ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIEditApplicationContactsResponse" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Illegal request parameters", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/applications/{id}/check_connectivity": { "post": { "tags": ["Applications"], "summary": "Run a connectivity check on an application", "operationId": "runCheckConnectivity", "parameters": [{ "name": "id", "in": "path", "description": "Application revision ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/RestApplicationConnectivity" } } } }, "403": { "description": "The user is missing the Refresh Connectivity permission", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/applications/{id}/apply": { "post": { "tags": ["Applications"], "summary": "Apply an application draft for opening a change request", "operationId": "applyDraft", "parameters": [{ "name": "id", "in": "path", "description": "Application revision ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "summary", "in": "query", "description": "Change request subject", "required": false, "schema": { "type": "string" } }], "requestBody": { "description": "applyReqBody - Flow IDs to include in change request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIApplicationApplyRequest" } } } }, "responses": { "500": { "description": "Failed to apply the draft revision", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/RestChangeApplicationResponse" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Illegal request parameters", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/applications/new": { "post": { "tags": ["Applications"], "summary": "Create a new application", "operationId": "newApplication", "requestBody": { "description": "applicationRequest - Data for new application", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIApplicationRequest" } } }, "required": true }, "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIApplication" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Illegal request parameters", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/settings/permissions/user/permitted_applications": { "get": { "tags": ["Permissions"], "summary": "Retrieve whether a user has permissions for an application – For use by admin users", "operationId": "getUserPermittedApplications", "parameters": [{ "name": "name", "in": "query", "description": "Case-sensitive user name", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Application revision ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "User or application not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPermittedPermissionResponse" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/settings/permissions/default": { "get": { "tags": ["Permissions"], "summary": "Retrieve the default permissions of new users", "operationId": "getDefaultPermissions", "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/APIDefaultPermissions" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/network_services/name/**": { "get": { "tags": ["Services"], "summary": "Retrieve a collection of network services by name", "description": "This API cannot be tested in Swagger", "operationId": "getNetworkServiceByName", "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/APINetworkService" } } } }, "403": { "description": "Access denied", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/network_services/": { "get": { "tags": ["Services"], "summary": "Retrieve a list of all the network services", "description": "The response is a subset of the results in pages", "operationId": "getAllNetworkServices", "parameters": [{ "name": "page_number", "in": "query", "description": "The page number", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "page_size", "in": "query", "description": "The page size", "required": false, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/APINetworkService" } } } } }, "403": { "description": "Access Denied", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/network_objects/{id}/vulnerabilities": { "get": { "tags": ["Network Objects"], "summary": "Retrieve vulnerabilities for a network object", "operationId": "getNetworkObjectVulnerabilities", "parameters": [{ "name": "id", "in": "path", "description": "Network object id", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Network object not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/RestObjectVulnerability" } } } }, "403": { "description": "Access Denied", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/network_objects/{id}/applications": { "get": { "tags": ["Network Objects"], "summary": "Get a list of applications affected by a network object", "operationId": "getNetworkObjectApplications", "parameters": [{ "name": "id", "in": "path", "description": "Network object id", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Network object not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/APIApplication" } } } } }, "403": { "description": "Access Denied", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/network_objects/name/**": { "get": { "tags": ["Network Objects"], "summary": "Retrieve a list of network objects by name", "description": "This API cannot be tested in Swagger", "operationId": "getNetworkObjectsByName", "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/APINetworkObject" } } } } }, "403": { "description": "Access Denied", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/network_objects/find": { "get": { "tags": ["Network Objects"], "summary": "Retrieve a list of filtered network objects ", "operationId": "findNetworkObjectsByIp", "parameters": [{ "name": "address", "in": "query", "description": "The address to query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "The filter type", "required": false, "schema": { "type": "string", "default": "INTERSECT", "enum": ["DEFAULT", "CONTAINED", "CONTAINING", "EXACT", "INTERSECT", "NONE", "NAME", "OBJECT", "DISPLAY"] }, "example": "INTERSECT" }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/APINetworkObject" } } } } }, "403": { "description": "Access Denied", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/network_objects/find/applications": { "get": { "tags": ["Network Objects"], "summary": "Retrieve a list of applications affected by filtered network objects", "operationId": "findNetworkObjectsApplicationsByIp", "parameters": [{ "name": "address", "in": "query", "description": "The address to search", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "The filter type", "required": false, "schema": { "type": "string", "default": "INTERSECT", "enum": ["DEFAULT", "CONTAINED", "CONTAINING", "EXACT", "INTERSECT", "NONE", "NAME", "OBJECT", "DISPLAY"] }, "example": "INTERSECT" }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/APIApplication" } } } } }, "403": { "description": "Access Denied", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/network_objects/": { "get": { "tags": ["Network Objects"], "summary": "Retrieve a list of all network objects", "description": "The response is a subset of the results in pages", "operationId": "getAllNetworkObjects", "parameters": [{ "name": "page_number", "in": "query", "description": "The page number", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "page_size", "in": "query", "description": "The page size", "required": false, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/APINetworkObject" } } } } }, "403": { "description": "Access Denied", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/applications/{id}": { "get": { "tags": ["Applications"], "summary": "Retrieve an application by ID", "operationId": "getApplicationById", "parameters": [{ "name": "id", "in": "path", "description": "Application revision ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/APIApplication" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/applications/{id}/vulnerabilities": { "get": { "tags": ["Applications"], "summary": "Retrieve a collection of vulnerabilities for an application", "operationId": "getApplicationVulnerabilities", "parameters": [{ "name": "id", "in": "path", "description": "Application revision ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/RestApplicationVulnerability" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/applications/{id}/risks": { "get": { "tags": ["Applications"], "summary": "Retrieve a list of risks for an application", "operationId": "getApplicationRisks", "parameters": [{ "name": "id", "in": "path", "description": "Application revision ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RestRisk" } } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/applications/{id}/revisions": { "get": { "tags": ["Applications"], "summary": "Retrieve a list of all revisions for an application", "operationId": "getApplicationRevisions", "parameters": [{ "name": "id", "in": "path", "description": "Application revision ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RestBaseApplicationRevision" } } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/applications/{id}/labels/{type}": { "get": { "tags": ["Applications"], "summary": "Retrieve a list of tags for an application by type", "operationId": "getApplicationLabels_1", "parameters": [{ "name": "id", "in": "path", "description": "Application revision ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "type", "in": "path", "description": "Tag type", "required": true, "schema": { "type": "string", "enum": ["CRITICAL_PROCESS", "USER_DEFINED", "PCI", "DYNAMIC", "SYSTEM_TAGS", "USER_TAGS"] } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/APILabel" } } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/applications/{id}/flows/{flowId}": { "get": { "tags": ["Flows"], "summary": "Retrieve an application flow by application ID and flow ID", "operationId": "getFlow", "parameters": [{ "name": "id", "in": "path", "description": "Application revision ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "flowId", "in": "path", "description": "Flow ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application or flow not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/APIFlow" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } }, "delete": { "tags": ["Flows"], "summary": "Remove a flow by application ID and flow ID", "operationId": "deleteFlowById", "parameters": [{ "name": "id", "in": "path", "description": "Application revision ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "flowId", "in": "path", "description": "Flow ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Illegal request parameters", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/applications/{id}/flows/{flowId}/risks": { "get": { "tags": ["Flows"], "summary": "Retrieve a list of risks for a flow by application ID and flow ID", "operationId": "getFlowRisks", "parameters": [{ "name": "id", "in": "path", "description": "Application revision ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "flowId", "in": "path", "description": "Flow ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application or flow not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RestRisk" } } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/applications/{id}/change_requests": { "get": { "tags": ["Applications"], "summary": "Retrieve a list of FireFlow change requests for an application", "operationId": "getApplicationChangeRequests", "parameters": [{ "name": "id", "in": "path", "description": "Application revision ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RestChangeRequest" } } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/applications/{id}/authorized_users_and_roles": { "get": { "tags": ["Applications"], "summary": "Retrieve all users and roles authorized to view or edit an application", "operationId": "getApplicationUsersAndRoles", "parameters": [{ "name": "id", "in": "path", "description": "Application app_id (the id of the first application revision)", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application not found or the user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIApplicationPermittedEntities" } } } }, "403": { "description": "The user is missing the Admin permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/applications/{id}/activity_log": { "get": { "tags": ["Applications"], "summary": "Retrieve a list of activity log entries for an application", "operationId": "getActivitiesForApplication", "parameters": [{ "name": "id", "in": "path", "description": "Application revision ID", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/APIApplicationActivityLog" } } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/applications/pci": { "get": { "tags": ["Applications"], "summary": "Retrieve a list of vulnerabilities for all applications in PCI zone, filtered by devices", "operationId": "getPciApplicationsVulnerabilities", "parameters": [{ "name": "devices", "in": "query", "description": "An array of device names to query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }], "responses": { "500": { "description": "Failed to get vulnerabilities for device", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PciApplicationVulnerabilityResponse" } } } } }, "403": { "description": "Access Denied", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/applications/name/**": { "get": { "tags": ["Applications"], "summary": "Retrieve a collection of applications by name", "description": "This API cannot be tested in Swagger", "operationId": "getApplicationByName", "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/APIApplication" } } } }, "403": { "description": "Access Denied", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/applications/id/{id}": { "get": { "tags": ["Applications"], "summary": "Retrieve an application by app_id", "operationId": "getApplicationByAppId", "parameters": [{ "name": "id", "in": "path", "description": "Application app_id (the id of the first application revision)", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application not found or the user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "$ref": "#/components/schemas/APIApplication" } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/applications/id/{id}/revisions": { "get": { "tags": ["Applications"], "summary": "Retrieve a list of all revisions for an application by app_id", "operationId": "getApplicationRevisionsByAppId", "parameters": [{ "name": "id", "in": "path", "description": "Application app_id (the id of the first application revision)", "required": true, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Application not found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RestBaseApplicationRevision" } } } } }, "403": { "description": "The user is missing required permissions", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/applications/activity_log": { "get": { "tags": ["Applications"], "summary": "Retrieve a list of activity log entries for all applications", "operationId": "getAllApplicationsActivities", "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/APIApplicationActivityLog" } } } } }, "403": { "description": "Access Denied", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } }, "/rest/v1/applications/": { "get": { "tags": ["Applications"], "summary": "Retrieve a list of all applications", "description": "The response is a subset of the results in pages", "operationId": "getAllApplications", "parameters": [{ "name": "page_number", "in": "query", "description": "The page number", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 }, "example": 1 }, { "name": "page_size", "in": "query", "description": "The page size", "required": false, "schema": { "type": "integer", "format": "int32" } }], "responses": { "500": { "description": "Internal Server Error", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "200": { "description": "OK", "content": { "application/json;charset=utf-8": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/APIApplication" } } } } }, "403": { "description": "Access Denied", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/RestStatus" } } } } } } } }, "components": { "schemas": { "RestStatus": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "object" } } } }, "APIApplicationPermission": { "type": "object", "properties": { "applicationID": { "type": "integer", "description": "Application revision id", "format": "int32" }, "permission": { "type": "string", "description": "Permission type", "enum": ["view", "edit"] } }, "description": "Application permission data" }, "APIApplicationPermissionChange": { "type": "object", "properties": { "add": { "uniqueItems": true, "type": "array", "description": "Application permissions to add", "items": { "$ref": "#/components/schemas/APIApplicationPermission" } }, "remove": { "uniqueItems": true, "type": "array", "description": "Application permissions to remove", "items": { "type": "integer", "description": "Application permissions to remove", "format": "int32" } } }, "description": "Application permission change data" }, "APIGlobalPermissionsChange": { "type": "object", "properties": { "add": { "uniqueItems": true, "type": "array", "description": "Permission names to add", "items": { "type": "string", "description": "Permission names to add" } }, "remove": { "uniqueItems": true, "type": "array", "description": "Permission names to remove", "items": { "type": "string", "description": "Permission names to remove" } } }, "description": "Permissions change data" }, "APIPermissionChanges": { "type": "object", "properties": { "authorizedViewsAndActionChanges": { "$ref": "#/components/schemas/APIGlobalPermissionsChange" }, "authorizedApplicationsChanges": { "$ref": "#/components/schemas/APIApplicationPermissionChange" } }, "description": "Permission content" }, "APIRolePermissionChanges": { "type": "object", "properties": { "authorizedViewsAndActionChanges": { "$ref": "#/components/schemas/APIGlobalPermissionsChange" }, "authorizedApplicationsChanges": { "$ref": "#/components/schemas/APIApplicationPermissionChange" }, "users": { "$ref": "#/components/schemas/APIRoleUsersChange" } }, "description": "Role permission content" }, "APIRoleUsersChange": { "type": "object", "properties": { "add": { "type": "array", "description": "List of user names to add to the role", "items": { "type": "string", "description": "List of user names to add to the role" } }, "remove": { "type": "array", "description": "List of user names to remove from the role", "items": { "type": "string", "description": "List of user names to remove from the role" } } }, "description": "Role users change" }, "APINewRole": { "required": ["name"], "type": "object", "properties": { "name": { "type": "string", "description": "Role name" }, "description": { "type": "string", "description": "Role description" }, "enabled": { "type": "boolean", "description": "Is enabled" }, "users": { "uniqueItems": true, "type": "array", "description": "List of user names assigned to the role", "items": { "type": "string", "description": "List of user names assigned to the role" } }, "authorizedViewsAndActions": { "uniqueItems": true, "type": "array", "description": "List of allowed global permissions", "items": { "type": "string", "description": "List of allowed global permissions" } }, "authorizedApplications": { "uniqueItems": true, "type": "array", "description": "List of allowed application permissions", "items": { "$ref": "#/components/schemas/APIApplicationPermission" } }, "ldapGroupDN": { "type": "string", "description": "LDAP group DN" } }, "description": "New role content" }, "APICustomFieldRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "Custom field name" }, "value": { "type": "string", "description": "Custom field value" } }, "description": "Custom field to set" }, "APIEditNetworkServiceRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "New service name" }, "setCustomFields": { "uniqueItems": true, "type": "array", "description": "List of custom field values", "items": { "$ref": "#/components/schemas/APICustomFieldRequest" } }, "clearCustomFields": { "uniqueItems": true, "type": "array", "description": "List of custom field names to clear", "items": { "type": "string", "description": "List of custom field names to clear" } }, "addContent": { "uniqueItems": true, "type": "array", "description": "List of service items to add", "items": { "$ref": "#/components/schemas/APINetworkServiceContent" } }, "removeContent": { "uniqueItems": true, "type": "array", "description": "List of service items to remove", "items": { "$ref": "#/components/schemas/APINetworkServiceContent" } } }, "description": "Network service data" }, "APINetworkServiceContent": { "type": "object", "properties": { "protocol": { "type": "string", "description": "Service protocol name" }, "port": { "type": "string", "description": "Service port number" } }, "description": "Network service item data" }, "APINetworkServiceRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "Network service name" }, "content": { "type": "array", "description": "List of service items", "items": { "$ref": "#/components/schemas/APINetworkServiceContent" } }, "custom_fields": { "type": "array", "description": "List of custom field values", "items": { "$ref": "#/components/schemas/APICustomFieldRequest" } } }, "description": "Network service content" }, "APIEditEndpointRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "New object name" }, "content": { "type": "string", "description": "New object content. The content must match the object type" }, "addMembers": { "uniqueItems": true, "type": "array", "description": "Group members to add. Only existing objects can be added", "items": { "$ref": "#/components/schemas/APIFlowNetworkEntityRequest" } }, "removeMembers": { "uniqueItems": true, "type": "array", "description": "Group members to remove", "items": { "$ref": "#/components/schemas/APIFlowNetworkEntityRequest" } }, "addTags": { "uniqueItems": true, "type": "array", "description": "Object tags to add. You can either add existing tags or create new ones", "items": { "type": "string", "description": "Object tags to add. You can either add existing tags or create new ones" } }, "removeTags": { "uniqueItems": true, "type": "array", "description": "Object tags to remove", "items": { "type": "string", "description": "Object tags to remove" } }, "setCustomFields": { "uniqueItems": true, "type": "array", "description": "List of custom field values to set", "items": { "$ref": "#/components/schemas/APICustomFieldRequest" } }, "clearCustomFields": { "uniqueItems": true, "type": "array", "description": "List of custom fields to clear", "items": { "type": "string", "description": "List of custom fields to clear" } } }, "description": "Network object data" }, "APIFlowNetworkEntityRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "Network entity name" }, "device": { "type": "string", "description": "Network entity device" }, "objectID": { "type": "integer", "description": "Network entity ID", "format": "int32" } }, "description": "Network entity (object or service) identification" }, "APIEditEndpointLabelsRequest": { "type": "object", "properties": { "labels": { "type": "array", "description": "List of new network object tags", "items": { "type": "string", "description": "List of new network object tags" } } }, "description": "List of new network object tags to update" }, "APIReplaceAbstractObjectRequest": { "type": "object", "properties": { "replaceWith": { "$ref": "#/components/schemas/APIFlowNetworkEntityRequest" }, "replaceInApplications": { "uniqueItems": true, "type": "array", "description": "List of names of applications in which to replace the abstract object. If empty list, replace in all applications", "items": { "type": "string", "description": "List of names of applications in which to replace the abstract object. If empty list, replace in all applications" } } }, "description": "Replace abstract object data" }, "APILabelsRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "Tag name" } }, "description": "Network object tags" }, "APINetworkObjectContent": { "type": "object", "properties": { "name": { "type": "string", "description": "Network object name" }, "type": { "type": "string", "description": "Network object type", "enum": ["Unknown", "Range", "Host", "Network", "Group", "Domain", "Gateway", "Abstract"] }, "tags": { "type": "array", "description": "Network object tags", "items": { "$ref": "#/components/schemas/APILabelsRequest" } }, "customFields": { "type": "array", "description": "List of network object custom field values", "items": { "$ref": "#/components/schemas/APICustomFieldRequest" } }, "selectedDevice": { "type": "array", "description": "List of network object selected device", "items": { "type": "integer", "description": "List of network object selected device", "format": "int32" } }, "subject": { "type": "string" }, "objectContainerLevel": { "type": "string" } }, "description": "Network object content" }, "APIApplication": { "type": "object", "properties": { "revisionID": { "type": "integer", "description": "Application revision id", "format": "int32" }, "applicationID": { "type": "integer", "description": "First application revision id", "format": "int32" }, "name": { "type": "string", "description": "Application name" }, "createdDate": { "type": "string", "description": "Application creation date", "format": "date-time" }, "revisionStatus": { "type": "string", "description": "Application revision status" }, "lifecyclePhase": { "type": "string", "description": "Application lifecycle phase" }, "expirationDate": { "type": "string", "description": "Application expiration date", "format": "date-time" }, "connectivityStatus": { "type": "string", "description": "Application flows connectivity status" }, "lastUpdateDate": { "type": "string", "description": "Last update date", "format": "date-time" }, "lastRiskCheck": { "type": "string", "description": "Last risk check date", "format": "date-time" }, "riskScore": { "type": "integer", "description": "Risk score for application flows", "format": "int32" }, "vulnerabilityScore": { "type": "integer", "description": "Vulnerability score for application flows", "format": "int32" }, "contacts": { "type": "array", "description": "List of application contacts", "items": { "$ref": "#/components/schemas/RestApplicationPersonRole" } }, "customFields": { "type": "array", "description": "List of application custom field values", "items": { "$ref": "#/components/schemas/APIProperty" } }, "labels": { "type": "array", "description": "List of application tags", "items": { "$ref": "#/components/schemas/APILabel" } } }, "description": "Application data" }, "APILabel": { "type": "object", "properties": { "name": { "type": "string" } }, "description": "List of application tags" }, "APIProperty": { "type": "object", "properties": { "name": { "type": "string", "description": "Custom field name" }, "value": { "type": "string", "description": "Custom field value" }, "link": { "type": "string", "description": "Link field URL" } }, "description": "List of application custom field values" }, "RestApplicationPersonRole": { "type": "object", "properties": { "role": { "type": "string", "description": "Contact role in the application" }, "name": { "type": "string", "description": "Contact name" }, "email": { "type": "string", "description": "Contact e-mail address" }, "phone": { "type": "string", "description": "Contact phone number" } }, "description": "Application contact data" }, "RestChangeApplicationResponse": { "type": "object", "properties": { "changeRequest": { "$ref": "#/components/schemas/RestChangeRequest" }, "application": { "$ref": "#/components/schemas/APIApplication" } }, "description": "Application data after change" }, "RestChangeRequest": { "type": "object", "properties": { "id": { "type": "integer", "description": "Change request id", "format": "int32" }, "openedDate": { "type": "string", "description": "Creation date", "format": "date-time" }, "requestor": { "type": "string", "description": "Requestor name" }, "status": { "type": "string", "description": "Change request status" }, "subject": { "type": "string", "description": "Change request subject" } }, "description": "FireFlow change request data" }, "APIEditApplicationLabelsRequest": { "type": "object", "properties": { "addLabels": { "uniqueItems": true, "type": "array", "description": "List of tags to add to the application", "items": { "type": "string", "description": "List of tags to add to the application" } }, "removeLabels": { "uniqueItems": true, "type": "array", "description": "List of tags to remove from the application", "items": { "type": "string", "description": "List of tags to remove from the application" } } }, "description": "List of tags to add and remove from an application" }, "APIEditFlowRequest": { "type": "object", "properties": { "flowID": { "type": "integer", "description": "Flow id", "format": "int32" }, "name": { "type": "string", "description": "New flow name" }, "addSources": { "uniqueItems": true, "type": "array", "description": "Network objects to add as sources", "items": { "$ref": "#/components/schemas/APIFlowNetworkEntityRequest" } }, "removeSources": { "uniqueItems": true, "type": "array", "description": "Network objects to remove from the sources", "items": { "$ref": "#/components/schemas/APIFlowNetworkEntityRequest" } }, "addNetworkUsers": { "uniqueItems": true, "type": "array", "description": "Network users to add", "items": { "type": "string", "description": "Network users to add" } }, "removeNetworkUsers": { "uniqueItems": true, "type": "array", "description": "Network users to remove", "items": { "type": "string", "description": "Network users to remove" } }, "addDestinations": { "uniqueItems": true, "type": "array", "description": "Network objects to add as destinations", "items": { "$ref": "#/components/schemas/APIFlowNetworkEntityRequest" } }, "removeDestinations": { "uniqueItems": true, "type": "array", "description": "Network objects to remove from the destinations", "items": { "$ref": "#/components/schemas/APIFlowNetworkEntityRequest" } }, "addNetworkApplications": { "uniqueItems": true, "type": "array", "description": "Network applications to add", "items": { "$ref": "#/components/schemas/APIFlowNetworkEntityRequest" } }, "removeNetworkApplications": { "uniqueItems": true, "type": "array", "description": "Network applications to remove", "items": { "$ref": "#/components/schemas/APIFlowNetworkEntityRequest" } }, "addServices": { "uniqueItems": true, "type": "array", "description": "Network services to add", "items": { "$ref": "#/components/schemas/APIFlowNetworkEntityRequest" } }, "removeServices": { "uniqueItems": true, "type": "array", "description": "Network services to remove", "items": { "$ref": "#/components/schemas/APIFlowNetworkEntityRequest" } }, "comment": { "type": "string", "description": "New comment" }, "setCustomFields": { "uniqueItems": true, "type": "array", "description": "Custom fields values to set", "items": { "$ref": "#/components/schemas/APICustomFieldRequest" } }, "clearCustomFields": { "uniqueItems": true, "type": "array", "description": "Custom fields to clear", "items": { "type": "string", "description": "Custom fields to clear" } } }, "description": "Flow data" }, "APIFlowConnectivity": { "type": "object", "properties": { "flowId": { "type": "integer", "description": "Flow id", "format": "int32" }, "relevantDevices": { "type": "array", "description": "List of devices containing flow objects", "items": { "type": "string", "description": "List of devices containing flow objects" } }, "queryLink": { "type": "string", "description": "Connectivity query link" }, "status": { "type": "string", "description": "Connectivity status" } }, "description": "Single flow connectivity status" }, "APIAbstractFlowRequest": { "type": "object", "properties": { "type": { "type": "string", "description": "Flow type (flow data fields depend on the flow type. See usage example in the notes section above)", "enum": ["APPLICATION", "SHARED", "SUBSCRIBED"] } }, "description": "Application flow type", "discriminator": { "propertyName": "type" } }, "APIFlowRequest": { "type": "object", "description": "Application flow data", "allOf": [{ "$ref": "#/components/schemas/APIAbstractFlowRequest" }, { "type": "object", "properties": { "name": { "type": "string", "description": "Flow name" }, "sources": { "type": "array", "description": "List of network objects used as sources", "items": { "$ref": "#/components/schemas/APIFlowNetworkEntityRequest" } }, "users": { "type": "array", "description": "List of network users", "items": { "type": "string", "description": "List of network users" } }, "destinations": { "type": "array", "description": "List of network objects used as destinations", "items": { "$ref": "#/components/schemas/APIFlowNetworkEntityRequest" } }, "services": { "type": "array", "description": "List of network services", "items": { "$ref": "#/components/schemas/APIFlowNetworkEntityRequest" } }, "comment": { "type": "string", "description": "Flow comments" }, "network_applications": { "type": "array", "description": "List of network applications", "items": { "$ref": "#/components/schemas/APIFlowNetworkEntityRequest" } }, "custom_fields": { "type": "array", "description": "List of flow custom field values", "items": { "$ref": "#/components/schemas/APICustomFieldRequest" } } } }] }, "APISubscribedFlowContent": { "type": "object", "properties": { "users": { "type": "array", "description": "List of network users", "items": { "type": "string", "description": "List of network users" } }, "comment": { "type": "string", "description": "Flow comments" }, "shared_flow_name": { "type": "string", "description": "Shared flow name" }, "placeholder_network_object": { "type": "array", "description": "List of network entity placeholders to be assigned", "items": { "$ref": "#/components/schemas/APIFlowNetworkEntityRequest" } }, "custom_fields": { "type": "array", "description": "List of flow custom field values", "items": { "$ref": "#/components/schemas/APICustomFieldRequest" } } }, "description": "Subscribed flow data" }, "APISubscribedFlowRequest": { "type": "object", "description": "Subscribed flow", "allOf": [{ "$ref": "#/components/schemas/APIAbstractFlowRequest" }, { "type": "object", "properties": { "shared_application_name": { "type": "string", "description": "Shared application name" }, "subscribed_flows": { "type": "array", "description": "List of shared flows subscribed by the application\nUsage example:
{
 \"type\": \"SUBSCRIBED\",
 \"shared_application_name\": \"string\",
 \"subscribed_flows\": [
  {
   \"shared_flow_name\": \"string\",
   \"placeholder_network_object\": [
    {
    \"name\": \"string\",
    \"device\" : \"string\"
    }
   ],
   \"comment\": \"string\",
   \"custom_fields\": [
    {
    \"name\": \"string\",
    \"value\": \"string\"
    }
   ]
  }
 ]
}", "items": { "$ref": "#/components/schemas/APISubscribedFlowContent" } } } }] }, "APIEditApplicationCustomFieldRequest": { "type": "object", "properties": { "setCustomFields": { "uniqueItems": true, "type": "array", "description": "List of custom fields to set in the application", "items": { "$ref": "#/components/schemas/APICustomFieldRequest" } }, "clearCustomFields": { "uniqueItems": true, "type": "array", "description": "List of custom field names to clear in the application", "items": { "type": "string", "description": "List of custom field names to clear in the application" } } }, "description": "List of custom fields to set and clear" }, "APIApplicationContact": { "type": "object", "properties": { "email": { "type": "string", "description": "Contact e-mail address" }, "role": { "type": "string", "description": "The contact role in the application" } }, "description": "List of contacts to remove from the application" }, "APIEditApplicationContactsRequest": { "type": "object", "properties": { "addContacts": { "uniqueItems": true, "type": "array", "description": "List of contacts to add to the application", "items": { "$ref": "#/components/schemas/APIApplicationContact" } }, "removeContacts": { "uniqueItems": true, "type": "array", "description": "List of contacts to remove from the application", "items": { "$ref": "#/components/schemas/APIApplicationContact" } } }, "description": "List of contacts to add and remove" }, "RestApplicationConnectivity": { "type": "object", "properties": { "status": { "type": "string", "description": "Connectivity status for application flow" }, "flows": { "type": "array", "description": "List of connectivity status by flow", "items": { "$ref": "#/components/schemas/APIFlowConnectivity" } } }, "description": "Connectivity status for application flows" }, "APIApplicationApplyRequest": { "type": "object", "properties": { "selectedFlowsIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } } }, "description": "Apply application data" }, "APIApplicationPermissionDefinition": { "type": "object", "properties": { "type": { "type": "string", "description": "Permission entity type", "enum": ["USER", "ROLE"] }, "name": { "type": "string", "description": "Permission name" }, "permission": { "type": "string", "description": "Permission type", "enum": ["VIEW", "EDIT"] } }, "description": "Application permission" }, "APIApplicationRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "Application name" }, "labels": { "type": "array", "description": "List of tags", "items": { "type": "string", "description": "List of tags" } }, "contacts": { "type": "array", "description": "List of contacts and roles", "items": { "$ref": "#/components/schemas/APIApplicationContact" } }, "flows": { "type": "array", "description": "List of flows", "items": { "oneOf": [{ "$ref": "#/components/schemas/APIFlowRequest" }, { "$ref": "#/components/schemas/APISubscribedFlowRequest" }] } }, "permissions": { "type": "array", "description": "List of permissions", "items": { "$ref": "#/components/schemas/APIApplicationPermissionDefinition" } }, "custom_fields": { "type": "array", "description": "List of custom field values", "items": { "$ref": "#/components/schemas/APICustomFieldRequest" } } }, "description": "New application data" }, "APIDefaultPermissions": { "type": "object", "properties": { "requestor": { "uniqueItems": true, "type": "array", "description": "List of requestor user permissions", "items": { "$ref": "#/components/schemas/APIGlobalPermission" } }, "privileged": { "uniqueItems": true, "type": "array", "description": "List of privileged user permissions", "items": { "$ref": "#/components/schemas/APIGlobalPermission" } } }, "description": "User permissions data" }, "APIGlobalPermission": { "type": "object", "properties": { "name": { "type": "string", "description": "Permission name" }, "allowed": { "type": "boolean", "description": "Is permission allowed" } }, "description": "Global permission" }, "APINetworkService": { "type": "object", "properties": { "revisionID": { "type": "integer", "description": "Revision id", "format": "int32" }, "serviceID": { "type": "integer", "description": "First revision id", "format": "int32" }, "name": { "type": "string", "description": "Service name" }, "origin": { "type": "string", "description": "Service origin" }, "revisionStatus": { "type": "string", "description": "Revision status" }, "devices": { "type": "array", "description": "List of devices that contain the service", "items": { "type": "string", "description": "List of devices that contain the service" } }, "services": { "type": "array", "description": "List of service item names", "items": { "type": "string", "description": "List of service item names" } }, "lastUpdateDate": { "type": "string", "description": "Last update date", "format": "date-time" }, "createdDate": { "type": "string", "description": "Creation date", "format": "date-time" }, "customFields": { "type": "array", "description": "List of custom field values", "items": { "$ref": "#/components/schemas/APIProperty" } } }, "description": "Network Service" }, "APINetworkObject": { "type": "object", "properties": { "revisionID": { "type": "integer", "description": "Object revision id", "format": "int32" }, "objectID": { "type": "integer", "description": "Object id of the first revision", "format": "int32" }, "name": { "type": "string", "description": "Object name" }, "objectType": { "type": "string", "description": "Object type" }, "revisionStatus": { "type": "string", "description": "Object revision status" }, "devices": { "type": "array", "description": "List of devices containing the object", "items": { "type": "string", "description": "List of devices containing the object" } }, "ipAddresses": { "type": "array", "description": "List of IP addresses", "items": { "type": "string", "description": "List of IP addresses" } }, "tags": { "type": "object", "additionalProperties": { "type": "array", "description": "Network object tags by tag type", "items": { "$ref": "#/components/schemas/RestNamedObject" } }, "description": "Network object tags by tag type" }, "members": { "type": "array", "description": "List of group members", "items": { "$ref": "#/components/schemas/RestNamedObject" } }, "lastUpdateDate": { "type": "string", "description": "Last update date", "format": "date-time" }, "createdDate": { "type": "string", "description": "Creation date", "format": "date-time" }, "origin": { "type": "string", "description": "Object origin" }, "vulnerabilityScore": { "type": "integer", "description": "Vulnerability score", "format": "int32" }, "customFields": { "type": "array", "description": "List of custom field values", "items": { "$ref": "#/components/schemas/APIProperty" } } }, "description": "Network object data" }, "RestNamedObject": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "description": "List of group members" }, "RestObjectVulnerability": { "type": "object", "properties": { "objectID": { "type": "integer", "description": "Network object id", "format": "int32" }, "objectName": { "type": "string", "description": "Network object name" }, "vulnerabilities": { "type": "array", "description": "List of vulnerabilities", "items": { "$ref": "#/components/schemas/RestVulnerability" } } }, "description": "Network object vulnerability" }, "RestVulnerability": { "type": "object", "properties": { "ip": { "type": "string", "description": "IP address" }, "id": { "type": "string", "description": "Vulnerability id" }, "title": { "type": "string", "description": "Vulnerability title" }, "cvss": { "type": "number", "description": "Vulnerability score", "format": "float" }, "description": { "type": "string", "description": "Vulnerability description" } }, "description": "Vulnerability information" }, "RestApplicationVulnerability": { "type": "object", "properties": { "findings": { "type": "array", "description": "List of vulnerabilities found in the application", "items": { "$ref": "#/components/schemas/RestObjectVulnerability" } }, "missingInformation": { "type": "array", "description": "List of user names with application view permissions", "items": { "$ref": "#/components/schemas/RestNamedObject" } } }, "description": "Application vulnerability information" }, "RestRisk": { "type": "object", "properties": { "riskId": { "type": "integer", "description": "Risk id", "format": "int32" }, "code": { "type": "string", "description": "Risk code" }, "level": { "type": "string", "description": "Risk level" }, "title": { "type": "string", "description": "Risk description" }, "profile": { "type": "string", "description": "Risk profile" } }, "description": "Application risk information" }, "RestBaseApplicationRevision": { "type": "object", "properties": { "revisionID": { "type": "integer", "description": "Application revision id", "format": "int32" }, "revisionStatus": { "type": "string", "description": "Application revision status" }, "createdDate": { "type": "string", "description": "Revision creation date", "format": "date-time" }, "applicationRevisionID": { "type": "integer", "description": "Application Revision ID", "format": "int32" } }, "description": "Application revision information" }, "APIFlow": { "type": "object", "properties": { "flowID": { "type": "integer", "description": "Flow id", "format": "int32" }, "flowFlowID": { "type": "integer", "description": "Flow Flow id", "format": "int32" }, "name": { "type": "string", "description": "Flow name" }, "comment": { "type": "string", "description": "Flow comments" }, "flowType": { "type": "string", "description": "Flow type", "enum": ["APPLICATION_FLOW", "SHARED_FLOW", "SHARED_FLOW_INSTANCE", "SUBSCRIBED_FLOW"] }, "lastUpdateDate": { "type": "string", "description": "Last update date", "format": "date-time" }, "createdDate": { "type": "string", "description": "Creation date", "format": "date-time" }, "customFields": { "type": "array", "description": "List of custom field values", "items": { "$ref": "#/components/schemas/APIProperty" } }, "connectivityStatus": { "type": "string", "description": "Flow connectivity status" }, "subscribedApplication": { "type": "string", "description": "Subscribed flow application name" }, "sharedFlowID": { "type": "integer", "description": "Instance flow shared flow ID", "format": "int32" }, "sources": { "type": "array", "description": "List of network objects used as sources", "items": { "$ref": "#/components/schemas/APINetworkObject" } }, "destinations": { "type": "array", "description": "List of network objects used as destinations", "items": { "$ref": "#/components/schemas/APINetworkObject" } }, "services": { "type": "array", "description": "List of network services", "items": { "$ref": "#/components/schemas/APINetworkService" } }, "networkApplications": { "type": "array", "description": "List of network applications", "items": { "$ref": "#/components/schemas/APINetworkApplication" } }, "networkUsers": { "type": "array", "description": "List of network users", "items": { "$ref": "#/components/schemas/RestNetworkUser" } }, "risks": { "type": "array", "description": "List of risks", "items": { "$ref": "#/components/schemas/RestRisk" } } }, "description": "Application flow data" }, "APINetworkApplication": { "type": "object", "properties": { "revisionID": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "origin": { "type": "string" }, "devices": { "type": "array", "items": { "type": "string" } }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/RestNamedObject" } }, "defaultServices": { "type": "array", "items": { "type": "string" } }, "lastUpdateDate": { "type": "string", "format": "date-time" }, "createdDate": { "type": "string", "format": "date-time" } }, "description": "List of network applications" }, "RestNetworkUser": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "description": "List of network users" }, "APIApplicationActivityLog": { "type": "object", "properties": { "userName": { "type": "string", "description": "Activity user name" }, "date": { "type": "string", "description": "Activity date", "format": "date-time" }, "category": { "type": "string", "description": "Activity category" }, "description": { "type": "string", "description": "Activity description" }, "applicationName": { "type": "string", "description": "Application name" } }, "description": "Application activity log entry" }, "PciApplicationVulnerabilityResponse": { "type": "object", "properties": { "application_id": { "type": "integer", "description": "Application revision id", "format": "int32" }, "application_name": { "type": "string", "description": "Application name" }, "application_vulnerability_score": { "type": "integer", "description": "Application vulnerability score", "format": "int32" }, "application_severity": { "type": "string", "description": "Application vulnerability severity" }, "unscanned_servers": { "type": "integer", "description": "Unscanned servers", "format": "int32" }, "unscanned_pci_servers": { "type": "integer", "description": "Unscanned servers in PCI zone", "format": "int32" } }, "description": "Vulnerability scores for applications in PCI zone" }, "APIDeleteResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "object" } }, "changeRequest": { "$ref": "#/components/schemas/RestChangeRequest" }, "networkObject": { "$ref": "#/components/schemas/APINetworkObject" } }, "description": "Delete network object results" }, "APIApplicationPermittedEntities": { "type": "object", "properties": { "applicationName": { "type": "string", "description": "Application name" }, "usersView": { "uniqueItems": true, "type": "array", "description": "List of user names with application view permissions", "items": { "type": "string", "description": "List of user names with application view permissions" } }, "usersEdit": { "uniqueItems": true, "type": "array", "description": "List of user names with application edit permissions", "items": { "type": "string", "description": "List of user names with application edit permissions" } }, "rolesView": { "uniqueItems": true, "type": "array", "description": "List of role names with application view permissions", "items": { "type": "string", "description": "List of role names with application view permissions" } }, "rolesEdit": { "uniqueItems": true, "type": "array", "description": "List of role names with application edit permissions", "items": { "type": "string", "description": "List of role names with application edit permissions" } } }, "description": "Application users and roles permissions" }, "APIEditApplicationContactsResponse": { "type": "object", "properties": { "applicationId": { "type": "integer", "description": "Application revision id", "format": "int32" }, "contacts": { "uniqueItems": true, "type": "array", "description": "List of contacts", "items": { "$ref": "#/components/schemas/APIApplicationContact" } } }, "description": "Contacts assigned to an application" }, "APIEditApplicationCustomFieldResponse": { "type": "object", "properties": { "applicationId": { "type": "integer", "description": "Application revision id", "format": "int32" }, "customFields": { "type": "array", "description": "List of custom fields values", "items": { "$ref": "#/components/schemas/APICustomFieldRequest" } } }, "description": "List of custom fields values in an application" }, "APIEditApplicationLabelsResponse": { "type": "object", "properties": { "applicationId": { "type": "integer", "description": "Application revision id", "format": "int32" }, "labels": { "type": "array", "description": "Current tags", "items": { "type": "string", "description": "Current tags" } } }, "description": "List of tags in an application" }, "NetworkEntitySaveResponse": { "type": "object", "properties": { "oldObject": { "$ref": "#/components/schemas/NetworkEntity" }, "objNewAffectedApplications": { "$ref": "#/components/schemas/NetworkEntityAffectedApplications" }, "affectedObjects": { "type": "array", "description": "List of affected network entities", "items": { "$ref": "#/components/schemas/NetworkEntity" } }, "newObject": { "$ref": "#/components/schemas/NetworkEntity" }, "objectReplaceMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/NetworkEntity" }, "description": "Changed parent objects" }, "significantChange": { "type": "boolean", "description": "Is significant change" } }, "description": "Network entity save results" }, "APIEditFlowsResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "object" } }, "flows": { "type": "array", "description": "List of flows", "items": { "$ref": "#/components/schemas/APIFlow" } } }, "description": "List of all application flows" }, "Status": { "type": "object", "properties": { "status": { "type": "string" }, "type": { "type": "string" }, "msg": { "type": "string" }, "success": { "type": "boolean" }, "error": { "type": "string" }, "data": { "type": "object", "additionalProperties": { "type": "object" } }, "files": { "type": "object" } } }, "APIEditedEndpoint": { "type": "object", "properties": { "changeRequest": { "$ref": "#/components/schemas/RestChangeRequest" }, "networkObject": { "$ref": "#/components/schemas/APINetworkObject" } }, "description": "Edit network object results" }, "APIReplaceAbstractObjectResponse": { "type": "object", "properties": { "replacedInApplications": { "uniqueItems": true, "type": "array", "description": "List of application id where the object was replaced", "items": { "type": "integer", "description": "List of application id where the object was replaced", "format": "int32" } }, "changeRequestId": { "type": "integer", "description": "FireFlow change request id", "format": "int32" } }, "description": "Replace abstract object action results" }, "APIRoleEntityPermissions": { "type": "object", "properties": { "name": { "type": "string", "description": "Permission name" }, "authorizedViewsAndActions": { "uniqueItems": true, "type": "array", "description": "List of allowed global permissions", "items": { "$ref": "#/components/schemas/APIGlobalPermission" } }, "authorizedApplications": { "uniqueItems": true, "type": "array", "description": "List of allowed application permissions", "items": { "$ref": "#/components/schemas/APIEntityApplicationPermission" } }, "roleUsers": { "uniqueItems": true, "type": "array", "description": "List of user names assigned to the role", "items": { "type": "string", "description": "List of user names assigned to the role" } }, "enabled": { "type": "boolean", "description": "Is enabled" } }, "description": "Role permissions" }, "APIUserEntityPermissions": { "type": "object", "properties": { "name": { "type": "string", "description": "Permission name" }, "authorizedViewsAndActions": { "uniqueItems": true, "type": "array", "description": "List of allowed global permissions", "items": { "$ref": "#/components/schemas/APIGlobalPermission" } }, "authorizedApplications": { "uniqueItems": true, "type": "array", "description": "List of allowed application permissions", "items": { "$ref": "#/components/schemas/APIEntityApplicationPermission" } }, "fullName": { "type": "string", "description": "User full name" }, "roles": { "uniqueItems": true, "type": "array", "description": "List of role names assigned to the user", "items": { "type": "string", "description": "List of role names assigned to the user" } }, "inheritedAuthorizedApplications": { "uniqueItems": true, "type": "array", "description": "List of inherited application permissions", "items": { "$ref": "#/components/schemas/APIEntityApplicationPermission" } }, "privileged": { "type": "boolean" } }, "description": "User permissions" }, "APIPermittedPermissionResponse": { "type": "object", "properties": { "permitted": { "type": "boolean" } } }, "APIEntityApplicationPermission": { "type": "object", "properties": { "applicationID": { "type": "integer", "description": "Application revision id", "format": "int32" }, "name": { "type": "string", "description": "Permission name" }, "permission": { "type": "string", "description": "Permission type", "enum": ["view", "edit"] } }, "description": "Application permission" }, "NetworkEntity": { "type": "object", "properties": { "head": { "type": "boolean" }, "dynamic": { "type": "boolean" }, "objectOrigin": { "$ref": "#/components/schemas/Origin" }, "revisionOrigin": { "$ref": "#/components/schemas/Origin" }, "status": { "type": "string", "enum": ["UNKNOWN", "ACTIVE", "HISTORY", "DRAFT", "PENDING", "REJECTED", "PENDING_DECOMMISSION", "DECOMMISSIONED"] }, "changeRequests": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequest" } }, "devices": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Device" } }, "networkEntityType": { "type": "string", "enum": ["Endpoint", "Service"] }, "name": { "type": "string" }, "subPoints": { "uniqueItems": true, "type": "array", "items": { "type": "object" } }, "subPointsFlat": { "uniqueItems": true, "type": "array", "items": { "type": "object" } }, "group": { "type": "boolean" }, "devicesDisplayNames": { "type": "array", "items": { "type": "string" } }, "groupId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "newObject": { "type": "boolean" }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/Property" } } } }, "NetworkEntityAffectedApplications": { "type": "object", "properties": { "affectedApplicationsRevisionsPerAppId": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AffectedApplicationRevisions" }, "description": "Affected applications revisions by application app_id" }, "incompleteMap": { "type": "boolean", "description": "Is affected applications list incomplete" }, "sortedApplications": { "type": "array", "items": { "$ref": "#/components/schemas/AffectedApplicationRevisions" } }, "affectsNonDraftsApplications": { "type": "boolean" }, "allApplications": { "type": "array", "items": { "$ref": "#/components/schemas/Application" } } }, "description": "Affected applications by network entity change" }, "Origin": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } } }, "ChangeRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "changeRequestId": { "type": "integer", "format": "int32" }, "subject": { "type": "string" }, "requestor": { "type": "string" }, "status": { "type": "string", "enum": ["UNKNOWN", "OPEN", "RESOLVED", "REJECTED"] }, "statusName": { "type": "string" }, "issueDate": { "type": "string", "format": "date-time" }, "applications": { "type": "array", "items": { "$ref": "#/components/schemas/Application" } }, "endpoints": { "type": "array", "items": { "$ref": "#/components/schemas/EndPoint" } }, "services": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkService" } }, "crOriginType": { "type": "string", "enum": ["Application", "Endpoint", "Service"] }, "crOriginObjectId": { "type": "integer", "format": "int32" }, "ignoreStatusChanges": { "type": "boolean" }, "crTemplateType": { "type": "string", "enum": ["TrafficChange", "ObjectChange"] }, "unresolved": { "type": "boolean" }, "name": { "type": "string" }, "newObject": { "type": "boolean" } } }, "Device": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "brand": { "$ref": "#/components/schemas/Brand" }, "displayName": { "type": "string" }, "lastReport": { "type": "string" }, "policyHash": { "type": "string" }, "parentDevice": { "$ref": "#/components/schemas/Device" }, "objectContainerIDs": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "tagged": { "type": "boolean" }, "newObject": { "type": "boolean" } } }, "Property": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "propertyType": { "$ref": "#/components/schemas/PropertyType" }, "value": { "type": "string" } } }, "AffectedApplicationRevisions": { "type": "object", "properties": { "appName": { "type": "string" }, "appAppId": { "type": "integer", "format": "int32" }, "revisionsMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/QueryResponse" } } } }, "Application": { "required": ["name"], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "app_id": { "type": "integer", "format": "int32" }, "name": { "maxLength": 2147483647, "minLength": 1, "type": "string" }, "revision": { "$ref": "#/components/schemas/RevisionInformation" }, "metaData": { "$ref": "#/components/schemas/ApplicationMetaData" }, "updateDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "applicationProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Property" } }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationPersonRole" } }, "applicationFlows": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationFlow" } }, "sharedFlows": { "type": "array", "items": { "$ref": "#/components/schemas/SharedFlow" } }, "flowSubscribed": { "type": "array", "items": { "$ref": "#/components/schemas/SubscribedFlow" } }, "connectivity": { "$ref": "#/components/schemas/Connectivity" }, "changeRequests": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequest" } }, "lastRiskCheck": { "type": "string", "format": "date-time" }, "riskScore": { "type": "integer", "format": "int32" }, "riskProfile": { "type": "string" }, "riskInformationUpToDate": { "type": "boolean" }, "connectivityScanInProgress": { "type": "boolean" }, "vulnerabilityScanInProgress": { "type": "boolean" }, "riskScanInProgress": { "type": "boolean" }, "discoveryUpdateInProgress": { "type": "boolean" }, "flows": { "type": "array", "items": { "$ref": "#/components/schemas/Flow" } }, "applicationSubscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/SubscribedFlow" } }, "flowsRevisions": { "type": "array", "items": { "$ref": "#/components/schemas/Flow" } }, "allFlows": { "type": "array", "items": { "$ref": "#/components/schemas/FlowInterface" } }, "allRevisionFlows": { "type": "array", "items": { "$ref": "#/components/schemas/FlowInterface" } }, "allFlowsExceptSharedFlowsSubscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/FlowInterface" } }, "allFlowsMapByType": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/FlowInterface" } } }, "flowInterfaces": { "type": "array", "items": { "$ref": "#/components/schemas/FlowInterface" } }, "allFlowSubscribedRevisions": { "type": "array", "items": { "$ref": "#/components/schemas/Flow" } }, "flowsWithSubscribed": { "type": "array", "items": { "$ref": "#/components/schemas/Flow" } }, "newApplication": { "type": "boolean" }, "flowNames": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "flowInstances": { "type": "array", "items": { "$ref": "#/components/schemas/SubscribedFlow" } }, "revisionNewInstances": { "type": "array", "items": { "$ref": "#/components/schemas/SubscribedFlow" } }, "revisionNewSubscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/SubscribedFlow" } }, "risks": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Risk" } }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/Property" } }, "applicationEditableEndpoints": { "type": "array", "items": { "$ref": "#/components/schemas/EndPoint" } }, "pciApplication": { "type": "boolean" }, "pciApplicationApply": { "type": "string", "enum": ["NONE", "PCI", "PCI_EXCLUDE"] }, "inDecommissionProcess": { "type": "boolean" }, "decommissioned": { "type": "boolean" }, "groupId": { "type": "integer", "format": "int32" }, "sharedFlowsSubscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/SubscribedFlow" } }, "applicationAndSharedFlowsNameMapByFlowId": { "type": "object", "additionalProperties": { "type": "string" } }, "active": { "type": "boolean" }, "newObject": { "type": "boolean" } } }, "EndPoint": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "endpointGroupId": { "type": "integer", "format": "int32" }, "head": { "type": "boolean" }, "name": { "type": "string" }, "lcName": { "type": "string" }, "canonizedName": { "type": "string" }, "dnsLookup": { "type": "boolean" }, "type": { "type": "string", "enum": ["Unknown", "Range", "Host", "Network", "Group", "Domain", "Gateway", "Abstract"] }, "revisionOrigin": { "$ref": "#/components/schemas/Origin" }, "revisionOriginId": { "type": "integer", "format": "int32" }, "metaData": { "$ref": "#/components/schemas/EndPointMetaData" }, "md5": { "type": "string" }, "updateDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "statusId": { "type": "integer", "format": "int32", "writeOnly": true }, "membersStatusId": { "type": "integer", "format": "int32", "writeOnly": true }, "changeRequests": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequest" } }, "labels": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Label" } }, "objectOrigin": { "$ref": "#/components/schemas/Origin" }, "membersNames": { "type": "array", "items": { "type": "string" } }, "sortedSubPoints": { "type": "array", "items": { "$ref": "#/components/schemas/EndPoint" } }, "groupId": { "type": "integer", "format": "int32" }, "hostIp": { "$ref": "#/components/schemas/IpRange" }, "fullRange": { "type": "boolean" }, "sortedFlatRanges": { "type": "array", "items": { "$ref": "#/components/schemas/IpRange" } }, "sortedImplicitOrFlatRangesWithoutSubPoints": { "type": "array", "items": { "$ref": "#/components/schemas/IpRange" } }, "endpointProperties": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Property" } }, "status": { "type": "string", "enum": ["UNKNOWN", "ACTIVE", "HISTORY", "DRAFT", "PENDING", "REJECTED", "PENDING_DECOMMISSION", "DECOMMISSIONED"] }, "networkEntityType": { "type": "string", "enum": ["Endpoint", "Service"] }, "objectStatus": { "type": "string", "enum": ["UNKNOWN", "ACTIVE", "HISTORY", "DRAFT", "PENDING", "REJECTED", "PENDING_DECOMMISSION", "DECOMMISSIONED"] }, "memberStatus": { "type": "string", "enum": ["UNKNOWN", "ACTIVE", "HISTORY", "DRAFT", "PENDING", "REJECTED", "PENDING_DECOMMISSION", "DECOMMISSIONED"] }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/Property" } }, "sortedSubImplicitPointsRanges": { "type": "array", "items": { "$ref": "#/components/schemas/IpRange" } }, "dynamic": { "type": "boolean" }, "pciObject": { "type": "boolean" }, "group": { "type": "boolean" }, "newObject": { "type": "boolean" }, "devicesDisplayNames": { "type": "array", "items": { "type": "string" } } } }, "NetworkService": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "lcName": { "type": "string" }, "canonizedName": { "type": "string" }, "updateDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "networkServices": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/NetworkServiceItem" } }, "devices": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Device" } }, "metaData": { "$ref": "#/components/schemas/NetworkServiceMetaData" }, "revisionOrigin": { "$ref": "#/components/schemas/Origin" }, "head": { "type": "boolean" }, "serviceGroupId": { "type": "integer", "format": "int32" }, "statusId": { "type": "integer", "format": "int32", "writeOnly": true }, "changeRequests": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequest" } }, "groupId": { "type": "integer", "format": "int32" }, "networkServiceItemsStrings": { "type": "array", "items": { "type": "string" } }, "dynamic": { "type": "boolean" }, "status": { "type": "string", "enum": ["UNKNOWN", "ACTIVE", "HISTORY", "DRAFT", "PENDING", "REJECTED", "PENDING_DECOMMISSION", "DECOMMISSIONED"] }, "networkEntityType": { "type": "string", "enum": ["Endpoint", "Service"] }, "single": { "type": "boolean" }, "objectOrigin": { "$ref": "#/components/schemas/Origin" }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/Property" } }, "subPoints": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/NetworkService" } }, "subPointsFlat": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/NetworkService" } }, "group": { "type": "boolean" }, "newObject": { "type": "boolean" }, "devicesDisplayNames": { "type": "array", "items": { "type": "string" } } } }, "Brand": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "brandId": { "type": "string" } } }, "PropertyType": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "propertyEntityType": { "type": "string", "enum": ["Application", "Flow", "Endpoint", "Project", "Person", "Service"] }, "name": { "type": "string" }, "description": { "type": "string" }, "showIfEmpty": { "type": "boolean" }, "enable": { "type": "boolean" }, "mandatory": { "type": "boolean" }, "typeName": { "type": "string" }, "newObject": { "type": "boolean" } } }, "RevisionInformation": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "counter": { "type": "integer", "format": "int32" }, "next": { "$ref": "#/components/schemas/RevisionInformation" }, "prev": { "$ref": "#/components/schemas/RevisionInformation" }, "status": { "type": "string", "enum": ["UNKNOWN", "ACTIVE", "HISTORY", "DRAFT", "PENDING", "REJECTED", "PENDING_DECOMMISSION", "DECOMMISSIONED"] }, "updateDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "head": { "type": "boolean" }, "newObject": { "type": "boolean" } } }, "ApplicationMetaData": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "lifecyclePhase": { "$ref": "#/components/schemas/ApplicationLifecycle" }, "expirationDate": { "type": "string", "format": "date-time" }, "applicationLock": { "type": "boolean" }, "appId": { "type": "integer", "format": "int32" }, "vulnerabilityScore": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationVulnerabilityScore" } }, "updateDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "renameInProgress": { "type": "boolean" }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/FileAttachment" } }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/Label" } }, "applicationsExcludedLabels": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Label" } }, "discoveredApplications": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/DiscoveredApplication" } }, "labelsByOrder": { "type": "array", "items": { "$ref": "#/components/schemas/Label" } }, "labelsForClone": { "type": "array", "items": { "$ref": "#/components/schemas/Label" } } } }, "ApplicationPersonRole": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "person": { "$ref": "#/components/schemas/Person" }, "application_role": { "$ref": "#/components/schemas/ApplicationRole" }, "keyStr": { "type": "string" } } }, "ApplicationFlow": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "flow_id": { "type": "integer", "format": "int32" }, "flow_name": { "type": "string" }, "comment": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "updateDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "application": { "$ref": "#/components/schemas/Application" }, "sources": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/EndPoint" } }, "destinations": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/EndPoint" } }, "services": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/NetworkService" } }, "networkApplications": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/NetworkApplication" } }, "networkUsers": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/NetworkUser" } }, "flowProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Property" } }, "changeRequests": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequest" } }, "lastChangeRequest": { "$ref": "#/components/schemas/ChangeRequest" }, "connectivity": { "$ref": "#/components/schemas/Connectivity" }, "abstractFlow": { "type": "boolean" }, "flowType": { "type": "string", "enum": ["NATIVE_FLOW", "SHARED_FLOW", "SUBSCRIBED_FLOW", "INSTANCE_FLOW"] }, "name": { "type": "string" }, "flowContainingAbstractObject": { "type": "boolean" }, "groupId": { "type": "integer", "format": "int32" }, "newObject": { "type": "boolean" } } }, "SharedFlow": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "flow_id": { "type": "integer", "format": "int32" }, "flow_name": { "type": "string" }, "comment": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "updateDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "application": { "$ref": "#/components/schemas/Application" }, "sources": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/EndPoint" } }, "destinations": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/EndPoint" } }, "services": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/NetworkService" } }, "networkApplications": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/NetworkApplication" } }, "networkUsers": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/NetworkUser" } }, "flowProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Property" } }, "instances": { "type": "array", "items": { "$ref": "#/components/schemas/SubscribedFlow" } }, "dstPlaceholder": { "type": "boolean" }, "srcPlaceholder": { "type": "boolean" }, "editInstances": { "type": "array", "items": { "$ref": "#/components/schemas/SubscribedFlow" } }, "flowType": { "type": "string", "enum": ["NATIVE_FLOW", "SHARED_FLOW", "SUBSCRIBED_FLOW", "INSTANCE_FLOW"] }, "abstractFlow": { "type": "boolean" }, "allInstancesMapPerFlowFlowId": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/SubscribedFlow" } } }, "name": { "type": "string" }, "flowContainingAbstractObject": { "type": "boolean" }, "groupId": { "type": "integer", "format": "int32" }, "newObject": { "type": "boolean" } } }, "SubscribedFlow": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "flow_id": { "type": "integer", "format": "int32" }, "flow_name": { "type": "string" }, "comment": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "updateDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "application": { "$ref": "#/components/schemas/Application" }, "sources": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/EndPoint" } }, "destinations": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/EndPoint" } }, "services": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/NetworkService" } }, "networkApplications": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/NetworkApplication" } }, "networkUsers": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/NetworkUser" } }, "flowProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Property" } }, "changeRequests": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequest" } }, "lastChangeRequest": { "$ref": "#/components/schemas/ChangeRequest" }, "connectivity": { "$ref": "#/components/schemas/Connectivity" }, "subscribedApplication": { "$ref": "#/components/schemas/Application" }, "template": { "$ref": "#/components/schemas/SharedFlow" }, "deletedApplicationAppId": { "type": "integer", "format": "int32" }, "flowType": { "type": "string", "enum": ["NATIVE_FLOW", "SHARED_FLOW", "SUBSCRIBED_FLOW", "INSTANCE_FLOW"] }, "subscribedApplicationHeadAndNotDecommissioned": { "type": "boolean" }, "subscribedApplicationHead": { "type": "boolean" }, "subscribedApplicationDecommissioned": { "type": "boolean" }, "abstractFlow": { "type": "boolean" }, "name": { "type": "string" }, "flowContainingAbstractObject": { "type": "boolean" }, "groupId": { "type": "integer", "format": "int32" }, "newObject": { "type": "boolean" } } }, "Connectivity": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "type": "string", "enum": ["Blocked", "Partial", "Pass", "Fail", "None", "Unfiltered"] }, "last_query_href": { "type": "string" }, "pending": { "type": "integer", "format": "int32" }, "updateDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "devices": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Device" } }, "color": { "type": "string" } } }, "Flow": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "flow_id": { "type": "integer", "format": "int32" }, "flow_name": { "type": "string" }, "comment": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "updateDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "application": { "$ref": "#/components/schemas/Application" }, "sources": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/EndPoint" } }, "destinations": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/EndPoint" } }, "services": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/NetworkService" } }, "networkApplications": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/NetworkApplication" } }, "networkUsers": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/NetworkUser" } }, "flowProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Property" } }, "changeRequests": { "type": "array", "items": { "$ref": "#/components/schemas/ChangeRequest" } }, "lastChangeRequest": { "$ref": "#/components/schemas/ChangeRequest" }, "connectivity": { "$ref": "#/components/schemas/Connectivity" }, "abstractFlow": { "type": "boolean" }, "flowType": { "type": "string", "enum": ["NATIVE_FLOW", "SHARED_FLOW", "SUBSCRIBED_FLOW", "INSTANCE_FLOW"] }, "name": { "type": "string" }, "flowContainingAbstractObject": { "type": "boolean" }, "groupId": { "type": "integer", "format": "int32" }, "newObject": { "type": "boolean" } } }, "FlowInterface": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "flow_id": { "type": "integer", "format": "int32" }, "flow_name": { "type": "string" }, "comment": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "updateDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "application": { "$ref": "#/components/schemas/Application" }, "sources": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/EndPoint" } }, "destinations": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/EndPoint" } }, "services": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/NetworkService" } }, "networkApplications": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/NetworkApplication" } }, "networkUsers": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/NetworkUser" } }, "flowProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Property" } }, "name": { "type": "string" }, "flowType": { "type": "string", "enum": ["NATIVE_FLOW", "SHARED_FLOW", "SUBSCRIBED_FLOW", "INSTANCE_FLOW"] }, "abstractFlow": { "type": "boolean" }, "flowContainingAbstractObject": { "type": "boolean" }, "groupId": { "type": "integer", "format": "int32" }, "newObject": { "type": "boolean" } } }, "Risk": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "code": { "type": "string" }, "title": { "type": "string" }, "profile": { "type": "string" }, "level": { "type": "string", "enum": ["High", "Susp_High", "Medium", "Low", "Ignore"] }, "newObject": { "type": "boolean" } } }, "EndPointMetaData": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "endpointGroupId": { "type": "integer", "format": "int32" }, "endpointOriginId": { "type": "integer", "format": "int32" }, "inProgress": { "type": "boolean" }, "vulnerabilityScore": { "type": "number", "format": "float" } } }, "Label": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "entityType": { "type": "string", "enum": ["Application", "Flow", "Endpoint", "Project", "Person", "Service"] }, "name": { "type": "string" }, "labelType": { "type": "integer", "format": "int32", "writeOnly": true }, "type": { "type": "string", "enum": ["CRITICAL_PROCESS", "USER_DEFINED", "PCI", "DYNAMIC", "SYSTEM_TAGS", "USER_TAGS"] }, "systemLabel": { "type": "boolean" }, "systemTag": { "type": "boolean" }, "permissionTag": { "type": "boolean" }, "newObject": { "type": "boolean" } } }, "IpRange": { "type": "object", "properties": { "low": { "type": "integer", "format": "int64" }, "high": { "type": "integer", "format": "int64" }, "id": { "type": "integer", "format": "int32" }, "minIp": { "type": "integer", "format": "int64" }, "maxIp": { "type": "integer", "format": "int64" }, "display": { "type": "string" }, "displayCIDR": { "type": "array", "items": { "type": "string" } }, "displayRange": { "type": "string" }, "optimalDisplay": { "type": "array", "items": { "type": "string" } }, "newObject": { "type": "boolean" }, "singleIP": { "type": "boolean" }, "cidr": { "type": "boolean" }, "any": { "type": "boolean" } } }, "NetworkServiceItem": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "protocol": { "type": "string" }, "srcPortStart": { "type": "integer", "format": "int32" }, "srcPortEnd": { "type": "integer", "format": "int32" }, "dstPortStart": { "type": "integer", "format": "int32" }, "dstPortEnd": { "type": "integer", "format": "int32" }, "display": { "type": "string" }, "any": { "type": "boolean" } } }, "NetworkServiceMetaData": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "serviceGroupId": { "type": "integer", "format": "int32" }, "objectOrigin": { "$ref": "#/components/schemas/Origin" }, "serviceProperties": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Property" } }, "inProgress": { "type": "boolean" } } }, "QueryResponse": { "type": "object", "properties": { "flowIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "flowsType": { "$ref": "#/components/schemas/ApplicationOwnerFlowsList" }, "applicationUpdatedDate": { "type": "string", "format": "date-time" }, "id": { "type": "integer", "format": "int32" }, "app_id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } } }, "ApplicationLifecycle": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32" }, "decommission": { "type": "boolean" }, "newObject": { "type": "boolean" } } }, "ApplicationVulnerabilityScore": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "metadata": { "$ref": "#/components/schemas/ApplicationMetaData" }, "score": { "type": "number", "format": "float" }, "date": { "type": "string", "format": "date-time" }, "severity": { "type": "string", "enum": ["NONE", "VERY_HIGH", "HIGH", "MEDIUM", "LOW", "NA"] } } }, "FileAttachment": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "filePath": { "type": "string" }, "createDate": { "type": "string", "format": "date-time" }, "newObject": { "type": "boolean" } } }, "DiscoveredApplication": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "sourceApplicationId": { "type": "integer", "format": "int32" }, "discoverySourceType": { "type": "string", "enum": ["AUTO_DISCOVERY", "TETRATION", "FILE"] }, "lastSnapshotId": { "type": "integer", "format": "int32" }, "createDate": { "type": "string", "format": "date-time" }, "updateDate": { "type": "string", "format": "date-time" } } }, "Person": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "first_name": { "type": "string" }, "middle_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string" }, "personProperties": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Property" } }, "person_application_roles": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationPersonRole" } }, "updateDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "full_name": { "type": "string" } } }, "ApplicationRole": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "updateDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "newObject": { "type": "boolean" } } }, "NetworkApplication": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "updateDate": { "type": "string", "format": "date-time" }, "createDate": { "type": "string", "format": "date-time" }, "networkApplicationMembers": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/NetworkApplication" } }, "defaultNetworkServices": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/NetworkServiceItem" } }, "devices": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Device" } }, "brand": { "$ref": "#/components/schemas/Brand" }, "origin": { "$ref": "#/components/schemas/Origin" }, "canonizedName": { "type": "string" }, "version": { "type": "string" }, "md5": { "type": "string" }, "newObject": { "type": "boolean" } } }, "NetworkUser": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "type": { "type": "string", "enum": ["USER", "GROUP"] }, "newObject": { "type": "boolean" } } }, "ApplicationOwnerFlowsList": { "type": "object", "properties": { "applicationFlows": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationFlow" } }, "sharedFlows": { "type": "array", "items": { "$ref": "#/components/schemas/SharedFlow" } }, "subscribedFlows": { "type": "array", "items": { "$ref": "#/components/schemas/SubscribedFlow" } }, "instancesFlows": { "type": "array", "items": { "$ref": "#/components/schemas/SubscribedFlow" } }, "allFlowsIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "applicationOwnerFullFlows": { "type": "array", "items": { "$ref": "#/components/schemas/Flow" } } } } } } }