├── .github ├── ISSUE_TEMPLATE │ └── bug_report.md ├── pull_request_template.md └── workflows │ └── main.yml ├── .gitignore ├── .idea └── vcs.xml ├── .lgtm.yaml ├── .swagger-codegen-ignore ├── CHANGELOG.md ├── LICENSE ├── README.md ├── demisto_client ├── __init__.py └── demisto_api │ ├── README.md │ ├── __init__.py │ ├── api │ ├── __init__.py │ └── default_api.py │ ├── api_client.py │ ├── configuration.py │ ├── models │ ├── __init__.py │ ├── advance_arg.py │ ├── arg_atomic_filter.py │ ├── arg_filter.py │ ├── arg_transformer.py │ ├── argument.py │ ├── array_positions.py │ ├── attachment.py │ ├── audit.py │ ├── audit_result.py │ ├── automation_script.py │ ├── automation_script_api.py │ ├── automation_script_filter.py │ ├── automation_script_filter_wrapper.py │ ├── automation_script_result.py │ ├── command.py │ ├── common_fields.py │ ├── complex_arg.py │ ├── config_data_type.py │ ├── config_field.py │ ├── create_incident_request.py │ ├── custom_fields.py │ ├── d_bot_score.py │ ├── dashboard.py │ ├── data_collection_form.py │ ├── date_range.py │ ├── date_range_filter.py │ ├── delete_evidence.py │ ├── docker_image.py │ ├── docker_images_result.py │ ├── download_entry.py │ ├── duration.py │ ├── ending_type.py │ ├── entry.py │ ├── entry_category.py │ ├── entry_history.py │ ├── entry_reputation.py │ ├── entry_task.py │ ├── entry_type.py │ ├── evidence.py │ ├── evidence_data.py │ ├── evidences.py │ ├── evidences_filter_wrapper.py │ ├── evidences_search_response.py │ ├── expiration_policy.py │ ├── expiration_settings_source.py │ ├── expiration_source.py │ ├── feed_indicator.py │ ├── feed_indicators.py │ ├── feed_indicators_request.py │ ├── field_group.py │ ├── field_mapping.py │ ├── field_term_location_map.py │ ├── file_metadata.py │ ├── filter_cache.py │ ├── filter_operator_id.py │ ├── form_display.py │ ├── generic_indicator_update_batch.py │ ├── generic_string_date_filter.py │ ├── generic_string_filter.py │ ├── grid_column.py │ ├── group.py │ ├── groups.py │ ├── human_cron.py │ ├── important.py │ ├── incident.py │ ├── incident_field.py │ ├── incident_filter.py │ ├── incident_search_response_wrapper.py │ ├── incident_status.py │ ├── incident_type.py │ ├── incident_wrapper.py │ ├── incidents.py │ ├── indicator_context.py │ ├── indicator_edit_bulk_response.py │ ├── indicator_filter.py │ ├── indicator_result.py │ ├── inline_response200.py │ ├── insight_cache.py │ ├── instance_classifier.py │ ├── integration_script.py │ ├── inv_playbook_assignee.py │ ├── inv_playbook_due.py │ ├── inv_playbook_task_complete_data.py │ ├── inv_playbook_task_data.py │ ├── inv_task_info.py │ ├── investigation.py │ ├── investigation_filter.py │ ├── investigation_playbook.py │ ├── investigation_playbook_data.py │ ├── investigation_playbook_state.py │ ├── investigation_playbook_task.py │ ├── investigation_playbook_tasks_api.py │ ├── investigation_search_response.py │ ├── investigation_status.py │ ├── investigation_type.py │ ├── investigations.py │ ├── ioc_object.py │ ├── ioc_objects.py │ ├── label.py │ ├── layout.py │ ├── layout_api.py │ ├── layout_field.py │ ├── layout_section.py │ ├── location.py │ ├── locations.py │ ├── mapper.py │ ├── module_args.py │ ├── module_configuration.py │ ├── new_docker_image.py │ ├── new_docker_image_result.py │ ├── notifiable_item.py │ ├── notify_timings.py │ ├── operator_argument.py │ ├── order.py │ ├── output.py │ ├── output_type.py │ ├── period.py │ ├── playbook.py │ ├── playbook_input.py │ ├── playbook_inputs.py │ ├── playbook_output.py │ ├── playbook_outputs.py │ ├── playbook_task.py │ ├── playbook_view.py │ ├── question.py │ ├── quiet_mode.py │ ├── raw_feed_indicator.py │ ├── raw_message.py │ ├── reliability.py │ ├── remote_repos.py │ ├── report.py │ ├── report_automation.py │ ├── report_fields_decoder.py │ ├── report_query.py │ ├── reputation.py │ ├── reputation_calc_alg.py │ ├── reputation_data.py │ ├── reputations_with_errors.py │ ├── run_status.py │ ├── script_api.py │ ├── script_sub_type.py │ ├── script_target.py │ ├── script_type.py │ ├── search_incidents_data.py │ ├── section.py │ ├── section_item.py │ ├── severity.py │ ├── sla.py │ ├── sla_state.py │ ├── stats_query_response.py │ ├── stats_text_response.py │ ├── stats_trends_response.py │ ├── system.py │ ├── system_agent.py │ ├── task.py │ ├── task_condition.py │ ├── task_loop.py │ ├── task_state.py │ ├── task_type.py │ ├── task_view.py │ ├── term_location_map.py │ ├── terminal_options.py │ ├── timer_action.py │ ├── timer_trigger.py │ ├── transformer_operator_id.py │ ├── update_data_batch.py │ ├── update_entry.py │ ├── update_entry_tags.py │ ├── update_indicator_reputation_data.py │ ├── update_response.py │ ├── uploaded_entry.py │ ├── version.py │ ├── widget.py │ ├── widget_cell.py │ └── widget_cells.py │ └── rest.py ├── docs ├── AdvanceArg.md ├── ArgAtomicFilter.md ├── ArgFilter.md ├── ArgTransformer.md ├── Argument.md ├── ArrayPositions.md ├── Attachment.md ├── Audit.md ├── AuditResult.md ├── AutomationScript.md ├── AutomationScriptAPI.md ├── AutomationScriptFilter.md ├── AutomationScriptFilterWrapper.md ├── AutomationScriptResult.md ├── Command.md ├── CommonFields.md ├── ComplexArg.md ├── ConfigDataType.md ├── ConfigField.md ├── CreateIncidentRequest.md ├── CustomFields.md ├── DBotScore.md ├── Dashboard.md ├── DataCollectionForm.md ├── DateRange.md ├── DateRangeFilter.md ├── DefaultApi.md ├── DeleteEvidence.md ├── DockerImage.md ├── DockerImagesResult.md ├── DownloadEntry.md ├── Duration.md ├── EndingType.md ├── Entry.md ├── EntryCategory.md ├── EntryHistory.md ├── EntryReputation.md ├── EntryTask.md ├── EntryType.md ├── Evidence.md ├── EvidenceData.md ├── Evidences.md ├── EvidencesFilterWrapper.md ├── EvidencesSearchResponse.md ├── ExpirationPolicy.md ├── ExpirationSettingsSource.md ├── ExpirationSource.md ├── FeedIndicator.md ├── FeedIndicators.md ├── FeedIndicatorsRequest.md ├── FieldGroup.md ├── FieldMapping.md ├── FieldTermLocationMap.md ├── FileMetadata.md ├── FilterCache.md ├── FilterOperatorID.md ├── FormDisplay.md ├── GenericIndicatorUpdateBatch.md ├── GenericStringDateFilter.md ├── GenericStringFilter.md ├── GridColumn.md ├── Group.md ├── Groups.md ├── HumanCron.md ├── Important.md ├── Incident.md ├── IncidentField.md ├── IncidentFilter.md ├── IncidentSearchResponseWrapper.md ├── IncidentStatus.md ├── IncidentType.md ├── IncidentWrapper.md ├── Incidents.md ├── IndicatorContext.md ├── IndicatorEditBulkResponse.md ├── IndicatorFilter.md ├── IndicatorResult.md ├── InlineResponse200.md ├── InsightCache.md ├── InstanceClassifier.md ├── IntegrationScript.md ├── InvPlaybookAssignee.md ├── InvPlaybookDue.md ├── InvPlaybookTaskCompleteData.md ├── InvPlaybookTaskData.md ├── InvTaskInfo.md ├── Investigation.md ├── InvestigationFilter.md ├── InvestigationPlaybook.md ├── InvestigationPlaybookData.md ├── InvestigationPlaybookState.md ├── InvestigationPlaybookTask.md ├── InvestigationPlaybookTasksAPI.md ├── InvestigationSearchResponse.md ├── InvestigationStatus.md ├── InvestigationType.md ├── Investigations.md ├── IocObject.md ├── IocObjects.md ├── Label.md ├── Layout.md ├── LayoutAPI.md ├── LayoutField.md ├── LayoutSection.md ├── Location.md ├── Locations.md ├── Mapper.md ├── ModuleArgs.md ├── ModuleConfiguration.md ├── NewDockerImage.md ├── NewDockerImageResult.md ├── NotifiableItem.md ├── NotifyTimings.md ├── OperatorArgument.md ├── Order.md ├── Output.md ├── OutputType.md ├── Period.md ├── Playbook.md ├── PlaybookInput.md ├── PlaybookInputs.md ├── PlaybookOutput.md ├── PlaybookOutputs.md ├── PlaybookTask.md ├── PlaybookView.md ├── Question.md ├── QuietMode.md ├── README.md ├── RawFeedIndicator.md ├── RawMessage.md ├── Reliability.md ├── RemoteRepos.md ├── Report.md ├── ReportAutomation.md ├── ReportFieldsDecoder.md ├── ReportQuery.md ├── Reputation.md ├── ReputationCalcAlg.md ├── ReputationData.md ├── ReputationsWithErrors.md ├── RunStatus.md ├── SLA.md ├── SLAState.md ├── ScriptAPI.md ├── ScriptSubType.md ├── ScriptTarget.md ├── ScriptType.md ├── SearchIncidentsData.md ├── Section.md ├── SectionItem.md ├── Severity.md ├── StatsQueryResponse.md ├── StatsTextResponse.md ├── StatsTrendsResponse.md ├── System.md ├── SystemAgent.md ├── Task.md ├── TaskCondition.md ├── TaskLoop.md ├── TaskState.md ├── TaskType.md ├── TaskView.md ├── TermLocationMap.md ├── TerminalOptions.md ├── TimerAction.md ├── TimerTrigger.md ├── TransformerOperatorID.md ├── UpdateDataBatch.md ├── UpdateEntry.md ├── UpdateEntryTags.md ├── UpdateIndicatorReputationData.md ├── UpdateResponse.md ├── UploadedEntry.md ├── Version.md ├── Widget.md ├── WidgetCell.md └── WidgetCells.md ├── examples ├── batch_util_example.py ├── create_incident_example.py ├── download_file_example.py ├── incidents_search_example.py ├── indicators_search_example.py ├── update_automation_example.py └── widget_upload.py ├── gen-code.sh ├── poetry.lock ├── poetry.toml ├── pyproject.toml ├── server_api_swagger.json ├── swagger-config.json ├── tests ├── examples_test.py ├── mocks_test.py └── tests_data │ ├── layout-details-test-V2.json │ └── layoutscontainer-test.json └── verify.sh /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: '' 6 | assignees: amshamah419 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Steps to reproduce the behavior: 15 | 1. 16 | 2. 17 | 3. 18 | 4. See error 19 | 20 | **Expected behavior** 21 | A clear and concise description of what you expected to happen. 22 | 23 | **Screenshots** 24 | If applicable, add screenshots to help explain your problem. 25 | 26 | **Additional context** 27 | Add any other context about the problem here. 28 | -------------------------------------------------------------------------------- /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | ## Status 4 | Ready/In Progress/In Hold (Reason for hold) 5 | 6 | ## Related Issues 7 | fixes: link to the issue 8 | 9 | ## Description 10 | A few sentences describing the overall goals of the pull request's commits. 11 | 12 | ## Must have 13 | - [ ] Unit Test or Example Code 14 | - [ ] Changelog entry 15 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | 27 | # PyInstaller 28 | # Usually these files are written by a python script from a template 29 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 30 | *.manifest 31 | *.spec 32 | 33 | # Installer logs 34 | pip-log.txt 35 | pip-delete-this-directory.txt 36 | 37 | # Unit test / coverage reports 38 | htmlcov/ 39 | .tox/ 40 | .coverage 41 | .coverage.* 42 | .cache 43 | nosetests.xml 44 | coverage.xml 45 | *,cover 46 | .hypothesis/ 47 | 48 | # Translations 49 | *.mo 50 | *.pot 51 | 52 | # Django stuff: 53 | *.log 54 | local_settings.py 55 | 56 | # Flask stuff: 57 | instance/ 58 | .webassets-cache 59 | 60 | # Scrapy stuff: 61 | .scrapy 62 | 63 | # Sphinx documentation 64 | docs/_build/ 65 | 66 | # PyBuilder 67 | target/ 68 | 69 | # IPython Notebook 70 | .ipynb_checkpoints 71 | 72 | # pyenv 73 | .python-version 74 | 75 | # celery beat schedule file 76 | celerybeat-schedule 77 | 78 | # dotenv 79 | .env 80 | 81 | # virtualenv 82 | venv*/ 83 | ENV/ 84 | 85 | # Spyder project settings 86 | .spyderproject 87 | 88 | # Rope project settings 89 | .ropeproject 90 | .travis.yml 91 | git_push.sh 92 | .swagger-codegen 93 | .vscode 94 | .pytest_cache 95 | py27 96 | py37 97 | 98 | # PyCharm configurtion files 99 | .idea/ -------------------------------------------------------------------------------- /.idea/vcs.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /.lgtm.yaml: -------------------------------------------------------------------------------- 1 | path_classifiers: 2 | test: 3 | - "/tests" 4 | example: 5 | - "/examples" 6 | generated: 7 | - "/demisto_client/demisto_api" 8 | -------------------------------------------------------------------------------- /.swagger-codegen-ignore: -------------------------------------------------------------------------------- 1 | # Swagger Codegen Ignore 2 | # Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen 3 | 4 | # Use this file to prevent files from being overwritten by the generator. 5 | # The patterns follow closely to .gitignore or .dockerignore. 6 | 7 | # As an example, the C# client generator defines ApiClient.cs. 8 | # You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line: 9 | #ApiClient.cs 10 | 11 | # You can match any string of characters against a directory, file or extension with a single asterisk (*): 12 | #foo/*/qux 13 | # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux 14 | 15 | # You can recursively match patterns against a directory, file or extension with a double asterisk (**): 16 | #foo/**/qux 17 | # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux 18 | 19 | # You can also negate patterns with an exclamation (!). 20 | # For example, you can ignore all files in a docs folder with the file extension .md: 21 | #docs/*.md 22 | # Then explicitly reverse the ignore rule for a single file: 23 | #!docs/README.md 24 | 25 | .gitignore 26 | poetry.lock 27 | pyproject.toml 28 | 29 | -------------------------------------------------------------------------------- /demisto_client/demisto_api/README.md: -------------------------------------------------------------------------------- 1 | # DO NOT MODIFY CODE IN THIS DIRECTORY OR SUB-DIRS. 2 | 3 | Use gen-code.sh to perform any changes needed in generated code. 4 | 5 | 6 | -------------------------------------------------------------------------------- /demisto_client/demisto_api/api/__init__.py: -------------------------------------------------------------------------------- 1 | from __future__ import absolute_import 2 | 3 | # flake8: noqa 4 | 5 | # import apis into api package 6 | from demisto_client.demisto_api.api.default_api import DefaultApi 7 | -------------------------------------------------------------------------------- /demisto_client/demisto_api/models/duration.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Demisto API 5 | 6 | This is the public REST API to integrate with the demisto server. HTTP request can be sent using any HTTP-client. For an example dedicated client take a look at: https://github.com/demisto/demisto-py. Requests must include API-key that can be generated in the Demisto web client under 'Settings' -> 'Integrations' -> 'API keys' Optimistic Locking and Versioning\\: When using Demisto REST API, you will need to make sure to work on the latest version of the item (incident, entry, etc.), otherwise, you will get a DB version error (which not allow you to override a newer item). In addition, you can pass 'version\\: -1' to force data override (make sure that other users data might be lost). Assume that Alice and Bob both read the same data from Demisto server, then they both changed the data, and then both tried to write the new versions back to the server. Whose changes should be saved? Alice’s? Bob’s? To solve this, each data item in Demisto has a numeric incremental version. If Alice saved an item with version 4 and Bob trying to save the same item with version 3, Demisto will rollback Bob request and returns a DB version conflict error. Bob will need to get the latest item and work on it so Alice work will not get lost. Example request using 'curl'\\: ``` curl 'https://hostname:443/incidents/search' -H 'content-type: application/json' -H 'accept: application/json' -H 'Authorization: ' --data-binary '{\"filter\":{\"query\":\"-status:closed -category:job\",\"period\":{\"by\":\"day\",\"fromValue\":7}}}' --compressed ``` # noqa: E501 7 | 8 | OpenAPI spec version: 2.0.0 9 | 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | 20 | class Duration(object): 21 | """NOTE: This class is auto generated by the swagger code generator program. 22 | 23 | Do not edit the class manually. 24 | """ 25 | 26 | """ 27 | Attributes: 28 | swagger_types (dict): The key is attribute name 29 | and the value is attribute type. 30 | attribute_map (dict): The key is attribute name 31 | and the value is json key in definition. 32 | """ 33 | swagger_types = { 34 | } 35 | 36 | attribute_map = { 37 | } 38 | 39 | def __init__(self): # noqa: E501 40 | """Duration - a model defined in Swagger""" # noqa: E501 41 | self.discriminator = None 42 | 43 | def to_dict(self): 44 | """Returns the model properties as a dict""" 45 | result = {} 46 | 47 | for attr, _ in six.iteritems(self.swagger_types): 48 | value = getattr(self, attr) 49 | if isinstance(value, list): 50 | result[attr] = list(map( 51 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 52 | value 53 | )) 54 | elif hasattr(value, "to_dict"): 55 | result[attr] = value.to_dict() 56 | elif isinstance(value, dict): 57 | result[attr] = dict(map( 58 | lambda item: (item[0], item[1].to_dict()) 59 | if hasattr(item[1], "to_dict") else item, 60 | value.items() 61 | )) 62 | else: 63 | result[attr] = value 64 | if issubclass(Duration, dict): 65 | for key, value in self.items(): 66 | result[key] = value 67 | 68 | return result 69 | 70 | def to_str(self): 71 | """Returns the string representation of the model""" 72 | return pprint.pformat(self.to_dict()) 73 | 74 | def __repr__(self): 75 | """For `print` and `pprint`""" 76 | return self.to_str() 77 | 78 | def __eq__(self, other): 79 | """Returns true if both objects are equal""" 80 | if not isinstance(other, Duration): 81 | return False 82 | 83 | return self.__dict__ == other.__dict__ 84 | 85 | def __ne__(self, other): 86 | """Returns true if both objects are not equal""" 87 | return not self == other 88 | -------------------------------------------------------------------------------- /demisto_client/demisto_api/models/ending_type.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Demisto API 5 | 6 | This is the public REST API to integrate with the demisto server. HTTP request can be sent using any HTTP-client. For an example dedicated client take a look at: https://github.com/demisto/demisto-py. Requests must include API-key that can be generated in the Demisto web client under 'Settings' -> 'Integrations' -> 'API keys' Optimistic Locking and Versioning\\: When using Demisto REST API, you will need to make sure to work on the latest version of the item (incident, entry, etc.), otherwise, you will get a DB version error (which not allow you to override a newer item). In addition, you can pass 'version\\: -1' to force data override (make sure that other users data might be lost). Assume that Alice and Bob both read the same data from Demisto server, then they both changed the data, and then both tried to write the new versions back to the server. Whose changes should be saved? Alice’s? Bob’s? To solve this, each data item in Demisto has a numeric incremental version. If Alice saved an item with version 4 and Bob trying to save the same item with version 3, Demisto will rollback Bob request and returns a DB version conflict error. Bob will need to get the latest item and work on it so Alice work will not get lost. Example request using 'curl'\\: ``` curl 'https://hostname:443/incidents/search' -H 'content-type: application/json' -H 'accept: application/json' -H 'Authorization: ' --data-binary '{\"filter\":{\"query\":\"-status:closed -category:job\",\"period\":{\"by\":\"day\",\"fromValue\":7}}}' --compressed ``` # noqa: E501 7 | 8 | OpenAPI spec version: 2.0.0 9 | 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | 20 | class EndingType(object): 21 | """NOTE: This class is auto generated by the swagger code generator program. 22 | 23 | Do not edit the class manually. 24 | """ 25 | 26 | """ 27 | Attributes: 28 | swagger_types (dict): The key is attribute name 29 | and the value is attribute type. 30 | attribute_map (dict): The key is attribute name 31 | and the value is json key in definition. 32 | """ 33 | swagger_types = { 34 | } 35 | 36 | attribute_map = { 37 | } 38 | 39 | def __init__(self): # noqa: E501 40 | """EndingType - a model defined in Swagger""" # noqa: E501 41 | self.discriminator = None 42 | 43 | def to_dict(self): 44 | """Returns the model properties as a dict""" 45 | result = {} 46 | 47 | for attr, _ in six.iteritems(self.swagger_types): 48 | value = getattr(self, attr) 49 | if isinstance(value, list): 50 | result[attr] = list(map( 51 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 52 | value 53 | )) 54 | elif hasattr(value, "to_dict"): 55 | result[attr] = value.to_dict() 56 | elif isinstance(value, dict): 57 | result[attr] = dict(map( 58 | lambda item: (item[0], item[1].to_dict()) 59 | if hasattr(item[1], "to_dict") else item, 60 | value.items() 61 | )) 62 | else: 63 | result[attr] = value 64 | if issubclass(EndingType, dict): 65 | for key, value in self.items(): 66 | result[key] = value 67 | 68 | return result 69 | 70 | def to_str(self): 71 | """Returns the string representation of the model""" 72 | return pprint.pformat(self.to_dict()) 73 | 74 | def __repr__(self): 75 | """For `print` and `pprint`""" 76 | return self.to_str() 77 | 78 | def __eq__(self, other): 79 | """Returns true if both objects are equal""" 80 | if not isinstance(other, EndingType): 81 | return False 82 | 83 | return self.__dict__ == other.__dict__ 84 | 85 | def __ne__(self, other): 86 | """Returns true if both objects are not equal""" 87 | return not self == other 88 | -------------------------------------------------------------------------------- /demisto_client/demisto_api/models/entry_type.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Demisto API 5 | 6 | This is the public REST API to integrate with the demisto server. HTTP request can be sent using any HTTP-client. For an example dedicated client take a look at: https://github.com/demisto/demisto-py. Requests must include API-key that can be generated in the Demisto web client under 'Settings' -> 'Integrations' -> 'API keys' Optimistic Locking and Versioning\\: When using Demisto REST API, you will need to make sure to work on the latest version of the item (incident, entry, etc.), otherwise, you will get a DB version error (which not allow you to override a newer item). In addition, you can pass 'version\\: -1' to force data override (make sure that other users data might be lost). Assume that Alice and Bob both read the same data from Demisto server, then they both changed the data, and then both tried to write the new versions back to the server. Whose changes should be saved? Alice’s? Bob’s? To solve this, each data item in Demisto has a numeric incremental version. If Alice saved an item with version 4 and Bob trying to save the same item with version 3, Demisto will rollback Bob request and returns a DB version conflict error. Bob will need to get the latest item and work on it so Alice work will not get lost. Example request using 'curl'\\: ``` curl 'https://hostname:443/incidents/search' -H 'content-type: application/json' -H 'accept: application/json' -H 'Authorization: ' --data-binary '{\"filter\":{\"query\":\"-status:closed -category:job\",\"period\":{\"by\":\"day\",\"fromValue\":7}}}' --compressed ``` # noqa: E501 7 | 8 | OpenAPI spec version: 2.0.0 9 | 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | 20 | class EntryType(object): 21 | """NOTE: This class is auto generated by the swagger code generator program. 22 | 23 | Do not edit the class manually. 24 | """ 25 | 26 | """ 27 | Attributes: 28 | swagger_types (dict): The key is attribute name 29 | and the value is attribute type. 30 | attribute_map (dict): The key is attribute name 31 | and the value is json key in definition. 32 | """ 33 | swagger_types = { 34 | } 35 | 36 | attribute_map = { 37 | } 38 | 39 | def __init__(self): # noqa: E501 40 | """EntryType - a model defined in Swagger""" # noqa: E501 41 | self.discriminator = None 42 | 43 | def to_dict(self): 44 | """Returns the model properties as a dict""" 45 | result = {} 46 | 47 | for attr, _ in six.iteritems(self.swagger_types): 48 | value = getattr(self, attr) 49 | if isinstance(value, list): 50 | result[attr] = list(map( 51 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 52 | value 53 | )) 54 | elif hasattr(value, "to_dict"): 55 | result[attr] = value.to_dict() 56 | elif isinstance(value, dict): 57 | result[attr] = dict(map( 58 | lambda item: (item[0], item[1].to_dict()) 59 | if hasattr(item[1], "to_dict") else item, 60 | value.items() 61 | )) 62 | else: 63 | result[attr] = value 64 | if issubclass(EntryType, dict): 65 | for key, value in self.items(): 66 | result[key] = value 67 | 68 | return result 69 | 70 | def to_str(self): 71 | """Returns the string representation of the model""" 72 | return pprint.pformat(self.to_dict()) 73 | 74 | def __repr__(self): 75 | """For `print` and `pprint`""" 76 | return self.to_str() 77 | 78 | def __eq__(self, other): 79 | """Returns true if both objects are equal""" 80 | if not isinstance(other, EntryType): 81 | return False 82 | 83 | return self.__dict__ == other.__dict__ 84 | 85 | def __ne__(self, other): 86 | """Returns true if both objects are not equal""" 87 | return not self == other 88 | -------------------------------------------------------------------------------- /demisto_client/demisto_api/models/field_group.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Demisto API 5 | 6 | This is the public REST API to integrate with the demisto server. HTTP request can be sent using any HTTP-client. For an example dedicated client take a look at: https://github.com/demisto/demisto-py. Requests must include API-key that can be generated in the Demisto web client under 'Settings' -> 'Integrations' -> 'API keys' Optimistic Locking and Versioning\\: When using Demisto REST API, you will need to make sure to work on the latest version of the item (incident, entry, etc.), otherwise, you will get a DB version error (which not allow you to override a newer item). In addition, you can pass 'version\\: -1' to force data override (make sure that other users data might be lost). Assume that Alice and Bob both read the same data from Demisto server, then they both changed the data, and then both tried to write the new versions back to the server. Whose changes should be saved? Alice’s? Bob’s? To solve this, each data item in Demisto has a numeric incremental version. If Alice saved an item with version 4 and Bob trying to save the same item with version 3, Demisto will rollback Bob request and returns a DB version conflict error. Bob will need to get the latest item and work on it so Alice work will not get lost. Example request using 'curl'\\: ``` curl 'https://hostname:443/incidents/search' -H 'content-type: application/json' -H 'accept: application/json' -H 'Authorization: ' --data-binary '{\"filter\":{\"query\":\"-status:closed -category:job\",\"period\":{\"by\":\"day\",\"fromValue\":7}}}' --compressed ``` # noqa: E501 7 | 8 | OpenAPI spec version: 2.0.0 9 | 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | 20 | class FieldGroup(object): 21 | """NOTE: This class is auto generated by the swagger code generator program. 22 | 23 | Do not edit the class manually. 24 | """ 25 | 26 | """ 27 | Attributes: 28 | swagger_types (dict): The key is attribute name 29 | and the value is attribute type. 30 | attribute_map (dict): The key is attribute name 31 | and the value is json key in definition. 32 | """ 33 | swagger_types = { 34 | } 35 | 36 | attribute_map = { 37 | } 38 | 39 | def __init__(self): # noqa: E501 40 | """FieldGroup - a model defined in Swagger""" # noqa: E501 41 | self.discriminator = None 42 | 43 | def to_dict(self): 44 | """Returns the model properties as a dict""" 45 | result = {} 46 | 47 | for attr, _ in six.iteritems(self.swagger_types): 48 | value = getattr(self, attr) 49 | if isinstance(value, list): 50 | result[attr] = list(map( 51 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 52 | value 53 | )) 54 | elif hasattr(value, "to_dict"): 55 | result[attr] = value.to_dict() 56 | elif isinstance(value, dict): 57 | result[attr] = dict(map( 58 | lambda item: (item[0], item[1].to_dict()) 59 | if hasattr(item[1], "to_dict") else item, 60 | value.items() 61 | )) 62 | else: 63 | result[attr] = value 64 | if issubclass(FieldGroup, dict): 65 | for key, value in self.items(): 66 | result[key] = value 67 | 68 | return result 69 | 70 | def to_str(self): 71 | """Returns the string representation of the model""" 72 | return pprint.pformat(self.to_dict()) 73 | 74 | def __repr__(self): 75 | """For `print` and `pprint`""" 76 | return self.to_str() 77 | 78 | def __eq__(self, other): 79 | """Returns true if both objects are equal""" 80 | if not isinstance(other, FieldGroup): 81 | return False 82 | 83 | return self.__dict__ == other.__dict__ 84 | 85 | def __ne__(self, other): 86 | """Returns true if both objects are not equal""" 87 | return not self == other 88 | -------------------------------------------------------------------------------- /demisto_client/demisto_api/models/incidents.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Demisto API 5 | 6 | This is the public REST API to integrate with the demisto server. HTTP request can be sent using any HTTP-client. For an example dedicated client take a look at: https://github.com/demisto/demisto-py. Requests must include API-key that can be generated in the Demisto web client under 'Settings' -> 'Integrations' -> 'API keys' Optimistic Locking and Versioning\\: When using Demisto REST API, you will need to make sure to work on the latest version of the item (incident, entry, etc.), otherwise, you will get a DB version error (which not allow you to override a newer item). In addition, you can pass 'version\\: -1' to force data override (make sure that other users data might be lost). Assume that Alice and Bob both read the same data from Demisto server, then they both changed the data, and then both tried to write the new versions back to the server. Whose changes should be saved? Alice’s? Bob’s? To solve this, each data item in Demisto has a numeric incremental version. If Alice saved an item with version 4 and Bob trying to save the same item with version 3, Demisto will rollback Bob request and returns a DB version conflict error. Bob will need to get the latest item and work on it so Alice work will not get lost. Example request using 'curl'\\: ``` curl 'https://hostname:443/incidents/search' -H 'content-type: application/json' -H 'accept: application/json' -H 'Authorization: ' --data-binary '{\"filter\":{\"query\":\"-status:closed -category:job\",\"period\":{\"by\":\"day\",\"fromValue\":7}}}' --compressed ``` # noqa: E501 7 | 8 | OpenAPI spec version: 2.0.0 9 | 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | 20 | class Incidents(object): 21 | """NOTE: This class is auto generated by the swagger code generator program. 22 | 23 | Do not edit the class manually. 24 | """ 25 | 26 | """ 27 | Attributes: 28 | swagger_types (dict): The key is attribute name 29 | and the value is attribute type. 30 | attribute_map (dict): The key is attribute name 31 | and the value is json key in definition. 32 | """ 33 | swagger_types = { 34 | } 35 | 36 | attribute_map = { 37 | } 38 | 39 | def __init__(self): # noqa: E501 40 | """Incidents - a model defined in Swagger""" # noqa: E501 41 | self.discriminator = None 42 | 43 | def to_dict(self): 44 | """Returns the model properties as a dict""" 45 | result = {} 46 | 47 | for attr, _ in six.iteritems(self.swagger_types): 48 | value = getattr(self, attr) 49 | if isinstance(value, list): 50 | result[attr] = list(map( 51 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 52 | value 53 | )) 54 | elif hasattr(value, "to_dict"): 55 | result[attr] = value.to_dict() 56 | elif isinstance(value, dict): 57 | result[attr] = dict(map( 58 | lambda item: (item[0], item[1].to_dict()) 59 | if hasattr(item[1], "to_dict") else item, 60 | value.items() 61 | )) 62 | else: 63 | result[attr] = value 64 | if issubclass(Incidents, dict): 65 | for key, value in self.items(): 66 | result[key] = value 67 | 68 | return result 69 | 70 | def to_str(self): 71 | """Returns the string representation of the model""" 72 | return pprint.pformat(self.to_dict()) 73 | 74 | def __repr__(self): 75 | """For `print` and `pprint`""" 76 | return self.to_str() 77 | 78 | def __eq__(self, other): 79 | """Returns true if both objects are equal""" 80 | if not isinstance(other, Incidents): 81 | return False 82 | 83 | return self.__dict__ == other.__dict__ 84 | 85 | def __ne__(self, other): 86 | """Returns true if both objects are not equal""" 87 | return not self == other 88 | -------------------------------------------------------------------------------- /demisto_client/demisto_api/models/module_args.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Demisto API 5 | 6 | This is the public REST API to integrate with the demisto server. HTTP request can be sent using any HTTP-client. For an example dedicated client take a look at: https://github.com/demisto/demisto-py. Requests must include API-key that can be generated in the Demisto web client under 'Settings' -> 'Integrations' -> 'API keys' Optimistic Locking and Versioning\\: When using Demisto REST API, you will need to make sure to work on the latest version of the item (incident, entry, etc.), otherwise, you will get a DB version error (which not allow you to override a newer item). In addition, you can pass 'version\\: -1' to force data override (make sure that other users data might be lost). Assume that Alice and Bob both read the same data from Demisto server, then they both changed the data, and then both tried to write the new versions back to the server. Whose changes should be saved? Alice’s? Bob’s? To solve this, each data item in Demisto has a numeric incremental version. If Alice saved an item with version 4 and Bob trying to save the same item with version 3, Demisto will rollback Bob request and returns a DB version conflict error. Bob will need to get the latest item and work on it so Alice work will not get lost. Example request using 'curl'\\: ``` curl 'https://hostname:443/incidents/search' -H 'content-type: application/json' -H 'accept: application/json' -H 'Authorization: ' --data-binary '{\"filter\":{\"query\":\"-status:closed -category:job\",\"period\":{\"by\":\"day\",\"fromValue\":7}}}' --compressed ``` # noqa: E501 7 | 8 | OpenAPI spec version: 2.0.0 9 | 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | 20 | class ModuleArgs(dict): 21 | """NOTE: This class is auto generated by the swagger code generator program. 22 | 23 | Do not edit the class manually. 24 | """ 25 | 26 | """ 27 | Attributes: 28 | swagger_types (dict): The key is attribute name 29 | and the value is attribute type. 30 | attribute_map (dict): The key is attribute name 31 | and the value is json key in definition. 32 | """ 33 | swagger_types = { 34 | } 35 | 36 | attribute_map = { 37 | } 38 | 39 | def __init__(self): # noqa: E501 40 | """ModuleArgs - a model defined in Swagger""" # noqa: E501 41 | self.discriminator = None 42 | 43 | def to_dict(self): 44 | """Returns the model properties as a dict""" 45 | result = {} 46 | 47 | for attr, _ in six.iteritems(self.swagger_types): 48 | value = getattr(self, attr) 49 | if isinstance(value, list): 50 | result[attr] = list(map( 51 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 52 | value 53 | )) 54 | elif hasattr(value, "to_dict"): 55 | result[attr] = value.to_dict() 56 | elif isinstance(value, dict): 57 | result[attr] = dict(map( 58 | lambda item: (item[0], item[1].to_dict()) 59 | if hasattr(item[1], "to_dict") else item, 60 | value.items() 61 | )) 62 | else: 63 | result[attr] = value 64 | if issubclass(ModuleArgs, dict): 65 | for key, value in self.items(): 66 | result[key] = value 67 | 68 | return result 69 | 70 | def to_str(self): 71 | """Returns the string representation of the model""" 72 | return pprint.pformat(self.to_dict()) 73 | 74 | def __repr__(self): 75 | """For `print` and `pprint`""" 76 | return self.to_str() 77 | 78 | def __eq__(self, other): 79 | """Returns true if both objects are equal""" 80 | if not isinstance(other, ModuleArgs): 81 | return False 82 | 83 | return self.__dict__ == other.__dict__ 84 | 85 | def __ne__(self, other): 86 | """Returns true if both objects are not equal""" 87 | return not self == other 88 | -------------------------------------------------------------------------------- /demisto_client/demisto_api/models/quiet_mode.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Demisto API 5 | 6 | This is the public REST API to integrate with the demisto server. HTTP request can be sent using any HTTP-client. For an example dedicated client take a look at: https://github.com/demisto/demisto-py. Requests must include API-key that can be generated in the Demisto web client under 'Settings' -> 'Integrations' -> 'API keys' Optimistic Locking and Versioning\\: When using Demisto REST API, you will need to make sure to work on the latest version of the item (incident, entry, etc.), otherwise, you will get a DB version error (which not allow you to override a newer item). In addition, you can pass 'version\\: -1' to force data override (make sure that other users data might be lost). Assume that Alice and Bob both read the same data from Demisto server, then they both changed the data, and then both tried to write the new versions back to the server. Whose changes should be saved? Alice’s? Bob’s? To solve this, each data item in Demisto has a numeric incremental version. If Alice saved an item with version 4 and Bob trying to save the same item with version 3, Demisto will rollback Bob request and returns a DB version conflict error. Bob will need to get the latest item and work on it so Alice work will not get lost. Example request using 'curl'\\: ``` curl 'https://hostname:443/incidents/search' -H 'content-type: application/json' -H 'accept: application/json' -H 'Authorization: ' --data-binary '{\"filter\":{\"query\":\"-status:closed -category:job\",\"period\":{\"by\":\"day\",\"fromValue\":7}}}' --compressed ``` # noqa: E501 7 | 8 | OpenAPI spec version: 2.0.0 9 | 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | 20 | class QuietMode(object): 21 | """NOTE: This class is auto generated by the swagger code generator program. 22 | 23 | Do not edit the class manually. 24 | """ 25 | 26 | """ 27 | Attributes: 28 | swagger_types (dict): The key is attribute name 29 | and the value is attribute type. 30 | attribute_map (dict): The key is attribute name 31 | and the value is json key in definition. 32 | """ 33 | swagger_types = { 34 | } 35 | 36 | attribute_map = { 37 | } 38 | 39 | def __init__(self): # noqa: E501 40 | """QuietMode - a model defined in Swagger""" # noqa: E501 41 | self.discriminator = None 42 | 43 | def to_dict(self): 44 | """Returns the model properties as a dict""" 45 | result = {} 46 | 47 | for attr, _ in six.iteritems(self.swagger_types): 48 | value = getattr(self, attr) 49 | if isinstance(value, list): 50 | result[attr] = list(map( 51 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 52 | value 53 | )) 54 | elif hasattr(value, "to_dict"): 55 | result[attr] = value.to_dict() 56 | elif isinstance(value, dict): 57 | result[attr] = dict(map( 58 | lambda item: (item[0], item[1].to_dict()) 59 | if hasattr(item[1], "to_dict") else item, 60 | value.items() 61 | )) 62 | else: 63 | result[attr] = value 64 | if issubclass(QuietMode, dict): 65 | for key, value in self.items(): 66 | result[key] = value 67 | 68 | return result 69 | 70 | def to_str(self): 71 | """Returns the string representation of the model""" 72 | return pprint.pformat(self.to_dict()) 73 | 74 | def __repr__(self): 75 | """For `print` and `pprint`""" 76 | return self.to_str() 77 | 78 | def __eq__(self, other): 79 | """Returns true if both objects are equal""" 80 | if not isinstance(other, QuietMode): 81 | return False 82 | 83 | return self.__dict__ == other.__dict__ 84 | 85 | def __ne__(self, other): 86 | """Returns true if both objects are not equal""" 87 | return not self == other 88 | -------------------------------------------------------------------------------- /demisto_client/demisto_api/models/run_status.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Demisto API 5 | 6 | This is the public REST API to integrate with the demisto server. HTTP request can be sent using any HTTP-client. For an example dedicated client take a look at: https://github.com/demisto/demisto-py. Requests must include API-key that can be generated in the Demisto web client under 'Settings' -> 'Integrations' -> 'API keys' Optimistic Locking and Versioning\\: When using Demisto REST API, you will need to make sure to work on the latest version of the item (incident, entry, etc.), otherwise, you will get a DB version error (which not allow you to override a newer item). In addition, you can pass 'version\\: -1' to force data override (make sure that other users data might be lost). Assume that Alice and Bob both read the same data from Demisto server, then they both changed the data, and then both tried to write the new versions back to the server. Whose changes should be saved? Alice’s? Bob’s? To solve this, each data item in Demisto has a numeric incremental version. If Alice saved an item with version 4 and Bob trying to save the same item with version 3, Demisto will rollback Bob request and returns a DB version conflict error. Bob will need to get the latest item and work on it so Alice work will not get lost. Example request using 'curl'\\: ``` curl 'https://hostname:443/incidents/search' -H 'content-type: application/json' -H 'accept: application/json' -H 'Authorization: ' --data-binary '{\"filter\":{\"query\":\"-status:closed -category:job\",\"period\":{\"by\":\"day\",\"fromValue\":7}}}' --compressed ``` # noqa: E501 7 | 8 | OpenAPI spec version: 2.0.0 9 | 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | 20 | class RunStatus(object): 21 | """NOTE: This class is auto generated by the swagger code generator program. 22 | 23 | Do not edit the class manually. 24 | """ 25 | 26 | """ 27 | Attributes: 28 | swagger_types (dict): The key is attribute name 29 | and the value is attribute type. 30 | attribute_map (dict): The key is attribute name 31 | and the value is json key in definition. 32 | """ 33 | swagger_types = { 34 | } 35 | 36 | attribute_map = { 37 | } 38 | 39 | def __init__(self): # noqa: E501 40 | """RunStatus - a model defined in Swagger""" # noqa: E501 41 | self.discriminator = None 42 | 43 | def to_dict(self): 44 | """Returns the model properties as a dict""" 45 | result = {} 46 | 47 | for attr, _ in six.iteritems(self.swagger_types): 48 | value = getattr(self, attr) 49 | if isinstance(value, list): 50 | result[attr] = list(map( 51 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 52 | value 53 | )) 54 | elif hasattr(value, "to_dict"): 55 | result[attr] = value.to_dict() 56 | elif isinstance(value, dict): 57 | result[attr] = dict(map( 58 | lambda item: (item[0], item[1].to_dict()) 59 | if hasattr(item[1], "to_dict") else item, 60 | value.items() 61 | )) 62 | else: 63 | result[attr] = value 64 | if issubclass(RunStatus, dict): 65 | for key, value in self.items(): 66 | result[key] = value 67 | 68 | return result 69 | 70 | def to_str(self): 71 | """Returns the string representation of the model""" 72 | return pprint.pformat(self.to_dict()) 73 | 74 | def __repr__(self): 75 | """For `print` and `pprint`""" 76 | return self.to_str() 77 | 78 | def __eq__(self, other): 79 | """Returns true if both objects are equal""" 80 | if not isinstance(other, RunStatus): 81 | return False 82 | 83 | return self.__dict__ == other.__dict__ 84 | 85 | def __ne__(self, other): 86 | """Returns true if both objects are not equal""" 87 | return not self == other 88 | -------------------------------------------------------------------------------- /demisto_client/demisto_api/models/severity.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Demisto API 5 | 6 | This is the public REST API to integrate with the demisto server. HTTP request can be sent using any HTTP-client. For an example dedicated client take a look at: https://github.com/demisto/demisto-py. Requests must include API-key that can be generated in the Demisto web client under 'Settings' -> 'Integrations' -> 'API keys' Optimistic Locking and Versioning\\: When using Demisto REST API, you will need to make sure to work on the latest version of the item (incident, entry, etc.), otherwise, you will get a DB version error (which not allow you to override a newer item). In addition, you can pass 'version\\: -1' to force data override (make sure that other users data might be lost). Assume that Alice and Bob both read the same data from Demisto server, then they both changed the data, and then both tried to write the new versions back to the server. Whose changes should be saved? Alice’s? Bob’s? To solve this, each data item in Demisto has a numeric incremental version. If Alice saved an item with version 4 and Bob trying to save the same item with version 3, Demisto will rollback Bob request and returns a DB version conflict error. Bob will need to get the latest item and work on it so Alice work will not get lost. Example request using 'curl'\\: ``` curl 'https://hostname:443/incidents/search' -H 'content-type: application/json' -H 'accept: application/json' -H 'Authorization: ' --data-binary '{\"filter\":{\"query\":\"-status:closed -category:job\",\"period\":{\"by\":\"day\",\"fromValue\":7}}}' --compressed ``` # noqa: E501 7 | 8 | OpenAPI spec version: 2.0.0 9 | 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | 20 | class Severity(object): 21 | """NOTE: This class is auto generated by the swagger code generator program. 22 | 23 | Do not edit the class manually. 24 | """ 25 | 26 | """ 27 | Attributes: 28 | swagger_types (dict): The key is attribute name 29 | and the value is attribute type. 30 | attribute_map (dict): The key is attribute name 31 | and the value is json key in definition. 32 | """ 33 | swagger_types = { 34 | } 35 | 36 | attribute_map = { 37 | } 38 | 39 | def __init__(self): # noqa: E501 40 | """Severity - a model defined in Swagger""" # noqa: E501 41 | self.discriminator = None 42 | 43 | def to_dict(self): 44 | """Returns the model properties as a dict""" 45 | result = {} 46 | 47 | for attr, _ in six.iteritems(self.swagger_types): 48 | value = getattr(self, attr) 49 | if isinstance(value, list): 50 | result[attr] = list(map( 51 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 52 | value 53 | )) 54 | elif hasattr(value, "to_dict"): 55 | result[attr] = value.to_dict() 56 | elif isinstance(value, dict): 57 | result[attr] = dict(map( 58 | lambda item: (item[0], item[1].to_dict()) 59 | if hasattr(item[1], "to_dict") else item, 60 | value.items() 61 | )) 62 | else: 63 | result[attr] = value 64 | if issubclass(Severity, dict): 65 | for key, value in self.items(): 66 | result[key] = value 67 | 68 | return result 69 | 70 | def to_str(self): 71 | """Returns the string representation of the model""" 72 | return pprint.pformat(self.to_dict()) 73 | 74 | def __repr__(self): 75 | """For `print` and `pprint`""" 76 | return self.to_str() 77 | 78 | def __eq__(self, other): 79 | """Returns true if both objects are equal""" 80 | if not isinstance(other, Severity): 81 | return False 82 | 83 | return self.__dict__ == other.__dict__ 84 | 85 | def __ne__(self, other): 86 | """Returns true if both objects are not equal""" 87 | return not self == other 88 | -------------------------------------------------------------------------------- /demisto_client/demisto_api/models/sla_state.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Demisto API 5 | 6 | This is the public REST API to integrate with the demisto server. HTTP request can be sent using any HTTP-client. For an example dedicated client take a look at: https://github.com/demisto/demisto-py. Requests must include API-key that can be generated in the Demisto web client under 'Settings' -> 'Integrations' -> 'API keys' Optimistic Locking and Versioning\\: When using Demisto REST API, you will need to make sure to work on the latest version of the item (incident, entry, etc.), otherwise, you will get a DB version error (which not allow you to override a newer item). In addition, you can pass 'version\\: -1' to force data override (make sure that other users data might be lost). Assume that Alice and Bob both read the same data from Demisto server, then they both changed the data, and then both tried to write the new versions back to the server. Whose changes should be saved? Alice’s? Bob’s? To solve this, each data item in Demisto has a numeric incremental version. If Alice saved an item with version 4 and Bob trying to save the same item with version 3, Demisto will rollback Bob request and returns a DB version conflict error. Bob will need to get the latest item and work on it so Alice work will not get lost. Example request using 'curl'\\: ``` curl 'https://hostname:443/incidents/search' -H 'content-type: application/json' -H 'accept: application/json' -H 'Authorization: ' --data-binary '{\"filter\":{\"query\":\"-status:closed -category:job\",\"period\":{\"by\":\"day\",\"fromValue\":7}}}' --compressed ``` # noqa: E501 7 | 8 | OpenAPI spec version: 2.0.0 9 | 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | 20 | class SLAState(object): 21 | """NOTE: This class is auto generated by the swagger code generator program. 22 | 23 | Do not edit the class manually. 24 | """ 25 | 26 | """ 27 | Attributes: 28 | swagger_types (dict): The key is attribute name 29 | and the value is attribute type. 30 | attribute_map (dict): The key is attribute name 31 | and the value is json key in definition. 32 | """ 33 | swagger_types = { 34 | } 35 | 36 | attribute_map = { 37 | } 38 | 39 | def __init__(self): # noqa: E501 40 | """SLAState - a model defined in Swagger""" # noqa: E501 41 | self.discriminator = None 42 | 43 | def to_dict(self): 44 | """Returns the model properties as a dict""" 45 | result = {} 46 | 47 | for attr, _ in six.iteritems(self.swagger_types): 48 | value = getattr(self, attr) 49 | if isinstance(value, list): 50 | result[attr] = list(map( 51 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 52 | value 53 | )) 54 | elif hasattr(value, "to_dict"): 55 | result[attr] = value.to_dict() 56 | elif isinstance(value, dict): 57 | result[attr] = dict(map( 58 | lambda item: (item[0], item[1].to_dict()) 59 | if hasattr(item[1], "to_dict") else item, 60 | value.items() 61 | )) 62 | else: 63 | result[attr] = value 64 | if issubclass(SLAState, dict): 65 | for key, value in self.items(): 66 | result[key] = value 67 | 68 | return result 69 | 70 | def to_str(self): 71 | """Returns the string representation of the model""" 72 | return pprint.pformat(self.to_dict()) 73 | 74 | def __repr__(self): 75 | """For `print` and `pprint`""" 76 | return self.to_str() 77 | 78 | def __eq__(self, other): 79 | """Returns true if both objects are equal""" 80 | if not isinstance(other, SLAState): 81 | return False 82 | 83 | return self.__dict__ == other.__dict__ 84 | 85 | def __ne__(self, other): 86 | """Returns true if both objects are not equal""" 87 | return not self == other 88 | -------------------------------------------------------------------------------- /demisto_client/demisto_api/models/task_state.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Demisto API 5 | 6 | This is the public REST API to integrate with the demisto server. HTTP request can be sent using any HTTP-client. For an example dedicated client take a look at: https://github.com/demisto/demisto-py. Requests must include API-key that can be generated in the Demisto web client under 'Settings' -> 'Integrations' -> 'API keys' Optimistic Locking and Versioning\\: When using Demisto REST API, you will need to make sure to work on the latest version of the item (incident, entry, etc.), otherwise, you will get a DB version error (which not allow you to override a newer item). In addition, you can pass 'version\\: -1' to force data override (make sure that other users data might be lost). Assume that Alice and Bob both read the same data from Demisto server, then they both changed the data, and then both tried to write the new versions back to the server. Whose changes should be saved? Alice’s? Bob’s? To solve this, each data item in Demisto has a numeric incremental version. If Alice saved an item with version 4 and Bob trying to save the same item with version 3, Demisto will rollback Bob request and returns a DB version conflict error. Bob will need to get the latest item and work on it so Alice work will not get lost. Example request using 'curl'\\: ``` curl 'https://hostname:443/incidents/search' -H 'content-type: application/json' -H 'accept: application/json' -H 'Authorization: ' --data-binary '{\"filter\":{\"query\":\"-status:closed -category:job\",\"period\":{\"by\":\"day\",\"fromValue\":7}}}' --compressed ``` # noqa: E501 7 | 8 | OpenAPI spec version: 2.0.0 9 | 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | 20 | class TaskState(object): 21 | """NOTE: This class is auto generated by the swagger code generator program. 22 | 23 | Do not edit the class manually. 24 | """ 25 | 26 | """ 27 | Attributes: 28 | swagger_types (dict): The key is attribute name 29 | and the value is attribute type. 30 | attribute_map (dict): The key is attribute name 31 | and the value is json key in definition. 32 | """ 33 | swagger_types = { 34 | } 35 | 36 | attribute_map = { 37 | } 38 | 39 | def __init__(self): # noqa: E501 40 | """TaskState - a model defined in Swagger""" # noqa: E501 41 | self.discriminator = None 42 | 43 | def to_dict(self): 44 | """Returns the model properties as a dict""" 45 | result = {} 46 | 47 | for attr, _ in six.iteritems(self.swagger_types): 48 | value = getattr(self, attr) 49 | if isinstance(value, list): 50 | result[attr] = list(map( 51 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 52 | value 53 | )) 54 | elif hasattr(value, "to_dict"): 55 | result[attr] = value.to_dict() 56 | elif isinstance(value, dict): 57 | result[attr] = dict(map( 58 | lambda item: (item[0], item[1].to_dict()) 59 | if hasattr(item[1], "to_dict") else item, 60 | value.items() 61 | )) 62 | else: 63 | result[attr] = value 64 | if issubclass(TaskState, dict): 65 | for key, value in self.items(): 66 | result[key] = value 67 | 68 | return result 69 | 70 | def to_str(self): 71 | """Returns the string representation of the model""" 72 | return pprint.pformat(self.to_dict()) 73 | 74 | def __repr__(self): 75 | """For `print` and `pprint`""" 76 | return self.to_str() 77 | 78 | def __eq__(self, other): 79 | """Returns true if both objects are equal""" 80 | if not isinstance(other, TaskState): 81 | return False 82 | 83 | return self.__dict__ == other.__dict__ 84 | 85 | def __ne__(self, other): 86 | """Returns true if both objects are not equal""" 87 | return not self == other 88 | -------------------------------------------------------------------------------- /demisto_client/demisto_api/models/task_type.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Demisto API 5 | 6 | This is the public REST API to integrate with the demisto server. HTTP request can be sent using any HTTP-client. For an example dedicated client take a look at: https://github.com/demisto/demisto-py. Requests must include API-key that can be generated in the Demisto web client under 'Settings' -> 'Integrations' -> 'API keys' Optimistic Locking and Versioning\\: When using Demisto REST API, you will need to make sure to work on the latest version of the item (incident, entry, etc.), otherwise, you will get a DB version error (which not allow you to override a newer item). In addition, you can pass 'version\\: -1' to force data override (make sure that other users data might be lost). Assume that Alice and Bob both read the same data from Demisto server, then they both changed the data, and then both tried to write the new versions back to the server. Whose changes should be saved? Alice’s? Bob’s? To solve this, each data item in Demisto has a numeric incremental version. If Alice saved an item with version 4 and Bob trying to save the same item with version 3, Demisto will rollback Bob request and returns a DB version conflict error. Bob will need to get the latest item and work on it so Alice work will not get lost. Example request using 'curl'\\: ``` curl 'https://hostname:443/incidents/search' -H 'content-type: application/json' -H 'accept: application/json' -H 'Authorization: ' --data-binary '{\"filter\":{\"query\":\"-status:closed -category:job\",\"period\":{\"by\":\"day\",\"fromValue\":7}}}' --compressed ``` # noqa: E501 7 | 8 | OpenAPI spec version: 2.0.0 9 | 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | 20 | class TaskType(object): 21 | """NOTE: This class is auto generated by the swagger code generator program. 22 | 23 | Do not edit the class manually. 24 | """ 25 | 26 | """ 27 | Attributes: 28 | swagger_types (dict): The key is attribute name 29 | and the value is attribute type. 30 | attribute_map (dict): The key is attribute name 31 | and the value is json key in definition. 32 | """ 33 | swagger_types = { 34 | } 35 | 36 | attribute_map = { 37 | } 38 | 39 | def __init__(self): # noqa: E501 40 | """TaskType - a model defined in Swagger""" # noqa: E501 41 | self.discriminator = None 42 | 43 | def to_dict(self): 44 | """Returns the model properties as a dict""" 45 | result = {} 46 | 47 | for attr, _ in six.iteritems(self.swagger_types): 48 | value = getattr(self, attr) 49 | if isinstance(value, list): 50 | result[attr] = list(map( 51 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 52 | value 53 | )) 54 | elif hasattr(value, "to_dict"): 55 | result[attr] = value.to_dict() 56 | elif isinstance(value, dict): 57 | result[attr] = dict(map( 58 | lambda item: (item[0], item[1].to_dict()) 59 | if hasattr(item[1], "to_dict") else item, 60 | value.items() 61 | )) 62 | else: 63 | result[attr] = value 64 | if issubclass(TaskType, dict): 65 | for key, value in self.items(): 66 | result[key] = value 67 | 68 | return result 69 | 70 | def to_str(self): 71 | """Returns the string representation of the model""" 72 | return pprint.pformat(self.to_dict()) 73 | 74 | def __repr__(self): 75 | """For `print` and `pprint`""" 76 | return self.to_str() 77 | 78 | def __eq__(self, other): 79 | """Returns true if both objects are equal""" 80 | if not isinstance(other, TaskType): 81 | return False 82 | 83 | return self.__dict__ == other.__dict__ 84 | 85 | def __ne__(self, other): 86 | """Returns true if both objects are not equal""" 87 | return not self == other 88 | -------------------------------------------------------------------------------- /demisto_client/demisto_api/models/task_view.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Demisto API 5 | 6 | This is the public REST API to integrate with the demisto server. HTTP request can be sent using any HTTP-client. For an example dedicated client take a look at: https://github.com/demisto/demisto-py. Requests must include API-key that can be generated in the Demisto web client under 'Settings' -> 'Integrations' -> 'API keys' Optimistic Locking and Versioning\\: When using Demisto REST API, you will need to make sure to work on the latest version of the item (incident, entry, etc.), otherwise, you will get a DB version error (which not allow you to override a newer item). In addition, you can pass 'version\\: -1' to force data override (make sure that other users data might be lost). Assume that Alice and Bob both read the same data from Demisto server, then they both changed the data, and then both tried to write the new versions back to the server. Whose changes should be saved? Alice’s? Bob’s? To solve this, each data item in Demisto has a numeric incremental version. If Alice saved an item with version 4 and Bob trying to save the same item with version 3, Demisto will rollback Bob request and returns a DB version conflict error. Bob will need to get the latest item and work on it so Alice work will not get lost. Example request using 'curl'\\: ``` curl 'https://hostname:443/incidents/search' -H 'content-type: application/json' -H 'accept: application/json' -H 'Authorization: ' --data-binary '{\"filter\":{\"query\":\"-status:closed -category:job\",\"period\":{\"by\":\"day\",\"fromValue\":7}}}' --compressed ``` # noqa: E501 7 | 8 | OpenAPI spec version: 2.0.0 9 | 10 | Generated by: https://github.com/swagger-api/swagger-codegen.git 11 | """ 12 | 13 | 14 | import pprint 15 | import re # noqa: F401 16 | 17 | import six 18 | 19 | 20 | class TaskView(object): 21 | """NOTE: This class is auto generated by the swagger code generator program. 22 | 23 | Do not edit the class manually. 24 | """ 25 | 26 | """ 27 | Attributes: 28 | swagger_types (dict): The key is attribute name 29 | and the value is attribute type. 30 | attribute_map (dict): The key is attribute name 31 | and the value is json key in definition. 32 | """ 33 | swagger_types = { 34 | } 35 | 36 | attribute_map = { 37 | } 38 | 39 | def __init__(self): # noqa: E501 40 | """TaskView - a model defined in Swagger""" # noqa: E501 41 | self.discriminator = None 42 | 43 | def to_dict(self): 44 | """Returns the model properties as a dict""" 45 | result = {} 46 | 47 | for attr, _ in six.iteritems(self.swagger_types): 48 | value = getattr(self, attr) 49 | if isinstance(value, list): 50 | result[attr] = list(map( 51 | lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 52 | value 53 | )) 54 | elif hasattr(value, "to_dict"): 55 | result[attr] = value.to_dict() 56 | elif isinstance(value, dict): 57 | result[attr] = dict(map( 58 | lambda item: (item[0], item[1].to_dict()) 59 | if hasattr(item[1], "to_dict") else item, 60 | value.items() 61 | )) 62 | else: 63 | result[attr] = value 64 | if issubclass(TaskView, dict): 65 | for key, value in self.items(): 66 | result[key] = value 67 | 68 | return result 69 | 70 | def to_str(self): 71 | """Returns the string representation of the model""" 72 | return pprint.pformat(self.to_dict()) 73 | 74 | def __repr__(self): 75 | """For `print` and `pprint`""" 76 | return self.to_str() 77 | 78 | def __eq__(self, other): 79 | """Returns true if both objects are equal""" 80 | if not isinstance(other, TaskView): 81 | return False 82 | 83 | return self.__dict__ == other.__dict__ 84 | 85 | def __ne__(self, other): 86 | """Returns true if both objects are not equal""" 87 | return not self == other 88 | -------------------------------------------------------------------------------- /docs/AdvanceArg.md: -------------------------------------------------------------------------------- 1 | # AdvanceArg 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **complex** | [**ComplexArg**](ComplexArg.md) | | [optional] 7 | **simple** | **str** | | [optional] 8 | 9 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ArgAtomicFilter.md: -------------------------------------------------------------------------------- 1 | # ArgAtomicFilter 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **ignore_case** | **bool** | | [optional] 7 | **left** | [**OperatorArgument**](OperatorArgument.md) | | [optional] 8 | **operator** | [**FilterOperatorID**](FilterOperatorID.md) | | [optional] 9 | **right** | [**OperatorArgument**](OperatorArgument.md) | | [optional] 10 | **type** | **str** | | [optional] 11 | 12 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/ArgFilter.md: -------------------------------------------------------------------------------- 1 | # ArgFilter 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ArgTransformer.md: -------------------------------------------------------------------------------- 1 | # ArgTransformer 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **args** | **object** | | [optional] 7 | **operator** | [**TransformerOperatorID**](TransformerOperatorID.md) | | [optional] 8 | 9 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Argument.md: -------------------------------------------------------------------------------- 1 | # Argument 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **auto** | **str** | | [optional] 7 | **default** | **bool** | | [optional] 8 | **default_value** | **str** | | [optional] 9 | **deprecated** | **bool** | | [optional] 10 | **description** | **str** | | [optional] 11 | **is_array** | **bool** | | [optional] 12 | **name** | **str** | | [optional] 13 | **predefined** | **list[str]** | | [optional] 14 | **required** | **bool** | | [optional] 15 | **secret** | **bool** | | [optional] 16 | 17 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/ArrayPositions.md: -------------------------------------------------------------------------------- 1 | # ArrayPositions 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/Attachment.md: -------------------------------------------------------------------------------- 1 | # Attachment 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **description** | **str** | | [optional] 7 | **name** | **str** | | [optional] 8 | **path** | **str** | | [optional] 9 | **show_media_file** | **bool** | | [optional] 10 | **type** | **str** | | [optional] 11 | 12 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/Audit.md: -------------------------------------------------------------------------------- 1 | # Audit 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **action** | **dict(str, object)** | | [optional] 7 | **id** | **str** | | [optional] 8 | **identifier** | **str** | | [optional] 9 | **modified** | **datetime** | | [optional] 10 | **object** | **str** | | [optional] 11 | **sort_values** | **list[str]** | | [optional] 12 | **type** | **str** | | [optional] 13 | **user** | **str** | | [optional] 14 | **version** | **int** | | [optional] 15 | 16 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/AuditResult.md: -------------------------------------------------------------------------------- 1 | # AuditResult 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **audits** | [**list[Audit]**](Audit.md) | | [optional] 7 | **total** | **int** | | [optional] 8 | 9 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/AutomationScript.md: -------------------------------------------------------------------------------- 1 | # AutomationScript 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **arguments** | [**list[Argument]**](Argument.md) | | [optional] 7 | **comment** | **str** | | [optional] 8 | **commit_message** | **str** | | [optional] 9 | **context_keys** | **list[str]** | | [optional] 10 | **depends_on** | **dict(str, list[str])** | This fields indicates which commands this script depends on | [optional] 11 | **deprecated** | **bool** | | [optional] 12 | **docker_image** | **str** | | [optional] 13 | **enabled** | **bool** | | [optional] 14 | **has_role** | **bool** | Internal field to make queries on role faster | [optional] 15 | **hidden** | **bool** | | [optional] 16 | **id** | **str** | | [optional] 17 | **important** | [**list[Important]**](Important.md) | | [optional] 18 | **locked** | **bool** | | [optional] 19 | **modified** | **datetime** | | [optional] 20 | **name** | **str** | | [optional] 21 | **outputs** | [**list[Output]**](Output.md) | | [optional] 22 | **prev_name** | **str** | | [optional] 23 | **previous_roles** | **list[str]** | PreviousRoleName - do not change this field manually | [optional] 24 | **pswd** | **str** | | [optional] 25 | **raw_tags** | **list[str]** | | [optional] 26 | **roles** | **list[str]** | The role assigned to this investigation | [optional] 27 | **run_as** | **str** | | [optional] 28 | **run_once** | **bool** | | [optional] 29 | **script** | **str** | | [optional] 30 | **script_target** | [**ScriptTarget**](ScriptTarget.md) | | [optional] 31 | **searchable_name** | **str** | | [optional] 32 | **sensitive** | **bool** | | [optional] 33 | **should_commit** | **bool** | | [optional] 34 | **sort_values** | **list[str]** | | [optional] 35 | **subtype** | [**ScriptSubType**](ScriptSubType.md) | | [optional] 36 | **system** | **bool** | | [optional] 37 | **tags** | **list[str]** | | [optional] 38 | **timeout** | [**Duration**](Duration.md) | | [optional] 39 | **type** | [**ScriptType**](ScriptType.md) | | [optional] 40 | **user** | **str** | | [optional] 41 | **vc_should_ignore** | **bool** | | [optional] 42 | **version** | **int** | | [optional] 43 | **visual_script** | **str** | | [optional] 44 | 45 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 46 | 47 | 48 | -------------------------------------------------------------------------------- /docs/AutomationScriptAPI.md: -------------------------------------------------------------------------------- 1 | # AutomationScriptAPI 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **arguments** | [**list[Argument]**](Argument.md) | | [optional] 7 | **comment** | **str** | | [optional] 8 | **context_keys** | **list[str]** | | [optional] 9 | **depends_on** | **dict(str, list[str])** | | [optional] 10 | **deprecated** | **bool** | | [optional] 11 | **docker_image** | **str** | | [optional] 12 | **enabled** | **bool** | | [optional] 13 | **hidden** | **bool** | | [optional] 14 | **id** | **str** | | [optional] 15 | **locked** | **bool** | | [optional] 16 | **modified** | **datetime** | | [optional] 17 | **name** | **str** | | [optional] 18 | **outputs** | [**list[Output]**](Output.md) | | [optional] 19 | **permitted** | **bool** | | [optional] 20 | **roles** | **list[str]** | | [optional] 21 | **run_as** | **str** | | [optional] 22 | **script_target** | [**ScriptTarget**](ScriptTarget.md) | | [optional] 23 | **system** | **bool** | | [optional] 24 | **tags** | **list[str]** | | [optional] 25 | **type** | [**ScriptType**](ScriptType.md) | | [optional] 26 | **user** | **str** | | [optional] 27 | **version** | **int** | | [optional] 28 | 29 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 30 | 31 | 32 | -------------------------------------------------------------------------------- /docs/AutomationScriptFilter.md: -------------------------------------------------------------------------------- 1 | # AutomationScriptFilter 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **cache** | **dict(str, list[str])** | Cache of join functions | [optional] 7 | **page** | **int** | 0-based page | [optional] 8 | **query** | **str** | | [optional] 9 | **search_after** | **list[str]** | Efficient next page, pass max sort value from previous page | [optional] 10 | **search_before** | **list[str]** | Efficient prev page, pass min sort value from next page | [optional] 11 | **size** | **int** | Size is limited to 1000, if not passed it defaults to 0, and no results will return | [optional] 12 | **sort** | [**list[Order]**](Order.md) | The sort order | [optional] 13 | **strip_context** | **bool** | | [optional] 14 | 15 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/AutomationScriptFilterWrapper.md: -------------------------------------------------------------------------------- 1 | # AutomationScriptFilterWrapper 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **filter** | [**GenericStringFilter**](GenericStringFilter.md) | | [optional] 7 | **save_password** | **bool** | | [optional] 8 | **script** | [**AutomationScript**](AutomationScript.md) | | [optional] 9 | 10 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/AutomationScriptResult.md: -------------------------------------------------------------------------------- 1 | # AutomationScriptResult 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **python_enabled** | **bool** | | [optional] 7 | **scripts** | [**list[AutomationScriptAPI]**](AutomationScriptAPI.md) | | [optional] 8 | **selected_script** | **dict(str, object)** | | [optional] 9 | **suggestions** | **list[str]** | | [optional] 10 | 11 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Command.md: -------------------------------------------------------------------------------- 1 | # Command 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **arguments** | [**list[Argument]**](Argument.md) | | [optional] 7 | **cartesian** | **bool** | | [optional] 8 | **deprecated** | **bool** | | [optional] 9 | **description** | **str** | | [optional] 10 | **execution** | **bool** | | [optional] 11 | **hidden** | **bool** | | [optional] 12 | **important** | [**list[Important]**](Important.md) | | [optional] 13 | **name** | **str** | | [optional] 14 | **outputs** | [**list[Output]**](Output.md) | | [optional] 15 | **permitted** | **bool** | | [optional] 16 | **sensitive** | **bool** | | [optional] 17 | **timeout** | **int** | | [optional] 18 | 19 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/CommonFields.md: -------------------------------------------------------------------------------- 1 | # CommonFields 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | | [optional] 7 | **modified** | **datetime** | | [optional] 8 | **sort_values** | **list[str]** | | [optional] 9 | **version** | **int** | | [optional] 10 | 11 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ComplexArg.md: -------------------------------------------------------------------------------- 1 | # ComplexArg 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **accessor** | **str** | | [optional] 7 | **filters** | [**list[ArgFilter]**](ArgFilter.md) | | [optional] 8 | **root** | **str** | | [optional] 9 | **transformers** | [**list[ArgTransformer]**](ArgTransformer.md) | | [optional] 10 | 11 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ConfigDataType.md: -------------------------------------------------------------------------------- 1 | # ConfigDataType 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ConfigField.md: -------------------------------------------------------------------------------- 1 | # ConfigField 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **default_value** | **str** | | [optional] 7 | **display** | **str** | | [optional] 8 | **hidden** | **bool** | | [optional] 9 | **info** | **str** | | [optional] 10 | **name** | **str** | | [optional] 11 | **options** | **list[str]** | | [optional] 12 | **required** | **bool** | | [optional] 13 | **type** | [**ConfigDataType**](ConfigDataType.md) | | [optional] 14 | 15 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/CustomFields.md: -------------------------------------------------------------------------------- 1 | # CustomFields 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/DBotScore.md: -------------------------------------------------------------------------------- 1 | # DBotScore 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **content** | **str** | | [optional] 7 | **content_format** | **str** | | [optional] 8 | **context** | **dict(str, object)** | | [optional] 9 | **is_typed_indicator** | **bool** | | [optional] 10 | **score** | **int** | | [optional] 11 | **score_change_timestamp** | **datetime** | We need to track when the score changes to know if we need to re-calculate the overall score | [optional] 12 | **timestamp** | **datetime** | | [optional] 13 | **type** | **str** | | [optional] 14 | 15 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/Dashboard.md: -------------------------------------------------------------------------------- 1 | # Dashboard 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **commit_message** | **str** | | [optional] 7 | **from_date** | **datetime** | | [optional] 8 | **from_date_license** | **datetime** | | [optional] 9 | **id** | **str** | | [optional] 10 | **is_common** | **bool** | | [optional] 11 | **layout** | [**WidgetCells**](WidgetCells.md) | | [optional] 12 | **modified** | **datetime** | | [optional] 13 | **name** | **str** | | [optional] 14 | **owner** | **str** | | [optional] 15 | **period** | [**Period**](Period.md) | | [optional] 16 | **prev_name** | **str** | | [optional] 17 | **shared** | **bool** | | [optional] 18 | **should_commit** | **bool** | | [optional] 19 | **sort_values** | **list[str]** | | [optional] 20 | **system** | **bool** | | [optional] 21 | **to_date** | **datetime** | | [optional] 22 | **vc_should_ignore** | **bool** | | [optional] 23 | **version** | **int** | | [optional] 24 | 25 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/DataCollectionForm.md: -------------------------------------------------------------------------------- 1 | # DataCollectionForm 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **description** | **str** | | [optional] 7 | **expired** | **bool** | | [optional] 8 | **questions** | [**list[Question]**](Question.md) | | [optional] 9 | **sender** | **str** | | [optional] 10 | **title** | **str** | | [optional] 11 | **total_answers** | **int** | | [optional] 12 | 13 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/DateRange.md: -------------------------------------------------------------------------------- 1 | # DateRange 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **from_date** | **datetime** | | [optional] 7 | **from_date_license** | **datetime** | | [optional] 8 | **period** | [**Period**](Period.md) | | [optional] 9 | **to_date** | **datetime** | | [optional] 10 | 11 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/DateRangeFilter.md: -------------------------------------------------------------------------------- 1 | # DateRangeFilter 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **from_date** | **datetime** | | [optional] 7 | **from_date_license** | **datetime** | | [optional] 8 | **period** | [**Period**](Period.md) | | [optional] 9 | **time_frame** | [**Duration**](Duration.md) | | [optional] 10 | **to_date** | **datetime** | | [optional] 11 | 12 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/DeleteEvidence.md: -------------------------------------------------------------------------------- 1 | # DeleteEvidence 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **evidence_id** | **str** | | [optional] 7 | 8 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/DockerImage.md: -------------------------------------------------------------------------------- 1 | # DockerImage 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **created_at** | **str** | | [optional] 7 | **created_since** | **str** | | [optional] 8 | **id** | **str** | | [optional] 9 | **repository** | **str** | | [optional] 10 | **size** | **str** | | [optional] 11 | **tag** | **str** | | [optional] 12 | 13 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/DockerImagesResult.md: -------------------------------------------------------------------------------- 1 | # DockerImagesResult 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **images** | [**list[DockerImage]**](DockerImage.md) | | [optional] 7 | 8 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/DownloadEntry.md: -------------------------------------------------------------------------------- 1 | # DownloadEntry 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | | [optional] 7 | **investigation_id** | **str** | | [optional] 8 | 9 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Duration.md: -------------------------------------------------------------------------------- 1 | # Duration 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/EndingType.md: -------------------------------------------------------------------------------- 1 | # EndingType 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/Entry.md: -------------------------------------------------------------------------------- 1 | # Entry 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **shard_id** | **int** | | [optional] 7 | **brand** | **str** | | [optional] 8 | **category** | [**EntryCategory**](EntryCategory.md) | | [optional] 9 | **contents** | **object** | The contents of the entry that is actually indexed - should not be used | [optional] 10 | **contents_size** | **int** | ContentsSize the total size of the contents | [optional] 11 | **created** | **datetime** | When it was taken | [optional] 12 | **cron** | **str** | | [optional] 13 | **cron_view** | **bool** | | [optional] 14 | **deleted** | **bool** | | [optional] 15 | **ending_date** | **datetime** | | [optional] 16 | **ending_type** | [**EndingType**](EndingType.md) | | [optional] 17 | **entry_task** | [**EntryTask**](EntryTask.md) | | [optional] 18 | **error_source** | **str** | Source of the error | [optional] 19 | **file** | **str** | Filename of associated content | [optional] 20 | **file_id** | **str** | FileID is the file name when saved in the server | [optional] 21 | **file_metadata** | [**FileMetadata**](FileMetadata.md) | | [optional] 22 | **format** | **str** | Holds information on how content is formatted | [optional] 23 | **has_role** | **bool** | Internal field to make queries on role faster | [optional] 24 | **history** | [**list[EntryHistory]**](EntryHistory.md) | Edit history | [optional] 25 | **human_cron** | [**HumanCron**](HumanCron.md) | | [optional] 26 | **id** | **str** | | [optional] 27 | **instance** | **str** | | [optional] 28 | **investigation_id** | **str** | The id of the investigation it belongs to | [optional] 29 | **modified** | **datetime** | | [optional] 30 | **note** | **bool** | Note | [optional] 31 | **parent_content** | **object** | ParentEntry content - for reference | [optional] 32 | **parent_entry_truncated** | **bool** | ParentEntryTruncated - indicates weather entry content was truncated | [optional] 33 | **parent_id** | **str** | ParentId is the ID of the parent entry | [optional] 34 | **pinned** | **bool** | Mark entry as pinned = evidence | [optional] 35 | **playbook_id** | **str** | PlaybookID - if the entry is assigned as note to a playbook task, it will hold the playbook | [optional] 36 | **previous_roles** | **list[str]** | PreviousRoleName - do not change this field manually | [optional] 37 | **read_only** | **bool** | ReadOnly | [optional] 38 | **recurrent** | **bool** | | [optional] 39 | **reputation_size** | **int** | ReputationSize the total size of the reputation | [optional] 40 | **reputations** | [**list[EntryReputation]**](EntryReputation.md) | EntryReputations the reputations calculated by regex match | [optional] 41 | **roles** | **list[str]** | The role assigned to this investigation | [optional] 42 | **scheduled** | **bool** | is it scheduled | [optional] 43 | **sort_values** | **list[str]** | | [optional] 44 | **start_date** | **datetime** | | [optional] 45 | **system** | **str** | The name of the system associated with this entry | [optional] 46 | **tags** | **list[str]** | Tags | [optional] 47 | **tags_raw** | **list[str]** | TagsRaw | [optional] 48 | **task_id** | **str** | TaskID - used if the entry is assigned as note to a playbook task | [optional] 49 | **times** | **int** | | [optional] 50 | **timezone_offset** | **int** | | [optional] 51 | **type** | [**EntryType**](EntryType.md) | | [optional] 52 | **user** | **str** | The user who created the entry | [optional] 53 | **version** | **int** | | [optional] 54 | 55 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 56 | 57 | 58 | -------------------------------------------------------------------------------- /docs/EntryCategory.md: -------------------------------------------------------------------------------- 1 | # EntryCategory 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/EntryHistory.md: -------------------------------------------------------------------------------- 1 | # EntryHistory 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **content_date** | **datetime** | | [optional] 7 | **contents** | **str** | | [optional] 8 | **contents_format** | **str** | | [optional] 9 | **user** | **str** | | [optional] 10 | 11 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/EntryReputation.md: -------------------------------------------------------------------------------- 1 | # EntryReputation 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **highlights** | [**FieldTermLocationMap**](FieldTermLocationMap.md) | | [optional] 7 | **reputations_data** | [**list[ReputationData]**](ReputationData.md) | | [optional] 8 | 9 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/EntryTask.md: -------------------------------------------------------------------------------- 1 | # EntryTask 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **playbook_name** | **str** | | [optional] 7 | **task_id** | **str** | | [optional] 8 | **task_name** | **str** | | [optional] 9 | **task_status** | **str** | | [optional] 10 | 11 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/EntryType.md: -------------------------------------------------------------------------------- 1 | # EntryType 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/Evidence.md: -------------------------------------------------------------------------------- 1 | # Evidence 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **shard_id** | **int** | | [optional] 7 | **description** | **str** | The description for the resolve | [optional] 8 | **entry_id** | **str** | The entry ID | [optional] 9 | **fetched** | **datetime** | when the evidence entry was fetched | [optional] 10 | **has_role** | **bool** | Internal field to make queries on role faster | [optional] 11 | **id** | **str** | | [optional] 12 | **incident_id** | **str** | The incident ID | [optional] 13 | **marked_by** | **str** | the user that marked this evidence | [optional] 14 | **marked_date** | **datetime** | when this evidence was marked | [optional] 15 | **modified** | **datetime** | | [optional] 16 | **occurred** | **datetime** | When this evidence has occurred | [optional] 17 | **previous_roles** | **list[str]** | PreviousRoleName - do not change this field manually | [optional] 18 | **roles** | **list[str]** | The role assigned to this investigation | [optional] 19 | **sort_values** | **list[str]** | | [optional] 20 | **tags** | **list[str]** | Tags | [optional] 21 | **tags_raw** | **list[str]** | TagsRaw | [optional] 22 | **task_id** | **str** | when the evidence entry was fetched | [optional] 23 | **version** | **int** | | [optional] 24 | 25 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/EvidenceData.md: -------------------------------------------------------------------------------- 1 | # EvidenceData 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **custom_fields** | [**dict(str, AdvanceArg)**](AdvanceArg.md) | This field must have empty json key | [optional] 7 | **description** | [**AdvanceArg**](AdvanceArg.md) | | [optional] 8 | **occurred** | [**AdvanceArg**](AdvanceArg.md) | | [optional] 9 | **tags** | [**AdvanceArg**](AdvanceArg.md) | | [optional] 10 | 11 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Evidences.md: -------------------------------------------------------------------------------- 1 | # Evidences 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/EvidencesFilterWrapper.md: -------------------------------------------------------------------------------- 1 | # EvidencesFilterWrapper 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **filter** | [**GenericStringDateFilter**](GenericStringDateFilter.md) | | [optional] 7 | **incident_id** | **str** | | [optional] 8 | 9 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/EvidencesSearchResponse.md: -------------------------------------------------------------------------------- 1 | # EvidencesSearchResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **evidences** | [**Evidences**](Evidences.md) | | [optional] 7 | **total** | **int** | | [optional] 8 | 9 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ExpirationPolicy.md: -------------------------------------------------------------------------------- 1 | # ExpirationPolicy 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ExpirationSettingsSource.md: -------------------------------------------------------------------------------- 1 | # ExpirationSettingsSource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ExpirationSource.md: -------------------------------------------------------------------------------- 1 | # ExpirationSource 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **brand** | **str** | | [optional] 7 | **expiration_interval** | **int** | | [optional] 8 | **expiration_policy** | [**ExpirationPolicy**](ExpirationPolicy.md) | | [optional] 9 | **instance** | **str** | | [optional] 10 | **module_id** | **str** | | [optional] 11 | **set_time** | **datetime** | | [optional] 12 | **source** | [**ExpirationSettingsSource**](ExpirationSettingsSource.md) | | [optional] 13 | **user** | **str** | | [optional] 14 | 15 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/FeedIndicator.md: -------------------------------------------------------------------------------- 1 | # FeedIndicator 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **expiration_source** | [**ExpirationSource**](ExpirationSource.md) | | [optional] 7 | **bypass_exclusion_list** | **bool** | | [optional] 8 | **classifier_version** | **int** | | [optional] 9 | **expiration_interval** | **int** | | [optional] 10 | **expiration_policy** | [**ExpirationPolicy**](ExpirationPolicy.md) | | [optional] 11 | **feed_config** | **dict(str, object)** | | [optional] 12 | **fetch_time** | **datetime** | | [optional] 13 | **fields** | [**CustomFields**](CustomFields.md) | | [optional] 14 | **is_enrichment** | **bool** | | [optional] 15 | **modified_time** | **datetime** | | [optional] 16 | **module_id** | **str** | | [optional] 17 | **raw_json** | **dict(str, object)** | | [optional] 18 | **reliability** | [**Reliability**](Reliability.md) | | [optional] 19 | **score** | **int** | | [optional] 20 | **source_brand** | **str** | | [optional] 21 | **source_instance** | **str** | | [optional] 22 | **timestamp** | **datetime** | | [optional] 23 | **type** | **str** | indicator fields | [optional] 24 | **value** | **str** | | [optional] 25 | 26 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 27 | 28 | 29 | -------------------------------------------------------------------------------- /docs/FeedIndicators.md: -------------------------------------------------------------------------------- 1 | # FeedIndicators 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/FeedIndicatorsRequest.md: -------------------------------------------------------------------------------- 1 | # FeedIndicatorsRequest 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **bypass_exclusion_list** | **bool** | | [optional] 7 | **classifier_id** | **str** | | [optional] 8 | **indicators** | [**list[RawFeedIndicator]**](RawFeedIndicator.md) | | [optional] 9 | **mapper_id** | **str** | | [optional] 10 | 11 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/FieldGroup.md: -------------------------------------------------------------------------------- 1 | # FieldGroup 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/FieldMapping.md: -------------------------------------------------------------------------------- 1 | # FieldMapping 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **field_id** | **str** | | [optional] 7 | **output** | [**AdvanceArg**](AdvanceArg.md) | | [optional] 8 | 9 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/FieldTermLocationMap.md: -------------------------------------------------------------------------------- 1 | # FieldTermLocationMap 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/FileMetadata.md: -------------------------------------------------------------------------------- 1 | # FileMetadata 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **info** | **str** | | [optional] 7 | **is_media_file** | **bool** | | [optional] 8 | **md5** | **str** | | [optional] 9 | **sha1** | **str** | | [optional] 10 | **sha256** | **str** | | [optional] 11 | **sha512** | **str** | | [optional] 12 | **size** | **int** | | [optional] 13 | **ssdeep** | **str** | | [optional] 14 | **type** | **str** | | [optional] 15 | 16 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/FilterCache.md: -------------------------------------------------------------------------------- 1 | # FilterCache 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/FilterOperatorID.md: -------------------------------------------------------------------------------- 1 | # FilterOperatorID 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/FormDisplay.md: -------------------------------------------------------------------------------- 1 | # FormDisplay 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **body_background_color** | **str** | | [optional] 7 | **body_font_color** | **str** | | [optional] 8 | **header_background_color** | **str** | | [optional] 9 | **header_font_color** | **str** | | [optional] 10 | **sender** | **str** | | [optional] 11 | **submit_button_background_color** | **str** | | [optional] 12 | **submit_button_font_color** | **str** | | [optional] 13 | **submit_text** | **str** | | [optional] 14 | 15 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/GenericIndicatorUpdateBatch.md: -------------------------------------------------------------------------------- 1 | # GenericIndicatorUpdateBatch 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **all** | **bool** | | [optional] 7 | **columns** | **list[str]** | | [optional] 8 | **do_not_whitelist** | **bool** | | [optional] 9 | **filter** | [**IndicatorFilter**](IndicatorFilter.md) | | [optional] 10 | **ids** | **list[str]** | | [optional] 11 | **reason** | **str** | | [optional] 12 | **reputations** | **list[str]** | | [optional] 13 | 14 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/GenericStringDateFilter.md: -------------------------------------------------------------------------------- 1 | # GenericStringDateFilter 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **cache** | **dict(str, list[str])** | Cache of join functions | [optional] 7 | **from_date** | **datetime** | | [optional] 8 | **from_date_license** | **datetime** | | [optional] 9 | **page** | **int** | 0-based page | [optional] 10 | **period** | [**Period**](Period.md) | | [optional] 11 | **query** | **str** | | [optional] 12 | **search_after** | **list[str]** | Efficient next page, pass max sort value from previous page | [optional] 13 | **search_before** | **list[str]** | Efficient prev page, pass min sort value from next page | [optional] 14 | **size** | **int** | Size is limited to 1000, if not passed it defaults to 0, and no results will return | [optional] 15 | **sort** | [**list[Order]**](Order.md) | The sort order | [optional] 16 | **time_frame** | [**Duration**](Duration.md) | | [optional] 17 | **to_date** | **datetime** | | [optional] 18 | 19 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/GenericStringFilter.md: -------------------------------------------------------------------------------- 1 | # GenericStringFilter 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **cache** | **dict(str, list[str])** | Cache of join functions | [optional] 7 | **page** | **int** | 0-based page | [optional] 8 | **query** | **str** | | [optional] 9 | **search_after** | **list[str]** | Efficient next page, pass max sort value from previous page | [optional] 10 | **search_before** | **list[str]** | Efficient prev page, pass min sort value from next page | [optional] 11 | **size** | **int** | Size is limited to 1000, if not passed it defaults to 0, and no results will return | [optional] 12 | **sort** | [**list[Order]**](Order.md) | The sort order | [optional] 13 | 14 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/GridColumn.md: -------------------------------------------------------------------------------- 1 | # GridColumn 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **display_name** | **str** | | [optional] 7 | **field_calc_script** | **str** | | [optional] 8 | **is_default** | **bool** | | [optional] 9 | **is_read_only** | **bool** | | [optional] 10 | **key** | **str** | | [optional] 11 | **required** | **bool** | | [optional] 12 | **script** | **str** | | [optional] 13 | **select_values** | **list[str]** | | [optional] 14 | **type** | **str** | | [optional] 15 | **width** | **int** | | [optional] 16 | 17 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/Group.md: -------------------------------------------------------------------------------- 1 | # Group 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **data** | **list[int]** | The data value provided in array of integer values. | [optional] 7 | **groups** | [**Groups**](Groups.md) | | [optional] 8 | **name** | **str** | | [optional] 9 | 10 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/Groups.md: -------------------------------------------------------------------------------- 1 | # Groups 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/HumanCron.md: -------------------------------------------------------------------------------- 1 | # HumanCron 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **at_time_hour** | **str** | | [optional] 7 | **at_time_minute** | **str** | | [optional] 8 | **days** | **list[str]** | | [optional] 9 | **hours_period** | **str** | | [optional] 10 | **scheduling_type** | **str** | the following fields are deprecated. do not use them. | [optional] 11 | **time_period** | **int** | | [optional] 12 | **time_period_type** | **str** | | [optional] 13 | 14 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/Important.md: -------------------------------------------------------------------------------- 1 | # Important 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **context_path** | **str** | | [optional] 7 | **description** | **str** | Description is either a string or a map from string to interface | [optional] 8 | **related** | **str** | To what other context path this output is related | [optional] 9 | 10 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/IncidentField.md: -------------------------------------------------------------------------------- 1 | # IncidentField 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **associated_to_all** | **bool** | | [optional] 7 | **associated_types** | **list[str]** | AssociatedTypes - list of incident (case) types IDs related to specific incident field | [optional] 8 | **breach_script** | **str** | | [optional] 9 | **case_insensitive** | **bool** | | [optional] 10 | **cli_name** | **str** | | [optional] 11 | **close_form** | **bool** | | [optional] 12 | **columns** | [**list[GridColumn]**](GridColumn.md) | | [optional] 13 | **commit_message** | **str** | | [optional] 14 | **content** | **bool** | | [optional] 15 | **default_rows** | **list[dict(str, object)]** | | [optional] 16 | **description** | **str** | | [optional] 17 | **edit_form** | **bool** | | [optional] 18 | **field_calc_script** | **str** | | [optional] 19 | **group** | [**FieldGroup**](FieldGroup.md) | | [optional] 20 | **hidden** | **bool** | | [optional] 21 | **id** | **str** | | [optional] 22 | **is_read_only** | **bool** | | [optional] 23 | **locked** | **bool** | | [optional] 24 | **modified** | **datetime** | | [optional] 25 | **name** | **str** | | [optional] 26 | **never_set_as_required** | **bool** | | [optional] 27 | **owner_only** | **bool** | | [optional] 28 | **placeholder** | **str** | | [optional] 29 | **prev_name** | **str** | | [optional] 30 | **required** | **bool** | | [optional] 31 | **script** | **str** | | [optional] 32 | **select_values** | **list[str]** | | [optional] 33 | **should_commit** | **bool** | | [optional] 34 | **sla** | **int** | | [optional] 35 | **sort_values** | **list[str]** | | [optional] 36 | **system** | **bool** | | [optional] 37 | **system_associated_types** | **list[str]** | | [optional] 38 | **threshold** | **float** | | [optional] 39 | **type** | **str** | | [optional] 40 | **unmapped** | **bool** | | [optional] 41 | **unsearchable** | **bool** | | [optional] 42 | **use_as_kpi** | **bool** | | [optional] 43 | **validated_error** | **str** | | [optional] 44 | **validation_regex** | **str** | | [optional] 45 | **vc_should_ignore** | **bool** | | [optional] 46 | **version** | **int** | | [optional] 47 | 48 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 49 | 50 | 51 | -------------------------------------------------------------------------------- /docs/IncidentFilter.md: -------------------------------------------------------------------------------- 1 | # IncidentFilter 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **cache** | **dict(str, list[str])** | Cache of join functions | [optional] 7 | **and_op** | **bool** | | [optional] 8 | **category** | **list[str]** | | [optional] 9 | **details** | **str** | | [optional] 10 | **files** | **list[str]** | | [optional] 11 | **first_incident_in_page** | [**IncidentWrapper**](IncidentWrapper.md) | | [optional] 12 | **from_activated_date** | **datetime** | | [optional] 13 | **from_closed_date** | **datetime** | | [optional] 14 | **from_date** | **datetime** | | [optional] 15 | **from_date_license** | **datetime** | | [optional] 16 | **from_due_date** | **datetime** | | [optional] 17 | **from_reminder** | **datetime** | | [optional] 18 | **id** | **list[str]** | | [optional] 19 | **include_tmp** | **bool** | | [optional] 20 | **investigation** | **list[str]** | | [optional] 21 | **last_incident_in_page** | [**IncidentWrapper**](IncidentWrapper.md) | | [optional] 22 | **level** | [**list[Severity]**](Severity.md) | | [optional] 23 | **name** | **list[str]** | | [optional] 24 | **next_page** | **bool** | | [optional] 25 | **not_category** | **list[str]** | | [optional] 26 | **not_investigation** | **list[str]** | | [optional] 27 | **not_status** | [**list[IncidentStatus]**](IncidentStatus.md) | | [optional] 28 | **page** | **int** | 0-based page | [optional] 29 | **parent** | **list[str]** | | [optional] 30 | **period** | [**Period**](Period.md) | | [optional] 31 | **query** | **str** | | [optional] 32 | **reason** | **list[str]** | | [optional] 33 | **search_after** | **list[str]** | Efficient next page, pass max sort value from previous page | [optional] 34 | **search_before** | **list[str]** | Efficient prev page, pass min sort value from next page | [optional] 35 | **sequential_pages_search** | **bool** | | [optional] 36 | **size** | **int** | Size is limited to 1000, if not passed it defaults to 0, and no results will return | [optional] 37 | **sort** | [**list[Order]**](Order.md) | The sort order | [optional] 38 | **status** | [**list[IncidentStatus]**](IncidentStatus.md) | | [optional] 39 | **systems** | **list[str]** | | [optional] 40 | **time_frame** | [**Duration**](Duration.md) | | [optional] 41 | **to_activated_date** | **datetime** | | [optional] 42 | **to_closed_date** | **datetime** | | [optional] 43 | **to_date** | **datetime** | | [optional] 44 | **to_due_date** | **datetime** | | [optional] 45 | **to_reminder** | **datetime** | | [optional] 46 | **total_only** | **bool** | | [optional] 47 | **type** | **list[str]** | | [optional] 48 | **urls** | **list[str]** | | [optional] 49 | **users** | **list[str]** | | [optional] 50 | 51 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 52 | 53 | 54 | -------------------------------------------------------------------------------- /docs/IncidentSearchResponseWrapper.md: -------------------------------------------------------------------------------- 1 | # IncidentSearchResponseWrapper 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **data** | [**list[IncidentWrapper]**](IncidentWrapper.md) | in: body | [optional] 7 | **not_updated** | **int** | | [optional] 8 | **total** | **int** | | [optional] 9 | 10 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/IncidentStatus.md: -------------------------------------------------------------------------------- 1 | # IncidentStatus 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/IncidentType.md: -------------------------------------------------------------------------------- 1 | # IncidentType 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **autorun** | **bool** | | [optional] 7 | **closure_script** | **str** | | [optional] 8 | **color** | **str** | | [optional] 9 | **commit_message** | **str** | | [optional] 10 | **days** | **int** | | [optional] 11 | **days_r** | **int** | | [optional] 12 | **default** | **bool** | | [optional] 13 | **disabled** | **bool** | | [optional] 14 | **hours** | **int** | | [optional] 15 | **hours_r** | **int** | | [optional] 16 | **id** | **str** | | [optional] 17 | **locked** | **bool** | | [optional] 18 | **modified** | **datetime** | | [optional] 19 | **name** | **str** | | [optional] 20 | **playbook_id** | **str** | | [optional] 21 | **pre_processing_script** | **str** | | [optional] 22 | **prev_name** | **str** | | [optional] 23 | **readonly** | **bool** | | [optional] 24 | **reputation_calc** | [**ReputationCalcAlg**](ReputationCalcAlg.md) | | [optional] 25 | **should_commit** | **bool** | | [optional] 26 | **sla** | **int** | | [optional] 27 | **sla_reminder** | **int** | | [optional] 28 | **sort_values** | **list[str]** | | [optional] 29 | **system** | **bool** | | [optional] 30 | **vc_should_ignore** | **bool** | | [optional] 31 | **version** | **int** | | [optional] 32 | **weeks** | **int** | | [optional] 33 | **weeks_r** | **int** | | [optional] 34 | 35 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 36 | 37 | 38 | -------------------------------------------------------------------------------- /docs/Incidents.md: -------------------------------------------------------------------------------- 1 | # Incidents 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/IndicatorContext.md: -------------------------------------------------------------------------------- 1 | # IndicatorContext 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **entry_id** | **str** | | [optional] 7 | **indicator** | [**IocObject**](IocObject.md) | | [optional] 8 | **investigation_id** | **str** | | [optional] 9 | **seen_now** | **bool** | | [optional] 10 | 11 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/IndicatorEditBulkResponse.md: -------------------------------------------------------------------------------- 1 | # IndicatorEditBulkResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **total** | **int** | | [optional] 7 | **updated** | **int** | | [optional] 8 | 9 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/IndicatorFilter.md: -------------------------------------------------------------------------------- 1 | # IndicatorFilter 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **cache** | **dict(str, list[str])** | Cache of join functions | [optional] 7 | **early_time_in_page** | **datetime** | | [optional] 8 | **first_seen** | [**DateRangeFilter**](DateRangeFilter.md) | | [optional] 9 | **from_date** | **datetime** | | [optional] 10 | **from_date_license** | **datetime** | | [optional] 11 | **last_seen** | [**DateRangeFilter**](DateRangeFilter.md) | | [optional] 12 | **later_time_in_page** | **datetime** | | [optional] 13 | **page** | **int** | 0-based page | [optional] 14 | **period** | [**Period**](Period.md) | | [optional] 15 | **prev_page** | **bool** | MT support - these fields are for indicator search according to calculatedTime | [optional] 16 | **query** | **str** | | [optional] 17 | **search_after** | **list[str]** | Efficient next page, pass max sort value from previous page | [optional] 18 | **search_before** | **list[str]** | Efficient prev page, pass min sort value from next page | [optional] 19 | **size** | **int** | Size is limited to 1000, if not passed it defaults to 0, and no results will return | [optional] 20 | **sort** | [**list[Order]**](Order.md) | The sort order | [optional] 21 | **time_frame** | [**Duration**](Duration.md) | | [optional] 22 | **to_date** | **datetime** | | [optional] 23 | 24 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 25 | 26 | 27 | -------------------------------------------------------------------------------- /docs/IndicatorResult.md: -------------------------------------------------------------------------------- 1 | # IndicatorResult 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **ioc_objects** | [**IocObjects**](IocObjects.md) | | [optional] 7 | **total** | **int** | | [optional] 8 | 9 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/InlineResponse200.md: -------------------------------------------------------------------------------- 1 | # InlineResponse200 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **data** | [**list[Incident]**](Incident.md) | | [optional] 7 | **total** | **int** | | [optional] 8 | 9 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/InsightCache.md: -------------------------------------------------------------------------------- 1 | # InsightCache 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | | [optional] 7 | **modified** | **datetime** | | [optional] 8 | **scores** | [**dict(str, DBotScore)**](DBotScore.md) | | [optional] 9 | **sequence_number** | **int** | | [optional] 10 | **sort_values** | **list[str]** | | [optional] 11 | **version** | **int** | | [optional] 12 | 13 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/InstanceClassifier.md: -------------------------------------------------------------------------------- 1 | # InstanceClassifier 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **brand_name** | **str** | | [optional] 7 | **commit_message** | **str** | | [optional] 8 | **custom** | **bool** | | [optional] 9 | **default_incident_type** | **str** | | [optional] 10 | **feed** | **bool** | | [optional] 11 | **from_server_version** | [**Version**](Version.md) | | [optional] 12 | **id** | **str** | | [optional] 13 | **incident_samples** | [**Incidents**](Incidents.md) | | [optional] 14 | **indicator_samples** | [**FeedIndicators**](FeedIndicators.md) | | [optional] 15 | **instance_id** | **str** | | [optional] 16 | **instance_name** | **str** | | [optional] 17 | **is_default** | **bool** | | [optional] 18 | **item_version** | [**Version**](Version.md) | | [optional] 19 | **key_type_map** | **dict(str, str)** | | [optional] 20 | **mapping** | [**dict(str, Mapper)**](Mapper.md) | | [optional] 21 | **modified** | **datetime** | | [optional] 22 | **pack_id** | **str** | | [optional] 23 | **primary_term** | **int** | | [optional] 24 | **propagation_labels** | **list[str]** | | [optional] 25 | **sequence_number** | **int** | | [optional] 26 | **should_commit** | **bool** | | [optional] 27 | **sort_values** | **list[str]** | | [optional] 28 | **version** | **int** | | [optional] 29 | 30 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 31 | 32 | 33 | -------------------------------------------------------------------------------- /docs/IntegrationScript.md: -------------------------------------------------------------------------------- 1 | # IntegrationScript 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **commands** | [**list[Command]**](Command.md) | | [optional] 7 | **docker_image** | **str** | | [optional] 8 | **feed** | **bool** | | [optional] 9 | **is_fetch** | **bool** | | [optional] 10 | **is_fetch_credentials** | **bool** | | [optional] 11 | **long_running** | **bool** | | [optional] 12 | **long_running_port_mapping** | **bool** | | [optional] 13 | **run_once** | **bool** | | [optional] 14 | **script** | **str** | | [optional] 15 | **subtype** | [**ScriptSubType**](ScriptSubType.md) | | [optional] 16 | **type** | [**ScriptType**](ScriptType.md) | | [optional] 17 | 18 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/InvPlaybookAssignee.md: -------------------------------------------------------------------------------- 1 | # InvPlaybookAssignee 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **assignee** | **str** | | [optional] 7 | **in_task_id** | **str** | | [optional] 8 | **inv_id** | **str** | | [optional] 9 | **version** | **int** | | [optional] 10 | 11 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/InvPlaybookDue.md: -------------------------------------------------------------------------------- 1 | # InvPlaybookDue 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **_date** | **datetime** | | [optional] 7 | **in_task_id** | **str** | | [optional] 8 | **inv_id** | **str** | | [optional] 9 | **version** | **int** | | [optional] 10 | 11 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/InvPlaybookTaskCompleteData.md: -------------------------------------------------------------------------------- 1 | # InvPlaybookTaskCompleteData 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **arguments** | **dict(str, object)** | | [optional] 7 | **completed_by** | **str** | | [optional] 8 | **completed_count** | **int** | | [optional] 9 | **completed_date** | **datetime** | | [optional] 10 | **entries** | **list[str]** | | [optional] 11 | **input** | **str** | | [optional] 12 | **outputs** | **dict(str, object)** | | [optional] 13 | **playbook_inputs** | **dict(str, object)** | | [optional] 14 | **start_date** | **datetime** | | [optional] 15 | **state** | [**TaskState**](TaskState.md) | | [optional] 16 | **will_not_execute_count** | **int** | | [optional] 17 | 18 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/InvPlaybookTaskData.md: -------------------------------------------------------------------------------- 1 | # InvPlaybookTaskData 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **add_after** | **bool** | | [optional] 7 | **automation_script** | **str** | | [optional] 8 | **description** | **str** | | [optional] 9 | **name** | **str** | | [optional] 10 | **neighbor_inv_pb_task_id** | **str** | | [optional] 11 | **script_arguments** | [**dict(str, AdvanceArg)**](AdvanceArg.md) | | [optional] 12 | **tags** | **list[str]** | | [optional] 13 | 14 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/InvTaskInfo.md: -------------------------------------------------------------------------------- 1 | # InvTaskInfo 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **args** | [**dict(str, AdvanceArg)**](AdvanceArg.md) | | [optional] 7 | **comment** | **str** | | [optional] 8 | **conditions** | [**list[TaskCondition]**](TaskCondition.md) | | [optional] 9 | **in_task_id** | **str** | | [optional] 10 | **input** | **str** | | [optional] 11 | **inv_id** | **str** | | [optional] 12 | **loop_args** | [**dict(str, AdvanceArg)**](AdvanceArg.md) | | [optional] 13 | **loop_condition** | [**list[ArgFilter]**](ArgFilter.md) | | [optional] 14 | **version** | **int** | | [optional] 15 | 16 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/Investigation.md: -------------------------------------------------------------------------------- 1 | # Investigation 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **shard_id** | **int** | | [optional] 7 | **category** | **str** | Category of the investigation | [optional] 8 | **child_investigations** | **list[str]** | ChildInvestigations id's | [optional] 9 | **closed** | **datetime** | When was this closed | [optional] 10 | **closing_user_id** | **str** | The user ID that closed this investigation | [optional] 11 | **created** | **datetime** | When was this created | [optional] 12 | **creating_user_id** | **str** | The user ID that created this investigation | [optional] 13 | **details** | **str** | User defined free text details | [optional] 14 | **entitlements** | **list[str]** | One time entitlements | [optional] 15 | **entry_users** | **list[str]** | EntryUsers | [optional] 16 | **has_role** | **bool** | Internal field to make queries on role faster | [optional] 17 | **id** | **str** | | [optional] 18 | **is_child_investigation** | **bool** | IsChildInvestigation | [optional] 19 | **last_open** | **datetime** | | [optional] 20 | **mirror_auto_close** | **dict(str, bool)** | MirrorAutoClose will tell us to close the Chat Module channel if we close investigation | [optional] 21 | **mirror_types** | **dict(str, str)** | MirrorTypes holds info about mirror direction and message type to be mirrored message type can be either 'all' or 'chat' direction can be either 'FromDemisto', 'ToDemisto' or 'Both' if this investigation is mirrored | [optional] 22 | **modified** | **datetime** | | [optional] 23 | **name** | **str** | The name of the investigation, which is unique to the project | [optional] 24 | **open_duration** | **int** | Duration from open to close time | [optional] 25 | **parent_investigation** | **str** | ParentInvestigation - parent id, in case this is a child investigation of another investigation | [optional] 26 | **persistent_entitlements** | **dict(str, str)** | Persistent entitlement per tag. Empty tag will also return an entitlement | [optional] 27 | **previous_roles** | **list[str]** | PreviousRoleName - do not change this field manually | [optional] 28 | **raw_category** | **str** | | [optional] 29 | **reason** | **dict(str, str)** | The reason for the status (resolve) | [optional] 30 | **roles** | **list[str]** | The role assigned to this investigation | [optional] 31 | **run_status** | [**RunStatus**](RunStatus.md) | | [optional] 32 | **slack_mirror_auto_close** | **bool** | DEPRECATED - DeprecatedSlackMirrorAutoClose will tell us to close the Slack channel if we close investigation | [optional] 33 | **slack_mirror_type** | **str** | DEPRECATED - DeprecatedSlackMirrorType holds info about mirror direction and message type to be mirror message type can be either 'all' or 'chat' direction can be either 'demisto2Slack', 'slack2Demisto' or 'both' if this investigation is mirrored to Slack | [optional] 34 | **sort_values** | **list[str]** | | [optional] 35 | **status** | [**InvestigationStatus**](InvestigationStatus.md) | | [optional] 36 | **systems** | [**list[System]**](System.md) | The systems involved | [optional] 37 | **tags** | **list[str]** | Tags | [optional] 38 | **type** | [**InvestigationType**](InvestigationType.md) | | [optional] 39 | **users** | **list[str]** | The users who share this investigation | [optional] 40 | **version** | **int** | | [optional] 41 | 42 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 43 | 44 | 45 | -------------------------------------------------------------------------------- /docs/InvestigationFilter.md: -------------------------------------------------------------------------------- 1 | # InvestigationFilter 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **cache** | **dict(str, list[str])** | Cache of join functions | [optional] 7 | **and_op** | **bool** | | [optional] 8 | **category** | **list[str]** | | [optional] 9 | **from_close_date** | **datetime** | | [optional] 10 | **from_date** | **datetime** | | [optional] 11 | **from_date_license** | **datetime** | | [optional] 12 | **id** | **list[str]** | | [optional] 13 | **ids_only** | **bool** | | [optional] 14 | **include_child_inv** | **bool** | | [optional] 15 | **name** | **list[str]** | | [optional] 16 | **not_category** | **list[str]** | | [optional] 17 | **not_i_ds** | **list[str]** | | [optional] 18 | **page** | **int** | 0-based page | [optional] 19 | **period** | [**Period**](Period.md) | | [optional] 20 | **reason** | **list[str]** | | [optional] 21 | **search_after** | **list[str]** | Efficient next page, pass max sort value from previous page | [optional] 22 | **search_before** | **list[str]** | Efficient prev page, pass min sort value from next page | [optional] 23 | **size** | **int** | Size is limited to 1000, if not passed it defaults to 0, and no results will return | [optional] 24 | **sort** | [**list[Order]**](Order.md) | The sort order | [optional] 25 | **status** | [**list[InvestigationStatus]**](InvestigationStatus.md) | | [optional] 26 | **time_frame** | [**Duration**](Duration.md) | | [optional] 27 | **to_close_date** | **datetime** | | [optional] 28 | **to_date** | **datetime** | | [optional] 29 | **type** | [**list[InvestigationType]**](InvestigationType.md) | | [optional] 30 | **user** | **list[str]** | | [optional] 31 | 32 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 33 | 34 | 35 | -------------------------------------------------------------------------------- /docs/InvestigationPlaybook.md: -------------------------------------------------------------------------------- 1 | # InvestigationPlaybook 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **dirty** | **bool** | | [optional] 7 | **ready_playbook_inputs** | **dict(str, dict(str, object))** | | [optional] 8 | **replaced_playbook** | **bool** | Indicate whether this playbook has new history during this session | [optional] 9 | **shard_id** | **int** | | [optional] 10 | **updated_operator_i_ds** | **bool** | | [optional] 11 | **auto_extracting** | **bool** | | [optional] 12 | **comment** | **str** | | [optional] 13 | **has_role** | **bool** | Internal field to make queries on role faster | [optional] 14 | **id** | **str** | | [optional] 15 | **incident_create_date** | **datetime** | Incident create date | [optional] 16 | **inputs** | [**PlaybookInputs**](PlaybookInputs.md) | | [optional] 17 | **investigation_id** | **str** | | [optional] 18 | **modified** | **datetime** | | [optional] 19 | **name** | **str** | | [optional] 20 | **outputs** | [**PlaybookOutputs**](PlaybookOutputs.md) | | [optional] 21 | **pb_history** | [**list[InvestigationPlaybookData]**](InvestigationPlaybookData.md) | in: body | [optional] 22 | **playbook_id** | **str** | | [optional] 23 | **previous_roles** | **list[str]** | PreviousRoleName - do not change this field manually | [optional] 24 | **roles** | **list[str]** | The role assigned to this investigation | [optional] 25 | **sort_values** | **list[str]** | | [optional] 26 | **start_date** | **datetime** | | [optional] 27 | **start_task_id** | **str** | FirstTask is the root task of the playbook | [optional] 28 | **state** | [**InvestigationPlaybookState**](InvestigationPlaybookState.md) | | [optional] 29 | **sub_playbook_inputs** | [**dict(str, PlaybookInputs)**](PlaybookInputs.md) | | [optional] 30 | **sub_playbook_outputs** | [**dict(str, PlaybookOutputs)**](PlaybookOutputs.md) | | [optional] 31 | **tasks** | [**dict(str, InvestigationPlaybookTask)**](InvestigationPlaybookTask.md) | | [optional] 32 | **version** | **int** | | [optional] 33 | **view** | [**PlaybookView**](PlaybookView.md) | | [optional] 34 | 35 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 36 | 37 | 38 | -------------------------------------------------------------------------------- /docs/InvestigationPlaybookData.md: -------------------------------------------------------------------------------- 1 | # InvestigationPlaybookData 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **ready_playbook_inputs** | **dict(str, dict(str, object))** | | [optional] 7 | **auto_extracting** | **bool** | | [optional] 8 | **comment** | **str** | | [optional] 9 | **inputs** | [**PlaybookInputs**](PlaybookInputs.md) | | [optional] 10 | **investigation_id** | **str** | | [optional] 11 | **name** | **str** | | [optional] 12 | **outputs** | [**PlaybookOutputs**](PlaybookOutputs.md) | | [optional] 13 | **playbook_id** | **str** | | [optional] 14 | **start_date** | **datetime** | | [optional] 15 | **start_task_id** | **str** | FirstTask is the root task of the playbook | [optional] 16 | **state** | [**InvestigationPlaybookState**](InvestigationPlaybookState.md) | | [optional] 17 | **sub_playbook_inputs** | [**dict(str, PlaybookInputs)**](PlaybookInputs.md) | | [optional] 18 | **sub_playbook_outputs** | [**dict(str, PlaybookOutputs)**](PlaybookOutputs.md) | | [optional] 19 | **tasks** | [**dict(str, InvestigationPlaybookTask)**](InvestigationPlaybookTask.md) | | [optional] 20 | **view** | [**PlaybookView**](PlaybookView.md) | | [optional] 21 | 22 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 23 | 24 | 25 | -------------------------------------------------------------------------------- /docs/InvestigationPlaybookState.md: -------------------------------------------------------------------------------- 1 | # InvestigationPlaybookState 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/InvestigationPlaybookTask.md: -------------------------------------------------------------------------------- 1 | # InvestigationPlaybookTask 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **arguments** | **dict(str, object)** | | [optional] 7 | **assignee** | **str** | | [optional] 8 | **assignee_set** | **bool** | | [optional] 9 | **blocking_tasks** | **list[str]** | | [optional] 10 | **comments** | **bool** | Whether this task had any comments or not | [optional] 11 | **completed_by** | **str** | | [optional] 12 | **completed_count** | **int** | | [optional] 13 | **completed_date** | **datetime** | | [optional] 14 | **conditions** | [**list[TaskCondition]**](TaskCondition.md) | Conditions - optional list of conditions to run when task is conditional. we check conditions by their order (e.i. - considering the first one that satisfied) | [optional] 15 | **continue_on_error** | **bool** | | [optional] 16 | **default_assignee** | **str** | | [optional] 17 | **default_assignee_complex** | [**AdvanceArg**](AdvanceArg.md) | | [optional] 18 | **default_reminder** | **int** | | [optional] 19 | **due_date** | **datetime** | | [optional] 20 | **due_date_set** | **bool** | | [optional] 21 | **entries** | **list[str]** | | [optional] 22 | **evidence_data** | [**EvidenceData**](EvidenceData.md) | | [optional] 23 | **execution_count** | **int** | | [optional] 24 | **field_mapping** | [**list[FieldMapping]**](FieldMapping.md) | | [optional] 25 | **for_each_index** | **int** | Parameters needed for loops | [optional] 26 | **for_each_inputs** | **dict(str, list[object])** | | [optional] 27 | **form** | [**DataCollectionForm**](DataCollectionForm.md) | | [optional] 28 | **id** | **str** | | [optional] 29 | **ignore_worker** | **bool** | Do not run this task in a worker | [optional] 30 | **indent** | **int** | | [optional] 31 | **input** | **str** | | [optional] 32 | **loop** | [**TaskLoop**](TaskLoop.md) | | [optional] 33 | **message** | [**NotifiableItem**](NotifiableItem.md) | | [optional] 34 | **next_tasks** | **dict(str, list[str])** | | [optional] 35 | **note** | **bool** | | [optional] 36 | **outputs** | **dict(str, object)** | | [optional] 37 | **parent_block_count** | **int** | the number of tasks that are waiting on blocked in subplaybooks of this task | [optional] 38 | **parent_playbook_id** | **str** | | [optional] 39 | **patched** | **bool** | Indicates whether this task was patched to InvPB and did not originally belong to the playbook | [optional] 40 | **playbook_inputs** | **dict(str, object)** | | [optional] 41 | **previous_tasks** | **dict(str, list[str])** | | [optional] 42 | **quiet_mode** | [**QuietMode**](QuietMode.md) | | [optional] 43 | **reminder** | **int** | Duration in minutes, this field is not persisted here | [optional] 44 | **reputation_calc** | [**ReputationCalcAlg**](ReputationCalcAlg.md) | | [optional] 45 | **restricted_completion** | **bool** | | [optional] 46 | **script_arguments** | [**dict(str, AdvanceArg)**](AdvanceArg.md) | | [optional] 47 | **separate_context** | **bool** | | [optional] 48 | **sla** | [**SLA**](SLA.md) | | [optional] 49 | **sla_reminder** | [**SLA**](SLA.md) | | [optional] 50 | **start_date** | **datetime** | | [optional] 51 | **state** | [**TaskState**](TaskState.md) | | [optional] 52 | **sub_playbook** | [**InvestigationPlaybook**](InvestigationPlaybook.md) | | [optional] 53 | **task** | [**Task**](Task.md) | | [optional] 54 | **task_complete_data** | [**list[InvPlaybookTaskCompleteData]**](InvPlaybookTaskCompleteData.md) | History complete data | [optional] 55 | **task_id** | **str** | | [optional] 56 | **timer_triggers** | [**list[TimerTrigger]**](TimerTrigger.md) | SLA fields | [optional] 57 | **type** | [**TaskType**](TaskType.md) | | [optional] 58 | **view** | [**TaskView**](TaskView.md) | | [optional] 59 | **will_not_execute_count** | **int** | | [optional] 60 | 61 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 62 | 63 | 64 | -------------------------------------------------------------------------------- /docs/InvestigationPlaybookTasksAPI.md: -------------------------------------------------------------------------------- 1 | # InvestigationPlaybookTasksAPI 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **ancestors** | **list[str]** | | [optional] 7 | **inc_severity** | [**Severity**](Severity.md) | | [optional] 8 | **inv_id** | **str** | | [optional] 9 | **inv_name** | **str** | | [optional] 10 | **task** | [**InvestigationPlaybookTask**](InvestigationPlaybookTask.md) | | [optional] 11 | 12 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 13 | 14 | 15 | -------------------------------------------------------------------------------- /docs/InvestigationSearchResponse.md: -------------------------------------------------------------------------------- 1 | # InvestigationSearchResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **data** | [**list[Investigation]**](Investigation.md) | in: body | [optional] 7 | **total** | **int** | | [optional] 8 | 9 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/InvestigationStatus.md: -------------------------------------------------------------------------------- 1 | # InvestigationStatus 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/InvestigationType.md: -------------------------------------------------------------------------------- 1 | # InvestigationType 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/Investigations.md: -------------------------------------------------------------------------------- 1 | # Investigations 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/IocObject.md: -------------------------------------------------------------------------------- 1 | # IocObject 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **custom_fields** | [**CustomFields**](CustomFields.md) | | [optional] 7 | **account** | **str** | | [optional] 8 | **calculated_time** | **datetime** | Do not set the fields bellow this line | [optional] 9 | **comment** | **str** | | [optional] 10 | **first_seen** | **datetime** | | [optional] 11 | **first_seen_entry_id** | **str** | | [optional] 12 | **id** | **str** | | [optional] 13 | **indicator_type** | **str** | | [optional] 14 | **insight_cache** | [**InsightCache**](InsightCache.md) | | [optional] 15 | **investigation_i_ds** | **list[str]** | | [optional] 16 | **last_reputation_run** | **datetime** | | [optional] 17 | **last_seen** | **datetime** | | [optional] 18 | **last_seen_entry_id** | **str** | | [optional] 19 | **manual_score** | **bool** | | [optional] 20 | **manual_set_time** | **datetime** | | [optional] 21 | **manually_edited_fields** | **list[str]** | | [optional] 22 | **modified** | **datetime** | | [optional] 23 | **score** | **int** | | [optional] 24 | **set_by** | **str** | | [optional] 25 | **sort_values** | **list[str]** | | [optional] 26 | **source** | **str** | | [optional] 27 | **timestamp** | **datetime** | | [optional] 28 | **value** | **str** | | [optional] 29 | **version** | **int** | | [optional] 30 | 31 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/IocObjects.md: -------------------------------------------------------------------------------- 1 | # IocObjects 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/Label.md: -------------------------------------------------------------------------------- 1 | # Label 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | | [optional] 7 | **value** | **str** | | [optional] 8 | 9 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Layout.md: -------------------------------------------------------------------------------- 1 | # Layout 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **commit_message** | **str** | | [optional] 7 | **from_server_version** | [**Version**](Version.md) | | [optional] 8 | **id** | **str** | | [optional] 9 | **item_version** | [**Version**](Version.md) | | [optional] 10 | **kind** | **str** | | [optional] 11 | **modified** | **datetime** | | [optional] 12 | **name** | **str** | | [optional] 13 | **pack_id** | **str** | | [optional] 14 | **prev_kind** | **str** | | [optional] 15 | **prev_type_id** | **str** | | [optional] 16 | **primary_term** | **int** | | [optional] 17 | **propagation_labels** | **list[str]** | | [optional] 18 | **sections** | [**list[LayoutSection]**](LayoutSection.md) | | [optional] 19 | **sequence_number** | **int** | | [optional] 20 | **should_commit** | **bool** | | [optional] 21 | **sort_values** | **list[str]** | | [optional] 22 | **system** | **bool** | | [optional] 23 | **to_server_version** | [**Version**](Version.md) | | [optional] 24 | **type_id** | **str** | | [optional] 25 | **vc_should_ignore** | **bool** | | [optional] 26 | **version** | **int** | | [optional] 27 | 28 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 29 | 30 | 31 | -------------------------------------------------------------------------------- /docs/LayoutAPI.md: -------------------------------------------------------------------------------- 1 | # LayoutAPI 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **kind** | **str** | | [optional] 7 | **layout** | [**Layout**](Layout.md) | | [optional] 8 | **type_id** | **str** | | [optional] 9 | 10 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/LayoutField.md: -------------------------------------------------------------------------------- 1 | # LayoutField 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **field_id** | **str** | | [optional] 7 | **id** | **str** | | [optional] 8 | **is_visible** | **bool** | | [optional] 9 | **modified** | **datetime** | | [optional] 10 | **primary_term** | **int** | | [optional] 11 | **sequence_number** | **int** | | [optional] 12 | **sort_values** | **list[str]** | | [optional] 13 | **version** | **int** | | [optional] 14 | 15 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/LayoutSection.md: -------------------------------------------------------------------------------- 1 | # LayoutSection 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **description** | **str** | | [optional] 7 | **fields** | [**list[LayoutField]**](LayoutField.md) | | [optional] 8 | **id** | **str** | | [optional] 9 | **is_visible** | **bool** | | [optional] 10 | **modified** | **datetime** | | [optional] 11 | **name** | **str** | | [optional] 12 | **primary_term** | **int** | | [optional] 13 | **query** | **object** | | [optional] 14 | **query_type** | **str** | | [optional] 15 | **read_only** | **bool** | | [optional] 16 | **sequence_number** | **int** | | [optional] 17 | **sort_values** | **list[str]** | | [optional] 18 | **type** | **str** | | [optional] 19 | **version** | **int** | | [optional] 20 | 21 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/Location.md: -------------------------------------------------------------------------------- 1 | # Location 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **array_positions** | [**ArrayPositions**](ArrayPositions.md) | | [optional] 7 | **end** | **int** | | [optional] 8 | **pos** | **int** | Pos is the position of the term within the field, starting at 1 | [optional] 9 | **start** | **int** | Start and End are the byte offsets of the term in the field | [optional] 10 | 11 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Locations.md: -------------------------------------------------------------------------------- 1 | # Locations 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/Mapper.md: -------------------------------------------------------------------------------- 1 | # Mapper 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **dont_map_event_to_labels** | **bool** | DontMapEventToLabels by default we will map all the fields of the event to incident labels | [optional] 7 | **internal_mapping** | [**dict(str, AdvanceArg)**](AdvanceArg.md) | | [optional] 8 | 9 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ModuleArgs.md: -------------------------------------------------------------------------------- 1 | # ModuleArgs 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ModuleConfiguration.md: -------------------------------------------------------------------------------- 1 | # ModuleConfiguration 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **beta** | **bool** | | [optional] 7 | **brand** | **str** | | [optional] 8 | **can_get_samples** | **bool** | | [optional] 9 | **category** | **str** | | [optional] 10 | **cmdline** | **str** | | [optional] 11 | **commit_message** | **str** | | [optional] 12 | **configuration** | [**list[ConfigField]**](ConfigField.md) | | [optional] 13 | **deprecated** | **bool** | | [optional] 14 | **description** | **str** | | [optional] 15 | **detailed_description** | **str** | | [optional] 16 | **display** | **str** | | [optional] 17 | **executable** | **str** | | [optional] 18 | **hidden** | **bool** | | [optional] 19 | **hide_engines** | **bool** | | [optional] 20 | **icon** | **str** | | [optional] 21 | **id** | **str** | | [optional] 22 | **image** | **str** | | [optional] 23 | **integration_script** | [**IntegrationScript**](IntegrationScript.md) | | [optional] 24 | **is_password_protected** | **bool** | | [optional] 25 | **locked** | **bool** | | [optional] 26 | **modified** | **datetime** | | [optional] 27 | **name** | **str** | | [optional] 28 | **path** | **str** | | [optional] 29 | **prev_name** | **str** | | [optional] 30 | **propagation_labels** | **list[str]** | | [optional] 31 | **readonly** | **bool** | | [optional] 32 | **script_not_visible** | **bool** | | [optional] 33 | **should_commit** | **bool** | | [optional] 34 | **sort_values** | **list[str]** | | [optional] 35 | **source_module_id** | **str** | | [optional] 36 | **system** | **bool** | | [optional] 37 | **vc_should_ignore** | **bool** | | [optional] 38 | **version** | **int** | | [optional] 39 | 40 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 41 | 42 | 43 | -------------------------------------------------------------------------------- /docs/NewDockerImage.md: -------------------------------------------------------------------------------- 1 | # NewDockerImage 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **base** | **str** | | [optional] 7 | **dependencies** | **list[str]** | | [optional] 8 | **name** | **str** | | [optional] 9 | **packages** | **list[str]** | | [optional] 10 | 11 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/NewDockerImageResult.md: -------------------------------------------------------------------------------- 1 | # NewDockerImageResult 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **output** | **str** | | [optional] 7 | 8 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/NotifiableItem.md: -------------------------------------------------------------------------------- 1 | # NotifiableItem 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **bcc** | [**AdvanceArg**](AdvanceArg.md) | | [optional] 7 | **body** | [**AdvanceArg**](AdvanceArg.md) | | [optional] 8 | **cc** | [**AdvanceArg**](AdvanceArg.md) | | [optional] 9 | **default_option** | **str** | | [optional] 10 | **format** | **str** | | [optional] 11 | **methods** | **list[str]** | | [optional] 12 | **reply_options** | **list[str]** | | [optional] 13 | **subject** | [**AdvanceArg**](AdvanceArg.md) | | [optional] 14 | **timings** | [**NotifyTimings**](NotifyTimings.md) | | [optional] 15 | **to** | [**AdvanceArg**](AdvanceArg.md) | | [optional] 16 | 17 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/NotifyTimings.md: -------------------------------------------------------------------------------- 1 | # NotifyTimings 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **complete_after_replies** | **int** | | [optional] 7 | **retries_count** | **int** | | [optional] 8 | **retries_interval** | **int** | | [optional] 9 | 10 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/OperatorArgument.md: -------------------------------------------------------------------------------- 1 | # OperatorArgument 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **is_context** | **bool** | | [optional] 7 | **value** | [**AdvanceArg**](AdvanceArg.md) | | [optional] 8 | 9 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Order.md: -------------------------------------------------------------------------------- 1 | # Order 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **asc** | **bool** | | [optional] 7 | **field** | **str** | | [optional] 8 | **field_type** | **str** | | [optional] 9 | 10 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/Output.md: -------------------------------------------------------------------------------- 1 | # Output 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **content_path** | **str** | | [optional] 7 | **context_path** | **str** | | [optional] 8 | **description** | **object** | Description is either a string or a map from string to interface | [optional] 9 | **type** | [**OutputType**](OutputType.md) | | [optional] 10 | 11 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/OutputType.md: -------------------------------------------------------------------------------- 1 | # OutputType 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/Period.md: -------------------------------------------------------------------------------- 1 | # Period 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **by** | **str** | By is used for legacty, and if exists it will override ByTo and ByFrom | [optional] 7 | **by_from** | **str** | | [optional] 8 | **by_to** | **str** | | [optional] 9 | **field** | **str** | | [optional] 10 | **from_value** | **str** | | [optional] 11 | **to_value** | **str** | | [optional] 12 | 13 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/Playbook.md: -------------------------------------------------------------------------------- 1 | # Playbook 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **brands** | **list[str]** | | [optional] 7 | **commands** | **list[str]** | | [optional] 8 | **comment** | **str** | | [optional] 9 | **commit_message** | **str** | | [optional] 10 | **dbot_created_by** | **str** | Who has created this event - relevant only for manual incidents | [optional] 11 | **detached** | **bool** | | [optional] 12 | **from_server_version** | [**Version**](Version.md) | | [optional] 13 | **has_role** | **bool** | Internal field to make queries on role faster | [optional] 14 | **hidden** | **bool** | | [optional] 15 | **id** | **str** | | [optional] 16 | **inputs** | [**PlaybookInputs**](PlaybookInputs.md) | | [optional] 17 | **item_version** | [**Version**](Version.md) | | [optional] 18 | **locked** | **bool** | | [optional] 19 | **missing_scripts_ids** | **list[str]** | | [optional] 20 | **modified** | **datetime** | | [optional] 21 | **name** | **str** | | [optional] 22 | **name_raw** | **str** | | [optional] 23 | **outputs** | [**PlaybookOutputs**](PlaybookOutputs.md) | | [optional] 24 | **pack_id** | **str** | | [optional] 25 | **prev_name** | **str** | | [optional] 26 | **previous_roles** | **list[str]** | PreviousRoleName - do not change this field manually | [optional] 27 | **primary_term** | **int** | | [optional] 28 | **private** | **bool** | | [optional] 29 | **propagation_labels** | **list[str]** | | [optional] 30 | **quiet** | **bool** | | [optional] 31 | **roles** | **list[str]** | The role assigned to this investigation | [optional] 32 | **script_ids** | **list[str]** | | [optional] 33 | **sequence_number** | **int** | | [optional] 34 | **should_commit** | **bool** | | [optional] 35 | **sort_values** | **list[str]** | | [optional] 36 | **source_playbook_id** | **str** | | [optional] 37 | **start_task_id** | **str** | | [optional] 38 | **system** | **bool** | | [optional] 39 | **tags** | **list[str]** | | [optional] 40 | **task_ids** | **list[str]** | auto generated field that will contain all task ids in this playbook Needed for searching with bleve | [optional] 41 | **tasks** | [**dict(str, PlaybookTask)**](PlaybookTask.md) | | [optional] 42 | **to_server_version** | [**Version**](Version.md) | | [optional] 43 | **vc_should_ignore** | **bool** | | [optional] 44 | **version** | **int** | | [optional] 45 | **view** | [**PlaybookView**](PlaybookView.md) | | [optional] 46 | 47 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 48 | 49 | 50 | -------------------------------------------------------------------------------- /docs/PlaybookInput.md: -------------------------------------------------------------------------------- 1 | # PlaybookInput 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **description** | **str** | | [optional] 7 | **key** | **str** | | [optional] 8 | **required** | **bool** | | [optional] 9 | **value** | [**AdvanceArg**](AdvanceArg.md) | | [optional] 10 | 11 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/PlaybookInputs.md: -------------------------------------------------------------------------------- 1 | # PlaybookInputs 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/PlaybookOutput.md: -------------------------------------------------------------------------------- 1 | # PlaybookOutput 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **context_path** | **str** | | [optional] 7 | **description** | **str** | | [optional] 8 | **type** | [**OutputType**](OutputType.md) | | [optional] 9 | 10 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/PlaybookOutputs.md: -------------------------------------------------------------------------------- 1 | # PlaybookOutputs 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/PlaybookTask.md: -------------------------------------------------------------------------------- 1 | # PlaybookTask 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **conditions** | [**list[TaskCondition]**](TaskCondition.md) | Conditions - optional list of conditions to run when task is conditional. we check conditions by their order (e.i. - considering the first one that satisfied) | [optional] 7 | **continue_on_error** | **bool** | | [optional] 8 | **default_assignee** | **str** | | [optional] 9 | **default_assignee_complex** | [**AdvanceArg**](AdvanceArg.md) | | [optional] 10 | **default_reminder** | **int** | | [optional] 11 | **evidence_data** | [**EvidenceData**](EvidenceData.md) | | [optional] 12 | **field_mapping** | [**list[FieldMapping]**](FieldMapping.md) | | [optional] 13 | **form** | [**DataCollectionForm**](DataCollectionForm.md) | | [optional] 14 | **form_display** | [**FormDisplay**](FormDisplay.md) | | [optional] 15 | **id** | **str** | | [optional] 16 | **ignore_worker** | **bool** | Do not run this task in a worker | [optional] 17 | **loop** | [**TaskLoop**](TaskLoop.md) | | [optional] 18 | **message** | [**NotifiableItem**](NotifiableItem.md) | | [optional] 19 | **next_tasks** | **dict(str, list[str])** | | [optional] 20 | **note** | **bool** | | [optional] 21 | **quiet_mode** | [**QuietMode**](QuietMode.md) | | [optional] 22 | **reputation_calc** | [**ReputationCalcAlg**](ReputationCalcAlg.md) | | [optional] 23 | **restricted_completion** | **bool** | | [optional] 24 | **script_arguments** | [**dict(str, AdvanceArg)**](AdvanceArg.md) | | [optional] 25 | **separate_context** | **bool** | | [optional] 26 | **skip_unavailable** | **bool** | SkipUnavailable if true then will check if automation exists, integration of that command is installed and active or sub playbook exists in Demisto | [optional] 27 | **sla** | [**SLA**](SLA.md) | | [optional] 28 | **sla_reminder** | [**SLA**](SLA.md) | | [optional] 29 | **task** | [**Task**](Task.md) | | [optional] 30 | **task_id** | **str** | | [optional] 31 | **timer_triggers** | [**list[TimerTrigger]**](TimerTrigger.md) | SLA fields | [optional] 32 | **type** | [**TaskType**](TaskType.md) | | [optional] 33 | **view** | [**TaskView**](TaskView.md) | | [optional] 34 | 35 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 36 | 37 | 38 | -------------------------------------------------------------------------------- /docs/PlaybookView.md: -------------------------------------------------------------------------------- 1 | # PlaybookView 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/Question.md: -------------------------------------------------------------------------------- 1 | # Question 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **columns** | [**list[GridColumn]**](GridColumn.md) | | [optional] 7 | **default_rows** | **list[dict(str, object)]** | | [optional] 8 | **field_associated** | **str** | | [optional] 9 | **id** | **str** | | [optional] 10 | **label** | **str** | | [optional] 11 | **label_arg** | [**AdvanceArg**](AdvanceArg.md) | | [optional] 12 | **options** | **list[str]** | | [optional] 13 | **placeholder** | **str** | | [optional] 14 | **required** | **bool** | | [optional] 15 | **tooltip** | **str** | | [optional] 16 | **type** | **str** | | [optional] 17 | 18 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 19 | 20 | 21 | -------------------------------------------------------------------------------- /docs/QuietMode.md: -------------------------------------------------------------------------------- 1 | # QuietMode 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/RawFeedIndicator.md: -------------------------------------------------------------------------------- 1 | # RawFeedIndicator 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/RawMessage.md: -------------------------------------------------------------------------------- 1 | # RawMessage 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/Reliability.md: -------------------------------------------------------------------------------- 1 | # Reliability 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/RemoteRepos.md: -------------------------------------------------------------------------------- 1 | # RemoteRepos 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/Report.md: -------------------------------------------------------------------------------- 1 | # Report 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **commit_message** | **str** | | [optional] 7 | **created_by** | **str** | | [optional] 8 | **cron** | **str** | | [optional] 9 | **cron_view** | **bool** | | [optional] 10 | **dashboard** | [**Dashboard**](Dashboard.md) | | [optional] 11 | **decoder** | [**dict(str, ReportFieldsDecoder)**](ReportFieldsDecoder.md) | | [optional] 12 | **description** | **str** | | [optional] 13 | **disable_header** | **bool** | | [optional] 14 | **ending_date** | **datetime** | | [optional] 15 | **ending_type** | [**EndingType**](EndingType.md) | | [optional] 16 | **human_cron** | [**HumanCron**](HumanCron.md) | | [optional] 17 | **id** | **str** | | [optional] 18 | **latest_report_name** | **str** | | [optional] 19 | **latest_report_time** | **datetime** | | [optional] 20 | **latest_report_username** | **str** | | [optional] 21 | **latest_scheduled_report_time** | **datetime** | | [optional] 22 | **locked** | **bool** | | [optional] 23 | **modified** | **datetime** | | [optional] 24 | **name** | **str** | | [optional] 25 | **next_scheduled_time** | **datetime** | | [optional] 26 | **orientation** | **str** | | [optional] 27 | **paper_size** | **str** | | [optional] 28 | **prev_name** | **str** | | [optional] 29 | **prev_type** | **str** | | [optional] 30 | **recipients** | **list[str]** | | [optional] 31 | **recurrent** | **bool** | | [optional] 32 | **report_type** | **str** | | [optional] 33 | **run_once** | **bool** | | [optional] 34 | **running_user** | **str** | | [optional] 35 | **scheduled** | **bool** | is it scheduled | [optional] 36 | **sections** | [**list[Section]**](Section.md) | | [optional] 37 | **sensitive** | **bool** | | [optional] 38 | **should_commit** | **bool** | | [optional] 39 | **sort_values** | **list[str]** | | [optional] 40 | **start_date** | **datetime** | | [optional] 41 | **system** | **bool** | | [optional] 42 | **tags** | **list[str]** | | [optional] 43 | **times** | **int** | | [optional] 44 | **timezone_offset** | **int** | | [optional] 45 | **type** | **str** | | [optional] 46 | **user_api_key** | **str** | | [optional] 47 | **user_api_key_id** | **str** | | [optional] 48 | **vc_should_ignore** | **bool** | | [optional] 49 | **version** | **int** | | [optional] 50 | 51 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 52 | 53 | 54 | -------------------------------------------------------------------------------- /docs/ReportAutomation.md: -------------------------------------------------------------------------------- 1 | # ReportAutomation 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **args** | [**ModuleArgs**](ModuleArgs.md) | | [optional] 7 | **id** | **str** | | [optional] 8 | **name** | **str** | | [optional] 9 | **no_event** | **bool** | | [optional] 10 | 11 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ReportFieldsDecoder.md: -------------------------------------------------------------------------------- 1 | # ReportFieldsDecoder 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **type** | **str** | | [optional] 7 | **value** | **str** | | [optional] 8 | 9 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/ReportQuery.md: -------------------------------------------------------------------------------- 1 | # ReportQuery 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **filter** | [**RawMessage**](RawMessage.md) | | [optional] 7 | **group_by** | **list[str]** | | [optional] 8 | **keys** | **list[str]** | | [optional] 9 | **type** | **str** | | [optional] 10 | 11 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/Reputation.md: -------------------------------------------------------------------------------- 1 | # Reputation 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **cache_versn** | **int** | | [optional] 7 | **commit_message** | **str** | | [optional] 8 | **context_path** | **str** | | [optional] 9 | **context_value** | **str** | | [optional] 10 | **default_mapping** | [**dict(str, AdvanceArg)**](AdvanceArg.md) | | [optional] 11 | **definition_id** | **str** | | [optional] 12 | **details** | **str** | | [optional] 13 | **disabled** | **bool** | | [optional] 14 | **enhancement_script_names** | **list[str]** | | [optional] 15 | **excluded_brands** | **list[str]** | | [optional] 16 | **expiration** | **int** | | [optional] 17 | **file** | **bool** | | [optional] 18 | **file_hashes_priority** | **list[str]** | | [optional] 19 | **format_script** | **str** | | [optional] 20 | **from_server_version** | [**Version**](Version.md) | | [optional] 21 | **highlight** | **dict(str, list[str])** | | [optional] 22 | **id** | **str** | | [optional] 23 | **item_version** | [**Version**](Version.md) | | [optional] 24 | **layout** | **str** | | [optional] 25 | **legacy_names** | **list[str]** | | [optional] 26 | **locked** | **bool** | | [optional] 27 | **manual_mapping** | [**dict(str, AdvanceArg)**](AdvanceArg.md) | | [optional] 28 | **merge_context** | **bool** | | [optional] 29 | **modified** | **datetime** | | [optional] 30 | **numeric_id** | **int** | | [optional] 31 | **pack_id** | **str** | | [optional] 32 | **pack_name** | **str** | | [optional] 33 | **pack_propagation_labels** | **list[str]** | | [optional] 34 | **prev_details** | **str** | | [optional] 35 | **primary_term** | **int** | | [optional] 36 | **propagation_labels** | **list[str]** | | [optional] 37 | **regex** | **str** | | [optional] 38 | **remote** | **bool** | | [optional] 39 | **reputation_command** | **str** | | [optional] 40 | **reputation_script_name** | **str** | | [optional] 41 | **sequence_number** | **int** | | [optional] 42 | **should_commit** | **bool** | | [optional] 43 | **should_share_comments** | **bool** | | [optional] 44 | **sort_values** | **list[str]** | | [optional] 45 | **sync_hash** | **str** | | [optional] 46 | **system** | **bool** | | [optional] 47 | **to_server_version** | [**Version**](Version.md) | | [optional] 48 | **update_after** | **int** | | [optional] 49 | **vc_should_ignore** | **bool** | | [optional] 50 | **vc_should_keep_item_legacy_prod_machine** | **bool** | | [optional] 51 | **version** | **int** | | [optional] 52 | 53 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 54 | 55 | 56 | -------------------------------------------------------------------------------- /docs/ReputationCalcAlg.md: -------------------------------------------------------------------------------- 1 | # ReputationCalcAlg 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ReputationData.md: -------------------------------------------------------------------------------- 1 | # ReputationData 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **raw_term** | **str** | | [optional] 7 | **reputation** | **int** | | [optional] 8 | **reputation_id** | **str** | | [optional] 9 | **term** | **str** | | [optional] 10 | 11 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/ReputationsWithErrors.md: -------------------------------------------------------------------------------- 1 | # ReputationsWithErrors 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **error** | **str** | | [optional] 7 | **reputations** | [**list[Reputation]**](Reputation.md) | | [optional] 8 | 9 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/RunStatus.md: -------------------------------------------------------------------------------- 1 | # RunStatus 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/SLA.md: -------------------------------------------------------------------------------- 1 | # SLA 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **days** | **int** | | [optional] 7 | **hours** | **int** | | [optional] 8 | **weeks** | **int** | | [optional] 9 | 10 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/SLAState.md: -------------------------------------------------------------------------------- 1 | # SLAState 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ScriptAPI.md: -------------------------------------------------------------------------------- 1 | # ScriptAPI 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **arguments** | [**list[Argument]**](Argument.md) | | [optional] 7 | **comment** | **str** | | [optional] 8 | **context_keys** | **list[str]** | | [optional] 9 | **depends_on** | **dict(str, list[str])** | | [optional] 10 | **deprecated** | **bool** | | [optional] 11 | **detached** | **bool** | | [optional] 12 | **docker_image** | **str** | | [optional] 13 | **enabled** | **bool** | | [optional] 14 | **hidden** | **bool** | | [optional] 15 | **id** | **str** | | [optional] 16 | **locked** | **bool** | | [optional] 17 | **modified** | **datetime** | | [optional] 18 | **name** | **str** | | [optional] 19 | **outputs** | [**list[Output]**](Output.md) | | [optional] 20 | **permitted** | **bool** | | [optional] 21 | **propagation_labels** | **list[str]** | | [optional] 22 | **roles** | **list[str]** | | [optional] 23 | **run_as** | **str** | | [optional] 24 | **script_target** | [**ScriptTarget**](ScriptTarget.md) | | [optional] 25 | **system** | **bool** | | [optional] 26 | **tags** | **list[str]** | | [optional] 27 | **type** | [**ScriptType**](ScriptType.md) | | [optional] 28 | **user** | **str** | | [optional] 29 | **version** | **int** | | [optional] 30 | 31 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 32 | 33 | 34 | -------------------------------------------------------------------------------- /docs/ScriptSubType.md: -------------------------------------------------------------------------------- 1 | # ScriptSubType 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ScriptTarget.md: -------------------------------------------------------------------------------- 1 | # ScriptTarget 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/ScriptType.md: -------------------------------------------------------------------------------- 1 | # ScriptType 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/SearchIncidentsData.md: -------------------------------------------------------------------------------- 1 | # SearchIncidentsData 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **filter** | [**IncidentFilter**](IncidentFilter.md) | | [optional] 7 | **user_filter** | **bool** | | [optional] 8 | 9 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Section.md: -------------------------------------------------------------------------------- 1 | # Section 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **automation** | [**ReportAutomation**](ReportAutomation.md) | | [optional] 7 | **data** | **object** | | [optional] 8 | **description** | **str** | | [optional] 9 | **display_type** | **str** | | [optional] 10 | **empty_notification** | **str** | | [optional] 11 | **from_date** | **str** | | [optional] 12 | **layout** | **object** | | [optional] 13 | **query** | [**ReportQuery**](ReportQuery.md) | | [optional] 14 | **title** | **str** | | [optional] 15 | **title_style** | **dict(str, object)** | | [optional] 16 | **to_date** | **str** | | [optional] 17 | **type** | **str** | | [optional] 18 | 19 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/SectionItem.md: -------------------------------------------------------------------------------- 1 | # SectionItem 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **data** | **object** | | [optional] 7 | **display_type** | **str** | | [optional] 8 | **end_col** | **int** | | [optional] 9 | **field_id** | **str** | | [optional] 10 | **field_name** | **str** | | [optional] 11 | **field_type** | **str** | | [optional] 12 | **header_style** | **object** | | [optional] 13 | **index** | **int** | | [optional] 14 | **start_col** | **int** | | [optional] 15 | 16 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 17 | 18 | 19 | -------------------------------------------------------------------------------- /docs/Severity.md: -------------------------------------------------------------------------------- 1 | # Severity 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/StatsQueryResponse.md: -------------------------------------------------------------------------------- 1 | # StatsQueryResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **data** | **object** | data array or object describing the statistics data based on type. | [optional] 7 | **widget_cell_id** | **str** | | [optional] 8 | 9 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/StatsTextResponse.md: -------------------------------------------------------------------------------- 1 | # StatsTextResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **groups** | [**Groups**](Groups.md) | | [optional] 7 | **text** | **str** | Describe the complete text for the text widget, after placeholders injection. | [optional] 8 | 9 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/StatsTrendsResponse.md: -------------------------------------------------------------------------------- 1 | # StatsTrendsResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **curr_sum** | **int** | | [optional] 7 | **prev_sum** | **int** | | [optional] 8 | 9 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/System.md: -------------------------------------------------------------------------------- 1 | # System 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **agent** | [**SystemAgent**](SystemAgent.md) | | [optional] 7 | **arch** | **str** | | [optional] 8 | **ciphers** | **list[str]** | | [optional] 9 | **credentials** | **str** | | [optional] 10 | **engine_id** | **str** | | [optional] 11 | **host** | **str** | | [optional] 12 | **integrationinstanceid** | **str** | | [optional] 13 | **issharedagent** | **bool** | | [optional] 14 | **name** | **str** | | [optional] 15 | **os** | **str** | | [optional] 16 | **password** | **str** | | [optional] 17 | **smb** | **int** | | [optional] 18 | **smbport** | **int** | | [optional] 19 | **sshkey** | **str** | | [optional] 20 | **sshport** | **int** | | [optional] 21 | **terminal_options** | [**TerminalOptions**](TerminalOptions.md) | | [optional] 22 | **user** | **str** | | [optional] 23 | **workgroup** | **str** | | [optional] 24 | 25 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/SystemAgent.md: -------------------------------------------------------------------------------- 1 | # SystemAgent 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **servercontext** | **list[int]** | | [optional] 7 | 8 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/Task.md: -------------------------------------------------------------------------------- 1 | # Task 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **brand** | **str** | | [optional] 7 | **cloned_from** | **str** | | [optional] 8 | **comment** | **str** | | [optional] 9 | **conditions** | **list[str]** | | [optional] 10 | **description** | **str** | | [optional] 11 | **id** | **str** | | [optional] 12 | **is_command** | **bool** | | [optional] 13 | **is_locked** | **bool** | | [optional] 14 | **is_system_task** | **bool** | | [optional] 15 | **is_title_task** | **bool** | | [optional] 16 | **modified** | **datetime** | | [optional] 17 | **name** | **str** | | [optional] 18 | **playbook_id** | **str** | | [optional] 19 | **script_id** | **str** | | [optional] 20 | **sort_values** | **list[str]** | | [optional] 21 | **tags** | **list[str]** | | [optional] 22 | **type** | [**TaskType**](TaskType.md) | | [optional] 23 | **version** | **int** | | [optional] 24 | 25 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 26 | 27 | 28 | -------------------------------------------------------------------------------- /docs/TaskCondition.md: -------------------------------------------------------------------------------- 1 | # TaskCondition 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **condition** | [**list[ArgFilter]**](ArgFilter.md) | | [optional] 7 | **label** | **str** | | [optional] 8 | 9 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/TaskLoop.md: -------------------------------------------------------------------------------- 1 | # TaskLoop 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **brand** | **str** | | [optional] 7 | **builtin_condition** | [**list[ArgFilter]**](ArgFilter.md) | | [optional] 8 | **exit_condition** | **str** | | [optional] 9 | **for_each** | **bool** | | [optional] 10 | **is_command** | **bool** | | [optional] 11 | **script_arguments** | [**dict(str, AdvanceArg)**](AdvanceArg.md) | | [optional] 12 | **script_id** | **str** | | [optional] 13 | **wait** | **int** | | [optional] 14 | 15 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/TaskState.md: -------------------------------------------------------------------------------- 1 | # TaskState 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/TaskType.md: -------------------------------------------------------------------------------- 1 | # TaskType 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/TaskView.md: -------------------------------------------------------------------------------- 1 | # TaskView 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/TermLocationMap.md: -------------------------------------------------------------------------------- 1 | # TermLocationMap 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/TerminalOptions.md: -------------------------------------------------------------------------------- 1 | # TerminalOptions 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **echo** | **int** | | [optional] 7 | **terminal** | **bool** | | [optional] 8 | **terminal_height** | **int** | | [optional] 9 | **terminal_type** | **str** | | [optional] 10 | **terminal_width** | **int** | | [optional] 11 | **ty_i_speed** | **int** | | [optional] 12 | **ty_o_speed** | **int** | | [optional] 13 | 14 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 15 | 16 | 17 | -------------------------------------------------------------------------------- /docs/TimerAction.md: -------------------------------------------------------------------------------- 1 | # TimerAction 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/TimerTrigger.md: -------------------------------------------------------------------------------- 1 | # TimerTrigger 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **action** | [**TimerAction**](TimerAction.md) | | [optional] 7 | **field_name** | **str** | | [optional] 8 | 9 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/TransformerOperatorID.md: -------------------------------------------------------------------------------- 1 | # TransformerOperatorID 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /docs/UpdateDataBatch.md: -------------------------------------------------------------------------------- 1 | # UpdateDataBatch 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **custom_fields** | **dict(str, object)** | | [optional] 7 | **all** | **bool** | | [optional] 8 | **close_notes** | **str** | | [optional] 9 | **close_reason** | **str** | | [optional] 10 | **columns** | **list[str]** | | [optional] 11 | **data** | **dict(str, object)** | | [optional] 12 | **filter** | [**IncidentFilter**](IncidentFilter.md) | | [optional] 13 | **force** | **bool** | | [optional] 14 | **ids** | **list[str]** | | [optional] 15 | **line** | **str** | | [optional] 16 | **original_incident_id** | **str** | | [optional] 17 | **override_investigation** | **bool** | | [optional] 18 | 19 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 20 | 21 | 22 | -------------------------------------------------------------------------------- /docs/UpdateEntry.md: -------------------------------------------------------------------------------- 1 | # UpdateEntry 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **args** | [**dict(str, AdvanceArg)**](AdvanceArg.md) | | [optional] 7 | **data** | **str** | | [optional] 8 | **id** | **str** | | [optional] 9 | **investigation_id** | **str** | | [optional] 10 | **markdown** | **bool** | | [optional] 11 | **version** | **int** | | [optional] 12 | 13 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 14 | 15 | 16 | -------------------------------------------------------------------------------- /docs/UpdateEntryTags.md: -------------------------------------------------------------------------------- 1 | # UpdateEntryTags 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **id** | **str** | | [optional] 7 | **investigation_id** | **str** | | [optional] 8 | **tags** | **list[str]** | | [optional] 9 | **version** | **int** | | [optional] 10 | 11 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/UpdateIndicatorReputationData.md: -------------------------------------------------------------------------------- 1 | # UpdateIndicatorReputationData 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **investigation_id** | **str** | | [optional] 7 | **do_not_whitelist** | **bool** | | [optional] 8 | **entry_id** | **str** | | [optional] 9 | **manual_score** | **bool** | | [optional] 10 | **reason** | **str** | | [optional] 11 | **reputation** | **int** | | [optional] 12 | **reputations** | **list[str]** | | [optional] 13 | **value** | **str** | | [optional] 14 | 15 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/UpdateResponse.md: -------------------------------------------------------------------------------- 1 | # UpdateResponse 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **not_updated** | **int** | | [optional] 7 | **updated_ids** | **list[str]** | | [optional] 8 | 9 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/UploadedEntry.md: -------------------------------------------------------------------------------- 1 | # UploadedEntry 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **contents** | **str** | | [optional] 7 | **format** | **str** | | [optional] 8 | **investigation_id** | **str** | | [optional] 9 | 10 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/Version.md: -------------------------------------------------------------------------------- 1 | # Version 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **digits** | **list[int]** | | [optional] 7 | **label** | **str** | | [optional] 8 | 9 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 10 | 11 | 12 | -------------------------------------------------------------------------------- /docs/Widget.md: -------------------------------------------------------------------------------- 1 | # Widget 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **category** | **str** | Category the widget is related to. Used to display in widget library under category or dataType if empty. | [optional] 7 | **commit_message** | **str** | | [optional] 8 | **data_type** | **str** | Data type of the widget. Describes what data does the widget query. supporting data types \"incidents\",\"messages\",\"system\",\"entries\",\"tasks\", \"audit\". | [optional] 9 | **date_range** | [**DateRange**](DateRange.md) | | [optional] 10 | **description** | **str** | The description of the widget's usage and data representation. | [optional] 11 | **id** | **str** | | [optional] 12 | **is_predefined** | **bool** | Is the widget a system widget. | [optional] 13 | **locked** | **bool** | Is the widget locked for editing. | [optional] 14 | **modified** | **datetime** | | [optional] 15 | **name** | **str** | Default name of the widget. | 16 | **params** | **dict(str, object)** | Additional parameters for this widget, depends on widget type and data. | [optional] 17 | **prev_name** | **str** | The previous name of the widget. | [optional] 18 | **query** | **str** | Query to search on the dataType. | [optional] 19 | **should_commit** | **bool** | | [optional] 20 | **size** | **int** | Maximum size for this widget data returned. | [optional] 21 | **sort** | [**list[Order]**](Order.md) | Sorting array to sort the data received by the given Order parameters. | [optional] 22 | **sort_values** | **list[str]** | | [optional] 23 | **vc_should_ignore** | **bool** | | [optional] 24 | **version** | **int** | | [optional] 25 | **widget_type** | **str** | Widget type describes how does the widget should recieve the data, and display it. Supporting types: \"bar\", \"column\", \"pie\", \"list\", \"number\", \"trend\", \"text\", \"duration\", \"image\", \"line\", and \"table\". | 26 | 27 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 28 | 29 | 30 | -------------------------------------------------------------------------------- /docs/WidgetCell.md: -------------------------------------------------------------------------------- 1 | # WidgetCell 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | **force_range** | **bool** | | [optional] 7 | **h** | **int** | | [optional] 8 | **i** | **str** | | [optional] 9 | **id** | **str** | | [optional] 10 | **w** | **int** | | [optional] 11 | **widget** | [**Widget**](Widget.md) | | [optional] 12 | **x** | **int** | | [optional] 13 | **y** | **int** | | [optional] 14 | 15 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/WidgetCells.md: -------------------------------------------------------------------------------- 1 | # WidgetCells 2 | 3 | ## Properties 4 | Name | Type | Description | Notes 5 | ------------ | ------------- | ------------- | ------------- 6 | 7 | [[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md) 8 | 9 | 10 | -------------------------------------------------------------------------------- /examples/batch_util_example.py: -------------------------------------------------------------------------------- 1 | from __future__ import print_function 2 | import demisto_client.demisto_api 3 | from demisto_client.demisto_api.rest import ApiException 4 | from pprint import pprint 5 | 6 | api_key = 'YOUR API KEY' 7 | base_url = 'YOUR DEMISTO URL' 8 | 9 | # create an instance of the API class 10 | api_instance = demisto_client.configure(base_url=base_url, api_key=api_key, debug=False) 11 | update_data_batch = demisto_client.demisto_api.UpdateDataBatch() 12 | 13 | update_data_batch.ids = ['1001', '1002', '1003'] 14 | update_data_batch.close_notes = 'Incident is a duplicate to incident 1000' 15 | update_data_batch.close_reason = 'Closed as duplicate' 16 | 17 | try: 18 | # Batch close incidents 19 | api_response = api_instance.close_incidents_batch(update_data_batch=update_data_batch) 20 | pprint(api_response) 21 | except ApiException as e: 22 | print("Exception when calling DefaultApi->close_incidents_batch: %s\n" % e) 23 | -------------------------------------------------------------------------------- /examples/create_incident_example.py: -------------------------------------------------------------------------------- 1 | import demisto_client.demisto_api 2 | from demisto_client.demisto_api.rest import ApiException 3 | from datetime import datetime 4 | import tempfile 5 | import os 6 | import time 7 | 8 | api_key = None # set to your 'YOUR_API_KEY' or set environment variable: DEMISTO_API_KEY 9 | base_url = None # set to your 'http://DEMISTO_HOST' or set environment variable: DEMISTO_BASE_URL 10 | 11 | api_instance = demisto_client.configure(base_url=base_url, api_key=api_key, debug=True) 12 | create_incident_request = demisto_client.demisto_api.CreateIncidentRequest() 13 | 14 | create_incident_request.name = 'Sample Malware Incident: {}'.format(datetime.now()) 15 | create_incident_request.type = 'Malware' 16 | create_incident_request.owner = 'admin' 17 | create_incident_request.severity = 1 18 | create_incident_request.occurred = datetime.now() 19 | create_incident_request.create_investigation = False # we set to false as we still neeed to upload a file 20 | create_incident_request.playbook_id = 'malware_investigation-_generic' 21 | # If you want to set source_brand and source_instance it is required to set the `Instance` label 22 | create_incident_request.labels = [demisto_client.demisto_api.Label('Instance', 'Demisto Py Client')] 23 | create_incident_request.source_brand = 'API' 24 | create_incident_request.source_instance = 'Demisto Py Client' 25 | create_incident_request.custom_fields = { 26 | 'src': '1.1.1.1', 27 | 'dest': '192.168.1.1', 28 | 'malwarefamily': 'Trojan.Generic', 29 | 'filehash': '142b638c6a60b60c7f9928da4fb85a5a8e1422a9ffdc9ee49e17e56ccca9cf6e', 30 | 'vendorproduct': 'Secure Product', 31 | } 32 | 33 | tf = None 34 | try: 35 | api_response = api_instance.create_incident(create_incident_request=create_incident_request) 36 | print("Create incident response: {}".format(api_response)) 37 | tf = tempfile.NamedTemporaryFile(delete=False) 38 | tf.write(b'Test data representing an uploaded file') 39 | tf.close() 40 | # note that this is a form post. `last` needs to be true/false string and not boolean 41 | res_upload = api_instance.incident_file_upload(id=api_response.id, file=tf.name, file_name="test-report.txt", 42 | file_comment='Test report file', last='true') 43 | print("Upload file to incident response: {}".format(res_upload)) 44 | # the uploaded file will be the 3rd entry. Let's download it 45 | print('sleeping 10 seconds before download....') 46 | time.sleep(10) # sleep a few seconds to allow server to fully index 47 | res_download = api_instance.download_file('3@{}'.format(api_response.id)) 48 | print("Download file result: {}".format(res_download)) 49 | except ApiException as e: 50 | print("Exception when calling DefaultApi->create_incident: %s\n" % e) 51 | finally: 52 | if tf: 53 | os.unlink(tf.name) 54 | -------------------------------------------------------------------------------- /examples/download_file_example.py: -------------------------------------------------------------------------------- 1 | # download test 2 | import sys 3 | import demisto_client.demisto_api 4 | 5 | 6 | def main(): 7 | if len(sys.argv) != 2 or (len(sys.argv) == 2 and (sys.argv[1] == '-h' or sys.argv[1] == '--help')): 8 | print("Usage: {} ".format(sys.argv[0])) 9 | sys.exit(1) 10 | eid = sys.argv[1] 11 | print("Downloading file from entry id: {}".format(eid)) 12 | api_key = None # set to your 'YOUR_API_KEY' or set environment variable: DEMISTO_API_KEY 13 | base_url = None # set to your 'http://DEMISTO_HOST' or set environment variable: DEMISTO_BASE_URL 14 | 15 | api_instance = demisto_client.configure(base_url=base_url, api_key=api_key, debug=False) 16 | res_download = api_instance.download_file(eid) 17 | print("Download file is available at: {}".format(res_download)) 18 | print("Downloading again the file but not storing to disk (_preload_content=False)...") 19 | res_download = api_instance.download_file(eid, _preload_content=False) 20 | print("Download file size: {}".format(len(res_download.data))) 21 | 22 | 23 | if __name__ == "__main__": 24 | main() 25 | -------------------------------------------------------------------------------- /examples/incidents_search_example.py: -------------------------------------------------------------------------------- 1 | from __future__ import print_function 2 | import demisto_client.demisto_api 3 | from demisto_client.demisto_api.rest import ApiException 4 | from pprint import pprint 5 | 6 | api_key = None # set to your 'YOUR_API_KEY' or set environment variable: DEMISTO_API_KEY 7 | base_url = None # set to your 'http://DEMISTO_HOST' or set environment variable: DEMISTO_BASE_URL 8 | 9 | # create an instance of the API class 10 | api_instance = demisto_client.configure(base_url=base_url, api_key=api_key, debug=True) 11 | filter = demisto_client.demisto_api.SearchIncidentsData() 12 | 13 | # Create incident filter object 14 | inc_filter = demisto_client.demisto_api.IncidentFilter() 15 | inc_filter.name = ['test'] 16 | 17 | filter.filter = inc_filter 18 | 19 | try: 20 | # Search incidents by filter 21 | api_response = api_instance.search_incidents(filter=filter) 22 | pprint(api_response) 23 | except ApiException as e: 24 | print("Exception when calling DefaultApi->search_incidents: %s\n" % e) 25 | -------------------------------------------------------------------------------- /examples/indicators_search_example.py: -------------------------------------------------------------------------------- 1 | from __future__ import print_function 2 | import demisto_client.demisto_api 3 | from demisto_client.demisto_api.rest import ApiException 4 | from pprint import pprint 5 | 6 | api_key = 'YOUR API KEY' 7 | base_url = 'YOUR DEMISTO URL' 8 | 9 | # create an instance of the API class 10 | api_instance = demisto_client.configure(base_url=base_url, api_key=api_key, debug=True) 11 | indicator_filter = demisto_client.demisto_api.IndicatorFilter() 12 | 13 | indicator_filter.query = 'value:8.8.8.8' 14 | 15 | try: 16 | # Search indicators 17 | api_response = api_instance.indicators_search(indicator_filter=indicator_filter) 18 | pprint(api_response) 19 | except ApiException as e: 20 | print("Exception when calling DefaultApi->indicators_search: %s\n" % e) 21 | -------------------------------------------------------------------------------- /examples/update_automation_example.py: -------------------------------------------------------------------------------- 1 | from __future__ import print_function 2 | import demisto_client.demisto_api 3 | from demisto_client.demisto_api.rest import ApiException 4 | from pprint import pprint 5 | 6 | api_key = 'YOUR API KEY' 7 | base_url = 'YOUR DEMISTO URL' 8 | 9 | # create an instance of the API class 10 | api_instance = demisto_client.configure(base_url=base_url, api_key=api_key, debug=True) 11 | automation_script_filter_wrapper = demisto_client.demisto_api.AutomationScriptFilterWrapper() 12 | script = demisto_client.demisto_api.AutomationScript() 13 | args = demisto_client.demisto_api.Argument() 14 | 15 | # Create Arguments 16 | args.name = 'system' 17 | args.required = True 18 | args.default = True 19 | args.description = 'The system name' 20 | 21 | # Create Script 22 | script.name = 'D2Remove' 23 | script.enabled = True 24 | script.version = -1 25 | script.type = 'python' 26 | script.arguments = [args] 27 | script.script = ''' 28 | result = demisto.executeCommand('d2_remove', demisto.args()) 29 | 30 | if isError(result[0]): 31 | demisto.results(result) 32 | else: 33 | demisto.results('D2 agent removed successfully') 34 | ''' 35 | 36 | automation_script_filter_wrapper.script = script 37 | 38 | try: 39 | # Create or update automation 40 | api_response = api_instance.save_or_update_script( 41 | automation_script_filter_wrapper=automation_script_filter_wrapper) 42 | pprint(api_response) 43 | except ApiException as e: 44 | print("Exception when calling DefaultApi->save_or_update_script: %s\n" % e) 45 | -------------------------------------------------------------------------------- /examples/widget_upload.py: -------------------------------------------------------------------------------- 1 | from __future__ import print_function 2 | import demisto_client.demisto_api 3 | from demisto_client.demisto_api.rest import ApiException 4 | from pprint import pprint 5 | 6 | api_key = 'YOUR API KEY' 7 | base_url = 'YOUR DEMISTO URL' 8 | 9 | # create an instance of the API class 10 | api_instance = demisto_client.configure(base_url=base_url, api_key=api_key, debug=True) 11 | widget = demisto_client.demisto_api.Widget() 12 | 13 | widget.name = 'Active Incidents - Pie chart' 14 | widget.query = '-category:job and -status:archived and -status:closed' 15 | widget.data_type = 'incidents' 16 | widget.widget_type = 'pie' 17 | 18 | try: 19 | # Import a widget 20 | api_response = api_instance.import_widget(widget=widget) 21 | pprint(api_response) 22 | except ApiException as e: 23 | print("Exception when calling DefaultApi->import_widget: %s\n" % e) 24 | -------------------------------------------------------------------------------- /poetry.toml: -------------------------------------------------------------------------------- 1 | [virtualenvs] 2 | in-project = true 3 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [tool.poetry] 2 | name = "demisto-py" 3 | version = "3.2.18" 4 | description = "\"A Python library for the Demisto API\"" 5 | authors = ["Demisto"] 6 | license = "Apache-2.0" 7 | readme = "README.md" 8 | packages = [{include = "demisto_client"}] 9 | homepage = "https://github.com/demisto/demisto-py" 10 | keywords=["Swagger", "Demisto API"] 11 | classifiers=[ 12 | 'Intended Audience :: Developers', 13 | 'Natural Language :: English', 14 | 'License :: OSI Approved :: Apache Software License', 15 | 'Programming Language :: Python', 16 | 'Programming Language :: Python :: 3.8', 17 | 'Programming Language :: Python :: 3.9', 18 | 'Programming Language :: Python :: 3.10', 19 | 'Programming Language :: Python :: 3.11', 20 | 'Programming Language :: Python :: 3.12', 21 | 'Programming Language :: Python :: Implementation :: CPython' 22 | ] 23 | 24 | [tool.poetry.dependencies] 25 | python = ">=3.9,<=3.13" 26 | certifi = "^2024.2.2" 27 | six = "^1.16" 28 | python-dateutil = "^2.7.2" 29 | urllib3 = "<2.1.0" # Can't update until CIAC-9648 is resolved 30 | tzlocal = "^5.2.0" 31 | setuptools = "^75.5.0" 32 | 33 | 34 | 35 | [tool.poetry.group.dev.dependencies] 36 | pytest = "^8.0.0" 37 | pytest-mock = "^3.12.0" 38 | freezegun = "^1.4.0" 39 | 40 | [build-system] 41 | requires = ["poetry-core"] 42 | build-backend = "poetry.core.masonry.api" 43 | -------------------------------------------------------------------------------- /swagger-config.json: -------------------------------------------------------------------------------- 1 | { 2 | "packageName": "demisto_client.demisto_api", 3 | "projectName": "demisto-py", 4 | "packageVersion": "2.0.0", 5 | "packageUrl": "https://github.com/demisto/demisto-py" 6 | } -------------------------------------------------------------------------------- /tests/examples_test.py: -------------------------------------------------------------------------------- 1 | import pprint 2 | from demisto_client.demisto_api import rest 3 | 4 | UPDATE_AUTOMATION_EXAMPLE_PATH = './examples/update_automation_example.py' 5 | 6 | 7 | class Response: 8 | def __init__(self, data): 9 | self.data = data 10 | 11 | 12 | def test_run_update_automation_example(mocker): 13 | """ 14 | Given: A demisto instance. 15 | When: Running the update_automation_example.py script. 16 | Then: Ensure no errors are raised. 17 | """ 18 | mocker.patch.object(rest.RESTClientObject, 'POST', return_value=Response(data='{ok}')) 19 | mocked_pprint = mocker.patch.object(pprint, 'pprint') 20 | with open(UPDATE_AUTOMATION_EXAMPLE_PATH) as example_file: 21 | exec(example_file.read()) 22 | 23 | mocked_pprint.assert_called_once() 24 | -------------------------------------------------------------------------------- /verify.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # exit on errors 4 | set -e 5 | 6 | # Script to run extra verifications 7 | 8 | # Verify that code-gen.sh doesn't generate a diff 9 | bash ./gen-code.sh