{ "id": "@itentialopensource/adapter-checkpoint_management", "type": "Adapter", "export": "CheckpointManagement", "title": "Checkpoint_Management", "src": "adapter.js", "roles": [ "admin" ], "methods": [ { "name": "iapUpdateAdapterConfiguration", "summary": "Updates the adapter configuration", "description": "Updates the adapter configuration file with the provided changes", "input": [ { "name": "configFile", "type": "string", "info": "The name of the file to change", "required": true, "schema": { "title": "configFile", "type": "string" } }, { "name": "changes", "type": "object", "info": "JSON object containing the configuration changes", "required": true, "schema": { "title": "changes", "type": "object" } }, { "name": "entity", "type": "string", "info": "The entity in which the changes are being made", "required": false, "schema": { "title": "entity", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of file to change - action, schema, or mock", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "action", "type": "string", "info": "The action to be changed", "required": false, "schema": { "title": "action", "type": "string" } }, { "name": "replace", "type": "boolean", "info": "True to replace entire mock data, false to merge/append", "required": false, "schema": { "title": "replace", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUpdateAdapterConfiguration" }, "task": true }, { "name": "iapSuspendAdapter", "summary": "Suspends the adapter", "description": "Suspends the adapter", "input": [ { "name": "mode", "type": "enum", "enumerals": [ "pause", "error" ], "info": "How incoming requests are handled. Defaults to 'pause'", "description": "How incoming requests are handled. Defaults to 'pause'", "schema": { "title": "mode", "type": "string" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapSuspendAdapter" }, "task": true }, { "name": "iapUnsuspendAdapter", "summary": "Unsuspends the adapter", "description": "Unsuspends the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUnsuspendAdapter" }, "task": true }, { "name": "iapGetAdapterQueue", "summary": "Return the requests that are waiting in the queue if throttling is enabled", "description": "Return the requests that are waiting in the queue if throttling is enabled", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter queue", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetAdapterQueue" }, "task": true }, { "name": "iapFindAdapterPath", "summary": "Provides the ability to see if a particular API path is supported by the adapter", "description": "Provides the ability to see if a particular API path is supported by the adapter", "input": [ { "name": "apiPath", "type": "string", "info": "The API Path you want to check - make sure to not include base path and version", "description": "The API Path you want to check - make sure to not include base path and version", "schema": { "title": "apiPath", "type": "string" }, "required": true } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapFindAdapterPath" }, "task": true }, { "name": "iapTroubleshootAdapter", "summary": "Runs troubleshoot script for adapter", "description": "Runs troubleshoot script for adapter", "input": [ { "name": "props", "type": "object", "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}", "required": true, "schema": { "title": "props", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapTroubleshootAdapter" }, "task": true }, { "name": "iapRunAdapterHealthcheck", "summary": "Runs healthcheck script for adapter", "description": "Runs healthcheck script for adapter", "input": [], "output": { "name": "result", "type": "boolean", "description": "Whether healthcheck passed or failed", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterHealthcheck" }, "task": true }, { "name": "iapRunAdapterConnectivity", "summary": "Runs connectivity check script for adapter", "description": "Runs connectivity check script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterConnectivity" }, "task": true }, { "name": "iapRunAdapterBasicGet", "summary": "Runs basicGet script for adapter", "description": "Runs basicGet script for adapter", "input": [ { "name": "maxCalls", "required": false, "type": "number", "info": "How many GET endpoints to test (defaults to 5)", "schema": { "title": "maxCalls", "type": "number", "default": 5 } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterBasicGet" }, "task": true }, { "name": "iapMoveAdapterEntitiesToDB", "summary": "Moves entities from an adapter into the Itential Platform database", "description": "Moves entities from an adapter into the Itential Platform database", "input": [], "output": { "name": "res", "type": "object", "description": "A JSON Object containing status, code and the response from the mongo transaction", "schema": { "title": "res", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapMoveAdapterEntitiesToDB" }, "task": true }, { "name": "iapDeactivateTasks", "summary": "Deactivate the inputted tasks", "description": "Deactivate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to deactivate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapDeactivateTasks" }, "task": true }, { "name": "iapActivateTasks", "summary": "Activate the inputted tasks", "description": "activate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to activate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapActivateTasks" }, "task": true }, { "name": "iapPopulateEntityCache", "summary": "Populate the cache for the given entities", "description": "Populate the cache for the given entities", "input": [ { "name": "entityTypes", "type": "array", "info": "the entity type(s) to populate", "required": true, "schema": { "title": "entityTypes", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapPopulateEntityCache" }, "task": true }, { "name": "iapRetrieveEntitiesCache", "summary": "Retrieves data from cache for specified entity type", "description": "Retrieves data from cache for specified entity type", "input": [ { "name": "entityType", "type": "string", "info": "entity of which to retrieve", "required": true, "schema": { "title": "entityType", "type": "string" } }, { "name": "options", "type": "object", "info": "settings of which data to return and how to return it", "required": false, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRetrieveEntitiesCache" }, "task": true }, { "name": "getDevice", "summary": "Get the Appliance", "description": "Get the Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevice" }, "task": false }, { "name": "getDevicesFiltered", "summary": "Get Appliances that match the filter", "description": "Get Appliances that match the filter", "input": [ { "name": "options", "type": "object", "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }", "required": true, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevicesFiltered" }, "task": false }, { "name": "isAlive", "summary": "Checks the status for the provided Appliance", "description": "Checks the status for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "boolean", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/isAlive" }, "task": false }, { "name": "getConfig", "summary": "Gets a config for the provided Appliance", "description": "Gets a config for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } }, { "name": "format", "type": "string", "info": "The format to be returned - this is ignored as we always return json", "required": false, "schema": { "title": "format", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getConfig" }, "task": false }, { "name": "iapGetDeviceCount", "summary": "Gets a device count from the system", "description": "Gets a device count from the system", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetDeviceCount" }, "task": false }, { "name": "iapExpandedGenericAdapterRequest", "summary": "Makes the requested generic call with additional options", "description": "Makes the requested generic call with additional options via metadata", "input": [ { "name": "metadata", "type": "object", "info": "metadata for the call (optional)", "description": "metadata for the call - allows for many enhancements (optional)", "schema": { "title": "metadata", "type": "object" }, "required": false }, { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": false }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": false }, { "name": "pathVars", "type": "object", "info": "the parameters to be put within the url path (optional)", "description": "the parameters to be put within the url path (optional)", "schema": { "title": "pathVars", "type": "object" }, "required": false }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapExpandedGenericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequest", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequestNoBasePath", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequestNoBasePath" }, "task": true }, { "name": "iapRunAdapterLint", "summary": "Run the adapter lint script to return the results", "description": "Run the adapter lint script to return the results", "input": [], "output": { "name": "result", "type": "string", "description": "A string containing the run results", "schema": { "title": "result", "type": "string" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterLint" }, "task": true }, { "name": "iapRunAdapterTests", "summary": "Run the adapter test scripts (baseunit and unit) to return the results", "description": "Run the adapter test scripts (baseunit and unit) to return the results", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterTests" }, "task": true }, { "name": "iapGetAdapterInventory", "summary": "Provide inventory information abbout the adapter", "description": "Provide inventory information abbout the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapGetAdapterInventory" }, "task": true }, { "name": "login", "summary": "login", "description": "Login request to receive session token.", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/login" }, "task": true }, { "name": "loginToDomainWithSid", "summary": "loginToDomainWithSid", "description": "Login to a domain with sid.", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/loginToDomainWithSid" }, "task": true }, { "name": "publish", "summary": "publish", "description": "Publish the last changes. Use the show-task command to check the progress of the task.", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/publish" }, "task": true }, { "name": "publishWithSid", "summary": "publish", "description": "Publish the last changes. Use the show-task command to check the progress of the task.", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/publishWithSid" }, "task": true }, { "name": "discard", "summary": "discard", "description": "Discard the changes", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/discard" }, "task": true }, { "name": "discardWithSid", "summary": "discard", "description": "Discard the changes", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/discardWithSid" }, "task": true }, { "name": "logout", "summary": "logout", "description": "Log out from the existing session", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/logout" }, "task": true }, { "name": "logoutWithSid", "summary": "logout", "description": "Log out from the existing session", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/logoutWithSid" }, "task": true }, { "name": "disconnect", "summary": "disconnect", "description": "Disconnect a private session", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/disconnect" }, "task": true }, { "name": "disconnectWithSid", "summary": "disconnect", "description": "Disconnect a private session", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/disconnectWithSid" }, "task": true }, { "name": "keepalive", "summary": "keepalive", "description": "Keep the session alive", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/keepalive" }, "task": true }, { "name": "keepaliveWithSid", "summary": "keepalive", "description": "Keep the session alive", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/keepaliveWithSid" }, "task": true }, { "name": "showSession", "summary": "show-session", "description": "show-session", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showSession" }, "task": true }, { "name": "showSessionWithSid", "summary": "show-session", "description": "show-session", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showSessionWithSid" }, "task": true }, { "name": "setSession", "summary": "set-session", "description": "set-session", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setSession" }, "task": true }, { "name": "setSessionWithSid", "summary": "set-session", "description": "set-session", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setSessionWithSid" }, "task": true }, { "name": "continueSessionInSmartconsole", "summary": "continue-session-in-smartconsole", "description": "Continue an existing API session who's UID is \"bae159e7-d3ef-44ab-a8a8-ea3ce7ee25a5\" in SmartConsole.", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/continueSessionInSmartconsole" }, "task": true }, { "name": "continueSessionInSmartconsoleWithSid", "summary": "continue-session-in-smartconsole", "description": "Continue an existing API session who's UID is \"bae159e7-d3ef-44ab-a8a8-ea3ce7ee25a5\" in SmartConsole.", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/continueSessionInSmartconsoleWithSid" }, "task": true }, { "name": "showLastPublishedSession", "summary": "show-last-published-session", "description": "Show last published session", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showLastPublishedSession" }, "task": true }, { "name": "showLastPublishedSessionWithSid", "summary": "show-last-published-session", "description": "Show last published session", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showLastPublishedSessionWithSid" }, "task": true }, { "name": "purgePublishedSessionsByCount", "summary": "purge-published-sessions by count", "description": "Purge all sessions except the specified number of newest sessions to preserve.", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/purgePublishedSessionsByCount" }, "task": true }, { "name": "purgePublishedSessionsByCountWithSid", "summary": "purge-published-sessions by count", "description": "Purge all sessions except the specified number of newest sessions to preserve.", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/purgePublishedSessionsByCountWithSid" }, "task": true }, { "name": "switchSession", "summary": "switch-session", "description": "switch-session", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/switchSession" }, "task": true }, { "name": "switchSessionWithSid", "summary": "switch-session", "description": "switch-session", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/switchSessionWithSid" }, "task": true }, { "name": "assignSession", "summary": "assign-session", "description": "Assign an existing session with UID \"41e821a0-3720-11e3-aa6e-0800200c9fde\" to current administrator.", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/assignSession" }, "task": true }, { "name": "assignSessionWithSid", "summary": "assign-session", "description": "Assign an existing session with UID \"41e821a0-3720-11e3-aa6e-0800200c9fde\" to current administrator.", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/assignSessionWithSid" }, "task": true }, { "name": "takeOverSession", "summary": "take-over-session", "description": "Take over an existing session with UID \"41e821a0-3720-11e3-aa6e-0800200c9fde\".", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/takeOverSession" }, "task": true }, { "name": "takeOverSessionWithSid", "summary": "take-over-session", "description": "Take over an existing session with UID \"41e821a0-3720-11e3-aa6e-0800200c9fde\".", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/takeOverSessionWithSid" }, "task": true }, { "name": "showSessions", "summary": "show-sessions", "description": "Show all the sessions. Details level: UID", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showSessions" }, "task": true }, { "name": "showSessionsWithSid", "summary": "show-sessions", "description": "Show all the sessions. Details level: UID", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showSessionsWithSid" }, "task": true }, { "name": "showLoginMessage", "summary": "show-login-message", "description": "show-login-message", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showLoginMessage" }, "task": true }, { "name": "showLoginMessageWithSid", "summary": "show-login-message", "description": "show-login-message", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showLoginMessageWithSid" }, "task": true }, { "name": "setLoginMessage", "summary": "set-login-message", "description": "set-login-message", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setLoginMessage" }, "task": true }, { "name": "setLoginMessageWithSid", "summary": "set-login-message", "description": "set-login-message", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setLoginMessageWithSid" }, "task": true }, { "name": "addHost", "summary": "add-host", "description": "Adds simple host", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addHost" }, "task": true }, { "name": "addHostWithSid", "summary": "add-host", "description": "Adds simple host", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addHostWithSid" }, "task": true }, { "name": "showHost", "summary": "show-host", "description": "show-host", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showHost" }, "task": true }, { "name": "showHostWithSid", "summary": "show-host", "description": "show-host", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showHostWithSid" }, "task": true }, { "name": "setHost", "summary": "set-host", "description": "set-host", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setHost" }, "task": true }, { "name": "setHostWithSid", "summary": "set-host", "description": "set-host", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setHostWithSid" }, "task": true }, { "name": "deleteHost", "summary": "delete-host", "description": "delete-host", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteHost" }, "task": true }, { "name": "deleteHostWithSid", "summary": "delete-host", "description": "delete-host", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteHostWithSid" }, "task": true }, { "name": "showHosts", "summary": "show-hosts", "description": "show-hosts", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showHosts" }, "task": true }, { "name": "showHostsWithSid", "summary": "show-hosts", "description": "show-hosts", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showHostsWithSid" }, "task": true }, { "name": "addNetwork", "summary": "add-network", "description": "add-network", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addNetwork" }, "task": true }, { "name": "addNetworkWithSid", "summary": "add-network", "description": "add-network", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addNetworkWithSid" }, "task": true }, { "name": "showNetwork", "summary": "show-network", "description": "show-network", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showNetwork" }, "task": true }, { "name": "showNetworkWithSid", "summary": "show-network", "description": "show-network", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showNetworkWithSid" }, "task": true }, { "name": "setNetwork", "summary": "set-network", "description": "set-network", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setNetwork" }, "task": true }, { "name": "setNetworkWithSid", "summary": "set-network", "description": "set-network", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setNetworkWithSid" }, "task": true }, { "name": "deleteNetwork", "summary": "delete-network", "description": "delete-network", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNetwork" }, "task": true }, { "name": "deleteNetworkWithSid", "summary": "delete-network", "description": "delete-network", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNetworkWithSid" }, "task": true }, { "name": "showNetworks", "summary": "show-networks", "description": "show-networks", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showNetworks" }, "task": true }, { "name": "showNetworksWithSid", "summary": "show-networks", "description": "show-networks", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showNetworksWithSid" }, "task": true }, { "name": "addWildcard", "summary": "add-wildcard", "description": "Adds a new Wildcard", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addWildcard" }, "task": true }, { "name": "addWildcardWithSid", "summary": "add-wildcard", "description": "Adds a new Wildcard", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addWildcardWithSid" }, "task": true }, { "name": "showWildcard", "summary": "show-wildcard", "description": "Displays a Wildcard", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showWildcard" }, "task": true }, { "name": "showWildcardWithSid", "summary": "show-wildcard", "description": "Displays a Wildcard", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showWildcardWithSid" }, "task": true }, { "name": "setWildcard", "summary": "set-wildcard", "description": "Edits an existing Wildcard", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setWildcard" }, "task": true }, { "name": "setWildcardWithSid", "summary": "set-wildcard", "description": "Edits an existing Wildcard", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setWildcardWithSid" }, "task": true }, { "name": "deleteWildcard", "summary": "delete-wildcard", "description": "Deletes an existing Wildcard", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteWildcard" }, "task": true }, { "name": "deleteWildcardWithSid", "summary": "delete-wildcard", "description": "Deletes an existing Wildcard", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteWildcardWithSid" }, "task": true }, { "name": "showWildcards", "summary": "show-wildcards", "description": "Displays all Wildcards", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showWildcards" }, "task": true }, { "name": "showWildcardsWithSid", "summary": "show-wildcards", "description": "Displays all Wildcards", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showWildcardsWithSid" }, "task": true }, { "name": "addGroupWithGroup", "summary": "add-group with group", "description": "add-group with group", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addGroupWithGroup" }, "task": true }, { "name": "addGroupWithGroupWithSid", "summary": "add-group with group", "description": "add-group with group", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addGroupWithGroupWithSid" }, "task": true }, { "name": "showGroup", "summary": "show-group", "description": "show-group", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showGroup" }, "task": true }, { "name": "showGroupWithSid", "summary": "show-group", "description": "show-group", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showGroupWithSid" }, "task": true }, { "name": "setGroup", "summary": "set-group", "description": "set-group", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setGroup" }, "task": true }, { "name": "setGroupWithSid", "summary": "set-group", "description": "set-group", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setGroupWithSid" }, "task": true }, { "name": "deleteGroup", "summary": "delete-group", "description": "delete-group", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteGroup" }, "task": true }, { "name": "deleteGroupWithSid", "summary": "delete-group", "description": "delete-group", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteGroupWithSid" }, "task": true }, { "name": "showGroups", "summary": "show-groups", "description": "show-groups", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showGroups" }, "task": true }, { "name": "showGroupsWithSid", "summary": "show-groups", "description": "show-groups", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showGroupsWithSid" }, "task": true }, { "name": "addAddressRange", "summary": "add-address-range", "description": "add-address-range", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addAddressRange" }, "task": true }, { "name": "addAddressRangeWithSid", "summary": "add-address-range", "description": "add-address-range", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addAddressRangeWithSid" }, "task": true }, { "name": "showAddressRange", "summary": "show-address-range", "description": "show-address-range", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showAddressRange" }, "task": true }, { "name": "showAddressRangeWithSid", "summary": "show-address-range", "description": "show-address-range", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showAddressRangeWithSid" }, "task": true }, { "name": "setAddressRange", "summary": "set-address-range", "description": "set-address-range", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setAddressRange" }, "task": true }, { "name": "setAddressRangeWithSid", "summary": "set-address-range", "description": "set-address-range", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setAddressRangeWithSid" }, "task": true }, { "name": "deleteAddressRange", "summary": "delete-address-range", "description": "delete-address-range", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteAddressRange" }, "task": true }, { "name": "deleteAddressRangeWithSid", "summary": "delete-address-range", "description": "delete-address-range", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteAddressRangeWithSid" }, "task": true }, { "name": "showAddressRanges", "summary": "show-address-ranges", "description": "show-address-ranges", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showAddressRanges" }, "task": true }, { "name": "showAddressRangesWithSid", "summary": "show-address-ranges", "description": "show-address-ranges", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showAddressRangesWithSid" }, "task": true }, { "name": "addMulticastAddressRangeIpRange", "summary": "add-multicast-address-range-ip-range", "description": "Adds a new Multicast Address Range using a range of IP Addresses", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addMulticastAddressRangeIpRange" }, "task": true }, { "name": "addMulticastAddressRangeIpRangeWithSid", "summary": "add-multicast-address-range-ip-range", "description": "Adds a new Multicast Address Range using a range of IP Addresses", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addMulticastAddressRangeIpRangeWithSid" }, "task": true }, { "name": "showMulticastAddressRange", "summary": "show-multicast-address-range", "description": "Displays a Multicast Address Range", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showMulticastAddressRange" }, "task": true }, { "name": "showMulticastAddressRangeWithSid", "summary": "show-multicast-address-range", "description": "Displays a Multicast Address Range", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showMulticastAddressRangeWithSid" }, "task": true }, { "name": "setMulticastAddressRange", "summary": "set-multicast-address-range", "description": "Edits an existing Multicast Address Range", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setMulticastAddressRange" }, "task": true }, { "name": "setMulticastAddressRangeWithSid", "summary": "set-multicast-address-range", "description": "Edits an existing Multicast Address Range", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setMulticastAddressRangeWithSid" }, "task": true }, { "name": "deleteMulticastAddressRange", "summary": "delete-multicast-address-range", "description": "Deletes a Multicast Address Range", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteMulticastAddressRange" }, "task": true }, { "name": "deleteMulticastAddressRangeWithSid", "summary": "delete-multicast-address-range", "description": "Deletes a Multicast Address Range", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteMulticastAddressRangeWithSid" }, "task": true }, { "name": "showMulticastAddressRanges", "summary": "show-multicast-address-ranges", "description": "Displays all Multicast Address Ranges", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showMulticastAddressRanges" }, "task": true }, { "name": "showMulticastAddressRangesWithSid", "summary": "show-multicast-address-ranges", "description": "Displays all Multicast Address Ranges", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showMulticastAddressRangesWithSid" }, "task": true }, { "name": "addGroupWithExclusion", "summary": "add-group-with-exclusion", "description": "add-group-with-exclusion", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addGroupWithExclusion" }, "task": true }, { "name": "addGroupWithExclusionWithSid", "summary": "add-group-with-exclusion", "description": "add-group-with-exclusion", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addGroupWithExclusionWithSid" }, "task": true }, { "name": "showGroupWithExclusion", "summary": "show-group-with-exclusion", "description": "show-group-with-exclusion", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showGroupWithExclusion" }, "task": true }, { "name": "showGroupWithExclusionWithSid", "summary": "show-group-with-exclusion", "description": "show-group-with-exclusion", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showGroupWithExclusionWithSid" }, "task": true }, { "name": "setGroupWithExclusion", "summary": "set-group-with-exclusion", "description": "set-group-with-exclusion", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setGroupWithExclusion" }, "task": true }, { "name": "setGroupWithExclusionWithSid", "summary": "set-group-with-exclusion", "description": "set-group-with-exclusion", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setGroupWithExclusionWithSid" }, "task": true }, { "name": "deleteGroupWithExclusion", "summary": "delete-group-with-exclusion", "description": "delete-group-with-exclusion", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteGroupWithExclusion" }, "task": true }, { "name": "deleteGroupWithExclusionWithSid", "summary": "delete-group-with-exclusion", "description": "delete-group-with-exclusion", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteGroupWithExclusionWithSid" }, "task": true }, { "name": "showGroupsWithExclusion", "summary": "show-groups-with-exclusion", "description": "show-groups-with-exclusion", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showGroupsWithExclusion" }, "task": true }, { "name": "showGroupsWithExclusionWithSid", "summary": "show-groups-with-exclusion", "description": "show-groups-with-exclusion", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showGroupsWithExclusionWithSid" }, "task": true }, { "name": "addSimpleGateway", "summary": "add-simple-gateway", "description": "add-simple-gateway", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addSimpleGateway" }, "task": true }, { "name": "addSimpleGatewayWithSid", "summary": "add-simple-gateway", "description": "add-simple-gateway", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addSimpleGatewayWithSid" }, "task": true }, { "name": "showSimpleGateway", "summary": "show-simple-gateway", "description": "show-simple-gateway", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showSimpleGateway" }, "task": true }, { "name": "showSimpleGatewayWithSid", "summary": "show-simple-gateway", "description": "show-simple-gateway", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showSimpleGatewayWithSid" }, "task": true }, { "name": "setSimpleGateway", "summary": "set-simple-gateway", "description": "set-simple-gateway", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setSimpleGateway" }, "task": true }, { "name": "setSimpleGatewayWithSid", "summary": "set-simple-gateway", "description": "set-simple-gateway", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setSimpleGatewayWithSid" }, "task": true }, { "name": "deleteSimpleGateway", "summary": "delete-simple-gateway", "description": "Delete simple gateway", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSimpleGateway" }, "task": true }, { "name": "deleteSimpleGatewayWithSid", "summary": "delete-simple-gateway", "description": "Delete simple gateway", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSimpleGatewayWithSid" }, "task": true }, { "name": "showSimpleGateways", "summary": "show-simple-gateways", "description": "show-simple-gateways", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showSimpleGateways" }, "task": true }, { "name": "showSimpleGatewaysWithSid", "summary": "show-simple-gateways", "description": "show-simple-gateways", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showSimpleGatewaysWithSid" }, "task": true }, { "name": "addSecurityZone", "summary": "add-security-zone", "description": "add-security-zone", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addSecurityZone" }, "task": true }, { "name": "addSecurityZoneWithSid", "summary": "add-security-zone", "description": "add-security-zone", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addSecurityZoneWithSid" }, "task": true }, { "name": "showSecurityZone", "summary": "show-security-zone", "description": "show-security-zone", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showSecurityZone" }, "task": true }, { "name": "showSecurityZoneWithSid", "summary": "show-security-zone", "description": "show-security-zone", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showSecurityZoneWithSid" }, "task": true }, { "name": "setSecurityZone", "summary": "set-security-zone", "description": "set-security-zone", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setSecurityZone" }, "task": true }, { "name": "setSecurityZoneWithSid", "summary": "set-security-zone", "description": "set-security-zone", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setSecurityZoneWithSid" }, "task": true }, { "name": "deleteSecurityZone", "summary": "delete-security-zone", "description": "delete-security-zone", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSecurityZone" }, "task": true }, { "name": "deleteSecurityZoneWithSid", "summary": "delete-security-zone", "description": "delete-security-zone", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteSecurityZoneWithSid" }, "task": true }, { "name": "showSecurityZones", "summary": "show-security-zones", "description": "Show all the security zones", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showSecurityZones" }, "task": true }, { "name": "showSecurityZonesWithSid", "summary": "show-security-zones", "description": "Show all the security zones", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showSecurityZonesWithSid" }, "task": true }, { "name": "addTime", "summary": "add-time", "description": "add-time", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addTime" }, "task": true }, { "name": "addTimeWithSid", "summary": "add-time", "description": "add-time", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addTimeWithSid" }, "task": true }, { "name": "showTime", "summary": "show-time", "description": "show-time", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showTime" }, "task": true }, { "name": "showTimeWithSid", "summary": "show-time", "description": "show-time", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showTimeWithSid" }, "task": true }, { "name": "setTime", "summary": "set-time", "description": "set-time", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setTime" }, "task": true }, { "name": "setTimeWithSid", "summary": "set-time", "description": "set-time", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setTimeWithSid" }, "task": true }, { "name": "deleteTime", "summary": "delete-time", "description": "delete-time", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTime" }, "task": true }, { "name": "deleteTimeWithSid", "summary": "delete-time", "description": "delete-time", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTimeWithSid" }, "task": true }, { "name": "showTimes", "summary": "show-times", "description": "show-times", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showTimes" }, "task": true }, { "name": "showTimesWithSid", "summary": "show-times", "description": "show-times", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showTimesWithSid" }, "task": true }, { "name": "addTimeGroup", "summary": "add-time-group", "description": "add-time-group", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addTimeGroup" }, "task": true }, { "name": "addTimeGroupWithSid", "summary": "add-time-group", "description": "add-time-group", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addTimeGroupWithSid" }, "task": true }, { "name": "showTimeGroup", "summary": "show-time-group", "description": "show-time-group", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showTimeGroup" }, "task": true }, { "name": "showTimeGroupWithSid", "summary": "show-time-group", "description": "show-time-group", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showTimeGroupWithSid" }, "task": true }, { "name": "setTimeGroup", "summary": "set-time-group", "description": "set-time-group", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setTimeGroup" }, "task": true }, { "name": "setTimeGroupWithSid", "summary": "set-time-group", "description": "set-time-group", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setTimeGroupWithSid" }, "task": true }, { "name": "deleteTimeGroup", "summary": "delete-time-group", "description": "delete-time-group", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTimeGroup" }, "task": true }, { "name": "deleteTimeGroupWithSid", "summary": "delete-time-group", "description": "delete-time-group", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTimeGroupWithSid" }, "task": true }, { "name": "showTimeGroups", "summary": "show-time-groups", "description": "show-time-groups", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showTimeGroups" }, "task": true }, { "name": "showTimeGroupsWithSid", "summary": "show-time-groups", "description": "show-time-groups", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showTimeGroupsWithSid" }, "task": true }, { "name": "addAccessRole", "summary": "add-access-role", "description": "add-access-role", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addAccessRole" }, "task": true }, { "name": "addAccessRoleWithSid", "summary": "add-access-role", "description": "add-access-role", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addAccessRoleWithSid" }, "task": true }, { "name": "showAccessRole", "summary": "show-access-role", "description": "show-access-role", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showAccessRole" }, "task": true }, { "name": "showAccessRoleWithSid", "summary": "show-access-role", "description": "show-access-role", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showAccessRoleWithSid" }, "task": true }, { "name": "setAccessRole", "summary": "set-access-role", "description": "set-access-role", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setAccessRole" }, "task": true }, { "name": "setAccessRoleWithSid", "summary": "set-access-role", "description": "set-access-role", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setAccessRoleWithSid" }, "task": true }, { "name": "deleteAccessRole", "summary": "delete-access-role", "description": "delete-access-role", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteAccessRole" }, "task": true }, { "name": "deleteAccessRoleWithSid", "summary": "delete-access-role", "description": "delete-access-role", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteAccessRoleWithSid" }, "task": true }, { "name": "showAccessRoles", "summary": "show-access-roles", "description": "Show all the access roles", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showAccessRoles" }, "task": true }, { "name": "showAccessRolesWithSid", "summary": "show-access-roles", "description": "Show all the access roles", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showAccessRolesWithSid" }, "task": true }, { "name": "addDynamicObject", "summary": "add-dynamic-object", "description": "Adds new dynamic object", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addDynamicObject" }, "task": true }, { "name": "addDynamicObjectWithSid", "summary": "add-dynamic-object", "description": "Adds new dynamic object", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addDynamicObjectWithSid" }, "task": true }, { "name": "showDynamicObject", "summary": "show-dynamic-object", "description": "Retieves existing dynamic object", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDynamicObject" }, "task": true }, { "name": "showDynamicObjectWithSid", "summary": "show-dynamic-object", "description": "Retieves existing dynamic object", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDynamicObjectWithSid" }, "task": true }, { "name": "setDynamicObject", "summary": "set-dynamic-object", "description": "Edit existing dynamic object", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setDynamicObject" }, "task": true }, { "name": "setDynamicObjectWithSid", "summary": "set-dynamic-object", "description": "Edit existing dynamic object", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setDynamicObjectWithSid" }, "task": true }, { "name": "deleteDynamicObject", "summary": "delete-dynamic-object", "description": "Delete existing dynamic object", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteDynamicObject" }, "task": true }, { "name": "deleteDynamicObjectWithSid", "summary": "delete-dynamic-object", "description": "Delete existing dynamic object", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteDynamicObjectWithSid" }, "task": true }, { "name": "showDynamicObjects", "summary": "show-dynamic-objects", "description": "Show all the dynamic objects", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDynamicObjects" }, "task": true }, { "name": "showDynamicObjectsWithSid", "summary": "show-dynamic-objects", "description": "Show all the dynamic objects", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDynamicObjectsWithSid" }, "task": true }, { "name": "addTrustedClient", "summary": "add-trusted-client", "description": "add-trusted-client", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addTrustedClient" }, "task": true }, { "name": "addTrustedClientWithSid", "summary": "add-trusted-client", "description": "add-trusted-client", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addTrustedClientWithSid" }, "task": true }, { "name": "showTrustedClient", "summary": "show-trusted-client", "description": "show-trusted-client", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showTrustedClient" }, "task": true }, { "name": "showTrustedClientWithSid", "summary": "show-trusted-client", "description": "show-trusted-client", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showTrustedClientWithSid" }, "task": true }, { "name": "setTrustedClient", "summary": "set-trusted-client", "description": "set-trusted-client", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setTrustedClient" }, "task": true }, { "name": "setTrustedClientWithSid", "summary": "set-trusted-client", "description": "set-trusted-client", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setTrustedClientWithSid" }, "task": true }, { "name": "deleteTrustedClient", "summary": "delete-trusted-client", "description": "delete-trusted-client", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTrustedClient" }, "task": true }, { "name": "deleteTrustedClientWithSid", "summary": "delete-trusted-client", "description": "delete-trusted-client", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTrustedClientWithSid" }, "task": true }, { "name": "showTrustedClients", "summary": "show-trusted-clients", "description": "show-trusted-clients", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showTrustedClients" }, "task": true }, { "name": "showTrustedClientsWithSid", "summary": "show-trusted-clients", "description": "show-trusted-clients", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showTrustedClientsWithSid" }, "task": true }, { "name": "addTag", "summary": "add-tag", "description": "Add tag", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addTag" }, "task": true }, { "name": "addTagWithSid", "summary": "add-tag", "description": "Add tag", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addTagWithSid" }, "task": true }, { "name": "showTag", "summary": "show-tag", "description": "Show tag", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showTag" }, "task": true }, { "name": "showTagWithSid", "summary": "show-tag", "description": "Show tag", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showTagWithSid" }, "task": true }, { "name": "setTag", "summary": "set-tag", "description": "Set tag", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setTag" }, "task": true }, { "name": "setTagWithSid", "summary": "set-tag", "description": "Set tag", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setTagWithSid" }, "task": true }, { "name": "deleteTag", "summary": "delete-tag", "description": "Delete tag", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTag" }, "task": true }, { "name": "deleteTagWithSid", "summary": "delete-tag", "description": "Delete tag", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteTagWithSid" }, "task": true }, { "name": "showTags", "summary": "show-tags", "description": "Show all the tags", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showTags" }, "task": true }, { "name": "showTagsWithSid", "summary": "show-tags", "description": "Show all the tags", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showTagsWithSid" }, "task": true }, { "name": "addDnsDomain", "summary": "add-dns-domain", "description": "add-dns-domain", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addDnsDomain" }, "task": true }, { "name": "addDnsDomainWithSid", "summary": "add-dns-domain", "description": "add-dns-domain", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addDnsDomainWithSid" }, "task": true }, { "name": "showDnsDomain", "summary": "show-dns-domain", "description": "show-dns-domain", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDnsDomain" }, "task": true }, { "name": "showDnsDomainWithSid", "summary": "show-dns-domain", "description": "show-dns-domain", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDnsDomainWithSid" }, "task": true }, { "name": "setDnsDomain", "summary": "set-dns-domain", "description": "set-dns-domain", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setDnsDomain" }, "task": true }, { "name": "setDnsDomainWithSid", "summary": "set-dns-domain", "description": "set-dns-domain", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setDnsDomainWithSid" }, "task": true }, { "name": "deleteDnsDomain", "summary": "delete-dns-domain", "description": "delete-dns-domain", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteDnsDomain" }, "task": true }, { "name": "deleteDnsDomainWithSid", "summary": "delete-dns-domain", "description": "delete-dns-domain", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteDnsDomainWithSid" }, "task": true }, { "name": "showDnsDomains", "summary": "show-dns-domains", "description": "show-dns-domains", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDnsDomains" }, "task": true }, { "name": "showDnsDomainsWithSid", "summary": "show-dns-domains", "description": "show-dns-domains", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDnsDomainsWithSid" }, "task": true }, { "name": "addOpsecApplication", "summary": "add-opsec-application", "description": "Adds an OPSEC Application", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addOpsecApplication" }, "task": true }, { "name": "addOpsecApplicationWithSid", "summary": "add-opsec-application", "description": "Adds an OPSEC Application", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addOpsecApplicationWithSid" }, "task": true }, { "name": "showOpsecApplication", "summary": "show-opsec-application", "description": "Displays an OPSEC Application", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showOpsecApplication" }, "task": true }, { "name": "showOpsecApplicationWithSid", "summary": "show-opsec-application", "description": "Displays an OPSEC Application", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showOpsecApplicationWithSid" }, "task": true }, { "name": "setOpsecApplication", "summary": "set-opsec-application", "description": "Edits an OPSEC Application", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setOpsecApplication" }, "task": true }, { "name": "setOpsecApplicationWithSid", "summary": "set-opsec-application", "description": "Edits an OPSEC Application", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setOpsecApplicationWithSid" }, "task": true }, { "name": "deleteOpsecApplication", "summary": "delete-opsec-application", "description": "Deletes an OPSEC Application", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteOpsecApplication" }, "task": true }, { "name": "deleteOpsecApplicationWithSid", "summary": "delete-opsec-application", "description": "Deletes an OPSEC Application", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteOpsecApplicationWithSid" }, "task": true }, { "name": "showOpsecApplications", "summary": "show-opsec-applications", "description": "Displays all OPSEC Applications", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showOpsecApplications" }, "task": true }, { "name": "showOpsecApplicationsWithSid", "summary": "show-opsec-applications", "description": "Displays all OPSEC Applications", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showOpsecApplicationsWithSid" }, "task": true }, { "name": "showDataCenterContent", "summary": "show-data-center-content", "description": "show-data-center-content", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDataCenterContent" }, "task": true }, { "name": "showDataCenterContentWithSid", "summary": "show-data-center-content", "description": "show-data-center-content", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDataCenterContentWithSid" }, "task": true }, { "name": "showDataCenter", "summary": "show-data-center", "description": "show-data-center", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDataCenter" }, "task": true }, { "name": "showDataCenterWithSid", "summary": "show-data-center", "description": "show-data-center", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDataCenterWithSid" }, "task": true }, { "name": "showDataCenters", "summary": "show-data-centers", "description": "show-data-centers", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDataCenters" }, "task": true }, { "name": "showDataCentersWithSid", "summary": "show-data-centers", "description": "show-data-centers", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDataCentersWithSid" }, "task": true }, { "name": "addDataCenterObjectWithGroup", "summary": "add-data-center-object with group", "description": "add-data-center-object with group", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addDataCenterObjectWithGroup" }, "task": true }, { "name": "addDataCenterObjectWithGroupWithSid", "summary": "add-data-center-object with group", "description": "add-data-center-object with group", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addDataCenterObjectWithGroupWithSid" }, "task": true }, { "name": "showDataCenterObject", "summary": "show-data-center-object", "description": "show-data-center-object", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDataCenterObject" }, "task": true }, { "name": "showDataCenterObjectWithSid", "summary": "show-data-center-object", "description": "show-data-center-object", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDataCenterObjectWithSid" }, "task": true }, { "name": "deleteDataCenterObject", "summary": "delete-data-center-object", "description": "delete-data-center-object", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteDataCenterObject" }, "task": true }, { "name": "deleteDataCenterObjectWithSid", "summary": "delete-data-center-object", "description": "delete-data-center-object", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteDataCenterObjectWithSid" }, "task": true }, { "name": "showDataCenterObjects", "summary": "show-data-center-objects", "description": "show-data-center-objects", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDataCenterObjects" }, "task": true }, { "name": "showDataCenterObjectsWithSid", "summary": "show-data-center-objects", "description": "show-data-center-objects", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDataCenterObjectsWithSid" }, "task": true }, { "name": "showUpdatableObjectsRepositoryContent", "summary": "show-updatable-objects-repository-content", "description": "Show the content of the Updatable Objects Repository", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showUpdatableObjectsRepositoryContent" }, "task": true }, { "name": "showUpdatableObjectsRepositoryContentWithSid", "summary": "show-updatable-objects-repository-content", "description": "Show the content of the Updatable Objects Repository", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showUpdatableObjectsRepositoryContentWithSid" }, "task": true }, { "name": "updateUpdatableObjectsRepositoryContent", "summary": "update-updatable-objects-repository-content", "description": "Update the objects in the Updatable Objects repository. Use the show-task command to check the progress of the task.", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateUpdatableObjectsRepositoryContent" }, "task": true }, { "name": "updateUpdatableObjectsRepositoryContentWithSid", "summary": "update-updatable-objects-repository-content", "description": "Update the objects in the Updatable Objects repository. Use the show-task command to check the progress of the task.", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateUpdatableObjectsRepositoryContentWithSid" }, "task": true }, { "name": "addUpdatableObject", "summary": "add-updatable-object", "description": "Add updatable object using URI", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addUpdatableObject" }, "task": true }, { "name": "addUpdatableObjectWithSid", "summary": "add-updatable-object", "description": "Add updatable object using URI", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addUpdatableObjectWithSid" }, "task": true }, { "name": "showUpdatableObject", "summary": "show-updatable-object", "description": "Show updatable object using it's name", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showUpdatableObject" }, "task": true }, { "name": "showUpdatableObjectWithSid", "summary": "show-updatable-object", "description": "Show updatable object using it's name", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showUpdatableObjectWithSid" }, "task": true }, { "name": "deleteUpdatableObject", "summary": "delete-updatable-object", "description": "Delete an updatable object", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteUpdatableObject" }, "task": true }, { "name": "deleteUpdatableObjectWithSid", "summary": "delete-updatable-object", "description": "Delete an updatable object", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteUpdatableObjectWithSid" }, "task": true }, { "name": "showUpdatableObjects", "summary": "show-updatable-objects", "description": "Shows all the imported updatable objects", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showUpdatableObjects" }, "task": true }, { "name": "showUpdatableObjectsWithSid", "summary": "show-updatable-objects", "description": "Shows all the imported updatable objects", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showUpdatableObjectsWithSid" }, "task": true }, { "name": "addServiceTcp", "summary": "add-service-tcp", "description": "add-service-tcp", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addServiceTcp" }, "task": true }, { "name": "addServiceTcpWithSid", "summary": "add-service-tcp", "description": "add-service-tcp", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addServiceTcpWithSid" }, "task": true }, { "name": "showServiceTcp", "summary": "show-service-tcp", "description": "show-service-tcp", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServiceTcp" }, "task": true }, { "name": "showServiceTcpWithSid", "summary": "show-service-tcp", "description": "show-service-tcp", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServiceTcpWithSid" }, "task": true }, { "name": "setServiceTcp", "summary": "set-service-tcp", "description": "set-service-tcp", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setServiceTcp" }, "task": true }, { "name": "setServiceTcpWithSid", "summary": "set-service-tcp", "description": "set-service-tcp", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setServiceTcpWithSid" }, "task": true }, { "name": "deleteServiceTcp", "summary": "delete-service-tcp", "description": "delete-service-tcp", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteServiceTcp" }, "task": true }, { "name": "deleteServiceTcpWithSid", "summary": "delete-service-tcp", "description": "delete-service-tcp", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteServiceTcpWithSid" }, "task": true }, { "name": "showServicesTcp", "summary": "show-services-tcp", "description": "show-services-tcp", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServicesTcp" }, "task": true }, { "name": "showServicesTcpWithSid", "summary": "show-services-tcp", "description": "show-services-tcp", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServicesTcpWithSid" }, "task": true }, { "name": "addServiceUdp", "summary": "add-service-udp", "description": "add-service-udp", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addServiceUdp" }, "task": true }, { "name": "addServiceUdpWithSid", "summary": "add-service-udp", "description": "add-service-udp", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addServiceUdpWithSid" }, "task": true }, { "name": "showServiceUdp", "summary": "show-service-udp", "description": "show-service-udp", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServiceUdp" }, "task": true }, { "name": "showServiceUdpWithSid", "summary": "show-service-udp", "description": "show-service-udp", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServiceUdpWithSid" }, "task": true }, { "name": "setServiceUdp", "summary": "set-service-udp", "description": "set-service-udp", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setServiceUdp" }, "task": true }, { "name": "setServiceUdpWithSid", "summary": "set-service-udp", "description": "set-service-udp", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setServiceUdpWithSid" }, "task": true }, { "name": "deleteServiceUdp", "summary": "delete-service-udp", "description": "delete-service-udp", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteServiceUdp" }, "task": true }, { "name": "deleteServiceUdpWithSid", "summary": "delete-service-udp", "description": "delete-service-udp", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteServiceUdpWithSid" }, "task": true }, { "name": "showServicesUdp", "summary": "show-services-udp", "description": "show-services-udp", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServicesUdp" }, "task": true }, { "name": "showServicesUdpWithSid", "summary": "show-services-udp", "description": "show-services-udp", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServicesUdpWithSid" }, "task": true }, { "name": "addServiceIcmp", "summary": "add-service-icmp", "description": "add-service-icmp", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addServiceIcmp" }, "task": true }, { "name": "addServiceIcmpWithSid", "summary": "add-service-icmp", "description": "add-service-icmp", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addServiceIcmpWithSid" }, "task": true }, { "name": "showServiceIcmp", "summary": "show-service-icmp", "description": "show-service-icmp", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServiceIcmp" }, "task": true }, { "name": "showServiceIcmpWithSid", "summary": "show-service-icmp", "description": "show-service-icmp", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServiceIcmpWithSid" }, "task": true }, { "name": "setServiceIcmp", "summary": "set-service-icmp", "description": "set-service-icmp", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setServiceIcmp" }, "task": true }, { "name": "setServiceIcmpWithSid", "summary": "set-service-icmp", "description": "set-service-icmp", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setServiceIcmpWithSid" }, "task": true }, { "name": "deleteServiceIcmp", "summary": "delete-service-icmp", "description": "delete-service-icmp", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteServiceIcmp" }, "task": true }, { "name": "deleteServiceIcmpWithSid", "summary": "delete-service-icmp", "description": "delete-service-icmp", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteServiceIcmpWithSid" }, "task": true }, { "name": "showServicesIcmp", "summary": "show-services-icmp", "description": "show-services-icmp", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServicesIcmp" }, "task": true }, { "name": "showServicesIcmpWithSid", "summary": "show-services-icmp", "description": "show-services-icmp", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServicesIcmpWithSid" }, "task": true }, { "name": "addServiceIcmp6", "summary": "add-service-icmp6", "description": "add-service-icmp6", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addServiceIcmp6" }, "task": true }, { "name": "addServiceIcmp6WithSid", "summary": "add-service-icmp6", "description": "add-service-icmp6", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addServiceIcmp6WithSid" }, "task": true }, { "name": "showServiceIcmp6", "summary": "show-service-icmp6", "description": "show-service-icmp6", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServiceIcmp6" }, "task": true }, { "name": "showServiceIcmp6WithSid", "summary": "show-service-icmp6", "description": "show-service-icmp6", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServiceIcmp6WithSid" }, "task": true }, { "name": "setServiceIcmp6", "summary": "set-service-icmp6", "description": "set-service-icmp6", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setServiceIcmp6" }, "task": true }, { "name": "setServiceIcmp6WithSid", "summary": "set-service-icmp6", "description": "set-service-icmp6", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setServiceIcmp6WithSid" }, "task": true }, { "name": "deleteServiceIcmp6", "summary": "delete-service-icmp6", "description": "delete-service-icmp6", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteServiceIcmp6" }, "task": true }, { "name": "deleteServiceIcmp6WithSid", "summary": "delete-service-icmp6", "description": "delete-service-icmp6", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteServiceIcmp6WithSid" }, "task": true }, { "name": "showServicesIcmp6", "summary": "show-services-icmp6", "description": "show-services-icmp6", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServicesIcmp6" }, "task": true }, { "name": "showServicesIcmp6WithSid", "summary": "show-services-icmp6", "description": "show-services-icmp6", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServicesIcmp6WithSid" }, "task": true }, { "name": "addServiceSctp", "summary": "add-service-sctp", "description": "add-service-sctp", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addServiceSctp" }, "task": true }, { "name": "addServiceSctpWithSid", "summary": "add-service-sctp", "description": "add-service-sctp", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addServiceSctpWithSid" }, "task": true }, { "name": "showServiceSctp", "summary": "show-service-sctp", "description": "show-service-sctp", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServiceSctp" }, "task": true }, { "name": "showServiceSctpWithSid", "summary": "show-service-sctp", "description": "show-service-sctp", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServiceSctpWithSid" }, "task": true }, { "name": "setServiceSctp", "summary": "set-service-sctp", "description": "set-service-sctp", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setServiceSctp" }, "task": true }, { "name": "setServiceSctpWithSid", "summary": "set-service-sctp", "description": "set-service-sctp", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setServiceSctpWithSid" }, "task": true }, { "name": "deleteServiceSctp", "summary": "delete-service-sctp", "description": "delete-service-sctp", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteServiceSctp" }, "task": true }, { "name": "deleteServiceSctpWithSid", "summary": "delete-service-sctp", "description": "delete-service-sctp", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteServiceSctpWithSid" }, "task": true }, { "name": "showServicesSctp", "summary": "show-services-sctp", "description": "show-services-sctp", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServicesSctp" }, "task": true }, { "name": "showServicesSctpWithSid", "summary": "show-services-sctp", "description": "show-services-sctp", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServicesSctpWithSid" }, "task": true }, { "name": "addServiceOther", "summary": "add-service-other", "description": "add-service-other", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addServiceOther" }, "task": true }, { "name": "addServiceOtherWithSid", "summary": "add-service-other", "description": "add-service-other", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addServiceOtherWithSid" }, "task": true }, { "name": "showServiceOther", "summary": "show-service-other", "description": "show-service-other", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServiceOther" }, "task": true }, { "name": "showServiceOtherWithSid", "summary": "show-service-other", "description": "show-service-other", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServiceOtherWithSid" }, "task": true }, { "name": "setServiceOther", "summary": "set-service-other", "description": "set-service-other", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setServiceOther" }, "task": true }, { "name": "setServiceOtherWithSid", "summary": "set-service-other", "description": "set-service-other", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setServiceOtherWithSid" }, "task": true }, { "name": "deleteServiceOther", "summary": "delete-service-other", "description": "delete-service-other", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteServiceOther" }, "task": true }, { "name": "deleteServiceOtherWithSid", "summary": "delete-service-other", "description": "delete-service-other", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteServiceOtherWithSid" }, "task": true }, { "name": "showServicesOther", "summary": "show-services-other", "description": "show-services-other", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServicesOther" }, "task": true }, { "name": "showServicesOtherWithSid", "summary": "show-services-other", "description": "show-services-other", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServicesOtherWithSid" }, "task": true }, { "name": "addServiceGroup", "summary": "add-service-group", "description": "add-service-group", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addServiceGroup" }, "task": true }, { "name": "addServiceGroupWithSid", "summary": "add-service-group", "description": "add-service-group", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addServiceGroupWithSid" }, "task": true }, { "name": "showServiceGroup", "summary": "show-service-group", "description": "show-service-group", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServiceGroup" }, "task": true }, { "name": "showServiceGroupWithSid", "summary": "show-service-group", "description": "show-service-group", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServiceGroupWithSid" }, "task": true }, { "name": "setServiceGroup", "summary": "set-service-group", "description": "set-service-group", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setServiceGroup" }, "task": true }, { "name": "setServiceGroupWithSid", "summary": "set-service-group", "description": "set-service-group", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setServiceGroupWithSid" }, "task": true }, { "name": "deleteServiceGroup", "summary": "delete-service-group", "description": "delete-service-group", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteServiceGroup" }, "task": true }, { "name": "deleteServiceGroupWithSid", "summary": "delete-service-group", "description": "delete-service-group", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteServiceGroupWithSid" }, "task": true }, { "name": "showServiceGroups", "summary": "show-service-groups", "description": "show-service-groups", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServiceGroups" }, "task": true }, { "name": "showServiceGroupsWithSid", "summary": "show-service-groups", "description": "show-service-groups", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServiceGroupsWithSid" }, "task": true }, { "name": "addApplicationSite", "summary": "add-application-site", "description": "add-application-site", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addApplicationSite" }, "task": true }, { "name": "addApplicationSiteWithSid", "summary": "add-application-site", "description": "add-application-site", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addApplicationSiteWithSid" }, "task": true }, { "name": "showApplicationSite", "summary": "show-application-site", "description": "show-application-site", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showApplicationSite" }, "task": true }, { "name": "showApplicationSiteWithSid", "summary": "show-application-site", "description": "show-application-site", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showApplicationSiteWithSid" }, "task": true }, { "name": "setApplicationSite", "summary": "set-application-site", "description": "set-application-site", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setApplicationSite" }, "task": true }, { "name": "setApplicationSiteWithSid", "summary": "set-application-site", "description": "set-application-site", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setApplicationSiteWithSid" }, "task": true }, { "name": "deleteApplicationSite", "summary": "delete-application-site", "description": "delete-application-site", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteApplicationSite" }, "task": true }, { "name": "deleteApplicationSiteWithSid", "summary": "delete-application-site", "description": "delete-application-site", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteApplicationSiteWithSid" }, "task": true }, { "name": "showApplicationSites", "summary": "show-application-sites", "description": "show-application-sites", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showApplicationSites" }, "task": true }, { "name": "showApplicationSitesWithSid", "summary": "show-application-sites", "description": "show-application-sites", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showApplicationSitesWithSid" }, "task": true }, { "name": "addApplicationSiteCategory", "summary": "add-application-site-category", "description": "add-application-site-category", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addApplicationSiteCategory" }, "task": true }, { "name": "addApplicationSiteCategoryWithSid", "summary": "add-application-site-category", "description": "add-application-site-category", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addApplicationSiteCategoryWithSid" }, "task": true }, { "name": "showApplicationSiteCategory", "summary": "show-application-site-category", "description": "show-application-site-category", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showApplicationSiteCategory" }, "task": true }, { "name": "showApplicationSiteCategoryWithSid", "summary": "show-application-site-category", "description": "show-application-site-category", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showApplicationSiteCategoryWithSid" }, "task": true }, { "name": "setApplicationSiteCategory", "summary": "set-application-site-category", "description": "set-application-site-category", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setApplicationSiteCategory" }, "task": true }, { "name": "setApplicationSiteCategoryWithSid", "summary": "set-application-site-category", "description": "set-application-site-category", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setApplicationSiteCategoryWithSid" }, "task": true }, { "name": "deleteApplicationSiteCategory", "summary": "delete-application-site-category", "description": "delete-application-site-category", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteApplicationSiteCategory" }, "task": true }, { "name": "deleteApplicationSiteCategoryWithSid", "summary": "delete-application-site-category", "description": "delete-application-site-category", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteApplicationSiteCategoryWithSid" }, "task": true }, { "name": "showApplicationSiteCategories", "summary": "show-application-site-categories", "description": "show-application-site-categories", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showApplicationSiteCategories" }, "task": true }, { "name": "showApplicationSiteCategoriesWithSid", "summary": "show-application-site-categories", "description": "show-application-site-categories", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showApplicationSiteCategoriesWithSid" }, "task": true }, { "name": "addApplicationSiteGroup", "summary": "add-application-site-group", "description": "add-application-site-group", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addApplicationSiteGroup" }, "task": true }, { "name": "addApplicationSiteGroupWithSid", "summary": "add-application-site-group", "description": "add-application-site-group", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addApplicationSiteGroupWithSid" }, "task": true }, { "name": "showApplicationSiteGroup", "summary": "show-application-site-group", "description": "show-application-site-group", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showApplicationSiteGroup" }, "task": true }, { "name": "showApplicationSiteGroupWithSid", "summary": "show-application-site-group", "description": "show-application-site-group", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showApplicationSiteGroupWithSid" }, "task": true }, { "name": "setApplicationSiteGroup", "summary": "set-application-site-group", "description": "set-application-site-group", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setApplicationSiteGroup" }, "task": true }, { "name": "setApplicationSiteGroupWithSid", "summary": "set-application-site-group", "description": "set-application-site-group", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setApplicationSiteGroupWithSid" }, "task": true }, { "name": "deleteApplicationSiteGroup", "summary": "delete-application-site-group", "description": "delete-application-site-group", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteApplicationSiteGroup" }, "task": true }, { "name": "deleteApplicationSiteGroupWithSid", "summary": "delete-application-site-group", "description": "delete-application-site-group", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteApplicationSiteGroupWithSid" }, "task": true }, { "name": "showApplicationSiteGroups", "summary": "show-application-site-groups", "description": "show-application-site-groups", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showApplicationSiteGroups" }, "task": true }, { "name": "showApplicationSiteGroupsWithSid", "summary": "show-application-site-groups", "description": "show-application-site-groups", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showApplicationSiteGroupsWithSid" }, "task": true }, { "name": "addServiceDceRpc", "summary": "add-service-dce-rpc", "description": "add-service-dce-rpc", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addServiceDceRpc" }, "task": true }, { "name": "addServiceDceRpcWithSid", "summary": "add-service-dce-rpc", "description": "add-service-dce-rpc", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addServiceDceRpcWithSid" }, "task": true }, { "name": "showServiceDceRpc", "summary": "show-service-dce-rpc", "description": "show-service-dce-rpc", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServiceDceRpc" }, "task": true }, { "name": "showServiceDceRpcWithSid", "summary": "show-service-dce-rpc", "description": "show-service-dce-rpc", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServiceDceRpcWithSid" }, "task": true }, { "name": "setServiceDceRpc", "summary": "set-service-dce-rpc", "description": "set-service-dce-rpc", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setServiceDceRpc" }, "task": true }, { "name": "setServiceDceRpcWithSid", "summary": "set-service-dce-rpc", "description": "set-service-dce-rpc", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setServiceDceRpcWithSid" }, "task": true }, { "name": "deleteServiceDceRpc", "summary": "delete-service-dce-rpc", "description": "delete-service-dce-rpc", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteServiceDceRpc" }, "task": true }, { "name": "deleteServiceDceRpcWithSid", "summary": "delete-service-dce-rpc", "description": "delete-service-dce-rpc", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteServiceDceRpcWithSid" }, "task": true }, { "name": "showServicesDceRpc", "summary": "show-services-dce-rpc", "description": "show-services-dce-rpc", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServicesDceRpc" }, "task": true }, { "name": "showServicesDceRpcWithSid", "summary": "show-services-dce-rpc", "description": "show-services-dce-rpc", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServicesDceRpcWithSid" }, "task": true }, { "name": "addServiceRpc", "summary": "add-service-rpc", "description": "add-service-rpc", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addServiceRpc" }, "task": true }, { "name": "addServiceRpcWithSid", "summary": "add-service-rpc", "description": "add-service-rpc", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addServiceRpcWithSid" }, "task": true }, { "name": "showServiceRpc", "summary": "show-service-rpc", "description": "show-service-rpc", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServiceRpc" }, "task": true }, { "name": "showServiceRpcWithSid", "summary": "show-service-rpc", "description": "show-service-rpc", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServiceRpcWithSid" }, "task": true }, { "name": "setServiceRpc", "summary": "set-service-rpc", "description": "set-service-rpc", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setServiceRpc" }, "task": true }, { "name": "setServiceRpcWithSid", "summary": "set-service-rpc", "description": "set-service-rpc", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setServiceRpcWithSid" }, "task": true }, { "name": "deleteServiceRpc", "summary": "delete-service-rpc", "description": "delete-service-rpc", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteServiceRpc" }, "task": true }, { "name": "deleteServiceRpcWithSid", "summary": "delete-service-rpc", "description": "delete-service-rpc", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteServiceRpcWithSid" }, "task": true }, { "name": "showServicesRpc", "summary": "show-services-rpc", "description": "show-services-rpc", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServicesRpc" }, "task": true }, { "name": "showServicesRpcWithSid", "summary": "show-services-rpc", "description": "show-services-rpc", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showServicesRpcWithSid" }, "task": true }, { "name": "addAccessRule", "summary": "add-access-rule", "description": "add-access-rule", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addAccessRule" }, "task": true }, { "name": "addAccessRuleWithSid", "summary": "add-access-rule", "description": "add-access-rule", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addAccessRuleWithSid" }, "task": true }, { "name": "showAccessRulebase", "summary": "show-access-rulebase", "description": "Shows the entire Access Rules Rulebase.", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showAccessRulebase" }, "task": true }, { "name": "showAccessRulebaseWithSid", "summary": "show-access-rulebase", "description": "Shows the entire Access Rules Rulebase.", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showAccessRulebaseWithSid" }, "task": true }, { "name": "showAccessRule", "summary": "show-access-rule", "description": "show-access-rule", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showAccessRule" }, "task": true }, { "name": "showAccessRuleWithSid", "summary": "show-access-rule", "description": "show-access-rule", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showAccessRuleWithSid" }, "task": true }, { "name": "setAccessRule", "summary": "set-access-rule", "description": "set-access-rule", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setAccessRule" }, "task": true }, { "name": "setAccessRuleWithSid", "summary": "set-access-rule", "description": "set-access-rule", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setAccessRuleWithSid" }, "task": true }, { "name": "deleteAccessRule", "summary": "delete-access-rule", "description": "delete-access-rule", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteAccessRule" }, "task": true }, { "name": "deleteAccessRuleWithSid", "summary": "delete-access-rule", "description": "delete-access-rule", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteAccessRuleWithSid" }, "task": true }, { "name": "addAccessSection", "summary": "add-access-section", "description": "add-access-section", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addAccessSection" }, "task": true }, { "name": "addAccessSectionWithSid", "summary": "add-access-section", "description": "add-access-section", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addAccessSectionWithSid" }, "task": true }, { "name": "showAccessSection", "summary": "show-access-section", "description": "show-access-section", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showAccessSection" }, "task": true }, { "name": "showAccessSectionWithSid", "summary": "show-access-section", "description": "show-access-section", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showAccessSectionWithSid" }, "task": true }, { "name": "setAccessSection", "summary": "set-access-section", "description": "set-access-section", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setAccessSection" }, "task": true }, { "name": "setAccessSectionWithSid", "summary": "set-access-section", "description": "set-access-section", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setAccessSectionWithSid" }, "task": true }, { "name": "deleteAccessSection", "summary": "delete-access-section", "description": "delete-access-section", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteAccessSection" }, "task": true }, { "name": "deleteAccessSectionWithSid", "summary": "delete-access-section", "description": "delete-access-section", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteAccessSectionWithSid" }, "task": true }, { "name": "addAccessLayer", "summary": "add-access-layer", "description": "Add access layer", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addAccessLayer" }, "task": true }, { "name": "addAccessLayerWithSid", "summary": "add-access-layer", "description": "Add access layer", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addAccessLayerWithSid" }, "task": true }, { "name": "showAccessLayer", "summary": "show-access-layer", "description": "show-access-layer", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showAccessLayer" }, "task": true }, { "name": "showAccessLayerWithSid", "summary": "show-access-layer", "description": "show-access-layer", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showAccessLayerWithSid" }, "task": true }, { "name": "setAccessLayer", "summary": "set-access-layer", "description": "Set access layer", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setAccessLayer" }, "task": true }, { "name": "setAccessLayerWithSid", "summary": "set-access-layer", "description": "Set access layer", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setAccessLayerWithSid" }, "task": true }, { "name": "deleteAccessLayer", "summary": "delete-access-layer", "description": "Delete access layer", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteAccessLayer" }, "task": true }, { "name": "deleteAccessLayerWithSid", "summary": "delete-access-layer", "description": "Delete access layer", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteAccessLayerWithSid" }, "task": true }, { "name": "showAccessLayers", "summary": "show-access-layers", "description": "show-access-layers", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showAccessLayers" }, "task": true }, { "name": "showAccessLayersWithSid", "summary": "show-access-layers", "description": "show-access-layers", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showAccessLayersWithSid" }, "task": true }, { "name": "addNatRule", "summary": "add-nat-rule", "description": "add-nat-rule", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addNatRule" }, "task": true }, { "name": "addNatRuleWithSid", "summary": "add-nat-rule", "description": "add-nat-rule", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addNatRuleWithSid" }, "task": true }, { "name": "showNatRulebase", "summary": "show-nat-rulebase", "description": "Shows the entire NAT Rules Rulebase.", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showNatRulebase" }, "task": true }, { "name": "showNatRulebaseWithSid", "summary": "show-nat-rulebase", "description": "Shows the entire NAT Rules Rulebase.", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showNatRulebaseWithSid" }, "task": true }, { "name": "showNatRule", "summary": "show-nat-rule", "description": "show-nat-rule", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showNatRule" }, "task": true }, { "name": "showNatRuleWithSid", "summary": "show-nat-rule", "description": "show-nat-rule", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showNatRuleWithSid" }, "task": true }, { "name": "setNatRule", "summary": "set-nat-rule", "description": "set-nat-rule", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setNatRule" }, "task": true }, { "name": "setNatRuleWithSid", "summary": "set-nat-rule", "description": "set-nat-rule", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setNatRuleWithSid" }, "task": true }, { "name": "deleteNatRule", "summary": "delete-nat-rule", "description": "delete-nat-rule", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNatRule" }, "task": true }, { "name": "deleteNatRuleWithSid", "summary": "delete-nat-rule", "description": "delete-nat-rule", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNatRuleWithSid" }, "task": true }, { "name": "addNatSection", "summary": "add-nat-section", "description": "add-nat-section", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addNatSection" }, "task": true }, { "name": "addNatSectionWithSid", "summary": "add-nat-section", "description": "add-nat-section", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addNatSectionWithSid" }, "task": true }, { "name": "showNatSection", "summary": "show-nat-section", "description": "show-nat-section", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showNatSection" }, "task": true }, { "name": "showNatSectionWithSid", "summary": "show-nat-section", "description": "show-nat-section", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showNatSectionWithSid" }, "task": true }, { "name": "setNatSection", "summary": "set-nat-section", "description": "set-nat-section", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setNatSection" }, "task": true }, { "name": "setNatSectionWithSid", "summary": "set-nat-section", "description": "set-nat-section", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setNatSectionWithSid" }, "task": true }, { "name": "deleteNatSection", "summary": "delete-nat-section", "description": "delete-nat-section", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNatSection" }, "task": true }, { "name": "deleteNatSectionWithSid", "summary": "delete-nat-section", "description": "delete-nat-section", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteNatSectionWithSid" }, "task": true }, { "name": "addVpnCommunityMeshed", "summary": "add-vpn-community-meshed", "description": "Adds a new VPN Meshed Community", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addVpnCommunityMeshed" }, "task": true }, { "name": "addVpnCommunityMeshedWithSid", "summary": "add-vpn-community-meshed", "description": "Adds a new VPN Meshed Community", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addVpnCommunityMeshedWithSid" }, "task": true }, { "name": "showVpnCommunityMeshed", "summary": "show-vpn-community-meshed", "description": "Displays a VPN Meshed Community", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showVpnCommunityMeshed" }, "task": true }, { "name": "showVpnCommunityMeshedWithSid", "summary": "show-vpn-community-meshed", "description": "Displays a VPN Meshed Community", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showVpnCommunityMeshedWithSid" }, "task": true }, { "name": "setVpnCommunityMeshed", "summary": "set-vpn-community-meshed", "description": "Modifies an existing VPN Meshed Community", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setVpnCommunityMeshed" }, "task": true }, { "name": "setVpnCommunityMeshedWithSid", "summary": "set-vpn-community-meshed", "description": "Modifies an existing VPN Meshed Community", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setVpnCommunityMeshedWithSid" }, "task": true }, { "name": "deleteVpnCommunityMeshed", "summary": "delete-vpn-community-meshed", "description": "delete-vpn-community-meshed", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpnCommunityMeshed" }, "task": true }, { "name": "deleteVpnCommunityMeshedWithSid", "summary": "delete-vpn-community-meshed", "description": "delete-vpn-community-meshed", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpnCommunityMeshedWithSid" }, "task": true }, { "name": "showVpnCommunitiesMeshed", "summary": "show-vpn-communities-meshed", "description": "Displays several VPN Meshed Communities", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showVpnCommunitiesMeshed" }, "task": true }, { "name": "showVpnCommunitiesMeshedWithSid", "summary": "show-vpn-communities-meshed", "description": "Displays several VPN Meshed Communities", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showVpnCommunitiesMeshedWithSid" }, "task": true }, { "name": "addVpnCommunityStar", "summary": "add-vpn-community-star", "description": "Adds a new VPN Star Community", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addVpnCommunityStar" }, "task": true }, { "name": "addVpnCommunityStarWithSid", "summary": "add-vpn-community-star", "description": "Adds a new VPN Star Community", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addVpnCommunityStarWithSid" }, "task": true }, { "name": "showVpnCommunityStar", "summary": "show-vpn-community-star", "description": "Displays a VPN Star Community", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showVpnCommunityStar" }, "task": true }, { "name": "showVpnCommunityStarWithSid", "summary": "show-vpn-community-star", "description": "Displays a VPN Star Community", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showVpnCommunityStarWithSid" }, "task": true }, { "name": "setVpnCommunityStar", "summary": "set-vpn-community-star", "description": "Modifies an existing VPN Star Community", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setVpnCommunityStar" }, "task": true }, { "name": "setVpnCommunityStarWithSid", "summary": "set-vpn-community-star", "description": "Modifies an existing VPN Star Community", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setVpnCommunityStarWithSid" }, "task": true }, { "name": "deleteVpnCommunityStar", "summary": "delete-vpn-community-star", "description": "delete-vpn-community-star", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpnCommunityStar" }, "task": true }, { "name": "deleteVpnCommunityStarWithSid", "summary": "delete-vpn-community-star", "description": "delete-vpn-community-star", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteVpnCommunityStarWithSid" }, "task": true }, { "name": "showVpnCommunitiesStar", "summary": "show-vpn-communities-star", "description": "Displays several VPN Star Communities", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showVpnCommunitiesStar" }, "task": true }, { "name": "showVpnCommunitiesStarWithSid", "summary": "show-vpn-communities-star", "description": "Displays several VPN Star Communities", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showVpnCommunitiesStarWithSid" }, "task": true }, { "name": "addThreatRule", "summary": "add-threat-rule", "description": "Add threat prevention rule", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addThreatRule" }, "task": true }, { "name": "addThreatRuleWithSid", "summary": "add-threat-rule", "description": "Add threat prevention rule", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addThreatRuleWithSid" }, "task": true }, { "name": "showThreatRulebase", "summary": "show-threat-rulebase", "description": "Shows the entire Threat Rules Rulebase.", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showThreatRulebase" }, "task": true }, { "name": "showThreatRulebaseWithSid", "summary": "show-threat-rulebase", "description": "Shows the entire Threat Rules Rulebase.", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showThreatRulebaseWithSid" }, "task": true }, { "name": "showThreatRule", "summary": "show-threat-rule", "description": "show-threat-rule", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showThreatRule" }, "task": true }, { "name": "showThreatRuleWithSid", "summary": "show-threat-rule", "description": "show-threat-rule", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showThreatRuleWithSid" }, "task": true }, { "name": "setThreatRule", "summary": "set-threat-rule", "description": "set-threat-rule", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setThreatRule" }, "task": true }, { "name": "setThreatRuleWithSid", "summary": "set-threat-rule", "description": "set-threat-rule", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setThreatRuleWithSid" }, "task": true }, { "name": "deleteThreatRule", "summary": "delete-threat-rule", "description": "delete-threat-rule", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteThreatRule" }, "task": true }, { "name": "deleteThreatRuleWithSid", "summary": "delete-threat-rule", "description": "delete-threat-rule", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteThreatRuleWithSid" }, "task": true }, { "name": "addThreatException", "summary": "add-threat-exception", "description": "Add threat prevention exception", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addThreatException" }, "task": true }, { "name": "addThreatExceptionWithSid", "summary": "add-threat-exception", "description": "Add threat prevention exception", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addThreatExceptionWithSid" }, "task": true }, { "name": "showThreatRuleExceptionRulebase", "summary": "show-threat-rule-exception-rulebase", "description": "show threat exception rulebase of a threat rule", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showThreatRuleExceptionRulebase" }, "task": true }, { "name": "showThreatRuleExceptionRulebaseWithSid", "summary": "show-threat-rule-exception-rulebase", "description": "show threat exception rulebase of a threat rule", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showThreatRuleExceptionRulebaseWithSid" }, "task": true }, { "name": "showThreatException", "summary": "show-threat-exception", "description": "show-threat-exception", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showThreatException" }, "task": true }, { "name": "showThreatExceptionWithSid", "summary": "show-threat-exception", "description": "show-threat-exception", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showThreatExceptionWithSid" }, "task": true }, { "name": "setThreatException", "summary": "set-threat-exception", "description": "Set threat prevention exception", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setThreatException" }, "task": true }, { "name": "setThreatExceptionWithSid", "summary": "set-threat-exception", "description": "Set threat prevention exception", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setThreatExceptionWithSid" }, "task": true }, { "name": "deleteThreatException", "summary": "delete-threat-exception", "description": "Delete threat exception", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteThreatException" }, "task": true }, { "name": "deleteThreatExceptionWithSid", "summary": "delete-threat-exception", "description": "Delete threat exception", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteThreatExceptionWithSid" }, "task": true }, { "name": "addExceptionGroup", "summary": "add-exception-group", "description": "add-exception-group", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addExceptionGroup" }, "task": true }, { "name": "addExceptionGroupWithSid", "summary": "add-exception-group", "description": "add-exception-group", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addExceptionGroupWithSid" }, "task": true }, { "name": "showExceptionGroup", "summary": "show-exception-group", "description": "show-exception-group", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showExceptionGroup" }, "task": true }, { "name": "showExceptionGroupWithSid", "summary": "show-exception-group", "description": "show-exception-group", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showExceptionGroupWithSid" }, "task": true }, { "name": "setExceptionGroup", "summary": "set-exception-group", "description": "Set exception group", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setExceptionGroup" }, "task": true }, { "name": "setExceptionGroupWithSid", "summary": "set-exception-group", "description": "Set exception group", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setExceptionGroupWithSid" }, "task": true }, { "name": "deleteExceptionGroup", "summary": "delete-exception-group", "description": "Delete exception group", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteExceptionGroup" }, "task": true }, { "name": "deleteExceptionGroupWithSid", "summary": "delete-exception-group", "description": "Delete exception group", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteExceptionGroupWithSid" }, "task": true }, { "name": "showExceptionGroups", "summary": "show-exception-groups", "description": "show-exception-groups", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showExceptionGroups" }, "task": true }, { "name": "showExceptionGroupsWithSid", "summary": "show-exception-groups", "description": "show-exception-groups", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showExceptionGroupsWithSid" }, "task": true }, { "name": "showThreatProtection", "summary": "show-threat-protection", "description": "show-threat-protection", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showThreatProtection" }, "task": true }, { "name": "showThreatProtectionWithSid", "summary": "show-threat-protection", "description": "show-threat-protection", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showThreatProtectionWithSid" }, "task": true }, { "name": "setThreatProtection", "summary": "set-threat-protection", "description": "Sets an override to an existing profile for a specific protection. In the example below, one override will be set for \"New Profile 1\".", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setThreatProtection" }, "task": true }, { "name": "setThreatProtectionWithSid", "summary": "set-threat-protection", "description": "Sets an override to an existing profile for a specific protection. In the example below, one override will be set for \"New Profile 1\".", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setThreatProtectionWithSid" }, "task": true }, { "name": "showThreatProtections", "summary": "show-threat-protections", "description": "show-threat-protections", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showThreatProtections" }, "task": true }, { "name": "showThreatProtectionsWithSid", "summary": "show-threat-protections", "description": "show-threat-protections", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showThreatProtectionsWithSid" }, "task": true }, { "name": "addThreatProtections", "summary": "add-threat-protections", "description": "Adding threat protections", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addThreatProtections" }, "task": true }, { "name": "addThreatProtectionsWithSid", "summary": "add-threat-protections", "description": "Adding threat protections", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addThreatProtectionsWithSid" }, "task": true }, { "name": "deleteThreatProtections", "summary": "delete-threat-protections", "description": "Delete threat protections", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteThreatProtections" }, "task": true }, { "name": "deleteThreatProtectionsWithSid", "summary": "delete-threat-protections", "description": "Delete threat protections", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteThreatProtectionsWithSid" }, "task": true }, { "name": "addThreatProfile", "summary": "add-threat-profile", "description": "add-threat-profile", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addThreatProfile" }, "task": true }, { "name": "addThreatProfileWithSid", "summary": "add-threat-profile", "description": "add-threat-profile", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addThreatProfileWithSid" }, "task": true }, { "name": "showThreatProfile", "summary": "show-threat-profile", "description": "show-threat-profile", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showThreatProfile" }, "task": true }, { "name": "showThreatProfileWithSid", "summary": "show-threat-profile", "description": "show-threat-profile", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showThreatProfileWithSid" }, "task": true }, { "name": "setThreatProfile", "summary": "set-threat-profile", "description": "set-threat-profile", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setThreatProfile" }, "task": true }, { "name": "setThreatProfileWithSid", "summary": "set-threat-profile", "description": "set-threat-profile", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setThreatProfileWithSid" }, "task": true }, { "name": "deleteThreatProfile", "summary": "delete-threat-profile", "description": "delete-threat-profile", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteThreatProfile" }, "task": true }, { "name": "deleteThreatProfileWithSid", "summary": "delete-threat-profile", "description": "delete-threat-profile", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteThreatProfileWithSid" }, "task": true }, { "name": "showThreatProfiles", "summary": "show-threat-profiles", "description": "show-threat-profiles", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showThreatProfiles" }, "task": true }, { "name": "showThreatProfilesWithSid", "summary": "show-threat-profiles", "description": "show-threat-profiles", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showThreatProfilesWithSid" }, "task": true }, { "name": "addThreatIndicator", "summary": "add-threat-indicator", "description": "Adding a threat indicator", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addThreatIndicator" }, "task": true }, { "name": "addThreatIndicatorWithSid", "summary": "add-threat-indicator", "description": "Adding a threat indicator", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addThreatIndicatorWithSid" }, "task": true }, { "name": "showThreatIndicator", "summary": "show-threat-indicator", "description": "Showing a threat indicator", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showThreatIndicator" }, "task": true }, { "name": "showThreatIndicatorWithSid", "summary": "show-threat-indicator", "description": "Showing a threat indicator", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showThreatIndicatorWithSid" }, "task": true }, { "name": "setThreatIndicator", "summary": "set-threat-indicator", "description": "Setting a threat indicator", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setThreatIndicator" }, "task": true }, { "name": "setThreatIndicatorWithSid", "summary": "set-threat-indicator", "description": "Setting a threat indicator", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setThreatIndicatorWithSid" }, "task": true }, { "name": "deleteThreatIndicator", "summary": "delete-threat-indicator", "description": "Deleting a threat indicator", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteThreatIndicator" }, "task": true }, { "name": "deleteThreatIndicatorWithSid", "summary": "delete-threat-indicator", "description": "Deleting a threat indicator", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteThreatIndicatorWithSid" }, "task": true }, { "name": "showThreatIndicators", "summary": "show-threat-indicators", "description": "Showing a list of threat indicators", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showThreatIndicators" }, "task": true }, { "name": "showThreatIndicatorsWithSid", "summary": "show-threat-indicators", "description": "Showing a list of threat indicators", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showThreatIndicatorsWithSid" }, "task": true }, { "name": "addThreatLayer", "summary": "add-threat-layer", "description": "Add threat layer", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addThreatLayer" }, "task": true }, { "name": "addThreatLayerWithSid", "summary": "add-threat-layer", "description": "Add threat layer", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addThreatLayerWithSid" }, "task": true }, { "name": "showThreatLayer", "summary": "show-threat-layer", "description": "Show threat layer", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showThreatLayer" }, "task": true }, { "name": "showThreatLayerWithSid", "summary": "show-threat-layer", "description": "Show threat layer", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showThreatLayerWithSid" }, "task": true }, { "name": "setThreatLayer", "summary": "set-threat-layer", "description": "Set threat layer", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setThreatLayer" }, "task": true }, { "name": "setThreatLayerWithSid", "summary": "set-threat-layer", "description": "Set threat layer", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setThreatLayerWithSid" }, "task": true }, { "name": "deleteThreatLayer", "summary": "delete-threat-layer", "description": "Delete threat layer", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteThreatLayer" }, "task": true }, { "name": "deleteThreatLayerWithSid", "summary": "delete-threat-layer", "description": "Delete threat layer", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteThreatLayerWithSid" }, "task": true }, { "name": "showThreatLayers", "summary": "show-threat-layers", "description": "Show threat layers", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showThreatLayers" }, "task": true }, { "name": "showThreatLayersWithSid", "summary": "show-threat-layers", "description": "Show threat layers", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showThreatLayersWithSid" }, "task": true }, { "name": "showIpsUpdateSchedule", "summary": "show-ips-update-schedule", "description": "Show IPS update schedule", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showIpsUpdateSchedule" }, "task": true }, { "name": "showIpsUpdateScheduleWithSid", "summary": "show-ips-update-schedule", "description": "Show IPS update schedule", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showIpsUpdateScheduleWithSid" }, "task": true }, { "name": "setIpsUpdateScheduleInterval", "summary": "set-ips-update-schedule-interval", "description": "Set IPS update schedule (interval basis)", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setIpsUpdateScheduleInterval" }, "task": true }, { "name": "setIpsUpdateScheduleIntervalWithSid", "summary": "set-ips-update-schedule-interval", "description": "Set IPS update schedule (interval basis)", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setIpsUpdateScheduleIntervalWithSid" }, "task": true }, { "name": "runIpsUpdate", "summary": "run-ips-update", "description": "Run IPS update", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/runIpsUpdate" }, "task": true }, { "name": "runIpsUpdateWithSid", "summary": "run-ips-update", "description": "Run IPS update", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/runIpsUpdateWithSid" }, "task": true }, { "name": "showIpsStatus", "summary": "show-ips-status", "description": "Show IPS database status", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showIpsStatus" }, "task": true }, { "name": "showIpsStatusWithSid", "summary": "show-ips-status", "description": "Show IPS database status", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showIpsStatusWithSid" }, "task": true }, { "name": "showIpsProtectionExtendedAttribute", "summary": "show-ips-protection-extended-attribute", "description": "Show IPS protection extended Attribute", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showIpsProtectionExtendedAttribute" }, "task": true }, { "name": "showIpsProtectionExtendedAttributeWithSid", "summary": "show-ips-protection-extended-attribute", "description": "Show IPS protection extended Attribute", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showIpsProtectionExtendedAttributeWithSid" }, "task": true }, { "name": "showIpsProtectionExtendedAttributes", "summary": "show-ips-protection-extended-attributes", "description": "Show IPS protection extended Attributes", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showIpsProtectionExtendedAttributes" }, "task": true }, { "name": "showIpsProtectionExtendedAttributesWithSid", "summary": "show-ips-protection-extended-attributes", "description": "Show IPS protection extended Attributes", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showIpsProtectionExtendedAttributesWithSid" }, "task": true }, { "name": "runThreatEmulationFileTypesOfflineUpdate", "summary": "run-threat-emulation-file-types-offline-update", "description": "Updates Threat Emulation file types offline.", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/runThreatEmulationFileTypesOfflineUpdate" }, "task": true }, { "name": "runThreatEmulationFileTypesOfflineUpdateWithSid", "summary": "run-threat-emulation-file-types-offline-update", "description": "Updates Threat Emulation file types offline.", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/runThreatEmulationFileTypesOfflineUpdateWithSid" }, "task": true }, { "name": "verifyPolicy", "summary": "verify-policy", "description": "verify-policy", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/verifyPolicy" }, "task": true }, { "name": "verifyPolicyWithSid", "summary": "verify-policy", "description": "verify-policy", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/verifyPolicyWithSid" }, "task": true }, { "name": "installPolicy", "summary": "install-policy", "description": "install-policy", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/installPolicy" }, "task": true }, { "name": "installPolicyWithSid", "summary": "install-policy", "description": "install-policy", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/installPolicyWithSid" }, "task": true }, { "name": "addPackage", "summary": "add-package", "description": "Add package", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addPackage" }, "task": true }, { "name": "addPackageWithSid", "summary": "add-package", "description": "Add package", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addPackageWithSid" }, "task": true }, { "name": "showPackage", "summary": "show-package", "description": "show-package", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showPackage" }, "task": true }, { "name": "showPackageWithSid", "summary": "show-package", "description": "show-package", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showPackageWithSid" }, "task": true }, { "name": "setPackage", "summary": "set-package", "description": "set-package", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setPackage" }, "task": true }, { "name": "setPackageWithSid", "summary": "set-package", "description": "set-package", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setPackageWithSid" }, "task": true }, { "name": "deletePackage", "summary": "delete-package", "description": "delete-package", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deletePackage" }, "task": true }, { "name": "deletePackageWithSid", "summary": "delete-package", "description": "delete-package", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deletePackageWithSid" }, "task": true }, { "name": "showPackages", "summary": "show-packages", "description": "show-packages", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showPackages" }, "task": true }, { "name": "showPackagesWithSid", "summary": "show-packages", "description": "show-packages", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showPackagesWithSid" }, "task": true }, { "name": "addDomain", "summary": "add-domain", "description": "add-domain", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addDomain" }, "task": true }, { "name": "addDomainWithSid", "summary": "add-domain", "description": "add-domain", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addDomainWithSid" }, "task": true }, { "name": "showDomain", "summary": "show-domain", "description": "show-domain", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDomain" }, "task": true }, { "name": "showDomainWithSid", "summary": "show-domain", "description": "show-domain", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDomainWithSid" }, "task": true }, { "name": "setDomain", "summary": "set-domain", "description": "set-domain", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setDomain" }, "task": true }, { "name": "setDomainWithSid", "summary": "set-domain", "description": "set-domain", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setDomainWithSid" }, "task": true }, { "name": "deleteDomain", "summary": "delete-domain", "description": "delete-domain", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteDomain" }, "task": true }, { "name": "deleteDomainWithSid", "summary": "delete-domain", "description": "delete-domain", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteDomainWithSid" }, "task": true }, { "name": "showDomains", "summary": "show-domains", "description": "show-domains", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDomains" }, "task": true }, { "name": "showDomainsWithSid", "summary": "show-domains", "description": "show-domains", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showDomainsWithSid" }, "task": true }, { "name": "showGlobalDomain", "summary": "show-global-domain", "description": "show-global-domain", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showGlobalDomain" }, "task": true }, { "name": "showGlobalDomainWithSid", "summary": "show-global-domain", "description": "show-global-domain", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showGlobalDomainWithSid" }, "task": true }, { "name": "setGlobalDomain", "summary": "set-global-domain", "description": "set-global-domain", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setGlobalDomain" }, "task": true }, { "name": "setGlobalDomainWithSid", "summary": "set-global-domain", "description": "set-global-domain", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setGlobalDomainWithSid" }, "task": true }, { "name": "showMds", "summary": "show-mds", "description": "show-mds", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showMds" }, "task": true }, { "name": "showMdsWithSid", "summary": "show-mds", "description": "show-mds", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showMdsWithSid" }, "task": true }, { "name": "showMdss", "summary": "show-mdss", "description": "Show all the domains", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showMdss" }, "task": true }, { "name": "showMdssWithSid", "summary": "show-mdss", "description": "Show all the domains", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showMdssWithSid" }, "task": true }, { "name": "showPlaceHolder", "summary": "show-place-holder", "description": "Show rules placeholder in the global policy", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showPlaceHolder" }, "task": true }, { "name": "showPlaceHolderWithSid", "summary": "show-place-holder", "description": "Show rules placeholder in the global policy", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showPlaceHolderWithSid" }, "task": true }, { "name": "addGlobalAssignment", "summary": "add-global-assignment", "description": "add-global-assignment", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addGlobalAssignment" }, "task": true }, { "name": "addGlobalAssignmentWithSid", "summary": "add-global-assignment", "description": "add-global-assignment", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addGlobalAssignmentWithSid" }, "task": true }, { "name": "showGlobalAssignment", "summary": "show-global-assignment", "description": "show-global-assignment", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showGlobalAssignment" }, "task": true }, { "name": "showGlobalAssignmentWithSid", "summary": "show-global-assignment", "description": "show-global-assignment", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showGlobalAssignmentWithSid" }, "task": true }, { "name": "setGlobalAssignment", "summary": "set-global-assignment", "description": "set-global-assignment", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setGlobalAssignment" }, "task": true }, { "name": "setGlobalAssignmentWithSid", "summary": "set-global-assignment", "description": "set-global-assignment", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setGlobalAssignmentWithSid" }, "task": true }, { "name": "deleteGlobalAssignment", "summary": "delete-global-assignment", "description": "delete-global-assignment", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteGlobalAssignment" }, "task": true }, { "name": "deleteGlobalAssignmentWithSid", "summary": "delete-global-assignment", "description": "delete-global-assignment", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteGlobalAssignmentWithSid" }, "task": true }, { "name": "showGlobalAssignments", "summary": "show-global-assignments", "description": "show-global-assignments", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showGlobalAssignments" }, "task": true }, { "name": "showGlobalAssignmentsWithSid", "summary": "show-global-assignments", "description": "show-global-assignments", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showGlobalAssignmentsWithSid" }, "task": true }, { "name": "assignGlobalAssignment", "summary": "assign-global-assignment", "description": "assign-global-assignment", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/assignGlobalAssignment" }, "task": true }, { "name": "assignGlobalAssignmentWithSid", "summary": "assign-global-assignment", "description": "assign-global-assignment", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/assignGlobalAssignmentWithSid" }, "task": true }, { "name": "whereUsed", "summary": "where-used", "description": "Searches for direct usage of target object in other objects and rules", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/whereUsed" }, "task": true }, { "name": "whereUsedWithSid", "summary": "where-used", "description": "Searches for direct usage of target object in other objects and rules", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/whereUsedWithSid" }, "task": true }, { "name": "showTask", "summary": "show-task", "description": "show-task", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showTask" }, "task": true }, { "name": "showTaskWithSid", "summary": "show-task", "description": "show-task", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showTaskWithSid" }, "task": true }, { "name": "runScript", "summary": "run-script", "description": "run-script", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/runScript" }, "task": true }, { "name": "runScriptWithSid", "summary": "run-script", "description": "run-script", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/runScriptWithSid" }, "task": true }, { "name": "showUnusedObjects", "summary": "show unused objects", "description": "Show unused objects", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showUnusedObjects" }, "task": true }, { "name": "showUnusedObjectsWithSid", "summary": "show unused objects", "description": "Show unused objects", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showUnusedObjectsWithSid" }, "task": true }, { "name": "export", "summary": "export", "description": "export", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/export" }, "task": true }, { "name": "exportWithSid", "summary": "export", "description": "export", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/exportWithSid" }, "task": true }, { "name": "showChangesBetweenTheDates", "summary": "show-changes between the dates", "description": "Request for changes by start and end date. Use the show-task command to check the progress of the task. Output below is the output of the show-task command.", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showChangesBetweenTheDates" }, "task": true }, { "name": "showChangesBetweenTheDatesWithSid", "summary": "show-changes between the dates", "description": "Request for changes by start and end date. Use the show-task command to check the progress of the task. Output below is the output of the show-task command.", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showChangesBetweenTheDatesWithSid" }, "task": true }, { "name": "showGatewaysAndServers", "summary": "show-gateways-and-servers", "description": "Shows Gateways & Servers", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showGatewaysAndServers" }, "task": true }, { "name": "showGatewaysAndServersWithSid", "summary": "show-gateways-and-servers", "description": "Shows Gateways & Servers", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showGatewaysAndServersWithSid" }, "task": true }, { "name": "showObjectsOfTypeGroup", "summary": "show-objects of type group", "description": "show-objects of type group", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showObjectsOfTypeGroup" }, "task": true }, { "name": "showObjectsOfTypeGroupWithSid", "summary": "show-objects of type group", "description": "show-objects of type group", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showObjectsOfTypeGroupWithSid" }, "task": true }, { "name": "showValidations", "summary": "show-validations", "description": "Show all validation incidents.", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showValidations" }, "task": true }, { "name": "showValidationsWithSid", "summary": "show-validations", "description": "Show all validation incidents.", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showValidationsWithSid" }, "task": true }, { "name": "showTasks", "summary": "show-tasks", "description": "Show all successful tasks initiated by administrator admin1, last updated after date 2018-05-23T08:00:00.", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showTasks" }, "task": true }, { "name": "showTasksWithSid", "summary": "show-tasks", "description": "Show all successful tasks initiated by administrator admin1, last updated after date 2018-05-23T08:00:00.", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showTasksWithSid" }, "task": true }, { "name": "showApiVersions", "summary": "show-api-versions", "description": "show-api-versions", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showApiVersions" }, "task": true }, { "name": "showApiVersionsWithSid", "summary": "show-api-versions", "description": "show-api-versions", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showApiVersionsWithSid" }, "task": true }, { "name": "showObject", "summary": "show-object", "description": "Show object", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showObject" }, "task": true }, { "name": "showObjectWithSid", "summary": "show-object", "description": "Show object", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showObjectWithSid" }, "task": true }, { "name": "showCommands", "summary": "show-commands", "description": "Show all the commands supported by the API server", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showCommands" }, "task": true }, { "name": "showCommandsWithSid", "summary": "show-commands", "description": "Show all the commands supported by the API server", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showCommandsWithSid" }, "task": true }, { "name": "putFile", "summary": "put-file", "description": "put-file", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putFile" }, "task": true }, { "name": "putFileWithSid", "summary": "put-file", "description": "put-file", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putFileWithSid" }, "task": true }, { "name": "addAdministrator", "summary": "add-administrator", "description": "add-administrator", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addAdministrator" }, "task": true }, { "name": "addAdministratorWithSid", "summary": "add-administrator", "description": "add-administrator", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addAdministratorWithSid" }, "task": true }, { "name": "showAdministrator", "summary": "show-administrator", "description": "show-administrator", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showAdministrator" }, "task": true }, { "name": "showAdministratorWithSid", "summary": "show-administrator", "description": "show-administrator", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showAdministratorWithSid" }, "task": true }, { "name": "setAdministrator", "summary": "set-administrator", "description": "set-administrator", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setAdministrator" }, "task": true }, { "name": "setAdministratorWithSid", "summary": "set-administrator", "description": "set-administrator", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setAdministratorWithSid" }, "task": true }, { "name": "deleteAdministrator", "summary": "delete-administrator", "description": "delete-administrator", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteAdministrator" }, "task": true }, { "name": "deleteAdministratorWithSid", "summary": "delete-administrator", "description": "delete-administrator", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteAdministratorWithSid" }, "task": true }, { "name": "showAdministrators", "summary": "show-administrators", "description": "show-administrators", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showAdministrators" }, "task": true }, { "name": "showAdministratorsWithSid", "summary": "show-administrators", "description": "show-administrators", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showAdministratorsWithSid" }, "task": true }, { "name": "unlockAdministrator", "summary": "unlock-administrator", "description": "Unlock administrator", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/unlockAdministrator" }, "task": true }, { "name": "unlockAdministratorWithSid", "summary": "unlock-administrator", "description": "Unlock administrator", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/unlockAdministratorWithSid" }, "task": true }, { "name": "showApiSettings", "summary": "show-api-settings", "description": "show-api-settings", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showApiSettings" }, "task": true }, { "name": "showApiSettingsWithSid", "summary": "show-api-settings", "description": "show-api-settings", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showApiSettingsWithSid" }, "task": true }, { "name": "setApiSettings", "summary": "set-api-settings", "description": "Set API Settings", "input": [ { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setApiSettings" }, "task": true }, { "name": "setApiSettingsWithSid", "summary": "set-api-settings", "description": "Set API Settings", "input": [ { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": true, "schema": { "title": "sid", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "title": "body", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/setApiSettingsWithSid" }, "task": true }, { "name": "verifySoftwarePackage", "summary": "Verifies the software package on target machines.", "description": "Verifies the software package on target machines.", "input": [ { "name": "body", "type": "object", "info": "Request body: object", "required": true, "schema": { "type": "object" } }, { "name": "iapMetadata", "type": "object", "info": "Itential Platform Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.", "required": false, "schema": { "title": "iapMetadata", "type": "object" } }, { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": false, "schema": { "title": "sid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/verifySoftwarePackage" }, "task": true }, { "name": "installSoftwarePackage", "summary": "Installs the software package on target machines.", "description": "Installs the software package on target machines.", "input": [ { "name": "body", "type": "object", "info": "Request body: object", "required": true, "schema": { "type": "object" } }, { "name": "iapMetadata", "type": "object", "info": "Itential Platform Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.", "required": false, "schema": { "title": "iapMetadata", "type": "object" } }, { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": false, "schema": { "title": "sid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/installSoftwarePackage" }, "task": true }, { "name": "uninstallSoftwarePackage", "summary": "Uninstalls the software package from target machines.", "description": "Uninstalls the software package from target machines.", "input": [ { "name": "body", "type": "object", "info": "Request body: object", "required": true, "schema": { "type": "object" } }, { "name": "iapMetadata", "type": "object", "info": "Itential Platform Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.", "required": false, "schema": { "title": "iapMetadata", "type": "object" } }, { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": false, "schema": { "title": "sid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/uninstallSoftwarePackage" }, "task": true }, { "name": "addRepositoryPackage", "summary": "Add the software package to the central repository.", "description": "Add the software package to the central repository. On Multi-Domain Server this command is available only after logging in to the Global domain.", "input": [ { "name": "body", "type": "object", "info": "Request body: object", "required": true, "schema": { "type": "object" } }, { "name": "iapMetadata", "type": "object", "info": "Itential Platform Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.", "required": false, "schema": { "title": "iapMetadata", "type": "object" } }, { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": false, "schema": { "title": "sid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addRepositoryPackage" }, "task": true }, { "name": "showRepositoryPackage", "summary": "Gets repository software packages information.", "description": "Gets repository software packages information.", "input": [ { "name": "body", "type": "object", "info": "Request body: object", "required": true, "schema": { "type": "object" } }, { "name": "iapMetadata", "type": "object", "info": "Itential Platform Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.", "required": false, "schema": { "title": "iapMetadata", "type": "object" } }, { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": false, "schema": { "title": "sid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showRepositoryPackage" }, "task": true }, { "name": "showSoftwarePackageDetails", "summary": "Gets the software package information from the cloud.", "description": "Gets the software package information from the cloud.", "input": [ { "name": "body", "type": "object", "info": "Request body: object", "required": true, "schema": { "type": "object" } }, { "name": "iapMetadata", "type": "object", "info": "Itential Platform Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.", "required": false, "schema": { "title": "iapMetadata", "type": "object" } }, { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": false, "schema": { "title": "sid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showSoftwarePackageDetails" }, "task": true }, { "name": "showSoftwarePackagesPerTargets", "summary": "Shows software packages on targets.", "description": "Shows software packages on targets.", "input": [ { "name": "body", "type": "object", "info": "Request body: object", "required": true, "schema": { "type": "object" } }, { "name": "iapMetadata", "type": "object", "info": "Itential Platform Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.", "required": false, "schema": { "title": "iapMetadata", "type": "object" } }, { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": false, "schema": { "title": "sid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showSoftwarePackagesPerTargets" }, "task": true }, { "name": "deleteRepositoryPackage", "summary": "Delete the repository software package from the central repository.", "description": "Delete the repository software package from the central repository. On Multi-Domain Server this command is available only after logging in to the Global domain.", "input": [ { "name": "body", "type": "object", "info": "Request body: object", "required": true, "schema": { "type": "object" } }, { "name": "iapMetadata", "type": "object", "info": "Itential Platform Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.", "required": false, "schema": { "title": "iapMetadata", "type": "object" } }, { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": false, "schema": { "title": "sid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteRepositoryPackage" }, "task": true }, { "name": "showRepositoryPackages", "summary": "Gets all repository software packages information.", "description": "Gets all repository software packages information.", "input": [ { "name": "body", "type": "object", "info": "Request body: object", "required": true, "schema": { "type": "object" } }, { "name": "iapMetadata", "type": "object", "info": "Itential Platform Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.", "required": false, "schema": { "title": "iapMetadata", "type": "object" } }, { "name": "sid", "type": "string", "info": "Session unique identifier returned by the login request.", "required": false, "schema": { "title": "sid", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/showRepositoryPackages" }, "task": true } ] }