{"info":{"_postman_id":"a3bb56bd-b9d1-4210-812a-acb76b57ec80","name":"Respond (CFTR) API Reference","description":"

Cyware Fusion and Threat Response (CFTR) is a threat response automation platform that combines cyber fusion, advanced orchestration, and automation. Using the CFTR application security analysts can tackle all kinds of threats including malware, vulnerabilities, incidents, campaigns, and threat actors. Using the CFTR integrated threat databases, security analysts can manage and respond to all kinds of security threats such as malware, vulnerabilities, and threat actors.

CFTR API is organized around REST. You can use this API Reference to engage with the CFTR services programmatically and enable any automation or integration with other systems in your environment.

Note: You can make a maximum of 6000 API requests every 15 minutes to Respond.

Supported Version

Cyware Fusion and Threat Response (CFTR) v3.0 and higher.

Note: You can download the Postman API collection and Swagger API collection using the following links:

Postman Collection
\n
Swagger Collection
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"4787352","collectionId":"a3bb56bd-b9d1-4210-812a-acb76b57ec80","publishedId":"UVeDuTqn","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2024-04-19T13:01:08.000Z"},"item":[{"name":"Authentication","item":[{"name":"Test connectivity","id":"9a201708-0774-430b-b9bf-85c9b8fe6ed1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/test-connectivity/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Test the connectivity with the CFTR platform.

Request Parameters

This API endpoint does not require any input parameter.

Response

The API response status is 200 (OK) if all the following parameters are correct:

Base URL
URL Path
Access ID
Signature
Expires

\n","urlObject":{"path":["test-connectivity",""],"host":["{{base_url}}"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"dbfb1faf-11b0-47f6-87a3-2e97f46510f8","name":"Test connectivity","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/cftrapi/openapi/test-connectivity/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}"],"path":["cftrapi","openapi","test-connectivity",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 08 Sep 2021 06:34:55 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"9","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Allow","value":"GET, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"\"Success\""}],"_postman_id":"9a201708-0774-430b-b9bf-85c9b8fe6ed1"}],"id":"bdcdac06-f197-41cd-91a4-1226743079f0","description":"

Mandatory Parameters in CFTR API calls

For any API URL request made to the CFTR application, you must include three mandatory parameters, namely Access ID, Expires, and Signature.

Access ID - Access ID is available to you when you generate API credentials from the CFTR application.
Expires - Expires indicates when this request expires. Use the below formula to make expires. Default margin for expiry is 20 seconds.
expires = current time + 20 sec
Signature - Create a signature from Access ID, Secret Key, and Expires Time.

You can get the access ID and the secret key when you generate API credentials from the CFTR application.

Base URL

A base URL (base_url) is the consistent part of your web address for the CFTR application. https://example.com/cftrapi/ is an example of a Base URL.

Create Signature

Create your signature from Access ID, Secret Key, and Expires Time. The following Python code is a sample to generate signature for Endpoint authentication.

import base64\nimport hashlib\nimport hmac\nimport time\nexpires = int(time.time() + 20) # expires in 20 sec\ndef generate_signature(access_id, secret_key, expires):\n to_sign = '{}\\n{}'.format(access_id, expires)\n return base64.b64encode(\n     hmac.new(\n         secret_key.encode('utf-8'),\n         to_sign.encode('utf-8'),\n         hashlib.sha1\n     ).digest()).decode(\"utf-8\")\n#------------------------------------------------------------------\n#Example:\n#access_id = \"7e4e6a9c-11ca-40f4-95af-edae017358d0\"\n#secret_key = \"e61e92fb-bfd9-4cef-9b21-6f1e8211b77b\"\n#signature = generate_signature(access_id, secret_key, expires)\n\n

Example Endpoint

/openapi/v1/incident/?Expires=1516693349&AccessID=185e9347-b3c3-4885-   af03-4144a8b815f0&Signature=TLy8CHozBvNXKxIi1VUgRRU9O00=\n\n

\n","_postman_id":"bdcdac06-f197-41cd-91a4-1226743079f0"},{"name":"Admin Panel","item":[{"name":"Form Management","item":[{"name":"Get Incident Workflows Listing","id":"dac14697-b9c3-451f-9d3f-336109b6d783","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/forms/incident/schema/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&page_size=30&schema_type=published","description":"

Retrieve a list of all the incident workflows with details from your CFTR application.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

Each incident workflow detail in the response contains the following parameters:

Parameter	Type	Description
`title`	String	Title of the Incident Workflow.
`description`	String	Description of the Incident Workflow.
`unique_id`	String	Unique Identifier String of UUID-4 format of the Incident Worflow.
`schema_type`	String	Defines the state of Incident Workflow as `draft` OR `published`.
`status`	String	Describes the state of Incident Workflow as `active` or `inactive`.
`is_default`	Boolean	Determines whether the Incident Workflow is the default one or not.
`object_identifier`	String	Determines the string name for Incident Module.
`phase_flow`	String	Determines the selected flow of Workflow phases as `linear` or `non-linear`.
`created`	String	Timestamp String in ISO Format describing the date-time of creation of the Incident Workflow.
`modified`	String	Timestamp String in ISO Format describing the date-time of latest modification of the Incident Workflow.
`created_by`	String	`user_id` in UUID-4 format of the user who created the Incident Workflow.
`modified_by`	String	`user_id` in UUID-4 format of the User who lastly modified the Incident Workflow.
`created_by_data`	Object	Basic details of the user who created the Incident Workflow.
`modified_by_data`	Object	Basic details of the user who lastly modified the Incident Workflow.
`is_removed`	Boolean	Determines whether the Workflow is in deleted state or not.
`is_mapped`	Boolean	Determines whether the Incident Workflow has been mapped to parent parameters or not.
`num_of_phases`	Integer	Determines the number of phases present in the Incident Workflow.
`is_imported`	Boolean	Determines if the Workflow is imported or not.

","urlObject":{"path":["forms","incident","schema",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"description":{"content":"

[integer] [Optional] [Default: 10] Enter the number of records required on one page.

\n","type":"text/plain"},"key":"page_size","value":"30"},{"description":{"content":"

[String] [Optional] Enter the status of the Incident Workflow. Allowed values:

draft
published

\n","type":"text/plain"},"key":"schema_type","value":"published"}],"variable":[]}},"response":[{"id":"41a1cb12-96ec-47df-abdd-93885a5285b4","name":"Get Incident Workflows Listing","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/forms/incident/schema/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&page_size=30&schema_type=draft","host":["{{base_url}}v1"],"path":["forms","incident","schema",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"page_size","value":"30","description":"[integer] [Optional] [Default: 10] Enter the number of records to be displayed on one page."},{"key":"schema_type","value":"draft","description":"[String] [Optional] Enter the status of the Incident Workflow. Allowed values:\n- draft\n- published"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 16 Dec 2023 12:58:17 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: http: data: blob:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 10,\n \"results\": [\n {\n \"title\": \"Incident Workflow19:48:32\",\n \"description\": null,\n \"unique_id\": \"6580f1e2-f1e2-487e-9b78-3b71b56a7806\",\n \"schema_type\": \"draft\",\n \"status\": \"active\",\n \"is_default\": false,\n \"object_identifier\": \"incident\",\n \"phase_flow\": \"LINEAR\",\n \"created\": \"2023-12-15T19:48:36.933934Z\",\n \"modified\": \"2023-12-15T19:48:36.933934Z\",\n \"created_by\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"modified_by\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"created_by_data\": {\n \"username\": \"automation\",\n \"first_name\": \"Ui\",\n \"last_name\": \"Automation\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"cftr_qa@cyware.com\",\n \"full_name\": \"Ui Automation\"\n },\n \"modified_by_data\": {\n \"username\": \"automation\",\n \"first_name\": \"Ui\",\n \"last_name\": \"Automation\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"cftr_qa@cyware.com\",\n \"full_name\": \"Ui Automation\"\n },\n \"is_removed\": false,\n \"is_mapped\": false,\n \"num_of_phases\": 0,\n \"is_imported\": false\n },\n {\n \"title\": \"Incident Workflow19:46:32\",\n \"description\": null,\n \"unique_id\": \"384f4ea1-306f-4aef-ad08-7b96b8b0f4ea\",\n \"schema_type\": \"draft\",\n \"status\": \"active\",\n \"is_default\": false,\n \"object_identifier\": \"incident\",\n \"phase_flow\": \"LINEAR\",\n \"created\": \"2023-12-14T19:46:37.619084Z\",\n \"modified\": \"2023-12-14T19:46:37.619084Z\",\n \"created_by\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"modified_by\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"created_by_data\": {\n \"username\": \"automation\",\n \"first_name\": \"Ui\",\n \"last_name\": \"Automation\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"cftr_qa@cyware.com\",\n \"full_name\": \"Ui Automation\"\n },\n \"modified_by_data\": {\n \"username\": \"automation\",\n \"first_name\": \"Ui\",\n \"last_name\": \"Automation\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"cftr_qa@cyware.com\",\n \"full_name\": \"Ui Automation\"\n },\n \"is_removed\": false,\n \"is_mapped\": false,\n \"num_of_phases\": 0,\n \"is_imported\": false\n },\n {\n \"title\": \"Incident Workflow19:46:30\",\n \"description\": null,\n \"unique_id\": \"52bc4f5a-eff1-453d-a750-e70c029ae1bb\",\n \"schema_type\": \"draft\",\n \"status\": \"active\",\n \"is_default\": false,\n \"object_identifier\": \"incident\",\n \"phase_flow\": \"LINEAR\",\n \"created\": \"2023-12-13T19:46:35.642665Z\",\n \"modified\": \"2023-12-13T19:46:35.642665Z\",\n \"created_by\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"modified_by\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"created_by_data\": {\n \"username\": \"automation\",\n \"first_name\": \"Ui\",\n \"last_name\": \"Automation\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"cftr_qa@cyware.com\",\n \"full_name\": \"Ui Automation\"\n },\n \"modified_by_data\": {\n \"username\": \"automation\",\n \"first_name\": \"Ui\",\n \"last_name\": \"Automation\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"cftr_qa@cyware.com\",\n \"full_name\": \"Ui Automation\"\n },\n \"is_removed\": false,\n \"is_mapped\": false,\n \"num_of_phases\": 0,\n \"is_imported\": false\n },\n {\n \"title\": \"Incident Workflow19:49:36\",\n \"description\": null,\n \"unique_id\": \"270d867d-044e-4416-b21c-7404aac680e4\",\n \"schema_type\": \"draft\",\n \"status\": \"active\",\n \"is_default\": false,\n \"object_identifier\": \"incident\",\n \"phase_flow\": \"LINEAR\",\n \"created\": \"2023-12-11T19:49:41.017314Z\",\n \"modified\": \"2023-12-13T08:20:52.248283Z\",\n \"created_by\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"modified_by\": \"224b2a70-28fd-4984-9338-d9d0535aeaad\",\n \"created_by_data\": {\n \"username\": \"automation\",\n \"first_name\": \"Ui\",\n \"last_name\": \"Automation\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"cftr_qa@cyware.com\",\n \"full_name\": \"Ui Automation\"\n },\n \"modified_by_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"224b2a70-28fd-4984-9338-d9d0535aeaad\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System Default\"\n },\n \"is_removed\": false,\n \"is_mapped\": false,\n \"num_of_phases\": 0,\n \"is_imported\": false\n },\n {\n \"title\": \"Incident Workflow19:48:43\",\n \"description\": null,\n \"unique_id\": \"961d94d3-a2af-46f5-8c52-596530d52779\",\n \"schema_type\": \"draft\",\n \"status\": \"active\",\n \"is_default\": false,\n \"object_identifier\": \"incident\",\n \"phase_flow\": \"LINEAR\",\n \"created\": \"2023-12-10T19:48:48.321184Z\",\n \"modified\": \"2023-12-13T08:18:55.350106Z\",\n \"created_by\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"modified_by\": \"224b2a70-28fd-4984-9338-d9d0535aeaad\",\n \"created_by_data\": {\n \"username\": \"automation\",\n \"first_name\": \"Ui\",\n \"last_name\": \"Automation\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"cftr_qa@cyware.com\",\n \"full_name\": \"Ui Automation\"\n },\n \"modified_by_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"224b2a70-28fd-4984-9338-d9d0535aeaad\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System Default\"\n },\n \"is_removed\": false,\n \"is_mapped\": false,\n \"num_of_phases\": 0,\n \"is_imported\": false\n },\n {\n \"title\": \"Incident Workflow19:48:38\",\n \"description\": null,\n \"unique_id\": \"6323d7d9-3918-496a-bb08-319d68da1801\",\n \"schema_type\": \"draft\",\n \"status\": \"active\",\n \"is_default\": false,\n \"object_identifier\": \"incident\",\n \"phase_flow\": \"LINEAR\",\n \"created\": \"2023-12-12T19:48:43.291213Z\",\n \"modified\": \"2023-12-12T19:48:43.291213Z\",\n \"created_by\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"modified_by\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"created_by_data\": {\n \"username\": \"automation\",\n \"first_name\": \"Ui\",\n \"last_name\": \"Automation\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"cftr_qa@cyware.com\",\n \"full_name\": \"Ui Automation\"\n },\n \"modified_by_data\": {\n \"username\": \"automation\",\n \"first_name\": \"Ui\",\n \"last_name\": \"Automation\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"cftr_qa@cyware.com\",\n \"full_name\": \"Ui Automation\"\n },\n \"is_removed\": false,\n \"is_mapped\": false,\n \"num_of_phases\": 0,\n \"is_imported\": false\n },\n {\n \"title\": \"Incident Workflow19:48:59\",\n \"description\": null,\n \"unique_id\": \"fbc07455-c652-46a9-9175-9fca9d04248e\",\n \"schema_type\": \"draft\",\n \"status\": \"active\",\n \"is_default\": false,\n \"object_identifier\": \"incident\",\n \"phase_flow\": \"LINEAR\",\n \"created\": \"2023-12-09T19:49:04.614240Z\",\n \"modified\": \"2023-12-09T19:49:04.614240Z\",\n \"created_by\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"modified_by\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"created_by_data\": {\n \"username\": \"automation\",\n \"first_name\": \"Ui\",\n \"last_name\": \"Automation\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"cftr_qa@cyware.com\",\n \"full_name\": \"Ui Automation\"\n },\n \"modified_by_data\": {\n \"username\": \"automation\",\n \"first_name\": \"Ui\",\n \"last_name\": \"Automation\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"cftr_qa@cyware.com\",\n \"full_name\": \"Ui Automation\"\n },\n \"is_removed\": false,\n \"is_mapped\": false,\n \"num_of_phases\": 0,\n \"is_imported\": false\n },\n {\n \"title\": \"Incident Workflow19:49:02\",\n \"description\": null,\n \"unique_id\": \"a923489b-a589-4eb0-b170-4476b6f132ea\",\n \"schema_type\": \"draft\",\n \"status\": \"active\",\n \"is_default\": false,\n \"object_identifier\": \"incident\",\n \"phase_flow\": \"LINEAR\",\n \"created\": \"2023-12-08T19:49:07.071316Z\",\n \"modified\": \"2023-12-08T19:49:07.071316Z\",\n \"created_by\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"modified_by\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"created_by_data\": {\n \"username\": \"automation\",\n \"first_name\": \"Ui\",\n \"last_name\": \"Automation\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"cftr_qa@cyware.com\",\n \"full_name\": \"Ui Automation\"\n },\n \"modified_by_data\": {\n \"username\": \"automation\",\n \"first_name\": \"Ui\",\n \"last_name\": \"Automation\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"cftr_qa@cyware.com\",\n \"full_name\": \"Ui Automation\"\n },\n \"is_removed\": false,\n \"is_mapped\": false,\n \"num_of_phases\": 0,\n \"is_imported\": false\n },\n {\n \"title\": \"Incident Workflow19:56:24\",\n \"description\": null,\n \"unique_id\": \"3a0a310d-f5c0-405e-a15c-2ad2a7e698d5\",\n \"schema_type\": \"draft\",\n \"status\": \"active\",\n \"is_default\": false,\n \"object_identifier\": \"incident\",\n \"phase_flow\": \"LINEAR\",\n \"created\": \"2023-12-07T19:56:29.492581Z\",\n \"modified\": \"2023-12-07T19:56:29.492581Z\",\n \"created_by\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"modified_by\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"created_by_data\": {\n \"username\": \"automation\",\n \"first_name\": \"Ui\",\n \"last_name\": \"Automation\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"cftr_qa@cyware.com\",\n \"full_name\": \"Ui Automation\"\n },\n \"modified_by_data\": {\n \"username\": \"automation\",\n \"first_name\": \"Ui\",\n \"last_name\": \"Automation\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"cftr_qa@cyware.com\",\n \"full_name\": \"Ui Automation\"\n },\n \"is_removed\": false,\n \"is_mapped\": false,\n \"num_of_phases\": 0,\n \"is_imported\": false\n },\n {\n \"title\": \"Incident Workflow19:58:15\",\n \"description\": null,\n \"unique_id\": \"61464e3d-2c32-4ff4-9dcd-2533e9011153\",\n \"schema_type\": \"draft\",\n \"status\": \"active\",\n \"is_default\": false,\n \"object_identifier\": \"incident\",\n \"phase_flow\": \"LINEAR\",\n \"created\": \"2023-12-06T19:58:19.828761Z\",\n \"modified\": \"2023-12-06T19:58:19.828761Z\",\n \"created_by\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"modified_by\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"created_by_data\": {\n \"username\": \"automation\",\n \"first_name\": \"Ui\",\n \"last_name\": \"Automation\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"cftr_qa@cyware.com\",\n \"full_name\": \"Ui Automation\"\n },\n \"modified_by_data\": {\n \"username\": \"automation\",\n \"first_name\": \"Ui\",\n \"last_name\": \"Automation\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"cftr_qa@cyware.com\",\n \"full_name\": \"Ui Automation\"\n },\n \"is_removed\": false,\n \"is_mapped\": false,\n \"num_of_phases\": 0,\n \"is_imported\": false\n }\n ]\n}"}],"_postman_id":"dac14697-b9c3-451f-9d3f-336109b6d783"},{"name":"List Incident Workflow Fields","event":[{"listen":"prerequest","script":{"id":"f103be37-fc3f-47aa-94f2-8560cc38b916","exec":["var accessid = pm.environment.get(\"open_api_access_id\");","var secret_key = pm.environment.get(\"open_api_secret_key\");","/*"," -generating epochtime"," -epochtime is being send in expires parameter of params"," -sign is generated and then passed for generating signature","*/","pm.environment.set(\"unixtimestamp\",Math.round(Date.now()/1000));","var expires = pm.environment.get(\"unixtimestamp\")+15;","pm.environment.set('UTC Timezone', new Date().toISOString());","pm.environment.set(\"expires\", expires);","var to_sign = accessid+\"\\n\"+expires;","/*","Generate Signature for Authentication"," -Key based hashing is done using HMAC-SHA1 Algorithm"," -This is then converted into base64"," -Finally the generated signature is URL Encoded so as to make all the special characters URL Safe","*/","var hash = CryptoJS.HmacSHA1(to_sign, secret_key);","var hashInBase64 = encodeURIComponent(CryptoJS.enc.Base64.stringify(hash));","pm.environment.set(\"signature\",hashInBase64);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"06d21c55-667e-44fc-b4b7-9b48090686f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{base_url}}v1/forms/fields/?object_identifier=incident&type=threat_method&AccessID ={{open_api_access_id}}&Signature={{signature}}&Expires={{expires}}","description":"

Get Incident Types

Retrieve details of the Fields present in Form Management module of the Respond.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
results	array	Returns the list of fields added in the Form Management.
unique_id	string	Returns the unique identifier of the incident.
field_name	string	Returns the name of the incident form field. For example, Incident Type
field_type	string	Enter the type for the field For example, `select` to indicate a dropdown.
is_active	boolean	Indicates whether this field is currently active.
is_removed	boolean	Indicates whether this field was deleted or not.
order	integer	Returns the position of the field in the incident form layout.
placeholder	string	Returns the placeholder text shown when no option is selected.
help_text	string	Returns the tooltip text of the field.
field_options	array	Returns the list of selectable options.
is_editable	boolean	Indicates whether this field configuration can be edited.
is_deletable	boolean	Indicates whether this field can be deleted from the configuration.
is_table_column	boolean	Indicates whether this field is shown as a column in the listing page.
is_required	boolean	Indicates whether this field is mandatory when submitting the form.
is_required_for_creation	boolean	Indicates whether a value is mandatory only when creating a new incident.
type	string	Returns the type of the field.
prepopulator_value	string or null	Returns any default value configured for this field.
field_readable_key	string	Returns the key used to uniquely identify this field. For example, `ie_incident_type`
is_widget_field	boolean	Indicates whether this field is available as a widget element in the UI.
extra_params	object	Returns the other details of the field.
data_source	string	Returns data source for populating this field.
dependent_options_data	array	Returns the configurations for options that depend on other field values.
always_visible	boolean	Indicates whether this field is always visible, regardless of conditions.
column_no	integer	Column index where the field appears in multi-column layouts.
is_read_only	boolean	Indicates whether the field is read-only.
is_sla_field	boolean	Indicates whether this field is related to SLA.
enable_filter	boolean	Indicates whether this field can be used as a filter in search.
is_restricted_user_group_write_access	boolean	Indicates if write access to this field is restricted to specific user groups.
user_groups_with_write_access	array	Returns the IDs of user groups that have write access to this field.
is_restricted	boolean	Indicates whether access to this field is restricted to specific user or user groups.
user_groups_with_write_access_data	array	Returns the detailed metadata for user groups that have write access.
is_parent_param	boolean	Indicates whether this field acts as a parent parameter for dependent fields.
is_field_new	boolean	Indicates whether this field is newly added in the form.
note_mandatory	boolean	Indicates whether adding a note is mandatory when modifying this field.
editable_fields	array	Returns the list of sub fields that can be edited for this field.
is_enabled	boolean	Indicates whether this field is enabled and available in the UI.
editable_readable_key	boolean	Indicates whether the field's readable key can be edited.
process_intel_automatically	boolean	Indicates whether intelligence processing is automatically enabled for this field.
process_intel_cftr_enable	boolean	Indicates whether Respond-specific intelligence processing is enabled for this field.
process_intel_ctix_enable	boolean	Indicates whether CTIX-specific threat intelligence processing is enabled for this field.
is_dynamic_column	boolean	Indicates whether this field is treated as a dynamic column in tabular views.

","urlObject":{"path":["forms","fields",""],"host":["{{base_url}}v1"],"query":[{"description":{"content":"

Pass the object identifier. For example, incident, action

\n","type":"text/plain"},"key":"object_identifier","value":"incident"},{"description":{"content":"

Pass the field type. Predefined values exist for out-of-the-box fields, while newly created fields belong to the \"other\" type.

\n","type":"text/plain"},"key":"type","value":"threat_method"},{"key":"AccessID ","value":"{{open_api_access_id}}"},{"key":"Signature","value":"{{signature}}"},{"key":"Expires","value":"{{expires}}"}],"variable":[]}},"response":[{"id":"4cef5586-ceca-44ab-b33d-ab5df0d2fccf","name":"Fetch Incident Type Field","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/forms/fields/?object_identifier=incident&type=threat_method&AccessID={{open_api_access_id}}&Signature={{signature}}&Expires={{expires}}","host":["{{base_url}}v1"],"path":["forms","fields",""],"query":[{"key":"object_identifier","value":"incident"},{"key":"type","value":"threat_method"},{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Signature","value":"{{signature}}"},{"key":"Expires","value":"{{expires}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 17 Feb 2026 09:36:11 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET, POST, PUT, HEAD, OPTIONS"},{"key":"Vary","value":"origin, Cookie"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"Content-Security-Policy","value":"img-src https: http: data: blob:;"},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"unique_id\": \"af3bcdbb-e326-4034-a535-f568be8f0a51\",\n \"field_name\": \"Incident Type\",\n \"field_type\": \"select\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 11,\n \"placeholder\": \"Select Incident Type\",\n \"help_text\": \"\",\n \"field_options\": [\n {\n \"unique_id\": \"1a52d2d3-d81d-444b-b4d7-5203a44548f1\",\n \"option_name\": \"APT\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"af3bcdbb-e326-4034-a535-f568be8f0a51\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"3035b451-e903-45ec-9f89-8fa515338b85\",\n \"option_name\": \"Error\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"af3bcdbb-e326-4034-a535-f568be8f0a51\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"63ec3620-3513-4f71-a417-05631544d8e2\",\n \"option_name\": \"Hacking\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"af3bcdbb-e326-4034-a535-f568be8f0a51\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"eb74f6c6-72a3-42ce-8dfc-5f20184b1a67\",\n \"option_name\": \"Improper Disposal\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"af3bcdbb-e326-4034-a535-f568be8f0a51\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"6831fda7-92d0-4b08-a4a4-f53a87880a6d\",\n \"option_name\": \"IP Spoofing\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"af3bcdbb-e326-4034-a535-f568be8f0a51\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"9293faa9-5737-47fd-8cbc-3b7d1bff1e7a\",\n \"option_name\": \"Lost Device\",\n \"is_active\": true,\n \"order\": 5,\n \"option_field\": \"af3bcdbb-e326-4034-a535-f568be8f0a51\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"6e92c112-3868-4832-b1c1-0dadba9b14ea\",\n \"option_name\": \"Malware\",\n \"is_active\": true,\n \"order\": 6,\n \"option_field\": \"af3bcdbb-e326-4034-a535-f568be8f0a51\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"8f108848-34b7-498d-9b55-26f4e829fba4\",\n \"option_name\": \"Network Scanning\",\n \"is_active\": true,\n \"order\": 7,\n \"option_field\": \"af3bcdbb-e326-4034-a535-f568be8f0a51\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"f104aba0-5de9-4a77-8d78-0e88bcb318a0\",\n \"option_name\": \"Phishing\",\n \"is_active\": true,\n \"order\": 8,\n \"option_field\": \"af3bcdbb-e326-4034-a535-f568be8f0a51\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"bce1dd15-8896-4edf-8fa3-017b737ee065\",\n \"option_name\": \"Spamming\",\n \"is_active\": true,\n \"order\": 9,\n \"option_field\": \"af3bcdbb-e326-4034-a535-f568be8f0a51\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"5aa6478f-6f91-4bf5-8cc4-1be8038e5945\",\n \"option_name\": \"Spearphishing\",\n \"is_active\": true,\n \"order\": 10,\n \"option_field\": \"af3bcdbb-e326-4034-a535-f568be8f0a51\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"db0b47a4-0c82-4581-926b-3e9495ef7584\",\n \"option_name\": \"System Misuse\",\n \"is_active\": true,\n \"order\": 11,\n \"option_field\": \"af3bcdbb-e326-4034-a535-f568be8f0a51\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"f5a712f4-0bb2-4a42-886a-7d653234569b\",\n \"option_name\": \"User Account Compromise\",\n \"is_active\": true,\n \"order\": 12,\n \"option_field\": \"af3bcdbb-e326-4034-a535-f568be8f0a51\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"10c5be41-a967-4921-a554-808ab3ee0365\",\n \"option_name\": \"Website Defacement\",\n \"is_active\": true,\n \"order\": 13,\n \"option_field\": \"af3bcdbb-e326-4034-a535-f568be8f0a51\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"2ef32bff-fcc8-4536-b773-39ea910f8e54\",\n \"option_name\": \"Other\",\n \"is_active\": true,\n \"order\": 14,\n \"option_field\": \"af3bcdbb-e326-4034-a535-f568be8f0a51\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n }\n ],\n \"is_editable\": true,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": true,\n \"is_required_for_creation\": false,\n \"type\": \"threat_method\",\n \"is_tabbable\": true,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"ie_incident_type\",\n \"is_widget_field\": true,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": true,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false,\n \"is_dynamic_column\": false\n }\n ]\n}"}],"_postman_id":"06d21c55-667e-44fc-b4b7-9b48090686f2"},{"name":"Get Incident Workflow Details","id":"fd2cbd93-f8f2-411a-9bb5-2ff978732e01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/forms/incident/schema/:workflow_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the details of an incident workflow.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

Each incident workflow detail in the response contains the following parameters:

Parameter	Type	Description
`title`	String	Title of the Incident Workflow.
`description`	String	Description of the Incident Workflow.
`unique_id`	String	Unique ID of the Incident Workflow.
`schema_type`	String	Shows the state of Incident Workflow. Allowed values: - `draft` - `published`
`status`	String	Status of the Incident Workflow. Allowed values: - `active` - `inactive`
`is_default`	Boolean	Shows whether the Incident Workflow is the default workflow or not.
`object_identifier`	String	Shows the string name for Incident module.
`phase_flow`	String	Shows the phase flow of the Incident Workflow phases. Allowed values: - `linear` - `non-linear`
`created`	String	Creation date-time of the Incident Workflow.
`modified`	String	Latest modification date-time of the Incident Workflow.
`created_by`	String	`user_id` of the user who created the Incident Workflow.
`modified_by`	String	`user_id` of the user who last modified the Incident Workflow.
`created_by_data`	Object	Basic details of user who created the Incident Workflow.
`modified_by_data`	Object	Basic details of the user who last modified the Incident Workflow.
`is_removed`	Boolean	Shows whether the workflow is in deleted state or not.
`is_mapped`	Boolean	Shows whether the Incident Workflow has been mapped to parent parameters or not.
`num_of_phases`	Integer	Number of phases present in the Incident Workflow.
`closure_phase`	String	`unique_id` of phase after which incident can be closed.
`closure_phase_data`	Object	Details of the closure phase. Details include: `option_name`, `unique_id`, and so on.
`phase_key`	String	`unique_id` of the phases.
`preparation_key`	String	`unique_id` of the preparation tab.
`custom_tab_key`	String	`unique_id` of the custom tabs.
`closure_phase_options`	Array	`unique_id` of all the phases of the Incident Workflow which can be selected as the closure phase.
`tabs`	Array	`unique_id` of the tabs of the Incident Workflow.

Response Parameters | Form Tab Structure

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the Tab.
`tab_name`	String	Title of the tab.
`is_active`	Boolean	Shows if the tab is active or not.
`is_editable`	Boolean	Shows if the tab can be edited or not.
`is_removed`	Boolean	Shows whether the tab is in deleted state or not.
`object_identifier`	String	Shows the string name for Incident module
`tab_fields`	List of Objects	Details of the fields added in the tab. Note: The tab fields are further explained in the table below.
`tab_type`	String	The tab type. Examples of tab types are: `preparation`: Preparation tab is common across all workflows. `phase`: Phase `custom`: Custom Tab
`parent`	String	`unique_id` of the parent of the tab.
`children`	List	Details of children tabs.
`is_removable`	Boolean	Shows if tab can be removed or not.
`validation_expression`	String	Validation expression (if any) added. It is used for Threat Intel.
`schema`	List	List of `unique_id` of workflows in which the tab is added.
`order`	Integer	Order of the tab.
`help_text`	String	Help text of the tab

Response Parameters | Tab Fields Structure

Parameter	Type	Description
`unique_id`	String	Unique identifier string of UUID-4 format of the Field.
`field_name`	String	Title of the field.
`field_type`	String	The type of field. Allowed values: `select`: Single option can be selected for the field. `multiselect`: Multiple options can be selected for the field. `text`: Text field. `textarea`: Text Area field. `calendar`: date time field. `integer`: Integer Field.
`is_active`	Boolean	Shows whether field is active or not.
`is_removed`	Boolean	Shows whether the field is in deleted state or not.
`placeholder`	String	Placeholder of the field.
`help_text`	String	Help text of the field.
`field_options`	List of Objects	Details of the options.
`is_editable`	Boolean	Shows whether field can be edited or not.
`is_deletable`	Boolean	Shows whether field can be deleted or not.
`is_required`	Boolean	Shows whether the field is mandatory or not.
`field_readable_key`	String	Unique readable key for receiving field data from external sources.
`is_widget_field`	Boolean	Shows whether the widget can be created for this field or not. (Applicable only on select/multi-select fields)
`validation_expression`	String	Validation expression (if any) added. It is used for Threat Intel.
`is_read_only`	Boolean	Shows whether the field is one time entry field or not.
`enable_filter`	Boolean	Shows whether the filter option should be provided for this field or not. Applicable only for select/multi-select fields.
`is_restricted_user_group_write_access`	Boolean	Shows whether the field access is restricted by user group.
`user_groups_with_write_access`	List	List of `group_comm_id` of user groups that have write access to the field.
`is_restricted`	Boolean	Shows whether the current user has write access to the field or not.
`user_groups_with_write_access_data`	List of Objects	Basic details of user groups that have write access to the field.
`is_parent_param`	Boolean	Shows whether the field is selected as a parent parameter or not.
`order`	Integer	Order of the field. (Defines the position of the field in the form)
`column_no`	Integer	Column Number of the field. (Defines the column of the field in the form). Allowed values: `1`: Field will be present in left column `2`: Field will be present in right column.
`request_notes`	String	Reason for updating the field (Single select fields).

","urlObject":{"path":["forms","incident","schema",":workflow_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the Incident Workflow in UUID-4 Format.

\n","type":"text/plain"},"type":"any","value":"5ca19332-75e2-4e1b-953a-22f8b467ea1d","key":"workflow_unique_id"}]}},"response":[{"id":"988d34e3-ecfe-4fa7-851a-fbb4b3928859","name":"Get Incident Workflow Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/forms/incident/schema/:workflow_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["forms","incident","schema",":workflow_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"workflow_unique_id","value":"52bc4f5a-eff1-453d-a750-e70c029ae1bb","description":"Enter the unique ID of the Incident Workflow in UUID-4 Format."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 16 Dec 2023 17:41:20 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: http: data: blob:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"Incident Workflow19:46:30\",\n \"description\": null,\n \"unique_id\": \"52bc4f5a-eff1-453d-a750-e70c029ae1bb\",\n \"schema_type\": \"draft\",\n \"status\": \"active\",\n \"is_default\": false,\n \"object_identifier\": \"incident\",\n \"phase_flow\": \"LINEAR\",\n \"closure_phase\": null,\n \"closure_phase_data\": null,\n \"created\": \"2023-12-13T19:46:35.642665Z\",\n \"modified\": \"2023-12-13T19:46:35.642665Z\",\n \"created_by\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"modified_by\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"tabs\": [\n {\n \"unique_id\": \"ac6bbc05-64d0-4c94-9bc8-fad77ba69004\",\n \"tab_name\": \"Basic Details\",\n \"is_active\": true,\n \"is_editable\": true,\n \"is_removed\": false,\n \"object_identifier\": \"incident\",\n \"tab_fields\": [\n {\n \"unique_id\": \"af92bb0f-b54a-47da-ad16-e162a11abc0b\",\n \"field_name\": \"Title\",\n \"field_type\": \"custom-text\",\n \"is_active\": true,\n \"is_removed\": false,\n \"placeholder\": \"Enter Title\",\n \"help_text\": \"\",\n \"field_options\": null,\n \"is_editable\": true,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": true,\n \"type\": \"title\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"title\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [\n \"field_name\",\n \"process_intel_automatically\",\n \"process_intel_cftr_enable\",\n \"process_intel_ctix_enable\"\n ],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": true,\n \"editable_readable_key\": false,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false,\n \"order\": 0,\n \"column_no\": 0\n },\n {\n \"unique_id\": \"b8b3f2b2-e288-41cf-aa6d-71f3e885b5b4\",\n \"field_name\": \"Assigned Group\",\n \"field_type\": \"select\",\n \"is_active\": true,\n \"is_removed\": false,\n \"placeholder\": \"Assigned Group\",\n \"help_text\": \"\",\n \"field_options\": [],\n \"is_editable\": true,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": true,\n \"type\": \"assigned_group\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"assigned_group\",\n \"is_widget_field\": false,\n \"extra_params\": {\n \"notes_required\": true\n },\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {\n \"permission_code\": \"view_incident\"\n },\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [\n \"field_name\"\n ],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": true,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false,\n \"order\": 1,\n \"column_no\": 1\n },\n {\n \"unique_id\": \"b6dd2b46-8d97-4942-8caf-27fb2303a9f4\",\n \"field_name\": \"Severity\",\n \"field_type\": \"select\",\n \"is_active\": true,\n \"is_removed\": false,\n \"placeholder\": \"Select Severity\",\n \"help_text\": \"\",\n \"field_options\": [\n {\n \"unique_id\": \"0a4ec850-1159-48bd-aa36-7736f87d40ef\",\n \"option_name\": \"Unknown\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"b6dd2b46-8d97-4942-8caf-27fb2303a9f4\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"d7a676f9-4255-4997-9a0b-82824d4cac24\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"b6dd2b46-8d97-4942-8caf-27fb2303a9f4\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"8105ec73-be3f-4585-9686-d8a6bd0dae0a\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"b6dd2b46-8d97-4942-8caf-27fb2303a9f4\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"e571fd70-9409-43de-bc78-8e50e370f918\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"b6dd2b46-8d97-4942-8caf-27fb2303a9f4\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"f65c11ac-1e1e-4809-9ebd-506a536c3a31\",\n \"option_name\": \"Critical\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"b6dd2b46-8d97-4942-8caf-27fb2303a9f4\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"e8156a06-9ffb-4adf-ae53-374830932bae\",\n \"option_name\": \"Crisis\",\n \"is_active\": true,\n \"order\": 5,\n \"option_field\": \"b6dd2b46-8d97-4942-8caf-27fb2303a9f4\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n }\n ],\n \"is_editable\": true,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": true,\n \"type\": \"level\",\n \"is_tabbable\": true,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"level\",\n \"is_widget_field\": true,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"is_read_only\": false,\n \"is_sla_field\": true,\n \"enable_filter\": true,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false,\n \"order\": 2,\n \"column_no\": 1\n },\n {\n \"unique_id\": \"2ed7d7b2-64b7-485c-8771-be563faf920c\",\n \"field_name\": \"Incident Type\",\n \"field_type\": \"select\",\n \"is_active\": true,\n \"is_removed\": false,\n \"placeholder\": \"Select Incident Type\",\n \"help_text\": \"\",\n \"field_options\": [\n {\n \"unique_id\": \"6081d67c-0f4b-4359-8c0c-74ca51636ccf\",\n \"option_name\": \"APT\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"2ed7d7b2-64b7-485c-8771-be563faf920c\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"7da29120-7ac4-41ca-8e80-ab2de847a276\",\n \"option_name\": \"Error\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"2ed7d7b2-64b7-485c-8771-be563faf920c\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"b07cabdf-4e46-4dcc-a2e0-ad03c5f85980\",\n \"option_name\": \"Hacking\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"2ed7d7b2-64b7-485c-8771-be563faf920c\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"93a7da3e-35a8-49da-8c52-f231cdf1dbf6\",\n \"option_name\": \"Improper Disposal\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"2ed7d7b2-64b7-485c-8771-be563faf920c\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"296d7f52-398a-4f2a-b17c-7912abfa52e8\",\n \"option_name\": \"IP Spoofing\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"2ed7d7b2-64b7-485c-8771-be563faf920c\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"4d6e2f93-e373-4ab9-aa43-75424c169062\",\n \"option_name\": \"Lost Device\",\n \"is_active\": true,\n \"order\": 5,\n \"option_field\": \"2ed7d7b2-64b7-485c-8771-be563faf920c\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"9599263a-e13e-40c4-9363-015b1ae039b0\",\n \"option_name\": \"Malware\",\n \"is_active\": true,\n \"order\": 6,\n \"option_field\": \"2ed7d7b2-64b7-485c-8771-be563faf920c\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"76bf9b26-aa44-4790-aa1b-28470d8f76ce\",\n \"option_name\": \"Network Scanning\",\n \"is_active\": true,\n \"order\": 7,\n \"option_field\": \"2ed7d7b2-64b7-485c-8771-be563faf920c\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"7ce6b213-9a0b-48f6-9261-30261f2eb7aa\",\n \"option_name\": \"Phishing\",\n \"is_active\": true,\n \"order\": 8,\n \"option_field\": \"2ed7d7b2-64b7-485c-8771-be563faf920c\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"b5ca6c17-860b-4633-8cf1-8bb10bd188fe\",\n \"option_name\": \"Spamming\",\n \"is_active\": true,\n \"order\": 9,\n \"option_field\": \"2ed7d7b2-64b7-485c-8771-be563faf920c\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"4d97a429-c827-4555-80cd-9726009be310\",\n \"option_name\": \"Spearphishing\",\n \"is_active\": true,\n \"order\": 10,\n \"option_field\": \"2ed7d7b2-64b7-485c-8771-be563faf920c\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"1682150f-90da-4c62-8742-d20492ac433e\",\n \"option_name\": \"System Misuse\",\n \"is_active\": true,\n \"order\": 11,\n \"option_field\": \"2ed7d7b2-64b7-485c-8771-be563faf920c\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"8802f33a-9dde-4aa1-8016-dc77d7bea640\",\n \"option_name\": \"User Account Compromise\",\n \"is_active\": true,\n \"order\": 12,\n \"option_field\": \"2ed7d7b2-64b7-485c-8771-be563faf920c\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"379159b9-43e7-4bad-9714-ff0b79e3673d\",\n \"option_name\": \"Website Defacement\",\n \"is_active\": true,\n \"order\": 13,\n \"option_field\": \"2ed7d7b2-64b7-485c-8771-be563faf920c\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"6bc438dc-a31a-4449-8d44-dc0af180199c\",\n \"option_name\": \"Other\",\n \"is_active\": true,\n \"order\": 14,\n \"option_field\": \"2ed7d7b2-64b7-485c-8771-be563faf920c\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n }\n ],\n \"is_editable\": true,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": true,\n \"type\": \"threat_method\",\n \"is_tabbable\": true,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"ie_incident_type\",\n \"is_widget_field\": true,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"is_read_only\": false,\n \"is_sla_field\": true,\n \"enable_filter\": true,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false,\n \"order\": 3,\n \"column_no\": 1\n },\n {\n \"unique_id\": \"af15d920-a873-4755-9b0e-82c379c4783b\",\n \"field_name\": \"Location(s) Impacted\",\n \"field_type\": \"multiselect\",\n \"is_active\": true,\n \"is_removed\": false,\n \"placeholder\": \"Select Location(s) Impacted\",\n \"help_text\": \"\",\n \"field_options\": [],\n \"is_editable\": false,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": true,\n \"type\": \"location\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"locations_impacted\",\n \"is_widget_field\": true,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": \"utils/location-hierarchy/\",\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"is_read_only\": false,\n \"is_sla_field\": true,\n \"enable_filter\": false,\n \"extra_query_params\": {\n \"all_data\": \"true\"\n },\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": true,\n \"editable_readable_key\": false,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false,\n \"order\": 4,\n \"column_no\": 1\n },\n {\n \"unique_id\": \"4a1a73b3-3e36-4130-8f21-5e4e36c3d676\",\n \"field_name\": \"Business Unit(s) Impacted\",\n \"field_type\": \"select\",\n \"is_active\": true,\n \"is_removed\": false,\n \"placeholder\": \"Select Business Unit(s) Impacted\",\n \"help_text\": \"\",\n \"field_options\": [],\n \"is_editable\": false,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": true,\n \"type\": \"business-unit\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"business_units_impacted\",\n \"is_widget_field\": true,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"is_read_only\": false,\n \"is_sla_field\": true,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": true,\n \"editable_readable_key\": false,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false,\n \"order\": 6,\n \"column_no\": 1\n },\n {\n \"unique_id\": \"2de72823-28b4-46a8-bc69-e169e07fa1dd\",\n \"field_name\": \"Customer Notification Required\",\n \"field_type\": \"select\",\n \"is_active\": true,\n \"is_removed\": false,\n \"placeholder\": \"Select Customer Notification Required\",\n \"help_text\": \"\",\n \"field_options\": [\n {\n \"unique_id\": \"0420e237-5f41-46e7-9e95-cfab42017368\",\n \"option_name\": \"Yes\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"2de72823-28b4-46a8-bc69-e169e07fa1dd\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"176b6ab9-61d9-4dc1-9d87-f935bbb233e1\",\n \"option_name\": \"No\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"2de72823-28b4-46a8-bc69-e169e07fa1dd\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"138456b8-e6a9-43a7-a1a2-41cdbbc79a7b\",\n \"option_name\": \"N/A\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"2de72823-28b4-46a8-bc69-e169e07fa1dd\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n }\n ],\n \"is_editable\": true,\n \"is_deletable\": false,\n \"is_table_column\": false,\n \"is_required\": true,\n \"type\": \"customer_notification_required\",\n \"is_tabbable\": true,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"ie_customer_notification_required\",\n \"is_widget_field\": true,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": true,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false,\n \"order\": 8,\n \"column_no\": 1\n },\n {\n \"unique_id\": \"dc861355-798d-468b-8cd8-72f25843499e\",\n \"field_name\": \"Assigned User\",\n \"field_type\": \"select\",\n \"is_active\": true,\n \"is_removed\": false,\n \"placeholder\": \"Assigned to\",\n \"help_text\": \"\",\n \"field_options\": [],\n \"is_editable\": true,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": true,\n \"type\": \"assigned_to_incident\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"assigned_to\",\n \"is_widget_field\": false,\n \"extra_params\": {\n \"notes_required\": true\n },\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [\n \"field_name\"\n ],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": true,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false,\n \"order\": 1,\n \"column_no\": 2\n },\n {\n \"unique_id\": \"17f9c5dd-3f48-4a89-8964-94fef65ad9e3\",\n \"field_name\": \"Incident Date\",\n \"field_type\": \"calendar\",\n \"is_active\": true,\n \"is_removed\": false,\n \"placeholder\": \"Select Incident Date\",\n \"help_text\": \"\",\n \"field_options\": null,\n \"is_editable\": true,\n \"is_deletable\": true,\n \"is_table_column\": true,\n \"is_required\": true,\n \"type\": \"incident_date\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"incident_date\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false,\n \"order\": 2,\n \"column_no\": 2\n },\n {\n \"unique_id\": \"b0f51fa4-9ed4-4a9f-ab48-8717e99d4b12\",\n \"field_name\": \"Detection Date\",\n \"field_type\": \"calendar\",\n \"is_active\": true,\n \"is_removed\": false,\n \"placeholder\": \"Select Detection Date\",\n \"help_text\": \"\",\n \"field_options\": null,\n \"is_editable\": true,\n \"is_deletable\": true,\n \"is_table_column\": true,\n \"is_required\": true,\n \"type\": \"other\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"detection_date\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false,\n \"order\": 3,\n \"column_no\": 2\n },\n {\n \"unique_id\": \"ffb4fa5d-6756-4293-b07a-18b3dac09977\",\n \"field_name\": \"Source\",\n \"field_type\": \"select\",\n \"is_active\": true,\n \"is_removed\": false,\n \"placeholder\": \"Select Source\",\n \"help_text\": \"\",\n \"field_options\": [],\n \"is_editable\": false,\n \"is_deletable\": true,\n \"is_table_column\": true,\n \"is_required\": true,\n \"type\": \"source\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"sources\",\n \"is_widget_field\": true,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false,\n \"order\": 8,\n \"column_no\": 2\n },\n {\n \"unique_id\": \"9c365dae-bcab-43b7-b0c4-acb35917e9ef\",\n \"field_name\": \"Description\",\n \"field_type\": \"textarea\",\n \"is_active\": true,\n \"is_removed\": false,\n \"placeholder\": \"Enter Description\",\n \"help_text\": \"\",\n \"field_options\": null,\n \"is_editable\": true,\n \"is_deletable\": true,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"description\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"description\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [\n \"field_name\",\n \"is_required\",\n \"process_intel_automatically\",\n \"process_intel_cftr_enable\",\n \"process_intel_ctix_enable\"\n ],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": false,\n \"process_intel_automatically\": true,\n \"process_intel_cftr_enable\": true,\n \"process_intel_ctix_enable\": false,\n \"order\": 1,\n \"column_no\": 0\n },\n {\n \"unique_id\": \"7cd1a88b-8778-4b13-a2cf-13da170bee48\",\n \"field_name\": \"Custom 1\",\n \"field_type\": \"text\",\n \"is_active\": true,\n \"is_removed\": false,\n \"placeholder\": \"\",\n \"help_text\": \"\",\n \"field_options\": null,\n \"is_editable\": true,\n \"is_deletable\": true,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"other\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"custom_1\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false,\n \"order\": 0,\n \"column_no\": 1\n },\n {\n \"unique_id\": \"82b22338-08ea-4382-8ff4-661aea8852df\",\n \"field_name\": \"False Positive\",\n \"field_type\": \"select\",\n \"is_active\": true,\n \"is_removed\": false,\n \"placeholder\": \"False Positive\",\n \"help_text\": \"\",\n \"field_options\": [\n {\n \"unique_id\": \"c692d68b-e8a0-484e-9a9e-7eeaa04b350e\",\n \"option_name\": \"Yes\",\n \"is_active\": true,\n \"order\": 1001,\n \"option_field\": \"82b22338-08ea-4382-8ff4-661aea8852df\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"b028dfa1-9eb7-48d8-b8d9-82b3b3b4cdf9\",\n \"option_name\": \"No\",\n \"is_active\": true,\n \"order\": 1002,\n \"option_field\": \"82b22338-08ea-4382-8ff4-661aea8852df\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n }\n ],\n \"is_editable\": true,\n \"is_deletable\": true,\n \"is_table_column\": false,\n \"is_required\": false,\n \"type\": \"other\",\n \"is_tabbable\": true,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"false_positive\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": true,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false,\n \"order\": 5,\n \"column_no\": 1\n },\n {\n \"unique_id\": \"969d73f5-ee79-4e7e-b0ab-cd0867e6d347\",\n \"field_name\": \"Regulatory Notification Required\",\n \"field_type\": \"select\",\n \"is_active\": true,\n \"is_removed\": false,\n \"placeholder\": \"Select Regulatory Notification Required\",\n \"help_text\": \"\",\n \"field_options\": [\n {\n \"unique_id\": \"dfeaaacb-b36f-4f18-bfb1-77181f63297a\",\n \"option_name\": \"Yes\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"969d73f5-ee79-4e7e-b0ab-cd0867e6d347\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"1ea1c7d4-49e8-4a6d-ab1f-677b4296024e\",\n \"option_name\": \"No\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"969d73f5-ee79-4e7e-b0ab-cd0867e6d347\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"2ae9e1cb-55af-4ca3-b0ec-d5e5e49db0c2\",\n \"option_name\": \"N/A\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"969d73f5-ee79-4e7e-b0ab-cd0867e6d347\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n }\n ],\n \"is_editable\": true,\n \"is_deletable\": true,\n \"is_table_column\": false,\n \"is_required\": false,\n \"type\": \"other\",\n \"is_tabbable\": true,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"ie_regulatory_notifications_required\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": true,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false,\n \"order\": 7,\n \"column_no\": 1\n },\n {\n \"unique_id\": \"57354a26-f121-477c-b764-7e32fc915730\",\n \"field_name\": \"Business Impact\",\n \"field_type\": \"multiselect\",\n \"is_active\": true,\n \"is_removed\": false,\n \"placeholder\": \"Select Business Impact\",\n \"help_text\": \"\",\n \"field_options\": [\n {\n \"unique_id\": \"5f40c4e5-fa62-4034-9196-b3b15a146230\",\n \"option_name\": \"Branding Impact\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"57354a26-f121-477c-b764-7e32fc915730\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"7e3cd665-5b5c-4c70-ae9c-a6eb7e1f0e63\",\n \"option_name\": \"Business Disruption\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"57354a26-f121-477c-b764-7e32fc915730\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"7d12292f-63c4-4de3-8706-5eafb85c7b22\",\n \"option_name\": \"Data Theft\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"57354a26-f121-477c-b764-7e32fc915730\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"49437501-c1c6-4194-b9c6-71a6767ed2b5\",\n \"option_name\": \"Financial Loss\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"57354a26-f121-477c-b764-7e32fc915730\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"d8272f15-2240-4a9c-8a2e-0cfab071bff7\",\n \"option_name\": \"IP Theft\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"57354a26-f121-477c-b764-7e32fc915730\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"806498f7-3afc-45ca-bd6b-fdea3be7e0c8\",\n \"option_name\": \"No Impact\",\n \"is_active\": true,\n \"order\": 5,\n \"option_field\": \"57354a26-f121-477c-b764-7e32fc915730\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"7328c9a2-fdcb-4efc-94ae-481bc9400713\",\n \"option_name\": \"Other\",\n \"is_active\": true,\n \"order\": 6,\n \"option_field\": \"57354a26-f121-477c-b764-7e32fc915730\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n }\n ],\n \"is_editable\": true,\n \"is_deletable\": true,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"other\",\n \"is_tabbable\": true,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"business_impact\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": true,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false,\n \"order\": 0,\n \"column_no\": 2\n },\n {\n \"unique_id\": \"b4ef2ff2-40ea-4beb-a69a-28bc6aad2908\",\n \"field_name\": \"Tactic-Technique-SubTechnique\",\n \"field_type\": \"dependent_select\",\n \"is_active\": true,\n \"is_removed\": false,\n \"placeholder\": \"Select Tactic Technique\",\n \"help_text\": \"\",\n \"field_options\": null,\n \"is_editable\": true,\n \"is_deletable\": true,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"tactic_technique_pair\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"tactic_technique_pair\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [\n \"is_required\"\n ],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false,\n \"order\": 4,\n \"column_no\": 2\n },\n {\n \"unique_id\": \"b8eb1213-deca-4661-9c65-b6fd5a9f74d5\",\n \"field_name\": \"Kill Chain Phase\",\n \"field_type\": \"select\",\n \"is_active\": true,\n \"is_removed\": false,\n \"placeholder\": \"Select Kill Chain Phase\",\n \"help_text\": \"\",\n \"field_options\": [\n {\n \"unique_id\": \"f759db6e-2736-4532-ba97-922cfc3ed5f4\",\n \"option_name\": \"Action on Objectives \",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"b8eb1213-deca-4661-9c65-b6fd5a9f74d5\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"921f19ae-9a86-4a62-a933-bebe6ddbb3cd\",\n \"option_name\": \"Command & Control\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"b8eb1213-deca-4661-9c65-b6fd5a9f74d5\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"e8d996ef-e909-4aa4-8b5f-c6ac2925ae4e\",\n \"option_name\": \"Delivery\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"b8eb1213-deca-4661-9c65-b6fd5a9f74d5\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"ad2db8bb-91a7-4dc1-a98f-acc724c54255\",\n \"option_name\": \"Exploitation\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"b8eb1213-deca-4661-9c65-b6fd5a9f74d5\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"8938c213-ae8a-4e11-a3ec-d2d2b4aef2dd\",\n \"option_name\": \"Installation\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"b8eb1213-deca-4661-9c65-b6fd5a9f74d5\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"eb191abe-7a01-4551-b116-84d963bb1fec\",\n \"option_name\": \"Reconnaissance\",\n \"is_active\": true,\n \"order\": 5,\n \"option_field\": \"b8eb1213-deca-4661-9c65-b6fd5a9f74d5\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"7a1a8c62-ea34-4b3c-af18-afa4b8ed6c6c\",\n \"option_name\": \"Weaponization\",\n \"is_active\": true,\n \"order\": 6,\n \"option_field\": \"b8eb1213-deca-4661-9c65-b6fd5a9f74d5\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"7bffbe15-a28d-4ce7-92e1-9a8a6e63a4a6\",\n \"option_name\": \"Unknown\",\n \"is_active\": true,\n \"order\": 7,\n \"option_field\": \"b8eb1213-deca-4661-9c65-b6fd5a9f74d5\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n }\n ],\n \"is_editable\": true,\n \"is_deletable\": true,\n \"is_table_column\": false,\n \"is_required\": false,\n \"type\": \"kill_chain_phase\",\n \"is_tabbable\": true,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"kill_chain_phase\",\n \"is_widget_field\": true,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": true,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false,\n \"order\": 5,\n \"column_no\": 2\n },\n {\n \"unique_id\": \"a38b7fb2-fe52-43dc-b114-ab9fff606f70\",\n \"field_name\": \"Regulatory Reporting\",\n \"field_type\": \"multiselect\",\n \"is_active\": true,\n \"is_removed\": false,\n \"placeholder\": \"Select Regulatory Reporting\",\n \"help_text\": \"\",\n \"field_options\": [\n {\n \"unique_id\": \"49180638-eee5-4b15-920e-519a87fac266\",\n \"option_name\": \"FCC\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"a38b7fb2-fe52-43dc-b114-ab9fff606f70\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"e8ed6a51-877c-4699-8c0d-2b3aff1598be\",\n \"option_name\": \"FINRA\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"a38b7fb2-fe52-43dc-b114-ab9fff606f70\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"f1834c07-c681-478b-bfdd-f541e6a90851\",\n \"option_name\": \"HSS\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"a38b7fb2-fe52-43dc-b114-ab9fff606f70\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"26b2df7c-54e4-4670-9917-b4ce879670aa\",\n \"option_name\": \"SEC\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"a38b7fb2-fe52-43dc-b114-ab9fff606f70\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"c5cdfaef-8e58-4214-b235-539d4dbce79a\",\n \"option_name\": \"US-CERT\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"a38b7fb2-fe52-43dc-b114-ab9fff606f70\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n }\n ],\n \"is_editable\": true,\n \"is_deletable\": true,\n \"is_table_column\": false,\n \"is_required\": false,\n \"type\": \"regulatory_reporting\",\n \"is_tabbable\": true,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"ie_regulatory_reporting\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": true,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false,\n \"order\": 6,\n \"column_no\": 2\n },\n {\n \"unique_id\": \"98732d18-edf3-4f47-9c2a-b483077dd4bb\",\n \"field_name\": \"Motives\",\n \"field_type\": \"multiselect\",\n \"is_active\": true,\n \"is_removed\": false,\n \"placeholder\": \"Select Motives\",\n \"help_text\": \"\",\n \"field_options\": [\n {\n \"unique_id\": \"e76f0664-bc14-4b92-b377-8fa2fbde010d\",\n \"option_name\": \"Branding Impact\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"98732d18-edf3-4f47-9c2a-b483077dd4bb\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"a58f51f6-0399-4677-9485-4908884fb67d\",\n \"option_name\": \"Business Disruption\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"98732d18-edf3-4f47-9c2a-b483077dd4bb\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"ebd6cfec-e330-40b9-b950-5d2e464e56ad\",\n \"option_name\": \"Data Theft\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"98732d18-edf3-4f47-9c2a-b483077dd4bb\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"195b55f9-73a9-41a1-8e54-43dcd0a2d25f\",\n \"option_name\": \"Financial Loss\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"98732d18-edf3-4f47-9c2a-b483077dd4bb\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"7b679482-ed88-4cfc-863e-6d7691871cae\",\n \"option_name\": \"Fun\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"98732d18-edf3-4f47-9c2a-b483077dd4bb\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"5abd84e7-ad3a-4cd3-8676-7ce0cb0e227f\",\n \"option_name\": \"IP Theft\",\n \"is_active\": true,\n \"order\": 5,\n \"option_field\": \"98732d18-edf3-4f47-9c2a-b483077dd4bb\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"240aa60f-b902-4411-a482-d57f5ecbf7ab\",\n \"option_name\": \"Revenge\",\n \"is_active\": true,\n \"order\": 6,\n \"option_field\": \"98732d18-edf3-4f47-9c2a-b483077dd4bb\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"f77a410b-48d0-4456-8bcf-775013013d49\",\n \"option_name\": \"Geo-political\",\n \"is_active\": true,\n \"order\": 7,\n \"option_field\": \"98732d18-edf3-4f47-9c2a-b483077dd4bb\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"fd6b0004-ba6c-4ff0-adb1-fe5636852a0e\",\n \"option_name\": \"Other\",\n \"is_active\": true,\n \"order\": 8,\n \"option_field\": \"98732d18-edf3-4f47-9c2a-b483077dd4bb\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n }\n ],\n \"is_editable\": true,\n \"is_deletable\": false,\n \"is_table_column\": false,\n \"is_required\": false,\n \"type\": \"motive\",\n \"is_tabbable\": true,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"ie_motives\",\n \"is_widget_field\": true,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": true,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false,\n \"order\": 7,\n \"column_no\": 2\n },\n {\n \"unique_id\": \"30019630-b025-48eb-b79c-ca6dfd313928\",\n \"field_name\": \"Applicable Compliance\",\n \"field_type\": \"multiselect\",\n \"is_active\": true,\n \"is_removed\": false,\n \"placeholder\": \"Select Applicable Compliance\",\n \"help_text\": \"\",\n \"field_options\": [\n {\n \"unique_id\": \"57b1bb43-3c6e-4ed5-b756-98e459a547d0\",\n \"option_name\": \"PCI\",\n \"is_active\": true,\n \"order\": 10,\n \"option_field\": \"30019630-b025-48eb-b79c-ca6dfd313928\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"c8e77e2e-6233-4daf-9366-7db3fc11cb50\",\n \"option_name\": \"SOX\",\n \"is_active\": true,\n \"order\": 20,\n \"option_field\": \"30019630-b025-48eb-b79c-ca6dfd313928\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n }\n ],\n \"is_editable\": true,\n \"is_deletable\": true,\n \"is_table_column\": false,\n \"is_required\": false,\n \"type\": \"applicable_compliance\",\n \"is_tabbable\": true,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"applicable_compliance\",\n \"is_widget_field\": true,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": true,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false,\n \"order\": 9,\n \"column_no\": 2\n }\n ],\n \"tab_type\": \"preparation\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": \"583f86b0-4dff-42df-9866-c4318d464e6f\",\n \"children\": [],\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {},\n \"order\": 0\n }\n ],\n \"created_by_data\": {\n \"username\": \"automation\",\n \"first_name\": \"Ui\",\n \"last_name\": \"Automation\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"cftr_qa@cyware.com\",\n \"full_name\": \"Ui Automation\"\n },\n \"modified_by_data\": {\n \"username\": \"automation\",\n \"first_name\": \"Ui\",\n \"last_name\": \"Automation\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"cftr_qa@cyware.com\",\n \"full_name\": \"Ui Automation\"\n },\n \"phase_key\": \"phase\",\n \"preparation_key\": \"preparation\",\n \"custom_tab_key\": \"other\",\n \"is_removed\": false,\n \"is_mapped\": false,\n \"num_of_phases\": 0,\n \"closure_phase_options\": [],\n \"check_mandatory_fields_on_phase_change\": false,\n \"is_imported\": false\n}"}],"_postman_id":"fd2cbd93-f8f2-411a-9bb5-2ff978732e01"},{"name":"Get Component Form Structure","id":"caa823ef-41fd-4d8d-ba4c-513844c9fd62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/forms/:component_identifier/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the form structure of the following components from your CFTR application:

Action
Device
Vulnerability
Threat Actor
Campaign
Threat Briefing
PIR
Enhancement
Malware
Application
Asset-Software
Asset-User

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

Response Parameters | Form Tab Structure

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the tab.
`tab_name`	String	Title of the tab.
`is_active`	Boolean	Shows if the tab is active or not.
`is_editable`	Boolean	Shows if the tab can be edited or not.
`is_removed`	Boolean	Shows whether the tab is in deleted state or not.
`object_identifier`	String	Shows the string name of the component.
`tab_fields`	List of Objects	Details of the fields added in the tab. Note: The tab fields are further explained in the table below.
`tab_type`	String	The tab type. Examples of tab types are: - Summary - Custom
`parent`	String	`unique_id` of the parent tab.
`children`	List	Details of children tabs.
`is_removable`	Boolean	Shows if tab can be removed or not.
`validation_expression`	String	Validation expression (if any) added. It is used for Threat Intel.
`order`	Integer	Order of the tab.

Response Parameters | Tab Fields Structure

Parameter	Type	Description
`unique_id`	String	Unique ID of the field in UUID-4 format.
`field_name`	String	Title of the field.
`field_type`	String	The type of field. Allowed values: `select`: Single option can be selected for the field. `multiselect`: Multiple options can be selected for the field. `text`: Text field. `textarea`: Text Area field. `calendar`: Date time field. `integer`: Integer Field.
`is_active`	Boolean	Shows whether field is active or not.
`is_removed`	Boolean	Shows whether the field is in deleted state or not.
`placeholder`	String	Placeholder of the field.
`field_options`	List of Objects	Details of the field options.
`is_editable`	Boolean	Shows whether the field can be edited or not.
`is_deletable`	Boolean	Shows whether field can be deleted or not.
`is_required`	Boolean	Shows whether the field is mandatory or not.
`field_readable_key`	String	Unique readable key for receiving field data from external sources.
`is_widget_field`	Boolean	Shows whether the widget can be created for this field or not. (Applicable only on select/multi-select fields)
`validation_expression`	String	Validation expression (if any) added. It is used for Threat Intel.
`is_read_only`	Boolean	Shows whether the field is one time entry field or not.
`enable_filter`	Boolean	Shows whether the filter option should be provided for this field or not. (Applicable only on select/multi-select fields)
`is_restricted_user_group_write_access`	Boolean	Shows whether the field access is restricted by a user group or not.
`user_groups_with_write_access`	List	List of `group_comm_id` of user groups that have write access to the field.
`is_restricted`	Boolean	Shows whether the current user has write access to the field or not.
`user_groups_with_write_access_data`	List of Objects	Basic details of the user groups that have write access to the field.
`is_parent_param`	Boolean	Shows whether the field is selected as a parent parameter or not.
`order`	Integer	Order of the field. (Defines the position of the field in the form)
`column_no`	Integer	Column number of the field. (Defines the column of the field in the form). Allowed values: `1`: Field is displayed on the left column `2`: Field is displayed on the right column.

","urlObject":{"path":["forms",":component_identifier",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the component identifier to retrieve the form structure. \nAllowed values:

action
device
vulnerability
threat-actor
campaign
threat-briefing
pir \n8.enhancement
malware
application
asset-software
general-user

\n","type":"text/plain"},"type":"any","value":"action","key":"component_identifier"}]}},"response":[{"id":"231821a6-9a32-4d94-ac79-25db00c94f2e","name":"Get Component Form Structure","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/forms/:component_identifier/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["forms",":component_identifier",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"component_identifier","value":"action","description":"Enter the component identifier to retrieve the form structure. \nAllowed values: \n1. `action`\n2. `device`\n3. `vulnerability`\n4. `threat-actor`\n5. `campaign`\n6. `threat-briefing`\n7. `pir` \n8.`enhancement`\n9. `malware`\n10. `application`\n11. `asset-software`\n12. `general-user`"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 16 Dec 2023 18:24:53 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: http: data: blob:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"[\n {\n \"unique_id\": \"50f7cd11-16a0-4c9a-a019-e70999841376\",\n \"tab_name\": \"Summary\",\n \"is_active\": true,\n \"order\": 10,\n \"is_editable\": true,\n \"is_removed\": false,\n \"object_identifier\": \"action\",\n \"tab_fields\": [\n {\n \"unique_id\": \"db99f615-bc99-47a1-a5bc-fbf9828c9db5\",\n \"field_name\": \"Title\",\n \"field_type\": \"custom-text\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 0,\n \"placeholder\": \"Enter Title\",\n \"help_text\": \"\",\n \"field_options\": null,\n \"is_editable\": false,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": true,\n \"type\": \"title\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"title\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 0,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": true,\n \"editable_readable_key\": false,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false\n },\n {\n \"unique_id\": \"4b47343c-dbe7-4331-8d86-65adee0a8f63\",\n \"field_name\": \"Assigned Group\",\n \"field_type\": \"select\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 4,\n \"placeholder\": \"Assigned Group\",\n \"help_text\": \"\",\n \"field_options\": [],\n \"is_editable\": false,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": true,\n \"type\": \"assigned_group\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"assigned_group\",\n \"is_widget_field\": false,\n \"extra_params\": {\n \"notes_required\": true\n },\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 2,\n \"is_read_only\": false,\n \"is_sla_field\": true,\n \"enable_filter\": false,\n \"extra_query_params\": {\n \"permission_code\": \"view_action\"\n },\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": true,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false\n },\n {\n \"unique_id\": \"830f6725-81ff-478e-9868-f69ca5c93d99\",\n \"field_name\": \"Description\",\n \"field_type\": \"textarea\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 1,\n \"placeholder\": \"Enter Description\",\n \"help_text\": \"\",\n \"field_options\": null,\n \"is_editable\": false,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"description\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"description\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 0,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": false,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false\n },\n {\n \"unique_id\": \"b04b6b4b-a04b-4eb4-a2c8-75007eb29143\",\n \"field_name\": \"Priority\",\n \"field_type\": \"select\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 5,\n \"placeholder\": \"Priority\",\n \"help_text\": \"\",\n \"field_options\": [\n {\n \"unique_id\": \"2a870879-955a-44a1-8ee6-36c0bd3ae782\",\n \"option_name\": \"Very Low\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"b04b6b4b-a04b-4eb4-a2c8-75007eb29143\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"1681f65a-ded9-419b-ac41-873daa01d947\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"b04b6b4b-a04b-4eb4-a2c8-75007eb29143\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"aacbf72b-8c8b-46c5-88c1-331e2607bd4a\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"b04b6b4b-a04b-4eb4-a2c8-75007eb29143\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"5d0f340a-27f5-424e-ac54-f404d196aa8e\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"b04b6b4b-a04b-4eb4-a2c8-75007eb29143\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"3bc330a5-0f4c-41fd-88d9-7f5f729b0d7a\",\n \"option_name\": \"Very High\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"b04b6b4b-a04b-4eb4-a2c8-75007eb29143\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n }\n ],\n \"is_editable\": true,\n \"is_deletable\": false,\n \"is_table_column\": false,\n \"is_required\": false,\n \"type\": \"priority\",\n \"is_tabbable\": true,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"priority\",\n \"is_widget_field\": true,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": true,\n \"enable_filter\": true,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false\n },\n {\n \"unique_id\": \"36ebfd6a-4f38-4ccb-9c92-bb21e6ac3068\",\n \"field_name\": \"Action Type\",\n \"field_type\": \"select\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 6,\n \"placeholder\": \"Type\",\n \"help_text\": \"\",\n \"field_options\": [\n {\n \"unique_id\": \"7c621764-9677-4081-985e-a9131f8899b7\",\n \"option_name\": \"Containment\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"36ebfd6a-4f38-4ccb-9c92-bb21e6ac3068\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"51a1b780-e34f-4472-a7dc-eb24410e7ef9\",\n \"option_name\": \"Corrective\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"36ebfd6a-4f38-4ccb-9c92-bb21e6ac3068\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"185ed7c3-da16-4b0a-aced-e975791c4ff5\",\n \"option_name\": \"Eradication\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"36ebfd6a-4f38-4ccb-9c92-bb21e6ac3068\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"9a2f83fb-dc85-4a15-b528-3d1921463b2d\",\n \"option_name\": \"Mitigation\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"36ebfd6a-4f38-4ccb-9c92-bb21e6ac3068\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"e0a288cd-0901-41a4-93bb-d9b335af8b2c\",\n \"option_name\": \"Recovery\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"36ebfd6a-4f38-4ccb-9c92-bb21e6ac3068\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"6931afe6-d684-420e-8c9c-b8106070602a\",\n \"option_name\": \"Remediation\",\n \"is_active\": true,\n \"order\": 5,\n \"option_field\": \"36ebfd6a-4f38-4ccb-9c92-bb21e6ac3068\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n }\n ],\n \"is_editable\": true,\n \"is_deletable\": false,\n \"is_table_column\": false,\n \"is_required\": false,\n \"type\": \"type\",\n \"is_tabbable\": true,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"type\",\n \"is_widget_field\": true,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": true,\n \"enable_filter\": true,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false\n },\n {\n \"unique_id\": \"e30b3fe2-f8ac-4713-8973-7bb4c0fedbd1\",\n \"field_name\": \"Assigned User\",\n \"field_type\": \"select\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 3,\n \"placeholder\": \"Assigned To\",\n \"help_text\": \"\",\n \"field_options\": [],\n \"is_editable\": false,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"assigned_to\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"assigned_to\",\n \"is_widget_field\": false,\n \"extra_params\": {\n \"notes_required\": true\n },\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 2,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": true,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false\n },\n {\n \"unique_id\": \"356986a8-0f1b-44b4-90de-0d34526c3db3\",\n \"field_name\": \"Exception Details\",\n \"field_type\": \"textarea\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 8,\n \"placeholder\": \"Exception Details\",\n \"help_text\": \"\",\n \"field_options\": null,\n \"is_editable\": true,\n \"is_deletable\": true,\n \"is_table_column\": false,\n \"is_required\": false,\n \"type\": \"other\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"exception_details\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 2,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false\n }\n ],\n \"tab_type\": \"preparation\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": null,\n \"children\": [],\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"3f3dafd1-20e9-4361-b80e-2d006f5f84ae\",\n \"tab_name\": \"Notes\",\n \"is_active\": true,\n \"order\": 15,\n \"is_editable\": false,\n \"is_removed\": false,\n \"object_identifier\": \"action\",\n \"tab_fields\": [],\n \"tab_type\": \"notes\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": null,\n \"children\": [],\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"edce9820-1425-4bb9-8daa-ef1553b07fa5\",\n \"tab_name\": \"Activity Logs\",\n \"is_active\": true,\n \"order\": 20,\n \"is_editable\": false,\n \"is_removed\": false,\n \"object_identifier\": \"action\",\n \"tab_fields\": [],\n \"tab_type\": \"activity_logs\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": null,\n \"children\": [],\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"fac72c72-7cc6-4dd6-8e70-64f85ffc33ff\",\n \"tab_name\": \"Connect The Dots\",\n \"is_active\": true,\n \"order\": 25,\n \"is_editable\": false,\n \"is_removed\": false,\n \"object_identifier\": \"action\",\n \"tab_fields\": [\n {\n \"unique_id\": \"c5846455-e22b-4690-8802-625b1953ece9\",\n \"field_name\": \"Labels\",\n \"field_type\": \"multiselect\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 0,\n \"placeholder\": \"Select Labels\",\n \"help_text\": \"\",\n \"field_options\": [],\n \"is_editable\": false,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"label\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"labels\",\n \"is_widget_field\": true,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false\n },\n {\n \"unique_id\": \"b19c46f8-57b6-4e61-b5a6-2c35fd775f22\",\n \"field_name\": \"Campaigns\",\n \"field_type\": \"multiselect\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 1,\n \"placeholder\": \"Campaigns\",\n \"help_text\": \"\",\n \"field_options\": [],\n \"is_editable\": false,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"campaign\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"campaigns\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false\n },\n {\n \"unique_id\": \"8df0001a-4564-4184-858f-7c79ecbbb154\",\n \"field_name\": \"Incident\",\n \"field_type\": \"select\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 2,\n \"placeholder\": \"Incident\",\n \"help_text\": \"\",\n \"field_options\": [],\n \"is_editable\": false,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"incident\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"incidents\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": \"incident/?status__mom=open,untriaged\",\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false\n },\n {\n \"unique_id\": \"0e0d1193-103a-4e47-b05d-3647f8e67527\",\n \"field_name\": \"Vulnerabilities\",\n \"field_type\": \"multiselect\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 3,\n \"placeholder\": \"Vulnerabilities\",\n \"help_text\": \"\",\n \"field_options\": [],\n \"is_editable\": false,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"vulnerability\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"vulnerabilities\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": \"vulnerability/?status=open\",\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false\n },\n {\n \"unique_id\": \"73d48026-44b9-4894-9c12-75a660ff1817\",\n \"field_name\": \"Threat Actors\",\n \"field_type\": \"multiselect\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 4,\n \"placeholder\": \"Threat Actors\",\n \"help_text\": \"\",\n \"field_options\": [],\n \"is_editable\": false,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"threat-actor\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"threat_actors\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": \"threat-actor/?status=active\",\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false\n },\n {\n \"unique_id\": \"f18fd429-bc6a-4186-b6ff-06d7eb3475bd\",\n \"field_name\": \"Malware\",\n \"field_type\": \"multiselect\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 5,\n \"placeholder\": \"Select Malware\",\n \"help_text\": \"\",\n \"field_options\": [],\n \"is_editable\": false,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"malware\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"malwares\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": \"malware/?status=active\",\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false\n },\n {\n \"unique_id\": \"e87eae47-f8e4-46c9-8eb6-bc637d87a403\",\n \"field_name\": \"Applications\",\n \"field_type\": \"multiselect\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 10,\n \"placeholder\": \"Select Application(s)\",\n \"help_text\": \"\",\n \"field_options\": [],\n \"is_editable\": false,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"application\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"applications\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false\n },\n {\n \"unique_id\": \"32c071c1-c2fa-46ae-b711-c197e005d5bb\",\n \"field_name\": \"Devices\",\n \"field_type\": \"multiselect\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 11,\n \"placeholder\": \"Select Device(s)\",\n \"help_text\": \"\",\n \"field_options\": [],\n \"is_editable\": false,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"device\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"endpoints\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false\n },\n {\n \"unique_id\": \"0e4b3032-f61b-4d95-87f1-13f9c4aa2704\",\n \"field_name\": \"Software\",\n \"field_type\": \"multiselect\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 12,\n \"placeholder\": \"Software(s)\",\n \"help_text\": \"\",\n \"field_options\": [],\n \"is_editable\": false,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"asset-software\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"softwares\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false\n },\n {\n \"unique_id\": \"2387c4c6-37b6-40c9-acc1-ff428befbc41\",\n \"field_name\": \"Users\",\n \"field_type\": \"multiselect\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 13,\n \"placeholder\": \"Select User(s)\",\n \"help_text\": \"\",\n \"field_options\": [],\n \"is_editable\": false,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"general-user\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"users\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false\n },\n {\n \"unique_id\": \"40cfadfc-960d-4ae2-9b8f-562d718d2ab3\",\n \"field_name\": \"Threat Briefings\",\n \"field_type\": \"multiselect\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 65,\n \"placeholder\": \"\",\n \"help_text\": \"\",\n \"field_options\": [],\n \"is_editable\": false,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"threat-briefing\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"briefings\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": \"threat-briefing/?status=ACTIVE\",\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false\n }\n ],\n \"tab_type\": \"linked\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": null,\n \"children\": [],\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"e28d1bd4-04bc-414c-b7a1-b5928770d62d\",\n \"tab_name\": \"Attachments\",\n \"is_active\": true,\n \"order\": 30,\n \"is_editable\": false,\n \"is_removed\": false,\n \"object_identifier\": \"action\",\n \"tab_fields\": [\n {\n \"unique_id\": \"d82cf0b8-3ac8-4b62-9475-7919e459535b\",\n \"field_name\": \"Artifacts\",\n \"field_type\": \"multiselect\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 5,\n \"placeholder\": \"Select Artifacts\",\n \"help_text\": \"\",\n \"field_options\": [],\n \"is_editable\": false,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"attachments\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"attachments\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false\n }\n ],\n \"tab_type\": \"attachment\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": null,\n \"children\": [],\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"464c38b0-69bb-42c7-872c-65f43ea03724\",\n \"tab_name\": \"Playbooks\",\n \"is_active\": true,\n \"order\": 33,\n \"is_editable\": false,\n \"is_removed\": false,\n \"object_identifier\": \"action\",\n \"tab_fields\": [],\n \"tab_type\": \"playbook\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": null,\n \"children\": [],\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"0954d8cc-ddc9-4bd9-9cb6-de7d2e4372f9\",\n \"tab_name\": \"Knowledge Base\",\n \"is_active\": true,\n \"order\": 35,\n \"is_editable\": false,\n \"is_removed\": false,\n \"object_identifier\": \"action\",\n \"tab_fields\": [\n {\n \"unique_id\": \"78604177-e0fa-41ab-85b6-a41f5289e278\",\n \"field_name\": \"Knowledge Base\",\n \"field_type\": \"multiselect\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 1,\n \"placeholder\": \"Select Knowledge Base\",\n \"help_text\": \"\",\n \"field_options\": [],\n \"is_editable\": false,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"knowledge-base\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"knowledge_base\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false\n }\n ],\n \"tab_type\": \"knowledge-base\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": null,\n \"children\": [],\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"ef3a0ca4-c00b-4ed0-b66a-3c9707edcb28\",\n \"tab_name\": \"Time Tracking\",\n \"is_active\": true,\n \"order\": 40,\n \"is_editable\": false,\n \"is_removed\": false,\n \"object_identifier\": \"action\",\n \"tab_fields\": [],\n \"tab_type\": \"time_tracking\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": null,\n \"children\": [],\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"cfcf0e13-ff5b-41bf-bef6-680ae075f4a5\",\n \"tab_name\": \"Custom\",\n \"is_active\": true,\n \"order\": 100,\n \"is_editable\": false,\n \"is_removed\": false,\n \"object_identifier\": \"action\",\n \"tab_fields\": [],\n \"tab_type\": \"custom\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": null,\n \"children\": [\n {\n \"unique_id\": \"d2f6c4b0-6d1c-4efa-811c-53529eba7581\",\n \"tab_name\": \"Conditional tab18:45:49\",\n \"is_active\": true,\n \"order\": 10010,\n \"is_editable\": true,\n \"is_removed\": false,\n \"object_identifier\": \"action\",\n \"tab_fields\": [],\n \"tab_type\": \"other\",\n \"visible_tab_field_option_data\": {\n \"unique_id\": \"2a870879-955a-44a1-8ee6-36c0bd3ae782\",\n \"option_name\": \"Very Low\",\n \"is_active\": true,\n \"order\": 0,\n \"is_removed\": false,\n \"is_editable\": true,\n \"color_code\": null\n },\n \"always_visible\": false,\n \"visible_tab_field\": \"b04b6b4b-a04b-4eb4-a2c8-75007eb29143\",\n \"visible_tab_field_data\": {\n \"unique_id\": \"b04b6b4b-a04b-4eb4-a2c8-75007eb29143\",\n \"field_name\": \"Priority\",\n \"field_type\": \"select\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 5,\n \"placeholder\": \"Priority\",\n \"help_text\": \"\",\n \"field_options\": [\n {\n \"unique_id\": \"2a870879-955a-44a1-8ee6-36c0bd3ae782\",\n \"option_name\": \"Very Low\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"b04b6b4b-a04b-4eb4-a2c8-75007eb29143\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"1681f65a-ded9-419b-ac41-873daa01d947\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"b04b6b4b-a04b-4eb4-a2c8-75007eb29143\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"aacbf72b-8c8b-46c5-88c1-331e2607bd4a\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"b04b6b4b-a04b-4eb4-a2c8-75007eb29143\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"5d0f340a-27f5-424e-ac54-f404d196aa8e\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"b04b6b4b-a04b-4eb4-a2c8-75007eb29143\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"3bc330a5-0f4c-41fd-88d9-7f5f729b0d7a\",\n \"option_name\": \"Very High\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"b04b6b4b-a04b-4eb4-a2c8-75007eb29143\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n }\n ],\n \"is_editable\": true,\n \"is_deletable\": false,\n \"is_table_column\": false,\n \"is_required\": false,\n \"type\": \"priority\",\n \"is_tabbable\": true,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"priority\",\n \"is_widget_field\": true,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": true,\n \"enable_filter\": true,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false\n },\n \"parent\": \"cfcf0e13-ff5b-41bf-bef6-680ae075f4a5\",\n \"help_text\": null,\n \"is_removable\": true,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"0931a422-92dc-4a73-ab15-f3a93f59e7c5\",\n \"tab_name\": \"tab18:36:19\",\n \"is_active\": true,\n \"order\": 10010,\n \"is_editable\": true,\n \"is_removed\": false,\n \"object_identifier\": \"action\",\n \"tab_fields\": [],\n \"tab_type\": \"other\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": \"cfcf0e13-ff5b-41bf-bef6-680ae075f4a5\",\n \"help_text\": null,\n \"is_removable\": true,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n }\n ],\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"d2f6c4b0-6d1c-4efa-811c-53529eba7581\",\n \"tab_name\": \"Conditional tab18:45:49\",\n \"is_active\": true,\n \"order\": 10010,\n \"is_editable\": true,\n \"is_removed\": false,\n \"object_identifier\": \"action\",\n \"tab_fields\": [],\n \"tab_type\": \"other\",\n \"visible_tab_field_option_data\": {\n \"unique_id\": \"2a870879-955a-44a1-8ee6-36c0bd3ae782\",\n \"option_name\": \"Very Low\",\n \"is_active\": true,\n \"order\": 0,\n \"is_removed\": false,\n \"is_editable\": true,\n \"color_code\": null\n },\n \"always_visible\": false,\n \"visible_tab_field\": \"b04b6b4b-a04b-4eb4-a2c8-75007eb29143\",\n \"visible_tab_field_data\": {\n \"unique_id\": \"b04b6b4b-a04b-4eb4-a2c8-75007eb29143\",\n \"field_name\": \"Priority\",\n \"field_type\": \"select\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 5,\n \"placeholder\": \"Priority\",\n \"help_text\": \"\",\n \"field_options\": [\n {\n \"unique_id\": \"2a870879-955a-44a1-8ee6-36c0bd3ae782\",\n \"option_name\": \"Very Low\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"b04b6b4b-a04b-4eb4-a2c8-75007eb29143\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"1681f65a-ded9-419b-ac41-873daa01d947\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"b04b6b4b-a04b-4eb4-a2c8-75007eb29143\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"aacbf72b-8c8b-46c5-88c1-331e2607bd4a\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"b04b6b4b-a04b-4eb4-a2c8-75007eb29143\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"5d0f340a-27f5-424e-ac54-f404d196aa8e\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"b04b6b4b-a04b-4eb4-a2c8-75007eb29143\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"3bc330a5-0f4c-41fd-88d9-7f5f729b0d7a\",\n \"option_name\": \"Very High\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"b04b6b4b-a04b-4eb4-a2c8-75007eb29143\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n }\n ],\n \"is_editable\": true,\n \"is_deletable\": false,\n \"is_table_column\": false,\n \"is_required\": false,\n \"type\": \"priority\",\n \"is_tabbable\": true,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"priority\",\n \"is_widget_field\": true,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": true,\n \"enable_filter\": true,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false,\n \"is_field_new\": false,\n \"note_mandatory\": false,\n \"editable_fields\": [],\n \"is_enabled\": true,\n \"exclude_conditional_logic\": false,\n \"editable_readable_key\": true,\n \"process_intel_automatically\": false,\n \"process_intel_cftr_enable\": false,\n \"process_intel_ctix_enable\": false\n },\n \"parent\": \"cfcf0e13-ff5b-41bf-bef6-680ae075f4a5\",\n \"children\": [],\n \"help_text\": null,\n \"is_removable\": true,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"0931a422-92dc-4a73-ab15-f3a93f59e7c5\",\n \"tab_name\": \"tab18:36:19\",\n \"is_active\": true,\n \"order\": 10010,\n \"is_editable\": true,\n \"is_removed\": false,\n \"object_identifier\": \"action\",\n \"tab_fields\": [],\n \"tab_type\": \"other\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": \"cfcf0e13-ff5b-41bf-bef6-680ae075f4a5\",\n \"children\": [],\n \"help_text\": null,\n \"is_removable\": true,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n }\n]"}],"_postman_id":"caa823ef-41fd-4d8d-ba4c-513844c9fd62"},{"name":"Get Threat Intel Form Structure","id":"045ac84f-9e63-410a-aa10-bb9d191b54fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/forms/threat-intel/form_tab/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&only_parent=True","description":"

Retrieve the Form Field Structure of the Threat Intel component.

Note: The fields of the Indicator Property tab may vary as per your configuration and the custom indicators.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

Response Parameters | Form Tab Structure

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the Tab.
`tab_name`	String	Title of the tab.
`is_active`	Boolean	Shows if the tab is active or not.
`is_editable`	Boolean	Shows if the tab can be edited or not.
`is_removed`	Boolean	Shows whether the tab is in deleted state or not.
`object_identifier`	String	Shows the string name for Threat Intel module.
`tab_fields`	List of Objects	Details of the fields added in the tab. Note: The tab fields are further explained in the table below.
`tab_type`	String	The tab type. Examples of tab types are: `preparation`: Preparation tab is common across all workflows. `custom`: Custom Tab
`parent`	String	`unique_id` of the parent of the tab.
`children`	List	Details of children tabs.
`is_removable`	Boolean	Shows if tab can be removed or not.
`validation_expression`	String	Validation expression (if any) added. It is used for Threat Intel.
`order`	Integer	Order of the tab.

Response Parameters | Tab Fields Structure

Parameter	Type	Description
`unique_id`	String	Unique Identifier String of UUID-4 format of the Field.
`field_name`	String	Title of the field.
`field_type`	String	The type of field. Allowed values: `select`: Single option can be selected for the field. `multiselect`: Multiple options can be selected for the field. `text`: Text field. `textarea`: Text Area field. `calendar`: date time field. `integer`: Integer Field.
`is_active`	Boolean	Shows whether field is active or not.
`is_removed`	Boolean	Shows whether the field is in deleted state or not.
`placeholder`	String	Placeholder of the field.
`help_text`	String	Help text o.f the field
`field_options`	List of Objects	Details of the options.
`is_editable`	Boolean	Shows whether field can be edited or not.
`is_deletable`	Boolean	Shows whether field can be deleted or not.
`is_required`	Boolean	Shows whether the field is mandatory or not.
`field_readable_key`	String	Unique readable key for receiving field data from external sources.
`is_widget_field`	Boolean	Shows whether the widget can be created for this field or not. (Applicable only on select/multi-select fields)
`validation_expression`	String	Validation expression (if any) added. It is used for Threat Intel.
`is_read_only`	Boolean	Shows whether the field is one time entry field or not.
`enable_filter`	Boolean	Shows whether the filter option should be provided for this field or not. (Applicable only on select/multi-select fields)
`is_restricted_user_group_write_access`	Boolean	Shows whether the field access is restricted by user group.
`user_groups_with_write_access`	List	List of `group_comm_id` of user groups that have write access to the field.
`is_restricted`	Boolean	Shows whether the current user has write access to the field or not.
`user_groups_with_write_access_data`	List of Objects	Basic details of user groups that have write access to the field.
`is_parent_param`	Boolean	Shows whether the field is selected as a parent parameter or not.
`order`	Integer	Order of the field. (Defines the position of the field in the form)
`column_no`	Integer	Column number of the field. (Defines the column of the field in the form). Allowed values: `1`: Field will be present in left column `2`: Field will be present in right column.

","urlObject":{"path":["forms","threat-intel","form_tab",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"description":{"content":"

[Boolean] [Default: False] Specify if you want to retrieve the first level information of parent tabs only.

\n","type":"text/plain"},"key":"only_parent","value":"True"}],"variable":[]}},"response":[{"id":"ebdffa71-7f4a-4c0c-ada1-eb7ca6151f6d","name":"200 OK: Threat Intel Form Structure","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/forms/threat-intel/form_tab/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&only_parent=True","host":["{{base_url}}v1"],"path":["forms","threat-intel","form_tab",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"only_parent","value":"True","description":"[Boolean] [Default: False] Get first level information of only parent tabs"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 25 Feb 2022 15:40:54 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"20487","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"[\n {\n \"unique_id\": \"be9c7e79-6bd4-45a3-b78b-1f5336193aab\",\n \"tab_name\": \"Summary\",\n \"is_active\": true,\n \"order\": 10,\n \"is_editable\": false,\n \"is_removed\": false,\n \"object_identifier\": \"ioc\",\n \"tab_fields\": [\n {\n \"unique_id\": \"86c4ec83-8c11-4f96-b101-f456fe40ce2c\",\n \"field_name\": \"Vulnerabilities\",\n \"field_type\": \"multiselect\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 10,\n \"placeholder\": \"Select Vulnerabilities\",\n \"help_text\": null,\n \"field_options\": [],\n \"is_editable\": false,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"vulnerability\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"vulnerabilities\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false\n },\n {\n \"unique_id\": \"860cff3d-ed1a-41be-81ef-2e8a6bab8417\",\n \"field_name\": \"Threat Actors\",\n \"field_type\": \"multiselect\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 10,\n \"placeholder\": \"Select Threat Actors\",\n \"help_text\": null,\n \"field_options\": [],\n \"is_editable\": false,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"threat-actor\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"threat_actors\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false\n },\n {\n \"unique_id\": \"26e9271f-645e-4644-b2aa-da9048b9fcba\",\n \"field_name\": \"Malwares\",\n \"field_type\": \"multiselect\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 10,\n \"placeholder\": \"Select Malwares\",\n \"help_text\": null,\n \"field_options\": [],\n \"is_editable\": false,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"malware\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"Malwares\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false\n },\n {\n \"unique_id\": \"bc417395-74ab-4695-abe3-4eae91058139\",\n \"field_name\": \"Incidents\",\n \"field_type\": \"multiselect\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 10,\n \"placeholder\": \"Select Incidents\",\n \"help_text\": null,\n \"field_options\": [],\n \"is_editable\": false,\n \"is_deletable\": false,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"incident\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"incidents\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false\n }\n ],\n \"tab_type\": \"preparation\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": null,\n \"children\": [],\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"876ed93d-4231-4487-9a1a-b1a7356308ac\",\n \"tab_name\": \"Actions\",\n \"is_active\": true,\n \"order\": 20,\n \"is_editable\": false,\n \"is_removed\": false,\n \"object_identifier\": \"ioc\",\n \"tab_fields\": [],\n \"tab_type\": \"action\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": null,\n \"children\": [],\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"dc59ada7-b489-4c6d-acd1-de8a3e1feefe\",\n \"tab_name\": \"Notes\",\n \"is_active\": true,\n \"order\": 30,\n \"is_editable\": false,\n \"is_removed\": false,\n \"object_identifier\": \"ioc\",\n \"tab_fields\": [],\n \"tab_type\": \"notes\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": null,\n \"children\": [],\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"7712ce8b-bb3b-4ef7-8e59-5216c9df492e\",\n \"tab_name\": \"Terminal\",\n \"is_active\": true,\n \"order\": 40,\n \"is_editable\": false,\n \"is_removed\": false,\n \"object_identifier\": \"ioc\",\n \"tab_fields\": [],\n \"tab_type\": \"terminal\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": null,\n \"children\": [],\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"758ef007-6826-4474-8d83-ee7d2f049ae4\",\n \"tab_name\": \"Intel Enrichment\",\n \"is_active\": true,\n \"order\": 50,\n \"is_editable\": false,\n \"is_removed\": false,\n \"object_identifier\": \"ioc\",\n \"tab_fields\": [],\n \"tab_type\": \"enrichment\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": null,\n \"children\": [],\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"a46ac64d-4123-4fc3-925f-f27eabcacd7d\",\n \"tab_name\": \"Indicator Property\",\n \"is_active\": true,\n \"order\": 1000,\n \"is_editable\": false,\n \"is_removed\": false,\n \"object_identifier\": \"ioc\",\n \"tab_fields\": [\n {\n \"unique_id\": \"6ca6fe2a-accd-45b7-9b71-1e8bc5fdbd5d\",\n \"field_name\": \"IOC Type\",\n \"field_type\": \"select\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 0,\n \"placeholder\": \"IOC Type\",\n \"help_text\": \"\",\n \"field_options\": [],\n \"is_editable\": false,\n \"is_deletable\": true,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"ioc_type\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"ioc_type\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false\n }\n ],\n \"tab_type\": \"indicator_type\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": null,\n \"children\": [\n {\n \"unique_id\": \"1ce8d992-518a-4e59-9e52-eb4859fe8891\",\n \"tab_name\": \"IP\",\n \"is_active\": true,\n \"order\": 10,\n \"is_editable\": false,\n \"is_removed\": false,\n \"object_identifier\": \"ioc\",\n \"tab_fields\": [],\n \"tab_type\": \"other\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": \"a46ac64d-4123-4fc3-925f-f27eabcacd7d\",\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"8eff4f47-d43b-4be6-b86d-7688643ab81a\",\n \"tab_name\": \"custom\",\n \"is_active\": true,\n \"order\": 10,\n \"is_editable\": true,\n \"is_removed\": false,\n \"object_identifier\": \"ioc\",\n \"tab_fields\": [],\n \"tab_type\": \"other\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": \"a46ac64d-4123-4fc3-925f-f27eabcacd7d\",\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": \"^[0-9]+$\",\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"c02de515-b030-4d8c-9ee6-ad3709965287\",\n \"tab_name\": \"Domain\",\n \"is_active\": true,\n \"order\": 20,\n \"is_editable\": false,\n \"is_removed\": false,\n \"object_identifier\": \"ioc\",\n \"tab_fields\": [],\n \"tab_type\": \"other\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": \"a46ac64d-4123-4fc3-925f-f27eabcacd7d\",\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"8d849f81-0bf8-4f5b-932d-4b7bb912d9b6\",\n \"tab_name\": \"URL\",\n \"is_active\": true,\n \"order\": 30,\n \"is_editable\": false,\n \"is_removed\": false,\n \"object_identifier\": \"ioc\",\n \"tab_fields\": [],\n \"tab_type\": \"other\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": \"a46ac64d-4123-4fc3-925f-f27eabcacd7d\",\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"513b6634-5d28-4cc0-bcdc-c51a57095ccb\",\n \"tab_name\": \"Email\",\n \"is_active\": true,\n \"order\": 40,\n \"is_editable\": false,\n \"is_removed\": false,\n \"object_identifier\": \"ioc\",\n \"tab_fields\": [],\n \"tab_type\": \"other\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": \"a46ac64d-4123-4fc3-925f-f27eabcacd7d\",\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"47800a29-dc33-44ec-a118-c74aa0ac58be\",\n \"tab_name\": \"MD5\",\n \"is_active\": true,\n \"order\": 50,\n \"is_editable\": false,\n \"is_removed\": false,\n \"object_identifier\": \"ioc\",\n \"tab_fields\": [],\n \"tab_type\": \"other\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": \"a46ac64d-4123-4fc3-925f-f27eabcacd7d\",\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"6dcdc57d-3b89-4a7a-8fea-c119c7de5de5\",\n \"tab_name\": \"SHA1\",\n \"is_active\": true,\n \"order\": 60,\n \"is_editable\": false,\n \"is_removed\": false,\n \"object_identifier\": \"ioc\",\n \"tab_fields\": [],\n \"tab_type\": \"other\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": \"a46ac64d-4123-4fc3-925f-f27eabcacd7d\",\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"a94c847e-7d49-4198-bc5b-f3a0066bca4a\",\n \"tab_name\": \"SHA256\",\n \"is_active\": true,\n \"order\": 70,\n \"is_editable\": false,\n \"is_removed\": false,\n \"object_identifier\": \"ioc\",\n \"tab_fields\": [],\n \"tab_type\": \"other\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": \"a46ac64d-4123-4fc3-925f-f27eabcacd7d\",\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"b25df532-6f59-4afd-b2b4-43e33c700031\",\n \"tab_name\": \"Registry Key\",\n \"is_active\": true,\n \"order\": 10001,\n \"is_editable\": true,\n \"is_removed\": false,\n \"object_identifier\": \"ioc\",\n \"tab_fields\": [\n {\n \"unique_id\": \"e18430ab-6fad-4a18-a5bf-5a4a09324eb4\",\n \"field_name\": \"Registry Key\",\n \"field_type\": \"text\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 10,\n \"placeholder\": null,\n \"help_text\": \"Registry keys contain registry values, just like folders contain files. Registry keys can also contain other registry keys, which are sometimes referred to as subkeys.\",\n \"field_options\": null,\n \"is_editable\": true,\n \"is_deletable\": true,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"other\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"registry_key\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false\n }\n ],\n \"tab_type\": \"other\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": \"a46ac64d-4123-4fc3-925f-f27eabcacd7d\",\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"b60401fa-4666-4df6-a884-06ad3c46863a\",\n \"tab_name\": \"Debit Card\",\n \"is_active\": true,\n \"order\": 10007,\n \"is_editable\": true,\n \"is_removed\": false,\n \"object_identifier\": \"ioc\",\n \"tab_fields\": [\n {\n \"unique_id\": \"e8211da9-9e9d-481c-b01c-0a922d3a4f5c\",\n \"field_name\": \"Name On Card\",\n \"field_type\": \"text\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 10,\n \"placeholder\": \"\",\n \"help_text\": \"\",\n \"field_options\": null,\n \"is_editable\": true,\n \"is_deletable\": true,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"other\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"name_on_card\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false\n }\n ],\n \"tab_type\": \"other\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": \"a46ac64d-4123-4fc3-925f-f27eabcacd7d\",\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": \"\\\\d+\",\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"51fae053-7a29-45e4-937f-805911264956\",\n \"tab_name\": \"Test Doc\",\n \"is_active\": true,\n \"order\": 10007,\n \"is_editable\": true,\n \"is_removed\": false,\n \"object_identifier\": \"ioc\",\n \"tab_fields\": [],\n \"tab_type\": \"other\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": \"a46ac64d-4123-4fc3-925f-f27eabcacd7d\",\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"5009125d-4044-46ef-8712-5c874fadcb8e\",\n \"tab_name\": \"Service\",\n \"is_active\": true,\n \"order\": 10007,\n \"is_editable\": true,\n \"is_removed\": false,\n \"object_identifier\": \"ioc\",\n \"tab_fields\": [\n {\n \"unique_id\": \"6a773e26-7899-4fd3-b36d-0f8079351378\",\n \"field_name\": \"Service Name\",\n \"field_type\": \"text\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 10,\n \"placeholder\": \"\",\n \"help_text\": \"\",\n \"field_options\": null,\n \"is_editable\": true,\n \"is_deletable\": true,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"other\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"service_name\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false\n },\n {\n \"unique_id\": \"bb23cc98-c176-4afb-ac2a-7fe3ed42fc94\",\n \"field_name\": \"Binary Path\",\n \"field_type\": \"text\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 10,\n \"placeholder\": null,\n \"help_text\": null,\n \"field_options\": null,\n \"is_editable\": true,\n \"is_deletable\": true,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"other\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"binary_path\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false\n },\n {\n \"unique_id\": \"251a88c0-6eb6-41f2-a671-eabd06a7ab17\",\n \"field_name\": \"Display Name\",\n \"field_type\": \"text\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 10,\n \"placeholder\": null,\n \"help_text\": null,\n \"field_options\": null,\n \"is_editable\": true,\n \"is_deletable\": true,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"other\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"display_name\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false\n }\n ],\n \"tab_type\": \"other\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": \"a46ac64d-4123-4fc3-925f-f27eabcacd7d\",\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n },\n {\n \"unique_id\": \"ecb56f4e-50f8-47a7-a486-05e9c63867af\",\n \"tab_name\": \"FQFN\",\n \"is_active\": true,\n \"order\": 10007,\n \"is_editable\": true,\n \"is_removed\": false,\n \"object_identifier\": \"ioc\",\n \"tab_fields\": [\n {\n \"unique_id\": \"6a53909e-447d-465c-9652-47f6f7e13ccc\",\n \"field_name\": \"Description\",\n \"field_type\": \"textarea\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 10,\n \"placeholder\": \"\",\n \"help_text\": \"\",\n \"field_options\": null,\n \"is_editable\": true,\n \"is_deletable\": true,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"other\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"description\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false\n },\n {\n \"unique_id\": \"c4ebf942-6672-475b-b12a-3bfea91be001\",\n \"field_name\": \"File Path\",\n \"field_type\": \"text\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 10,\n \"placeholder\": null,\n \"help_text\": null,\n \"field_options\": null,\n \"is_editable\": true,\n \"is_deletable\": true,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"other\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"file_path\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false\n },\n {\n \"unique_id\": \"3c6bde64-e11c-4603-b397-41c43ac09af4\",\n \"field_name\": \"File Name\",\n \"field_type\": \"text\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 10,\n \"placeholder\": \"\",\n \"help_text\": \"\",\n \"field_options\": null,\n \"is_editable\": true,\n \"is_deletable\": true,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"other\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"file_name\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false\n },\n {\n \"unique_id\": \"390f5ce6-ce81-48b3-9e4a-3a0289eca791\",\n \"field_name\": \"File Hash - MD5\",\n \"field_type\": \"text\",\n \"is_active\": true,\n \"is_removed\": false,\n \"order\": 10,\n \"placeholder\": null,\n \"help_text\": null,\n \"field_options\": null,\n \"is_editable\": true,\n \"is_deletable\": true,\n \"is_table_column\": true,\n \"is_required\": false,\n \"type\": \"other\",\n \"is_tabbable\": false,\n \"prepopulator_value\": null,\n \"field_readable_key\": \"file_hash_-_md5\",\n \"is_widget_field\": false,\n \"extra_params\": {},\n \"validation_expression\": null,\n \"data_source\": null,\n \"dependent_options_data\": [],\n \"always_visible\": true,\n \"column_no\": 1,\n \"is_read_only\": false,\n \"is_sla_field\": false,\n \"enable_filter\": false,\n \"extra_query_params\": {},\n \"is_restricted_user_group_write_access\": false,\n \"user_groups_with_write_access\": [],\n \"is_restricted\": false,\n \"user_groups_with_write_access_data\": [],\n \"is_parent_param\": false\n }\n ],\n \"tab_type\": \"other\",\n \"visible_tab_field_option_data\": null,\n \"always_visible\": true,\n \"visible_tab_field\": null,\n \"visible_tab_field_data\": null,\n \"parent\": \"a46ac64d-4123-4fc3-925f-f27eabcacd7d\",\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n }\n ],\n \"help_text\": null,\n \"is_removable\": false,\n \"validation_expression\": null,\n \"schema\": [],\n \"copy_from_schema\": null,\n \"extra_params\": {}\n }\n]"}],"_postman_id":"045ac84f-9e63-410a-aa10-bb9d191b54fe"}],"id":"e24d7d31-1795-42b6-ac2b-aa4b043f3b95","description":"

The Form Management section in the CFTR Admin Panel enables CFTR admins to manage the forms of various CFTR components. The forms are used to provide initial details of a component while creating a component record.

This section describes how to use the API endpoints to manage forms of various CFTR components.

\n","_postman_id":"e24d7d31-1795-42b6-ac2b-aa4b043f3b95"},{"name":"Settings","item":[{"name":"OS Types","item":[{"name":"Get List of OS Types","id":"3f4563e3-4ab6-4b93-b355-949c73cef341","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/utils/ostypes/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve a list of all OS types with details from the CFTR application.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` shows the API endpoint to the next page.
`count`	Integer	Total number of OS types in CFTR application according to the filters applied.
`results`	List of Objects	Details of the OS Type. Each object provides details of one OS Type.

Response Parameters | Results Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	Title of the OS type.
`unique_id`	String	Unique Identifier String of UUID-4 format of the OS type.
`readable_id`	String	Unique readable ID of the OS type. It starts with OST followed by a unique number. Example: \"OST101\"
`description`	Text	Description of the OS type.
`created`	String	Creation date and time of the OS type in ISO format.
`modified`	String	Last modified date and time of the OS type in ISO format.

[integer] [Optional] Enter the number of records to be retrieved per page. Default value: 10

\n","type":"text/plain"},"key":"page_size","value":"30"},{"disabled":true,"description":{"content":"

[String] [Optional] Enter the query string to filter the response based on the OS type title that contains thequery string. Default value: None

\n","type":"text/plain"},"key":"q","value":"solaris"},{"disabled":true,"description":{"content":"

[integer] [Optional] Enter the page number. All the OS types of this page will be returned. Default value: 1

\n","type":"text/plain"},"key":"page","value":"2"}],"variable":[]}},"response":[{"id":"c2ea9085-10e9-407e-9793-34e8d403e1ad","name":"200 OK: Get records of OS Types from 31-60 ordered on Title","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/utils/ostypes/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&page=2&page_size=30","host":["{{base_url}}v1"],"path":["utils","ostypes",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"page","value":"2","description":"[integer] [Optional] [Default: 1] Starting page. Actual records returned depends on page and page_size. "},{"key":"page_size","value":"30","description":"[integer] [Optional] [Default: 10] Size of records required on one page"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Wed, 16 Feb 2022 07:16:50 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"6620","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {\n \"next\": \"openapi/v1/utils/ostypes/?page=3&page_size=30&AccessID=6ffcb69e-3ece-4bf0-a8f7-c787ca1a5984&Expires=1644995826&Signature=iBQAoSxLTGmGQU4Upwei1ETPhNc=\",\n \"previous\": \"openapi/v1/utils/ostypes/?page=1&page_size=30&AccessID=6ffcb69e-3ece-4bf0-a8f7-c787ca1a5984&Expires=1644995826&Signature=iBQAoSxLTGmGQU4Upwei1ETPhNc=\"\n },\n \"count\": 331,\n \"results\": [\n {\n \"title\": \"CentOS release 5.5 (Final), 2.6.18-274.17.1.el5\",\n \"unique_id\": \"2fd4996d-f21b-4d43-8000-31769f3ed3ae\",\n \"readable_id\": \"OST131\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:17.999706Z\",\n \"modified\": \"2022-01-24T09:48:03.240438Z\"\n },\n {\n \"title\": \"CentOS release 6.5\",\n \"unique_id\": \"a48ad461-53a6-429c-9649-b7edef9aaca5\",\n \"readable_id\": \"OST132\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.014060Z\",\n \"modified\": \"2022-01-24T09:48:03.254537Z\"\n },\n {\n \"title\": \"Checkpoint Gaia R77.30\",\n \"unique_id\": \"a7d8c474-a565-4d27-85bd-264b8a10d5f5\",\n \"readable_id\": \"OST133\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.027917Z\",\n \"modified\": \"2022-01-24T09:48:03.268017Z\"\n },\n {\n \"title\": \"Cisco Unified OS, UCOS4.0.0.0-44\",\n \"unique_id\": \"51d2b763-70de-487b-a795-db70ff8a6312\",\n \"readable_id\": \"OST134\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.041509Z\",\n \"modified\": \"2022-01-24T09:48:03.281400Z\"\n },\n {\n \"title\": \"ESX 4.0.0 build-171294\",\n \"unique_id\": \"7a99e1ff-e22f-4053-a81c-7861e2a7f96d\",\n \"readable_id\": \"OST135\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.054184Z\",\n \"modified\": \"2022-01-24T09:48:03.293465Z\"\n },\n {\n \"title\": \"ESX, 3.0.1\",\n \"unique_id\": \"a697619c-db6b-4afa-a4c8-2ce191afec86\",\n \"readable_id\": \"OST136\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.068678Z\",\n \"modified\": \"2022-01-24T09:48:03.307935Z\"\n },\n {\n \"title\": \"ESX, 3.5\",\n \"unique_id\": \"5d1acc98-526a-48f3-9e51-ef6bca1d6f43\",\n \"readable_id\": \"OST137\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.083168Z\",\n \"modified\": \"2022-01-24T09:48:03.320501Z\"\n },\n {\n \"title\": \"ESX, 4.0\",\n \"unique_id\": \"4ff5873d-dac3-4aed-8282-399810148bae\",\n \"readable_id\": \"OST138\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.096932Z\",\n \"modified\": \"2022-01-24T09:48:03.333109Z\"\n },\n {\n \"title\": \"ESX, 5.0\",\n \"unique_id\": \"87f5594e-f758-4e80-8dd7-fd4499f3c990\",\n \"readable_id\": \"OST139\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.110264Z\",\n \"modified\": \"2022-01-24T09:48:03.346565Z\"\n },\n {\n \"title\": \"ESXi 4.1.0 build-348481\",\n \"unique_id\": \"b93e8f69-9f80-43f9-ad53-ef26b9a06cc6\",\n \"readable_id\": \"OST140\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.126228Z\",\n \"modified\": \"2022-01-24T09:48:03.359927Z\"\n },\n {\n \"title\": \"ESXi 5.0.0 build-469512\",\n \"unique_id\": \"dc80926c-399e-4203-9686-1ca3a43ee068\",\n \"readable_id\": \"OST141\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.139669Z\",\n \"modified\": \"2022-01-24T09:48:03.373118Z\"\n },\n {\n \"title\": \"ESXi 5.0.0 build-504890\",\n \"unique_id\": \"c3eeebb0-c069-40da-8af6-c6a3b68a1583\",\n \"readable_id\": \"OST142\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.151965Z\",\n \"modified\": \"2022-01-24T09:48:03.390529Z\"\n },\n {\n \"title\": \"ESXi 5.0.0 build-623860\",\n \"unique_id\": \"bfd39756-31f0-46dc-ab1e-25473797bff5\",\n \"readable_id\": \"OST143\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.166436Z\",\n \"modified\": \"2022-01-24T09:48:03.404988Z\"\n },\n {\n \"title\": \"ESXi 5.0.0 build-914586\",\n \"unique_id\": \"48db225d-3160-445d-b924-1f71e7644940\",\n \"readable_id\": \"OST144\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.180238Z\",\n \"modified\": \"2022-01-24T09:48:03.422050Z\"\n },\n {\n \"title\": \"ESXi 5.5.0 build 1331820\",\n \"unique_id\": \"d4b70b52-3ae8-4850-965f-d62064e2bf0d\",\n \"readable_id\": \"OST145\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.195001Z\",\n \"modified\": \"2022-01-24T09:48:03.435846Z\"\n },\n {\n \"title\": \"ESXi 5.5.0 build-1331820\",\n \"unique_id\": \"f0dc30a8-7c5a-4580-9043-5d51f49411f8\",\n \"readable_id\": \"OST146\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.209391Z\",\n \"modified\": \"2022-01-24T09:48:03.451679Z\"\n },\n {\n \"title\": \"ESXi 5.5.0 build-1623387\",\n \"unique_id\": \"ba787fdc-254d-4dd8-a65b-be3c33d1ad96\",\n \"readable_id\": \"OST147\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.223532Z\",\n \"modified\": \"2022-01-24T09:48:03.470781Z\"\n },\n {\n \"title\": \"ESXi 5.5.0 build-2143827\",\n \"unique_id\": \"3157b5e7-b41c-4dc1-8aa2-632711c94c5e\",\n \"readable_id\": \"OST148\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.235249Z\",\n \"modified\": \"2022-01-24T09:48:03.489444Z\"\n },\n {\n \"title\": \"ESXi 5.5.0 build-3468236\",\n \"unique_id\": \"5488ac8a-8f00-45ed-b337-231ae7fa5fdc\",\n \"readable_id\": \"OST149\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.249133Z\",\n \"modified\": \"2022-01-24T09:48:03.505447Z\"\n },\n {\n \"title\": \"ESXi, 5.5.0, 2068190\",\n \"unique_id\": \"5911a0b8-34eb-4c9c-a7ea-75f8ffa6ee44\",\n \"readable_id\": \"OST150\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.262438Z\",\n \"modified\": \"2022-01-24T09:48:03.519141Z\"\n },\n {\n \"title\": \"Fedora Linux, 2.6.12-1.1381_FC3\",\n \"unique_id\": \"32be178f-eb55-4e5a-95ca-5f0259c65f9a\",\n \"readable_id\": \"OST151\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.278487Z\",\n \"modified\": \"2022-01-24T09:48:03.534419Z\"\n },\n {\n \"title\": \"FLARE Linux based\",\n \"unique_id\": \"02d429b6-306e-4ccf-8038-fd4b1a74e1d4\",\n \"readable_id\": \"OST152\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.292790Z\",\n \"modified\": \"2022-01-24T09:48:03.548698Z\"\n },\n {\n \"title\": \"FotiOS V5.2.5\",\n \"unique_id\": \"1d655fd1-19cc-402a-bdda-41cd0274e8b7\",\n \"readable_id\": \"OST153\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.306025Z\",\n \"modified\": \"2022-01-24T09:48:03.563501Z\"\n },\n {\n \"title\": \"Guardian Operating System J06.18.01\",\n \"unique_id\": \"9d7501fa-03d4-4ef8-94f9-f448b467429e\",\n \"readable_id\": \"OST154\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.323449Z\",\n \"modified\": \"2022-01-24T09:48:03.576540Z\"\n },\n {\n \"title\": \"Guardian, J06.20.00\",\n \"unique_id\": \"84e3c10c-2509-43fe-85e1-ec6c50bf0bd9\",\n \"readable_id\": \"OST155\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.342428Z\",\n \"modified\": \"2022-01-24T09:48:03.590480Z\"\n },\n {\n \"title\": \"Guardian,J06.20.00\",\n \"unique_id\": \"f40c60c8-23c0-4190-9727-b199bdb54dad\",\n \"readable_id\": \"OST156\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.361922Z\",\n \"modified\": \"2022-01-24T09:48:03.603809Z\"\n },\n {\n \"title\": \"HP-UX, B.11.31 U\",\n \"unique_id\": \"df43b14e-4594-4180-a153-f1d0ecdc50ef\",\n \"readable_id\": \"OST157\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.378383Z\",\n \"modified\": \"2022-01-24T09:48:03.617657Z\"\n },\n {\n \"title\": \"IBM AIX 7.1\",\n \"unique_id\": \"84499211-2425-4e03-961f-4d3aae13f9ea\",\n \"readable_id\": \"OST158\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.398322Z\",\n \"modified\": \"2022-01-24T09:48:03.632099Z\"\n },\n {\n \"title\": \"LINUX\",\n \"unique_id\": \"079dc5fd-706e-4efa-a26f-ef50f3b19aa0\",\n \"readable_id\": \"OST159\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.416916Z\",\n \"modified\": \"2022-01-24T09:48:03.646312Z\"\n },\n {\n \"title\": \"Linux 6.5\",\n \"unique_id\": \"4428a5e7-4310-4a84-9b56-27e8642773cb\",\n \"readable_id\": \"OST160\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:18.502013Z\",\n \"modified\": \"2022-01-24T09:48:03.661214Z\"\n }\n ],\n \"mapping\": {\n \"dropdown_display_name\": \"readable_id\"\n }\n}"}],"_postman_id":"3f4563e3-4ab6-4b93-b355-949c73cef341"},{"name":"Create OS Type","id":"19e1efa5-8e6e-497e-93d6-f09ee3a2f039","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"test OS Type\",\n \"description\": \"OS type description\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/utils/ostypes/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Create an OS type in your CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
`title`	String	Mandatory	Enter a title for the OS type.
`description`	String	Optional	Enter a description for the OS type.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	The title of the OS type.
`unique_id`	String	Unique ID of the OS type in UUID-4 format.
`readable_id`	String	Unique readable ID of the OS type. It starts with OST followed by a unique number. Example: \"OST101\"
`description`	Text	Description of the OS type.
`created`	String	Creation date and time of the OS type in ISO format.
`modified`	String	Last modified date and time of the OS type in ISO format.

Example Error Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Description
400	Title is required.

","urlObject":{"path":["utils","ostypes",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"ca9b2bb3-dace-48a4-8167-0a050908f004","name":"201 Created: Create a new OS Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"test OS Type\",\n \"description\": \"OS Type Description\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/utils/ostypes/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["utils","ostypes",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Thu, 17 Feb 2022 04:29:40 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"215","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"test OS Type\",\n \"unique_id\": \"b159f9eb-3b4b-45f4-95fc-119358a0fc1b\",\n \"readable_id\": \"OST437\",\n \"description\": \"OS Type Description\",\n \"created\": \"2022-02-17T04:29:40.303636Z\",\n \"modified\": \"2022-02-17T04:29:40.303636Z\"\n}"}],"_postman_id":"19e1efa5-8e6e-497e-93d6-f09ee3a2f039"},{"name":"Update OS Type","id":"31f3f92f-9da8-4f75-920b-54e82d3e9fce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"updated test OS Type\",\n \"description\": \"updated OS Type description\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/utils/ostypes/:ostype_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Update the details of an OS type in the CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
`title`	String	Optional	Enter a title for the OS type.
`description`	String	Optional	Enter a description for the OS type.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	The title of the OS type.
`unique_id`	String	Unique Identifier String of UUID-4 format of the OS type.
`readable_id`	String	Unique readable ID of the OS type. It starts with OST followed by a unique number. Example: \"OST101\"
`description`	Text	Description of the OS type.
`created`	Datetime	Creation date and time of the OS type in ISO format.
`modified`	Datetime	Last modified date and time of the OS type in ISO format.

Example Error Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Description
400	Title cannot be null.
404	OS type does not exist.

","urlObject":{"path":["utils","ostypes",":ostype_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the OS Type in UUID-4 format.

\n","type":"text/plain"},"type":"any","value":"c09ea131-9755-463d-9429-dd57dc6543b7","key":"ostype_unique_id"}]}},"response":[{"id":"1a9aa751-9633-4061-9af1-f15ed462d5c7","name":"200 OK: Update an OS Type's title","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"updated test OS Type\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/utils/ostypes/:ostype_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["utils","ostypes",":ostype_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"ostype_unique_id","value":"c09ea131-9755-463d-9429-dd57dc6543b7","description":"Enter the unique ID of the OS Type of UUID-4 format"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Thu, 17 Feb 2022 06:03:04 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"223","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"updated test OS Type\",\n \"unique_id\": \"c09ea131-9755-463d-9429-dd57dc6543b7\",\n \"readable_id\": \"OST440\",\n \"description\": \"OS Type description\",\n \"created\": \"2022-02-17T04:35:49.329864Z\",\n \"modified\": \"2022-02-17T06:03:04.827863Z\"\n}"}],"_postman_id":"31f3f92f-9da8-4f75-920b-54e82d3e9fce"}],"id":"7be65fc5-e8e1-4f9b-a651-f1de577926d4","description":"

In the OS Types section, CFTR admins can configure the types of OS used by various endpoints in your organization.

This section describes how to use the API endpoints to manage OS types in the CFTR application.

\n","_postman_id":"7be65fc5-e8e1-4f9b-a651-f1de577926d4"},{"name":"Location","item":[{"name":"Get List of Locations","id":"bcd2ea93-c477-4d50-8144-4c64c54a8636","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}v1/utils/location/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve a list of all locations with details from the CFTR application.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` shows the API endpoint to the next page.
`count`	Integer	Total number of locations in CFTR application according to the filters applied.
`results`	List of Objects	Details of the location. Each object provides details of one location.

Response Parameters | Results Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	The title of the location.
`unique_id`	String	Unique ID of the location in UUID-4 format.
`country`	String	Unique ID of the corresponding country in UUID-4 format.
`country_data`	Object	Details of the corresponding country.
`state`	String	Unique ID of the corresponding state in UUID-4 format.
`state_data`	Object	Details of the corresponding state.
`city`	String	Name of the city.
`site`	String	Name of the site.
`pincode`	String	PIN code of the site.
`created`	String	Creation date and time of the location in ISO format.
`modified`	String	Last modified date and time of the location in ISO format.
`is_active`	Boolean	Shows if the location is active or not.
`Longitude`	String	Unique ID of the longitude of the location.
`Latitude`	String	Unique ID of the lantitude of the location.

Response Parameters | Country Data Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	The name of the Country.
`unique_id`	String	Unique ID of the corresponding country in UUID-4 format.

Response Parameters | State Data Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	The name of the State.
`unique_id`	String	Unique ID of the corresponding state in UUID-4 format.

[integer] [Optional] Enter the number of records to be retrieved per page. Default value: 10

\n","type":"text/plain"},"key":"page_size","value":"30"},{"disabled":true,"description":{"content":"

[String] [Optional] Enter the query string to filter the response based on the location title that contains the query string. Default value: None

\n","type":"text/plain"},"key":"q","value":"delhi"},{"disabled":true,"description":{"content":"

[integer] [Optional] Enter the page number. All the locations of this page will be returned. Default value: 1

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

[String] [Optional] Enter the title of the location. The details of the specific location is returned. Default value: None

\n","type":"text/plain"},"key":"title","value":"delhi"},{"disabled":true,"description":{"content":"

[String] [Optional] Enter the unique ID of the location. The details of the specific location is returned. Default value: None

\n","type":"text/plain"},"key":"unique_id","value":"4882e471-e997-43ec-a317-e244d8286690"}],"variable":[]}},"response":[{"id":"baf4172d-57c9-4b70-a51d-a3ee4bae9d1b","name":"Get List of Locations whose titles contain the strng \"Tiru\"","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}","disabled":true}],"url":{"raw":"{{base_url}}v1/utils/location/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&page_size=30&q=tiru&page=1","host":["{{base_url}}v1"],"path":["utils","location",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"page_size","value":"30","description":"[integer] [Optional] [Default: 10] Number of records retrieved per page"},{"key":"q","value":"tiru","description":"[String] [Optional] [Default: None] Query String on which the API returns Locations whose titles contain entered string"},{"key":"page","value":"1","description":"[integer] [Optional] [Default: 1] Starting page. Actual records returned depends on page and page_size"},{"key":"title","value":null,"description":"[String] [Optional] [Default: None] Query String on which the API returns Location whose title exctly matches the entered sting ","disabled":true},{"key":"unique_id","value":null,"description":"[String] [Optional] [Default: None] Query String to get Location by unique_id of the Location.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Wed, 23 Feb 2022 06:14:43 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1528","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 3,\n \"results\": [\n {\n \"title\": \"Tiruchoor\",\n \"country\": \"4882e471-e997-43ec-a317-e244d8286690\",\n \"country_data\": {\n \"title\": \"India\",\n \"unique_id\": \"4882e471-e997-43ec-a317-e244d8286690\"\n },\n \"state\": \"8e2beaff-7aaf-4b72-bcc0-d61b25e822f3\",\n \"state_data\": {\n \"title\": \"Tamil Nadu\",\n \"unique_id\": \"8e2beaff-7aaf-4b72-bcc0-d61b25e822f3\"\n },\n \"city\": \"Tiruchoor\",\n \"site\": \"Office\",\n \"pincode\": \"517092\",\n \"unique_id\": \"eab37b3a-7e91-49cf-bb05-30bfa4d811c6\",\n \"created\": \"2022-02-22T10:27:29.118125Z\",\n \"modified\": \"2022-02-23T04:43:05.027368Z\"\n },\n {\n \"title\": \"Tirumala\",\n \"country\": \"4882e471-e997-43ec-a317-e244d8286690\",\n \"country_data\": {\n \"title\": \"India\",\n \"unique_id\": \"4882e471-e997-43ec-a317-e244d8286690\"\n },\n \"state\": \"ef48b6b6-d32f-4015-b130-a5dce6f3ee55\",\n \"state_data\": {\n \"title\": \"Andhra Pradesh\",\n \"unique_id\": \"ef48b6b6-d32f-4015-b130-a5dce6f3ee55\"\n },\n \"city\": \"Tirumala\",\n \"site\": \"Office Campus\",\n \"pincode\": \"517101\",\n \"unique_id\": \"59a5cf12-a70e-4852-99ab-13be2ab991bd\",\n \"created\": \"2022-02-15T11:59:23.553038Z\",\n \"modified\": \"2022-02-23T03:54:27.658545Z\"\n },\n {\n \"title\": \"Tirupathi\",\n \"country\": \"4882e471-e997-43ec-a317-e244d8286690\",\n \"country_data\": {\n \"title\": \"India\",\n \"unique_id\": \"4882e471-e997-43ec-a317-e244d8286690\"\n },\n \"state\": \"ef48b6b6-d32f-4015-b130-a5dce6f3ee55\",\n \"state_data\": {\n \"title\": \"Andhra Pradesh\",\n \"unique_id\": \"ef48b6b6-d32f-4015-b130-a5dce6f3ee55\"\n },\n \"city\": \"Tirupathi\",\n \"site\": \"Office Campus\",\n \"pincode\": \"517101\",\n \"unique_id\": \"be4ab48c-78dc-4f90-bcb8-80c1c8ffef7f\",\n \"created\": \"2022-02-23T03:30:11.856709Z\",\n \"modified\": \"2022-02-23T03:30:11.856709Z\"\n }\n ],\n \"mapping\": {\n \"dropdown_display_name\": \"readable_id\"\n }\n}"}],"_postman_id":"bcd2ea93-c477-4d50-8144-4c64c54a8636"},{"name":"Create Location","id":"eda231d0-b801-42dd-bade-a077660e25c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"city\": \"Kolkata\",\n \"country\": \"4882e471-e997-43ec-a317-e244d8286690\",\n \"pincode\": \"700001\",\n \"site\": \"Office Campus\",\n \"state\": \"f3451c59-c77a-415e-a658-9f310f7c8dc9\",\n \"title\": \"Kolkata\"\n}"},"url":"{{base_url}}v1/utils/location/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Create a location in your CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
`title`	String	Mandatory	Enter a title for the location.
`country`	String	Mandatory	Enter the unique ID of the country in UUID format.
`state`	String	Mandatory	Enter the unique ID of the state in UUID format.
`city`	String	Optional	Enter the city name.
`site`	String	Optional	Enter the site name.
`pincode`	String	Optional	Enter the PIN code of the site.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` shows the API endpoint to the next page.
`count`	Integer	Total number of locations in CFTR application according to the filters applied.
`results`	List of Objects	Details of the location. Each object provides details of one location.

Response Parameters | Results Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	The title of the location.
`unique_id`	String	Unique ID of the location in UUID-4 format.
`country`	String	Unique ID of the corresponding country in UUID-4 format.
`country_data`	Object	Details of the corresponding country.
`state`	String	Unique ID of the corresponding state in UUID-4 format.
`state_data`	Object	Details of the corresponding state.
`city`	String	Name of the city.
`site`	String	Name of the site.
`pincode`	String	PIN code of the site.
`created`	String	Creation date and time of the location in ISO format.
`modified`	String	Last modified date and time of the location in ISO format.
`latitude`	String	Latitude of the location
`longitude`	String	Longitude of the location

Response Parameters | Country Data Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	The name of the Country.
`unique_id`	String	Unique ID of the corresponding country in UUID-4 format.

Response Parameters | State Data Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	The name of the State.
`unique_id`	String	Unique ID of the corresponding state in UUID-4 format.

","urlObject":{"path":["utils","location",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"6a7599f8-a494-4268-b105-77c5d76a8073","name":"Create a new Location","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}","disabled":true}],"body":{"mode":"raw","raw":"{\n \"city\": \"Kolkata\",\n \"country\": \"4882e471-e997-43ec-a317-e244d8286690\",\n \"pincode\": \"700001\",\n \"site\": \"Office Campus\",\n \"state\": \"f3451c59-c77a-415e-a658-9f310f7c8dc9\",\n \"title\": \"Kolkata\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/utils/location/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["utils","location",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Wed, 23 Feb 2022 06:43:33 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"478","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"Kolkata\",\n \"country\": \"4882e471-e997-43ec-a317-e244d8286690\",\n \"country_data\": {\n \"title\": \"India\",\n \"unique_id\": \"4882e471-e997-43ec-a317-e244d8286690\"\n },\n \"state\": \"f3451c59-c77a-415e-a658-9f310f7c8dc9\",\n \"state_data\": {\n \"title\": \"West Bengal\",\n \"unique_id\": \"f3451c59-c77a-415e-a658-9f310f7c8dc9\"\n },\n \"city\": \"Kolkata\",\n \"site\": \"Office Campus\",\n \"pincode\": \"700001\",\n \"unique_id\": \"c13178eb-c7cd-4d93-a4cd-d8da3ace0ab6\",\n \"created\": \"2022-02-23T06:43:33.913094Z\",\n \"modified\": \"2022-02-23T06:43:33.913094Z\"\n}"}],"_postman_id":"eda231d0-b801-42dd-bade-a077660e25c9"},{"name":"Update Location","id":"cee0d86f-c1d3-4b35-9e7f-682822292fc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}"}],"body":{"mode":"raw","raw":"{\n \"city\": \"Howrah\",\n \"country\": \"4882e471-e997-43ec-a317-e244d8286690\",\n \"pincode\": \"700004\",\n \"site\": \"Office Campus\",\n \"state\": \"f3451c59-c77a-415e-a658-9f310f7c8dc9\",\n \"title\": \"Howrah\"\n}"},"url":"{{base_url}}v1/utils/location/:location_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Update a location in your CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
`title`	String	Optional	Enter a title for the location.
`country`	String	Optional	Enter the unique ID of the country in UUID format.
`state`	String	Optional	Enter the unique ID of the state in UUID format.
`city`	String	Optional	Enter the city name.
`site`	String	Optional	Enter the site name.
`pincode`	String	Optional	Enter the PIN code of the site.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` shows the API endpoint to the next page.
`count`	Integer	Total number of locations in CFTR application according to the filters applied.
`results`	List of Objects	Details of the location. Each object provides details of one location.

Response Parameters | Results Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	The title of the location.
`unique_id`	String	Unique ID of the location in UUID-4 format.
`country`	String	Unique ID of the corresponding country in UUID-4 format.
`country_data`	Object	Details of the corresponding country.
`state`	String	Unique ID of the corresponding state in UUID-4 format.
`state_data`	Object	Details of the corresponding state.
`city`	String	Name of the city.
`site`	String	Name of the site.
`pincode`	String	PIN code of the site.
`created`	String	Creation date and time of the location in ISO format.
`modified`	String	Last modified date and time of the location in ISO format.

Response Parameters | Country Data Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	The name of the Country.
`unique_id`	String	Unique ID of the corresponding country in UUID-4 format.

Response Parameters | State Data Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	The name of the state.
`unique_id`	String	Unique ID of the corresponding state in UUID-4 format.

","urlObject":{"path":["utils","location",":location_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the location in UUID-4 format.

\n","type":"text/plain"},"type":"any","value":"411b6ad5-3fdd-4608-9bc9-0129d2a78d57","key":"location_unique_id"}]}},"response":[{"id":"4e0f2622-2ade-4c01-9406-bb5cd925ae92","name":"Update title, city and pincode of a Location","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}"}],"body":{"mode":"raw","raw":"{\n \"city\": \"Howrah\",\n \"country\": \"4882e471-e997-43ec-a317-e244d8286690\",\n \"pincode\": \"700004\",\n \"site\": \"Office Campus\",\n \"state\": \"f3451c59-c77a-415e-a658-9f310f7c8dc9\",\n \"title\": \"Howrah\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/utils/location/:location_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["utils","location",":location_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"location_unique_id","value":"c13178eb-c7cd-4d93-a4cd-d8da3ace0ab6"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Wed, 23 Feb 2022 07:10:55 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"476","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"Howrah\",\n \"country\": \"4882e471-e997-43ec-a317-e244d8286690\",\n \"country_data\": {\n \"title\": \"India\",\n \"unique_id\": \"4882e471-e997-43ec-a317-e244d8286690\"\n },\n \"state\": \"f3451c59-c77a-415e-a658-9f310f7c8dc9\",\n \"state_data\": {\n \"title\": \"West Bengal\",\n \"unique_id\": \"f3451c59-c77a-415e-a658-9f310f7c8dc9\"\n },\n \"city\": \"Howrah\",\n \"site\": \"Office Campus\",\n \"pincode\": \"700004\",\n \"unique_id\": \"c13178eb-c7cd-4d93-a4cd-d8da3ace0ab6\",\n \"created\": \"2022-02-23T06:43:33.913094Z\",\n \"modified\": \"2022-02-23T07:10:55.561849Z\"\n}"}],"_postman_id":"cee0d86f-c1d3-4b35-9e7f-682822292fc3"}],"id":"a44f3e3c-14fe-465e-8918-b1b77d925bb4","description":"

In the Locations section, CFTR admins can configure various geographical locations of the users.

This section describes how to use the API endpoints to manage locations in the CFTR application.

\n","_postman_id":"a44f3e3c-14fe-465e-8918-b1b77d925bb4"},{"name":"Manufacturers","item":[{"name":"Get List of Manufacturers","id":"8beb4f64-40ba-4a34-ba8b-32de11d4157d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}v1/utils/manufacturers/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve a list of all manufacturers with details from the CFTR application.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` shows the API endpoint to the next page.
`count`	Integer	Total number of manufacturers in the CFTR application according to the filters applied.
`results`	List of Objects	Details of the manufacturers. Each object provides details of one manufacturer.

Response Parameters | Results Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	The title of the manufacturer.
`unique_id`	String	Unique ID of the manufacturer in UUID-4 format.
`readable_id`	String	Unique readable ID of the manufacturer. It starts with MFR followed by a unique number. Example: \"MFR101\"
`description`	Text	Description of the manufacturer.
`created`	String	Creation date and time of the manufacturer in ISO format.
`modified`	String	Last modified date and time of the manufacturer in ISO format.

[integer] [Optional] Enter the number of records to be retrieved per page. Default value: 10

\n","type":"text/plain"},"key":"page_size","value":"30"},{"disabled":true,"description":{"content":"

[String] [Optional] Enter the query string to filter the response based on the manufacturer title that contains thequery string. Default value: None

\n","type":"text/plain"},"key":"q","value":"cis"},{"disabled":true,"description":{"content":"

[integer] [Optional] Enter the page number. All the manufacturers of this page will be returned. Default value: 1

\n","type":"text/plain"},"key":"page","value":"2"}],"variable":[]}},"response":[{"id":"e00580a2-acb7-4aef-8238-a19edb1d0244","name":"Eg: Get records of first 30 manufacturers","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}","disabled":true}],"url":{"raw":"{{base_url}}v1/utils/manufacturers/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&page_size=30","host":["{{base_url}}v1"],"path":["utils","manufacturers",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"page_size","value":"30","description":"[integer] [Optional] [Default: 1] Number of records retrieved per page"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Thu, 17 Feb 2022 05:21:28 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"6158","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {\n \"next\": \"openapi/v1/utils/manufacturers/?page=2&page_size=30&AccessID=6ffcb69e-3ece-4bf0-a8f7-c787ca1a5984&Expires=1645075303&Signature=FX8U/u2EylkKeaToSy0rYAR5K3I=\"\n },\n \"count\": 156,\n \"results\": [\n {\n \"title\": \"ABS Computer Technologies (Parent: Newegg)\",\n \"unique_id\": \"9f95931a-e628-47d5-a08e-780cbbb07f87\",\n \"readable_id\": \"MFR101\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:23.729568Z\",\n \"modified\": \"2022-02-16T04:21:05.437329Z\"\n },\n {\n \"title\": \"Acer\",\n \"unique_id\": \"e6bdcd7f-e2f0-4668-8669-84943f5b898b\",\n \"readable_id\": \"MFR102\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:23.748743Z\",\n \"modified\": \"2022-01-24T09:48:09.797979Z\"\n },\n {\n \"title\": \"Achim\",\n \"unique_id\": \"d9ee1ce5-d8a7-45ca-b14d-1488816956d1\",\n \"readable_id\": \"MFR103\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:23.767180Z\",\n \"modified\": \"2022-01-24T09:48:07.947019Z\"\n },\n {\n \"title\": \"ACube Systems Srl\",\n \"unique_id\": \"d7d1f309-a800-48c0-a609-044c2810912b\",\n \"readable_id\": \"MFR105\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:23.797634Z\",\n \"modified\": \"2022-01-24T09:48:07.975004Z\"\n },\n {\n \"title\": \"Aigo\",\n \"unique_id\": \"2918905d-0650-48ac-b6e5-65a7c0327282\",\n \"readable_id\": \"MFR107\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:23.826174Z\",\n \"modified\": \"2022-01-24T09:48:08.000192Z\"\n },\n {\n \"title\": \"Aleutia\",\n \"unique_id\": \"61568ac5-5b9b-4282-8be5-2ca819b71932\",\n \"readable_id\": \"MFR109\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:23.852424Z\",\n \"modified\": \"2022-01-24T09:48:08.036930Z\"\n },\n {\n \"title\": \"Alienware (Parent: Dell)\",\n \"unique_id\": \"cf0e752b-8824-48fb-bc76-435217c9cddb\",\n \"readable_id\": \"MFR110\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:23.864933Z\",\n \"modified\": \"2022-01-24T09:48:08.049263Z\"\n },\n {\n \"title\": \"AMAX Information Technologies\",\n \"unique_id\": \"2412b0dc-86d8-4795-be10-fb20d633870a\",\n \"readable_id\": \"MFR111\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:23.878359Z\",\n \"modified\": \"2022-01-24T09:48:08.061150Z\"\n },\n {\n \"title\": \"AMD\",\n \"unique_id\": \"9385025e-8e11-474b-8042-a4e2c3c4f782\",\n \"readable_id\": \"MFR108\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:23.838095Z\",\n \"modified\": \"2022-01-24T09:48:08.022913Z\"\n },\n {\n \"title\": \"Amiga, Inc.\",\n \"unique_id\": \"40918cf5-d080-41cd-bcca-f53055628313\",\n \"readable_id\": \"MFR104\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:23.782251Z\",\n \"modified\": \"2022-01-24T09:48:07.960184Z\"\n },\n {\n \"title\": \"AOpen\",\n \"unique_id\": \"86533c94-1274-4ed3-8639-22daf6a09f0c\",\n \"readable_id\": \"MFR112\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:23.891935Z\",\n \"modified\": \"2022-01-24T09:48:08.071797Z\"\n },\n {\n \"title\": \"Aorus\",\n \"unique_id\": \"6b55a97b-bf72-4d4d-9113-e0c6c286a112\",\n \"readable_id\": \"MFR144\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:24.355868Z\",\n \"modified\": \"2022-01-24T09:48:08.469131Z\"\n },\n {\n \"title\": \"Apple\",\n \"unique_id\": \"f60ad38d-7b37-4686-bb1e-ffef4f01a888\",\n \"readable_id\": \"MFR113\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:23.905763Z\",\n \"modified\": \"2022-01-24T09:48:08.081588Z\"\n },\n {\n \"title\": \"ASRock\",\n \"unique_id\": \"e46366b4-7eb5-4713-b8ef-403bbdc8ee25\",\n \"readable_id\": \"MFR114\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:23.920667Z\",\n \"modified\": \"2022-01-24T09:48:08.092208Z\"\n },\n {\n \"title\": \"Asus\",\n \"unique_id\": \"7a717083-68f8-4cb2-89ac-cc7220e6236a\",\n \"readable_id\": \"MFR115\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:23.935919Z\",\n \"modified\": \"2022-01-24T09:48:08.109110Z\"\n },\n {\n \"title\": \"AVADirect\",\n \"unique_id\": \"00a500d0-3d26-4ccd-b952-01d2273de413\",\n \"readable_id\": \"MFR116\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:23.950175Z\",\n \"modified\": \"2022-01-24T09:48:08.123317Z\"\n },\n {\n \"title\": \"Avast\",\n \"unique_id\": \"686d398c-b964-4f07-be4a-835f1e175858\",\n \"readable_id\": \"MFR244\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:26.043455Z\",\n \"modified\": \"2022-01-24T09:48:09.685838Z\"\n },\n {\n \"title\": \"AXIOO International\",\n \"unique_id\": \"72cf3706-1146-405f-b063-f12917ea3d3c\",\n \"readable_id\": \"MFR117\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:23.964428Z\",\n \"modified\": \"2022-01-24T09:48:08.137834Z\"\n },\n {\n \"title\": \"Azure\",\n \"unique_id\": \"dd60d43b-02c7-41e9-8322-0fbec7d02bd6\",\n \"readable_id\": \"MFR247\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:26.095689Z\",\n \"modified\": \"2022-01-24T09:48:09.720902Z\"\n },\n {\n \"title\": \"BenQ\",\n \"unique_id\": \"c01875e2-a8bc-443f-be3e-1315abe1af98\",\n \"readable_id\": \"MFR118\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:23.979213Z\",\n \"modified\": \"2022-01-24T09:48:08.152512Z\"\n },\n {\n \"title\": \"Biostar\",\n \"unique_id\": \"3635c069-706e-4623-9693-d810474561d7\",\n \"readable_id\": \"MFR119\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:23.998879Z\",\n \"modified\": \"2022-01-24T09:48:08.168334Z\"\n },\n {\n \"title\": \"Bromium\",\n \"unique_id\": \"1b717fd7-169d-4d1c-b5ba-50c745e53790\",\n \"readable_id\": \"MFR248\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:26.114985Z\",\n \"modified\": \"2022-01-24T09:48:09.732722Z\"\n },\n {\n \"title\": \"Carbon black\",\n \"unique_id\": \"8e93f74d-8b25-4c6c-81fc-01db083aa800\",\n \"readable_id\": \"MFR238\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:25.935903Z\",\n \"modified\": \"2022-01-24T09:48:09.617536Z\"\n },\n {\n \"title\": \"Chassis Plans\",\n \"unique_id\": \"112d052b-1892-46d1-8c08-21789668af94\",\n \"readable_id\": \"MFR120\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:24.015339Z\",\n \"modified\": \"2022-01-24T09:48:08.184025Z\"\n },\n {\n \"title\": \"Checkpoint\",\n \"unique_id\": \"080a22d7-ba3d-4aae-97c2-78240a87fe8d\",\n \"readable_id\": \"MFR245\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:26.059066Z\",\n \"modified\": \"2022-01-24T09:48:09.697669Z\"\n },\n {\n \"title\": \"Chip PC\",\n \"unique_id\": \"29945c24-fe05-46e2-a960-1b0a90589fc5\",\n \"readable_id\": \"MFR121\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:24.031348Z\",\n \"modified\": \"2022-01-24T09:48:08.199753Z\"\n },\n {\n \"title\": \"CISCO \",\n \"unique_id\": \"d11af6ef-d71a-4425-9c64-11b37f537a98\",\n \"readable_id\": \"MFR254\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:26.297700Z\",\n \"modified\": \"2022-01-24T09:48:09.863336Z\"\n },\n {\n \"title\": \"Cisco Systems\",\n \"unique_id\": \"13f87273-907a-4c93-8983-f70846f74bbc\",\n \"readable_id\": \"MFR122\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:24.048309Z\",\n \"modified\": \"2022-01-24T09:48:08.213059Z\"\n },\n {\n \"title\": \"Clevo\",\n \"unique_id\": \"1e465cd7-7805-4dd9-98b4-0fdddd437601\",\n \"readable_id\": \"MFR123\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:24.062542Z\",\n \"modified\": \"2022-01-24T09:48:08.224780Z\"\n },\n {\n \"title\": \"Compal\",\n \"unique_id\": \"78dd8575-1f1f-4fb1-8c4d-b2c4ea180896\",\n \"readable_id\": \"MFR126\",\n \"description\": null,\n \"created\": \"2022-01-24T09:28:24.102179Z\",\n \"modified\": \"2022-01-24T09:48:08.258043Z\"\n }\n ],\n \"mapping\": {\n \"dropdown_display_name\": \"readable_id\"\n }\n}"}],"_postman_id":"8beb4f64-40ba-4a34-ba8b-32de11d4157d"},{"name":"Create Manufacturer","id":"1a8c731f-d6bf-4554-87b7-75a1f6882174","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"test Manufacturer\",\n \"description\": \"Manufacturer description\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/utils/manufacturers/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Creates a manufacturer in your CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
`title`	String	Mandatory	Enter a title for the manufacturer.
`description`	String	Optional	Enter a description of the manufacturer.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	The title of the manufacturer.
`unique_id`	String	Unique ID of the manufacturer in UUID-4 format.
`readable_id`	String	Unique readable ID of the manufacturer. It starts with MFR followed by a unique number. Example: \"MFR101\"
`description`	Text	Description of the manufacturer.
`created`	String	Creation date and time of the manufacturer in ISO format.
`modified`	String	Last modified date and time of the manufacturer in ISO format.

Example Error Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Description
400	Title is required.

","urlObject":{"path":["utils","manufacturers",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"8dcbed68-5277-4352-b002-02b75d8cabf5","name":"Eg: Create a new Manufacturer","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}","disabled":true}],"body":{"mode":"raw","raw":"{\n \"title\": \"test Manufacturer\",\n \"description\": \"Manufacturer description\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/utils/manufacturers/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["utils","manufacturers",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Thu, 17 Feb 2022 05:50:30 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"225","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"test Manufacturer\",\n \"unique_id\": \"0d574e58-3ce0-450c-9ebd-e22168f06e5c\",\n \"readable_id\": \"MFR258\",\n \"description\": \"Manufacturer description\",\n \"created\": \"2022-02-17T05:50:30.817821Z\",\n \"modified\": \"2022-02-17T05:50:30.817821Z\"\n}"}],"_postman_id":"1a8c731f-d6bf-4554-87b7-75a1f6882174"},{"name":"Update Manufacturer","id":"331db441-8716-4b76-b6ca-4248a3258994","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"updated test Manufacturer\",\n \"description\": \"updated Manufacturer description\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/utils/manufacturers/:manufacturer_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Update the details of a manufacturer in the CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
`title`	String	Optional	Enter a title for the manufacturer.
`description`	String	Optional	Enter a description of the manufacturer.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	The title of the manufacturer.
`unique_id`	String	Unique ID of the manufacturer in UUID-4 format.
`readable_id`	String	Unique readable ID of the manufacturer. It starts with MFR followed by a unique number. Example: \"MFR101\"
`description`	Text	Description of the manufacturer.
`created`	String	Creation date and time of the manufacturer in ISO format.
`modified`	String	Last modified date and time of the manufacturer in ISO format.

Example Error Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Description
400	Title cannot be null.
404	Manufacturer does not exist.

","urlObject":{"path":["utils","manufacturers",":manufacturer_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the Manufacturer in UUID-4 format.

\n","type":"text/plain"},"type":"any","value":"50738bb5-0a7a-4692-b8df-b28500596165","key":"manufacturer_unique_id"}]}},"response":[{"id":"56c5535e-d68d-4c57-b202-f6db55607eaf","name":"Eg: Update a Manufacturer's title and description","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}","disabled":true}],"body":{"mode":"raw","raw":"{\n \"title\": \"updated test Manufacturer\",\n \"description\": \"updated Manufacturer description\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/utils/manufacturers/:manufacturer_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["utils","manufacturers",":manufacturer_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"manufacturer_unique_id","value":"50738bb5-0a7a-4692-b8df-b28500596165","description":"Enter the unique ID of the Manufacturer of UUID-4 format"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Thu, 17 Feb 2022 06:11:50 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"241","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"updated test Manufacturer\",\n \"unique_id\": \"50738bb5-0a7a-4692-b8df-b28500596165\",\n \"readable_id\": \"MFR259\",\n \"description\": \"updated Manufacturer description\",\n \"created\": \"2022-02-17T05:56:35.371850Z\",\n \"modified\": \"2022-02-17T06:11:50.333902Z\"\n}"}],"_postman_id":"331db441-8716-4b76-b6ca-4248a3258994"}],"id":"4200d365-9bad-4f9b-8390-f6709791b2da","description":"

In the Manufacturers section, CFTR admins can configure the manufacturers of various assets of your organization.

This section describes how to use the API endpoints to manage the manufacturers in the CFTR application.

\n","_postman_id":"4200d365-9bad-4f9b-8390-f6709791b2da"},{"name":"Source","item":[{"name":"Source_Type","item":[{"name":"Get List Of Source_Types","id":"70111a86-a018-4ae5-af9a-bafb4dca4fc2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}"}],"url":"{{base_url}}v1/utils/source-type/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve a list of all source types with details from the CFTR application.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` shows the API endpoint to the next page.
`count`	Integer	Total number of source types in CFTR application according to the filters applied.
`results`	List of Objects	Details of the source type. Each object provides details of one source type.

Response Parameters | Source Type Data Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the source type in UUID-4 format.
`created`	String	Creation date and time of the source type in ISO format.
`title`	String	The title of the source type.

[String] [Optional] Enter the query string to filter the response based on the source type title that contains the query string. Default value: None

\n","type":"text/plain"},"key":"q_dropdown","value":"CTIX"}],"variable":[]}},"response":[{"id":"0c453884-90cb-4756-a4e2-b1fa160c4a2c","name":"Get List Of Source_Types with titles containing the string \"Type\"","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/utils/source-type/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&q_dropdown=Type","host":["{{base_url}}v1"],"path":["utils","source-type",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"q_dropdown","value":"Type","description":"[String] [Optional] [Default: None] Query String on which the API returns Source_Types whose titles contain entered string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Fri, 25 Feb 2022 13:21:27 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"519","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 4,\n \"results\": [\n {\n \"unique_id\": \"3bb694a6-3725-4c45-8901-eecc9a11dd4e\",\n \"created\": \"2022-02-25T13:05:31.679471Z\",\n \"title\": \"Type4\"\n },\n {\n \"unique_id\": \"fc0f2063-e336-4ff1-bbee-fb573c0d97e5\",\n \"created\": \"2022-02-23T07:16:24.395555Z\",\n \"title\": \"Type3\"\n },\n {\n \"unique_id\": \"b9af3741-1a45-453d-adfb-f06e6fb4b451\",\n \"created\": \"2022-02-23T03:19:46.706878Z\",\n \"title\": \"Type2\"\n },\n {\n \"unique_id\": \"ef9aad94-5162-4ddc-b61a-f1bbaebedda6\",\n \"created\": \"2022-02-21T01:09:15.935035Z\",\n \"title\": \"Type1\"\n }\n ],\n \"mapping\": {\n \"dropdown_display_name\": \"readable_id\"\n }\n}"}],"_postman_id":"70111a86-a018-4ae5-af9a-bafb4dca4fc2"},{"name":"Create new Source_type","id":"be46e996-c240-48ce-9177-d5f7fafe0098","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}"}],"body":{"mode":"raw","raw":"{\n \"title\": \"New Source_Type\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/utils/source-type/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Create a source type in your CFTR application.

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
`title`	String	Mandatory	Enter a name for the source type

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the source type in UUID-4 format.
`created`	String	Creation date and time of the source type in ISO format.
`title`	String	The title of the source type.

","urlObject":{"path":["utils","source-type",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"f5e217d3-614a-4632-8605-e27bab31906d","name":"Create new Source_type titled \"New Source_Type\"","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}"}],"body":{"mode":"raw","raw":"{\n \"title\": \"New Source_Type\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/utils/source-type/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["utils","source-type",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Fri, 25 Feb 2022 13:57:59 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"118","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"unique_id\": \"9cc473cc-fc3e-42b2-854d-456ffa7d8c0f\",\n \"created\": \"2022-02-25T13:57:59.500948Z\",\n \"title\": \"New Source_Type\"\n}"}],"_postman_id":"be46e996-c240-48ce-9177-d5f7fafe0098"}],"id":"72fd091f-bd60-4b74-89ab-1b0fdef82fd5","_postman_id":"72fd091f-bd60-4b74-89ab-1b0fdef82fd5","description":""},{"name":"Get List of Sources","id":"20f9f1ca-b2c8-4ea8-b0cb-cdf3855e8264","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/utils/source/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve a list of all sources with details from the CFTR application.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` shows the API endpoint to the next page.
`count`	Integer	Total number of sources in CFTR application according to the filters applied.
`results`	List of Objects	Details of the source. Each object provides details of one source.

Response Parameters | Results Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`value`	String	The name of the source.
`source_type`	String	Unique ID of the source type in UUID-4 format.
`source_display_name`	String	Display name of the source.
`unique_id`	String	Unique ID of the source in UUID-4 format.
`created`	String	Creation date and time of the source in ISO format.
`modified`	String	Last modified date and time of the source in ISO format.
`source_type_data`	Object	Details of the source type.

Response Parameters | Source Type Data Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the source type in UUID-4 format .
`created`	String	Creation date and time of the source type in ISO format.
`title`	String	The title of the source type.

[integer] [Optional] Enter the number of records to be retrieved per page. Default value: 10

\n","type":"text/plain"},"key":"page_size","value":"30"},{"disabled":true,"description":{"content":"

[String] [Optional] Enter the query string to filter the response based on the source title that contains the query string. Default value: None

\n","type":"text/plain"},"key":"q","value":"bengaluru"},{"disabled":true,"description":{"content":"

[integer] [Optional] Enter the page number. All the sources of this page will be returned. Default value: 1

\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"b00cb14a-7622-4e91-b532-a8ee93592d50","name":"Get List of Sources whose title or source_type__ title attributes contain the string \"Source\"","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}","disabled":true}],"url":{"raw":"{{base_url}}v1/utils/source/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&page_size=30&page=1&q=Source","host":["{{base_url}}v1"],"path":["utils","source",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"page_size","value":"30","description":"[integer] [Optional] [Default: 10] Number of records retrieved per page"},{"key":"page","value":"1","description":"[integer] [Optional] [Default: 1] Starting page. Actual records returned depends on page and page_size"},{"key":"q","value":"Source","description":"[String] [Optional] [Default:None] Query string to filter Sources on the basis of either value (Name of Source) or source_type_data__title(Title of Source Type)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Wed, 23 Feb 2022 06:18:53 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1567","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 4,\n \"results\": [\n {\n \"unique_id\": \"0c8c10fc-4117-40b4-aec2-a2b89c93a855\",\n \"source_type\": \"ef9aad94-5162-4ddc-b61a-f1bbaebedda6\",\n \"value\": \"Source1\",\n \"source_type_data\": {\n \"unique_id\": \"ef9aad94-5162-4ddc-b61a-f1bbaebedda6\",\n \"created\": \"2022-02-21T01:09:15.935035Z\",\n \"title\": \"Type1\"\n },\n \"created\": \"2022-02-21T01:09:23.251661Z\",\n \"source_display_name\": \"Type1-Source1\",\n \"modified\": \"2022-02-23T04:46:09.111810Z\"\n },\n {\n \"unique_id\": \"e27412bf-a59f-489c-a466-9eea0cb55ede\",\n \"source_type\": \"ef9aad94-5162-4ddc-b61a-f1bbaebedda6\",\n \"value\": \"Source2\",\n \"source_type_data\": {\n \"unique_id\": \"ef9aad94-5162-4ddc-b61a-f1bbaebedda6\",\n \"created\": \"2022-02-21T01:09:15.935035Z\",\n \"title\": \"Type1\"\n },\n \"created\": \"2022-02-21T11:40:03.139652Z\",\n \"source_display_name\": \"Type1-Source2\",\n \"modified\": \"2022-02-21T11:40:03.139652Z\"\n },\n {\n \"unique_id\": \"6e98d1c5-17d9-40e8-94c4-86a30c25f68f\",\n \"source_type\": \"b9af3741-1a45-453d-adfb-f06e6fb4b451\",\n \"value\": \"Source3\",\n \"source_type_data\": {\n \"unique_id\": \"b9af3741-1a45-453d-adfb-f06e6fb4b451\",\n \"created\": \"2022-02-23T03:19:46.706878Z\",\n \"title\": \"Type2\"\n },\n \"created\": \"2022-02-22T11:55:19.909939Z\",\n \"source_display_name\": \"Type2-Source3\",\n \"modified\": \"2022-02-23T04:46:18.744286Z\"\n },\n {\n \"unique_id\": \"0cd2b0d2-8fae-4b19-849c-19b181c8c2ac\",\n \"source_type\": \"b9af3741-1a45-453d-adfb-f06e6fb4b451\",\n \"value\": \"Source4\",\n \"source_type_data\": {\n \"unique_id\": \"b9af3741-1a45-453d-adfb-f06e6fb4b451\",\n \"created\": \"2022-02-23T03:19:46.706878Z\",\n \"title\": \"Type2\"\n },\n \"created\": \"2022-02-23T03:19:49.345965Z\",\n \"source_display_name\": \"Type2-Source4\",\n \"modified\": \"2022-02-23T04:46:26.174339Z\"\n }\n ],\n \"mapping\": {\n \"dropdown_display_name\": \"readable_id\"\n }\n}"}],"_postman_id":"20f9f1ca-b2c8-4ea8-b0cb-cdf3855e8264"},{"name":"Create Source","id":"4a1b4841-c240-4427-a300-27b6b383037d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"source_type\": \"ef9aad94-5162-4ddc-b61a-f1bbaebedda6\",\n \"value\": \"Source7\"\n}"},"url":"{{base_url}}v1/utils/source/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Create a source in your CFTR application.

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
`value`	String	Mandatory	Enter a name for the source.
`source_type`	String	Mandatory	Enter the unique ID of the source type in UUID format. Use the following endpoinyt to retrieve the list of source: /openapi/v1/utils/source-type/

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`value`	String	The name of the source.
`source_type`	String	Unique ID of the source type in UUID-4 format.
`source_display_name`	String	Display name of the source.
`unique_id`	String	Unique ID of the source in UUID-4 format.
`created`	String	Creation date and time of the source in ISO format.
`modified`	String	Last modified date and time of the source in ISO format.
`source_type_data`	Object	Details of the source type.

Response Parameters | Source Type Data Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the source type in UUID-4 format .
`created`	String	Creation date and time of the source type in ISO format.
`title`	String	The title of the source type.

","urlObject":{"path":["utils","source",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"63f4f080-f824-417c-8bee-99c666ebbfb8","name":"Create a new Source","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}","disabled":true}],"body":{"mode":"raw","raw":"{\n \"source_type\": \"ef9aad94-5162-4ddc-b61a-f1bbaebedda6\",\n \"value\": \"Source5\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/utils/source/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["utils","source",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Wed, 23 Feb 2022 07:13:08 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"370","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"unique_id\": \"56ef046a-58a4-4eb9-af49-b8ecb4f31e7b\",\n \"source_type\": \"ef9aad94-5162-4ddc-b61a-f1bbaebedda6\",\n \"value\": \"Source5\",\n \"source_type_data\": {\n \"unique_id\": \"ef9aad94-5162-4ddc-b61a-f1bbaebedda6\",\n \"created\": \"2022-02-21T01:09:15.935035Z\",\n \"title\": \"Type1\"\n },\n \"created\": \"2022-02-23T07:13:08.291239Z\",\n \"source_display_name\": \"Type1-Source5\",\n \"modified\": \"2022-02-23T07:13:08.291239Z\"\n}"}],"_postman_id":"4a1b4841-c240-4427-a300-27b6b383037d"},{"name":"Update Source","id":"c1d5fb8e-e56d-4a0f-9f72-5b47fda32f64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}"}],"body":{"mode":"raw","raw":"{\n \"source_type\": \"b9af3741-1a45-453d-adfb-f06e6fb4b451\",\n \"value\": \"Source11\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/utils/source/:source_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Update a source in your CFTR application.

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
`value`	String	Optional	Enter a name for the source.
`source_type`	String	Optional	Enter the unique ID of the source type in UUID format.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`value`	String	The name of the source.
`source_type`	String	Unique ID of the source type in UUID-4 format.
`source_display_name`	String	Display name of the source.
`unique_id`	String	Unique ID of the source in UUID-4 format.
`created`	String	Creation date and time of the source in ISO format.
`modified`	String	Last modified date and time of the source in ISO format.
`source_type_data`	Object	Details of the source type.

Response Parameters | Source Type Data Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the source type in UUID-4 format .
`created`	String	Creation date and time of the source type in ISO format.
`title`	String	The title of the source type.

","urlObject":{"path":["utils","source",":source_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the source in UUID-4 format.

\n","type":"text/plain"},"type":"any","value":"0c8c10fc-4117-40b4-aec2-a2b89c93a855","key":"source_unique_id"}]}},"response":[{"id":"c7c46260-12d7-4b67-a911-646cbf90a207","name":"Update title and source_type of Source","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}"}],"body":{"mode":"raw","raw":"{\n \"source_type\": \"b9af3741-1a45-453d-adfb-f06e6fb4b451\",\n \"value\": \"Source11\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/utils/source/:source_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["utils","source",":source_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"source_unique_id","value":"0c8c10fc-4117-40b4-aec2-a2b89c93a855"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Wed, 23 Feb 2022 07:17:07 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"372","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"unique_id\": \"0c8c10fc-4117-40b4-aec2-a2b89c93a855\",\n \"source_type\": \"b9af3741-1a45-453d-adfb-f06e6fb4b451\",\n \"value\": \"Source11\",\n \"source_type_data\": {\n \"unique_id\": \"b9af3741-1a45-453d-adfb-f06e6fb4b451\",\n \"created\": \"2022-02-23T03:19:46.706878Z\",\n \"title\": \"Type2\"\n },\n \"created\": \"2022-02-21T01:09:23.251661Z\",\n \"source_display_name\": \"Type2-Source11\",\n \"modified\": \"2022-02-23T07:17:07.098893Z\"\n}"}],"_postman_id":"c1d5fb8e-e56d-4a0f-9f72-5b47fda32f64"}],"id":"edeb5793-066b-4ee8-abfa-7d42eaee03cd","description":"

Identifying the sources of the threats is key to defending your organization. Categorizing sources is essential in the incident management process to understand the extent of the potential damage an incident might cause.

This section describes how to use the API endpoints to manage sources in the CFTR application.

\n","_postman_id":"edeb5793-066b-4ee8-abfa-7d42eaee03cd"},{"name":"Business Unit","item":[{"name":"Get List of Business Units","id":"4b4208fd-8bfb-4647-bebb-441b62ab8b9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}"}],"url":"{{base_url}}v1/utils/business-unit/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve a list of all Business Units with details from the CFTR application.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` shows the API endpoint to the next page.
`count`	Integer	Total number of Business Units in CFTR application according to the filters applied.
`results`	List of Objects	Details of the Business Unit. Each object provides details of one Business Unit.

Response Parameters | Results Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	The title of the Business Unit.
`description`	Text	Description of the Business Unit.
`unique_id`	String	Unique ID of the Business Unit in UUID-4 format.
`created`	String	Creation date and time of the Business Unit in ISO format.
`modified`	String	Last modified date and time of the Business Unit in ISO format.
`readable_id`	String	Unique readable ID of the Business Unit. It starts with BU followed by a unique number. Example: \"BU102\"
`email_list`	String	Emails of the recepients to whom the notifications are sent.

[integer] [Optional] Enter the number of records to be retrieved per page. Default value: 10

\n","type":"text/plain"},"key":"page_size","value":"30"},{"disabled":true,"description":{"content":"

[String] [Optional] Enter the query string to filter the response based on the Business Unit title that contains the query string. Default value: None

\n","type":"text/plain"},"key":"q","value":"Arctic"},{"disabled":true,"description":{"content":"

[integer] [Optional] Enter the page number. All the Business Units of this page will be returned. Default value: 1

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

[String] [Optional] Enter the unique ID of the Business Unit. The details of the specific Business Unit is returned. Default value: None

\n","type":"text/plain"},"key":"unique_id","value":"728277db-83be-4108-a8d7-e52c5deefc2c"}],"variable":[]}},"response":[{"id":"719998e6-71df-4a9c-831f-3e352bd9b4ae","name":"Get List of Business Units with string \"BU10\" in their readable_id","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}"}],"url":{"raw":"{{base_url}}v1/utils/business-unit/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&page_size=30&q=BU10&page=1&unique_id","host":["{{base_url}}v1"],"path":["utils","business-unit",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"page_size","value":"30","description":"[integer] [Optional] [Default: 10] Number of records retrieved per page"},{"key":"q","value":"BU10","description":"[String] [Optional] [Default: None] Filter Business Units on the basis on the basis of readable_id, unique_id or title."},{"key":"page","value":"1","description":"[integer] [Optional] [Default: 1] Starting page. Actual records returned depends on page and page_size"},{"key":"unique_id","value":null,"description":"[String] [Optional] [Default: None] Query String to get Business Unit by unique_id of the Location."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Wed, 23 Feb 2022 06:32:02 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1107","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 5,\n \"results\": [\n {\n \"title\": \"Arctic Fox\",\n \"description\": \"Description\",\n \"unique_id\": \"728277db-83be-4108-a8d7-e52c5deefc2c\",\n \"created\": \"2022-02-23T06:29:21.983864Z\",\n \"modified\": \"2022-02-23T06:29:21.983864Z\",\n \"readable_id\": \"BU106\"\n },\n {\n \"title\": \"Arctic Owl\",\n \"description\": \"Description\",\n \"unique_id\": \"c56ebc77-7069-438b-b698-a767675ffcc1\",\n \"created\": \"2022-02-22T12:24:52.934007Z\",\n \"modified\": \"2022-02-23T04:45:00.464222Z\",\n \"readable_id\": \"BU105\"\n },\n {\n \"title\": \"Argent Cobra\",\n \"description\": \"test\",\n \"unique_id\": \"e5c55bf9-a7a8-4296-8df7-75985b025c35\",\n \"created\": \"2022-02-21T12:40:06.955100Z\",\n \"modified\": \"2022-02-23T04:45:32.440961Z\",\n \"readable_id\": \"BU103\"\n },\n {\n \"title\": \"Atlas-CLT\",\n \"description\": \"The Description\",\n \"unique_id\": \"bfb0b460-1df9-43a9-bb5a-f88202ca09e5\",\n \"created\": \"2022-02-22T12:19:34.716561Z\",\n \"modified\": \"2022-02-23T04:45:09.557591Z\",\n \"readable_id\": \"BU104\"\n },\n {\n \"title\": \"Blue Bobcat\",\n \"description\": \"Description\",\n \"unique_id\": \"8b2a1983-ebae-4ec0-929b-013259bf4d13\",\n \"created\": \"2022-02-15T06:36:15.833329Z\",\n \"modified\": \"2022-02-23T04:45:55.191261Z\",\n \"readable_id\": \"BU102\"\n }\n ],\n \"mapping\": {\n \"dropdown_display_name\": \"readable_id\"\n }\n}"}],"_postman_id":"4b4208fd-8bfb-4647-bebb-441b62ab8b9e"},{"name":"Create Business Unit","id":"4afcf4a5-565f-4cfa-9de1-9ce9d2bccda0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"description\": \"The Description\",\n \"title\": \"Business Unit title\"\n}"},"url":"{{base_url}}v1/utils/business-unit/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Create a Business Unit in your CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
`title`	String	Mandatory	Enter a name for the Business Unit.
`description`	String	Optional	Enter a description of the Business Unit.
`email_list`	String	Optional	Emails to which the incident notifications are sent.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	The title of the Business Unit.
`description`	Text	Description of the Business Unit.
`unique_id`	String	Unique ID of the Business Unit in UUID-4 format.
`created`	String	Creation date and time of the Business Unit in ISO format.
`modified`	String	Last modified date and time of the Business Unit in ISO format.
`readable_id`	String	Unique readable ID of the Business Unit. It starts with BU followed by a unique number. Example: \"BU102\"
`email_list`	String	Emails to which the incident notifications are sent.

","urlObject":{"path":["utils","business-unit",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"c42893a2-ee60-4b07-af61-4b2099c11192","name":"Create Business Unit","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}","disabled":true}],"body":{"mode":"raw","raw":"{\n \"description\": \"The Description\",\n \"title\": \"Business Unit title 3\",\n \"email_list\":\"john.doe@abc.com\"\n}"},"url":{"raw":"{{base_url}}v1/utils/business-unit/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["utils","business-unit",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 04 Jan 2024 07:06:29 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"258","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: http: data: blob:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"India\",\n \"description\": \"Asian business unit\",\n \"unique_id\": \"745cb471-6bc4-4410-8387-4cecf859ebf3\",\n \"created\": \"2024-01-04T07:06:29.326907Z\",\n \"modified\": \"2024-01-04T07:06:29.326907Z\",\n \"readable_id\": \"BU121\",\n \"email_list\": \"john.doe@abc.com\"\n}"}],"_postman_id":"4afcf4a5-565f-4cfa-9de1-9ce9d2bccda0"},{"name":"Update Business Unit","id":"70a02697-fc56-4cc7-b400-43fa4c215fa3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}"}],"body":{"mode":"raw","raw":"{\n \"description\": \"Updated Description\",\n \"title\": \"Updated Business Unit\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/utils/business-unit/:business-unit_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Update a Business Unit in your CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
`title`	String	Optional	Enter a name for the Business Unit.
`description`	String	Optional	Enter a description of the Business Unit.
email_list	String	Optional	Emails to which the incident notifications are sent.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	The title of the Business Unit.
`description`	Text	Description of the Business Unit.
`unique_id`	String	Unique ID of the Business Unit in UUID-4 format.
`created`	String	Creation date and time of the Business Unit in ISO format.
`modified`	String	Last modified date and time of the Business Unit in ISO format.
`readable_id`	String	Unique readable ID of the Business Unit. It starts with BU followed by a unique number. Example: \"BU102\"

","urlObject":{"path":["utils","business-unit",":business-unit_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the Business Unit in UUID-4 format

\n","type":"text/plain"},"type":"any","value":"c56ebc77-7069-438b-b698-a767675ffcc1","key":"business-unit_unique_id"}]}},"response":[{"id":"d8e693fa-f467-4190-87fe-082c824d8afd","name":"Update title and description of a Business Unit","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}"}],"body":{"mode":"raw","raw":"{\n \"description\": \"A new business unit is added\",\n \"title\": \"New york\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/utils/business-unit/:business-unit_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["utils","business-unit",":business-unit_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"business-unit_unique_id","value":"c56ebc77-7069-438b-b698-a767675ffcc1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Wed, 23 Feb 2022 07:31:47 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"223","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"New York\",\n \"description\": \"This is a new business unit\",\n \"unique_id\": \"c56ebc77-7069-438b-b698-a767675ffcc1\",\n \"created\": \"2022-02-22T12:24:52.934007Z\",\n \"modified\": \"2022-02-23T07:31:47.311828Z\",\n \"readable_id\": \"BU105\"\n}"}],"_postman_id":"70a02697-fc56-4cc7-b400-43fa4c215fa3"}],"id":"9010b1d7-1ff7-41fd-9b48-959ff2f0c0df","description":"

In the Business Units tab of the Settings module, CFTR admins can configure the business units of the organization.

This section describes how to use the API endpoints to manage business units in the CFTR application.

\n","_postman_id":"9010b1d7-1ff7-41fd-9b48-959ff2f0c0df"},{"name":"Labels","item":[{"name":"Get List of Labels","id":"ca8c2a88-458c-4ab1-951e-2766c5787ade","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}"}],"url":"{{base_url}}v1/utils/label/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve a list of labels with details from the CFTR application.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` shows the API endpoint to the next page.
`count`	Integer	Total number of labels in CFTR application according to the filters applied.
`results`	List of Objects	Details of the labels. Each object provides details of one label.

Response Parameters | Results Object

String

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the label in UUID-4 format.
`title`	String	The title of the label.
`description`	Text	Description of the label.
`color_code`	String	Hex value of the label color.
`created`	Creation date and time of the label in ISO format.
`modified`	String	Last modified date and time of the label in ISO format.
`component_identifier`	String	Unique ID of the associated component.
`component_identifier_data`	Object	Details of the `component_identifier`. Note: The parameters of the `component_identifier_data` are described in the table below.

Response Parameters | Component Identifier Data Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`component_name`	String	The name of the component.
`component_identifier`	String	Unique ID of the associated component.

[integer] [Optional] Enter the number of records to be retrieved per page. Default value: 10

\n","type":"text/plain"},"key":"page_size","value":"30"},{"disabled":true,"description":{"content":"

[String] [Optional] Enter the query string to filter the response based on the label title that contains the query string. Default value: None

\n","type":"text/plain"},"key":"q","value":"label"},{"disabled":true,"description":{"content":"

[integer] [Optional] Enter the page number. All the labels of this page will be returned. Default value: 1

\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"a1ddde6b-9f67-46aa-bd22-5881b492bf39","name":"Eg: Get records of first 30 Labels containing \"label\" in their title","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}"}],"url":{"raw":"{{base_url}}v1/utils/label/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&page_size=30&q=label","host":["{{base_url}}v1"],"path":["utils","label",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"page_size","value":"30","description":"[integer] [Optional] [Default: 10] Number of records retrieved per page"},{"key":"q","value":"label","description":"[String][Optional][Default: None] Query string on which API returns the Labels containing it"},{"key":"page","value":"1","description":"[integer] [Optional] [Default: 1] Starting page. Actual records returned depends on page and page_size","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Thu, 17 Feb 2022 09:33:26 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"794","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 2,\n \"results\": [\n {\n \"unique_id\": \"891c9bfa-4e58-43c6-9159-0eaead22c2a0\",\n \"title\": \"My Label\",\n \"description\": \"my description\",\n \"color_code\": \"#AE45DA\",\n \"created\": \"2022-02-17T06:19:44.269365Z\",\n \"modified\": \"2022-02-17T06:19:44.269365Z\",\n \"component_identifier\": \"action\",\n \"is_removed\": false,\n \"component_identifier_data\": {\n \"component_name\": \"Action\",\n \"component_identifier\": \"action\"\n }\n },\n {\n \"unique_id\": \"e05e83a8-0389-4863-b97f-074c4097a7c2\",\n \"title\": \"My new Label\",\n \"description\": \"My description\",\n \"color_code\": \"#388E3C\",\n \"created\": \"2022-02-17T06:51:25.874625Z\",\n \"modified\": \"2022-02-17T06:51:25.874625Z\",\n \"component_identifier\": \"application\",\n \"is_removed\": false,\n \"component_identifier_data\": {\n \"component_name\": \"Application\",\n \"component_identifier\": \"application\"\n }\n }\n ],\n \"mapping\": {\n \"dropdown_display_name\": \"readable_id\"\n }\n}"}],"_postman_id":"ca8c2a88-458c-4ab1-951e-2766c5787ade"},{"name":"Create Label","id":"2116dedf-3c93-440c-9414-92ecf43c8c47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"color_code\": \"#2E7D32\",\n \"title\": \"test Label\",\n \"component_identifier\": \"incident\",\n \"description\": \"Incident Label\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/utils/label/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Creates a label in your CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
`title`	String	Mandatory	Enter a title for the label.
`component_identifier`	String	Mandatory	Enter the unique ID of the component to which the label is to be associated. Example: \"action\"
`description`	String	Optional	Enter a description of the label.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the label in UUID-4 format.
`title`	String	The title of the label.
`description`	Text	Description of the label.
`color_code`	String	Hex value of the label color.
`created`	String	Creation date and time of the label in ISO format.
`modified`	String	Last modified date and time of the label in ISO format.
`component_identifier`	String	Unique ID of the associated component.
`component_identifier_data`	Object	Details of the `component_identifier`. Note: The parameters of the `component_identifier_data` are described in the table below.

Response Parameters | Component Identifier Data Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`component_name`	String	The name of the component.
`component_identifier`	String	Unique ID of the associated component.

Example Error Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Description
400	Title is required. Component Identifier is required and valid. Title and Component Identifier together should be unique.

","urlObject":{"path":["utils","label",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"dd380d69-66b5-40ab-9837-cfe4aae6504d","name":"Eg: Create a new Label for incident","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}","disabled":true}],"body":{"mode":"raw","raw":"{\n \"color_code\": \"#2E7D32\",\n \"title\": \"test Label\",\n \"component_identifier\": \"incident\",\n \"description\": \"Incident Label\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/utils/label/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["utils","label",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Thu, 17 Feb 2022 10:01:03 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"353","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"unique_id\": \"9ed80da4-11da-42ad-9518-c06d3c8f3254\",\n \"title\": \"test Label\",\n \"description\": \"Incident Label\",\n \"color_code\": \"#2E7D32\",\n \"created\": \"2022-02-17T10:01:03.549231Z\",\n \"modified\": \"2022-02-17T10:01:03.549231Z\",\n \"component_identifier\": \"incident\",\n \"is_removed\": false,\n \"component_identifier_data\": {\n \"component_name\": \"Incident\",\n \"component_identifier\": \"incident\"\n }\n}"}],"_postman_id":"2116dedf-3c93-440c-9414-92ecf43c8c47"},{"name":"Update Label","id":"71013ed0-8209-4939-b625-f9a9d33b5d3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"test Incident Label\",\n \"description\": \"Incident Label description\",\n \"color_code\": \"#2E7D32\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/utils/label/:label_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Update a label in your CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
`color_code`	String	Optional	Enter a color for the Label in hex format [Default: #344563]
`title`	String	Optional	Enter a title for the Label
`description`	String	Optional	Enter a description that best describes the key details of the Label

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the label in UUID-4 format.
`title`	String	The title of the label.
`description`	Text	Description of the label.
`color_code`	String	Hex value of the label color.
`created`	String	Creation date and time of the label in ISO format.
`modified`	String	Last modified date and time of the label in ISO format.
`component_identifier`	String	Unique ID of the associated component.
`component_identifier_data`	Object	Details of the `component_identifier`. Note: The parameters of the `component_identifier_data` are described in the table below.

Response Parameters | Component Identifier Data Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`component_name`	String	The name of the component.
`component_identifier`	String	Unique ID of the associated component.

Example Error Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Description
400	Title is required
404	Label does not exist

","urlObject":{"path":["utils","label",":label_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the Label in UUID-4 format.

\n","type":"text/plain"},"type":"any","value":"9be586b6-bdc7-4af4-b619-b611dbde4fae","key":"label_unique_id"}]}},"response":[{"id":"994cc87c-b5fe-48a8-873b-eb2bc54e1662","name":"Eg: Update a Label's title,description and color","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}","disabled":true}],"body":{"mode":"raw","raw":"{\n \"title\": \"updated Campaign Label\",\n \"description\": \"updated Campaign Label\",\n \"color_code\": \"#344563\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/utils/label/:label_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["utils","label",":label_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"label_unique_id","value":"b754792d-a8e9-4bc8-9ee7-03c1cb15e541","description":"Enter the unique ID of the Label in UUID-4 format"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Thu, 17 Feb 2022 11:14:27 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"373","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"unique_id\": \"b754792d-a8e9-4bc8-9ee7-03c1cb15e541\",\n \"title\": \"updated Campaign Label\",\n \"description\": \"updated Campaign Label\",\n \"color_code\": \"#344563\",\n \"created\": \"2022-02-17T09:50:05.845230Z\",\n \"modified\": \"2022-02-17T11:14:27.889209Z\",\n \"component_identifier\": \"campaign\",\n \"is_removed\": false,\n \"component_identifier_data\": {\n \"component_name\": \"Campaign\",\n \"component_identifier\": \"campaign\"\n }\n}"}],"_postman_id":"71013ed0-8209-4939-b625-f9a9d33b5d3c"}],"id":"e3d0cb5a-9100-4d33-b77a-c2d416bdf4c3","description":"

Labels are tagged to the records of all the CFTR components to organize related records.

This section describes how to use the API endpoints to manage the labels in the CFTR application.

\n","_postman_id":"e3d0cb5a-9100-4d33-b77a-c2d416bdf4c3"}],"id":"ce6c56d3-31bb-4351-b567-3ca4e876c145","description":"

The Settings section of the Admin Panel enables CFTR admins to manage the fields that are required for providing important information of an incident such as Location, Business Unit, Sources, Labels, Manufacturer, and OS Types.

\n","_postman_id":"ce6c56d3-31bb-4351-b567-3ca4e876c145"},{"name":"User Management","item":[{"name":"Get List of Users","id":"ecbbdf36-53c6-4ba0-9de8-21dc7c3b2ec0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}v1/rest-auth/user/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve a list of all users with details from the CFTR application.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` shows the API endpoint to the next page.
`count`	Integer	Total number of users in CFTR application according to the filters applied.
`results`	List of Objects	Details of the users. Each object provides details of one user.

Response Parameters | Results Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`user_id`	String	Unique ID of the users in UUID-4 format.
`first_name`	String	First name of the user.
`last_name`	String	Last name of the user.
`email`	String	Email ID of the user.
`display_pic`	String	The link to the display picture of the user.
`username`	String	Username of the user.
`profile_background_color`	String	Hex key of the background color of the user profile.
`is_active`	Boolean	Shows whether a user is an active user or not.
`full_name`	String	Full name of the user.

[integer] [Optional] [Default: 1] Enter the page number of the list of users. All users of this page are returned.

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

[integer] [Optional] [Default: 10] Enter the number of records to be retrieved per page.

\n","type":"text/plain"},"key":"page_size","value":"10"},{"disabled":true,"description":{"content":"

[boolean][Optional][Default: None] Enter the status of the users. By default API returns both active and inactive accounts.

\n","type":"text/plain"},"key":"is_active","value":"true"},{"disabled":true,"description":{"content":"

[string][Optional][Default: None] Query string on which API returns the users that contain the string in at least one of their email, first_name, last_name, username, or full_name.

\n","type":"text/plain"},"key":"q","value":"username"},{"disabled":true,"description":{"content":"

[boolean][Optional][Default: None] Specify if the user is a bot user or not. By default API returns both bot and non-bot accounts.

\n","type":"text/plain"},"key":"is_bot","value":"true"},{"disabled":true,"description":{"content":"

[string][Optional][Default: None] Enter the unique ID of User Group of the user in UUID-4 format.

\n","type":"text/plain"},"key":"group_comm_id","value":"f69f0418-8825-476d-9185-af10dd7655aa"}],"variable":[]}},"response":[{"id":"99b56f7d-1d44-4958-b6a3-d950d6e3cb93","name":"Eg: Get records of first 5 active users whose username contains \"johndoe\"","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}","disabled":true}],"url":{"raw":"{{base_url}}v1/rest-auth/user/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&page=1&page_size=5&is_active=true&q=johndoe","host":["{{base_url}}v1"],"path":["rest-auth","user",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"page","value":"1","description":"[integer] [Optional] [Default: 1] Starting page. Actual records returned depends on page and page_size"},{"key":"page_size","value":"5","description":"[integer] [Optional] [Default: 10] Number of records retrieved per page"},{"key":"is_active","value":"true","description":"[boolean][Optional][Default: None] Get users filtered on whether their accounts are active or not. By default API returns both active and inactive accounts."},{"key":"q","value":"johndoe","description":"[string][Optional][Default: None] Query string on which API returns the users who contain the string in atleast one of their email, first_name, last_name, username, or full_name"},{"key":"is_bot","value":"true","description":"[boolean][Optional][Default: None] Get users filtered on whether their accounts is a bot account. By default API returns both bot and non-bot accounts.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Tue, 22 Feb 2022 06:11:44 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"561","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 2,\n \"results\": [\n {\n \"user_id\": \"9c1c92a9-c2e9-42ae-afd2-81c32895aa2a\",\n \"first_name\": \"john\",\n \"last_name\": \"doe\",\n \"email\": \"john.doe@example.com\",\n \"display_pic\": null,\n \"username\": \"johndoe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"john doe\"\n },\n {\n \"user_id\": \"fe493232-e50e-497f-87ed-041a719df5ed\",\n \"first_name\": \"john\",\n \"last_name\": \"doe\",\n \"email\": \"john.doe+1@example.com\",\n \"display_pic\": null,\n \"username\": \"johndoe_1\",\n \"profile_background_color\": \"#A0887E\",\n \"is_active\": true,\n \"full_name\": \"john doe\"\n }\n ],\n \"mapping\": {\n \"dropdown_display_name\": \"readable_id\"\n }\n}"}],"_postman_id":"ecbbdf36-53c6-4ba0-9de8-21dc7c3b2ec0"},{"name":"Get details of one User","id":"24c26f58-ef54-401d-a7d1-e7c59e6fc711","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}v1/rest-auth/user/:user_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the details of a user from your CFTR application.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

Parameter	Type	Description
`user_id`	String	Unique ID of the user in UUID-4 format.
`permission`	List of String	The list of permissions configured for the user in the CFTR application. Note: The permissions depend on the user groups of the user.
`last_login`	String	Last log in date and time of the user in ISO Format.
`first_name`	String	First name of the user.
`last_name`	String	Last name of the user.
`email`	String	Email ID of the user.
`title`	String	Job title of the user.
`display_pic`	String	The link to the display picture of the user.
`groups`	List of String	List of unique IDs of `group_comm_id` of the User Groups in UUID-4 format.
`groups_data`	List of Objects	Details of the User Groups. Each object includes the details of one User Group such as `group_comm_id`, `group_name`, and `description`.
`country_code`	String	Country code of the user.
`contact_number`	String	Contact number of the user.
`username`	String	Username of the user.
`location`	String	Unique ID of the location of the user in UUID-4 format.
`location_data`	Object	Details of the user location.
`allowed_locations`	List of Strings	List of unique IDs of the allowed locations of the user in UUID-4 format.
`allowed_locations_data`	List of Objects	Details of the allowed locations of the user. Each object includes the details of one location. Details include: title, unique_id, and is_active.
`business_unit`	String	Unique ID of the Business Unit of the user in UUID-4 format.
`business_unit_data`	Object	Details of the Business Unit of the user.
`allowed_business_units`	List of Strings	List of unique IDs of the allowed Business Units of the user in UUID-4 format.
`allowed_business_units_data`	List of Objects	Details of the allowed Business Units of the user. Each object includes the details of one Business Unit. Details include: `title`, `description`, unique_id, created,and so on
`is_active`	Boolean	Shows whether the user is an active user or not.
`date_joined`	Datetime	Joining date and time of the user in ISO format.
`is_onboarded`	Boolean	Shows whether the user has activated their account using the confirmation link or not.
`date_onboarded`	String	Onboarding date and time of the user in ISO format.
`is_bot`	Boolean	Shows whether the user is a bot user or not.
`is_admin`	Boolean	Shows whether the user is an admin in the CFTR application or not.
`show_related_incidents`	Boolean	Shows whether the user has access to view related incidents in the Connect The Dots section or not.
`show_related_assets`	Boolean	Shows if the user has access to view the related assets in Connect the Dots or not.
`show_briefings_escalation`	Boolean	Shows if the user has access to view briefings escalations.
`date_onboarded`	String	Date and time of when the user was onboarded.
`landing_component`	String	Unique ID of the landing component configured for the user in UUID-4 format.
`landing_component_data`	Object	Details of the landing component configured for the user.
`allowed_components`	List of Objects	Details of the allowed components of the user. Each object includes the details of one component. Details include: `component_comm_id`, `component_name`, `code_name`, and `component_identifier`.
`last_active`	String	Last active date and time of the user in ISO format.
`last_device`	String	Details of the last device used by the user.
`last_device_ip`	String	Generic IP address of the device last used by the user.
`currency`	String	Currency choice associated with the user. Allowed values: `INR`, `USD`, `GBP`, `EUR`, and`AED`.
`invited_by`	String	Unique ID of the user who invited the current user.
`ldap_id`	String	Unique ID of LDAP associated with the user.
`full_name`	String	Full name of the user.
`password_update_time`	String	Last updated date and time of the password of the user in ISO format.
`analyst_cost`	Float	Maximum value of analyst cost associated with each user group of the user.
`is_system_user`	Boolean	Shows whether the user is a system user or not.
`invite_status`	String	Shows whether the user has accepted the invite or not. Allowed values: - `INVITED`: Invite yet to be accepted. - `ACCEPTED`: Invite accepted.
`is_on_prem_client`	Boolean	Displays if the user is a on prem client.
`is_readonly_user`	Boolean	If the user is has only ready-only access.
`number_of_incidents_per_day`	Integer	The number of incidents that can be created by the user.
`number_of_business_units`	Integer	Number of business units

Note: The permissions of a user depend on the User Groups of the user. If a user is assigned to more than User Groups, then the permissions of all the User Groups apply for the user.

Response Parameters | Location and Allowed Locations Data Objects

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	Title of the location
`unique_id`	String	Unique ID of the location in UUID-4 format.
`is_active`	Boolean	Shows if the location is active or not.

Response Parameters | Business Unit and Allowed Business Units Data Objects

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	Title of the Business Unit.
`description`	Text	Description of the Business Unit.
`unique_id`	String	Unique ID of the Business Unit in UUID-4 format.
`created`	String	Creation date and time of the Business Unit in ISO format.
`modified`	String	Last modified date and time of the Business Unit in ISO format.
`readable_id`	String	Unique readable ID of the Business Unit. It starts with BU followed by a unique number Example: \"BU101\"

Response Parameters | Groups Data Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`group_comm_id`	String	Unique ID of the User Group in UUID-4 format.
`group_name`	String	Name of the User Group.
`description`	Text	Description of the User Group.

Response Parameters | Allowed Components and Landing Component Data Objects

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`component_comm_id`	String	Unique ID of the component in UUID-4 format.
`component_name`	String	Name of the component.
`code_name`	String	Code name of the component.
`component_identifier`	String	Identification string of the component.

Example Error Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Description
500	User with the given unique ID does not exist.

","urlObject":{"path":["rest-auth","user",":user_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the user in UUID-4 format.

\n","type":"text/plain"},"type":"any","value":"9ca5d44c-4f16-410c-ab6b-db26ce6f0b42","key":"user_unique_id"}]}},"response":[{"id":"b8d5d3ea-43e3-4189-993e-841926c9def8","name":"Get details of one User","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}","disabled":true}],"url":{"raw":"{{base_url}}v1/rest-auth/user/:user_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["rest-auth","user",":user_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"user_unique_id","value":"87e5291f-495a-4e52-8777-1e71e3ad1e86","description":"Enter the unique ID of the user in UUID-4 format."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 18 Dec 2023 12:34:46 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: http: data: blob:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"user_id\": \"87e5291f-495a-4e52-8777-1e71e3ad1e86\",\n \"permission\": [\n \"cu_sla\",\n \"cu_generaluser\",\n \"view_threatintel\",\n \"view_label\",\n \"cu_openapi\",\n \"view_license\",\n \"view_formmanagement\",\n \"cu_location\",\n \"cu_roster\",\n \"view_usergroup\",\n \"cu_user\",\n \"cu_enhancement\",\n \"cu_vulnerability\",\n \"cu_campaign\",\n \"view_costing\",\n \"cu_malware\",\n \"view_sla\",\n \"cu_businessunit\",\n \"cu_incident\",\n \"view_threatactor\",\n \"cu_cftr_server_monitor\",\n \"cu_dashboard\",\n \"view_fangdefang\",\n \"cu_threatintel\",\n \"cu_action_library\",\n \"view_dashboard\",\n \"view_cftr_server_monitor\",\n \"view_user_activity_logs\",\n \"view_pause_incident\",\n \"cu_user_activity_logs\",\n \"view_assetsoftware\",\n \"view_backup\",\n \"view_mssp_dashboard\",\n \"cu_pause_incident\",\n \"cu_usergroup\",\n \"view_user\",\n \"cu_formmanagement\",\n \"view_document\",\n \"cu_custom_email_templates\",\n \"cu_request_logs\",\n \"cu_label\",\n \"view_device\",\n \"view_campaign\",\n \"view_request_logs\",\n \"view_vulnerability\",\n \"view_template\",\n \"view_rule_engine\",\n \"cu_costing\",\n \"cu_ostypes\",\n \"cu_template\",\n \"view_ostypes\",\n \"view_malware\",\n \"view_action_library\",\n \"view_generaluser\",\n \"cu_source\",\n \"view_networkutility\",\n \"view_incident\",\n \"view_terminal\",\n \"cu_backup\",\n \"view_playbook\",\n \"cu_playbook\",\n \"cu_assetsoftware\",\n \"cu_application\",\n \"cu_report\",\n \"view_source\",\n \"view_location\",\n \"cu_rule_engine\",\n \"view_action\",\n \"cu_manufacturers\",\n \"view_protected_incident\",\n \"view_roster\",\n \"cu_terminal\",\n \"view_openapi\",\n \"cu_device\",\n \"cu_license\",\n \"view_delete_incident\",\n \"cu_document\",\n \"view_custom_email_templates\",\n \"cu_pir\",\n \"view_pir\",\n \"view_application\",\n \"cu_action\",\n \"view_manufacturers\",\n \"cu_tenant_configuration\",\n \"view_merge_incident\",\n \"cu_delete_incident\",\n \"view_attacknavigator\",\n \"cu_merge_incident\",\n \"view_enhancement\",\n \"view_tenant_configuration\",\n \"view_briefing\",\n \"cu_threatactor\",\n \"cu_briefing\",\n \"view_report\",\n \"view_businessunit\"\n ],\n \"last_login\": null,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@cyware.com\",\n \"title\": null,\n \"organization_unique_id\": null,\n \"display_pic\": null,\n \"organization_data\": null,\n \"groups\": [\n \"469dd0c4-7b76-40d5-9376-78224b83f7bd\",\n \"bb9ec114-24c4-4fa0-a4f9-94af5e73be8d\",\n \"bac18e04-884e-448e-b39b-ebb435e76238\"\n ],\n \"country_code\": \"\",\n \"contact_number\": null,\n \"username\": \"john_d\",\n \"allowed_locations\": [\n \"ca01df6c-eb80-492f-9b8e-25c0d27f0862\",\n \"97d8c8cc-3ad1-4dfb-83b2-e485e021f24e\",\n \"7e2a9f03-94e1-49dc-aa89-ba7e68cfab00\",\n \"4b3640ca-a2b9-44a7-9c46-c90e172a4838\",\n \"6fe72a38-123e-45a8-8cdb-f6d56643f232\",\n \"b4173fa6-f852-481e-b77b-916aa4819ef3\",\n \"e61d6009-5c36-4f2f-93e4-376a264b9fb2\",\n \"6abcac12-81a0-40cc-b51e-2959c8bfa1cd\",\n \"506d2a8a-f506-47a0-afbe-63fb468c55bd\",\n \"b88b7228-09bf-4c00-b641-88f8bec1c05b\",\n \"01de9b05-cae9-4313-975b-177ff7e0dd19\",\n \"590905f4-9924-41f6-a9d3-c56c0c71e493\",\n \"45c017a3-4c7e-47e9-902a-55156371f086\"\n ],\n \"allowed_locations_data\": [\n {\n \"title\": \"India\",\n \"unique_id\": \"ca01df6c-eb80-492f-9b8e-25c0d27f0862\",\n \"is_active\": true\n },\n {\n \"title\": \"New Delhi\",\n \"unique_id\": \"97d8c8cc-3ad1-4dfb-83b2-e485e021f24e\",\n \"is_active\": true\n },\n {\n \"title\": \"New York\",\n \"unique_id\": \"7e2a9f03-94e1-49dc-aa89-ba7e68cfab00\",\n \"is_active\": true\n },\n {\n \"title\": \"Singapore\",\n \"unique_id\": \"4b3640ca-a2b9-44a7-9c46-c90e172a4838\",\n \"is_active\": true\n },\n ],\n \"allowed_business_units\": [\n \"c81c9c5e-2569-47b0-8af4-5900e375c77d\",\n \"02335ead-3078-4322-8fce-38c58940bd5a\"\n ],\n \"allowed_business_units_data\": [\n {\n \"title\": \"System\",\n \"description\": null,\n \"unique_id\": \"02335ead-3078-4322-8fce-38c58940bd5a\",\n \"created\": \"2023-12-06T22:30:29.563082Z\",\n \"modified\": \"2023-12-06T22:30:29.563082Z\",\n \"readable_id\": \"BU103\",\n \"email_list\": null\n }\n ],\n \"allowed_entities\": [\n \"4989d89d-fde4-4f9d-b35b-038c5058976e\"\n ],\n \"allowed_entities_data\": [],\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"date_joined\": \"2023-12-07T05:17:39.380311Z\",\n \"user_theme\": \"skin-2\",\n \"business_unit_data\": null,\n \"location_data\": null,\n \"is_onboarded\": false,\n \"is_bot\": false,\n \"default_dashboard\": \"013b642d-998e-4468-8082-6bd38dcd9c8f\",\n \"business_unit\": null,\n \"location\": null,\n \"groups_data\": [\n {\n \"group_comm_id\": \"469dd0c4-7b76-40d5-9376-78224b83f7bd\",\n \"group_name\": \"CFTR Admin\",\n \"description\": null\n },\n {\n \"group_comm_id\": \"bb9ec114-24c4-4fa0-a4f9-94af5e73be8d\",\n \"group_name\": \"Soc Analyst\",\n \"description\": null\n },\n {\n \"group_comm_id\": \"bac18e04-884e-448e-b39b-ebb435e76238\",\n \"group_name\": \"SOC Manager\",\n \"description\": null\n }\n ],\n \"is_admin\": true,\n \"login_mode\": null,\n \"show_related_assets\": true,\n \"show_briefings_escalation\": false,\n \"date_onboarded\": \"2023-12-08T06:20:33.022035Z\",\n \"landing_component\": null,\n \"landing_component_data\": null,\n \"allowed_components\": [\n {\n \"component_comm_id\": \"Enhancement\",\n \"component_name\": \"Cost Tracking\",\n \"code_name\": \"costing\",\n \"component_identifier\": \"costing\"\n },\n {\n \"component_comm_id\": \"68c84dc8-7d8e-4eb3-8104-f990883e9d33\",\n \"component_name\": \"Actions\",\n \"code_name\": \"action\",\n \"component_identifier\": \"action\"\n },\n {\n \"component_comm_id\": \"68c84dc8-7d8e-4eb3-8104-f990883e9d33\",\n \"component_name\": \"Actions\",\n \"code_name\": \"action\",\n \"component_identifier\": \"action\"\n },\n {\n \"component_comm_id\": \"26c0e2bd-d95f-469b-9edb-0696f03e7e93\",\n \"component_name\": \"Applications\",\n \"code_name\": \"application\",\n \"component_identifier\": \"application\"\n },\n {\n \"component_comm_id\": \"26c0e2bd-d95f-469b-9edb-0696f03e7e93\",\n \"component_name\": \"Applications\",\n \"code_name\": \"application\",\n \"component_identifier\": \"application\"\n },\n {\n \"component_comm_id\": \"fb9dcac0-d379-4cbd-9d75-530b35ce4d56\",\n \"component_name\": \"Software\",\n \"code_name\": \"assetsoftware\",\n \"component_identifier\": \"asset-software\"\n },\n {\n \"component_comm_id\": \"fb9dcac0-d379-4cbd-9d75-530b35ce4d56\",\n \"component_name\": \"Software\",\n \"code_name\": \"assetsoftware\",\n \"component_identifier\": \"asset-software\"\n },\n {\n \"component_comm_id\": \"5fc6a5dd-7f57-460f-a60f-c0b3f9dcc254\",\n \"component_name\": \"Business Units\",\n \"code_name\": \"businessunit\",\n \"component_identifier\": \"business-unit\"\n },\n {\n \"component_comm_id\": \"5fc6a5dd-7f57-460f-a60f-c0b3f9dcc254\",\n \"component_name\": \"Business Units\",\n \"code_name\": \"businessunit\",\n \"component_identifier\": \"business-unit\"\n },\n {\n \"component_comm_id\": \"ca0c94aa-49a1-42a2-afe5-4a70f62996c8\",\n \"component_name\": \"Campaigns\",\n \"code_name\": \"campaign\",\n \"component_identifier\": \"campaign\"\n },\n {\n \"component_comm_id\": \"ca0c94aa-49a1-42a2-afe5-4a70f62996c8\",\n \"component_name\": \"Campaigns\",\n \"code_name\": \"campaign\",\n \"component_identifier\": \"campaign\"\n },\n {\n \"component_comm_id\": \"35994155-f479-4bf3-b4b4-c87efee4eb3b\",\n \"component_name\": \"Dashboards\",\n \"code_name\": \"dashboard\",\n \"component_identifier\": \"dashboard\"\n },\n {\n \"component_comm_id\": \"35994155-f479-4bf3-b4b4-c87efee4eb3b\",\n \"component_name\": \"Dashboards\",\n \"code_name\": \"dashboard\",\n \"component_identifier\": \"dashboard\"\n },\n {\n \"component_comm_id\": \"a58961f5-876d-4513-a005-41a5856ecf9c\",\n \"component_name\": \"Devices\",\n \"code_name\": \"device\",\n \"component_identifier\": \"device\"\n },\n {\n \"component_comm_id\": \"a58961f5-876d-4513-a005-41a5856ecf9c\",\n \"component_name\": \"Devices\",\n \"code_name\": \"device\",\n \"component_identifier\": \"device\"\n },\n {\n \"component_comm_id\": \"b28207c4-efa0-4d23-9ba2-d17bf83aa196\",\n \"component_name\": \"Enhancements\",\n \"code_name\": \"enhancement\",\n \"component_identifier\": \"enhancement\"\n },\n {\n \"component_comm_id\": \"b28207c4-efa0-4d23-9ba2-d17bf83aa196\",\n \"component_name\": \"Enhancements\",\n \"code_name\": \"enhancement\",\n \"component_identifier\": \"enhancement\"\n },\n {\n \"component_comm_id\": \"a9b2cd73-9e57-4a83-a47c-16555071d7d4\",\n \"component_name\": \"Fang-Defang\",\n \"code_name\": \"fangdefang\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"ae4f027f-c90f-49f3-9272-bee9452c797d\",\n \"component_name\": \"MSSP Dashboard\",\n \"code_name\": \"mssp_dashboard\",\n \"component_identifier\": \"\"\n }\n ],\n \"last_active\": \"2023-12-18T10:05:31.897609Z\",\n \"last_device\": \"MacOS Macintosh X 10.15.7\",\n \"last_device_ip\": \"3.7.118.226\",\n \"currency\": \"USD\",\n \"show_related_incidents\": \"True\",\n \"invited_by\": \"224b2a70-28fd-4984-9338-d9d0535aeaad\",\n \"ldap_id\": null,\n \"display_pic_datauri\": null,\n \"full_name\": \"John Joe\",\n \"password_update_time\": \"2023-12-08T06:20:12.030528Z\",\n \"analyst_cost\": 10.0,\n \"is_system_user\": false,\n \"invite_status\": \"ACCEPTED\",\n \"user_preferred_timezone\": null,\n \"user_preferred_date_format\": \"Mth d, yyyy\",\n \"user_preferred_time_format\": \"24\",\n \"telemetry_token\": \"d27ac78cea2272c517cf8210bad5dba1\",\n \"user_preferred_date_ui_format\": \"MMM D, YYYY\",\n \"browser_timezone\": \"Asia/Calcutta\",\n \"is_browser_timezone\": true,\n \"user_timezone\": null,\n \"user_date_format\": \"Mth d, yyyy\",\n \"user_time_format\": \"24\",\n \"is_browser_tz\": true,\n \"google_maps_api_key\": null,\n \"user_preferred_date_format_picker\": \"MMM d yyyy\",\n \"is_readonly_user\": false,\n \"number_of_incidents_per_day\": 100,\n \"number_of_business_units\": 5,\n \"is_on_prem_client\": false\n}"}],"_postman_id":"24c26f58-ef54-401d-a7d1-e7c59e6fc711"},{"name":"Create User","id":"4b812159-30cb-4e5a-9701-dc49b4079cdd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"country_code\": \"91\",\n \"contact_number\": \"2134533323\",\n \"first_name\": \"john\",\n \"last_name\": \"doe\",\n \"username\": \"johndoe\",\n \"password\": \"Abc@123\"\n \"email\": \"john.doe@example.com\",\n \"title\": \"Backend Developer\",\n \"groups\": [\n \"469dd0c4-7b76-40d5-9376-78224b83f7bd\"\n ],\n \"business_unit\": \"2d294ba9-4092-491b-b559-330def14a9f3\",\n \"is_bot\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/rest-auth/user/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Add a new user in your CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
`country_code`	String	Optional	Enter international dialing code of the country of the user.
`contact_number`	String	Optional	Enter the contact number of the user.
`first_name`	String	Mandatory	Enter the first name of the user.
`last_name`	String	Mandatory	Enter the last name of the user.
`username`	String	Mandatory	Enter username for the user.
`email`	String	Mandatory	Enter the email ID of the user.
`title`	String	Optional	Enter job title of the user.
`groups`	List of Strings	Mandatory	Enter the `group_comm_id` of the user groups to assign the user.
`location`	String	Optional	Enter the unique ID of the user location in UUID-4 format.
`business_unit`	String	Optional	Enter the unique ID of the Business Unit of the user in UUID-4 format.
`allowed_locations`	List of Strings	Optional	Enter the list of unique IDs of the allowed locations of the user in UUID-4 format.
`allowed_business_unit`	List of Strings	Optional	Enter the list of unique IDs of the allowed Business Units of the user in UUID-4 format.
`is_bot`	Boolean	Optional	Enter whether the user is a bot user or not.

Response Parameters

Parameter	Type	Description
`user_id`	String	Unique ID of the user in UUID-4 format.
`permission`	List of String	The list of permissions configured for the user in the CFTR application. Note: The permissions depend on the User Groups of the user.
`last_login`	String	Last log in date and time of the user in ISO Format.
`first_name`	String	First name of the user.
`last_name`	String	Last name of the user.
`email`	String	Email ID of the user.
`title`	String	Job title of the user.
`display_pic`	String	The link to the display picture of the user.
`groups`	List of String	List of unique IDs of `group_comm_id` of the user groups in UUID-4 format.
`groups_data`	List of Objects	Details of the user groups. Each object includes the details of one user group.
`country_code`	String	Country code of the user.
`contact_number`	String	Contact number of the user.
`username`	String	Username of the user.
`location`	String	Unique ID of the location of the user in UUID-4 format.
`location_data`	Object	Details of the user location.
`allowed_locations`	List of Strings	List of unique IDs of the allowed locations of the user in UUID-4 format.
`allowed_locations_data`	List of Objects	Details of the allowed locations of the user. Each object includes the details of one location.
`business_unit`	String	Unique ID of the Business Unit of the user in UUID-4 format.
`business_unit_data`	Object	Details of the Business Unit of the user.
`allowed_business_units`	List of Strings	List of unique IDs of the allowed business units of the user in UUID-4 format.
`allowed_business_units_data`	List of Objects	Details of the allowed business units of the user. Each object includes the details of one business unit.
`is_active`	Boolean	Shows whether the user is an active user or not.
`date_joined`	String	Joining date and time of the user in ISO format.
`is_onboarded`	Boolean	Shows whether the user has activated their account using the confirmation link or not.
`date_onboarded`	String	Onboarding date and time of the user in ISO format.
`is_bot`	Boolean	Shows whether the user is a bot user or not.
`is_admin`	Boolean	Shows whether the user is a CFTR admin or not.
`show_related_incidents`	Boolean	Shows whether the user has access to view related incidents in the Connect The Dots section or not.
`landing_component`	String	Unique ID of the landing component configured for the user in UUID-4 format.
`landing_component_data`	Object	Details of the landing component configured for the user.
`allowed_components`	List of Objects	Details of the allowed components of the user. Each object includes the details of one component.
`last_active`	String	Last active date and time of the user in ISO format.
`last_device`	String	Details of the last device used by the user.
`last_device_ip`	String	Generic IP address of the device last used by the user.
`currency`	String	Currency choice associated with the user. Allowed values: `INR`, `USD`, `GBP`, `EUR`, and`AED`.
`invited_by`	String	Unique ID of the user who invited the current user.
`ldap_id`	String	Unique ID of LDAP associated with the user.
`full_name`	String	Full name of the user.
`password_update_time`	String	Last updated date and time of the password of the user in ISO format.
`analyst_cost`	Float	Maximum value of analyst cost associated with each user group of the user.
`is_system_user`	Boolean	Shows whether the user is a system user or not.
`invite_status`	String	Shows whether the user has accepted the invite or not. Allowed values: - `INVITED`: Invite yet to be accepted. - `ACCEPTED`: Invite accepted.

Note: The permissions of a user depend on the User Groups of the user. If a user is assigned to more than User Groups, then the permissions of all the User Groups apply for the user.

Response Parameters | Location and Allowed Locations Data Objects

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	Title of the location
`unique_id`	String	Unique ID of the location in UUID-4 format.
`created`	String	Creation date and time of the location in ISO format.
`modified`	String	Last modified date and time of the location in ISO format.

Response Parameters | Business Unit and Allowed Business Units Data Objects

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	Title of the Business Unit.
`description`	Text	Description of the Business Unit.
`unique_id`	String	Unique ID of the Business Unit in UUID-4 format.
`created`	String	Creation date and time of the Business Unit in ISO format.
`modified`	String	Last modified date and time of the Business Unit in ISO format.
`readable_id`	String	Unique readable ID of the Business Unit. It starts with BU followed by a unique number Example: \"BU101\"

Response Parameters | Groups Data Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`group_comm_id`	String	Unique ID of the user group in UUID-4 format.
`group_name`	String	Name of the user group.
`description`	Text	Description of the user group.

Response Parameters | Allowed Components and Landing Component Data Objects

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`component_comm_id`	String	Unique ID of the component in UUID-4 format.
`component_name`	String	Name of the component.
`code_name`	String	Code name of the component.
`component_identifier`	String	Identification string of the component.

Example Error Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Description
400	Username should be unique. Email should be valid and unique. Username should only be lowercase alphabets, numbers, periods, and underscore (length between 3 and 15). Country code should be valid.

","urlObject":{"path":["rest-auth","user",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"476818a6-5398-4a1e-8556-7b2b17cff5c4","name":"Eg: Create a new User","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"country_code\": 91,\n \"contact_number\": 2134533323,\n \"first_name\": \"john\",\n \"last_name\": \"doe\",\n \"username\": \"johndoe_1\",\n \"email\": \"john.doe+1@example.com\",\n \"title\": \"Backend Developer\",\n \"groups\": [\n \"b7fccb8d-07da-45bd-b08f-5cbb94f4fd3e\"\n ],\n \"location\": \"88162aea-c7c8-48f2-b1cf-08b4eb5c35ab\",\n \"business_unit\": \"f0a81f30-a72a-4c9a-b901-cc15475c4e02\",\n \"allowed_locations\": [\n \"88162aea-c7c8-48f2-b1cf-08b4eb5c35ab\"\n ],\n \"allowed_business_units\": [\n \"f0a81f30-a72a-4c9a-b901-cc15475c4e02\"\n ],\n \"is_bot\": true\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/rest-auth/user/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["rest-auth","user",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Sun, 20 Feb 2022 16:44:48 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"17759","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"user_id\": \"fe493232-e50e-497f-87ed-041a719df5ed\",\n \"permission\": [\n \"cu_pir\",\n \"view_sla\",\n \"cu_dashboard\",\n \"view_document\",\n \"cu_enhancement\",\n \"cu_threatactor\",\n \"cu_pause_incident\",\n \"view_networkutility\",\n \"cu_sla\",\n \"cu_manufacturers\",\n \"cu_tenant_configuration\",\n \"cu_formmanagement\",\n \"cu_briefing\",\n \"cu_device\",\n \"view_roster\",\n \"view_cftr_server_monitor\",\n \"view_user\",\n \"view_costing\",\n \"cu_template\",\n \"view_manage_tenant\",\n \"view_label\",\n \"view_device\",\n \"view_source\",\n \"cu_report\",\n \"view_openapi\",\n \"cu_delete_incident\",\n \"view_briefing\",\n \"view_incident\",\n \"cu_generaluser\",\n \"view_generaluser\",\n \"view_pause_incident\",\n \"view_terminal\",\n \"view_threatintel\",\n \"view_pir\",\n \"view_malware\",\n \"cu_ostypes\",\n \"cu_backup\",\n \"cu_custom_email_templates\",\n \"cu_threatintel\",\n \"view_template\",\n \"view_backup\",\n \"view_businessunit\",\n \"view_user_activity_logs\",\n \"view_usergroup\",\n \"cu_playbook\",\n \"cu_user_activity_logs\",\n \"cu_campaign\",\n \"cu_usergroup\",\n \"view_dashboard\",\n \"view_license\",\n \"cu_businessunit\",\n \"view_delete_incident\",\n \"view_assetsoftware\",\n \"view_protected_incident\",\n \"cu_terminal\",\n \"view_report\",\n \"cu_incident\",\n \"view_playbook\",\n \"cu_costing\",\n \"view_attacknavigator\",\n \"cu_application\",\n \"cu_manage_tenant\",\n \"view_fangdefang\",\n \"cu_malware\",\n \"view_formmanagement\",\n \"view_custom_email_templates\",\n \"view_application\",\n \"view_location\",\n \"view_request_logs\",\n \"view_ostypes\",\n \"view_campaign\",\n \"view_enhancement\",\n \"view_vulnerability\",\n \"cu_merge_incident\",\n \"cu_document\",\n \"cu_request_logs\",\n \"view_tenant_configuration\",\n \"view_action\",\n \"view_merge_incident\",\n \"cu_assetsoftware\",\n \"cu_source\",\n \"cu_roster\",\n \"cu_openapi\",\n \"view_threatactor\",\n \"cu_location\",\n \"cu_vulnerability\",\n \"cu_action\",\n \"cu_user\",\n \"cu_label\",\n \"cu_license\",\n \"view_manufacturers\"\n ],\n \"last_login\": null,\n \"first_name\": \"john\",\n \"last_name\": \"doe\",\n \"email\": \"john.doe+1@example.com\",\n \"title\": \"Backend Developer\",\n \"organization_unique_id\": null,\n \"display_pic\": null,\n \"organization_data\": null,\n \"groups\": [\n \"b7fccb8d-07da-45bd-b08f-5cbb94f4fd3e\"\n ],\n \"country_code\": \"91\",\n \"contact_number\": \"2134533323\",\n \"username\": \"johndoe_1\",\n \"allowed_locations\": [\n \"973198d5-d223-489b-96bc-5511164d7545\",\n \"88162aea-c7c8-48f2-b1cf-08b4eb5c35ab\"\n ],\n \"allowed_locations_data\": [\n {\n \"title\": \"System\",\n \"unique_id\": \"88162aea-c7c8-48f2-b1cf-08b4eb5c35ab\",\n \"created\": \"2022-01-24T09:28:16.757486Z\",\n \"modified\": \"2022-01-24T09:28:16.757486Z\"\n }\n ],\n \"allowed_business_units\": [\n \"9a34e80d-6cda-4e9f-8eb9-e4bfd9ced52a\",\n \"f0a81f30-a72a-4c9a-b901-cc15475c4e02\"\n ],\n \"allowed_business_units_data\": [\n {\n \"title\": \"System\",\n \"description\": null,\n \"unique_id\": \"f0a81f30-a72a-4c9a-b901-cc15475c4e02\",\n \"created\": \"2022-01-24T09:28:16.737284Z\",\n \"modified\": \"2022-01-24T09:28:16.737284Z\",\n \"readable_id\": \"BU102\"\n }\n ],\n \"allowed_entities\": [\n \"977d7893-4b7c-4b55-a16c-64bf74582d7a\"\n ],\n \"allowed_entities_data\": [],\n \"profile_background_color\": \"#A0887E\",\n \"is_active\": true,\n \"date_joined\": \"2022-02-20T16:44:31.485953Z\",\n \"user_theme\": \"skin-2\",\n \"business_unit_data\": {\n \"title\": \"System\",\n \"description\": null,\n \"unique_id\": \"f0a81f30-a72a-4c9a-b901-cc15475c4e02\",\n \"created\": \"2022-01-24T09:28:16.737284Z\",\n \"modified\": \"2022-01-24T09:28:16.737284Z\",\n \"readable_id\": \"BU102\"\n },\n \"location_data\": {\n \"title\": \"System\",\n \"unique_id\": \"88162aea-c7c8-48f2-b1cf-08b4eb5c35ab\",\n \"created\": \"2022-01-24T09:28:16.757486Z\",\n \"modified\": \"2022-01-24T09:28:16.757486Z\"\n },\n \"is_onboarded\": false,\n \"is_bot\": true,\n \"default_dashboard\": \"26c964a8-4b59-403b-a547-e090bde502d8\",\n \"business_unit\": \"f0a81f30-a72a-4c9a-b901-cc15475c4e02\",\n \"location\": \"88162aea-c7c8-48f2-b1cf-08b4eb5c35ab\",\n \"groups_data\": [\n {\n \"group_comm_id\": \"b7fccb8d-07da-45bd-b08f-5cbb94f4fd3e\",\n \"group_name\": \"CFTR Admin\",\n \"description\": null\n }\n ],\n \"is_admin\": true,\n \"login_mode\": null,\n \"show_related_assets\": true,\n \"show_briefings_escalation\": false,\n \"date_onboarded\": null,\n \"landing_component\": null,\n \"landing_component_data\": null,\n \"allowed_components\": [\n {\n \"component_comm_id\": \"d9003084-078b-4f84-835c-ea1e92c35c2d\",\n \"component_name\": \"Labels\",\n \"code_name\": \"label\",\n \"component_identifier\": \"label\"\n },\n {\n \"component_comm_id\": \"a29d2ad9-c808-40c6-ba2a-0ed77627d92a\",\n \"component_name\": \"Actions\",\n \"code_name\": \"action\",\n \"component_identifier\": \"action\"\n },\n {\n \"component_comm_id\": \"f063260e-5536-41d8-8c92-1c795c6edb0d\",\n \"component_name\": \"Threat Briefings\",\n \"code_name\": \"briefing\",\n \"component_identifier\": \"threat-briefing\"\n },\n {\n \"component_comm_id\": \"08af4f86-f603-422a-acd4-fd175ab3465c\",\n \"component_name\": \"Tenant Management\",\n \"code_name\": \"manage_tenant\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"53641327-7022-4007-a9ce-10963b697298\",\n \"component_name\": \"Terminal\",\n \"code_name\": \"terminal\",\n \"component_identifier\": \"terminal\"\n },\n {\n \"component_comm_id\": \"8141a27a-d725-4baf-803e-7c0940171298\",\n \"component_name\": \"User Group Management\",\n \"code_name\": \"usergroup\",\n \"component_identifier\": \"user-group\"\n },\n {\n \"component_comm_id\": \"53641327-7022-4007-a9ce-10963b697298\",\n \"component_name\": \"Terminal\",\n \"code_name\": \"terminal\",\n \"component_identifier\": \"terminal\"\n },\n {\n \"component_comm_id\": \"826661b1-9be4-49fc-b3fe-782f0bb5b507\",\n \"component_name\": \"Devices\",\n \"code_name\": \"device\",\n \"component_identifier\": \"device\"\n },\n {\n \"component_comm_id\": \"e98db60b-a1a4-49d6-8f14-3944040b1853\",\n \"component_name\": \"Software\",\n \"code_name\": \"assetsoftware\",\n \"component_identifier\": \"asset-software\"\n },\n {\n \"component_comm_id\": \"ee0fced1-48fc-441b-9316-bc43b984ffff\",\n \"component_name\": \"Merge Incidents\",\n \"code_name\": \"merge_incident\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"08af4f86-f603-422a-acd4-fd175ab3465c\",\n \"component_name\": \"Tenant Management\",\n \"code_name\": \"manage_tenant\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"7e485ba0-7736-456b-92e6-6c85a8248f84\",\n \"component_name\": \"Incidents\",\n \"code_name\": \"incident\",\n \"component_identifier\": \"incident\"\n },\n {\n \"component_comm_id\": \"19c1534f-60be-4755-9e41-62d401cbdde4\",\n \"component_name\": \"Malware\",\n \"code_name\": \"malware\",\n \"component_identifier\": \"malware\"\n },\n {\n \"component_comm_id\": \"f8a41b07-7db3-4ca5-b35c-29011320efa1\",\n \"component_name\": \"ATT&CK Navigator\",\n \"code_name\": \"attacknavigator\",\n \"component_identifier\": \"attack-navigator\"\n },\n {\n \"component_comm_id\": \"13da5e0d-8f63-4a03-af66-5598ab813942\",\n \"component_name\": \"Threat Intel\",\n \"code_name\": \"threatintel\",\n \"component_identifier\": \"ioc\"\n },\n {\n \"component_comm_id\": \"d9003084-078b-4f84-835c-ea1e92c35c2d\",\n \"component_name\": \"Labels\",\n \"code_name\": \"label\",\n \"component_identifier\": \"label\"\n },\n {\n \"component_comm_id\": \"b3da5259-816c-4dcb-830e-e4147722ea19\",\n \"component_name\": \"Template Management\",\n \"code_name\": \"template\",\n \"component_identifier\": \"template\"\n },\n {\n \"component_comm_id\": \"8e3e1dde-92b4-4183-8ca3-3155e2428782\",\n \"component_name\": \"Version and License\",\n \"code_name\": \"license\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"56be76a0-3c88-4a43-8f8d-d51bb8eb822c\",\n \"component_name\": \"Manufacturers\",\n \"code_name\": \"manufacturers\",\n \"component_identifier\": \"manufacturers\"\n },\n {\n \"component_comm_id\": \"8e3e1dde-92b4-4183-8ca3-3155e2428782\",\n \"component_name\": \"Version and License\",\n \"code_name\": \"license\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"139a6f8a-40a3-4960-904e-31f4ddb8a344\",\n \"component_name\": \"Email Customization\",\n \"code_name\": \"custom_email_templates\",\n \"component_identifier\": \"custom_email_templates\"\n },\n {\n \"component_comm_id\": \"d4ebf715-b68e-4c77-bb69-b28fe48f9419\",\n \"component_name\": \"OpenAPI\",\n \"code_name\": \"openapi\",\n \"component_identifier\": \"openapi\"\n },\n {\n \"component_comm_id\": \"5830b4a8-7a24-43d0-b552-0c2bdffb3b13\",\n \"component_name\": \"Locations\",\n \"code_name\": \"location\",\n \"component_identifier\": \"location\"\n },\n {\n \"component_comm_id\": \"f54a6ffe-c25d-4b4c-b144-d3d982c46a05\",\n \"component_name\": \"Configurations\",\n \"code_name\": \"tenant_configuration\",\n \"component_identifier\": \"configuration\"\n },\n {\n \"component_comm_id\": \"d18468ff-a1bd-4d7f-b213-7644d3d99bca\",\n \"component_name\": \"User Management\",\n \"code_name\": \"user\",\n \"component_identifier\": \"ciims-user\"\n },\n {\n \"component_comm_id\": \"f063260e-5536-41d8-8c92-1c795c6edb0d\",\n \"component_name\": \"Threat Briefings\",\n \"code_name\": \"briefing\",\n \"component_identifier\": \"threat-briefing\"\n },\n {\n \"component_comm_id\": \"cd6ce02b-3d25-4a96-a27c-7a77affe669f\",\n \"component_name\": \"PIRs\",\n \"code_name\": \"pir\",\n \"component_identifier\": \"pir\"\n },\n {\n \"component_comm_id\": \"8141a27a-d725-4baf-803e-7c0940171298\",\n \"component_name\": \"User Group Management\",\n \"code_name\": \"usergroup\",\n \"component_identifier\": \"user-group\"\n },\n {\n \"component_comm_id\": \"3a9b99c6-4b00-47fb-b9b1-64e33066e933\",\n \"component_name\": \"OS Types\",\n \"code_name\": \"ostypes\",\n \"component_identifier\": \"ostype\"\n },\n {\n \"component_comm_id\": \"ee89e3bc-a594-4d4b-90b5-a80d4d7a9147\",\n \"component_name\": \"Reports\",\n \"code_name\": \"report\",\n \"component_identifier\": \"report\"\n },\n {\n \"component_comm_id\": \"389dc557-4e85-43e4-866d-676d7a33de2a\",\n \"component_name\": \"Form Management\",\n \"code_name\": \"formmanagement\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"f54a6ffe-c25d-4b4c-b144-d3d982c46a05\",\n \"component_name\": \"Configurations\",\n \"code_name\": \"tenant_configuration\",\n \"component_identifier\": \"configuration\"\n },\n {\n \"component_comm_id\": \"9819c575-05b6-4652-be17-560a7b4ea867\",\n \"component_name\": \"Pause Incident\",\n \"code_name\": \"pause_incident\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"d4ebf715-b68e-4c77-bb69-b28fe48f9419\",\n \"component_name\": \"OpenAPI\",\n \"code_name\": \"openapi\",\n \"component_identifier\": \"openapi\"\n },\n {\n \"component_comm_id\": \"cd6ce02b-3d25-4a96-a27c-7a77affe669f\",\n \"component_name\": \"PIRs\",\n \"code_name\": \"pir\",\n \"component_identifier\": \"pir\"\n },\n {\n \"component_comm_id\": \"2b697c91-2908-4154-8341-080a83ed5a31\",\n \"component_name\": \"Backups\",\n \"code_name\": \"backup\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"f03865cf-b137-4df6-b07f-49d6f0d46ad6\",\n \"component_name\": \"Users\",\n \"code_name\": \"generaluser\",\n \"component_identifier\": \"general-user\"\n },\n {\n \"component_comm_id\": \"b3da5259-816c-4dcb-830e-e4147722ea19\",\n \"component_name\": \"Template Management\",\n \"code_name\": \"template\",\n \"component_identifier\": \"template\"\n },\n {\n \"component_comm_id\": \"0613996b-ec2b-405b-9f6b-c39cb46c41a0\",\n \"component_name\": \"Knowledge Base\",\n \"code_name\": \"document\",\n \"component_identifier\": \"knowledge-base\"\n },\n {\n \"component_comm_id\": \"51917486-6f94-4524-82e0-aba2f2b50314\",\n \"component_name\": \"SLA\",\n \"code_name\": \"sla\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"f1c6293f-97f3-4ce0-8e68-c0691c4e6ea4\",\n \"component_name\": \"Applications\",\n \"code_name\": \"application\",\n \"component_identifier\": \"application\"\n },\n {\n \"component_comm_id\": \"3a9b99c6-4b00-47fb-b9b1-64e33066e933\",\n \"component_name\": \"OS Types\",\n \"code_name\": \"ostypes\",\n \"component_identifier\": \"ostype\"\n },\n {\n \"component_comm_id\": \"e98db60b-a1a4-49d6-8f14-3944040b1853\",\n \"component_name\": \"Software\",\n \"code_name\": \"assetsoftware\",\n \"component_identifier\": \"asset-software\"\n },\n {\n \"component_comm_id\": \"82661c76-07f7-46d3-99d9-842fef411322\",\n \"component_name\": \"Sources\",\n \"code_name\": \"source\",\n \"component_identifier\": \"source\"\n },\n {\n \"component_comm_id\": \"0d3f0316-c2dd-4a37-a7c9-65f2b27c4a7a\",\n \"component_name\": \"Dashboards\",\n \"code_name\": \"dashboard\",\n \"component_identifier\": \"dashboard\"\n },\n {\n \"component_comm_id\": \"9819c575-05b6-4652-be17-560a7b4ea867\",\n \"component_name\": \"Pause Incident\",\n \"code_name\": \"pause_incident\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"826661b1-9be4-49fc-b3fe-782f0bb5b507\",\n \"component_name\": \"Devices\",\n \"code_name\": \"device\",\n \"component_identifier\": \"device\"\n },\n {\n \"component_comm_id\": \"04bbf712-64d0-4f2e-97cf-f8d054efdcb4\",\n \"component_name\": \"Delete Untriaged Incidents\",\n \"code_name\": \"delete_incident\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"f03865cf-b137-4df6-b07f-49d6f0d46ad6\",\n \"component_name\": \"Users\",\n \"code_name\": \"generaluser\",\n \"component_identifier\": \"general-user\"\n },\n {\n \"component_comm_id\": \"e8f776d0-9ebd-496c-b051-3e5743fb50a7\",\n \"component_name\": \"Activity Logs\",\n \"code_name\": \"user_activity_logs\",\n \"component_identifier\": \"user_activity_logs\"\n },\n {\n \"component_comm_id\": \"f1c6293f-97f3-4ce0-8e68-c0691c4e6ea4\",\n \"component_name\": \"Applications\",\n \"code_name\": \"application\",\n \"component_identifier\": \"application\"\n },\n {\n \"component_comm_id\": \"ee89e3bc-a594-4d4b-90b5-a80d4d7a9147\",\n \"component_name\": \"Reports\",\n \"code_name\": \"report\",\n \"component_identifier\": \"report\"\n },\n {\n \"component_comm_id\": \"9ed8c26e-7ad4-4caa-b1ce-efc1993a81ef\",\n \"component_name\": \"API Request Logs\",\n \"code_name\": \"request_logs\",\n \"component_identifier\": \"request_logs\"\n },\n {\n \"component_comm_id\": \"2b697c91-2908-4154-8341-080a83ed5a31\",\n \"component_name\": \"Backups\",\n \"code_name\": \"backup\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"82661c76-07f7-46d3-99d9-842fef411322\",\n \"component_name\": \"Sources\",\n \"code_name\": \"source\",\n \"component_identifier\": \"source\"\n },\n {\n \"component_comm_id\": \"e81caf49-a0d6-4c40-85ed-338925d330f1\",\n \"component_name\": \"Network Utility\",\n \"code_name\": \"networkutility\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"389dc557-4e85-43e4-866d-676d7a33de2a\",\n \"component_name\": \"Form Management\",\n \"code_name\": \"formmanagement\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"13da5e0d-8f63-4a03-af66-5598ab813942\",\n \"component_name\": \"Threat Intel\",\n \"code_name\": \"threatintel\",\n \"component_identifier\": \"ioc\"\n },\n {\n \"component_comm_id\": \"0d3f0316-c2dd-4a37-a7c9-65f2b27c4a7a\",\n \"component_name\": \"Dashboards\",\n \"code_name\": \"dashboard\",\n \"component_identifier\": \"dashboard\"\n },\n {\n \"component_comm_id\": \"337150ef-3fa0-4f8a-9bfc-42f31433267b\",\n \"component_name\": \"Fang-Defang\",\n \"code_name\": \"fangdefang\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"0acd03ae-5481-4515-925d-d561dd9eab07\",\n \"component_name\": \"Threat Actors\",\n \"code_name\": \"threatactor\",\n \"component_identifier\": \"threat-actor\"\n },\n {\n \"component_comm_id\": \"ee0fced1-48fc-441b-9316-bc43b984ffff\",\n \"component_name\": \"Merge Incidents\",\n \"code_name\": \"merge_incident\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"18cec9b1-c90c-4bc5-b858-1411bc66e451\",\n \"component_name\": \"Campaigns\",\n \"code_name\": \"campaign\",\n \"component_identifier\": \"campaign\"\n },\n {\n \"component_comm_id\": \"5830b4a8-7a24-43d0-b552-0c2bdffb3b13\",\n \"component_name\": \"Locations\",\n \"code_name\": \"location\",\n \"component_identifier\": \"location\"\n },\n {\n \"component_comm_id\": \"9ed8c26e-7ad4-4caa-b1ce-efc1993a81ef\",\n \"component_name\": \"API Request Logs\",\n \"code_name\": \"request_logs\",\n \"component_identifier\": \"request_logs\"\n },\n {\n \"component_comm_id\": \"7e485ba0-7736-456b-92e6-6c85a8248f84\",\n \"component_name\": \"Incidents\",\n \"code_name\": \"incident\",\n \"component_identifier\": \"incident\"\n },\n {\n \"component_comm_id\": \"51917486-6f94-4524-82e0-aba2f2b50314\",\n \"component_name\": \"SLA\",\n \"code_name\": \"sla\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"04bbf712-64d0-4f2e-97cf-f8d054efdcb4\",\n \"component_name\": \"Delete Untriaged Incidents\",\n \"code_name\": \"delete_incident\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"ad694848-a6aa-46dc-bb17-e09ee2eca967\",\n \"component_name\": \"Cost Tracking\",\n \"code_name\": \"costing\",\n \"component_identifier\": \"costing\"\n },\n {\n \"component_comm_id\": \"18cec9b1-c90c-4bc5-b858-1411bc66e451\",\n \"component_name\": \"Campaigns\",\n \"code_name\": \"campaign\",\n \"component_identifier\": \"campaign\"\n },\n {\n \"component_comm_id\": \"176f1524-2332-43af-9645-ac91428fafba\",\n \"component_name\": \"Enhancements\",\n \"code_name\": \"enhancement\",\n \"component_identifier\": \"enhancement\"\n },\n {\n \"component_comm_id\": \"80f05ebe-2bcc-4a60-9c29-b32bf33d3c2d\",\n \"component_name\": \"Vulnerabilities\",\n \"code_name\": \"vulnerability\",\n \"component_identifier\": \"vulnerability\"\n },\n {\n \"component_comm_id\": \"cfdb86df-cf72-44bf-ad63-2011a390dbae\",\n \"component_name\": \"Roster Management\",\n \"code_name\": \"roster\",\n \"component_identifier\": \"roster\"\n },\n {\n \"component_comm_id\": \"4967ab3a-b762-41ce-acd4-d4bba1556b1e\",\n \"component_name\": \"Playbooks\",\n \"code_name\": \"playbook\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"da85b00a-a863-47e4-9a73-f1267f6160ce\",\n \"component_name\": \"Protected Incidents\",\n \"code_name\": \"protected_incident\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"56be76a0-3c88-4a43-8f8d-d51bb8eb822c\",\n \"component_name\": \"Manufacturers\",\n \"code_name\": \"manufacturers\",\n \"component_identifier\": \"manufacturers\"\n },\n {\n \"component_comm_id\": \"0acd03ae-5481-4515-925d-d561dd9eab07\",\n \"component_name\": \"Threat Actors\",\n \"code_name\": \"threatactor\",\n \"component_identifier\": \"threat-actor\"\n },\n {\n \"component_comm_id\": \"cfdb86df-cf72-44bf-ad63-2011a390dbae\",\n \"component_name\": \"Roster Management\",\n \"code_name\": \"roster\",\n \"component_identifier\": \"roster\"\n },\n {\n \"component_comm_id\": \"cc480584-e2bf-4adc-850d-452835bfa649\",\n \"component_name\": \"Business Units\",\n \"code_name\": \"businessunit\",\n \"component_identifier\": \"business-unit\"\n },\n {\n \"component_comm_id\": \"4967ab3a-b762-41ce-acd4-d4bba1556b1e\",\n \"component_name\": \"Playbooks\",\n \"code_name\": \"playbook\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"168584b9-3b6f-477f-96d8-c1a7ea6fb515\",\n \"component_name\": \"Console Status\",\n \"code_name\": \"cftr_server_monitor\",\n \"component_identifier\": \"cftr_server_monitor\"\n },\n {\n \"component_comm_id\": \"80f05ebe-2bcc-4a60-9c29-b32bf33d3c2d\",\n \"component_name\": \"Vulnerabilities\",\n \"code_name\": \"vulnerability\",\n \"component_identifier\": \"vulnerability\"\n },\n {\n \"component_comm_id\": \"0613996b-ec2b-405b-9f6b-c39cb46c41a0\",\n \"component_name\": \"Knowledge Base\",\n \"code_name\": \"document\",\n \"component_identifier\": \"knowledge-base\"\n },\n {\n \"component_comm_id\": \"ad694848-a6aa-46dc-bb17-e09ee2eca967\",\n \"component_name\": \"Cost Tracking\",\n \"code_name\": \"costing\",\n \"component_identifier\": \"costing\"\n },\n {\n \"component_comm_id\": \"cc480584-e2bf-4adc-850d-452835bfa649\",\n \"component_name\": \"Business Units\",\n \"code_name\": \"businessunit\",\n \"component_identifier\": \"business-unit\"\n },\n {\n \"component_comm_id\": \"d18468ff-a1bd-4d7f-b213-7644d3d99bca\",\n \"component_name\": \"User Management\",\n \"code_name\": \"user\",\n \"component_identifier\": \"ciims-user\"\n },\n {\n \"component_comm_id\": \"e8f776d0-9ebd-496c-b051-3e5743fb50a7\",\n \"component_name\": \"Activity Logs\",\n \"code_name\": \"user_activity_logs\",\n \"component_identifier\": \"user_activity_logs\"\n },\n {\n \"component_comm_id\": \"176f1524-2332-43af-9645-ac91428fafba\",\n \"component_name\": \"Enhancements\",\n \"code_name\": \"enhancement\",\n \"component_identifier\": \"enhancement\"\n },\n {\n \"component_comm_id\": \"19c1534f-60be-4755-9e41-62d401cbdde4\",\n \"component_name\": \"Malware\",\n \"code_name\": \"malware\",\n \"component_identifier\": \"malware\"\n },\n {\n \"component_comm_id\": \"a29d2ad9-c808-40c6-ba2a-0ed77627d92a\",\n \"component_name\": \"Actions\",\n \"code_name\": \"action\",\n \"component_identifier\": \"action\"\n },\n {\n \"component_comm_id\": \"139a6f8a-40a3-4960-904e-31f4ddb8a344\",\n \"component_name\": \"Email Customization\",\n \"code_name\": \"custom_email_templates\",\n \"component_identifier\": \"custom_email_templates\"\n }\n ],\n \"last_active\": null,\n \"last_device\": null,\n \"last_device_ip\": null,\n \"currency\": \"USD\",\n \"show_related_incidents\": \"True\",\n \"invited_by\": \"bd0cf077-ab46-4caa-98b7-c6fbd9334e45\",\n \"ldap_id\": null,\n \"display_pic_datauri\": null,\n \"full_name\": \"john doe\",\n \"password_update_time\": null,\n \"analyst_cost\": 20,\n \"is_system_user\": false,\n \"invite_status\": \"INVITED\"\n}"}],"_postman_id":"4b812159-30cb-4e5a-9701-dc49b4079cdd"},{"name":"Update User","id":"106e95b3-9203-40f2-981d-79e621df88ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"country_code\": \"91\",\n \"contact_number\": \"2134533323\",\n \"first_name\": \"john\",\n \"last_name\": \"doe\",\n \"email\": \"john.doe+1@example.com\",\n \"title\": \"Backend Developer\",\n \"groups\": [\n \"b7fccb8d-07da-45bd-b08f-5cbb94f4fd3e\"\n ],\n \"location\": \"88162aea-c7c8-48f2-b1cf-08b4eb5c35ab\",\n \"business_unit\": \"f0a81f30-a72a-4c9a-b901-cc15475c4e02\",\n \"allowed_locations\": [\n \"88162aea-c7c8-48f2-b1cf-08b4eb5c35ab\"\n ],\n \"allowed_business_units\": [\n \"f0a81f30-a72a-4c9a-b901-cc15475c4e02\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/rest-auth/user/:user_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Update the details of a user in the CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
`country_code`	String	Optional	Enter international dialing code of the country of the user.
`contact_number`	String	Optional	Enter the contact number of the user.
`first_name`	String	Optional	Enter the first name of the user.
`last_name`	String	Optional	Enter the last name of the user.
`username`	String	Optional	Enter username for the user.
`email`	String	Optional	Enter the email ID of the user.
`title`	String	Optional	Enter job title of the user.
`groups`	List of Strings	Optional	Enter the `group_comm_id` of the User Groups to assign the user.
`location`	String	Optional	Enter the unique ID of the user location in UUID-4 format.
`business_unit`	String	Optional	Enter the unique ID of the Business Unit of the user in UUID-4 format.
`allowed_locations`	List of Strings	Optional	Enter the list of unique IDs of the allowed locations of the user in UUID-4 format.
`allowed_business_unit`	List of Strings	Optional	Enter the list of unique IDs of the allowed Business Units of the user in UUID-4 format.
`is_bot`	Boolean	Optional	Enter whether the user is a bot user or not.

Response Parameters

Parameter	Type	Description
`user_id`	String	Unique ID of the user in UUID-4 format.
`permission`	List of String	The list of permissions configured for the user in the CFTR application. Note: The permissions depend on the user groups of the user.
`last_login`	String	Last log in date and time of the user in ISO Format.
`first_name`	String	First name of the user.
`last_name`	String	Last name of the user.
`email`	String	Email ID of the user.
`title`	String	Job title of the user.
`display_pic`	String	The link to the display picture of the user.
`groups`	List of String	List of unique IDs of `group_comm_id` of the user groups in UUID-4 format.
`groups_data`	List of Objects	Details of the user groups. Each object includes the details of one User Group.
`country_code`	String	Country code of the user.
`contact_number`	String	Contact number of the user.
`username`	String	Username of the user.
`location`	String	Unique ID of the location of the user in UUID-4 format.
`location_data`	Object	Details of the user location.
`allowed_locations`	List of Strings	List of unique IDs of the allowed locations of the user in UUID-4 format.
`allowed_locations_data`	List of Objects	Details of the allowed locations of the user. Each object includes the details of one location.
`business_unit`	String	Unique ID of the Business Unit of the user in UUID-4 format.
`business_unit_data`	Object	Details of the Business Unit of the user.
`allowed_business_units`	List of Strings	List of unique IDs of the allowed Business Units of the user in UUID-4 format.
`allowed_business_units_data`	List of Objects	Details of the allowed business units of the user. Each object includes the details of one business unit.
`is_active`	Boolean	Shows whether the user is an active user or not.
`date_joined`	String	Joining date and time of the user in ISO format.
`is_onboarded`	Boolean	Shows whether the user has activated their account using the confirmation link or not.
`date_onboarded`	String	Onboarding date and time of the user in ISO format.
`is_bot`	Boolean	Shows whether the user is a bot user or not.
`is_admin`	Boolean	Shows whether the user is a CFTR admin or not.
`show_related_incidents`	Boolean	Shows whether the user has access to view related incidents in the Connect The Dots section or not.
`landing_component`	String	Unique ID of the landing component configured for the user in UUID-4 format.
`landing_component_data`	Object	Details of the landing component configured for the user.
`allowed_components`	List of Objects	Details of the allowed components of the user. Each object includes the details of one component.
`last_active`	String	Last active date and time of the user in ISO format.
`last_device`	String	Details of the last device used by the user.
`last_device_ip`	String	Generic IP address of the device last used by the user.
`currency`	String	Currency choice associated with the user. Allowed values: `INR`, `USD`, `GBP`, `EUR`, and`AED`.
`invited_by`	String	Unique ID of the user who invited the current user.
`ldap_id`	String	Unique ID of LDAP associated with the user.
`full_name`	String	Full name of the user.
`password_update_time`	String	Last updated date and time of the password of the user in ISO format.
`analyst_cost`	Float	Maximum value of analyst cost associated with each user group of the user.
`is_system_user`	Boolean	Shows whether the user is a system user or not.
`invite_status`	String	Shows whether the user has accepted the invite or not. Allowed values: - `INVITED`: Invite yet to be accepted. - `ACCEPTED`: Invite accepted.

Note: The permissions of a user depend on the User Groups of the user. If a user is assigned to more than User Groups, then the permissions of all the User Groups apply for the user.

Response Parameters | Location and Allowed Locations Data Objects

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	Title of the location
`unique_id`	String	Unique ID of the location in UUID-4 format.
`created`	String	Creation date and time of the location in ISO format.
`modified`	String	Last modified date and time of the location in ISO format.

Response Parameters | Business Unit and Allowed Business Units Data Objects

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	Title of the Business Unit.
`description`	Text	Description of the Business Unit.
`unique_id`	String	Unique ID of the Business Unit in UUID-4 format.
`created`	String	Creation date and time of the Business Unit in ISO format.
`modified`	String	Last modified date and time of the Business Unit in ISO format.
`readable_id`	String	Unique readable ID of the Business Unit. It starts with BU followed by a unique number Example: \"BU101\"

Response Parameters | Groups Data Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`group_comm_id`	String	Unique ID of the User Group in UUID-4 format.
`group_name`	String	Name of the User Group.
`description`	Text	Description of the user group.

Response Parameters | Allowed Components and Landing Component Data Objects

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`component_comm_id`	String	Unique ID of the component in UUID-4 format.
`component_name`	String	Name of the component.
`code_name`	String	Code name of the component.
`component_identifier`	String	Identification string of the component.

Example Error Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Description
400	Username should be unique. Email should be valid and unique. Username should only be lowercase alphabets, numbers, periods, and underscore (length between 3 and 15). Country code should be valid.

Enter the unique ID of the user in UUID-4 format.

\n","type":"text/plain"},"type":"any","value":"fe493232-e50e-497f-87ed-041a719df5ed","key":"user_unique_id"}]}},"response":[{"id":"53439882-9359-46ed-a377-54d513a6c72c","name":"Eg: Update details of a User","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"country_code\": \"91\",\n \"contact_number\": \"2134533323\",\n \"first_name\": \"john\",\n \"last_name\": \"doe\",\n \"email\": \"john.doe+1@example.com\",\n \"title\": \"Backend Developer\",\n \"groups\": [\n \"b7fccb8d-07da-45bd-b08f-5cbb94f4fd3e\"\n ],\n \"location\": \"88162aea-c7c8-48f2-b1cf-08b4eb5c35ab\",\n \"business_unit\": \"f0a81f30-a72a-4c9a-b901-cc15475c4e02\",\n \"allowed_locations\": [\n \"88162aea-c7c8-48f2-b1cf-08b4eb5c35ab\"\n ],\n \"allowed_business_units\": [\n \"f0a81f30-a72a-4c9a-b901-cc15475c4e02\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/rest-auth/user/:user_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["rest-auth","user",":user_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"user_unique_id","value":"fe493232-e50e-497f-87ed-041a719df5ed","description":"Enter the unique ID of the User in UUID-4 format"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Mon, 21 Feb 2022 11:03:24 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"17759","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"user_id\": \"fe493232-e50e-497f-87ed-041a719df5ed\",\n \"permission\": [\n \"cu_terminal\",\n \"cu_document\",\n \"view_label\",\n \"view_sla\",\n \"cu_source\",\n \"cu_dashboard\",\n \"view_threatactor\",\n \"view_vulnerability\",\n \"cu_merge_incident\",\n \"cu_threatactor\",\n \"cu_formmanagement\",\n \"view_device\",\n \"cu_report\",\n \"view_businessunit\",\n \"cu_generaluser\",\n \"cu_backup\",\n \"cu_sla\",\n \"cu_user\",\n \"cu_request_logs\",\n \"view_pir\",\n \"cu_delete_incident\",\n \"view_application\",\n \"view_protected_incident\",\n \"view_tenant_configuration\",\n \"cu_pause_incident\",\n \"view_assetsoftware\",\n \"view_networkutility\",\n \"cu_manage_tenant\",\n \"cu_action\",\n \"cu_campaign\",\n \"view_source\",\n \"cu_ostypes\",\n \"view_manage_tenant\",\n \"view_merge_incident\",\n \"view_campaign\",\n \"cu_malware\",\n \"view_backup\",\n \"view_incident\",\n \"view_request_logs\",\n \"cu_briefing\",\n \"cu_custom_email_templates\",\n \"view_report\",\n \"cu_user_activity_logs\",\n \"view_enhancement\",\n \"cu_roster\",\n \"view_template\",\n \"cu_license\",\n \"view_user\",\n \"cu_businessunit\",\n \"view_usergroup\",\n \"cu_pir\",\n \"view_playbook\",\n \"view_attacknavigator\",\n \"cu_enhancement\",\n \"view_location\",\n \"view_costing\",\n \"cu_openapi\",\n \"cu_manufacturers\",\n \"cu_threatintel\",\n \"cu_incident\",\n \"cu_assetsoftware\",\n \"view_action\",\n \"view_ostypes\",\n \"view_formmanagement\",\n \"view_cftr_server_monitor\",\n \"cu_costing\",\n \"view_manufacturers\",\n \"view_fangdefang\",\n \"view_user_activity_logs\",\n \"cu_tenant_configuration\",\n \"cu_location\",\n \"view_briefing\",\n \"view_threatintel\",\n \"view_document\",\n \"cu_label\",\n \"view_generaluser\",\n \"cu_playbook\",\n \"view_terminal\",\n \"view_custom_email_templates\",\n \"cu_usergroup\",\n \"cu_template\",\n \"cu_vulnerability\",\n \"view_roster\",\n \"view_dashboard\",\n \"cu_device\",\n \"view_pause_incident\",\n \"view_delete_incident\",\n \"view_malware\",\n \"view_openapi\",\n \"cu_application\",\n \"view_license\"\n ],\n \"last_login\": null,\n \"first_name\": \"john\",\n \"last_name\": \"doe\",\n \"email\": \"john.doe+1@example.com\",\n \"title\": \"Backend Developer\",\n \"organization_unique_id\": null,\n \"display_pic\": null,\n \"organization_data\": null,\n \"groups\": [\n \"b7fccb8d-07da-45bd-b08f-5cbb94f4fd3e\"\n ],\n \"country_code\": \"91\",\n \"contact_number\": \"2134533323\",\n \"username\": \"johndoe_1\",\n \"allowed_locations\": [\n \"973198d5-d223-489b-96bc-5511164d7545\",\n \"88162aea-c7c8-48f2-b1cf-08b4eb5c35ab\"\n ],\n \"allowed_locations_data\": [\n {\n \"title\": \"System\",\n \"unique_id\": \"88162aea-c7c8-48f2-b1cf-08b4eb5c35ab\",\n \"created\": \"2022-01-24T09:28:16.757486Z\",\n \"modified\": \"2022-01-24T09:28:16.757486Z\"\n }\n ],\n \"allowed_business_units\": [\n \"9a34e80d-6cda-4e9f-8eb9-e4bfd9ced52a\",\n \"f0a81f30-a72a-4c9a-b901-cc15475c4e02\"\n ],\n \"allowed_business_units_data\": [\n {\n \"title\": \"System\",\n \"description\": null,\n \"unique_id\": \"f0a81f30-a72a-4c9a-b901-cc15475c4e02\",\n \"created\": \"2022-01-24T09:28:16.737284Z\",\n \"modified\": \"2022-01-24T09:28:16.737284Z\",\n \"readable_id\": \"BU102\"\n }\n ],\n \"allowed_entities\": [\n \"977d7893-4b7c-4b55-a16c-64bf74582d7a\"\n ],\n \"allowed_entities_data\": [],\n \"profile_background_color\": \"#A0887E\",\n \"is_active\": true,\n \"date_joined\": \"2022-02-20T16:44:31.485953Z\",\n \"user_theme\": \"skin-2\",\n \"business_unit_data\": {\n \"title\": \"System\",\n \"description\": null,\n \"unique_id\": \"f0a81f30-a72a-4c9a-b901-cc15475c4e02\",\n \"created\": \"2022-01-24T09:28:16.737284Z\",\n \"modified\": \"2022-01-24T09:28:16.737284Z\",\n \"readable_id\": \"BU102\"\n },\n \"location_data\": {\n \"title\": \"System\",\n \"unique_id\": \"88162aea-c7c8-48f2-b1cf-08b4eb5c35ab\",\n \"created\": \"2022-01-24T09:28:16.757486Z\",\n \"modified\": \"2022-01-24T09:28:16.757486Z\"\n },\n \"is_onboarded\": false,\n \"is_bot\": true,\n \"default_dashboard\": \"26c964a8-4b59-403b-a547-e090bde502d8\",\n \"business_unit\": \"f0a81f30-a72a-4c9a-b901-cc15475c4e02\",\n \"location\": \"88162aea-c7c8-48f2-b1cf-08b4eb5c35ab\",\n \"groups_data\": [\n {\n \"group_comm_id\": \"b7fccb8d-07da-45bd-b08f-5cbb94f4fd3e\",\n \"group_name\": \"CFTR Admin\",\n \"description\": null\n }\n ],\n \"is_admin\": true,\n \"login_mode\": null,\n \"show_related_assets\": true,\n \"show_briefings_escalation\": false,\n \"date_onboarded\": null,\n \"landing_component\": null,\n \"landing_component_data\": null,\n \"allowed_components\": [\n {\n \"component_comm_id\": \"d9003084-078b-4f84-835c-ea1e92c35c2d\",\n \"component_name\": \"Labels\",\n \"code_name\": \"label\",\n \"component_identifier\": \"label\"\n },\n {\n \"component_comm_id\": \"a29d2ad9-c808-40c6-ba2a-0ed77627d92a\",\n \"component_name\": \"Actions\",\n \"code_name\": \"action\",\n \"component_identifier\": \"action\"\n },\n {\n \"component_comm_id\": \"f063260e-5536-41d8-8c92-1c795c6edb0d\",\n \"component_name\": \"Threat Briefings\",\n \"code_name\": \"briefing\",\n \"component_identifier\": \"threat-briefing\"\n },\n {\n \"component_comm_id\": \"08af4f86-f603-422a-acd4-fd175ab3465c\",\n \"component_name\": \"Tenant Management\",\n \"code_name\": \"manage_tenant\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"53641327-7022-4007-a9ce-10963b697298\",\n \"component_name\": \"Terminal\",\n \"code_name\": \"terminal\",\n \"component_identifier\": \"terminal\"\n },\n {\n \"component_comm_id\": \"8141a27a-d725-4baf-803e-7c0940171298\",\n \"component_name\": \"User Group Management\",\n \"code_name\": \"usergroup\",\n \"component_identifier\": \"user-group\"\n },\n {\n \"component_comm_id\": \"53641327-7022-4007-a9ce-10963b697298\",\n \"component_name\": \"Terminal\",\n \"code_name\": \"terminal\",\n \"component_identifier\": \"terminal\"\n },\n {\n \"component_comm_id\": \"826661b1-9be4-49fc-b3fe-782f0bb5b507\",\n \"component_name\": \"Devices\",\n \"code_name\": \"device\",\n \"component_identifier\": \"device\"\n },\n {\n \"component_comm_id\": \"e98db60b-a1a4-49d6-8f14-3944040b1853\",\n \"component_name\": \"Software\",\n \"code_name\": \"assetsoftware\",\n \"component_identifier\": \"asset-software\"\n },\n {\n \"component_comm_id\": \"ee0fced1-48fc-441b-9316-bc43b984ffff\",\n \"component_name\": \"Merge Incidents\",\n \"code_name\": \"merge_incident\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"08af4f86-f603-422a-acd4-fd175ab3465c\",\n \"component_name\": \"Tenant Management\",\n \"code_name\": \"manage_tenant\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"7e485ba0-7736-456b-92e6-6c85a8248f84\",\n \"component_name\": \"Incidents\",\n \"code_name\": \"incident\",\n \"component_identifier\": \"incident\"\n },\n {\n \"component_comm_id\": \"19c1534f-60be-4755-9e41-62d401cbdde4\",\n \"component_name\": \"Malware\",\n \"code_name\": \"malware\",\n \"component_identifier\": \"malware\"\n },\n {\n \"component_comm_id\": \"f8a41b07-7db3-4ca5-b35c-29011320efa1\",\n \"component_name\": \"ATT&CK Navigator\",\n \"code_name\": \"attacknavigator\",\n \"component_identifier\": \"attack-navigator\"\n },\n {\n \"component_comm_id\": \"13da5e0d-8f63-4a03-af66-5598ab813942\",\n \"component_name\": \"Threat Intel\",\n \"code_name\": \"threatintel\",\n \"component_identifier\": \"ioc\"\n },\n {\n \"component_comm_id\": \"d9003084-078b-4f84-835c-ea1e92c35c2d\",\n \"component_name\": \"Labels\",\n \"code_name\": \"label\",\n \"component_identifier\": \"label\"\n },\n {\n \"component_comm_id\": \"b3da5259-816c-4dcb-830e-e4147722ea19\",\n \"component_name\": \"Template Management\",\n \"code_name\": \"template\",\n \"component_identifier\": \"template\"\n },\n {\n \"component_comm_id\": \"8e3e1dde-92b4-4183-8ca3-3155e2428782\",\n \"component_name\": \"Version and License\",\n \"code_name\": \"license\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"56be76a0-3c88-4a43-8f8d-d51bb8eb822c\",\n \"component_name\": \"Manufacturers\",\n \"code_name\": \"manufacturers\",\n \"component_identifier\": \"manufacturers\"\n },\n {\n \"component_comm_id\": \"8e3e1dde-92b4-4183-8ca3-3155e2428782\",\n \"component_name\": \"Version and License\",\n \"code_name\": \"license\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"139a6f8a-40a3-4960-904e-31f4ddb8a344\",\n \"component_name\": \"Email Customization\",\n \"code_name\": \"custom_email_templates\",\n \"component_identifier\": \"custom_email_templates\"\n },\n {\n \"component_comm_id\": \"d4ebf715-b68e-4c77-bb69-b28fe48f9419\",\n \"component_name\": \"OpenAPI\",\n \"code_name\": \"openapi\",\n \"component_identifier\": \"openapi\"\n },\n {\n \"component_comm_id\": \"5830b4a8-7a24-43d0-b552-0c2bdffb3b13\",\n \"component_name\": \"Locations\",\n \"code_name\": \"location\",\n \"component_identifier\": \"location\"\n },\n {\n \"component_comm_id\": \"f54a6ffe-c25d-4b4c-b144-d3d982c46a05\",\n \"component_name\": \"Configurations\",\n \"code_name\": \"tenant_configuration\",\n \"component_identifier\": \"configuration\"\n },\n {\n \"component_comm_id\": \"d18468ff-a1bd-4d7f-b213-7644d3d99bca\",\n \"component_name\": \"User Management\",\n \"code_name\": \"user\",\n \"component_identifier\": \"ciims-user\"\n },\n {\n \"component_comm_id\": \"f063260e-5536-41d8-8c92-1c795c6edb0d\",\n \"component_name\": \"Threat Briefings\",\n \"code_name\": \"briefing\",\n \"component_identifier\": \"threat-briefing\"\n },\n {\n \"component_comm_id\": \"cd6ce02b-3d25-4a96-a27c-7a77affe669f\",\n \"component_name\": \"PIRs\",\n \"code_name\": \"pir\",\n \"component_identifier\": \"pir\"\n },\n {\n \"component_comm_id\": \"8141a27a-d725-4baf-803e-7c0940171298\",\n \"component_name\": \"User Group Management\",\n \"code_name\": \"usergroup\",\n \"component_identifier\": \"user-group\"\n },\n {\n \"component_comm_id\": \"3a9b99c6-4b00-47fb-b9b1-64e33066e933\",\n \"component_name\": \"OS Types\",\n \"code_name\": \"ostypes\",\n \"component_identifier\": \"ostype\"\n },\n {\n \"component_comm_id\": \"ee89e3bc-a594-4d4b-90b5-a80d4d7a9147\",\n \"component_name\": \"Reports\",\n \"code_name\": \"report\",\n \"component_identifier\": \"report\"\n },\n {\n \"component_comm_id\": \"389dc557-4e85-43e4-866d-676d7a33de2a\",\n \"component_name\": \"Form Management\",\n \"code_name\": \"formmanagement\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"f54a6ffe-c25d-4b4c-b144-d3d982c46a05\",\n \"component_name\": \"Configurations\",\n \"code_name\": \"tenant_configuration\",\n \"component_identifier\": \"configuration\"\n },\n {\n \"component_comm_id\": \"9819c575-05b6-4652-be17-560a7b4ea867\",\n \"component_name\": \"Pause Incident\",\n \"code_name\": \"pause_incident\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"d4ebf715-b68e-4c77-bb69-b28fe48f9419\",\n \"component_name\": \"OpenAPI\",\n \"code_name\": \"openapi\",\n \"component_identifier\": \"openapi\"\n },\n {\n \"component_comm_id\": \"cd6ce02b-3d25-4a96-a27c-7a77affe669f\",\n \"component_name\": \"PIRs\",\n \"code_name\": \"pir\",\n \"component_identifier\": \"pir\"\n },\n {\n \"component_comm_id\": \"2b697c91-2908-4154-8341-080a83ed5a31\",\n \"component_name\": \"Backups\",\n \"code_name\": \"backup\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"f03865cf-b137-4df6-b07f-49d6f0d46ad6\",\n \"component_name\": \"Users\",\n \"code_name\": \"generaluser\",\n \"component_identifier\": \"general-user\"\n },\n {\n \"component_comm_id\": \"b3da5259-816c-4dcb-830e-e4147722ea19\",\n \"component_name\": \"Template Management\",\n \"code_name\": \"template\",\n \"component_identifier\": \"template\"\n },\n {\n \"component_comm_id\": \"0613996b-ec2b-405b-9f6b-c39cb46c41a0\",\n \"component_name\": \"Knowledge Base\",\n \"code_name\": \"document\",\n \"component_identifier\": \"knowledge-base\"\n },\n {\n \"component_comm_id\": \"51917486-6f94-4524-82e0-aba2f2b50314\",\n \"component_name\": \"SLA\",\n \"code_name\": \"sla\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"f1c6293f-97f3-4ce0-8e68-c0691c4e6ea4\",\n \"component_name\": \"Applications\",\n \"code_name\": \"application\",\n \"component_identifier\": \"application\"\n },\n {\n \"component_comm_id\": \"3a9b99c6-4b00-47fb-b9b1-64e33066e933\",\n \"component_name\": \"OS Types\",\n \"code_name\": \"ostypes\",\n \"component_identifier\": \"ostype\"\n },\n {\n \"component_comm_id\": \"e98db60b-a1a4-49d6-8f14-3944040b1853\",\n \"component_name\": \"Software\",\n \"code_name\": \"assetsoftware\",\n \"component_identifier\": \"asset-software\"\n },\n {\n \"component_comm_id\": \"82661c76-07f7-46d3-99d9-842fef411322\",\n \"component_name\": \"Sources\",\n \"code_name\": \"source\",\n \"component_identifier\": \"source\"\n },\n {\n \"component_comm_id\": \"0d3f0316-c2dd-4a37-a7c9-65f2b27c4a7a\",\n \"component_name\": \"Dashboards\",\n \"code_name\": \"dashboard\",\n \"component_identifier\": \"dashboard\"\n },\n {\n \"component_comm_id\": \"9819c575-05b6-4652-be17-560a7b4ea867\",\n \"component_name\": \"Pause Incident\",\n \"code_name\": \"pause_incident\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"826661b1-9be4-49fc-b3fe-782f0bb5b507\",\n \"component_name\": \"Devices\",\n \"code_name\": \"device\",\n \"component_identifier\": \"device\"\n },\n {\n \"component_comm_id\": \"04bbf712-64d0-4f2e-97cf-f8d054efdcb4\",\n \"component_name\": \"Delete Untriaged Incidents\",\n \"code_name\": \"delete_incident\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"f03865cf-b137-4df6-b07f-49d6f0d46ad6\",\n \"component_name\": \"Users\",\n \"code_name\": \"generaluser\",\n \"component_identifier\": \"general-user\"\n },\n {\n \"component_comm_id\": \"e8f776d0-9ebd-496c-b051-3e5743fb50a7\",\n \"component_name\": \"Activity Logs\",\n \"code_name\": \"user_activity_logs\",\n \"component_identifier\": \"user_activity_logs\"\n },\n {\n \"component_comm_id\": \"f1c6293f-97f3-4ce0-8e68-c0691c4e6ea4\",\n \"component_name\": \"Applications\",\n \"code_name\": \"application\",\n \"component_identifier\": \"application\"\n },\n {\n \"component_comm_id\": \"ee89e3bc-a594-4d4b-90b5-a80d4d7a9147\",\n \"component_name\": \"Reports\",\n \"code_name\": \"report\",\n \"component_identifier\": \"report\"\n },\n {\n \"component_comm_id\": \"9ed8c26e-7ad4-4caa-b1ce-efc1993a81ef\",\n \"component_name\": \"API Request Logs\",\n \"code_name\": \"request_logs\",\n \"component_identifier\": \"request_logs\"\n },\n {\n \"component_comm_id\": \"2b697c91-2908-4154-8341-080a83ed5a31\",\n \"component_name\": \"Backups\",\n \"code_name\": \"backup\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"82661c76-07f7-46d3-99d9-842fef411322\",\n \"component_name\": \"Sources\",\n \"code_name\": \"source\",\n \"component_identifier\": \"source\"\n },\n {\n \"component_comm_id\": \"e81caf49-a0d6-4c40-85ed-338925d330f1\",\n \"component_name\": \"Network Utility\",\n \"code_name\": \"networkutility\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"389dc557-4e85-43e4-866d-676d7a33de2a\",\n \"component_name\": \"Form Management\",\n \"code_name\": \"formmanagement\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"13da5e0d-8f63-4a03-af66-5598ab813942\",\n \"component_name\": \"Threat Intel\",\n \"code_name\": \"threatintel\",\n \"component_identifier\": \"ioc\"\n },\n {\n \"component_comm_id\": \"0d3f0316-c2dd-4a37-a7c9-65f2b27c4a7a\",\n \"component_name\": \"Dashboards\",\n \"code_name\": \"dashboard\",\n \"component_identifier\": \"dashboard\"\n },\n {\n \"component_comm_id\": \"337150ef-3fa0-4f8a-9bfc-42f31433267b\",\n \"component_name\": \"Fang-Defang\",\n \"code_name\": \"fangdefang\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"0acd03ae-5481-4515-925d-d561dd9eab07\",\n \"component_name\": \"Threat Actors\",\n \"code_name\": \"threatactor\",\n \"component_identifier\": \"threat-actor\"\n },\n {\n \"component_comm_id\": \"ee0fced1-48fc-441b-9316-bc43b984ffff\",\n \"component_name\": \"Merge Incidents\",\n \"code_name\": \"merge_incident\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"18cec9b1-c90c-4bc5-b858-1411bc66e451\",\n \"component_name\": \"Campaigns\",\n \"code_name\": \"campaign\",\n \"component_identifier\": \"campaign\"\n },\n {\n \"component_comm_id\": \"5830b4a8-7a24-43d0-b552-0c2bdffb3b13\",\n \"component_name\": \"Locations\",\n \"code_name\": \"location\",\n \"component_identifier\": \"location\"\n },\n {\n \"component_comm_id\": \"9ed8c26e-7ad4-4caa-b1ce-efc1993a81ef\",\n \"component_name\": \"API Request Logs\",\n \"code_name\": \"request_logs\",\n \"component_identifier\": \"request_logs\"\n },\n {\n \"component_comm_id\": \"7e485ba0-7736-456b-92e6-6c85a8248f84\",\n \"component_name\": \"Incidents\",\n \"code_name\": \"incident\",\n \"component_identifier\": \"incident\"\n },\n {\n \"component_comm_id\": \"51917486-6f94-4524-82e0-aba2f2b50314\",\n \"component_name\": \"SLA\",\n \"code_name\": \"sla\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"04bbf712-64d0-4f2e-97cf-f8d054efdcb4\",\n \"component_name\": \"Delete Untriaged Incidents\",\n \"code_name\": \"delete_incident\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"ad694848-a6aa-46dc-bb17-e09ee2eca967\",\n \"component_name\": \"Cost Tracking\",\n \"code_name\": \"costing\",\n \"component_identifier\": \"costing\"\n },\n {\n \"component_comm_id\": \"18cec9b1-c90c-4bc5-b858-1411bc66e451\",\n \"component_name\": \"Campaigns\",\n \"code_name\": \"campaign\",\n \"component_identifier\": \"campaign\"\n },\n {\n \"component_comm_id\": \"176f1524-2332-43af-9645-ac91428fafba\",\n \"component_name\": \"Enhancements\",\n \"code_name\": \"enhancement\",\n \"component_identifier\": \"enhancement\"\n },\n {\n \"component_comm_id\": \"80f05ebe-2bcc-4a60-9c29-b32bf33d3c2d\",\n \"component_name\": \"Vulnerabilities\",\n \"code_name\": \"vulnerability\",\n \"component_identifier\": \"vulnerability\"\n },\n {\n \"component_comm_id\": \"cfdb86df-cf72-44bf-ad63-2011a390dbae\",\n \"component_name\": \"Roster Management\",\n \"code_name\": \"roster\",\n \"component_identifier\": \"roster\"\n },\n {\n \"component_comm_id\": \"4967ab3a-b762-41ce-acd4-d4bba1556b1e\",\n \"component_name\": \"Playbooks\",\n \"code_name\": \"playbook\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"da85b00a-a863-47e4-9a73-f1267f6160ce\",\n \"component_name\": \"Protected Incidents\",\n \"code_name\": \"protected_incident\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"56be76a0-3c88-4a43-8f8d-d51bb8eb822c\",\n \"component_name\": \"Manufacturers\",\n \"code_name\": \"manufacturers\",\n \"component_identifier\": \"manufacturers\"\n },\n {\n \"component_comm_id\": \"0acd03ae-5481-4515-925d-d561dd9eab07\",\n \"component_name\": \"Threat Actors\",\n \"code_name\": \"threatactor\",\n \"component_identifier\": \"threat-actor\"\n },\n {\n \"component_comm_id\": \"cfdb86df-cf72-44bf-ad63-2011a390dbae\",\n \"component_name\": \"Roster Management\",\n \"code_name\": \"roster\",\n \"component_identifier\": \"roster\"\n },\n {\n \"component_comm_id\": \"cc480584-e2bf-4adc-850d-452835bfa649\",\n \"component_name\": \"Business Units\",\n \"code_name\": \"businessunit\",\n \"component_identifier\": \"business-unit\"\n },\n {\n \"component_comm_id\": \"4967ab3a-b762-41ce-acd4-d4bba1556b1e\",\n \"component_name\": \"Playbooks\",\n \"code_name\": \"playbook\",\n \"component_identifier\": \"\"\n },\n {\n \"component_comm_id\": \"168584b9-3b6f-477f-96d8-c1a7ea6fb515\",\n \"component_name\": \"Console Status\",\n \"code_name\": \"cftr_server_monitor\",\n \"component_identifier\": \"cftr_server_monitor\"\n },\n {\n \"component_comm_id\": \"80f05ebe-2bcc-4a60-9c29-b32bf33d3c2d\",\n \"component_name\": \"Vulnerabilities\",\n \"code_name\": \"vulnerability\",\n \"component_identifier\": \"vulnerability\"\n },\n {\n \"component_comm_id\": \"0613996b-ec2b-405b-9f6b-c39cb46c41a0\",\n \"component_name\": \"Knowledge Base\",\n \"code_name\": \"document\",\n \"component_identifier\": \"knowledge-base\"\n },\n {\n \"component_comm_id\": \"ad694848-a6aa-46dc-bb17-e09ee2eca967\",\n \"component_name\": \"Cost Tracking\",\n \"code_name\": \"costing\",\n \"component_identifier\": \"costing\"\n },\n {\n \"component_comm_id\": \"cc480584-e2bf-4adc-850d-452835bfa649\",\n \"component_name\": \"Business Units\",\n \"code_name\": \"businessunit\",\n \"component_identifier\": \"business-unit\"\n },\n {\n \"component_comm_id\": \"d18468ff-a1bd-4d7f-b213-7644d3d99bca\",\n \"component_name\": \"User Management\",\n \"code_name\": \"user\",\n \"component_identifier\": \"ciims-user\"\n },\n {\n \"component_comm_id\": \"e8f776d0-9ebd-496c-b051-3e5743fb50a7\",\n \"component_name\": \"Activity Logs\",\n \"code_name\": \"user_activity_logs\",\n \"component_identifier\": \"user_activity_logs\"\n },\n {\n \"component_comm_id\": \"176f1524-2332-43af-9645-ac91428fafba\",\n \"component_name\": \"Enhancements\",\n \"code_name\": \"enhancement\",\n \"component_identifier\": \"enhancement\"\n },\n {\n \"component_comm_id\": \"19c1534f-60be-4755-9e41-62d401cbdde4\",\n \"component_name\": \"Malware\",\n \"code_name\": \"malware\",\n \"component_identifier\": \"malware\"\n },\n {\n \"component_comm_id\": \"a29d2ad9-c808-40c6-ba2a-0ed77627d92a\",\n \"component_name\": \"Actions\",\n \"code_name\": \"action\",\n \"component_identifier\": \"action\"\n },\n {\n \"component_comm_id\": \"139a6f8a-40a3-4960-904e-31f4ddb8a344\",\n \"component_name\": \"Email Customization\",\n \"code_name\": \"custom_email_templates\",\n \"component_identifier\": \"custom_email_templates\"\n }\n ],\n \"last_active\": null,\n \"last_device\": null,\n \"last_device_ip\": null,\n \"currency\": \"USD\",\n \"show_related_incidents\": \"True\",\n \"invited_by\": \"bd0cf077-ab46-4caa-98b7-c6fbd9334e45\",\n \"ldap_id\": null,\n \"display_pic_datauri\": null,\n \"full_name\": \"john doe\",\n \"password_update_time\": null,\n \"analyst_cost\": 20,\n \"is_system_user\": false,\n \"invite_status\": \"INVITED\"\n}"}],"_postman_id":"106e95b3-9203-40f2-981d-79e621df88ad"}],"id":"19b77acc-cde6-4459-b199-54601375040a","description":"

The User Management module of the Admin Panel enables CFTR admins to manage the users of the CFTR application.

This section describes how to use the API endpoints to manage the CFTR users.

\n","_postman_id":"19b77acc-cde6-4459-b199-54601375040a"},{"name":"Group Management","item":[{"name":"Get List of Groups","id":"9cfe2b31-fb88-453f-8005-17752fa09c81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}v1/rest-auth/permission/group/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve a list of all the user groups with details from the CFTR application.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` shows the API endpoint to the next page.
`count`	Integer	Total number of User Groups in CFTR application as per the query parameters.
`results`	List of Objects	Details of the User Groups. Each object provides details of one User Group.

Response Parameters | Results Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`group_comm_id`	String	Unique ID of the User Group in UUID-4 format.
`group_name`	String	Name of the User Group.
`description`	Text	Description of the User Group.
`permissions`	List of Objects	List of permission objects of the usser group. Each object includes the details of one permission.
`created_by`	Object	Unique ID of the user who created the user group.
`user_count`	Positive Integer	Number of users assigned to the user group.
`permission_count`	Positive Integer	Count of the number of `permissions` configured for the user group.
`is_active`	Boolean	Shows whether the user group is currently active or not.
`is_editable`	Boolean	Shows whether the user group is editable or not.
`created`	Integer	Creation date and time of the user group in EPOCH time format.
`ciims_user_set`	List of Strings	List of unique IDs of the users assigned to the user group in UUID-4 format.
`ciims_user_set_data`	List of Objects	Details of the users assigned to the user group. Each object includes the details of one user.
`group_cost`	Float	Analyst cost associated with the users of the user group. The default cost is configured as per the daily rate.
`playbook_tags`	List of Strings	List of unique IDs of the Cyware Orchestrate Playbook tags added to the user group in UUID-4 format.
`playbook_tags_data`	List of Objects	Details of the Playbook tags. Each object includes the details of one Playbook tag.
`is_readonly_group`	Boolean	Shows whether the group is read-only or not.
`saml_associated_groups`	String	SAML groups associated with the user group

Response Parameters | Permissions Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`permission_comm_id`	String	Unique ID of the permission in UUID-4 format.
`display_name`	String	Display name of the permission.
`code_name`	String	Unique string of the permission.
`grant`	String	Level of grant associated with each permission in CFTR. Allowed values: -`ALLOWED:` Permissions that are provided by default. -`DISALLOWED:` Permissions that cannot be provided while creating a group. -`SELECTABLE:` Permission that can be configured while creating a group.
`verbose_name`	String	Verbose name given to the permission.

Response Parameters | Created By and CIIMS User Set Data Objects

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`username`	String	Username of the user.
`first_name`	String	First name of the user.
`last_name`	String	Last name of the user.
`profile_background_color`	String	Hex value of the user profile background color.
`user_id`	String	Unique ID of the user in UUID-4 format.
`display_pic`	String	Link to the display picture of the user.
`is_active`	Boolean	Shows whether the user is an active user or not.
`email`	String	Email ID of the user.
`full_name`	String	Full name of the user.

Response Parameters | Playbook Tags Data Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the Playbook in UUID-4 format.
`title`	String	Title of the Playbook.
`description`	Text	Description of the Playbook.

[integer] [Optional] [Default: 1] Starting page. Actual records returned depends on page and page_size

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

[integer] [Optional] [Default: 10] Number of records retrieved per page

\n","type":"text/plain"},"key":"page_size","value":"5"},{"disabled":true,"description":{"content":"

[boolean][Optional][Default: None] Get groups filtered on whether they are active or not. True returns active groups while false returns inactive groups. By default returns both active and inactive groups

\n","type":"text/plain"},"key":"is_active","value":"false"},{"disabled":true,"description":{"content":"

[string][Optional][Default: None] Query string on which API returns the groups whose group_name contain the string

\n","type":"text/plain"},"key":"q","value":"forensic"},{"disabled":true,"description":{"content":"

[comma separated strings][Optional][Default: None] Takes as param comma separated Unique identifier strings of UUID-4 format. API returns the groups that have the identifier strings(denoting a specific group permission) in the permission_comm_id in their permissions

\n","type":"text/plain"},"key":"permission_comm_id","value":"5f72c3e8-82a9-4066-adf1-7250f97fbfe4,1494db74-abd6-41eb-91a5-67e701aa5770"},{"disabled":true,"description":{"content":"

[string][Optional][Default: None] Takes as param a string. API returns the groups that have the identifier string(denoting a specific group permission) in the code_name in their permissions

\n","type":"text/plain"},"key":"permission_code","value":"view_malware"}],"variable":[]}},"response":[{"id":"bc749466-c61a-4ba4-9f19-7c835a9d2596","name":"Get List of Groups","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/rest-auth/permission/group/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["rest-auth","permission","group",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 25 Jan 2024 10:56:26 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, PATCH, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: http: data: blob:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 1,\n \"results\": [\n {\n \"group_comm_id\": \"4e046ee1-5bc9-4320-965f-3bf24dbb9256\",\n \"group_name\": \"Test Group\",\n \"group_email\": null,\n \"description\": \"Group Description\",\n \"permissions\": [\n {\n \"permission_comm_id\": \"7ad5da36-00ce-4baf-9550-4a84fed4e63f\",\n \"display_name\": \"View Locations\",\n \"code_name\": \"view_location\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Locations | View\"\n },\n {\n \"permission_comm_id\": \"814528c7-6eb2-4814-83a8-2bc403f783e5\",\n \"display_name\": \"View Merge Incidents\",\n \"code_name\": \"view_merge_incident\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Merge Incidents | View\"\n },\n {\n \"permission_comm_id\": \"7245d5f0-634a-4579-8cde-a7c4bd80c260\",\n \"display_name\": \"View Delete Untriaged Incidents\",\n \"code_name\": \"view_delete_incident\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Delete Untriaged Incidents | View\"\n },\n {\n \"permission_comm_id\": \"0431a41f-f853-41b5-81c2-e3d6b518126b\",\n \"display_name\": \"View Activity Logs\",\n \"code_name\": \"view_user_activity_logs\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Activity Logs | View\"\n },\n {\n \"permission_comm_id\": \"bbc1df75-6c3b-47b3-9f14-20e32a3693df\",\n \"display_name\": \"View Business Units\",\n \"code_name\": \"view_businessunit\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Business Units | View\"\n },\n {\n \"permission_comm_id\": \"9d214fd5-73ee-4aa0-8d7a-c27f0d82a04a\",\n \"display_name\": \"View Manufacturers\",\n \"code_name\": \"view_manufacturers\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Manufacturers | View\"\n },\n {\n \"permission_comm_id\": \"17bde088-d9dc-4f0f-bf17-e6012f4afd19\",\n \"display_name\": \"View Threat Intel\",\n \"code_name\": \"view_threatintel\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Threat Intel | View\"\n },\n {\n \"permission_comm_id\": \"8ecaca57-1043-430e-964f-f62f43b5fc98\",\n \"display_name\": \"View Labels\",\n \"code_name\": \"view_label\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Labels | View\"\n },\n {\n \"permission_comm_id\": \"3330e8af-f06a-4d25-92b5-a27b6c8f4c5e\",\n \"display_name\": \"View Actions\",\n \"code_name\": \"view_action\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Actions | View\"\n },\n {\n \"permission_comm_id\": \"1494db74-abd6-41eb-91a5-67e701aa5770\",\n \"display_name\": \"View Pause Incident\",\n \"code_name\": \"view_pause_incident\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Pause Incident | View\"\n },\n {\n \"permission_comm_id\": \"f8897569-1fee-4e91-b42b-3d90866bc3a3\",\n \"display_name\": \"View Dashboards\",\n \"code_name\": \"view_dashboard\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Dashboards | View\"\n },\n {\n \"permission_comm_id\": \"6e835cd0-381f-489e-bb44-e6b9f9edc26b\",\n \"display_name\": \"View Sources\",\n \"code_name\": \"view_source\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Sources | View\"\n },\n {\n \"permission_comm_id\": \"dd17e52f-206c-4879-92bd-c858ee43a4c5\",\n \"display_name\": \"View OS Types\",\n \"code_name\": \"view_ostypes\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"OS Types | View\"\n },\n {\n \"permission_comm_id\": \"b37d9ff9-63dd-4c1b-a977-d82438870f65\",\n \"display_name\": \"Create/Update Threat Intel\",\n \"code_name\": \"cu_threatintel\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Threat Intel | Create/Update\"\n }\n ],\n \"created_by\": {\n \"username\": \"johndoe\",\n \"first_name\": \"john\",\n \"last_name\": \"doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"3a437a20-1f40-47ee-be5e-13116a509cf4\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"john.doe@example.com\",\n \"full_name\": \"john doe\"\n },\n \"user_count\": 0,\n \"permission_count\": 14,\n \"is_editable\": true,\n \"is_active\": false,\n \"created\": 1645619094,\n \"ciims_user_set\": [],\n \"ciims_user_set_data\": [],\n \"group_cost\": 2,\n \"playbook_tags\": [],\n \"playbook_tags_data\": []\n }\n ]\n}"}],"_postman_id":"9cfe2b31-fb88-453f-8005-17752fa09c81"},{"name":"Get Details of a Group","id":"936ed818-1cb1-4e65-b699-7b99e03eea62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}v1/rest-auth/permission/group/:group_comm_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the details of a User Group from your CFTR application.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`group_comm_id`	String	Unique ID of the user group in UUID-4 format.
`group_name`	String	Name of the user group.
`description`	Text	Description of the user group.
`permissions`	List of Objects	List of permission objects of the user group. Each object includes the details of one permission.
`created_by`	Object	Unique ID of the user who created the user group.
`user_count`	Positive Integer	Number of users assigned to the user group.
`permission_count`	Positive Integer	Count of the number of `permissions` configured for the user group.
`is_active`	Boolean	Shows whether the user group is currently active or not.
`is_editable`	Boolean	Shows whether the user group is editable or not.
`created`	Integer	Creation date and time of the user group in EPOCH time format.
`ciims_user_set`	List of Strings	List of unique IDs of the users assigned to the user group in UUID-4 format.
`ciims_user_set_data`	List of Objects	Details of the users assigned to the user group. Each object includes the details of one user.
`group_cost`	Float	Analyst cost associated with the users of the user group. The default cost is configured as per the daily rate.
`playbook_tags`	List of Strings	List of unique IDs of the Cyware Orchestrate Playbook tags added to the User Group in UUID-4 format.
`playbook_tags_data`	List of Objects	Details of the Playbook tags. Each object includes the details of one Playbook tag.
`is_readonly_group`	Boolean	Shows whether the group is read only or not.
`saml_associated_groups`	String	Shows the associated SAML groups with the user group.

Response Parameters | Permissions Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`permission_comm_id`	String	Unique ID of the permission in UUID-4 format.
`display_name`	String	Display name of the permission.
`code_name`	String	Unique string of the permission.
`grant`	String	Level of grant associated with each permission in CFTR. Allowed values: -`ALLOWED:` Permissions that are provided by default. -`DISALLOWED:` Permissions that cannot be provided while creating a group. -`SELECTABLE:` Permission that can be configured while creating a group.
`verbose_name`	String	Verbose name given to the permission.

Response Parameters | Created By and CIIMS User Set Data Objects

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`username`	String	Username of the user.
`first_name`	String	First name of the user.
`last_name`	String	Last name of the user.
`profile_background_color`	String	Hex value of the user profile background color.
`user_id`	String	Unique ID of the user in UUID-4 format.
`display_pic`	String	Link to the display picture of the user.
`is_active`	Boolean	Shows whether the user is an active user or not.
`email`	String	Email ID of the user.
`full_name`	String	Full name of the user.

Response Parameters | Playbook Tags Data Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the Playbook in UUID-4 format.
`title`	String	Title of the Playbook.
`description`	Text	Description of the Playbook.

Example Error Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Description
400	Group does not exist.

","urlObject":{"path":["rest-auth","permission","group",":group_comm_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the Group in UUID-4 format

\n","type":"text/plain"},"type":"any","value":"39bc69fa-c09d-4fad-9fa8-1b86ceae5c19","key":"group_comm_id"}]}},"response":[{"id":"1881a411-b8b8-4efb-9e7b-2b7aeef624fd","name":"Eg: Get Details of a Group","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/rest-auth/permission/group/:group_comm_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["rest-auth","permission","group",":group_comm_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"group_comm_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 25 Jan 2024 10:44:01 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, PATCH, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: http: data: blob:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"group_comm_id\": \"39bc69fa-c09d-4fad-9fa8-1b86ceae5c19\",\n \"group_name\": \"India\",\n \"group_email\": null,\n \"description\": null,\n \"permissions\": [\n {\n \"permission_comm_id\": \"64998c73-b4d2-4425-b17a-f4424d0cb338\",\n \"display_name\": \"View Sources\",\n \"code_name\": \"view_source\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Sources | View\"\n },\n {\n \"permission_comm_id\": \"0e04462f-8c44-4b74-8b85-bfc43a0d66e4\",\n \"display_name\": \"View Dashboards\",\n \"code_name\": \"view_dashboard\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Dashboards | View\"\n },\n {\n \"permission_comm_id\": \"4b59b731-5630-44ef-97ad-288310d1148c\",\n \"display_name\": \"View Threat Actors\",\n \"code_name\": \"view_threatactor\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Threat Actors | View\"\n },\n {\n \"permission_comm_id\": \"ff7674fa-2030-4dc2-aefe-197eb9bbbc56\",\n \"display_name\": \"View Knowledge Base\",\n \"code_name\": \"view_document\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Knowledge Base | View\"\n },\n {\n \"permission_comm_id\": \"1de62b2e-f391-4482-9046-9bbef989bc40\",\n \"display_name\": \"View Threat Briefings\",\n \"code_name\": \"view_briefing\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Threat Briefings | View\"\n },\n {\n \"permission_comm_id\": \"a1c764a9-c1bf-4449-b91e-15ab59ffa9bb\",\n \"display_name\": \"View Applications\",\n \"code_name\": \"view_application\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Applications | View\"\n },\n {\n \"permission_comm_id\": \"4febaa88-5214-4373-be1b-bb787d5b68a5\",\n \"display_name\": \"View Threat Intel\",\n \"code_name\": \"view_threatintel\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Threat Intel | View\"\n },\n {\n \"permission_comm_id\": \"8eae85b5-b63d-435b-a8c3-b227267e93fa\",\n \"display_name\": \"View Labels\",\n \"code_name\": \"view_label\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Labels | View\"\n },\n {\n \"permission_comm_id\": \"5c9a8d53-b063-4531-a784-1fcfa5a7017e\",\n \"display_name\": \"View User Management\",\n \"code_name\": \"view_user\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"User Management | View\"\n },\n {\n \"permission_comm_id\": \"69bcdb44-5d6d-4c84-b063-fa41a29dc090\",\n \"display_name\": \"View Devices\",\n \"code_name\": \"view_device\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Devices | View\"\n },\n {\n \"permission_comm_id\": \"7aa957b9-2743-4354-81d4-04682bac206f\",\n \"display_name\": \"View User Group Management\",\n \"code_name\": \"view_usergroup\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"User Group Management | View\"\n },\n {\n \"permission_comm_id\": \"5033953c-6336-4a48-a4fb-af15313363f4\",\n \"display_name\": \"View Locations\",\n \"code_name\": \"view_location\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Locations | View\"\n },\n {\n \"permission_comm_id\": \"26675ef6-19ac-46e6-bec9-73e6467f7896\",\n \"display_name\": \"View Vulnerabilities\",\n \"code_name\": \"view_vulnerability\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Vulnerabilities | View\"\n },\n {\n \"permission_comm_id\": \"85802378-b233-4bf4-af9b-f6716243be82\",\n \"display_name\": \"View Business Units\",\n \"code_name\": \"view_businessunit\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Business Units | View\"\n },\n {\n \"permission_comm_id\": \"70b6e9b2-556c-47ef-baae-012f5a4b0c53\",\n \"display_name\": \"View Protected Incidents\",\n \"code_name\": \"view_protected_incident\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Protected Incidents | View\"\n },\n {\n \"permission_comm_id\": \"e8eb8d35-32c8-4a03-94e7-146ab9c9b1a8\",\n \"display_name\": \"View Pause Incident\",\n \"code_name\": \"view_pause_incident\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Pause Incident | View\"\n },\n {\n \"permission_comm_id\": \"5995c6b1-c4c2-4a73-9a39-00d3666c1f72\",\n \"display_name\": \"View Malware\",\n \"code_name\": \"view_malware\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Malware | View\"\n },\n {\n \"permission_comm_id\": \"8f56866f-35a3-4556-9261-b64fe634138b\",\n \"display_name\": \"View Merge Incidents\",\n \"code_name\": \"view_merge_incident\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Merge Incidents | View\"\n },\n {\n \"permission_comm_id\": \"eacafb77-e71a-47c9-b728-bafebcfde5b8\",\n \"display_name\": \"View Enhancements\",\n \"code_name\": \"view_enhancement\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Enhancements | View\"\n },\n {\n \"permission_comm_id\": \"0897bfa4-9b1d-4d7d-a382-9b66a9615e13\",\n \"display_name\": \"View Delete Untriaged Incidents\",\n \"code_name\": \"view_delete_incident\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Delete Untriaged Incidents | View\"\n },\n {\n \"permission_comm_id\": \"6c6a5edc-db2a-44ff-a675-fa7c8c681902\",\n \"display_name\": \"View Manufacturers\",\n \"code_name\": \"view_manufacturers\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Manufacturers | View\"\n },\n {\n \"permission_comm_id\": \"268132b3-06bc-4368-bfa2-41b9fab685cd\",\n \"display_name\": \"View ATT&CK Navigator\",\n \"code_name\": \"view_attacknavigator\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"ATT&CK Navigator | View\"\n },\n {\n \"permission_comm_id\": \"ed67ec22-70fe-4345-804d-fceb43cf6957\",\n \"display_name\": \"View Roster Management\",\n \"code_name\": \"view_roster\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Roster Management | View\"\n },\n {\n \"permission_comm_id\": \"7e984022-3840-43f4-88ad-e77cb1b0270f\",\n \"display_name\": \"View Actions\",\n \"code_name\": \"view_action\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Actions | View\"\n },\n {\n \"permission_comm_id\": \"ac1727b5-26e0-40d1-8afd-23f4dc303a10\",\n \"display_name\": \"View Configurations\",\n \"code_name\": \"view_tenant_configuration\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Configurations | View\"\n },\n {\n \"permission_comm_id\": \"abf54dbb-9cc1-4d6a-b679-98fa9a17fcc7\",\n \"display_name\": \"View Network Utility\",\n \"code_name\": \"view_networkutility\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Network Utility | View\"\n },\n {\n \"permission_comm_id\": \"686f1ad3-d0a5-4726-8e48-1ee6506c0a70\",\n \"display_name\": \"View Version and License\",\n \"code_name\": \"view_license\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Version and License | View\"\n },\n {\n \"permission_comm_id\": \"5f3b8b1b-19ed-4bf7-8292-9c091dfa96f9\",\n \"display_name\": \"View OpenAPI\",\n \"code_name\": \"view_openapi\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"OpenAPI | View\"\n },\n {\n \"permission_comm_id\": \"a319c1dc-fabd-4802-b68e-ae38eeae1d67\",\n \"display_name\": \"View Email Customization\",\n \"code_name\": \"view_custom_email_templates\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Email Customization | View\"\n },\n {\n \"permission_comm_id\": \"c4d96ce0-dd11-45da-a99f-ca7a7b6b037c\",\n \"display_name\": \"View Fang-Defang\",\n \"code_name\": \"view_fangdefang\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Fang-Defang | View\"\n },\n {\n \"permission_comm_id\": \"294e3cb5-18fd-4ce3-8dbb-077f0a59f5dd\",\n \"display_name\": \"View Template Management\",\n \"code_name\": \"view_template\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Template Management | View\"\n },\n {\n \"permission_comm_id\": \"373571d6-cae6-44a9-a4f0-b37e60ffb477\",\n \"display_name\": \"View Cost Tracking\",\n \"code_name\": \"view_costing\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Cost Tracking | View\"\n },\n {\n \"permission_comm_id\": \"6244e918-eca9-4b1a-905e-7b513e827648\",\n \"display_name\": \"View API Request Logs\",\n \"code_name\": \"view_request_logs\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"API Request Logs | View\"\n },\n {\n \"permission_comm_id\": \"36d68742-3ef3-47df-af3f-e4b0aca29bae\",\n \"display_name\": \"View OS Types\",\n \"code_name\": \"view_ostypes\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"OS Types | View\"\n },\n {\n \"permission_comm_id\": \"82c29a76-bef2-4042-839e-fdda3c154def\",\n \"display_name\": \"View Activity Logs\",\n \"code_name\": \"view_user_activity_logs\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Activity Logs | View\"\n },\n {\n \"permission_comm_id\": \"9dfd1147-f9a6-415e-9df2-4ffec9bbd662\",\n \"display_name\": \"View Form Management\",\n \"code_name\": \"view_formmanagement\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Form Management | View\"\n },\n {\n \"permission_comm_id\": \"7f35e9e8-fd81-4435-a98e-76911bf8a465\",\n \"display_name\": \"View Terminal\",\n \"code_name\": \"view_terminal\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Terminal | View\"\n },\n {\n \"permission_comm_id\": \"97100ca0-b884-4266-b9b6-b93459f6ef8f\",\n \"display_name\": \"View PIRs\",\n \"code_name\": \"view_pir\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"PIRs | View\"\n },\n {\n \"permission_comm_id\": \"79bcdd40-c869-4027-82b7-5b922f2c6423\",\n \"display_name\": \"View Rule Engine\",\n \"code_name\": \"view_rule_engine\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Rule Engine | View\"\n },\n {\n \"permission_comm_id\": \"66e3dc1b-109c-4d2b-85fc-bded33518d17\",\n \"display_name\": \"View Campaigns\",\n \"code_name\": \"view_campaign\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Campaigns | View\"\n },\n {\n \"permission_comm_id\": \"619f9a41-3df2-49f1-8b1a-8c9bd28620c2\",\n \"display_name\": \"View Action Library\",\n \"code_name\": \"view_action_library\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Action Library | View\"\n },\n {\n \"permission_comm_id\": \"b0cf1d19-f556-4c34-9627-699630a10746\",\n \"display_name\": \"View Playbooks\",\n \"code_name\": \"view_playbook\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Playbooks | View\"\n },\n {\n \"permission_comm_id\": \"7942200e-c486-448c-be2a-b79fd6588b99\",\n \"display_name\": \"View MSSP Dashboard\",\n \"code_name\": \"view_mssp_dashboard\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"MSSP Dashboard | View\"\n },\n {\n \"permission_comm_id\": \"e9142c4c-c743-49fb-9108-d0f6f9b5ca9c\",\n \"display_name\": \"View Users\",\n \"code_name\": \"view_generaluser\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Users | View\"\n },\n {\n \"permission_comm_id\": \"09262274-c06c-4c0d-a0d1-07dd553e2a24\",\n \"display_name\": \"View Reports\",\n \"code_name\": \"view_report\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Reports | View\"\n },\n {\n \"permission_comm_id\": \"e8a77274-5af7-48a3-b02a-e262bc84a71f\",\n \"display_name\": \"View Software\",\n \"code_name\": \"view_assetsoftware\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Software | View\"\n },\n {\n \"permission_comm_id\": \"e04f4db6-4ac7-420e-9317-fd43ec1264f4\",\n \"display_name\": \"View SLA\",\n \"code_name\": \"view_sla\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"SLA | View\"\n },\n {\n \"permission_comm_id\": \"27f4eb10-330e-4e9a-bbb2-b88accc1a17f\",\n \"display_name\": \"View Incidents\",\n \"code_name\": \"view_incident\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Incidents | View\"\n },\n {\n \"permission_comm_id\": \"9ad49fb7-e13c-4837-b015-446e4498d71a\",\n \"display_name\": \"Create/Update Template Management\",\n \"code_name\": \"cu_template\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Template Management | Create/Update\"\n },\n {\n \"permission_comm_id\": \"5ea7d1ef-e26f-438c-98b9-e974c0fbd7bd\",\n \"display_name\": \"Create/Update Cost Tracking\",\n \"code_name\": \"cu_costing\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Cost Tracking | Create/Update\"\n },\n {\n \"permission_comm_id\": \"35d8b57f-8497-44b3-8290-e9312dc51a10\",\n \"display_name\": \"Create/Update Actions\",\n \"code_name\": \"cu_action\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Actions | Create/Update\"\n },\n {\n \"permission_comm_id\": \"61a1595a-44ee-48c4-a244-6ea9501d43df\",\n \"display_name\": \"Create/Update Applications\",\n \"code_name\": \"cu_application\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Applications | Create/Update\"\n },\n {\n \"permission_comm_id\": \"75d2dd30-804e-44d2-982b-539e80acf01d\",\n \"display_name\": \"Create/Update Software\",\n \"code_name\": \"cu_assetsoftware\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Software | Create/Update\"\n },\n {\n \"permission_comm_id\": \"d3a2a1f3-211e-47c7-9816-a7ddbc20ce14\",\n \"display_name\": \"Create/Update Business Units\",\n \"code_name\": \"cu_businessunit\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Business Units | Create/Update\"\n },\n {\n \"permission_comm_id\": \"2f77ac13-35e3-45bd-bbf8-d603ab1aa55e\",\n \"display_name\": \"Create/Update Campaigns\",\n \"code_name\": \"cu_campaign\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Campaigns | Create/Update\"\n },\n {\n \"permission_comm_id\": \"fdb5138a-632a-4017-be6f-0f083f56936a\",\n \"display_name\": \"Create/Update Dashboards\",\n \"code_name\": \"cu_dashboard\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Dashboards | Create/Update\"\n },\n {\n \"permission_comm_id\": \"56b10a6e-c654-4abf-b334-ebb0e8f19696\",\n \"display_name\": \"Create/Update Devices\",\n \"code_name\": \"cu_device\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Devices | Create/Update\"\n },\n {\n \"permission_comm_id\": \"4b965004-f7e7-4347-8499-98ad5d00caa1\",\n \"display_name\": \"Create/Update Enhancements\",\n \"code_name\": \"cu_enhancement\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Enhancements | Create/Update\"\n },\n {\n \"permission_comm_id\": \"0feca461-4896-4532-930a-76c9c351f7c5\",\n \"display_name\": \"Create/Update Form Management\",\n \"code_name\": \"cu_formmanagement\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Form Management | Create/Update\"\n },\n {\n \"permission_comm_id\": \"15ba19bd-ec1c-4df1-b237-89479093e34c\",\n \"display_name\": \"Create/Update Users\",\n \"code_name\": \"cu_generaluser\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Users | Create/Update\"\n },\n {\n \"permission_comm_id\": \"6a4329a3-34fb-46ca-8b9b-71840b1aab70\",\n \"display_name\": \"Create/Update Incidents\",\n \"code_name\": \"cu_incident\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Incidents | Create/Update\"\n },\n {\n \"permission_comm_id\": \"8fdba603-a46b-4dac-aa9f-0eee2a843acb\",\n \"display_name\": \"Create/Update Knowledge Base\",\n \"code_name\": \"cu_document\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Knowledge Base | Create/Update\"\n },\n {\n \"permission_comm_id\": \"49c8aefb-491a-4868-92de-7635a9accac6\",\n \"display_name\": \"Create/Update Labels\",\n \"code_name\": \"cu_label\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Labels | Create/Update\"\n },\n {\n \"permission_comm_id\": \"bd718ce0-d722-4858-a0f1-f77e499d93f5\",\n \"display_name\": \"Create/Update Locations\",\n \"code_name\": \"cu_location\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Locations | Create/Update\"\n },\n {\n \"permission_comm_id\": \"caab819a-5848-40d6-8414-ea4668a7a5b2\",\n \"display_name\": \"Create/Update Malware\",\n \"code_name\": \"cu_malware\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Malware | Create/Update\"\n },\n {\n \"permission_comm_id\": \"2a7c89e0-44ce-4e99-b06b-e6f033b98155\",\n \"display_name\": \"Create/Update Manufacturers\",\n \"code_name\": \"cu_manufacturers\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Manufacturers | Create/Update\"\n },\n {\n \"permission_comm_id\": \"32a5a72b-2bbf-4c38-8791-ffe72aaa8a46\",\n \"display_name\": \"Create/Update OpenAPI\",\n \"code_name\": \"cu_openapi\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"OpenAPI | Create/Update\"\n },\n {\n \"permission_comm_id\": \"be9279e2-d3f1-44c3-aa2d-8baff9afa33f\",\n \"display_name\": \"Create/Update OS Types\",\n \"code_name\": \"cu_ostypes\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"OS Types | Create/Update\"\n },\n {\n \"permission_comm_id\": \"caa8396f-2da0-4195-91fd-b00449dfd9b2\",\n \"display_name\": \"Create/Update PIRs\",\n \"code_name\": \"cu_pir\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"PIRs | Create/Update\"\n },\n {\n \"permission_comm_id\": \"f935a35d-4fc5-4c3d-9477-6a236865ef55\",\n \"display_name\": \"Create/Update Playbooks\",\n \"code_name\": \"cu_playbook\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Playbooks | Create/Update\"\n },\n {\n \"permission_comm_id\": \"1317884e-2ed6-4c71-9a98-b926cef0c567\",\n \"display_name\": \"Create/Update Reports\",\n \"code_name\": \"cu_report\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Reports | Create/Update\"\n },\n {\n \"permission_comm_id\": \"a52e1b8c-6f58-454d-ba0c-064b990eb1c7\",\n \"display_name\": \"Create/Update SLA\",\n \"code_name\": \"cu_sla\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"SLA | Create/Update\"\n },\n {\n \"permission_comm_id\": \"b14ac6fd-6f0b-4f36-a33d-204b412b563b\",\n \"display_name\": \"Create/Update Sources\",\n \"code_name\": \"cu_source\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Sources | Create/Update\"\n },\n {\n \"permission_comm_id\": \"649b8fa1-4661-4af2-aabf-2cc352ec7066\",\n \"display_name\": \"Create/Update Threat Actors\",\n \"code_name\": \"cu_threatactor\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Threat Actors | Create/Update\"\n },\n {\n \"permission_comm_id\": \"03367f02-245f-4cda-81f4-c69177318bfb\",\n \"display_name\": \"Create/Update Threat Briefings\",\n \"code_name\": \"cu_briefing\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Threat Briefings | Create/Update\"\n },\n {\n \"permission_comm_id\": \"27f090f0-1309-4aba-b035-4124609345d6\",\n \"display_name\": \"Create/Update Threat Intel\",\n \"code_name\": \"cu_threatintel\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Threat Intel | Create/Update\"\n },\n {\n \"permission_comm_id\": \"1ac37a8a-0892-4200-bca2-c3449fb9cda1\",\n \"display_name\": \"Create/Update User Management\",\n \"code_name\": \"cu_user\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"User Management | Create/Update\"\n },\n {\n \"permission_comm_id\": \"b0f3c984-ddb7-4a51-bb79-493975f99145\",\n \"display_name\": \"Create/Update User Group Management\",\n \"code_name\": \"cu_usergroup\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"User Group Management | Create/Update\"\n },\n {\n \"permission_comm_id\": \"943895b2-5873-4e14-bac3-87814be88d61\",\n \"display_name\": \"Create/Update Vulnerabilities\",\n \"code_name\": \"cu_vulnerability\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Vulnerabilities | Create/Update\"\n },\n {\n \"permission_comm_id\": \"68fab426-8e25-457d-a6af-795612e41004\",\n \"display_name\": \"Create/Update Pause Incident\",\n \"code_name\": \"cu_pause_incident\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Pause Incident | Create/Update\"\n },\n {\n \"permission_comm_id\": \"aceb29a4-b262-46b4-9740-10c77cbede4c\",\n \"display_name\": \"Create/Update Merge Incidents\",\n \"code_name\": \"cu_merge_incident\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Merge Incidents | Create/Update\"\n },\n {\n \"permission_comm_id\": \"9bca84ae-dab7-43b1-a765-06d4e3906cd3\",\n \"display_name\": \"Create/Update Delete Untriaged Incidents\",\n \"code_name\": \"cu_delete_incident\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Delete Untriaged Incidents | Create/Update\"\n },\n {\n \"permission_comm_id\": \"20d90b20-16cf-438a-af70-7993c963a8e2\",\n \"display_name\": \"Create/Update Roster Management\",\n \"code_name\": \"cu_roster\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Roster Management | Create/Update\"\n },\n {\n \"permission_comm_id\": \"e49832c2-4900-4007-bf00-22806d6feb4e\",\n \"display_name\": \"Create/Update Configurations\",\n \"code_name\": \"cu_tenant_configuration\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Configurations | Create/Update\"\n },\n {\n \"permission_comm_id\": \"6d2aee3e-cf45-4b69-9e42-edf768533f48\",\n \"display_name\": \"Create/Update Version and License\",\n \"code_name\": \"cu_license\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Version and License | Create/Update\"\n },\n {\n \"permission_comm_id\": \"e49fe892-06fb-4fea-a688-b71698923ce9\",\n \"display_name\": \"Create/Update Email Customization\",\n \"code_name\": \"cu_custom_email_templates\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Email Customization | Create/Update\"\n },\n {\n \"permission_comm_id\": \"1622ff68-f3de-4bc6-a8cb-2f3611fc12f8\",\n \"display_name\": \"Create/Update API Request Logs\",\n \"code_name\": \"cu_request_logs\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"API Request Logs | Create/Update\"\n },\n {\n \"permission_comm_id\": \"34037569-d2e8-45e8-906c-5682ce1f8829\",\n \"display_name\": \"Create/Update Activity Logs\",\n \"code_name\": \"cu_user_activity_logs\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Activity Logs | Create/Update\"\n },\n {\n \"permission_comm_id\": \"9f73eabf-2eb3-44f2-8080-acd9b63d5b80\",\n \"display_name\": \"Create/Update Terminal\",\n \"code_name\": \"cu_terminal\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Terminal | Create/Update\"\n },\n {\n \"permission_comm_id\": \"4a2c497b-6e12-40e4-9c01-22836f149d4b\",\n \"display_name\": \"Create/Update Rule Engine\",\n \"code_name\": \"cu_rule_engine\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Rule Engine | Create/Update\"\n },\n {\n \"permission_comm_id\": \"a47a4151-f1e2-44aa-80dd-5d5977a23d20\",\n \"display_name\": \"Create/Update Action Library\",\n \"code_name\": \"cu_action_library\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Action Library | Create/Update\"\n }\n ],\n \"created_by\": {\n \"username\": \"system.default\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"9b0bb2dd-d2d3-4771-aaea-78b934681369\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System Default\"\n },\n \"user_count\": 1,\n \"permission_count\": 91,\n \"is_editable\": true,\n \"is_active\": true,\n \"created\": 1706077839,\n \"ciims_user_set\": [\n \"7dfb20cb-e6bf-449c-a731-3528344f47a6\"\n ],\n \"ciims_user_set_data\": [\n {\n \"user_id\": \"7dfb20cb-e6bf-449c-a731-3528344f47a6\",\n \"first_name\": \"john\",\n \"last_name\": \"doe\",\n \"email\": \"john.doe+4@example.com\",\n \"display_pic\": null,\n \"username\": \"johndoe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": false,\n \"full_name\": \"johndoe\"\n }\n ],\n \"group_cost\": 1,\n \"playbook_tags\": [],\n \"playbook_tags_data\": [],\n \"is_readonly_group\": false,\n \"readonly_selectable_update_perms\": [],\n \"saml_associated_groups\": []\n}"}],"_postman_id":"936ed818-1cb1-4e65-b699-7b99e03eea62"},{"name":"Create Group","id":"347a57d4-7a0d-48b7-9533-143cb0ce0bea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"permissions\": [\n {\n \"permission_comm_id\": \"3330e8af-f06a-4d25-92b5-a27b6c8f4c5e\",\n \"code_name\": \"view_action\"\n }\n ],\n \"group_name\": \"New Group\",\n \"description\": \"Group Description\",\n \"group_cost\": 300,\n \"ciims_user_set\": [\n \"3a437a20-1f40-47ee-be5e-13116a509cf4\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/rest-auth/permission/group/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Create a new User Group in your CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
`permissions`	List of Objects	Optional	Enter the list of permission objects for the user group.
`group_name`	String	Mandatory	Enter a name for the user group.
`description`	Text	Optional	Enter a description of the user group.
`group_cost`	String	Mandatory	Enter the analyst cost associated with the user group.
`ciims_user_set`	List of Strings	Optional	Enter the list of unique IDs of the users of the user group in UUID-4 format.

Request Parameters | Permissions Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
`permission_comm_id`	String	Mandatory	Enter the unique ID of the permission in UUID-4 format.
`code_name`	String	Mandatory	Enter the unique string of the permission.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`group_comm_id`	String	Unique ID of the User Group in UUID-4 format.
`group_name`	String	Name of the User Group.
`description`	Text	Description of the User Group.
`permissions`	List of Objects	List of permission objects of the User Group. Each object includes the details of one permission.
`created_by`	Object	Unique ID of the user who created the User Group.
`user_count`	Positive Integer	Number of users assigned to the User Group.
`permission_count`	Positive Integer	Count of the number of `permissions` configured for the User Group.
`is_active`	Boolean	Shows whether the User Group is currently active or not.
`created`	Integer	Creation date and time of the User Group in EPOCH time format.
`ciims_user_set`	List of Strings	List of unique IDs of the users assigned to the User Group in UUID-4 format.
`ciims_user_set_data`	List of Objects	Details of the users assigned to the User Group. Each object includes the details of one user.
`group_cost`	Float	Analyst cost associated with the users of the User Group. The default cost is configured as per the daily rate.
`playbook_tags`	List of Strings	List of unique IDs of the Cyware Orchestrate Playbook tags added to the User Group in UUID-4 format.
`playbook_tags_data`	List of Objects	Details of the Playbook tags. Each object includes the details of one Playbook tag.
`is_readonly_group`	Boolean	Shows whether the group has read only access only.
`saml_associated_groups`	List of Strings	Displays the list of associated SAML groups with the user group.

Response Parameters | Permissions Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`permission_comm_id`	String	Unique ID of the permission in UUID-4 format.
`display_name`	String	Display name of the permission.
`code_name`	String	Unique string of the permission.
`grant`	String	Level of grant associated with each permission in CFTR. Allowed values: -`ALLOWED:` Permissions that are provided by default. -`DISALLOWED:` Permissions that cannot be provided while creating a group. -`SELECTABLE:` Permission that can be configured while creating a group.
`verbose_name`	String	Verbose name given to the permission.

Response Parameters | Created By and CIIMS User Set Data Objects

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`username`	String	Username of the user.
`first_name`	String	First name of the user.
`last_name`	String	Last name of the user.
`profile_background_color`	String	Hex value of the user profile background color.
`user_id`	String	Unique ID of the user in UUID-4 format.
`display_pic`	String	Link to the display picture of the user.
`is_active`	Boolean	Shows whether the user is an active user or not.
`email`	String	Email ID of the user.
`full_name`	String	Full name of the user.

Response Parameters | Playbook Tags Data Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the Playbook in UUID-4 format.
`title`	String	Title of the Playbook.
`description`	Text	Description of the Playbook.

Example Error Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Description
400	`code_name` is required. `permission_comm_id` is required. `group_name` should be unique. `code_name` and `permission_comm_id` should be valid.

","urlObject":{"path":["rest-auth","permission","group",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"0817d5d7-3e1c-42c0-b89f-bf79cc1e7201","name":"Eg: Create a new Group","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}","disabled":true}],"body":{"mode":"raw","raw":"{\n \"permissions\": [\n {\n \"permission_comm_id\": \"3330e8af-f06a-4d25-92b5-a27b6c8f4c5e\",\n \"code_name\": \"view_action\"\n }\n ],\n \"group_name\": \"New Group\",\n \"description\": \"Group Description\",\n \"group_cost\": 300,\n \"ciims_user_set\": [\n \"3a437a20-1f40-47ee-be5e-13116a509cf4\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/rest-auth/permission/group/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["rest-auth","permission","group",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Thu, 24 Feb 2022 06:49:59 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"3297","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, PATCH, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"group_comm_id\": \"5bc94b8e-cbb0-4a5f-9279-0fbfdd29e7a1\",\n \"group_name\": \"New Group\",\n \"group_email\": null,\n \"description\": \"Group Description\",\n \"permissions\": [\n {\n \"permission_comm_id\": \"7ad5da36-00ce-4baf-9550-4a84fed4e63f\",\n \"display_name\": \"View Locations\",\n \"code_name\": \"view_location\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Locations | View\"\n },\n {\n \"permission_comm_id\": \"814528c7-6eb2-4814-83a8-2bc403f783e5\",\n \"display_name\": \"View Merge Incidents\",\n \"code_name\": \"view_merge_incident\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Merge Incidents | View\"\n },\n {\n \"permission_comm_id\": \"7245d5f0-634a-4579-8cde-a7c4bd80c260\",\n \"display_name\": \"View Delete Untriaged Incidents\",\n \"code_name\": \"view_delete_incident\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Delete Untriaged Incidents | View\"\n },\n {\n \"permission_comm_id\": \"bbc1df75-6c3b-47b3-9f14-20e32a3693df\",\n \"display_name\": \"View Business Units\",\n \"code_name\": \"view_businessunit\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Business Units | View\"\n },\n {\n \"permission_comm_id\": \"9d214fd5-73ee-4aa0-8d7a-c27f0d82a04a\",\n \"display_name\": \"View Manufacturers\",\n \"code_name\": \"view_manufacturers\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Manufacturers | View\"\n },\n {\n \"permission_comm_id\": \"17bde088-d9dc-4f0f-bf17-e6012f4afd19\",\n \"display_name\": \"View Threat Intel\",\n \"code_name\": \"view_threatintel\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Threat Intel | View\"\n },\n {\n \"permission_comm_id\": \"8ecaca57-1043-430e-964f-f62f43b5fc98\",\n \"display_name\": \"View Labels\",\n \"code_name\": \"view_label\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Labels | View\"\n },\n {\n \"permission_comm_id\": \"3330e8af-f06a-4d25-92b5-a27b6c8f4c5e\",\n \"display_name\": \"View Actions\",\n \"code_name\": \"view_action\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Actions | View\"\n },\n {\n \"permission_comm_id\": \"1494db74-abd6-41eb-91a5-67e701aa5770\",\n \"display_name\": \"View Pause Incident\",\n \"code_name\": \"view_pause_incident\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Pause Incident | View\"\n },\n {\n \"permission_comm_id\": \"f8897569-1fee-4e91-b42b-3d90866bc3a3\",\n \"display_name\": \"View Dashboards\",\n \"code_name\": \"view_dashboard\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Dashboards | View\"\n },\n {\n \"permission_comm_id\": \"6e835cd0-381f-489e-bb44-e6b9f9edc26b\",\n \"display_name\": \"View Sources\",\n \"code_name\": \"view_source\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Sources | View\"\n },\n {\n \"permission_comm_id\": \"dd17e52f-206c-4879-92bd-c858ee43a4c5\",\n \"display_name\": \"View OS Types\",\n \"code_name\": \"view_ostypes\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"OS Types | View\"\n },\n {\n \"permission_comm_id\": \"b37d9ff9-63dd-4c1b-a977-d82438870f65\",\n \"display_name\": \"Create/Update Threat Intel\",\n \"code_name\": \"cu_threatintel\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Threat Intel | Create/Update\"\n }\n ],\n \"created_by\": {\n \"username\": \"johndoe\",\n \"first_name\": \"john\",\n \"last_name\": \"doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"3a437a20-1f40-47ee-be5e-13116a509cf4\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"john.doe@example.com\",\n \"full_name\": \"john doe\"\n },\n \"user_count\": 1,\n \"permission_count\": 13,\n \"is_editable\": true,\n \"is_active\": true,\n \"created\": 1645685399,\n \"ciims_user_set\": [\n \"3a437a20-1f40-47ee-be5e-13116a509cf4\"\n ],\n \"ciims_user_set_data\": [\n {\n \"user_id\": \"3a437a20-1f40-47ee-be5e-13116a509cf4\",\n \"first_name\": \"john\",\n \"last_name\": \"doe\",\n \"email\": \"john.doe@example.com\",\n \"display_pic\": null,\n \"username\": \"johndoe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"john doe\"\n }\n ],\n \"group_cost\": 300,\n \"playbook_tags\": [],\n \"playbook_tags_data\": []\n}"}],"_postman_id":"347a57d4-7a0d-48b7-9533-143cb0ce0bea"},{"name":"Update Group","id":"74fffecd-140e-4be5-a155-a395386b6e3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"permissions\": [\n {\n \"permission_comm_id\": \"075179a0-a55e-40e7-a235-d73710cf29cb\",\n \"code_name\": \"view_networkutility\"\n },\n {\n \"permission_comm_id\": \"ae3d5a3b-8e0c-48ac-b85b-21a729264d4d\",\n \"code_name\": \"view_fangdefang\"\n }\n ],\n \"group_name\": \"Updated Group\",\n \"description\": \"Updated Group Description\"\n\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/rest-auth/permission/group/:group_comm_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Update the details of a User Group in your CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
`permissions`	List of Objects	Optional	Enter the list of permission objects for the User Group.
`group_name`	String	Optional	Enter a name for the User Group.
`description`	Text	Optional	Enter a description of the User Group.
`group_cost`	String	Optional	Enter the analyst cost associated with the User Group.
`ciims_user_set`	List of Strings	Optional	Enter the list of unique IDs of the users of the User Group in UUID-4 format.

Request Parameters | Permissions Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
`permission_comm_id`	String	Mandatory	Enter the unique ID of the permission in UUID-4 format.
`code_name`	String	Mandatory	Enter the unique string of the permission.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`group_comm_id`	String	Unique ID of the User Group in UUID-4 format.
`group_name`	String	Name of the User Group.
`description`	Text	Description of the User Group.
`permissions`	List of Objects	List of permission objects of the User Group. Each object includes the details of one permission.
`created_by`	Object	Unique ID of the user who created the User Group.
`user_count`	Positive Integer	Number of users assigned to the User Group.
`permission_count`	Positive Integer	Count of the number of `permissions` configured for the User Group.
`is_active`	Boolean	Shows whether the User Group is currently active or not.
`is_editable`	Boolean	Shows whether the user group is editable or not.
`created`	Integer	Creation date and time of the User Group in EPOCH time format.
`ciims_user_set`	List of Strings	List of unique IDs of the users assigned to the User Group in UUID-4 format.
`ciims_user_set_data`	List of Objects	Details of the users assigned to the User Group. Each object includes the details of one user.
`group_cost`	Float	Analyst cost associated with the users of the User Group. The default cost is configured as per the daily rate.
`playbook_tags`	List of Strings	List of unique IDs of the Cyware Orchestrate Playbook tags added to the User Group in UUID-4 format.
`playbook_tags_data`	List of Objects	Details of the Playbook tags. Each object includes the details of one Playbook tag.
`is_readonly_group`	Boolean	Shows whether the user group has read only access.
`saml_associated_groups`	List of Strings	Displays the list of associated SAML groups with the user group.

Response Parameters | Permissions Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`permission_comm_id`	String	Unique ID of the permission in UUID-4 format.
`display_name`	String	Display name of the permission.
`code_name`	String	Unique string of the permission.
`grant`	String	Level of grant associated with each permission in CFTR. Allowed values: -`ALLOWED:` Permissions that are provided by default. -`DISALLOWED:` Permissions that cannot be provided while creating a group. -`SELECTABLE:` Permission that can be configured while creating a group.
`verbose_name`	String	Verbose name given to the permission.

Response Parameters | Created By and CIIMS User Set Data Objects

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`username`	String	Username of the user.
`first_name`	String	First name of the user.
`last_name`	String	Last name of the user.
`profile_background_color`	String	Hex value of the user profile background color.
`user_id`	String	Unique ID of the user in UUID-4 format.
`display_pic`	String	Link to the display picture of the user.
`is_active`	Boolean	Shows whether the user is an active user or not.
`email`	String	Email ID of the user.
`full_name`	String	Full name of the user.

Response Parameters | Playbook Tags Data Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the Playbook in UUID-4 format.
`title`	String	Title of the Playbook.
`description`	Text	Description of the Playbook.

Example Error Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Description
400	`code_name` is required. `permission_comm_id` is required. `group_name` should be unique.

Enter the unique ID of the Group in UUID-4 format

\n","type":"text/plain"},"type":"any","value":"5bc94b8e-cbb0-4a5f-9279-0fbfdd29e7a1","key":"group_comm_id"}]}},"response":[{"id":"820cb221-233b-470d-b5a1-6f112bf5bfc4","name":"Eg: Update group name and description of a Group","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}","disabled":true}],"body":{"mode":"raw","raw":"{\n \"group_name\": \"Updated Group\",\n \"description\": \"Updated Group Description\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/rest-auth/permission/group/:group_comm_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["rest-auth","permission","group",":group_comm_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"group_comm_id","value":"5bc94b8e-cbb0-4a5f-9279-0fbfdd29e7a1","description":"Enter the unique ID of the Group in UUID-4 format"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Thu, 24 Feb 2022 08:08:19 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"3138","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, PATCH, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"group_comm_id\": \"5bc94b8e-cbb0-4a5f-9279-0fbfdd29e7a1\",\n \"group_name\": \"Updated Group\",\n \"group_email\": null,\n \"description\": \"Updated Group Description\",\n \"permissions\": [\n {\n \"permission_comm_id\": \"7ad5da36-00ce-4baf-9550-4a84fed4e63f\",\n \"display_name\": \"View Locations\",\n \"code_name\": \"view_location\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Locations | View\"\n },\n {\n \"permission_comm_id\": \"814528c7-6eb2-4814-83a8-2bc403f783e5\",\n \"display_name\": \"View Merge Incidents\",\n \"code_name\": \"view_merge_incident\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Merge Incidents | View\"\n },\n {\n \"permission_comm_id\": \"7245d5f0-634a-4579-8cde-a7c4bd80c260\",\n \"display_name\": \"View Delete Untriaged Incidents\",\n \"code_name\": \"view_delete_incident\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Delete Untriaged Incidents | View\"\n },\n {\n \"permission_comm_id\": \"bbc1df75-6c3b-47b3-9f14-20e32a3693df\",\n \"display_name\": \"View Business Units\",\n \"code_name\": \"view_businessunit\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Business Units | View\"\n },\n {\n \"permission_comm_id\": \"9d214fd5-73ee-4aa0-8d7a-c27f0d82a04a\",\n \"display_name\": \"View Manufacturers\",\n \"code_name\": \"view_manufacturers\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Manufacturers | View\"\n },\n {\n \"permission_comm_id\": \"17bde088-d9dc-4f0f-bf17-e6012f4afd19\",\n \"display_name\": \"View Threat Intel\",\n \"code_name\": \"view_threatintel\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Threat Intel | View\"\n },\n {\n \"permission_comm_id\": \"8ecaca57-1043-430e-964f-f62f43b5fc98\",\n \"display_name\": \"View Labels\",\n \"code_name\": \"view_label\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Labels | View\"\n },\n {\n \"permission_comm_id\": \"1494db74-abd6-41eb-91a5-67e701aa5770\",\n \"display_name\": \"View Pause Incident\",\n \"code_name\": \"view_pause_incident\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Pause Incident | View\"\n },\n {\n \"permission_comm_id\": \"f8897569-1fee-4e91-b42b-3d90866bc3a3\",\n \"display_name\": \"View Dashboards\",\n \"code_name\": \"view_dashboard\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Dashboards | View\"\n },\n {\n \"permission_comm_id\": \"6e835cd0-381f-489e-bb44-e6b9f9edc26b\",\n \"display_name\": \"View Sources\",\n \"code_name\": \"view_source\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Sources | View\"\n },\n {\n \"permission_comm_id\": \"dd17e52f-206c-4879-92bd-c858ee43a4c5\",\n \"display_name\": \"View OS Types\",\n \"code_name\": \"view_ostypes\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"OS Types | View\"\n },\n {\n \"permission_comm_id\": \"b37d9ff9-63dd-4c1b-a977-d82438870f65\",\n \"display_name\": \"Create/Update Threat Intel\",\n \"code_name\": \"cu_threatintel\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Threat Intel | Create/Update\"\n }\n ],\n \"created_by\": {\n \"username\": \"johndoe\",\n \"first_name\": \"john\",\n \"last_name\": \"doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"3a437a20-1f40-47ee-be5e-13116a509cf4\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"john.doe@example.com\",\n \"full_name\": \"john doe\"\n },\n \"user_count\": 1,\n \"permission_count\": 12,\n \"is_editable\": true,\n \"is_active\": true,\n \"created\": 1645685399,\n \"ciims_user_set\": [\n \"3a437a20-1f40-47ee-be5e-13116a509cf4\"\n ],\n \"ciims_user_set_data\": [\n {\n \"user_id\": \"3a437a20-1f40-47ee-be5e-13116a509cf4\",\n \"first_name\": \"john\",\n \"last_name\": \"doe\",\n \"email\": \"john.doe@example.com\",\n \"display_pic\": null,\n \"username\": \"johndoe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"john doe\"\n }\n ],\n \"group_cost\": 300,\n \"playbook_tags\": [],\n \"playbook_tags_data\": []\n}"},{"id":"0c4b6330-50f4-4e4f-855c-d5a7b608cb6c","name":"Eg: Update Group with \"View Network Utility\" and \"View Fang-Defang\" permissions","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}","disabled":true}],"body":{"mode":"raw","raw":"{\n \"permissions\": [\n {\n \"permission_comm_id\": \"075179a0-a55e-40e7-a235-d73710cf29cb\",\n \"code_name\": \"view_networkutility\"\n },\n {\n \"permission_comm_id\": \"ae3d5a3b-8e0c-48ac-b85b-21a729264d4d\",\n \"code_name\": \"view_fangdefang\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/rest-auth/permission/group/:group_comm_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["rest-auth","permission","group",":group_comm_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"group_comm_id","value":"5bc94b8e-cbb0-4a5f-9279-0fbfdd29e7a1","description":"Enter the unique ID of the Group in UUID-4 format"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Thu, 24 Feb 2022 08:13:43 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"3516","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, PATCH, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"group_comm_id\": \"5bc94b8e-cbb0-4a5f-9279-0fbfdd29e7a1\",\n \"group_name\": \"Updated Group\",\n \"group_email\": null,\n \"description\": \"Updated Group Description\",\n \"permissions\": [\n {\n \"permission_comm_id\": \"7ad5da36-00ce-4baf-9550-4a84fed4e63f\",\n \"display_name\": \"View Locations\",\n \"code_name\": \"view_location\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Locations | View\"\n },\n {\n \"permission_comm_id\": \"814528c7-6eb2-4814-83a8-2bc403f783e5\",\n \"display_name\": \"View Merge Incidents\",\n \"code_name\": \"view_merge_incident\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Merge Incidents | View\"\n },\n {\n \"permission_comm_id\": \"ae3d5a3b-8e0c-48ac-b85b-21a729264d4d\",\n \"display_name\": \"View Fang-Defang\",\n \"code_name\": \"view_fangdefang\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Fang-Defang | View\"\n },\n {\n \"permission_comm_id\": \"075179a0-a55e-40e7-a235-d73710cf29cb\",\n \"display_name\": \"View Network Utility\",\n \"code_name\": \"view_networkutility\",\n \"grant\": \"SELECTABLE\",\n \"verbose_name\": \"Network Utility | View\"\n },\n {\n \"permission_comm_id\": \"7245d5f0-634a-4579-8cde-a7c4bd80c260\",\n \"display_name\": \"View Delete Untriaged Incidents\",\n \"code_name\": \"view_delete_incident\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Delete Untriaged Incidents | View\"\n },\n {\n \"permission_comm_id\": \"bbc1df75-6c3b-47b3-9f14-20e32a3693df\",\n \"display_name\": \"View Business Units\",\n \"code_name\": \"view_businessunit\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Business Units | View\"\n },\n {\n \"permission_comm_id\": \"9d214fd5-73ee-4aa0-8d7a-c27f0d82a04a\",\n \"display_name\": \"View Manufacturers\",\n \"code_name\": \"view_manufacturers\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Manufacturers | View\"\n },\n {\n \"permission_comm_id\": \"17bde088-d9dc-4f0f-bf17-e6012f4afd19\",\n \"display_name\": \"View Threat Intel\",\n \"code_name\": \"view_threatintel\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Threat Intel | View\"\n },\n {\n \"permission_comm_id\": \"8ecaca57-1043-430e-964f-f62f43b5fc98\",\n \"display_name\": \"View Labels\",\n \"code_name\": \"view_label\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Labels | View\"\n },\n {\n \"permission_comm_id\": \"1494db74-abd6-41eb-91a5-67e701aa5770\",\n \"display_name\": \"View Pause Incident\",\n \"code_name\": \"view_pause_incident\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Pause Incident | View\"\n },\n {\n \"permission_comm_id\": \"f8897569-1fee-4e91-b42b-3d90866bc3a3\",\n \"display_name\": \"View Dashboards\",\n \"code_name\": \"view_dashboard\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Dashboards | View\"\n },\n {\n \"permission_comm_id\": \"6e835cd0-381f-489e-bb44-e6b9f9edc26b\",\n \"display_name\": \"View Sources\",\n \"code_name\": \"view_source\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Sources | View\"\n },\n {\n \"permission_comm_id\": \"dd17e52f-206c-4879-92bd-c858ee43a4c5\",\n \"display_name\": \"View OS Types\",\n \"code_name\": \"view_ostypes\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"OS Types | View\"\n },\n {\n \"permission_comm_id\": \"b37d9ff9-63dd-4c1b-a977-d82438870f65\",\n \"display_name\": \"Create/Update Threat Intel\",\n \"code_name\": \"cu_threatintel\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Threat Intel | Create/Update\"\n }\n ],\n \"created_by\": {\n \"username\": \"johndoe\",\n \"first_name\": \"john\",\n \"last_name\": \"doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"3a437a20-1f40-47ee-be5e-13116a509cf4\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"john.doe@example.com\",\n \"full_name\": \"john doe\"\n },\n \"user_count\": 1,\n \"permission_count\": 14,\n \"is_editable\": true,\n \"is_active\": true,\n \"created\": 1645685399,\n \"ciims_user_set\": [\n \"3a437a20-1f40-47ee-be5e-13116a509cf4\"\n ],\n \"ciims_user_set_data\": [\n {\n \"user_id\": \"3a437a20-1f40-47ee-be5e-13116a509cf4\",\n \"first_name\": \"john\",\n \"last_name\": \"doe\",\n \"email\": \"john.doe@example.com\",\n \"display_pic\": null,\n \"username\": \"johndoe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"john doe\"\n }\n ],\n \"group_cost\": 300,\n \"playbook_tags\": [],\n \"playbook_tags_data\": []\n}"},{"id":"1397553c-36c9-4e28-b3c5-33151972fc36","name":"Eg: Update Group with default granted permissions","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}","disabled":true}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/rest-auth/permission/group/:group_comm_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["rest-auth","permission","group",":group_comm_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"group_comm_id","value":"5bc94b8e-cbb0-4a5f-9279-0fbfdd29e7a1","description":"Enter the unique ID of the Group in UUID-4 format"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Thu, 24 Feb 2022 08:15:36 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"3138","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, PATCH, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"group_comm_id\": \"5bc94b8e-cbb0-4a5f-9279-0fbfdd29e7a1\",\n \"group_name\": \"Updated Group\",\n \"group_email\": null,\n \"description\": \"Updated Group Description\",\n \"permissions\": [\n {\n \"permission_comm_id\": \"7ad5da36-00ce-4baf-9550-4a84fed4e63f\",\n \"display_name\": \"View Locations\",\n \"code_name\": \"view_location\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Locations | View\"\n },\n {\n \"permission_comm_id\": \"814528c7-6eb2-4814-83a8-2bc403f783e5\",\n \"display_name\": \"View Merge Incidents\",\n \"code_name\": \"view_merge_incident\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Merge Incidents | View\"\n },\n {\n \"permission_comm_id\": \"7245d5f0-634a-4579-8cde-a7c4bd80c260\",\n \"display_name\": \"View Delete Untriaged Incidents\",\n \"code_name\": \"view_delete_incident\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Delete Untriaged Incidents | View\"\n },\n {\n \"permission_comm_id\": \"bbc1df75-6c3b-47b3-9f14-20e32a3693df\",\n \"display_name\": \"View Business Units\",\n \"code_name\": \"view_businessunit\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Business Units | View\"\n },\n {\n \"permission_comm_id\": \"9d214fd5-73ee-4aa0-8d7a-c27f0d82a04a\",\n \"display_name\": \"View Manufacturers\",\n \"code_name\": \"view_manufacturers\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Manufacturers | View\"\n },\n {\n \"permission_comm_id\": \"17bde088-d9dc-4f0f-bf17-e6012f4afd19\",\n \"display_name\": \"View Threat Intel\",\n \"code_name\": \"view_threatintel\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Threat Intel | View\"\n },\n {\n \"permission_comm_id\": \"8ecaca57-1043-430e-964f-f62f43b5fc98\",\n \"display_name\": \"View Labels\",\n \"code_name\": \"view_label\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Labels | View\"\n },\n {\n \"permission_comm_id\": \"1494db74-abd6-41eb-91a5-67e701aa5770\",\n \"display_name\": \"View Pause Incident\",\n \"code_name\": \"view_pause_incident\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Pause Incident | View\"\n },\n {\n \"permission_comm_id\": \"f8897569-1fee-4e91-b42b-3d90866bc3a3\",\n \"display_name\": \"View Dashboards\",\n \"code_name\": \"view_dashboard\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Dashboards | View\"\n },\n {\n \"permission_comm_id\": \"6e835cd0-381f-489e-bb44-e6b9f9edc26b\",\n \"display_name\": \"View Sources\",\n \"code_name\": \"view_source\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Sources | View\"\n },\n {\n \"permission_comm_id\": \"dd17e52f-206c-4879-92bd-c858ee43a4c5\",\n \"display_name\": \"View OS Types\",\n \"code_name\": \"view_ostypes\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"OS Types | View\"\n },\n {\n \"permission_comm_id\": \"b37d9ff9-63dd-4c1b-a977-d82438870f65\",\n \"display_name\": \"Create/Update Threat Intel\",\n \"code_name\": \"cu_threatintel\",\n \"grant\": \"ALLOWED\",\n \"verbose_name\": \"Threat Intel | Create/Update\"\n }\n ],\n \"created_by\": {\n \"username\": \"johndoe\",\n \"first_name\": \"john\",\n \"last_name\": \"doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"3a437a20-1f40-47ee-be5e-13116a509cf4\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"john.doe@example.com\",\n \"full_name\": \"john doe\"\n },\n \"user_count\": 1,\n \"permission_count\": 12,\n \"is_editable\": true,\n \"is_active\": true,\n \"created\": 1645685399,\n \"ciims_user_set\": [\n \"3a437a20-1f40-47ee-be5e-13116a509cf4\"\n ],\n \"ciims_user_set_data\": [\n {\n \"user_id\": \"3a437a20-1f40-47ee-be5e-13116a509cf4\",\n \"first_name\": \"john\",\n \"last_name\": \"doe\",\n \"email\": \"john.doe@example.com\",\n \"display_pic\": null,\n \"username\": \"johndoe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"john doe\"\n }\n ],\n \"group_cost\": 300,\n \"playbook_tags\": [],\n \"playbook_tags_data\": []\n}"}],"_postman_id":"74fffecd-140e-4be5-a155-a395386b6e3a"}],"id":"a921f931-7814-4486-9a0f-012e7a7baab9","description":"

User Groups enables CFTR admins to categorize users into various functional groups and assign permissions based on the functional requirements of the groups.

This section describes how to use the API endpoints to manage the CFTR User Groups.

\n","_postman_id":"a921f931-7814-4486-9a0f-012e7a7baab9"},{"name":"Version and License","item":[{"name":"Get Version and License Details","id":"9447cef5-39eb-4e15-856d-05c2c4084828","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/tenant/license/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the version and license details of your CFTR application.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	Title of the application.
`tenant_code`	String	The tenant code of the CFTR application.
`license_key`	String	License key of the application.
`readonly_users_count`	Integer	Number of read-only users.
`license_expiry_time`	String	License expiration date and time in ISO format.
`num_of_allowed_users`	Integer	Maximum number of allowed active users in the application.
`num_of_allowed_readonly_users`	Integer	Number of allowed readonly users in the application.
`current_users_count`	Integer	Number of active users in the application.
`platform_version`	String	Current Version of the application.
`tenant_name`	String	The tenant name.
`number_of_business_units`	Integer	Number of business units the application has.
`number_of_incidents_per_day`	Integer	Number of incidents created per day.
`number_of_child_tenants`	Integer	Number of child tenants associated with the application.
`requested_license_upgrade`	Boolean	Shows if whether requested for license upgrade or not.

","urlObject":{"path":["tenant","license",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"06a46e93-f338-4523-9af8-de9fc3652223","name":"Get Version and License Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/tenant/license/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["tenant","license",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 25 Jan 2024 11:28:27 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: http: data: blob:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"tenant_code\": \"cftr-13404\",\n \"license_key\": \"5c93b406-6adf-4c5e-b816-6b21b9bfe3e6\",\n \"license_expiry_time\": \"2024-01-28T23:59:59Z\",\n \"num_of_allowed_users\": 100,\n \"num_of_allowed_readonly_users\": null,\n \"license_type\": null,\n \"current_users_count\": 1,\n \"readonly_users_count\": 0,\n \"platform_version\": \"3.0.0.0\",\n \"last_commit_time\": \"2024-01-24T17:15:06+05:30\",\n \"tenant_name\": \"cftr-13404\",\n \"backend_version_time\": \"2024-01-24T17:15:06+05:30\",\n \"requested_license_upgrade\": false,\n \"title\": \"CFTR Enterprise\",\n \"number_of_child_tenants\": 0,\n \"number_of_business_units\": 0,\n \"current_child_tenants_count\": 0,\n \"current_business_units_count\": 6,\n \"number_of_incidents_per_day\": 0\n}"}],"_postman_id":"9447cef5-39eb-4e15-856d-05c2c4084828"}],"id":"c53fde87-dbc7-4534-b15b-6a07459efae7","_postman_id":"c53fde87-dbc7-4534-b15b-6a07459efae7","description":""},{"name":"Admin Logs","item":[{"name":"List Activity Logs","id":"707c7619-0f0e-4504-8330-69f09a21e647","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/activity-log/user-activity-logs/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve a list of activity logs from the admin logs.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

Response Parameters | Per Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`tenant_id`	String	Unique ID of the tenant in UUID-4 format.
`user`	String	Username of the user who triggered the log.
`action`	String	User action, such as create, update, and so on.
`object_type`	String	Type of the object added. For example, form tabs.
`object_display_name`	String	Name of the object, such as the title of an incident.
`first_name`	String	First name of the user who triggered the log.
`last_name`	String	Last name of the user who triggered the log.
`component_display_name`	String	Name of the updated module. For example, Form Management.
`created`	String	Creation date and time of the log.
`timestamp`	Double	Timestamp of when the action was peformed by the user in EPOCH time format.
`user_display_pic`	String	Base 64 encoded string that can be decoded to show user profile picutre.
`sentence_html`	String	HTML sentence as shown in the CFTR frontend.
`object_id`	String	Unique ID of the object for which the log is created in UUID-4 format.
`timestamp_ms`	Double	Timestamp of when the action was peformed by the user. This also inlcudes the milliseconds.
`user_profile_background_color`	String	Hex key of the background color of the user profile.
`user_display_pic`	String	Link to the display picture of the user.

","urlObject":{"path":["activity-log","user-activity-logs",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"disabled":true,"description":{"content":"

[string] [optional] Enter the module name to retrieve the activity logs of a specific module. For example, incident,action,malware, and so on.

\n","type":"text/plain"},"key":"component","value":"action"},{"disabled":true,"description":{"content":"

[string] [optional] Enter the username to retrieve the activity logs of a specific user.

\n","type":"text/plain"},"key":"user","value":"pooja_b"}],"variable":[]}},"response":[{"id":"7fe0a27d-e3b4-4155-b10a-05071967fa05","name":"Get List of Activity Logs of a specifc component","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/activity-log/user-activity-logs/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&component=action","host":["{{base_url}}v1"],"path":["activity-log","user-activity-logs",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"component","value":"action","description":"[string] [optional] Query to fetch the activity logs of specific component e.g incident,action,malware"},{"key":"user","value":"john.doe","description":"[string] [optional] Query for a specifc user activity logs","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 Jun 2022 06:57:29 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"730","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"[\n {\n \"tenant_id\": \"a107d53c-ef3d-433d-ae9f-f7e98257653f\",\n \"user\": \"john.doe\",\n \"action\": \"CREATE\",\n \"object_ctype\": 51,\n \"object_id\": \"c22f6074-d398-4f6c-8225-c3f08593f26e\",\n \"object_display_name\": \"(ACT101) sdbn\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"component_display_name\": \"Action\",\n \"object_type\": \"action\",\n \"created\": \"2022-06-05T07:03:06.692782+00:00\",\n \"timestamp\": 1654412586,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"sentence_html\": \"@system.default created Action (ACT101) sdbn\"\n }\n]"}],"_postman_id":"707c7619-0f0e-4504-8330-69f09a21e647"},{"name":"List API Request Logs","id":"aa024487-8b2d-43e3-9404-9c2826346204","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/utils/request-log/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve a list of API request logs from the admin logs.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` shows the API endpoint to the next page.
`count`	Integer	Total number of API request logs in the CFTR application as per the query parameters.
`results`	List of Objects	Details of the API request logs. Each object provides details of one API request log.

Response Parameters | Results Object

Parameter	Type	Description
`request_log_id`	String	Unique ID of the request log.
`tenant_id`	String	Unique ID of the tenant in UUID format.
`server_url`	String	Server URL of the instance.
`user_id`	String	Unique ID of the tenant in UUID format.
`username`	String	Username of the user who requested the API.
`request_method`	String	Request method of the API. For example, GET.
`user_ip_address`	String	IP address of the user who requested for API logs.
`request_full_path`	String	Actual API that is requested with the query parameters.
`request_timestamp`	Double	Request timestamp in EPOCH time format.
`response_timestamp`	Double	Response timestamp in EPOCH time format.
`request_timestamp_readable`	String	Request timestamp in a readable format in the UTC timezone.
`response_timestamp_readable`	String	Response timestamp in a readable format in the UTC timezone.
`request_path`	String	Actual API that is requested without the server URL.
`request_query_path`	String	Actual API which is being called without server url
`error_response_data`	Text	Error traceback of the API if there is any error
`transaction_id`	String	Unique id of the api transaction in UUID format
`error_traceback`	Text	Error traceback of the API if there is an error.
`log_type`	String	Type of the log. For example, SUCCESS and ERROR.
`duration`	Float	Time taken by the API to respond.
`query_params_text`	String	Query params of the API request.
`response_status_code`	Integer	Status code of API request.
`user_agent`	String	Browser or machine configuration of the user requesting the API.

","urlObject":{"path":["utils","request-log",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"disabled":true,"description":{"content":"

[optional] [string] Enter the API request method.

\n","type":"text/plain"},"key":"request_method","value":"GET"},{"disabled":true,"description":{"content":"

[optional] [string] Enter the username of a user.

\n","type":"text/plain"},"key":"username","value":"john"},{"disabled":true,"description":{"content":"

[optional] [integer] Enter the response status code of the API requests.

\n","type":"text/plain"},"key":"response_status_code","value":"200"},{"disabled":true,"description":{"content":"

[optional] [float] Enter a timestamp in EPOCH format to retrieve the request logs that are requested after this time.

\n","type":"text/plain"},"key":"request_timestamp__gte","value":"1655801151.348171"},{"disabled":true,"description":{"content":"

[optional] [float] Enter a timestamp in EPOCH format to retrieve the request logs that are requested before this time.

\n","type":"text/plain"},"key":"request_timestamp__lte","value":"1655801151.348171"}],"variable":[]}},"response":[{"id":"30c3f6dd-dbcd-4d67-b0a4-e3fe3a517856","name":"Get list of API Request Logs","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/utils/request-log/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["utils","request-log",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"request_method","value":"GET","description":"[optional] [string] Query for only GET,POST requests","disabled":true},{"key":"username","value":"john","description":"[optional] [string] Query all logs for this user","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 Jun 2022 06:59:17 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"11757","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {\n \"next\": \"openapi/v1/utils/request-log/?page=2&page_size=10&AccessID=99d034bb-863c-4d65-876f-b705730eaad4&Expires=1655794771&Signature=M2qTrBgOI/jXcr0RomVijEQfJ1w=\"\n },\n \"count\": 15273,\n \"results\": [\n {\n \"request_log_id\": \"PrQNhYEBUR1QOHIdwMkO\",\n \"tenant_id\": \"a107d53c-ef3d-433d-ae9f-f7e98257653f\",\n \"server_url\": \"https://abc.com/cftrapi/\",\n \"user_id\": \"3efcdba6-83a8-4921-a11c-4530d1d31947\",\n \"username\": \"john\",\n \"user_ip_address\": \"172.18.0.1\",\n \"request_method\": \"GET\",\n \"request_full_path\": \"https://abc.com/cftrapi/openapi/v1/activity-log/user-activity-logs/?AccessID=99d034bb-863c-4d65-876f-b705730eaad4&Expires=1655794695&Signature=6AQB1dlAulToVSFoVDnL6abTdNs%3D&user=john.doe\",\n \"request_timestamp\": 1655794679.682828,\n \"request_timestamp_readable\": \"2022-06-21 06:57:59 +0000\",\n \"response_timestamp\": 1655794679.811165,\n \"response_timestamp_readable\": \"2022-06-21 06:57:59 +0000\",\n \"response_status_code\": 200,\n \"user_agent\": \"PostmanRuntime/7.29.0\",\n \"request_path\": \"/openapi/v1/activity-log/user-activity-logs/?AccessID=99d034bb-863c-4d65-876f-b705730eaad4&Expires=1655794695&Signature=6AQB1dlAulToVSFoVDnL6abTdNs%3D&user=john.doe\",\n \"request_query_path\": \"/openapi/v1/activity-log/user-activity-logs/?AccessID=99d034bb-863c-4d65-876f-b705730eaad4&Expires=1655794695&Signature=6AQB1dlAulToVSFoVDnL6abTdNs%3D&user=john.doe\",\n \"error_response_data\": null,\n \"transaction_id\": \"ef7e0473-783e-49da-a5a6-9758ea8486ba\",\n \"error_traceback\": null,\n \"log_type\": \"SUCCESS\",\n \"duration\": 0.12833714485168457,\n \"query_params_text\": \"AccessID=99d034bb-863c-4d65-876f-b705730eaad4&Expires=1655794695&Signature=6AQB1dlAulToVSFoVDnL6abTdNs%3D&user=john.doe\"\n },\n {\n \"request_log_id\": \"PbQNhYEBUR1QOHIdR8kk\",\n \"tenant_id\": \"a107d53c-ef3d-433d-ae9f-f7e98257653f\",\n \"server_url\": \"https://abc.com/cftrapi/\",\n \"user_id\": \"3efcdba6-83a8-4921-a11c-4530d1d31947\",\n \"username\": \"john\",\n \"user_ip_address\": \"172.18.0.1\",\n \"request_method\": \"GET\",\n \"request_full_path\": \"https://abc.com/cftrapi/openapi/v1/activity-log/user-activity-logs/?AccessID=99d034bb-863c-4d65-876f-b705730eaad4&Expires=1655794664&Signature=k6%2B586Q0zNVQNZJzpHwwl%2BF2Vcw%3D&component=action\",\n \"request_timestamp\": 1655794648.71426,\n \"request_timestamp_readable\": \"2022-06-21 06:57:28 +0000\",\n \"response_timestamp\": 1655794648.850652,\n \"response_timestamp_readable\": \"2022-06-21 06:57:28 +0000\",\n \"response_status_code\": 200,\n \"user_agent\": \"PostmanRuntime/7.29.0\",\n \"request_path\": \"/openapi/v1/activity-log/user-activity-logs/?AccessID=99d034bb-863c-4d65-876f-b705730eaad4&Expires=1655794664&Signature=k6%2B586Q0zNVQNZJzpHwwl%2BF2Vcw%3D&component=action\",\n \"request_query_path\": \"/openapi/v1/activity-log/user-activity-logs/?AccessID=99d034bb-863c-4d65-876f-b705730eaad4&Expires=1655794664&Signature=k6%2B586Q0zNVQNZJzpHwwl%2BF2Vcw%3D&component=action\",\n \"error_response_data\": null,\n \"transaction_id\": \"30924689-61bd-47f7-bd5a-7515a5487ea9\",\n \"error_traceback\": null,\n \"log_type\": \"SUCCESS\",\n \"duration\": 0.13639187812805176,\n \"query_params_text\": \"AccessID=99d034bb-863c-4d65-876f-b705730eaad4&Expires=1655794664&Signature=k6%2B586Q0zNVQNZJzpHwwl%2BF2Vcw%3D&component=action\"\n },\n {\n \"request_log_id\": \"PLThhIEBUR1QOHIdTMki\",\n \"tenant_id\": \"a107d53c-ef3d-433d-ae9f-f7e98257653f\",\n \"server_url\": \"https://abc.com/cftrapi/\",\n \"user_id\": \"3efcdba6-83a8-4921-a11c-4530d1d31947\",\n \"username\": \"system.default\",\n \"user_ip_address\": \"172.18.0.1\",\n \"request_method\": \"GET\",\n \"request_full_path\": \"https://abc.com/cftrapi/utils/request-log/?request_timestamp__gte=1655791709.810323\",\n \"request_timestamp\": 1655791766.474538,\n \"request_timestamp_readable\": \"2022-06-21 06:09:26 +0000\",\n \"response_timestamp\": 1655791766.550524,\n \"response_timestamp_readable\": \"2022-06-21 06:09:26 +0000\",\n \"response_status_code\": 200,\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36\",\n \"request_path\": \"/utils/request-log/?request_timestamp__gte=1655791709.810323\",\n \"request_query_path\": \"/utils/request-log/?request_timestamp__gte=1655791709.810323\",\n \"error_response_data\": null,\n \"transaction_id\": \"6f38fa4a-eb59-4e19-b1e4-582b4b2a7f64\",\n \"error_traceback\": null,\n \"log_type\": \"SUCCESS\",\n \"duration\": 0.07598590850830078,\n \"query_params_text\": \"request_timestamp__gte=1655791709.810323\"\n },\n {\n \"request_log_id\": \"O7ThhIEBUR1QOHIdS8lk\",\n \"tenant_id\": \"a107d53c-ef3d-433d-ae9f-f7e98257653f\",\n \"server_url\": \"https://abc.com/cftrapi/\",\n \"user_id\": \"3efcdba6-83a8-4921-a11c-4530d1d31947\",\n \"username\": \"john\",\n \"user_ip_address\": \"172.18.0.1\",\n \"request_method\": \"GET\",\n \"request_full_path\": \"https://abc.com/cftrapi/notifications/app-notifications/user-unseen-count/\",\n \"request_timestamp\": 1655791766.307026,\n \"request_timestamp_readable\": \"2022-06-21 06:09:26 +0000\",\n \"response_timestamp\": 1655791766.360135,\n \"response_timestamp_readable\": \"2022-06-21 06:09:26 +0000\",\n \"response_status_code\": 200,\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36\",\n \"request_path\": \"/notifications/app-notifications/user-unseen-count/\",\n \"request_query_path\": \"/notifications/app-notifications/user-unseen-count/\",\n \"error_response_data\": null,\n \"transaction_id\": \"12c9b49d-8e92-432b-af20-feeaa51fa403\",\n \"error_traceback\": null,\n \"log_type\": \"SUCCESS\",\n \"duration\": 0.053109169006347656,\n \"query_params_text\": \"\"\n },\n {\n \"request_log_id\": \"OrThhIEBUR1QOHIdJMmM\",\n \"tenant_id\": \"a107d53c-ef3d-433d-ae9f-f7e98257653f\",\n \"server_url\": \"https://abc.com/cftrapi/\",\n \"user_id\": \"3efcdba6-83a8-4921-a11c-4530d1d31947\",\n \"username\": \"doe\",\n \"user_ip_address\": \"172.18.0.1\",\n \"request_method\": \"GET\",\n \"request_full_path\": \"https://abc.com/cftrapi/notifications/app-notifications/user-unseen-count/\",\n \"request_timestamp\": 1655791756.303884,\n \"request_timestamp_readable\": \"2022-06-21 06:09:16 +0000\",\n \"response_timestamp\": 1655791756.403182,\n \"response_timestamp_readable\": \"2022-06-21 06:09:16 +0000\",\n \"response_status_code\": 200,\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36\",\n \"request_path\": \"/notifications/app-notifications/user-unseen-count/\",\n \"request_query_path\": \"/notifications/app-notifications/user-unseen-count/\",\n \"error_response_data\": null,\n \"transaction_id\": \"5ad9013a-7a4d-4997-b575-e3091b6a6213\",\n \"error_traceback\": null,\n \"log_type\": \"SUCCESS\",\n \"duration\": 0.09929800033569336,\n \"query_params_text\": \"\"\n },\n {\n \"request_log_id\": \"ObThhIEBUR1QOHIdJMky\",\n \"tenant_id\": \"a107d53c-ef3d-433d-ae9f-f7e98257653f\",\n \"server_url\": \"https://abc.com/cftrapi/\",\n \"user_id\": \"3efcdba6-83a8-4921-a11c-4530d1d31947\",\n \"username\": \"john\",\n \"user_ip_address\": \"172.18.0.1\",\n \"request_method\": \"GET\",\n \"request_full_path\": \"https://abc.com/cftrapi/utils/request-log/?request_timestamp__gte=1655791709.810323\",\n \"request_timestamp\": 1655791756.086805,\n \"request_timestamp_readable\": \"2022-06-21 06:09:16 +0000\",\n \"response_timestamp\": 1655791756.317229,\n \"response_timestamp_readable\": \"2022-06-21 06:09:16 +0000\",\n \"response_status_code\": 200,\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36\",\n \"request_path\": \"/utils/request-log/?request_timestamp__gte=1655791709.810323\",\n \"request_query_path\": \"/utils/request-log/?request_timestamp__gte=1655791709.810323\",\n \"error_response_data\": null,\n \"transaction_id\": \"2842c54f-2375-46b2-892f-9dd92b430a3b\",\n \"error_traceback\": null,\n \"log_type\": \"SUCCESS\",\n \"duration\": 0.2304239273071289,\n \"query_params_text\": \"request_timestamp__gte=1655791709.810323\"\n },\n {\n \"request_log_id\": \"OLTghIEBUR1QOHId_ckU\",\n \"tenant_id\": \"a107d53c-ef3d-433d-ae9f-f7e98257653f\",\n \"server_url\": \"https://abc.com/cftrapi/\",\n \"user_id\": \"3efcdba6-83a8-4921-a11c-4530d1d31947\",\n \"username\": \"john\",\n \"user_ip_address\": \"172.18.0.1\",\n \"request_method\": \"GET\",\n \"request_full_path\": \"https://abc.com/cftrapi/notifications/app-notifications/user-unseen-count/\",\n \"request_timestamp\": 1655791746.278128,\n \"request_timestamp_readable\": \"2022-06-21 06:09:06 +0000\",\n \"response_timestamp\": 1655791746.315603,\n \"response_timestamp_readable\": \"2022-06-21 06:09:06 +0000\",\n \"response_status_code\": 200,\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36\",\n \"request_path\": \"/notifications/app-notifications/user-unseen-count/\",\n \"request_query_path\": \"/notifications/app-notifications/user-unseen-count/\",\n \"error_response_data\": null,\n \"transaction_id\": \"4e106c8c-d115-4861-8757-5e9620a42faa\",\n \"error_traceback\": null,\n \"log_type\": \"SUCCESS\",\n \"duration\": 0.0374751091003418,\n \"query_params_text\": \"\"\n },\n {\n \"request_log_id\": \"N7TghIEBUR1QOHId-8mS\",\n \"tenant_id\": \"a107d53c-ef3d-433d-ae9f-f7e98257653f\",\n \"server_url\": \"https://abc.com/cftrapi/\",\n \"user_id\": \"3efcdba6-83a8-4921-a11c-4530d1d31947\",\n \"username\": \"kar\",\n \"user_ip_address\": \"172.18.0.1\",\n \"request_method\": \"GET\",\n \"request_full_path\": \"https://abc.com/cftrapi/utils/request-log/?request_timestamp__gte=1655791709.810323\",\n \"request_timestamp\": 1655791745.838381,\n \"request_timestamp_readable\": \"2022-06-21 06:09:05 +0000\",\n \"response_timestamp\": 1655791745.924282,\n \"response_timestamp_readable\": \"2022-06-21 06:09:05 +0000\",\n \"response_status_code\": 200,\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36\",\n \"request_path\": \"/utils/request-log/?request_timestamp__gte=1655791709.810323\",\n \"request_query_path\": \"/utils/request-log/?request_timestamp__gte=1655791709.810323\",\n \"error_response_data\": null,\n \"transaction_id\": \"a4451ba0-8ff8-410b-b3b8-1f70849cea8d\",\n \"error_traceback\": null,\n \"log_type\": \"SUCCESS\",\n \"duration\": 0.08590102195739746,\n \"query_params_text\": \"request_timestamp__gte=1655791709.810323\"\n },\n {\n \"request_log_id\": \"NrTghIEBUR1QOHId1skF\",\n \"tenant_id\": \"a107d53c-ef3d-433d-ae9f-f7e98257653f\",\n \"server_url\": \"https://abc.com/cftrapi/\",\n \"user_id\": \"3efcdba6-83a8-4921-a11c-4530d1d31947\",\n \"username\": \"doe\",\n \"user_ip_address\": \"172.18.0.1\",\n \"request_method\": \"GET\",\n \"request_full_path\": \"https://abc.com/cftrapi/notifications/app-notifications/user-unseen-count/\",\n \"request_timestamp\": 1655791736.28478,\n \"request_timestamp_readable\": \"2022-06-21 06:08:56 +0000\",\n \"response_timestamp\": 1655791736.316116,\n \"response_timestamp_readable\": \"2022-06-21 06:08:56 +0000\",\n \"response_status_code\": 200,\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36\",\n \"request_path\": \"/notifications/app-notifications/user-unseen-count/\",\n \"request_query_path\": \"/notifications/app-notifications/user-unseen-count/\",\n \"error_response_data\": null,\n \"transaction_id\": \"7a616534-76f8-414e-9632-33c8caf24c1a\",\n \"error_traceback\": null,\n \"log_type\": \"SUCCESS\",\n \"duration\": 0.031336069107055664,\n \"query_params_text\": \"\"\n },\n {\n \"request_log_id\": \"NbTghIEBUR1QOHId08mh\",\n \"tenant_id\": \"a107d53c-ef3d-433d-ae9f-f7e98257653f\",\n \"server_url\": \"https://abc.com/cftrapi/\",\n \"user_id\": \"3efcdba6-83a8-4921-a11c-4530d1d31947\",\n \"username\": \"system.default\",\n \"user_ip_address\": \"172.18.0.1\",\n \"request_method\": \"GET\",\n \"request_full_path\": \"https://abc.com/cftrapi/utils/request-log/?request_timestamp__gte=1655791709.810323\",\n \"request_timestamp\": 1655791735.598889,\n \"request_timestamp_readable\": \"2022-06-21 06:08:55 +0000\",\n \"response_timestamp\": 1655791735.695181,\n \"response_timestamp_readable\": \"2022-06-21 06:08:55 +0000\",\n \"response_status_code\": 200,\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.0.0 Safari/537.36\",\n \"request_path\": \"/utils/request-log/?request_timestamp__gte=1655791709.810323\",\n \"request_query_path\": \"/utils/request-log/?request_timestamp__gte=1655791709.810323\",\n \"error_response_data\": null,\n \"transaction_id\": \"ef2d81a6-cf79-4803-b714-3fa0c887168e\",\n \"error_traceback\": null,\n \"log_type\": \"SUCCESS\",\n \"duration\": 0.09629178047180176,\n \"query_params_text\": \"request_timestamp__gte=1655791709.810323\"\n }\n ]\n}"}],"_postman_id":"aa024487-8b2d-43e3-9404-9c2826346204"},{"name":"Get Request Log Details","id":"030d4e56-7ff8-4bff-9b0d-44bc41fb6e66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/utils/request-log/:request_log_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the details of a specific API request log.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

Parameter	Type	Description
`request_log_id`	String	Unique ID of the request log.
`tenant_id`	String	Unique ID of the tenant in UUID format.
`server_url`	String	Server URL of the instance.
`user_id`	String	Unique ID of the tenant in UUID format.
`username`	String	Username of the user who requested the API.
`request_method`	String	Request method of the API.
`user_ip_address`	String	IP address of the user.
`request_full_path`	String	Actual API that is requested with query parameters.
`request_timestamp`	Double	Request timestamp in EPOCH time format.
`response_timestamp`	Double	Response timestamp in EPOCH time format.
`request_timestamp_readable`	String	Request timestamp in readable format in UTC timezone.
`response_timestamp_readable`	String	Response timestamp in readable format in UTC timezone.
`request_path`	String	Actual API that is requested without server URL.
`request_query_path`	String	Actual API that is requested without server URL.
`error_response_data`	Text	Error traceback of the API if there is an error.
`transaction_id`	String	Unique ID of the API transaction in UUID format.
`error_traceback`	Text	Error traceback of the API if there is an error.
`log_type`	String	Type of the log. For example, SUCCESS and ERROR.
`duration`	Float	Time taken by the API to respond.
`query_params_text`	String	Query parameters of the API.
`response_status_code`	Integer	Status code of API request.
`user_agent`	String	Browser or machine configuration of the user requesting the API.

","urlObject":{"path":["utils","request-log",":request_log_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"disabled":true,"description":{"content":"

[optional] [string] Enter the API request method.

\n","type":"text/plain"},"key":"request_method","value":"GET"},{"disabled":true,"description":{"content":"

[optional] [string] Enter the username of a user.

\n","type":"text/plain"},"key":"username","value":"john"},{"disabled":true,"description":{"content":"

[optional] [integer] Enter the response status code of the API requests.

\n","type":"text/plain"},"key":"response_status_code","value":"200"},{"disabled":true,"description":{"content":"

[optional] [float] Enter a timestamp in EPOCH format to retrieve the request logs that are requested after this time.

\n","type":"text/plain"},"key":"request_timestamp__gte","value":"1655801151.348171"},{"disabled":true,"description":{"content":"

[optional] [float] Enter a timestamp in EPOCH format to retrieve the request logs that are requested before this time.

\n","type":"text/plain"},"key":"request_timestamp__lte","value":"1655801151.348171"}],"variable":[{"description":{"content":"

[optional] [string] Unique id of a api request log

\n","type":"text/plain"},"type":"any","value":"NdFIqowBhGMARP75l3Ly","key":"request_log_id"}]}},"response":[{"id":"52e41d9b-4fea-4f84-bf0e-cc22a6482330","name":"Get details for specific activity log","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/utils/request-log/:request_log_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["utils","request-log",":request_log_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"request_method","value":"GET","description":"[optional] [string] Query for only GET,POST requests","disabled":true},{"key":"username","value":"john","description":"[optional] [string] Query all logs for this user","disabled":true},{"key":"response_status_code","value":"200","description":"[optional] [integer] Query for logs will response status code as 200","disabled":true},{"key":"request_timestamp__gte","value":"1655801151.348171","description":"[optional] [float] Get all logs greater than the mentioned timestamp","disabled":true},{"key":"request_timestamp__lte","value":"1655801151.348171","description":"[optional] [float] Get all logs less than the mentioned timestamp","disabled":true}],"variable":[{"key":"request_log_id","value":"PrQNhYEBUR1QOHIdwMkO","description":"[optional] [string] Unique id of a api request log"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 Jun 2022 08:50:57 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1458","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"request_log_id\": \"PrQNhYEBUR1QOHIdwMkO\",\n \"tenant_id\": \"a107d53c-ef3d-433d-ae9f-f7e98257653f\",\n \"server_url\": \"https://abc.com/cftrapi/\",\n \"user_id\": \"3efcdba6-83a8-4921-a11c-4530d1d31947\",\n \"username\": \"joh\",\n \"user_ip_address\": \"172.18.0.1\",\n \"request_method\": \"GET\",\n \"request_full_path\": \"https://abc.com/cftrapi/openapi/v1/activity-log/user-activity-logs/?AccessID=99d034bb-863c-4d65-876f-b705730eaad4&Expires=1655794695&Signature=6AQB1dlAulToVSFoVDnL6abTdNs%3D&user=john.doe\",\n \"request_timestamp\": 1655794679.682828,\n \"request_timestamp_readable\": \"2022-06-21 06:57:59 +0000\",\n \"response_timestamp\": 1655794679.811165,\n \"response_timestamp_readable\": \"2022-06-21 06:57:59 +0000\",\n \"response_status_code\": 200,\n \"user_agent\": \"PostmanRuntime/7.29.0\",\n \"request_path\": \"/openapi/v1/activity-log/user-activity-logs/?AccessID=99d034bb-863c-4d65-876f-b705730eaad4&Expires=1655794695&Signature=6AQB1dlAulToVSFoVDnL6abTdNs%3D&user=john.doe\",\n \"request_query_path\": \"/openapi/v1/activity-log/user-activity-logs/?AccessID=99d034bb-863c-4d65-876f-b705730eaad4&Expires=1655794695&Signature=6AQB1dlAulToVSFoVDnL6abTdNs%3D&user=john.doe\",\n \"error_response_data\": null,\n \"transaction_id\": \"ef7e0473-783e-49da-a5a6-9758ea8486ba\",\n \"error_traceback\": null,\n \"log_type\": \"SUCCESS\",\n \"duration\": 0.12833714485168457,\n \"query_params_text\": \"AccessID=99d034bb-863c-4d65-876f-b705730eaad4&Expires=1655794695&Signature=6AQB1dlAulToVSFoVDnL6abTdNs%3D&user=john.doe\"\n}"}],"_postman_id":"030d4e56-7ff8-4bff-9b0d-44bc41fb6e66"}],"id":"6b70f7db-91b6-495a-96fc-e174c614771a","description":"

The admin logs include all the activity logs of CFTR features and all the API request logs. Admin logs enable administrators to track all the activity in the CFTR application.

This section describes how to use the API endpoints to manage the admin logs.

\n","_postman_id":"6b70f7db-91b6-495a-96fc-e174c614771a"}],"id":"e6ab2fdf-9e7d-4316-bf9b-344a7173df24","description":"

This section describes how to use the API endpoints that are available only for the CFTR admins.

\n","_postman_id":"e6ab2fdf-9e7d-4316-bf9b-344a7173df24"},{"name":"Rule Engine","item":[{"name":"List Rule Triggers","id":"d8794b67-a02e-4b22-8d51-a3e033e6dc9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/rule-engine/trigger/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve a list of rule triggers available in CFTR.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` shows the API endpoint to the next page.
`count`	Integer	Total number of rule triggers in CFTR.
`results`	List of Objects	Details of the rule triggers. Each object provides details of one rule trigger.

Response Parameters | Results Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	Title of the rule trigger.
`unique_id`	String	Unique identifier string of the rule trigger in UUID-4 format.
`description`	Text	Description of the rule trigger.
`object_identifier`	String	Unique ID of the tigger.
`trigger_config`	List	Details of the rule triggers. Details include: `title` , `options`, `field_type`, and more.
`is_removed`	Boolean	Shows whether the rule trigger is in a deleted state or not.
`created`	String	Creation date and time of the rule trigger in ISO format.
`modified`	String	Last modified date and time of the rule trigger in ISO format.

","urlObject":{"path":["rule-engine","trigger",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"b254debc-6ece-471c-890a-2587576fe4c6","name":"Get List of Rule Triggers","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/rule-engine/trigger/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["rule-engine","trigger",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Mon, 20 Jun 2022 13:12:35 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1822","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 2,\n \"results\": [\n {\n \"title\": \"Workflow Phase Change\",\n \"description\": \"When the phase of the Incident is changed.\",\n \"object_identifier\": \"incident\",\n \"trigger_config\": [\n {\n \"title\": \"Workflow\",\n \"options\": {\n \"api\": \"forms/incident/schema/?schema_type=published\",\n \"labelKey\": \"title\",\n \"valueKey\": \"unique_id\"\n },\n \"unique_id\": \"schema\",\n \"field_type\": \"select\"\n },\n {\n \"field\": \"phase\",\n \"title\": \"From Phase\",\n \"options\": {\n \"api\": \"forms/field-options/?option_field_readable_key=phase&object_identifier=incident\",\n \"labelKey\": \"option_name\",\n \"valueKey\": \"unique_id\"\n },\n \"unique_id\": \"old_value\",\n \"depends_on\": \"schema\",\n \"field_type\": \"select\"\n },\n {\n \"field\": \"phase\",\n \"title\": \"To Phase\",\n \"options\": {\n \"api\": \"forms/field-options/?option_field_readable_key=phase&object_identifier=incident\",\n \"labelKey\": \"option_name\",\n \"valueKey\": \"unique_id\"\n },\n \"unique_id\": \"new_value\",\n \"depends_on\": \"schema\",\n \"field_type\": \"select\"\n }\n ],\n \"unique_id\": \"e5ca2914-bdf4-4920-8384-d2d435314838\",\n \"is_removed\": false,\n \"created\": \"2022-06-17T06:10:15.882199Z\",\n \"modified\": \"2022-06-17T06:10:15.882199Z\"\n },\n {\n \"title\": \"Incident Status Change\",\n \"description\": \"When the status of the Incident is changed.\",\n \"object_identifier\": \"incident\",\n \"trigger_config\": [\n {\n \"field\": \"status\",\n \"title\": \"From Status\",\n \"options\": [\n {\n \"title\": \"Open\",\n \"unique_id\": \"open\"\n },\n {\n \"title\": \"Closed\",\n \"unique_id\": \"closed\"\n },\n {\n \"title\": \"Untriaged\",\n \"unique_id\": \"untriaged\"\n },\n {\n \"title\": \"Merged\",\n \"unique_id\": \"merged\"\n }\n ],\n \"unique_id\": \"old_value\",\n \"field_type\": \"select\"\n },\n {\n \"field\": \"status\",\n \"title\": \"To Status\",\n \"options\": [\n {\n \"title\": \"Open\",\n \"unique_id\": \"open\"\n },\n {\n \"title\": \"Closed\",\n \"unique_id\": \"closed\"\n },\n {\n \"title\": \"Untriaged\",\n \"unique_id\": \"untriaged\"\n },\n {\n \"title\": \"Merged\",\n \"unique_id\": \"merged\"\n }\n ],\n \"unique_id\": \"new_value\",\n \"field_type\": \"select\"\n }\n ],\n \"unique_id\": \"391ee196-f660-478a-84a9-14acbab56241\",\n \"is_removed\": false,\n \"created\": \"2022-06-17T06:10:15.872889Z\",\n \"modified\": \"2022-06-17T06:10:15.872889Z\"\n }\n ]\n}"}],"_postman_id":"d8794b67-a02e-4b22-8d51-a3e033e6dc9e"},{"name":"List Rule Actions","id":"fa9f1a0d-e96b-470e-ac66-17f039be1575","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/rule-engine/action/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve a list of rule actions available in CFTR.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` shows the API endpoint to the next page.
`count`	Integer	Total number of Rule Actions in CFTR application.
`results`	List of Objects	Details of the Rule Action. Each object provides details of one Rule Action.

Response Parameters | Results Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	Title of the Rule Action.
`unique_id`	String	Unique Identifier String of UUID-4 format of the Rule Action.
`description`	Text	Description of the Rule Action.
`action_config`	List of Objects	Details of the Rule Action.
`action_slug`	String	The slug corresponding to the Rule Action.
`is_removed`	Boolean	Shows whether the Action is in a deleted state or not.
`created`	String	Creation date and time of the Rule Action in ISO format.
`modified`	String	Last modified date and time of the Rule Action in ISO format.

","urlObject":{"path":["rule-engine","action",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"d2a5fc53-a577-4243-9618-1b40e9ce558f","name":"Get List of Rule Actions","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/rule-engine/action/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["rule-engine","action",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Mon, 20 Jun 2022 13:14:13 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"480","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 1,\n \"results\": [\n {\n \"title\": \"Run Playbook\",\n \"description\": \"Select Playbook to Run\",\n \"action_config\": [\n {\n \"title\": \"Run Playbook\",\n \"options\": {\n \"api\": \"playbook/?dropdown=true\",\n \"labelKey\": \"title\",\n \"valueKey\": \"unique_id\",\n \"readable_id\": true\n },\n \"unique_id\": \"playbook_unique_id\",\n \"field_type\": \"select\"\n }\n ],\n \"action_slug\": \"run_playbook\",\n \"unique_id\": \"a4fa3bcb-d8be-4d92-a5ad-564a3fe66e64\",\n \"is_removed\": false,\n \"created\": \"2022-03-15T06:35:14.406065Z\",\n \"modified\": \"2022-03-25T10:53:53.894074Z\"\n }\n ]\n}"}],"_postman_id":"fa9f1a0d-e96b-470e-ac66-17f039be1575"},{"name":"List Rules","id":"068958f3-a634-417e-ab10-958584a27ce1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/rule-engine/rule/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve a list of rules available in CFTR.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` shows the API endpoint to the next page.
`count`	Integer	Total number of Rules in CFTR application.
`results`	List of Objects	Details of the Rules. Each object provides details of one Rule.

Response Parameters | Results Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	Title of the Rule.
`status`	String	Current status of the rule. Allowed values: `active` `inactive`
`created_by`	String	`user_id` of the user who created the rule.
`created_by_data`	Object	Details of the user who created the rule. Details include: `unique_id`, `first_name`, `last_name`, `email` and so on.
`modified_by`	String	Last updated date and time of the rule.
`modified_by_data`	Object	Details of the user who last updated the rule. Details include: `username` , `email` , `first_name`, `last_name`, and so on.
`unique_id`	String	Unique Identifier String of UUID-4 format of the Rule.
`created`	String	Creation date and time of the Rule in ISO format.
`modified`	String	Last modified date and time of the Rule in ISO format.

","urlObject":{"path":["rule-engine","rule",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"disabled":true,"description":{"content":"

[optional] Enter the status of the rules to filter response results.\nAllowed values:\nactive\ninactive

\n","type":"text/plain"},"key":"status","value":"active"},{"disabled":true,"description":{"content":"

[String] [Optional] Enter the query string to filter the response based on the rule title that includes the query string. \nDefault value: None

\n","type":"text/plain"},"key":"q","value":"rule 1"},{"disabled":true,"description":{"content":"

[integer] [Optional] Enter the page number. All the rules of this page will be returned. \nDefault value: 1

\n","type":"text/plain"},"key":"page","value":"2"},{"disabled":true,"description":{"content":"

[integer] [Optional] Enter the number of rules to be retrieved per page. \nDefault value: 10

\n","type":"text/plain"},"key":"page_size","value":"30"}],"variable":[]}},"response":[{"id":"2553a5d9-fb32-4b35-9cd4-10314e1c7812","name":"Get List of Rules","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/rule-engine/rule/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["rule-engine","rule",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Mon, 20 Jun 2022 13:25:53 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1569","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 2,\n \"results\": [\n {\n \"title\": \"Rule 1\",\n \"status\": \"active\",\n \"created_by\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"modified_by\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"modified_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"unique_id\": \"de76fb17-a055-47ba-bdc2-b8f172ddd390\",\n \"created\": \"2022-06-20T13:20:42.766194Z\",\n \"modified\": \"2022-06-20T13:20:42.766194Z\"\n },\n {\n \"title\": \"Rule 2\",\n \"status\": \"active\",\n \"created_by\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"modified_by\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"modified_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"unique_id\": \"855bb785-236e-4272-af36-d167f8fbbd74\",\n \"created\": \"2022-06-20T13:23:32.407288Z\",\n \"modified\": \"2022-06-20T13:23:32.407288Z\"\n }\n ],\n \"mapping\": {\n \"dropdown_display_name\": \"readable_id\"\n }\n}"}],"_postman_id":"068958f3-a634-417e-ab10-958584a27ce1"},{"name":"Get Rule Details","id":"14f91509-3424-4dd4-8f63-f81b80f53e84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/rule-engine/rule/:rule_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the details of a rule in the CFTR application.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

Parameter	Type	Description
`title`	String	Title of the Rule.
`status`	String	Current status of the rule. Allowed values: `active` `inactive`
`created_by`	String	`user_id` of the user who created the rule.
`created_by_data`	Object	Details of the user who created the rule. Details include: user_id, email, first_name, last_name, and so on.
`modified_by`	String	Last user who modified the rule.
`modified_by_data`	Object	Details of the user who last updated the rule. Details include `username` , `email` , `first_name`, `last_name`, and so on.
`unique_id`	String	Unique Identifier String of UUID-4 format of the Rule.
`created`	String	Creation date and time of the Rule in ISO format.
`modified`	String	Last modified date and time of the Rule in ISO format.
`trigger`	String	`unique_id` of the trigger added to the rule.
`actions`	List of String	`unique_ids` of the actions added to the rule.
`trigger_params`	Object	Parameters associated with the trigger. Required fields: `field`: Allowed values are `status`, `phase old_value`: From Value `new_value`: To Value
`trigger_params_data`	List of Objects	Details of trigger parameters such as `new_value_data` and `old_value_data`.
`action_params`	Object	Parameters associated with the action. Required fields: `playbook_unique_id`: `unique_id` of the Cyware Orchestrate Playbook to be triggered in the rule.
`conditions`	List of Objects	Details associated with the condition added. Fileds include: unique_id, operator, lhs, and so on.
`is_removed`	Boolean	Shows whether the Rule is in a deleted state or not.
`object_identifier`	String	Unique ID of the associated component.
`trigger_data`	Object	Details of the trigger associated with the rule.
`action_data`	Object	Details of action associated with the rule.
`is_working`	Boolean	Shows if the rule is working or not.

","urlObject":{"path":["rule-engine","rule",":rule_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of a rule.

\n","type":"text/plain"},"type":"any","value":"de76fb17-a055-47ba-bdc2-b8f172ddd390","key":"rule_unique_id"}]}},"response":[{"id":"62db178e-5832-4d06-ab21-f90a3ed447fe","name":"Get Details of a Rule","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/rule-engine/rule/de76fb17-a055-47ba-bdc2-b8f172ddd390/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["rule-engine","rule","de76fb17-a055-47ba-bdc2-b8f172ddd390",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Wed, 22 Jun 2022 13:49:48 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"2335","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"Rule 1\",\n \"status\": \"active\",\n \"created_by\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"created_by_data\": {\n \"user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"username\": \"jane.doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"Jane Doe\"\n },\n \"modified_by\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"modified_by_data\": {\n \"user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"username\": \"jane.doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"Jane Doe\"\n },\n \"trigger\": \"391ee196-f660-478a-84a9-14acbab56241\",\n \"action\": \"a4fa3bcb-d8be-4d92-a5ad-564a3fe66e64\",\n \"trigger_params\": {\n \"field\": \"status\",\n \"new_value\": \"closed\",\n \"old_value\": \"open\"\n },\n \"action_params\": {\n \"playbook_unique_id\": \"cd6f3f03-473a-44fa-b512-a6363ee11133\"\n },\n \"unique_id\": \"de76fb17-a055-47ba-bdc2-b8f172ddd390\",\n \"is_removed\": false,\n \"created\": \"2022-06-20T13:20:42.766194Z\",\n \"modified\": \"2022-06-20T13:20:42.766194Z\",\n \"object_identifier\": \"incident\",\n \"trigger_data\": {\n \"title\": \"Incident Status Change\",\n \"description\": \"When the status of the Incident is changed.\",\n \"object_identifier\": \"incident\",\n \"trigger_config\": [\n {\n \"field\": \"status\",\n \"title\": \"From Status\",\n \"options\": [\n {\n \"title\": \"Open\",\n \"unique_id\": \"open\"\n },\n {\n \"title\": \"Closed\",\n \"unique_id\": \"closed\"\n },\n {\n \"title\": \"Untriaged\",\n \"unique_id\": \"untriaged\"\n },\n {\n \"title\": \"Merged\",\n \"unique_id\": \"merged\"\n }\n ],\n \"unique_id\": \"old_value\",\n \"field_type\": \"select\"\n },\n {\n \"field\": \"status\",\n \"title\": \"To Status\",\n \"options\": [\n {\n \"title\": \"Open\",\n \"unique_id\": \"open\"\n },\n {\n \"title\": \"Closed\",\n \"unique_id\": \"closed\"\n },\n {\n \"title\": \"Untriaged\",\n \"unique_id\": \"untriaged\"\n },\n {\n \"title\": \"Merged\",\n \"unique_id\": \"merged\"\n }\n ],\n \"unique_id\": \"new_value\",\n \"field_type\": \"select\"\n }\n ],\n \"unique_id\": \"391ee196-f660-478a-84a9-14acbab56241\",\n \"is_removed\": false,\n \"created\": \"2022-06-17T06:10:15.872889Z\",\n \"modified\": \"2022-06-17T06:10:15.872889Z\"\n },\n \"action_data\": {\n \"title\": \"Run Playbook\",\n \"description\": \"Select Playbook to Run\",\n \"action_config\": [\n {\n \"title\": \"Run Playbook\",\n \"options\": {\n \"api\": \"playbook/?dropdown=true\",\n \"labelKey\": \"title\",\n \"valueKey\": \"unique_id\",\n \"readable_id\": true\n },\n \"unique_id\": \"playbook_unique_id\",\n \"field_type\": \"select\"\n }\n ],\n \"action_slug\": \"run_playbook\",\n \"unique_id\": \"a4fa3bcb-d8be-4d92-a5ad-564a3fe66e64\",\n \"is_removed\": false,\n \"created\": \"2022-03-15T06:35:14.406065Z\",\n \"modified\": \"2022-03-25T10:53:53.894074Z\"\n }\n}"}],"_postman_id":"14f91509-3424-4dd4-8f63-f81b80f53e84"},{"name":"Create Rule","id":"4df6f7df-fbfd-4add-8635-d844369522fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"action_params\": {\n \"playbook_unique_id\": \"cd6f3f03-473a-44fa-b512-a6363ee11133\"\n },\n \"trigger_params\": {\n \"old_value\": \"open\",\n \"new_value\": \"closed\",\n \"field\": \"status\"\n },\n \"title\": \"Rule 2\",\n \"trigger\": \"391ee196-f660-478a-84a9-14acbab56241\",\n \"action\": \"a4fa3bcb-d8be-4d92-a5ad-564a3fe66e64\",\n \"object_identifier\": \"incident\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/cftrapi/openapi/v1/rule-engine/rule/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Create a rule in CFTR.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`title`	String	Mandatory	Enter a title for the rule.
`status`	String	Optional	Enter the current status of the rule. Allowed values: `active` `inactive`
`trigger`	String	Mandatory	Enter the `unique_id` of the trigger to be added to the rule.
`action`	String	Mandatory	Enter the `unique_id` of the action to be added to the rule.
`trigger_params`	Object	Mandatory	Enter the parameters of the trigger. Note: The trigger parameters are further explained in the table below.
`action_params`	Object	Mandatory	Enter the parameters associated with the action. Required fields: `playbook_unique_id`: `unique_id` of Playbook to be triggered from the rule.
`object_identifier`	String	Mandatory	Unique ID of the associated component.

Request Parameters | Trigger Params

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`field`	String	Mandatory	Allowed values: `status` `phase`
`old_value`	String	Mandatory	From value of the trigger.
`new_value`	String	Mandatory	To value of the trigger.
`schema`	String	Optional (Mandatory when `field` is `phase`)	Enter the `unique_id` of the workflow. You can retrieve the list of available workflows and their unique IDs using the following API endpoint: `/openapi/v1/forms/incident/schema/`

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	Title of the Rule.
`status`	String	Current status of the rule. Allowed values: `active` `inactive`
`created_by`	String	`user_id` of the user who created the rule.
`created_by_data`	Object	Details of the user who created the rule.
`modified_by`	String	Last updated date and time of the rule.
`modified_by_data`	Object	Details of the user who last updated the rule. Details include: `username` , `email` , `first_name`, `last_name`, and so on.
`unique_id`	String	Unique Identifier String of UUID-4 format of the Rule.
`created`	String	Creation date and time of the Rule in ISO format.
`modified`	String	Last modified date and time of the Rule in ISO format.
`trigger`	String	`unique_id` of the trigger added to the rule.
`action`	String	`unique_id` of the action added to the rule.
`trigger_params`	Object	Parameters associated with the trigger. Required fields: `field`: Allowed values are `status`, `phase old_value`: From Value `new_value`: To Value
`action_params`	Object	Parameters associated with the action. Required fields: `playbook_unique_id`: `unique_id` of Playbook to be triggered from the rule.
`is_removed`	Boolean	Shows whether the Rule is in a deleted state or not.
`object_identifier`	String	Unique ID of the associated component.
`trigger_data`	Object	Details of the trigger associated with the rule.
`action_data`	Object	Details of the action associated with the rule.

","urlObject":{"path":["cftrapi","openapi","v1","rule-engine","rule",""],"host":["{{base_url}}"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"8b73c1e3-f7dc-4908-975c-de025bb6be7a","name":"Create Rule","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"action_params\": {\n \"playbook_unique_id\": \"cd6f3f03-473a-44fa-b512-a6363ee11133\"\n },\n \"trigger_params\": {\n \"old_value\": \"open\",\n \"new_value\": \"closed\",\n \"field\": \"status\"\n },\n \"title\": \"Rule 2\",\n \"trigger\": \"391ee196-f660-478a-84a9-14acbab56241\",\n \"action\": \"a4fa3bcb-d8be-4d92-a5ad-564a3fe66e64\",\n \"object_identifier\": \"incident\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/rule-engine/rule/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["rule-engine","rule",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Mon, 20 Jun 2022 13:23:32 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"2335","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"Rule 2\",\n \"status\": \"active\",\n \"created_by\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"modified_by\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"modified_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"trigger\": \"391ee196-f660-478a-84a9-14acbab56241\",\n \"action\": \"a4fa3bcb-d8be-4d92-a5ad-564a3fe66e64\",\n \"trigger_params\": {\n \"old_value\": \"open\",\n \"new_value\": \"closed\",\n \"field\": \"status\"\n },\n \"action_params\": {\n \"playbook_unique_id\": \"cd6f3f03-473a-44fa-b512-a6363ee11133\"\n },\n \"unique_id\": \"855bb785-236e-4272-af36-d167f8fbbd74\",\n \"is_removed\": false,\n \"created\": \"2022-06-20T13:23:32.407288Z\",\n \"modified\": \"2022-06-20T13:23:32.407288Z\",\n \"object_identifier\": \"incident\",\n \"trigger_data\": {\n \"title\": \"Incident Status Change\",\n \"description\": \"When the status of the Incident is changed.\",\n \"object_identifier\": \"incident\",\n \"trigger_config\": [\n {\n \"field\": \"status\",\n \"title\": \"From Status\",\n \"options\": [\n {\n \"title\": \"Open\",\n \"unique_id\": \"open\"\n },\n {\n \"title\": \"Closed\",\n \"unique_id\": \"closed\"\n },\n {\n \"title\": \"Untriaged\",\n \"unique_id\": \"untriaged\"\n },\n {\n \"title\": \"Merged\",\n \"unique_id\": \"merged\"\n }\n ],\n \"unique_id\": \"old_value\",\n \"field_type\": \"select\"\n },\n {\n \"field\": \"status\",\n \"title\": \"To Status\",\n \"options\": [\n {\n \"title\": \"Open\",\n \"unique_id\": \"open\"\n },\n {\n \"title\": \"Closed\",\n \"unique_id\": \"closed\"\n },\n {\n \"title\": \"Untriaged\",\n \"unique_id\": \"untriaged\"\n },\n {\n \"title\": \"Merged\",\n \"unique_id\": \"merged\"\n }\n ],\n \"unique_id\": \"new_value\",\n \"field_type\": \"select\"\n }\n ],\n \"unique_id\": \"391ee196-f660-478a-84a9-14acbab56241\",\n \"is_removed\": false,\n \"created\": \"2022-06-17T06:10:15.872889Z\",\n \"modified\": \"2022-06-17T06:10:15.872889Z\"\n },\n \"action_data\": {\n \"title\": \"Run Playbook\",\n \"description\": \"Select Playbook to Run\",\n \"action_config\": [\n {\n \"title\": \"Run Playbook\",\n \"options\": {\n \"api\": \"playbook/?dropdown=true\",\n \"labelKey\": \"title\",\n \"valueKey\": \"unique_id\",\n \"readable_id\": true\n },\n \"unique_id\": \"playbook_unique_id\",\n \"field_type\": \"select\"\n }\n ],\n \"action_slug\": \"run_playbook\",\n \"unique_id\": \"a4fa3bcb-d8be-4d92-a5ad-564a3fe66e64\",\n \"is_removed\": false,\n \"created\": \"2022-03-15T06:35:14.406065Z\",\n \"modified\": \"2022-03-25T10:53:53.894074Z\"\n }\n}"}],"_postman_id":"4df6f7df-fbfd-4add-8635-d844369522fe"},{"name":"Update Rule","id":"ee197639-6c0a-45a6-b234-1849bb02b3eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"action_params\": {\n \"playbook_unique_id\": \"cd6f3f03-473a-44fa-b512-a6363ee11133\"\n },\n \"trigger_params\": {\n \"old_value\": \"untriaged\",\n \"new_value\": \"open\",\n \"field\": \"status\"\n },\n \"title\": \"Rule 2\",\n \"trigger\": \"391ee196-f660-478a-84a9-14acbab56241\",\n \"action\": \"a4fa3bcb-d8be-4d92-a5ad-564a3fe66e64\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/rule-engine/rule/:rule_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Update a rule in the CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`title`	String	Optional	Title of the Rule.
`status`	String	Optional	Current status of the rule. Allowed values: `active` `inactive`Default value: `active`
`trigger`	String	Optional	`unique_id` of the trigger added to the rule.
`action`	String	Optional	`unique_id` of the action added to the rule.
`trigger_params`	Object	Optional	Parameters associated with the trigger. Required fields: `field`: Allowed values are `status`, `phase old_value`: From Value `new_value`: To Value
`action_params`	Object	Optional	Parameters associated with the action. Required fields: `playbook_unique_id`: `unique_id` of Playbook to be triggered from the rule.
`object_identifier`	String	Optional	Unique ID of the associated component.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	Title of the Rule.
`status`	String	Current status of the rule. Allowed values: `active` `inactive`
`created_by`	String	`user_id` of the user who created the rule.
`created_by_data`	Object	Details of the user who created the rule.
`modified_by`	String	`user_id` of the user who last modified the rule.
`modified_by_data`	Object	Details of the user who last updated the rule. Details include: `username` , `email` , `first_name`, `last_name`, and so on.
`unique_id`	String	Unique Identifier String of UUID-4 format of the Rule.
`created`	String	Creation date and time of the Rule in ISO format.
`modified`	String	Last modified date and time of the Rule in ISO format.
`trigger`	String	`unique_id` of the trigger added to the rule.
`action`	String	`unique_id` of the action added to the rule.
`trigger_params`	Object	Parameters associated with the trigger. Required fields: `field`: Allowed values are `status`, `phase old_value`: From Value `new_value`: To Value
`action_params`	Object	Parameters associated with the action. Required fields: `playbook_unique_id`: `unique_id` of Playbook to be triggered from the rule.
`is_removed`	Boolean	Shows whether the Rule is in a deleted state or not.
`object_identifier`	String	Unique ID of the associated component.
`trigger_data`	Object	Details of the trigger associated with the rule.
`action_data`	Object	Details of action associated with the rule.

Enter the unique ID of a rule

\n","type":"text/plain"},"type":"any","value":"de76fb17-a055-47ba-bdc2-b8f172ddd390","key":"rule_unique_id"}]}},"response":[{"id":"4f77fd1e-446a-43a2-8e5c-c81576728e54","name":"Update Rule","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"action_params\": {\n \"playbook_unique_id\": \"cd6f3f03-473a-44fa-b512-a6363ee11133\"\n },\n \"trigger_params\": {\n \"old_value\": \"untriaged\",\n \"new_value\": \"open\",\n \"field\": \"status\"\n },\n \"title\": \"Rule 2\",\n \"trigger\": \"391ee196-f660-478a-84a9-14acbab56241\",\n \"action\": \"a4fa3bcb-d8be-4d92-a5ad-564a3fe66e64\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/rule-engine/rule/855bb785-236e-4272-af36-d167f8fbbd74/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["rule-engine","rule","855bb785-236e-4272-af36-d167f8fbbd74",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Mon, 20 Jun 2022 13:25:12 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"2335","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"Rule 2\",\n \"status\": \"active\",\n \"created_by\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"created_by_data\": {\n \"user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"username\": \"jane\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"Jane Doe\"\n },\n \"modified_by\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"modified_by_data\": {\n \"user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"username\": \"jane\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"Jane Doe\"\n },\n \"trigger\": \"391ee196-f660-478a-84a9-14acbab56241\",\n \"action\": \"a4fa3bcb-d8be-4d92-a5ad-564a3fe66e64\",\n \"trigger_params\": {\n \"field\": \"status\",\n \"new_value\": \"closed\",\n \"old_value\": \"open\"\n },\n \"action_params\": {\n \"playbook_unique_id\": \"cd6f3f03-473a-44fa-b512-a6363ee11133\"\n },\n \"unique_id\": \"855bb785-236e-4272-af36-d167f8fbbd74\",\n \"is_removed\": false,\n \"created\": \"2022-06-20T13:23:32.407288Z\",\n \"modified\": \"2022-06-20T13:23:32.407288Z\",\n \"object_identifier\": \"incident\",\n \"trigger_data\": {\n \"title\": \"Incident Status Change\",\n \"description\": \"When the status of the Incident is changed.\",\n \"object_identifier\": \"incident\",\n \"trigger_config\": [\n {\n \"field\": \"status\",\n \"title\": \"From Status\",\n \"options\": [\n {\n \"title\": \"Open\",\n \"unique_id\": \"open\"\n },\n {\n \"title\": \"Closed\",\n \"unique_id\": \"closed\"\n },\n {\n \"title\": \"Untriaged\",\n \"unique_id\": \"untriaged\"\n },\n {\n \"title\": \"Merged\",\n \"unique_id\": \"merged\"\n }\n ],\n \"unique_id\": \"old_value\",\n \"field_type\": \"select\"\n },\n {\n \"field\": \"status\",\n \"title\": \"To Status\",\n \"options\": [\n {\n \"title\": \"Open\",\n \"unique_id\": \"open\"\n },\n {\n \"title\": \"Closed\",\n \"unique_id\": \"closed\"\n },\n {\n \"title\": \"Untriaged\",\n \"unique_id\": \"untriaged\"\n },\n {\n \"title\": \"Merged\",\n \"unique_id\": \"merged\"\n }\n ],\n \"unique_id\": \"new_value\",\n \"field_type\": \"select\"\n }\n ],\n \"unique_id\": \"391ee196-f660-478a-84a9-14acbab56241\",\n \"is_removed\": false,\n \"created\": \"2022-06-17T06:10:15.872889Z\",\n \"modified\": \"2022-06-17T06:10:15.872889Z\"\n },\n \"action_data\": {\n \"title\": \"Run Playbook\",\n \"description\": \"Select Playbook to Run\",\n \"action_config\": [\n {\n \"title\": \"Run Playbook\",\n \"options\": {\n \"api\": \"playbook/?dropdown=true\",\n \"labelKey\": \"title\",\n \"valueKey\": \"unique_id\",\n \"readable_id\": true\n },\n \"unique_id\": \"playbook_unique_id\",\n \"field_type\": \"select\"\n }\n ],\n \"action_slug\": \"run_playbook\",\n \"unique_id\": \"a4fa3bcb-d8be-4d92-a5ad-564a3fe66e64\",\n \"is_removed\": false,\n \"created\": \"2022-03-15T06:35:14.406065Z\",\n \"modified\": \"2022-03-25T10:53:53.894074Z\"\n }\n}"}],"_postman_id":"ee197639-6c0a-45a6-b234-1849bb02b3eb"}],"id":"86ded43c-4e81-4863-b75f-0fa9046c0a88","description":"

Using Rule Engine, you can automatically run Cyware Orchestrate Playbooks when the defined conditions are met. CFTR runs the playbook when the conditions of a rule are met.

This section describes how to use the API endpoints to manage the rules in the CFTR application.

\n","_postman_id":"86ded43c-4e81-4863-b75f-0fa9046c0a88"},{"name":"Incidents","item":[{"name":"Get List of Incidents","id":"ffeba0fb-e447-49d4-8e5d-90c915f6cbbd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/incident/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve a list of all the incidents with details from the CFTR application.

You can use the single-select and multi-select fields as query parameters to filter incidents.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/incident/?

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
link	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` shows the API endpoint to the next page.
count	Integer	Total number of incidents in CFTR application according to the filters applied.
results	List of Objects	Details of the incidents. Each object provides details of one incident.

Response Parameters | Results Object

Parameter	Type	Description
unique_id	String	Unique ID of the Incident in UUID-4 format.
readable_id	String	Unique readable ID of the incident. It starts with `INC` followed by a unique number. Example: INC101
created	String	Incident creation date and time.
description	Text	Description of the Incident.
modified	String	Last updated date and time of the incident.
title	Text	Title of the incident.
machine_generated	Boolean	True: Incident is considered machine generated when it is generated using the CFTR OpenAPI. False: Incident created manually.
status	String	Current status of the incident. Allowed values: `open` `closed` `untriaged` `merged`
closed_on	String	Date and time when the incident was closed. If incident is not closed, value of this param will be Null.
title_display	String	Title of the incident.
is_protected	Boolean	Shows if the incident is marked as protected or not.
level	String	Severity level of the incident.
phase	String	Current phase of the incident.
is_paused	Boolean	Shows if the incident is paused or not.
opened_on	String	Date and time when the incident was opened. If incident is not opened yet, value of this param will be Null.
assignment_sla	Object	Assignment SLA details of the incident. It has two keys: 1. `color`: Associated color code(according to SLA breach level). 2. `data`: It has two keys: - `sla_duration`: SLA Breach time. - `elapsed_time`: Time elapsed between incident opening and SLA completion.
resolution_sla	Object	Resolution SLA details of the incident. It has two keys: 1. `color`: Associated color code(according to SLA breach level). 2. `data`: It has two keys: - `sla_duration`: SLA Breach time. - `elapsed_time`: Time elapsed between incident opening and SLA completion.
is_bookmarked	Boolean	Shows if the incident is bookmarked or not.
resolution_due_date	Datetime	Resolution SLA breach date of the incident.
opened_by_data	Object	Details of the user who opened the incident. Details include: `username`, `email` ,`first_name`, `last_name`, and so on.
parent_data	Object	If Incident is merged to an incident, this parameter contains details of the parent incident. Details include: `title`, `unique_id`, and `readable_id`.
modified_by_data	Object	Details of user who last updated the Incident. Details include: `username`, `email` ,`first_name`, `last_name`, and so on.
assigned_group_data	Object	Details of the assigned user group. Details include: group name and group ID.
created_by_data	Object	Details of user who created the incident. Details include: `username`, `email` ,`first_name`, `last_name`, and so on.
assigned_to_data	Object	Details of the assigned user. Details include: `username`, `email` ,`first_name`, `last_name`, and so on.
labels_data	List of Objects	Details of labels added to the incident. Details include: `title`, `unique_id`, `color_code`, and so on.
business_units_impacted_data	Object	Details of business unit impacted by the incident. Details include: `title` and `unique_id` of the business unit.
locations_impacted_data	List of Objects	Details of locations impacted by the incident. Details include: `title` and `unique_id`.
phase_data	Object	Details of the current phase of the incident. Details include: `option_name`: The name of phase `unique_id`: Unique ID of the phase
ie_incident_type_data	Object	Details of the incident type associated with the incident. Details include: `option_name`, `unique_id,` and so on.
ie_incident_type	String	Incident type associated with the incident.
level_data	Object	Details of severity level associated with the incident. Details include: `option_name`, `unique_id`, and so on.

","urlObject":{"path":["incident",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"disabled":true,"description":{"content":"

[optional] Enter the status of the incidents.\nAllowed values:\n• open\n• closed\n• untriaged\n• merged\nExample: “open”

\n","type":"text/plain"},"key":"status","value":"open"},{"disabled":true,"description":{"content":"

[optional] Enter the last modified time of the incidents in EPOCH Time format.\nTime Zone must be as per UTC. All Incidents with modified date later than the entered time will be returned.

\n","type":"text/plain"},"key":"modified_date__gte","value":"1643283426"},{"disabled":true,"description":{"content":"

[optional] Enter the last modified time of the incidents in EPOCH Time format.\nTime Zone must be as per UTC. All Incidents with modified date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"modified_date__lte","value":"1643283426"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the incidents in EPOCH Time format.\nTime Zone must be as per UTC. All Incidents with creation date later than the entered time will be returned.

\n","type":"text/plain"},"key":"created_date__gte","value":"1643283426"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the incidents in EPOCH Time format.\nTime Zone must be as per UTC. All Incidents with creation date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"created_date__lte","value":"1643283426"},{"disabled":true,"description":{"content":"

[optional] Enter the page number of the incident list. This will retrieve the list of all Incidents from the entered page.

Default value: 1

\n","type":"text/plain"},"key":"page","value":"2"},{"disabled":true,"description":{"content":"

[optional] Enter number of incidents per page.\nDefault value: 10

\n","type":"text/plain"},"key":"page_size","value":"4"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID or title of the business unit. This parameter retrieves the incidents associated with the business unit.

You can retrieve the list of available Business Units with their Unique ID and title using the following API endpoint:

/openapi/v1/utils/business-unit/

\n","type":"text/plain"},"key":"business_units","value":"9750d6df-2d7f-4899-b20d-bfbba0a9084d"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID or title of the severity level of the incidents. This parameter retrieves the incidents by severity level.

\n","type":"text/plain"},"key":"level","value":"9e44ab13-64e5-43ad-a8d1-e1d181681090"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID or title of a phase. This parameter retrieves the incidents by the entered phase of incidents.

\n","type":"text/plain"},"key":"phase","value":"a5e04da7-61fb-4436-a11a-ab219eaeb296"}],"variable":[]}},"response":[{"id":"12436adf-28e1-4f80-8f50-138323358a8c","name":"Eg: Get List of Incidents","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/incident/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["incident",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Wed, 19 Jan 2022 09:12:31 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"31543","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {\n \"next\": \"openapi/v1/incident/?page=2&page_size=10&AccessID=769b74b8-23af-4abb-a99f-952ca699ac2c&Expires=1642583565&Signature=YTrZBb2rXNRwUjO2uhLrSIQmsdU=\"\n },\n \"count\": 164,\n \"results\": [\n {\n \"unique_id\": \"1cc818a1-2676-4746-ac2e-6610832c4d65\",\n \"readable_id\": \"INC586\",\n \"created\": \"2022-01-17T10:20:55.442706Z\",\n \"description\": \"

tst incidnet closure worklfow update flags

\",\n \"modified\": \"2022-01-19T06:20:35.414458Z\",\n \"title\": \"test closure\",\n \"machine_generated\": false,\n \"status\": \"open\",\n \"closed_on\": \"2022-01-17T12:09:26.125747Z\",\n \"title_display\": \"test closure\",\n \"is_protected\": false,\n \"level\": \"Low\",\n \"phase\": \"test 1\",\n \"is_paused\": false,\n \"opened_on\": \"2022-01-17T10:20:55.440647Z\",\n \"assignment_sla\": null,\n \"resolution_sla\": {\n \"data\": {\n \"sla_duration\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 30\n }\n },\n \"elapsed_time\": {\n \"days\": 1,\n \"hours\": 22,\n \"minutes\": 51\n },\n \"color\": 2\n },\n \"is_bookmarked\": false,\n \"resolution_due_date\": \"2022-01-17T10:50:55.440647Z\",\n \"opened_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"parent_data\": null,\n \"modified_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"assigned_group_data\": {\n \"group_comm_id\": \"9518ecfb-f091-4959-8c22-b7e50494b98f\",\n \"group_name\": \"CFTR Admin\"\n },\n \"created_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"assigned_to_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"labels_data\": [],\n \"business_units_impacted_data\": {\n \"title\": \"Bu 1\",\n \"unique_id\": \"9750d6df-2d7f-4899-b20d-bfbba0a9084d\"\n },\n \"locations_impacted_data\": [\n {\n \"title\": \"Loc 1\",\n \"unique_id\": \"671961e6-0119-460c-8d55-9b697f6e2d6e\"\n }\n ],\n \"phase_data\": {\n \"unique_id\": \"a5e04da7-61fb-4436-a11a-ab219eaeb296\",\n \"option_name\": \"test 1\",\n \"is_active\": true,\n \"order\": 10,\n \"option_field\": \"fe3b0e23-419d-4df7-b095-ee814a6a6d74\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"kill_chain_phase_data\": {\n \"unique_id\": \"11fbe9a7-a237-4df1-96f9-3b452a402117\",\n \"option_name\": \"Action on Objectives\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"bac118a8-dbb6-4621-a0f6-c23b2a6d531e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"kill_chain_phase\": \"Action on Objectives\",\n \"ie_motives_data\": [\n {\n \"unique_id\": \"56f89ff3-d39b-4d6e-846d-6389bfb1ecd2\",\n \"option_name\": \"Branding Impact\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"82982711-a45b-4c9a-8676-c559b774f7b2\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n }\n ],\n \"ie_motives\": [\n \"Branding Impact\"\n ],\n \"new_select_field_data\": {\n \"unique_id\": \"9063d472-c316-4843-8725-7d12f731511e\",\n \"option_name\": \"o2\",\n \"is_active\": true,\n \"order\": 10,\n \"option_field\": \"36baea0a-4a99-45e0-b788-e34c46996841\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"new_select_field\": \"o2\",\n \"applicable_compliance_data\": [\n {\n \"unique_id\": \"7d94de2b-5c69-4be4-afd0-e768b5fc3dc6\",\n \"option_name\": \"PCI\",\n \"is_active\": true,\n \"order\": 10,\n \"option_field\": \"814a12b5-0ae1-4f1e-b54c-8dccbd541920\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n {\n \"unique_id\": \"e54f611e-7b53-4435-a99e-a9fb8a052f2b\",\n \"option_name\": \"SOX\",\n \"is_active\": true,\n \"order\": 20,\n \"option_field\": \"814a12b5-0ae1-4f1e-b54c-8dccbd541920\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n }\n ],\n \"applicable_compliance\": [\n \"PCI\",\n \"SOX\"\n ],\n \"ie_root_cause_data\": null,\n \"ie_root_cause\": null,\n \"ie_incident_type_data\": {\n \"unique_id\": \"28b01b37-c686-49fd-abfd-aa95c2b1b050\",\n \"option_name\": \"Error\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"ca9713dc-37d7-4085-8367-3a8923a1e0b7\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"ie_incident_type\": \"Error\",\n \"business_impact_data\": [\n {\n \"unique_id\": \"ef0b030e-c19d-4f50-9972-7a2e51cc1cfd\",\n \"option_name\": \"Data Theft\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"b4c88412-0c66-4706-ac20-948ebacdc50f\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n {\n \"unique_id\": \"d4c011fd-69fe-46f1-b3e3-058fea528236\",\n \"option_name\": \"Business Disruption\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"b4c88412-0c66-4706-ac20-948ebacdc50f\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n }\n ],\n \"business_impact\": [\n \"Data Theft\",\n \"Business Disruption\"\n ],\n \"test_field__data\": {\n \"unique_id\": \"a5803e1d-9f2e-4da1-ac18-39d859b55cff\",\n \"option_name\": \"o2\",\n \"is_active\": true,\n \"order\": 10,\n \"option_field\": \"9f57b5c3-5caf-42ac-9c87-0bdd93aac1bc\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"test_field_\": \"o2\",\n \"level_data\": {\n \"unique_id\": \"9e44ab13-64e5-43ad-a8d1-e1d181681090\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"2fdedb65-b0b7-48af-b34e-714b4f7622bb\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n }\n },\n {\n \"unique_id\": \"6bc1d2b8-1254-4268-a3c6-249149f98d28\",\n \"readable_id\": \"INC585\",\n \"created\": \"2022-01-07T08:25:34.032458Z\",\n \"description\": null,\n \"modified\": \"2022-01-18T12:35:58.899178Z\",\n \"title\": \"t\",\n \"machine_generated\": false,\n \"status\": \"open\",\n \"closed_on\": null,\n \"title_display\": \"t\",\n \"is_protected\": false,\n \"level\": null,\n \"phase\": \"Detection Analysis\",\n \"is_paused\": false,\n \"opened_on\": \"2022-01-07T08:25:34.030210Z\",\n \"assignment_sla\": null,\n \"resolution_sla\": {\n \"data\": {\n \"sla_duration\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 30\n }\n },\n \"elapsed_time\": {\n \"days\": 12,\n \"hours\": 0,\n \"minutes\": 46\n },\n \"color\": 2\n },\n \"is_bookmarked\": false,\n \"resolution_due_date\": \"2022-01-07T08:55:34.030210Z\",\n \"opened_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"parent_data\": null,\n \"modified_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"assigned_group_data\": {\n \"group_comm_id\": \"9518ecfb-f091-4959-8c22-b7e50494b98f\",\n \"group_name\": \"CFTR Admin\"\n },\n \"created_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"assigned_to_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"labels_data\": [],\n \"business_units_impacted_data\": {\n \"title\": \"BU 2\",\n \"unique_id\": \"1a2f81d9-f4b5-4d28-8cfc-e2c72a4fa35f\"\n },\n \"locations_impacted_data\": [\n {\n \"title\": \"Loc 1\",\n \"unique_id\": \"671961e6-0119-460c-8d55-9b697f6e2d6e\"\n }\n ],\n \"phase_data\": {\n \"unique_id\": \"8884b69e-f1fc-4aaa-9583-1ab85652acf8\",\n \"option_name\": \"Detection Analysis\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"fe3b0e23-419d-4df7-b095-ee814a6a6d74\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"incident_identified_data\": [],\n \"incident_identified\": [],\n \"attack_vector_data\": null,\n \"attack_vector\": null,\n \"kill_chain_phase_data\": null,\n \"kill_chain_phase\": null,\n \"ie_motives_data\": [],\n \"ie_motives\": [],\n \"ie_regulatory_reporting_data\": [],\n \"ie_regulatory_reporting\": [],\n \"applicable_compliance_data\": [],\n \"applicable_compliance\": [],\n \"ie_regulatory_notifications_required_data\": null,\n \"ie_regulatory_notifications_required\": null,\n \"ie_root_cause_data\": null,\n \"ie_root_cause\": null,\n \"ie_incident_type_data\": null,\n \"ie_incident_type\": null,\n \"false_positive_data\": null,\n \"false_positive\": null,\n \"business_impact_data\": [],\n \"business_impact\": [],\n \"level_data\": null,\n \"ie_customer_notification_required_data\": null,\n \"ie_customer_notification_required\": null\n },\n {\n \"unique_id\": \"9da26277-93d2-4d02-8ff4-55a3177e35ac\",\n \"readable_id\": \"INC579\",\n \"created\": \"2021-12-19T06:23:48.808599Z\",\n \"description\": null,\n \"modified\": \"2022-01-18T12:08:15.608436Z\",\n \"title\": \"Incident created for demo purpose 1\",\n \"machine_generated\": false,\n \"status\": \"open\",\n \"closed_on\": null,\n \"title_display\": \"Incident created for demo purpose 1\",\n \"is_protected\": false,\n \"level\": null,\n \"phase\": \"Detection Analysis\",\n \"is_paused\": false,\n \"opened_on\": \"2021-12-19T06:23:48.808599Z\",\n \"assignment_sla\": null,\n \"resolution_sla\": null,\n \"is_bookmarked\": false,\n \"resolution_due_date\": null,\n \"opened_by_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"6850886e-e186-44de-bd0b-4730ff705dc9\",\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System Default\"\n },\n \"parent_data\": null,\n \"modified_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"assigned_group_data\": {\n \"group_comm_id\": \"9518ecfb-f091-4959-8c22-b7e50494b98f\",\n \"group_name\": \"CFTR Admin\"\n },\n \"created_by_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"6850886e-e186-44de-bd0b-4730ff705dc9\",\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System Default\"\n },\n \"assigned_to_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"labels_data\": [],\n \"business_units_impacted_data\": {\n \"title\": \"Bu 1\",\n \"unique_id\": \"9750d6df-2d7f-4899-b20d-bfbba0a9084d\"\n },\n \"locations_impacted_data\": [\n {\n \"title\": \"Loc 2\",\n \"unique_id\": \"0483162d-36c2-4f67-bf2b-a6bb46a52828\"\n }\n ],\n \"phase_data\": {\n \"unique_id\": \"8884b69e-f1fc-4aaa-9583-1ab85652acf8\",\n \"option_name\": \"Detection Analysis\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"fe3b0e23-419d-4df7-b095-ee814a6a6d74\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"kill_chain_phase_data\": {\n \"unique_id\": \"30be8fdf-16a5-486d-bce6-bc5108506ce5\",\n \"option_name\": \"Weaponization\",\n \"is_active\": true,\n \"order\": 6,\n \"option_field\": \"bac118a8-dbb6-4621-a0f6-c23b2a6d531e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"kill_chain_phase\": \"Weaponization\",\n \"applicable_compliance_data\": [],\n \"applicable_compliance\": [],\n \"ie_root_cause_data\": {\n \"unique_id\": \"871406ae-9bc8-4b38-8d6f-5424bc927a78\",\n \"option_name\": \"Inadequate Testing\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"503007a8-b2dc-462f-b2c3-939245eb684d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"ie_root_cause\": \"Inadequate Testing\",\n \"ie_incident_type_data\": null,\n \"ie_incident_type\": null,\n \"business_impact_data\": [],\n \"business_impact\": [],\n \"test_field__data\": null,\n \"test_field_\": null,\n \"level_data\": null\n },\n {\n \"unique_id\": \"e472a9f3-fed5-45e5-8c0a-823023dd92b2\",\n \"readable_id\": \"INC576\",\n \"created\": \"2021-12-14T10:40:52.039034Z\",\n \"description\": \"

\",\n \"modified\": \"2022-01-18T10:37:28.587155Z\",\n \"title\": \"q\",\n \"machine_generated\": false,\n \"status\": \"closed\",\n \"closed_on\": \"2021-12-14T10:43:48.710880Z\",\n \"title_display\": \"q\",\n \"is_protected\": false,\n \"level\": \"Unknown\",\n \"phase\": \"3\",\n \"is_paused\": false,\n \"opened_on\": \"2021-12-14T10:41:13.405183Z\",\n \"assignment_sla\": null,\n \"resolution_sla\": {\n \"data\": {\n \"sla_duration\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 30\n }\n },\n \"elapsed_time\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 2\n },\n \"color\": 0\n },\n \"is_bookmarked\": false,\n \"resolution_due_date\": \"2021-12-14T11:11:13.405183Z\",\n \"opened_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"parent_data\": null,\n \"modified_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"assigned_group_data\": {\n \"group_comm_id\": \"9518ecfb-f091-4959-8c22-b7e50494b98f\",\n \"group_name\": \"CFTR Admin\"\n },\n \"created_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"assigned_to_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"labels_data\": [],\n \"business_units_impacted_data\": {\n \"title\": \"BU 3\",\n \"unique_id\": \"c64ddedb-fcd4-4a44-8299-70fbabdf8204\"\n },\n \"locations_impacted_data\": [\n {\n \"title\": \"Loc 3\",\n \"unique_id\": \"d84cd854-b11f-4f6e-ac97-e606304d5e45\"\n }\n ],\n \"phase_data\": {\n \"unique_id\": \"d81e5d3a-9d96-4e13-933b-0d1853dca087\",\n \"option_name\": \"3\",\n \"is_active\": true,\n \"order\": 10,\n \"option_field\": \"fe3b0e23-419d-4df7-b095-ee814a6a6d74\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"kill_chain_phase_data\": null,\n \"kill_chain_phase\": null,\n \"applicable_compliance_data\": [\n {\n \"unique_id\": \"e54f611e-7b53-4435-a99e-a9fb8a052f2b\",\n \"option_name\": \"SOX\",\n \"is_active\": true,\n \"order\": 20,\n \"option_field\": \"814a12b5-0ae1-4f1e-b54c-8dccbd541920\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n }\n ],\n \"applicable_compliance\": [\n \"SOX\"\n ],\n \"ie_regulatory_notifications_required_data\": null,\n \"ie_regulatory_notifications_required\": null,\n \"ie_root_cause_data\": null,\n \"ie_root_cause\": null,\n \"ie_incident_type_data\": {\n \"unique_id\": \"28b01b37-c686-49fd-abfd-aa95c2b1b050\",\n \"option_name\": \"Error\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"ca9713dc-37d7-4085-8367-3a8923a1e0b7\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"ie_incident_type\": \"Error\",\n \"business_impact_data\": [],\n \"business_impact\": [],\n \"level_data\": {\n \"unique_id\": \"1e7712d5-cbf6-4354-aa93-1341605e350e\",\n \"option_name\": \"Unknown\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"2fdedb65-b0b7-48af-b34e-714b4f7622bb\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n }\n },\n {\n \"unique_id\": \"50eb0f72-18d3-4b14-a4b9-8ba771ae006f\",\n \"readable_id\": \"INC584\",\n \"created\": \"2021-12-31T09:10:21.445377Z\",\n \"description\": \"

erg

\",\n \"modified\": \"2022-01-07T08:10:01.118333Z\",\n \"title\": \"sla\",\n \"machine_generated\": false,\n \"status\": \"open\",\n \"closed_on\": null,\n \"title_display\": \"sla\",\n \"is_protected\": false,\n \"level\": \"Unknown\",\n \"phase\": \"Detection Analysis\",\n \"is_paused\": false,\n \"opened_on\": \"2021-12-31T09:10:21.443522Z\",\n \"assignment_sla\": {\n \"data\": {\n \"sla_duration\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 30\n }\n },\n \"elapsed_time\": {\n \"days\": 6,\n \"hours\": 22,\n \"minutes\": 58\n },\n \"color\": 2\n },\n \"resolution_sla\": {\n \"data\": {\n \"sla_duration\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 30\n }\n },\n \"elapsed_time\": {\n \"days\": 19,\n \"hours\": 0,\n \"minutes\": 2\n },\n \"color\": 2\n },\n \"is_bookmarked\": false,\n \"resolution_due_date\": \"2021-12-31T09:40:21.443522Z\",\n \"opened_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"parent_data\": null,\n \"modified_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"assigned_group_data\": {\n \"group_comm_id\": \"9518ecfb-f091-4959-8c22-b7e50494b98f\",\n \"group_name\": \"CFTR Admin\"\n },\n \"created_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"assigned_to_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"labels_data\": [],\n \"business_units_impacted_data\": {\n \"title\": \"BU 4\",\n \"unique_id\": \"ba273304-ff93-464f-961c-c06bf581e019\"\n },\n \"locations_impacted_data\": [\n {\n \"title\": \"Loc 3\",\n \"unique_id\": \"d84cd854-b11f-4f6e-ac97-e606304d5e45\"\n }\n ],\n \"phase_data\": {\n \"unique_id\": \"8884b69e-f1fc-4aaa-9583-1ab85652acf8\",\n \"option_name\": \"Detection Analysis\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"fe3b0e23-419d-4df7-b095-ee814a6a6d74\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"incident_identified_data\": [\n {\n \"unique_id\": \"3dbc103c-1774-4c92-a444-dc2cdb2e2341\",\n \"option_name\": \"Antivirus\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"d0a20bfe-f904-4025-b2ae-f258a4ca956f\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n {\n \"unique_id\": \"7302fbb0-63fe-443d-8f40-4fc1dc585c15\",\n \"option_name\": \"DAM\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"d0a20bfe-f904-4025-b2ae-f258a4ca956f\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n {\n \"unique_id\": \"d0c6bcb9-d435-47b2-a5d6-8455147282c0\",\n \"option_name\": \"Firewall\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"d0a20bfe-f904-4025-b2ae-f258a4ca956f\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n }\n ],\n \"incident_identified\": [\n \"Antivirus\",\n \"DAM\",\n \"Firewall\"\n ],\n \"attack_vector_data\": null,\n \"attack_vector\": null,\n \"kill_chain_phase_data\": null,\n \"kill_chain_phase\": null,\n \"ie_motives_data\": [],\n \"ie_motives\": [],\n \"ie_regulatory_reporting_data\": [],\n \"ie_regulatory_reporting\": [],\n \"applicable_compliance_data\": [\n {\n \"unique_id\": \"7d94de2b-5c69-4be4-afd0-e768b5fc3dc6\",\n \"option_name\": \"PCI\",\n \"is_active\": true,\n \"order\": 10,\n \"option_field\": \"814a12b5-0ae1-4f1e-b54c-8dccbd541920\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n }\n ],\n \"applicable_compliance\": [\n \"PCI\"\n ],\n \"ie_regulatory_notifications_required_data\": null,\n \"ie_regulatory_notifications_required\": null,\n \"ie_root_cause_data\": null,\n \"ie_root_cause\": null,\n \"ie_incident_type_data\": {\n \"unique_id\": \"69a64e92-a316-4122-8fb4-1d3976d16dca\",\n \"option_name\": \"IP Spoofing\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"ca9713dc-37d7-4085-8367-3a8923a1e0b7\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"ie_incident_type\": \"IP Spoofing\",\n \"false_positive_data\": null,\n \"false_positive\": null,\n \"business_impact_data\": [],\n \"business_impact\": [],\n \"level_data\": {\n \"unique_id\": \"1e7712d5-cbf6-4354-aa93-1341605e350e\",\n \"option_name\": \"Unknown\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"2fdedb65-b0b7-48af-b34e-714b4f7622bb\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"ie_customer_notification_required_data\": null,\n \"ie_customer_notification_required\": null\n },\n {\n \"unique_id\": \"cbf5519e-da74-4619-a6e7-ea08a775518d\",\n \"readable_id\": \"INC581\",\n \"created\": \"2021-12-09T23:28:22.349373Z\",\n \"description\": null,\n \"modified\": \"2021-12-20T13:05:54.912330Z\",\n \"title\": \"Incident created for demo purpose 1\",\n \"machine_generated\": false,\n \"status\": \"closed\",\n \"closed_on\": \"2021-12-20T02:50:37.349373Z\",\n \"title_display\": \"Incident created for demo purpose 1\",\n \"is_protected\": false,\n \"level\": null,\n \"phase\": \"Detection Analysis\",\n \"is_paused\": false,\n \"opened_on\": \"2021-12-09T23:28:22.349373Z\",\n \"assignment_sla\": null,\n \"resolution_sla\": null,\n \"is_bookmarked\": false,\n \"resolution_due_date\": null,\n \"opened_by_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"6850886e-e186-44de-bd0b-4730ff705dc9\",\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System Default\"\n },\n \"parent_data\": null,\n \"modified_by_data\": null,\n \"assigned_group_data\": {\n \"group_comm_id\": \"9518ecfb-f091-4959-8c22-b7e50494b98f\",\n \"group_name\": \"CFTR Admin\"\n },\n \"created_by_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"6850886e-e186-44de-bd0b-4730ff705dc9\",\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System Default\"\n },\n \"assigned_to_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"labels_data\": [],\n \"business_units_impacted_data\": {\n \"title\": \"BU 2\",\n \"unique_id\": \"1a2f81d9-f4b5-4d28-8cfc-e2c72a4fa35f\"\n },\n \"locations_impacted_data\": [\n {\n \"title\": \"Loc 1\",\n \"unique_id\": \"671961e6-0119-460c-8d55-9b697f6e2d6e\"\n }\n ],\n \"phase_data\": {\n \"unique_id\": \"8884b69e-f1fc-4aaa-9583-1ab85652acf8\",\n \"option_name\": \"Detection Analysis\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"fe3b0e23-419d-4df7-b095-ee814a6a6d74\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"incident_identified_data\": [],\n \"incident_identified\": [],\n \"attack_vector_data\": null,\n \"attack_vector\": null,\n \"kill_chain_phase_data\": {\n \"unique_id\": \"2ca6e018-4a40-450d-a821-f75abb37fb00\",\n \"option_name\": \"Delivery\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"bac118a8-dbb6-4621-a0f6-c23b2a6d531e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"kill_chain_phase\": \"Delivery\",\n \"ie_motives_data\": [\n {\n \"unique_id\": \"62dcade8-b781-41f3-a710-6b2526a4d7a7\",\n \"option_name\": \"Data Theft\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"82982711-a45b-4c9a-8676-c559b774f7b2\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n }\n ],\n \"ie_motives\": [\n \"Data Theft\"\n ],\n \"ie_regulatory_reporting_data\": [],\n \"ie_regulatory_reporting\": [],\n \"applicable_compliance_data\": [],\n \"applicable_compliance\": [],\n \"ie_regulatory_notifications_required_data\": null,\n \"ie_regulatory_notifications_required\": null,\n \"ie_root_cause_data\": {\n \"unique_id\": \"871406ae-9bc8-4b38-8d6f-5424bc927a78\",\n \"option_name\": \"Inadequate Testing\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"503007a8-b2dc-462f-b2c3-939245eb684d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"ie_root_cause\": \"Inadequate Testing\",\n \"ie_incident_type_data\": null,\n \"ie_incident_type\": null,\n \"false_positive_data\": null,\n \"false_positive\": null,\n \"business_impact_data\": [],\n \"business_impact\": [],\n \"level_data\": null,\n \"ie_customer_notification_required_data\": {\n \"unique_id\": \"0134202c-4705-44d4-95ba-2a5572b0155e\",\n \"option_name\": \"No\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"5ddf3029-ecee-4761-a512-69571d5e7a68\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"ie_customer_notification_required\": \"No\"\n },\n {\n \"unique_id\": \"d323e3b3-c345-4c89-a7da-30415666f5dd\",\n \"readable_id\": \"INC578\",\n \"created\": \"2021-09-28T15:09:34.808599Z\",\n \"description\": null,\n \"modified\": \"2021-12-20T12:09:40.117344Z\",\n \"title\": \"Incident created for demo purpose 0\",\n \"machine_generated\": false,\n \"status\": \"closed\",\n \"closed_on\": \"2021-12-18T18:18:33.808599Z\",\n \"title_display\": \"Incident created for demo purpose 0\",\n \"is_protected\": false,\n \"level\": null,\n \"phase\": \"Detection Analysis\",\n \"is_paused\": false,\n \"opened_on\": \"2021-09-28T15:09:34.808599Z\",\n \"assignment_sla\": null,\n \"resolution_sla\": null,\n \"is_bookmarked\": false,\n \"resolution_due_date\": null,\n \"opened_by_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"6850886e-e186-44de-bd0b-4730ff705dc9\",\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System Default\"\n },\n \"parent_data\": null,\n \"modified_by_data\": null,\n \"assigned_group_data\": {\n \"group_comm_id\": \"9518ecfb-f091-4959-8c22-b7e50494b98f\",\n \"group_name\": \"CFTR Admin\"\n },\n \"created_by_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"6850886e-e186-44de-bd0b-4730ff705dc9\",\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System Default\"\n },\n \"assigned_to_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"6850886e-e186-44de-bd0b-4730ff705dc9\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System Default\"\n },\n \"labels_data\": [],\n \"business_units_impacted_data\": {\n \"title\": \"Hidden\",\n \"unique_id\": \"2a29ca02-4676-441c-9d98-ceb14a65b1ea\"\n },\n \"locations_impacted_data\": [\n {\n \"title\": \"Loc 3\",\n \"unique_id\": \"d84cd854-b11f-4f6e-ac97-e606304d5e45\"\n }\n ],\n \"phase_data\": {\n \"unique_id\": \"8884b69e-f1fc-4aaa-9583-1ab85652acf8\",\n \"option_name\": \"Detection Analysis\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"fe3b0e23-419d-4df7-b095-ee814a6a6d74\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"kill_chain_phase_data\": {\n \"unique_id\": \"180f0a4a-c441-49b2-b894-a4bb1c2cdd6b\",\n \"option_name\": \"Reconnaissance\",\n \"is_active\": true,\n \"order\": 5,\n \"option_field\": \"bac118a8-dbb6-4621-a0f6-c23b2a6d531e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"kill_chain_phase\": \"Reconnaissance\",\n \"applicable_compliance_data\": [],\n \"applicable_compliance\": [],\n \"ie_root_cause_data\": {\n \"unique_id\": \"871406ae-9bc8-4b38-8d6f-5424bc927a78\",\n \"option_name\": \"Inadequate Testing\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"503007a8-b2dc-462f-b2c3-939245eb684d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"ie_root_cause\": \"Inadequate Testing\",\n \"ie_incident_type_data\": null,\n \"ie_incident_type\": null,\n \"business_impact_data\": [],\n \"business_impact\": [],\n \"test_field__data\": null,\n \"test_field_\": null,\n \"level_data\": null\n },\n {\n \"unique_id\": \"98bea801-91ae-4e52-aab1-7b83472ac6cc\",\n \"readable_id\": \"INC577\",\n \"created\": \"2021-12-14T10:44:40.383751Z\",\n \"description\": \"

\",\n \"modified\": \"2021-12-17T13:35:55.895951Z\",\n \"title\": \"q\",\n \"machine_generated\": false,\n \"status\": \"open\",\n \"closed_on\": null,\n \"title_display\": \"q\",\n \"is_protected\": false,\n \"level\": null,\n \"phase\": \"3\",\n \"is_paused\": false,\n \"opened_on\": \"2021-12-14T10:44:40.382371Z\",\n \"assignment_sla\": null,\n \"resolution_sla\": {\n \"data\": {\n \"sla_duration\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 30\n }\n },\n \"elapsed_time\": {\n \"days\": 35,\n \"hours\": 22,\n \"minutes\": 27\n },\n \"color\": 2\n },\n \"is_bookmarked\": false,\n \"resolution_due_date\": \"2021-12-14T11:14:40.382371Z\",\n \"opened_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"parent_data\": null,\n \"modified_by_data\": null,\n \"assigned_group_data\": {\n \"group_comm_id\": \"9518ecfb-f091-4959-8c22-b7e50494b98f\",\n \"group_name\": \"CFTR Admin\"\n },\n \"created_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"assigned_to_data\": {},\n \"labels_data\": [],\n \"business_units_impacted_data\": {\n \"title\": \"Bu 1\",\n \"unique_id\": \"9750d6df-2d7f-4899-b20d-bfbba0a9084d\"\n },\n \"locations_impacted_data\": [\n {\n \"title\": \"Loc 1\",\n \"unique_id\": \"671961e6-0119-460c-8d55-9b697f6e2d6e\"\n }\n ],\n \"phase_data\": {\n \"unique_id\": \"d81e5d3a-9d96-4e13-933b-0d1853dca087\",\n \"option_name\": \"3\",\n \"is_active\": true,\n \"order\": 10,\n \"option_field\": \"fe3b0e23-419d-4df7-b095-ee814a6a6d74\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"kill_chain_phase_data\": null,\n \"kill_chain_phase\": null,\n \"applicable_compliance_data\": [\n {\n \"unique_id\": \"7d94de2b-5c69-4be4-afd0-e768b5fc3dc6\",\n \"option_name\": \"PCI\",\n \"is_active\": true,\n \"order\": 10,\n \"option_field\": \"814a12b5-0ae1-4f1e-b54c-8dccbd541920\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n }\n ],\n \"applicable_compliance\": [\n \"PCI\"\n ],\n \"ie_regulatory_notifications_required_data\": null,\n \"ie_regulatory_notifications_required\": null,\n \"ie_root_cause_data\": null,\n \"ie_root_cause\": null,\n \"ie_incident_type_data\": null,\n \"ie_incident_type\": null,\n \"business_impact_data\": [],\n \"business_impact\": [],\n \"level_data\": null\n },\n {\n \"unique_id\": \"5462ff91-d25f-4bc4-8f41-a4caa470cbff\",\n \"readable_id\": \"INC575\",\n \"created\": \"2021-12-14T10:40:13.462946Z\",\n \"description\": \"

\",\n \"modified\": \"2021-12-14T10:40:17.366291Z\",\n \"title\": \"q\",\n \"machine_generated\": false,\n \"status\": \"open\",\n \"closed_on\": null,\n \"title_display\": \"q\",\n \"is_protected\": false,\n \"level\": null,\n \"phase\": \"3\",\n \"is_paused\": false,\n \"opened_on\": \"2021-12-14T10:40:13.460724Z\",\n \"assignment_sla\": null,\n \"resolution_sla\": {\n \"data\": {\n \"sla_duration\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 30\n }\n },\n \"elapsed_time\": {\n \"days\": 35,\n \"hours\": 22,\n \"minutes\": 32\n },\n \"color\": 2\n },\n \"is_bookmarked\": false,\n \"resolution_due_date\": \"2021-12-14T11:10:13.460724Z\",\n \"opened_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"parent_data\": null,\n \"modified_by_data\": null,\n \"assigned_group_data\": {\n \"group_comm_id\": \"9518ecfb-f091-4959-8c22-b7e50494b98f\",\n \"group_name\": \"CFTR Admin\"\n },\n \"created_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"assigned_to_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"labels_data\": [],\n \"business_units_impacted_data\": {\n \"title\": \"BU 3\",\n \"unique_id\": \"c64ddedb-fcd4-4a44-8299-70fbabdf8204\"\n },\n \"locations_impacted_data\": [\n {\n \"title\": \"Loc 2\",\n \"unique_id\": \"0483162d-36c2-4f67-bf2b-a6bb46a52828\"\n }\n ],\n \"phase_data\": {\n \"unique_id\": \"d81e5d3a-9d96-4e13-933b-0d1853dca087\",\n \"option_name\": \"3\",\n \"is_active\": true,\n \"order\": 10,\n \"option_field\": \"fe3b0e23-419d-4df7-b095-ee814a6a6d74\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"kill_chain_phase_data\": null,\n \"kill_chain_phase\": null,\n \"applicable_compliance_data\": [],\n \"applicable_compliance\": [],\n \"ie_regulatory_notifications_required_data\": null,\n \"ie_regulatory_notifications_required\": null,\n \"ie_root_cause_data\": null,\n \"ie_root_cause\": null,\n \"ie_incident_type_data\": null,\n \"ie_incident_type\": null,\n \"business_impact_data\": [],\n \"business_impact\": [],\n \"level_data\": null\n },\n {\n \"unique_id\": \"99a65e2a-aaa5-4dd6-bd74-2742c1c4ed6b\",\n \"readable_id\": \"INC574\",\n \"created\": \"2021-12-14T10:35:26.306836Z\",\n \"description\": null,\n \"modified\": \"2021-12-14T10:36:08.459579Z\",\n \"title\": \"q\",\n \"machine_generated\": false,\n \"status\": \"open\",\n \"closed_on\": null,\n \"title_display\": \"q\",\n \"is_protected\": false,\n \"level\": null,\n \"phase\": null,\n \"is_paused\": false,\n \"opened_on\": \"2021-12-14T10:36:05.666909Z\",\n \"assignment_sla\": null,\n \"resolution_sla\": {\n \"data\": {\n \"sla_duration\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 30\n }\n },\n \"elapsed_time\": {\n \"days\": 35,\n \"hours\": 22,\n \"minutes\": 36\n },\n \"color\": 2\n },\n \"is_bookmarked\": false,\n \"resolution_due_date\": \"2021-12-14T11:06:05.666909Z\",\n \"opened_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"parent_data\": null,\n \"modified_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"assigned_group_data\": {\n \"group_comm_id\": \"9518ecfb-f091-4959-8c22-b7e50494b98f\",\n \"group_name\": \"CFTR Admin\"\n },\n \"created_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"assigned_to_data\": {},\n \"labels_data\": [],\n \"business_units_impacted_data\": {\n \"title\": \"BU 3\",\n \"unique_id\": \"c64ddedb-fcd4-4a44-8299-70fbabdf8204\"\n },\n \"locations_impacted_data\": [\n {\n \"title\": \"Loc 3\",\n \"unique_id\": \"d84cd854-b11f-4f6e-ac97-e606304d5e45\"\n }\n ],\n \"phase_data\": null,\n \"kill_chain_phase_data\": null,\n \"kill_chain_phase\": null,\n \"applicable_compliance_data\": [\n {\n \"unique_id\": \"7d94de2b-5c69-4be4-afd0-e768b5fc3dc6\",\n \"option_name\": \"PCI\",\n \"is_active\": true,\n \"order\": 10,\n \"option_field\": \"814a12b5-0ae1-4f1e-b54c-8dccbd541920\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n }\n ],\n \"applicable_compliance\": [\n \"PCI\"\n ],\n \"ie_root_cause_data\": null,\n \"ie_root_cause\": null,\n \"ie_incident_type_data\": null,\n \"ie_incident_type\": null,\n \"business_impact_data\": [],\n \"business_impact\": [],\n \"test_field__data\": null,\n \"test_field_\": null,\n \"level_data\": null\n }\n ]\n}"}],"_postman_id":"ffeba0fb-e447-49d4-8e5d-90c915f6cbbd"},{"name":"List Incidents (Advanced)","event":[{"listen":"prerequest","script":{"exec":["var accessid = pm.environment.get(\"open_api_access_id\");","var secret_key = pm.environment.get(\"open_api_secret_key\");","/*"," -generating epochtime"," -epochtime is being send in expires parameter of params"," -sign is generated and then passed for generating signature","*/","pm.environment.set(\"unixtimestamp\",Math.round(Date.now()/1000));","var expires = pm.environment.get(\"unixtimestamp\")+15;","pm.environment.set('UTC Timezone', new Date().toISOString());","pm.environment.set(\"expires\", expires);","var to_sign = accessid+\"\\n\"+expires;","/*","Generate Signature for Authentication"," -Key based hashing is done using HMAC-SHA1 Algorithm"," -This is then converted into base64"," -Finally the generated signature is URL Encoded so as to make all the special characters URL Safe","*/","var hash = CryptoJS.HmacSHA1(to_sign, secret_key);","var hashInBase64 = encodeURIComponent(CryptoJS.enc.Base64.stringify(hash));","pm.environment.set(\"signature\",hashInBase64);"],"type":"text/javascript","packages":{},"requests":{},"id":"b4055e4d-7cf3-4088-b60c-8d2e3eee2480"}}],"id":"d355429a-7a1b-420d-aebe-e62e38f588b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{base_url}}v1/incident/qb/extended/?AccessID={{open_api_access_id}}&Signature={{signature}}&Expires={{expires}}&page_size=2","description":"

List Incidents Advanced

Retrieves the list of incidents with additional details from the Respond application.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter (key)	Type	Description
`link`	Object	This parameter has two keys: previous and next. previous key shows the API endpoint to the previous page. next shows the API endpoint to the next page.
`count`	number	Returns the total number of incidents that match the query across all pages.
`results`	array of objects	Returns a list of incident objects for the current page, each object representing a single incident with details.

Response Parameters | Results Object

Parameter (key)	Type	Description
`unique_id`	string	Returns the unique ID of the Incident in UUID-4 format.
`readable_id`	string	Returns the unique readable ID of the incident. It starts with INC followed by a unique number. Example: INC101
`title`	string	Returns the title of the incident.
`description`	string	Returns the description of the incident.
`status`	string	Returns the current status of the incident. For example, `Open`, `Closed`
`phase`	string	Returns the Current phase of the incident For example, `Containment`, `Closure`
`level`	string	Returns the severity level of the incident. For example, `Low`, `Medium`, `High`
`incident_date`	string	Returns the Date and time when the incident occurred.
`detection_date`	string	Returns the date and time when the incident was detected by the system or analysts.
`created`	string	Returns the timestamp when the incident was created.
`modified`	string	Returns the timestamp when the incident was last updated.
`opened_on`	string (ISO 8601)	Returns the timestamp when the incident was opened for investigation.
`closed_on`	string	Returns the timestamp when the incident was closed.
`title_display`	String	Title of the incident.
`machine_generated`	boolean	True: Incident is considered machine generated when it is generated using the Respond OpenAPI. False: Incident created manually.
`is_protected`	boolean	Returns if the incident is marked as protected or not.
`is_paused`	boolean	Returns whether the incident is currently paused or not.
`assignment_sla`	Object	Assignment SLA details of the incident. It has two keys: 1. color: Associated color code(according to SLA breach level). 2. data: It has two keys: - sla_duration: SLA Breach time. - elapsed_time: Time elapsed between incident opening and SLA completion.
`resolution_sla`	Object	Resolution SLA details of the incident. It has two keys: 1. color: Associated color code(according to SLA breach level). 2. data: It has two keys: - sla_duration: SLA Breach time. - elapsed_time: Time elapsed between incident opening and SLA completion.
`is_ctix_generated`	Boolean	Returns if the incident was created from Intel Exchange.
`is_bookmarked`	Boolean	Returns if the incident is bookmarked.
`incident_state`	string	High-level lifecycle state of the incident (often aligned with `status`, such as `Open` or `Closed`).
`business_impact`	array of strings	List of business impact labels associated with the incident (for example, `Branding Impact`).
`business_impact_data`	array of objects	Detailed metadata objects for each business impact entry, including ids, names and configuration details.
`attack_vector`	string, not mandatory	Primary attack vector associated with the incident (for example, `Email`), if specified.
`attack_vector_data`	object, not mandatory	Metadata describing the selected attack vector option (id, name, status and configuration fields).
`ie_incident_type`	string	Classification of the incident type (for example, `Malware`).
`ie_incident_type_data`	object	Metadata describing the selected incident type option (id, name and related configuration info).
`opened_by_data`	object	User details for the account that opened the incident (user id, name, email and related attributes).
`created_by_data`	object	User details for the account that originally created the incident record.
`modified_by_data`	object	User details for the account that last modified the incident.
`assigned_group_data`	object	Details of the group or team currently assigned to work on the incident.
`assigned_to_data`	object	Details of the individual user currently assigned to handle the incident.
`sources_data`	object	Returns the details of the source that generated the incident. Details include: unique_id, source_type, value, and more.
`labels_data`	array of objects	Details of labels added to the incident. Details include: title, unique_id, color_code, and more.
`business_units_impacted_data`	object	Returns details of the business units impacted by the incident. Details include: title and unique_id of the business unit.
`locations_impacted_data`	array of objects	Returns the locations impacted by the incident.
`first_assigned_on`	String	Returns when the incident was first assigned to a user.
`paused_on`	String	Returns the date and time when the incident was paused.
`phase_data`	object	Returns the details describing the incident’s current phase (id, display name, order and properties).
`status_data`	object	Returns the details describing the incident’s current status. Details include: id, display name, order and color code
`level_data`	Object	Returns the details of severity level associated with the incident. Details include: option_name, unique_id, and so on.
`ie_customer_notification_required_data`	Object	Returns the the details if the the customer notifications for the incident is enabled.
`ioc_url`	Array of Strings	List of unique_id of the connected URL Threat Intels.
`ioc_email`	Array of Strings	List of unique_id of the connected email Threat Intels.
`ioc_MD5`	Array of Strings	List of unique_id of the connected MD5 Threat Intels.
`ioc_ip`	Array of Strings	List of unique_id of the connected IP Threat Intels.
`ioc_domain`	Array of Strings	List of unique_id of the connected domain Threat Intels.
`ioc_SHA256`	Array of Strings	List of unique_id of the connected SHA256 Threat Intels.
`ioc_SHA1`	Array of Strings	Details of the connected SHA256 Threat Intels.

","urlObject":{"path":["incident","qb","extended",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Signature","value":"{{signature}}"},{"key":"Expires","value":"{{expires}}"},{"key":"page_size","value":"2"}],"variable":[]}},"response":[{"id":"6d5acb60-8a5f-4708-a726-8a0e5003e543","name":"List Incidents","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/incident/qb/extended/?AccessID={{open_api_access_id}}&Signature={{signature}}&Expires={{expires}}&page_size=2","host":["{{base_url}}v1"],"path":["incident","qb","extended",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Signature","value":"{{signature}}"},{"key":"Expires","value":"{{expires}}"},{"key":"page_size","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 17 Feb 2026 09:34:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET"},{"key":"Vary","value":"origin, Cookie"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"Content-Security-Policy","value":"img-src https: http: data: blob:;"},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {\n \"next\": \"openapi/v1/incident/qb/extended/?page=2&page_size=2&AccessID=286906ab-c717-40db-86b0-ff23cf50afab&Signature=bOdHmI2ifM6uqvZMHcHAMnMt/nE=&Expires=1771320880\"\n },\n \"count\": 73,\n \"results\": [\n {\n \"ir_source\": null,\n \"ir_org_id\": null,\n \"ir_user_id\": null,\n \"is_ir_revision\": false,\n \"attack_vector\": \"Email\",\n \"ie_root_cause\": null,\n \"ie_customer_notification_required\": \"Yes\",\n \"ie_regulatory_notifications_required\": null,\n \"false_positive\": null,\n \"applicable_compliance\": [],\n \"incident_identified\": [],\n \"ie_motives\": [],\n \"ie_regulatory_reporting\": [],\n \"business_impact\": [\n \"Branding Impact\"\n ],\n \"kill_chain_phase\": null,\n \"ioc_url\": [],\n \"ioc_email\": [],\n \"ioc_threat2026-02-16_05:27:07.006393\": [],\n \"ioc_MD5\": [],\n \"ioc_ip\": [],\n \"ioc_domain\": [],\n \"ioc_SHA256\": [],\n \"ioc_SHA1\": [],\n \"unique_id\": \"7002b4c6-ef09-41b8-a3b4-f19bb64aefd0\",\n \"readable_id\": \"INC188\",\n \"created\": \"2026-02-16T05:50:13.080746Z\",\n \"description\": \"New incident creation from api automation suite\",\n \"modified\": \"2026-02-16T05:50:21.097073Z\",\n \"title\": \"Api_automation 2026-02-16 05:29:43.741255\",\n \"machine_generated\": false,\n \"incident_date\": \"2026-02-16T05:29:43.741255Z\",\n \"detection_date\": \"2026-02-16T05:29:43.741255Z\",\n \"status\": \"Closed\",\n \"closed_on\": \"2026-02-16T05:50:20.737627Z\",\n \"title_display\": \"Api_automation 2026-02-16 05:29:43.741255\",\n \"is_protected\": false,\n \"level\": \"Low\",\n \"phase\": \"Closure\",\n \"ie_incident_type\": \"Malware\",\n \"is_paused\": false,\n \"opened_on\": \"2026-02-16T05:50:13.079338Z\",\n \"assignment_sla\": null,\n \"resolution_sla\": null,\n \"is_ctix_generated\": false,\n \"is_bookmarked\": false,\n \"resolution_due_date\": null,\n \"opened_by_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"92b31347-b184-442c-adcf-b43f04d2e496\",\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System Default\"\n },\n \"parent_data\": null,\n \"modified_by_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"92b31347-b184-442c-adcf-b43f04d2e496\",\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System Default\"\n },\n \"assigned_group_data\": {\n \"group_comm_id\": \"d0d089bf-b8d3-46b5-b7b9-f75d0ebfd7c3\",\n \"group_name\": \"CFTR Admin\"\n },\n \"created_by_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"92b31347-b184-442c-adcf-b43f04d2e496\",\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System Default\"\n },\n \"assigned_to_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"92b31347-b184-442c-adcf-b43f04d2e496\",\n \"display_pic\": \"https://3479.cftr.spotio.cywaredev.com/cftr/file-server/download/image.png?file_key=file-server-92b31347-b184-442c-adcf-b43f04d2e496&show_preview=True\",\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System Default\"\n },\n \"sources_data\": {\n \"unique_id\": \"e70c762c-d1fc-4311-abab-c8fdc2e7d0d4\",\n \"source_type\": \"c177afe1-60db-4e09-b6a1-61eed5e6812c\",\n \"value\": \"Manual\",\n \"source_type_data\": {\n \"unique_id\": \"c177afe1-60db-4e09-b6a1-61eed5e6812c\",\n \"created\": \"2026-02-04T07:42:59.347583Z\",\n \"title\": \"Manually Generated\"\n },\n \"created\": \"2026-02-04T07:42:59.355178Z\",\n \"source_display_name\": \"Manually Generated-Manual\",\n \"modified\": \"2026-02-04T07:42:59.355178Z\",\n \"is_removed\": false\n },\n \"labels_data\": [],\n \"business_units_impacted_data\": {\n \"title\": \"System\",\n \"unique_id\": \"55e326b3-47c8-40dd-931b-f0d05b0eb609\",\n \"email_list\": null\n },\n \"locations_impacted_data\": [\n {\n \"title\": \"System\",\n \"unique_id\": \"178de3e5-d373-479e-9a52-79bd78b0a41d\",\n \"is_active\": true\n }\n ],\n \"incident_state\": \"Closed\",\n \"first_assigned_on\": \"2026-02-16T05:50:13.079343Z\",\n \"paused_on\": null,\n \"paused_duration\": \"00:00:00\",\n \"closed_duration\": \"00:00:00\",\n \"duplicate_marked_on\": null,\n \"phase_data\": {\n \"unique_id\": \"e2d065ed-607a-4007-a2b5-62eec4b6bc6b\",\n \"option_name\": \"Closure\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"0f05c8ba-fa77-4ee1-b252-a21e0c6ecf64\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"status_data\": {\n \"unique_id\": \"463c325e-ba71-4037-96ee-1584260a13c7\",\n \"option_name\": \"Closed\",\n \"is_active\": true,\n \"order\": 100,\n \"option_field\": \"88d94d70-db10-47cb-8ad7-b00349975200\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": \"#00875A\"\n },\n \"incident_identified_data\": [],\n \"attack_vector_data\": {\n \"unique_id\": \"7df98507-6389-4acd-ab5d-901efafb8834\",\n \"option_name\": \"Email\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"4deb5b8a-460a-4605-a2cd-69da3bdef56d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"level_data\": {\n \"unique_id\": \"f3039354-5d5e-4829-b715-a2b661cba7f2\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"2f7c607e-c562-48dd-9b32-f331ccb2e2b8\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"ie_customer_notification_required_data\": {\n \"unique_id\": \"e113e471-2e12-4c91-9095-6ccc173f75fe\",\n \"option_name\": \"Yes\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"5686e3d6-2e3f-40ff-9b66-d8de36f2e3d3\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"ie_incident_type_data\": {\n \"unique_id\": \"6e92c112-3868-4832-b1c1-0dadba9b14ea\",\n \"option_name\": \"Malware\",\n \"is_active\": true,\n \"order\": 6,\n \"option_field\": \"af3bcdbb-e326-4034-a535-f568be8f0a51\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"business_impact_data\": [\n {\n \"unique_id\": \"cac88c96-9c2d-4c94-97aa-9fa738fb69c1\",\n \"option_name\": \"Branding Impact\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"8b9eb6f2-3554-4093-b385-93364b6ab8e2\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"kill_chain_phase_data\": null,\n \"applicable_compliance_data\": [],\n \"ie_motives_data\": [],\n \"ie_regulatory_reporting_data\": [],\n \"created_timestamp\": 1771221013.080746,\n \"modified_timestamp\": 1771221021.097073,\n \"opened_on_timestamp\": 1771221013.079338,\n \"closed_on_timestamp\": 1771221020.737627,\n \"incident_date_timestamp\": 1771219783.741255,\n \"detection_date_timestamp\": 1771219783.741255,\n \"first_assigned_on_timestamp\": 1771221013.079343\n },\n {\n \"ir_source\": null,\n \"ir_org_id\": null,\n \"ir_user_id\": null,\n \"is_ir_revision\": false,\n \"attack_vector\": null,\n \"ie_root_cause\": null,\n \"ie_customer_notification_required\": null,\n \"ie_regulatory_notifications_required\": null,\n \"false_positive\": null,\n \"applicable_compliance\": [],\n \"incident_identified\": [],\n \"ie_motives\": [],\n \"ie_regulatory_reporting\": [],\n \"business_impact\": [\n \"Branding Impact\"\n ],\n \"kill_chain_phase\": null,\n \"ioc_url\": [],\n \"ioc_email\": [],\n \"ioc_threat2026-02-16_05:27:07.006393\": [],\n \"ioc_MD5\": [],\n \"ioc_ip\": [],\n \"ioc_domain\": [],\n \"ioc_SHA256\": [],\n \"ioc_SHA1\": [],\n \"unique_id\": \"e2ea190c-e785-48aa-8284-ca579220b85e\",\n \"readable_id\": \"INC187\",\n \"created\": \"2026-02-16T05:49:32.567942Z\",\n \"description\": \"New incident creation from api automation suite\",\n \"modified\": \"2026-02-16T05:49:43.712214Z\",\n \"title\": \"API Automation Test For Text Field\",\n \"machine_generated\": false,\n \"incident_date\": null,\n \"detection_date\": null,\n \"status\": \"Open\",\n \"closed_on\": null,\n \"title_display\": \"API Automation Test For Text Field\",\n \"is_protected\": false,\n \"level\": \"Low\",\n \"phase\": \"Containment\",\n \"ie_incident_type\": \"Malware\",\n \"is_paused\": true,\n \"opened_on\": \"2026-02-16T05:49:32.566608Z\",\n \"assignment_sla\": null,\n \"resolution_sla\": null,\n \"is_ctix_generated\": false,\n \"is_bookmarked\": false,\n \"resolution_due_date\": null,\n \"opened_by_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"92b31347-b184-442c-adcf-b43f04d2e496\",\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System Default\"\n },\n \"parent_data\": null,\n \"modified_by_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"92b31347-b184-442c-adcf-b43f04d2e496\",\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System Default\"\n },\n \"assigned_group_data\": {\n \"group_comm_id\": \"d0d089bf-b8d3-46b5-b7b9-f75d0ebfd7c3\",\n \"group_name\": \"CFTR Admin\"\n },\n \"created_by_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"92b31347-b184-442c-adcf-b43f04d2e496\",\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System Default\"\n },\n \"assigned_to_data\": {},\n \"sources_data\": null,\n \"labels_data\": [],\n \"business_units_impacted_data\": {\n \"title\": \"System\",\n \"unique_id\": \"55e326b3-47c8-40dd-931b-f0d05b0eb609\",\n \"email_list\": null\n },\n \"locations_impacted_data\": [\n {\n \"title\": \"System\",\n \"unique_id\": \"178de3e5-d373-479e-9a52-79bd78b0a41d\",\n \"is_active\": true\n }\n ],\n \"incident_state\": \"Open\",\n \"first_assigned_on\": \"2026-02-16T05:49:32.566613Z\",\n \"paused_on\": null,\n \"paused_duration\": \"00:00:00\",\n \"closed_duration\": \"00:00:00\",\n \"duplicate_marked_on\": null,\n \"phase_data\": {\n \"unique_id\": \"d36e75db-f6d5-4755-a771-181a0598c56e\",\n \"option_name\": \"Containment\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"0f05c8ba-fa77-4ee1-b252-a21e0c6ecf64\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"status_data\": {\n \"unique_id\": \"3bba34ae-8541-43ef-94bf-e97ede95810f\",\n \"option_name\": \"Open\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"88d94d70-db10-47cb-8ad7-b00349975200\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": \"#E53535\"\n },\n \"incident_identified_data\": [],\n \"level_data\": {\n \"unique_id\": \"f3039354-5d5e-4829-b715-a2b661cba7f2\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"2f7c607e-c562-48dd-9b32-f331ccb2e2b8\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"ie_incident_type_data\": {\n \"unique_id\": \"6e92c112-3868-4832-b1c1-0dadba9b14ea\",\n \"option_name\": \"Malware\",\n \"is_active\": true,\n \"order\": 6,\n \"option_field\": \"af3bcdbb-e326-4034-a535-f568be8f0a51\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"business_impact_data\": [\n {\n \"unique_id\": \"cac88c96-9c2d-4c94-97aa-9fa738fb69c1\",\n \"option_name\": \"Branding Impact\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"8b9eb6f2-3554-4093-b385-93364b6ab8e2\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"kill_chain_phase_data\": null,\n \"applicable_compliance_data\": [],\n \"ie_motives_data\": [],\n \"ie_regulatory_reporting_data\": [],\n \"created_timestamp\": 1771220972.567942,\n \"modified_timestamp\": 1771220983.712214,\n \"opened_on_timestamp\": 1771220972.566608,\n \"first_assigned_on_timestamp\": 1771220972.566613\n }\n ]\n}"}],"_postman_id":"d355429a-7a1b-420d-aebe-e62e38f588b4"},{"name":"Get Details of an Incident","id":"9bf91892-28c9-4886-8f94-a69d43f247eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/incident/:incident_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the details of an incident.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/incident/:incident_unique_id/?

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

You can retrieve the details of an incident using the following API endpoint:

{{base-url}}/openapi/v1/forms/incident/schema/{{workflow-unique-id}}/\n\n

Response Parameters | Regulatory Fields

Parameter	Type	Description
`title`	String	Title of the incident.
`unique_id`	String	Unique Identifier String of UUID-4 format of the incident.
`readable_id`	String	Readable ID of the incident. For example, INC320.
`incident_date`	String	Date and time of when the incident happened.
`detection_date`	String	Date and time when the incident was detected as malicious.
`status`	String	Status of the incident workflow. Allowed values: - active - inactive
`phase`	String	Current phase of the incident. The phase describes the UUID of phase, part of the Incident Workflow.
`machine_generated`	Boolean	Displays if the incident is machine generated or not.
`phase_data`	Object	Details of the current phase of the incident.
`level`	String	Severity level of the incident. For example, high.
`level_data`	Object	Details of the severity level of the incident.
`created_by`	String	`user_id` of the user who created the incident.
`is_protected`	Boolean	Shows if the incident is protected or not.
`is_removed`	Boolean	Shows if the incident is in the deleted state or not.
`created_by_data`	Object	Details of user who created the incident.
`modified_by_data`	Object	Details of the user who last modified the incident.
`closed_by_data`	Object	Details of used who closed the incident.
`created`	String	Incident creation date and time.
`modified`	String	Last updated date and time of the incident.
`Opened_on`	Datetime	Date and time when the incident was opened.
`closed_on`	Datetime	Date and time when the incident was closed. If incident is not closed, value of this param will be Null.
`ie_num_of_pii_exposed`	Integer	Number of PIRs that were exposed in the incident.
`description`	String	Description of the Incident.
`assigned_to`	String	`user_id` of the assigned user.
`assigned_to_data`	Object	Details of the assigned user.
`assigned_group`	String	`group_comm_id` of the assigned user group.
`assigned_group_data`	Object	Details of the assigned user group.
`assignment_sla`	String	Assignment SLA details of the incident. It has two keys: 1. `color`: Associated color code(according to SLA breach level). 2. `data`: It has two keys: - `sla_duration`: SLA Breach time. - `elapsed_time`: Time elapsed between incident opening and SLA completion.
`ie_incident_type`	Strings	The type of incident. Example, hacking.
`days_open`	Integer	Number of days the incident is open.
`resolution_sla`	String	Resolution SLA details of the incident. It has two keys: 1. `color`: Associated color code(according to SLA breach level). 2. `data`: It has two keys: - `sla_duration`: SLA Breach time. - `elapsed_time`: Time elapsed between incident opening and SLA completion.
`notification_sla`	String	Details of the Incident notifications (if enabled in admin).
`total_cost`	Integer	Total cost incurred due to the incident.
`is_bookmarked`	Boolean	Shows if the incident is bookmarked or not.
`permanently_closed`	Boolean	Shows if the incident is permanently closed or not.
`resolution_due_date`	String	Resolution SLA breach date of the incident.
`can_update_instance`	Boolean	Shows whether the instance can be updated by the user who requested it or not.
`is_paused`	Boolean	Shows if the incident is paused or not.
`paused_by`	String	`user_id` of the user who paused the incident.
`paused_by_data`	Object	Details of the user who paused the incident.
`schema`	String	Unique ID of the Incident Workflow that is being used by the incident.
`schema_type`	String	Type of the incident Workflow. Allowed values: 'draft' or 'published'
`schema_data`	Object	Details of the Incident Workflow that is being used by the incident.
`sources`	Array	List of the sources for the incident.
`sources_data`	Array of Objects	Details of the sources for the incident.
`labels`	Array	List of the labels that are added to the incident.
`labels_data`	Array of Objects	Details of the labels that are added to the incident.
`tactic_technique_pair`	Array	List of the tactics and techniques used by the incident.
`tactic_technique_pair_data`	Array of Objects	Details of the tactics and techniques used by the incident.
`business_units_impacted_data`	Array of Objects	List of business units that are impacted by the incident.
`locations_impacted_data`	Array of Objects	List of locations that are impacted by the incident.
`incident_state`	String	State of the incident. For example, open, closed, merged.
`status_data`	Object	Details of the status of the incident.

Response Parameters | Connect The Dots

Following are the response parameters corresponding the Connect The Dots section of the incident. The parameters ending with data contain the meta information for each connected component. The non ___data__ _parameters just include an array of unique_id referencing to connected components.

Parameter	Type	Description
`applications`	Array of UUID Strings	List of `unique_id` of the connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`softwares`	Array of UUID Strings	List of `unique_id` of the connected softwares.
`softwares_data`	Array of Objects	Details of the connected softwares.
`users`	Array of UUID Strings	List of `unique_id` of the connected users.
`users_data`	Array of Objects	Details of the connected users.
`endpoints`	Array of UUID Strings	List of `unique_id` of the connected devices.
`endpoints_data`	Array of Objects	Details of the connected devices.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.
`enhancements`

Response Parameters | Default Indicators

Following are the seven standard indicators that are included by default in the CFTR platform, which reflect in the incident's response data with the following keys:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`ioc_SHA1`	Array of UUID Strings	List of `unique_id` of the connected SHA1 Threat Intels.
`ioc_SHA1_data`	Array of Objects	Details of the connected SHA1 Threat Intels.
`ioc_MD5`	Array of UUID Strings	List of `unique_id` of the connected MD5 Threat Intels.
`ioc_MD5_data`	Array of Objects	Details of the connected MD5 Threat Intels.
`ioc_SHA256`	Array of UUID Strings	List of `unique_id` of the connected SHA256 Threat Intels.
`ioc_SHA256_data`	Array of Objects	Details of the connected SHA256 Threat Intels.
`ioc_ip`	Array of UUID Strings	List of `unique_id` of the connected IP Threat Intels.
`ioc_ip_data`	Array of Objects	Details of the connected IP Threat Intels.
`ioc_url`	Array of UUID Strings	List of `unique_id` of the connected URL Threat Intels.
`ioc_url_data`	Array of Objects	Details of the connected URL Threat Intels.
`ioc_domain`	Array of UUID Strings	List of `unique_id` of the connected domain Threat Intels.
`ioc_domain_data`	Array of Objects	Details of the connected domain Threat Intels.
`ioc_email`	Array of UUID Strings	List of `unique_id` of the connected email Threat Intels.
`ioc_email_data`	Array of Objects	Details of the connected email Threat Intels.

Response Parameters | Custom Indicators

Custom Indicators are created, configured, and maintained through Form Management Threat Intel Section. Parameter Key in nomenclature is formed with the syntax: ioc_{{camel_case_of_threat_intel_name}}

The Example of a custom indicator parameter in the Incident's response is shown below.

\n
Note: The parameter key for custom indicator(s) may vary as per the Custom Threat Intel's name
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`ioc_credit_card`	Array of UUID Strings	List of UUID-4 formatted `unique_id` Strings corresponding to the Custom Threat Intel Credit Card, which are connected to the Incident
`ioc_credit_card_data`	Array of Objects	List of basic details of the Custom Indicator Credit Card connected to the Incident

Response Parameters | Custom Fields

As CFTR form structure is dynamic/configurable by nature, the response parameters may vary as per the Incidents Workflow configuration. The response parameters for the configured workflows contain the Readable Key (Identified as field_readable_key in the Workflow Details API) defined for each field. The following table describes some examples of the custom fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type
summary_card_host_pairs	String
ie_port_numbers_impacted	String
incident_learning	String
recovery_details	String

Response Parameters | Attachments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
attachments_data	Array of Objects	Details of each attachment of the incident.

Response Parameters | Actions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
actions_data	Array of Objects	Details of the actions that are added to the incident.

Response Parameters | Enhancements

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
enhancements	Array of UUID Strings	List of the enhancements that are added to the incident.
enhancements_data	Array of Objects	Details of the enhancements that are added to the incident.

Response Parameters | PIRs

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
pirs_data	Array of Objects	Details of the PIRs that are added to the incident.

Response Parameters | Knowledge Base

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
knowledge_base	Array of UUID Strings	List of the knowledge base records that are added to the incident.
knowledge_base_data	Array of Objects	Details of the knowledge base records that are added to the incident.

Response Parameters | System Form Fields

Few of the fields/parameters have the values in UUID-4 format. These fields do not intake Option Name in the request as they are used internally for various additional responsibilities around Analytics, Data Level Permission, Relationships and Filtering. These fields also include the parameters under Connect the Dots, indicators, and other sections.

These fields include:

All Connect the Dots params: You can retrieve the corresponding UUID-4 from the details page browser URL of the instance.
\n
All Indicators params: You can retrieve the corresponding UUID-4 from the details page browser URL of the instance.
\n
Assigned User / Assigned Group related params: You can retrieve the corresponding UUID-4 from the User Management and Group Management sections respectively.
\n
Business Unit, Location: You can retrieve the corresponding UUID-4 from Admin > Settings section
\n

\n","urlObject":{"path":["incident",":incident_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the incident of UUID format.

\n","type":"text/plain"},"type":"any","value":"12c02553-62ee-47cb-9b11-a1ae0c724d63","key":"incident_unique_id"}]}},"response":[{"id":"f66a114a-4b0a-40a0-8e1a-66636e3710ce","name":"Get Incident Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/incident/af04369e-27d9-4f0d-8f38-9c4788a7e35b/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["incident","af04369e-27d9-4f0d-8f38-9c4788a7e35b",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Jan 2022 08:08:44 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"56070","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"knowledge_base\": [],\n \"knowledge_base_data\": [],\n \"applications\": [\n \"c578b7c5-0e15-4741-8e38-8ca350563051\",\n \"31eef717-b89c-4d11-8c73-a4b6aa498acb\",\n \"a204b413-ce36-4019-9341-4f552cc8fc49\",\n \"4ef37041-3b28-4af1-a531-cb556b44972c\"\n ],\n \"applications_data\": [\n {\n \"unique_id\": \"c578b7c5-0e15-4741-8e38-8ca350563051\",\n \"created\": \"2018-12-19T06:29:02.640863Z\",\n \"modified\": \"2019-01-07T06:34:19.094658Z\",\n \"title\": \"Microsoft Outlook\",\n \"production_date\": \"2018-12-19T06:29:02.644095Z\",\n \"readable_id\": \"APL109\",\n \"title_display\": \"Microsoft Outlook\",\n \"status\": \"active\"\n },\n {\n \"unique_id\": \"31eef717-b89c-4d11-8c73-a4b6aa498acb\",\n \"created\": \"2018-12-19T06:51:41.367498Z\",\n \"modified\": \"2019-01-07T06:34:19.166447Z\",\n \"title\": \"Slack\",\n \"production_date\": \"2018-12-19T06:51:41.370665Z\",\n \"readable_id\": \"APL112\",\n \"title_display\": \"Slack\",\n \"status\": \"active\"\n },\n {\n \"unique_id\": \"a204b413-ce36-4019-9341-4f552cc8fc49\",\n \"created\": \"2018-12-17T06:36:01.332762Z\",\n \"modified\": \"2020-02-20T11:59:44.629083Z\",\n \"title\": \"OFM Well and Reservoir Analysis\",\n \"production_date\": \"2018-12-17T06:36:01.335550Z\",\n \"readable_id\": \"APL101\",\n \"title_display\": \"OFM Well and Reservoir Analysis\",\n \"status\": \"inactive\"\n },\n {\n \"unique_id\": \"4ef37041-3b28-4af1-a531-cb556b44972c\",\n \"created\": \"2019-11-15T12:23:50.396524Z\",\n \"modified\": \"2020-02-20T14:45:43.149387Z\",\n \"title\": \"Clevertap_CY\",\n \"production_date\": \"2020-02-12T18:30:00Z\",\n \"readable_id\": \"APL114\",\n \"title_display\": \"Clevertap_CY\",\n \"status\": \"inactive\"\n }\n ],\n \"softwares\": [\n \"e6d18ef1-f322-4d24-8763-a37c63ec495b\",\n \"274e783c-c0cf-4424-877d-042e0de41545\",\n \"a37dc078-5696-4a51-b03e-b381d2835631\",\n \"746d75ed-4861-4c5d-a4fe-fe76d8fcf614\",\n \"34944dca-67c3-48da-9ecb-b589472fe9ad\"\n ],\n \"softwares_data\": [\n {\n \"unique_id\": \"e6d18ef1-f322-4d24-8763-a37c63ec495b\",\n \"created\": \"2018-12-17T06:49:21.657998Z\",\n \"modified\": \"2018-12-17T06:49:21.666299Z\",\n \"title\": \"Windows Defender\",\n \"readable_id\": \"SFT108\",\n \"title_display\": \"Windows Defender\",\n \"software_status\": \"active\"\n },\n {\n \"unique_id\": \"274e783c-c0cf-4424-877d-042e0de41545\",\n \"created\": \"2018-12-19T06:30:37.279917Z\",\n \"modified\": \"2019-12-10T11:14:35.319305Z\",\n \"title\": \"acunetix web application scanner\",\n \"readable_id\": \"SFT124\",\n \"title_display\": \"acunetix web application scanner\",\n \"software_status\": \"active\"\n },\n {\n \"unique_id\": \"a37dc078-5696-4a51-b03e-b381d2835631\",\n \"created\": \"2018-12-19T06:07:23.157598Z\",\n \"modified\": \"2018-12-19T06:07:23.160355Z\",\n \"title\": \"Windows Defender Advanced Threat Protection\",\n \"readable_id\": \"SFT116\",\n \"title_display\": \"Windows Defender Advanced Threat Protection\",\n \"software_status\": \"active\"\n },\n {\n \"unique_id\": \"746d75ed-4861-4c5d-a4fe-fe76d8fcf614\",\n \"created\": \"2018-12-17T06:46:05.156749Z\",\n \"modified\": \"2018-12-17T06:46:05.159313Z\",\n \"title\": \"Quick Heal Antivirus\",\n \"readable_id\": \"SFT106\",\n \"title_display\": \"Quick Heal Antivirus\",\n \"software_status\": \"active\"\n },\n {\n \"unique_id\": \"34944dca-67c3-48da-9ecb-b589472fe9ad\",\n \"created\": \"2020-04-21T13:47:40.109271Z\",\n \"modified\": \"2020-05-08T13:52:20.347175Z\",\n \"title\": \"New Microsoft Visual Studio Express..\",\n \"readable_id\": \"SFT128\",\n \"title_display\": \"New Microsoft Visual Studio Express..\",\n \"software_status\": \"active\"\n }\n ],\n \"users\": [\n \"3040000a-434f-4c88-ae9a-c1dc01cffbf4\",\n \"4037b764-181b-4f72-b895-32ffa86115b9\",\n \"fb08a159-2007-4924-9de5-a67d538a89a8\"\n ],\n \"users_data\": [\n {\n \"unique_id\": \"3040000a-434f-4c88-ae9a-c1dc01cffbf4\",\n \"created\": \"2018-12-17T06:01:50.221405Z\",\n \"modified\": \"2019-01-23T09:34:21.911973Z\",\n \"email\": \"sophie@example.com\",\n \"employee_name\": \"Sophie Parker\",\n \"readable_id\": \"USR104\",\n \"display_name\": \"Sophie Parker\",\n \"title_display\": \"Sophie Parker\",\n \"user_status\": \"active\",\n \"threat_score\": 8.55\n },\n {\n \"unique_id\": \"4037b764-181b-4f72-b895-32ffa86115b9\",\n \"created\": \"2018-12-19T06:09:03.474896Z\",\n \"modified\": \"2019-12-03T12:59:07.282087Z\",\n \"email\": \"peter@example.com\",\n \"employee_name\": \"Peter Smith\",\n \"readable_id\": \"USR108\",\n \"display_name\": \"Peter Smith\",\n \"title_display\": \"Peter Smith\",\n \"user_status\": \"active\",\n \"threat_score\": 8.58\n },\n {\n \"unique_id\": \"fb08a159-2007-4924-9de5-a67d538a89a8\",\n \"created\": \"2019-08-17T13:07:56.081753Z\",\n \"modified\": \"2019-08-19T12:57:53.824127Z\",\n \"email\": \"mark@brown.com\",\n \"employee_name\": \"Mark Brown\",\n \"readable_id\": \"USR120\",\n \"display_name\": \"Mark Brown\",\n \"title_display\": \"Mark Brown\",\n \"user_status\": \"active\",\n \"threat_score\": 8.65\n }\n ],\n \"endpoints\": [\n \"e6523aba-3a3c-48d1-8499-820e0c01ccc0\",\n \"f98945fe-7aaa-4e87-8de0-57c0f5bedb00\",\n \"8cf84cfd-602f-4f47-9e0b-8685ee606c1c\",\n \"e9bd1fcb-03d0-488d-8ebf-a7251fc8d202\",\n \"84f572d0-9ac7-4085-abee-f504f08cee79\",\n \"f858d43d-8a5d-47a5-8227-48805dbb8661\"\n ],\n \"endpoints_data\": [\n {\n \"unique_id\": \"e6523aba-3a3c-48d1-8499-820e0c01ccc0\",\n \"created\": \"2020-03-24T01:18:45Z\",\n \"modified\": \"2020-01-09T19:26:17.753791Z\",\n \"hostname\": \"Laptop DVC 35\",\n \"serial_number\": null,\n \"readable_id\": \"DVC770\",\n \"title_display\": \"Laptop DVC 35\",\n \"ip_address\": null,\n \"mac_address\": null,\n \"endpoint_status\": \"quarantined\",\n \"threat_score\": 5.33\n },\n {\n \"unique_id\": \"f98945fe-7aaa-4e87-8de0-57c0f5bedb00\",\n \"created\": \"2020-03-24T18:16:21Z\",\n \"modified\": \"2021-09-08T06:06:46.861492Z\",\n \"hostname\": \"1A-Macbook Air\",\n \"serial_number\": \"BL90J92\",\n \"readable_id\": \"DVC730\",\n \"title_display\": \"1A-Macbook Air\",\n \"ip_address\": null,\n \"mac_address\": null,\n \"endpoint_status\": \"quarantined\",\n \"threat_score\": 10\n },\n {\n \"unique_id\": \"8cf84cfd-602f-4f47-9e0b-8685ee606c1c\",\n \"created\": \"2020-04-18T10:42:34Z\",\n \"modified\": \"2021-07-27T12:51:36.832952Z\",\n \"hostname\": \"11A-Desktop\",\n \"serial_number\": null,\n \"readable_id\": \"DVC942\",\n \"title_display\": \"11A-Desktop\",\n \"ip_address\": \"10.215.115.207\",\n \"mac_address\": null,\n \"endpoint_status\": \"inactive\",\n \"threat_score\": null\n },\n {\n \"unique_id\": \"e9bd1fcb-03d0-488d-8ebf-a7251fc8d202\",\n \"created\": \"2020-04-09T03:34:10Z\",\n \"modified\": \"2020-04-21T12:18:37.176093Z\",\n \"hostname\": \"AI241777\",\n \"serial_number\": \"1234567\",\n \"readable_id\": \"DVC943\",\n \"title_display\": \"AI241777\",\n \"ip_address\": \"172.16.0.0\",\n \"mac_address\": null,\n \"endpoint_status\": \"suspected\",\n \"threat_score\": 8.65\n },\n {\n \"unique_id\": \"84f572d0-9ac7-4085-abee-f504f08cee79\",\n \"created\": \"2020-04-12T08:44:42Z\",\n \"modified\": \"2020-07-06T20:10:38.761688Z\",\n \"hostname\": \"Laptop-DVC-935\",\n \"serial_number\": \"4CE0460D0G\",\n \"readable_id\": \"DVC935\",\n \"title_display\": \"Laptop-DVC-935\",\n \"ip_address\": \"43.224.158.234\",\n \"mac_address\": \"00:1B:44:11:3A:B7\",\n \"endpoint_status\": \"remediated\",\n \"threat_score\": 9.19\n },\n {\n \"unique_id\": \"f858d43d-8a5d-47a5-8227-48805dbb8661\",\n \"created\": \"2020-04-27T11:10:04.106674Z\",\n \"modified\": \"2020-07-02T12:14:53.611287Z\",\n \"hostname\": \"10A-Desktop1\",\n \"serial_number\": \"ser23iim3uakd0ja2hz\",\n \"readable_id\": \"DVC945\",\n \"title_display\": \"10A-Desktop1\",\n \"ip_address\": \"10.90.24.25\",\n \"mac_address\": null,\n \"endpoint_status\": \"clean\",\n \"threat_score\": 9.88\n }\n ],\n \"enhancements\": [\n \"1bbde85d-19b6-471c-845f-57d680ec369a\"\n ],\n \"enhancements_data\": [\n {\n \"title\": \"Scan closed group email attachment with [Threat Crowd]\",\n \"readable_id\": \"ENH130\",\n \"description\": \"

All the email from the server to be scanned before the user's inbox.

\",\n \"due_date\": \"2020-01-10T18:30:00Z\",\n \"created\": \"2020-01-08T11:41:52.622010Z\",\n \"modified\": \"2020-01-09T10:38:32.080975Z\",\n \"status\": \"open\",\n \"assigned_to\": null,\n \"unique_id\": \"1bbde85d-19b6-471c-845f-57d680ec369a\",\n \"assigned_to_data\": null,\n \"title_display\": \"Scan closed group email attachment with [Threat Crowd]\"\n }\n ],\n \"pirs_data\": [\n {\n \"unique_id\": \"1010f03c-a13f-42c2-b87a-af532899df50\",\n \"readable_id\": \"PIR126\",\n \"title\": \"Check with the similar incident logs with related APT source.\",\n \"status\": \"open\",\n \"created\": \"2020-01-08T11:43:55.450231Z\",\n \"modified\": \"2020-07-07T19:57:58.800771Z\",\n \"title_display\": \"Check with the similar incident logs with related APT source.\"\n }\n ],\n \"briefings\": [\n \"312ab277-c20a-46b3-a669-13761e25802a\",\n \"1f48a6ff-3742-4b44-9fc2-983c0ff19342\",\n \"233fee2b-f9b9-48ef-9b15-cd65b44ca34e\",\n \"e86cc50e-b0ea-4b86-9cb8-dc0cc22b7030\",\n \"188ccba5-90fe-4f71-93ba-33e36705c56e\",\n \"a74e8a31-16de-4313-b0e3-35ce27aa8dd1\",\n \"548ddba0-7e1d-4a61-b177-dfacb7ad8916\"\n ],\n \"briefings_data\": [\n {\n \"unique_id\": \"312ab277-c20a-46b3-a669-13761e25802a\",\n \"readable_id\": \"BRF132\",\n \"title\": \"Incident Escalated to Crisis: Possible Malicious Spear Phishing Email Attack.\",\n \"created\": \"2019-01-08T13:20:24.404416Z\",\n \"modified\": \"2020-01-10T12:48:19.470983Z\",\n \"title_display\": \"Incident Escalated to Crisis: Possible Malicious Spear Phishing Email Attack.\",\n \"status\": \"ACTIVE\"\n },\n {\n \"unique_id\": \"1f48a6ff-3742-4b44-9fc2-983c0ff19342\",\n \"readable_id\": \"BRF114\",\n \"title\": \"01/09/2018: Monthly briefing on new patches required for company laptops to ensure compliance\",\n \"created\": \"2018-05-18T12:35:16.068022Z\",\n \"modified\": \"2018-05-21T10:20:54.458365Z\",\n \"title_display\": \"01/09/2018: Monthly briefing on new patches required for company laptops to ensure compliance\",\n \"status\": \"ACTIVE\"\n },\n {\n \"unique_id\": \"233fee2b-f9b9-48ef-9b15-cd65b44ca34e\",\n \"readable_id\": \"BRF117\",\n \"title\": \"08/08/2018: Daily briefing on actions taken by security team to mitigate phishing attacks\",\n \"created\": \"2018-05-18T12:35:21.876072Z\",\n \"modified\": \"2018-05-18T14:11:47.715203Z\",\n \"title_display\": \"08/08/2018: Daily briefing on actions taken by security team to mitigate phishing attacks\",\n \"status\": \"ACTIVE\"\n },\n {\n \"unique_id\": \"e86cc50e-b0ea-4b86-9cb8-dc0cc22b7030\",\n \"readable_id\": \"BRF133\",\n \"title\": \"daily stand up of kedare's team of SOC\",\n \"created\": \"2019-01-24T11:21:09.759678Z\",\n \"modified\": \"2019-03-25T13:43:35.574316Z\",\n \"title_display\": \"daily stand up of kedare's team of SOC\",\n \"status\": \"ACTIVE\"\n },\n {\n \"unique_id\": \"188ccba5-90fe-4f71-93ba-33e36705c56e\",\n \"readable_id\": \"BRF116\",\n \"title\": \"17/02/2018: Special briefing on recent BEC scams targeting finance department\",\n \"created\": \"2018-05-18T12:35:19.898658Z\",\n \"modified\": \"2018-05-18T14:12:29.064574Z\",\n \"title_display\": \"17/02/2018: Special briefing on recent BEC scams targeting finance department\",\n \"status\": \"ACTIVE\"\n },\n {\n \"unique_id\": \"a74e8a31-16de-4313-b0e3-35ce27aa8dd1\",\n \"readable_id\": \"BRF109\",\n \"title\": \"09/03/2018: Weekly briefing on new patches required for company laptops to ensure compliance\",\n \"created\": \"2018-05-17T13:47:21.190634Z\",\n \"modified\": \"2019-01-23T09:34:53.284731Z\",\n \"title_display\": \"09/03/2018: Weekly briefing on new patches required for company laptops to ensure compliance\",\n \"status\": \"ACTIVE\"\n },\n {\n \"unique_id\": \"548ddba0-7e1d-4a61-b177-dfacb7ad8916\",\n \"readable_id\": \"BRF113\",\n \"title\": \"Weekly briefing on new security updates\",\n \"created\": \"2018-05-18T12:35:14.210534Z\",\n \"modified\": \"2020-01-10T10:24:58.655161Z\",\n \"title_display\": \"Weekly briefing on new security updates\",\n \"status\": \"INACTIVE\"\n }\n ],\n \"campaigns\": [\n \"1fb3dfee-880c-42d6-9048-c285bf88ba19\",\n \"7fb7c399-ee4e-46c7-ab7d-c37b23a7e240\",\n \"bb425b9c-8d5c-4bb0-b3ad-30df60438140\",\n \"a4768794-7c1f-49eb-8860-94e527975cfb\"\n ],\n \"campaigns_data\": [\n {\n \"title\": \"CEO Phishing attack\",\n \"unique_id\": \"1fb3dfee-880c-42d6-9048-c285bf88ba19\",\n \"readable_id\": \"CMP112\",\n \"created\": \"2018-05-18T11:54:50.194759Z\",\n \"modified\": \"2021-04-05T08:28:24.768141Z\",\n \"title_display\": \"CEO Phishing attack\",\n \"status\": \"ACTIVE\"\n },\n {\n \"title\": \"Change of user policy\",\n \"unique_id\": \"7fb7c399-ee4e-46c7-ab7d-c37b23a7e240\",\n \"readable_id\": \"CMP134\",\n \"created\": \"2019-08-17T13:12:12.258220Z\",\n \"modified\": \"2020-01-09T19:56:18.980856Z\",\n \"title_display\": \"Change of user policy\",\n \"status\": \"ACTIVE\"\n },\n {\n \"title\": \"Carbanak - Dridex Banking Trojan\",\n \"unique_id\": \"bb425b9c-8d5c-4bb0-b3ad-30df60438140\",\n \"readable_id\": \"CMP143\",\n \"created\": \"2020-07-25T13:13:20.364739Z\",\n \"modified\": \"2021-02-03T14:01:57.351910Z\",\n \"title_display\": \"Carbanak - Dridex Banking Trojan\",\n \"status\": \"ACTIVE\"\n },\n {\n \"title\": \"Targeted spear-phishing Attacks\",\n \"unique_id\": \"a4768794-7c1f-49eb-8860-94e527975cfb\",\n \"readable_id\": \"CMP102\",\n \"created\": \"2018-05-17T13:03:37.004887Z\",\n \"modified\": \"2018-05-23T10:20:28.727189Z\",\n \"title_display\": \"Targeted spear-phishing Attacks\",\n \"status\": \"ACTIVE\"\n }\n ],\n \"malwares\": [\n \"94691eba-87e4-4e22-89d7-fad2ad2ee52b\",\n \"9e1c7fbe-de11-43be-9fd9-790ee1baaf9e\",\n \"d185314a-2422-4e54-8b4a-ec2fb326454a\",\n \"f9f3523f-b326-4f66-b2ad-82582ffe925f\",\n \"59424d81-b19d-4222-9d8b-ac5e4e5cf174\",\n \"fba4c2a9-9e46-4c6a-aef1-d1299843630b\",\n \"a8039ff8-6481-405e-88a9-2cd4da71f015\"\n ],\n \"malwares_data\": [\n {\n \"unique_id\": \"94691eba-87e4-4e22-89d7-fad2ad2ee52b\",\n \"readable_id\": \"MLW105\",\n \"title\": \"TrickBot banking trojan\",\n \"status\": \"active\",\n \"created\": \"2020-04-17T13:31:57Z\",\n \"modified\": \"2021-06-14T09:59:02.947161Z\",\n \"title_display\": \"TrickBot banking trojan\"\n },\n {\n \"unique_id\": \"9e1c7fbe-de11-43be-9fd9-790ee1baaf9e\",\n \"readable_id\": \"MLW136\",\n \"title\": \"Carbanak Trojan\",\n \"status\": \"active\",\n \"created\": \"2020-03-27T00:52:06Z\",\n \"modified\": \"2020-02-26T16:13:59.591693Z\",\n \"title_display\": \"Carbanak Trojan\"\n },\n {\n \"unique_id\": \"d185314a-2422-4e54-8b4a-ec2fb326454a\",\n \"readable_id\": \"MLW118\",\n \"title\": \"Ramnit malware\",\n \"status\": \"active\",\n \"created\": \"2020-04-12T20:03:51Z\",\n \"modified\": \"2020-02-26T15:27:00.455479Z\",\n \"title_display\": \"Ramnit malware\"\n },\n {\n \"unique_id\": \"f9f3523f-b326-4f66-b2ad-82582ffe925f\",\n \"readable_id\": \"MLW115\",\n \"title\": \"Dridex Trojan\",\n \"status\": \"active\",\n \"created\": \"2020-03-30T02:20:25Z\",\n \"modified\": \"2020-07-26T18:09:16.828045Z\",\n \"title_display\": \"Dridex Trojan\"\n },\n {\n \"unique_id\": \"59424d81-b19d-4222-9d8b-ac5e4e5cf174\",\n \"readable_id\": \"MLW112\",\n \"title\": \"Shamoon malware\",\n \"status\": \"inactive\",\n \"created\": \"2020-04-17T05:45:42Z\",\n \"modified\": \"2020-04-23T11:34:05.731600Z\",\n \"title_display\": \"Shamoon malware\"\n },\n {\n \"unique_id\": \"fba4c2a9-9e46-4c6a-aef1-d1299843630b\",\n \"readable_id\": \"MLW124\",\n \"title\": \"Ordinypt Wiper\",\n \"status\": \"active\",\n \"created\": \"2020-04-14T11:04:07Z\",\n \"modified\": \"2020-02-26T15:27:00.634684Z\",\n \"title_display\": \"Ordinypt Wiper\"\n },\n {\n \"unique_id\": \"a8039ff8-6481-405e-88a9-2cd4da71f015\",\n \"readable_id\": \"MLW132\",\n \"title\": \"Davinci worm malware\",\n \"status\": \"active\",\n \"created\": \"2020-04-06T20:49:58Z\",\n \"modified\": \"2020-02-26T15:27:00.682312Z\",\n \"title_display\": \"Davinci worm malware\"\n }\n ],\n \"threat_actors\": [\n \"5ecc102e-96b3-45da-be27-c9008a8aa907\",\n \"c4b0e8cb-fd4f-472c-8981-8520cbf198ba\",\n \"67bc5b19-e576-4f5c-98d3-f198e12e62b8\",\n \"198b2aaf-09b5-42b4-8e4d-6da5e54d494e\"\n ],\n \"threat_actors_data\": [\n {\n \"unique_id\": \"5ecc102e-96b3-45da-be27-c9008a8aa907\",\n \"readable_id\": \"ATR117\",\n \"title\": \"Equation Group.\",\n \"status\": \"active\",\n \"created\": \"2018-05-18T11:34:45.737561Z\",\n \"modified\": \"2020-01-10T13:48:17.486648Z\",\n \"title_display\": \"Equation Group.\"\n },\n {\n \"unique_id\": \"c4b0e8cb-fd4f-472c-8981-8520cbf198ba\",\n \"readable_id\": \"ATR135\",\n \"title\": \"ATP on android app for category Housing\",\n \"status\": \"active\",\n \"created\": \"2019-11-15T12:07:47.113007Z\",\n \"modified\": \"2019-11-15T12:09:58.611709Z\",\n \"title_display\": \"ATP on android app for category Housing\"\n },\n {\n \"unique_id\": \"67bc5b19-e576-4f5c-98d3-f198e12e62b8\",\n \"readable_id\": \"ATR138\",\n \"title\": \"Syrian Electronic Army\",\n \"status\": \"inactive\",\n \"created\": \"2020-02-21T13:16:22.101403Z\",\n \"modified\": \"2020-02-21T13:26:55.127528Z\",\n \"title_display\": \"Syrian Electronic Army\"\n },\n {\n \"unique_id\": \"198b2aaf-09b5-42b4-8e4d-6da5e54d494e\",\n \"readable_id\": \"ATR110\",\n \"title\": \"ShadowBrokers\",\n \"status\": \"active\",\n \"created\": \"2018-05-12T13:20:16.540847Z\",\n \"modified\": \"2019-01-23T09:00:57.202945Z\",\n \"title_display\": \"ShadowBrokers\"\n }\n ],\n \"actions_data\": [\n {\n \"title\": \"Block Phishing URLs\",\n \"readable_id\": \"ACT3137\",\n \"created\": \"2020-04-12T15:43:17Z\",\n \"modified\": \"2020-01-10T06:30:03.455585Z\",\n \"status\": \"open\",\n \"unique_id\": \"8b9893ed-4bed-4368-9ac1-051bec39fdfa\",\n \"title_display\": \"Block Phishing URLs\"\n },\n {\n \"title\": \"Investigate the Event\",\n \"readable_id\": \"ACT3058\",\n \"created\": \"2020-04-18T03:20:47Z\",\n \"modified\": \"2020-02-20T10:05:01.772916Z\",\n \"status\": \"open\",\n \"unique_id\": \"464cb184-e1b6-4b6e-898d-66c488da88ca\",\n \"title_display\": \"Investigate the Event\"\n },\n {\n \"title\": \"Freeze all staff members email app access\",\n \"readable_id\": \"ACT3067\",\n \"created\": \"2020-04-05T22:07:56Z\",\n \"modified\": \"2020-01-10T06:30:03.728022Z\",\n \"status\": \"open\",\n \"unique_id\": \"87cd7245-eb05-41c5-93b2-5a1f7e65b0e3\",\n \"title_display\": \"Freeze all staff members email app access\"\n },\n {\n \"title\": \"Investigate the Asset for Malicious Process\",\n \"readable_id\": \"ACT4199\",\n \"created\": \"2020-04-03T01:57:14Z\",\n \"modified\": \"2020-04-16T15:45:16.121158Z\",\n \"status\": \"closed\",\n \"unique_id\": \"59b6dc56-993e-4a5b-9a0a-8c51d69c415d\",\n \"title_display\": \"Investigate the Asset for Malicious Process\"\n },\n {\n \"title\": \"Disable User Accounts\",\n \"readable_id\": \"ACT3138\",\n \"created\": \"2020-04-15T00:07:57Z\",\n \"modified\": \"2020-01-10T06:30:04.366811Z\",\n \"status\": \"open\",\n \"unique_id\": \"a331f3e5-210b-4921-bc1a-ca4ad9ee98b7\",\n \"title_display\": \"Disable User Accounts\"\n },\n {\n \"title\": \"Quarantine Impacted Assets\",\n \"readable_id\": \"ACT3135\",\n \"created\": \"2020-04-12T00:26:36Z\",\n \"modified\": \"2020-01-10T06:30:04.796979Z\",\n \"status\": \"open\",\n \"unique_id\": \"13e36940-0ee1-4389-a2a5-fbba4b2da320\",\n \"title_display\": \"Quarantine Impacted Assets\"\n },\n {\n \"title\": \"Perform remediation for the incident, if any\",\n \"readable_id\": \"ACT4207\",\n \"created\": \"2020-04-05T03:51:49Z\",\n \"modified\": \"2020-04-21T15:14:46.796953Z\",\n \"status\": \"open\",\n \"unique_id\": \"cf91405e-de71-4819-a0d1-a78e59fe398b\",\n \"title_display\": \"Perform remediation for the incident, if any\"\n },\n {\n \"title\": \"ACT\",\n \"readable_id\": \"ACT4210\",\n \"created\": \"2020-03-27T08:01:41Z\",\n \"modified\": \"2020-04-21T15:10:55.894960Z\",\n \"status\": \"open\",\n \"unique_id\": \"e1d8bef4-9cae-4879-9d01-6e4bd17e0742\",\n \"title_display\": \"ACT\"\n },\n {\n \"title\": \"Investigate the Asset for Malicious Process\",\n \"readable_id\": \"ACT4197\",\n \"created\": \"2020-04-09T13:08:11Z\",\n \"modified\": \"2020-04-16T14:55:34.338780Z\",\n \"status\": \"open\",\n \"unique_id\": \"f1e87a70-c529-4b02-9367-07c1dd6a8692\",\n \"title_display\": \"Investigate the Asset for Malicious Process\"\n },\n {\n \"title\": \"Block Phishing Domain @ Firewall\",\n \"readable_id\": \"ACT3136\",\n \"created\": \"2020-03-31T06:41:13Z\",\n \"modified\": \"2020-07-27T17:23:44.013393Z\",\n \"status\": \"open\",\n \"unique_id\": \"981d6cdd-e49e-426b-9064-0b7e8abddaf9\",\n \"title_display\": \"Block Phishing Domain @ Firewall\"\n },\n {\n \"title\": \"Provide learning and Closure comments of the Incident\",\n \"readable_id\": \"ACT4201\",\n \"created\": \"2020-04-17T09:25:23Z\",\n \"modified\": \"2020-04-16T15:45:23.441436Z\",\n \"status\": \"open\",\n \"unique_id\": \"f57a5ed9-d886-4d69-8d30-88519e9de7d2\",\n \"title_display\": \"Provide learning and Closure comments of the Incident\"\n },\n {\n \"title\": \"New action in Software\",\n \"readable_id\": \"ACT4205\",\n \"created\": \"2020-04-03T17:27:13Z\",\n \"modified\": \"2020-04-21T13:50:55.765617Z\",\n \"status\": \"open\",\n \"unique_id\": \"e7378d0c-0339-45ed-b0b2-22129116a207\",\n \"title_display\": \"New action in Software\"\n },\n {\n \"title\": \"Perform remediation for the incident, if any\",\n \"readable_id\": \"ACT4203\",\n \"created\": \"2020-04-03T00:38:13Z\",\n \"modified\": \"2020-04-21T12:17:03.585907Z\",\n \"status\": \"open\",\n \"unique_id\": \"edf01776-9434-4938-b357-3c11b36fddea\",\n \"title_display\": \"Perform remediation for the incident, if any\"\n },\n {\n \"title\": \"Block sender email at mail gateway\",\n \"readable_id\": \"ACT3072\",\n \"created\": \"2020-04-15T18:08:13Z\",\n \"modified\": \"2020-01-10T06:30:06.638991Z\",\n \"status\": \"open\",\n \"unique_id\": \"322f4344-1ec6-4395-9664-d72d70213f9b\",\n \"title_display\": \"Block sender email at mail gateway\"\n }\n ],\n \"vulnerabilities\": [\n \"bf4744ea-64fd-4192-9ece-ecddcf6063f3\",\n \"e2077df5-5f0b-44b7-a4b6-2f70d26184b9\",\n \"01ceb3ac-d25b-4be9-a70e-41b29171e59c\",\n \"e9a189b2-3b22-45dc-8007-0489ff9ec364\"\n ],\n \"vulnerabilities_data\": [\n {\n \"unique_id\": \"bf4744ea-64fd-4192-9ece-ecddcf6063f3\",\n \"readable_id\": \"VUL138\",\n \"title\": \"EternalBlue\",\n \"status\": \"open\",\n \"created\": \"2019-12-03T12:53:12.600097Z\",\n \"modified\": \"2020-05-08T13:46:16.698524Z\",\n \"title_display\": \"EternalBlue\",\n \"priority\": \"Medium\"\n },\n {\n \"unique_id\": \"e2077df5-5f0b-44b7-a4b6-2f70d26184b9\",\n \"readable_id\": \"VUL129\",\n \"title\": \"Privilege Escalation Vulnerability\",\n \"status\": \"open\",\n \"created\": \"2018-05-18T11:56:07.650869Z\",\n \"modified\": \"2018-07-03T15:53:55.699279Z\",\n \"title_display\": \"Privilege Escalation Vulnerability\",\n \"priority\": \"Very High\"\n },\n {\n \"unique_id\": \"01ceb3ac-d25b-4be9-a70e-41b29171e59c\",\n \"readable_id\": \"VUL130\",\n \"title\": \"Directory Traversal Vulnerability\",\n \"status\": \"open\",\n \"created\": \"2018-05-18T11:56:09.355409Z\",\n \"modified\": \"2018-07-03T15:53:55.739564Z\",\n \"title_display\": \"Directory Traversal Vulnerability\",\n \"priority\": \"Very High\"\n },\n {\n \"unique_id\": \"e9a189b2-3b22-45dc-8007-0489ff9ec364\",\n \"readable_id\": \"VUL108\",\n \"title\": \"SQL Injection Vulnerability\",\n \"status\": \"closed\",\n \"created\": \"2018-05-17T12:51:29.591297Z\",\n \"modified\": \"2020-01-10T12:00:40.243647Z\",\n \"title_display\": \"SQL Injection Vulnerability\",\n \"priority\": \"Medium\"\n }\n ],\n \"attachments_data\": [\n {\n \"title\": \"incident-April-10-2020.html\",\n \"description\": null,\n \"uploaded_file\": \"https://demov2-internal.example.com/cftrbucket/ciims-data/de4cf71b-incident-April-10-2020.html?AWSAccessKeyId=minio&Signature=%2B2ci%2FlpobrurG4sr0VD0kbBQJ4U%3D&Expires=1642752643\",\n \"unique_id\": \"ea1fdadc-8752-4029-a6fd-ec3ded9e24c9\",\n \"created_by_data\": {\n \"username\": \"annaharris\",\n \"first_name\": \"Anna\",\n \"last_name\": \"Harris\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"be43156f-97f3-48d4-be8b-3b533574efed\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"anna.harris@example.com\",\n \"full_name\": \"Anna Harris\"\n },\n \"created\": \"2020-04-21T14:26:32.220943Z\",\n \"modified\": \"2020-04-21T14:28:26.344956Z\",\n \"readable_id\": \"ART234\",\n \"is_removed\": false,\n \"readable_id_counter\": 234,\n \"file_hash\": \"a8d0c3026760d8b1ea911339e3ff58ed\",\n \"file_type\": \"artifact\",\n \"file_size\": 362836,\n \"can_delete\": false,\n \"parent_readable_id\": \"INC1737\",\n \"parent_component\": \"incident\",\n \"parent_unique_id\": \"af04369e-27d9-4f0d-8f38-9c4788a7e35b\"\n },\n {\n \"title\": \"raw_text.txt\",\n \"description\": null,\n \"uploaded_file\": \"https://demov2-internal.example.com/cftrbucket/ciims-data/b0b5371b-raw_text.txt?AWSAccessKeyId=minio&Signature=jc%2Fqp0ZCbN1%2Bl0plOd3CDeO7cJI%3D&Expires=1642752643\",\n \"unique_id\": \"79191ee3-34af-43a0-996d-2d4c90ba315a\",\n \"created_by_data\": {\n \"username\": \"annaharris\",\n \"first_name\": \"Anna\",\n \"last_name\": \"Harris\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"be43156f-97f3-48d4-be8b-3b533574efed\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"anna.harris@example.com\",\n \"full_name\": \"Anna Harris\"\n },\n \"created\": \"2020-01-09T14:05:19.383129Z\",\n \"modified\": \"2020-04-21T14:26:19.410070Z\",\n \"readable_id\": \"ART160\",\n \"is_removed\": false,\n \"readable_id_counter\": 160,\n \"file_hash\": \"a68b2482a6c645a9738329909861afb3\",\n \"file_type\": \"evidence\",\n \"file_size\": 50000,\n \"can_delete\": false,\n \"parent_readable_id\": \"INC1737\",\n \"parent_component\": \"incident\",\n \"parent_unique_id\": \"af04369e-27d9-4f0d-8f38-9c4788a7e35b\"\n },\n {\n \"title\": \"san.mpeg.mpeg\",\n \"description\": null,\n \"uploaded_file\": \"https://demov2-internal.example.com/cftrbucket/ciims-data/64bc0fd6-san.mpeg.mpeg?AWSAccessKeyId=minio&Signature=VqIbA6tw2d%2B085WwzAHtx%2BbTFrc%3D&Expires=1642752643\",\n \"unique_id\": \"a9ad63a3-7251-486b-a33a-0ab31525e7f7\",\n \"created_by_data\": {\n \"username\": \"annaharris\",\n \"first_name\": \"Anna\",\n \"last_name\": \"Harris\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"be43156f-97f3-48d4-be8b-3b533574efed\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"anna.harris@example.com\",\n \"full_name\": \"Anna Harris\"\n },\n \"created\": \"2020-01-09T14:06:07.359650Z\",\n \"modified\": \"2020-01-09T14:06:09.176999Z\",\n \"readable_id\": \"ART164\",\n \"is_removed\": false,\n \"readable_id_counter\": 164,\n \"file_hash\": \"4a1e4325031b13f933ac4f1db9ecb63f\",\n \"file_type\": \"miscellaneous\",\n \"file_size\": 200000,\n \"can_delete\": false,\n \"parent_readable_id\": \"INC1737\",\n \"parent_component\": \"incident\",\n \"parent_unique_id\": \"af04369e-27d9-4f0d-8f38-9c4788a7e35b\"\n },\n {\n \"title\": \"File.zip\",\n \"description\": null,\n \"uploaded_file\": \"https://demov2-internal.example.com/cftrbucket/ciims-data/c96d639e-File.zip?AWSAccessKeyId=minio&Signature=cpIJ7TjNaU1cl9lov%2FqKjBhHhd0%3D&Expires=1642752643\",\n \"unique_id\": \"17ba9f62-6345-4227-ba95-63c2c8758bfb\",\n \"created_by_data\": {\n \"username\": \"annaharris\",\n \"first_name\": \"Anna\",\n \"last_name\": \"Harris\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"be43156f-97f3-48d4-be8b-3b533574efed\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"anna.harris@example.com\",\n \"full_name\": \"Anna Harris\"\n },\n \"created\": \"2020-01-09T14:05:40.379033Z\",\n \"modified\": \"2020-01-09T14:05:42.183676Z\",\n \"readable_id\": \"ART163\",\n \"is_removed\": false,\n \"readable_id_counter\": 163,\n \"file_hash\": \"50e8c39289ca4807c0a103a79cb2262a\",\n \"file_type\": \"evidence\",\n \"file_size\": 150000,\n \"can_delete\": false,\n \"parent_readable_id\": \"INC1737\",\n \"parent_component\": \"incident\",\n \"parent_unique_id\": \"af04369e-27d9-4f0d-8f38-9c4788a7e35b\"\n },\n {\n \"title\": \"evidence.json\",\n \"description\": null,\n \"uploaded_file\": \"https://demov2-internal.example.com/cftrbucket/ciims-data/c92c9522-evidence.json?AWSAccessKeyId=minio&Signature=X31ju2yPfl8u%2B%2F%2FK6hjSzux1PU0%3D&Expires=1642752643\",\n \"unique_id\": \"c9742a35-6cd9-4779-a20d-9f3e97f135fd\",\n \"created_by_data\": {\n \"username\": \"annaharris\",\n \"first_name\": \"Anna\",\n \"last_name\": \"Harris\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"be43156f-97f3-48d4-be8b-3b533574efed\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"anna.harris@example.com\",\n \"full_name\": \"Anna Harris\"\n },\n \"created\": \"2020-01-09T14:05:33.505507Z\",\n \"modified\": \"2020-01-09T14:05:34.705751Z\",\n \"readable_id\": \"ART162\",\n \"is_removed\": false,\n \"readable_id_counter\": 162,\n \"file_hash\": \"b85d6fb9ef4260dcf1ce0a1b0bff80d3\",\n \"file_type\": \"evidence\",\n \"file_size\": 10000,\n \"can_delete\": false,\n \"parent_readable_id\": \"INC1737\",\n \"parent_component\": \"incident\",\n \"parent_unique_id\": \"af04369e-27d9-4f0d-8f38-9c4788a7e35b\"\n },\n {\n \"title\": \"log-img.jpeg\",\n \"description\": null,\n \"uploaded_file\": \"https://demov2-internal.example.com/cftrbucket/ciims-data/cd7a9c48-log-img.jpeg?AWSAccessKeyId=minio&Signature=4R42Epurb7F1g67zUPpmO9xBPlA%3D&Expires=1642752643\",\n \"unique_id\": \"977ca90b-5f02-41d8-9125-3e556f76c3f5\",\n \"created_by_data\": {\n \"username\": \"annaharris\",\n \"first_name\": \"Anna\",\n \"last_name\": \"Harris\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"be43156f-97f3-48d4-be8b-3b533574efed\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"anna.harris@example.com\",\n \"full_name\": \"Anna Harris\"\n },\n \"created\": \"2020-01-09T14:05:25.416887Z\",\n \"modified\": \"2020-01-09T14:05:27.161325Z\",\n \"readable_id\": \"ART161\",\n \"is_removed\": false,\n \"readable_id_counter\": 161,\n \"file_hash\": \"0019d23bef56a136a1891211d7007f6f\",\n \"file_type\": \"artifact\",\n \"file_size\": 100000,\n \"can_delete\": false,\n \"parent_readable_id\": \"INC1737\",\n \"parent_component\": \"incident\",\n \"parent_unique_id\": \"af04369e-27d9-4f0d-8f38-9c4788a7e35b\"\n },\n {\n \"title\": \"Server Logs.txt\",\n \"description\": null,\n \"uploaded_file\": \"https://demov2-internal.example.com/cftrbucket/ciims-data/b4e3cc9d-Server_Logs.txt?AWSAccessKeyId=minio&Signature=KsFEc8wIroN6I5cUXyt%2F4UWMq8A%3D&Expires=1642752643\",\n \"unique_id\": \"2670f48a-fff0-4ee9-9540-b3ce85d31bde\",\n \"created_by_data\": {\n \"username\": \"annaharris\",\n \"first_name\": \"Anna\",\n \"last_name\": \"Harris\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"be43156f-97f3-48d4-be8b-3b533574efed\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"anna.harris@example.com\",\n \"full_name\": \"Anna Harris\"\n },\n \"created\": \"2020-01-08T11:30:41.623248Z\",\n \"modified\": \"2020-01-08T11:32:06.196726Z\",\n \"readable_id\": \"ART157\",\n \"is_removed\": false,\n \"readable_id_counter\": 157,\n \"file_hash\": \"cf40a1de3f93b4a025409b5efa5aa210\",\n \"file_type\": \"artifact\",\n \"file_size\": 2000,\n \"can_delete\": false,\n \"parent_readable_id\": \"INC1737\",\n \"parent_component\": \"incident\",\n \"parent_unique_id\": \"af04369e-27d9-4f0d-8f38-9c4788a7e35b\"\n },\n {\n \"title\": \"IP class.jpg\",\n \"description\": null,\n \"uploaded_file\": \"https://demov2-internal.example.com/cftrbucket/ciims-data/29c60e43-IP_class.jpg?AWSAccessKeyId=minio&Signature=3PITs7LC8oqbuy7OCwsrVqTDI2s%3D&Expires=1642752643\",\n \"unique_id\": \"d74093fe-8a9b-415c-9040-2615b43e1b5e\",\n \"created_by_data\": {\n \"username\": \"annaharris\",\n \"first_name\": \"Anna\",\n \"last_name\": \"Harris\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"be43156f-97f3-48d4-be8b-3b533574efed\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"anna.harris@example.com\",\n \"full_name\": \"Anna Harris\"\n },\n \"created\": \"2020-01-08T11:31:43.640272Z\",\n \"modified\": \"2020-01-08T11:31:45.586868Z\",\n \"readable_id\": \"ART158\",\n \"is_removed\": false,\n \"readable_id_counter\": 158,\n \"file_hash\": \"62d5a8b752bf418d816da8b9586216be\",\n \"file_type\": \"miscellaneous\",\n \"file_size\": 246792,\n \"can_delete\": false,\n \"parent_readable_id\": \"INC1737\",\n \"parent_component\": \"incident\",\n \"parent_unique_id\": \"af04369e-27d9-4f0d-8f38-9c4788a7e35b\"\n }\n ],\n \"related_incidents\": [],\n \"related_incidents_data\": [],\n \"ioc\": null,\n \"config\": null,\n \"ie_malware_analysis_summary\": null,\n \"recovery_details\": \"

All the suspected email attachments recovered

\",\n \"char_field_6\": \"101029\",\n \"incident_learning\": \"

Apply 2-step incoming message

\",\n \"containment_ip\": \"160.153.32.169\",\n \"alert_source_id\": null,\n \"passive_dns_query_type\": null,\n \"ie_port_numbers_impacted\": \"

3012

\",\n \"summary_card_host_pairs\": null,\n \"ie_invegtigation_eradication_exception\": null,\n \"ie_log_analysis_summary\": \"

Final URL

https://air-alaska.com/

Serving IP Address

160.153.32.165

Status Code

200

Body Length

22.37 KB

Headers

cache-control

no-store, no-cache, must-revalidate, post-check=0, pre-check=0

text/html; charset=utf-8

date

Wed, 08 Jan 2020 10:54:59 GMT

expires

Wed, 17 Aug 2005 00:00:00 GMT

last-modified

Wed, 08 Jan 2020 10:54:59 GMT

8104ffe99c9dc59c47786e56dda8cbee=e73945uqch8iel9cpujq4kkii4; path=/; HttpOnly

upgrade

h2,h2c

vary

Accept-Encoding,User-Agent

x-powered-by

PHP/5.6.40

HTML

Title

Home - alaska Aviation

Meta Tags

author

Super User

generator

Joomla! - Open Source Content Management

viewport

width=device-width, initial-scale=1.0

\",\n \"base_line_changes\": \"

Not applicable

\",\n \"methods_monitor_recovery_actions\": \"

Scan Attachment

\",\n \"containment_hash\": null,\n \"closure_comments\": \"

User account recovered and marked protected

\",\n \"methods_validate_recovery_actions\": \"

Scan & Enrich

\",\n \"containment_result\": \"Mail access restricted\",\n \"ie_forensics_details\": null,\n \"containment_url\": \"mail.air.alaska\",\n \"ioc_other\": null,\n \"summary_card_hashes\": null,\n \"ie_findings_summary\": \"

I completed the investigation

\",\n \"summary_card_components\": null,\n \"containment_host\": \"staff.air.member\",\n \"char_field_38\": null,\n \"summary_card_certificates\": null,\n \"ie_impact_on_intellectual_property\": null,\n \"summary_card_services\": null,\n \"summary_card_cookies\": null,\n \"domain_ioc\": null,\n \"sender_ip\": null,\n \"recipient_address\": null,\n \"ip_ioc\": null,\n \"summary_card_trackers\": null,\n \"summary_card_resolutions\": null,\n \"summary_card_articles\": null,\n \"server\": null,\n \"summary_card_projects\": null,\n \"file_path\": null,\n \"summary_card_reverse_dns\": null,\n \"host_name_infrastructure_alert\": null,\n \"recommended_actions\": null,\n \"affected_host\": null,\n \"incident_user_cftr_id\": null,\n \"incident_user\": null,\n \"verbose_data\": null,\n \"confidence_score\": null,\n \"ie_num_of_assets_impacted\": null,\n \"passive_dns_records\": null,\n \"ie_num_of_users_impacted\": null,\n \"ip_contained\": null,\n \"who.is_record_count\": null,\n \"new_summary\": null,\n \"ie_regulatory_reporting_date\": \"2020-01-30T18:30:00Z\",\n \"passive_dns_last_seen\": null,\n \"submitted_date\": null,\n \"passive_dns_first_seen\": null,\n \"ie_regulatory_notifications_required\": null,\n \"ie_customer_notification_required\": \"Yes - Something\",\n \"false_positive\": \"No\",\n \"ie_root_cause\": \"Misconfiguration\",\n \"test_severity\": null,\n \"text_fields\": null,\n \"kill_chain_phase\": \"Installation\",\n \"tlp\": null,\n \"action\": null,\n \"ioc_SHA1\": [\n \"99d9a54d-b574-41c6-94e2-9ff3b6be6439\",\n \"e57e6ea3-6bb3-48a9-802c-967dde1219c7\"\n ],\n \"ie_regulatory_reporting\": [],\n \"ie_motives\": [\n \"Business Disruption\",\n \"Data Theft\",\n \"Financial Loss\"\n ],\n \"ioc_MD5\": [\n \"db26607c-5d76-4d05-b43d-f271f185a809\",\n \"499d06cd-88aa-4408-9f24-3d0928cc9b4e\"\n ],\n \"ioc_test_doc\": [],\n \"ioc_type\": [],\n \"criticality\": [],\n \"ioc_registry_key\": [],\n \"physical_locations\": [],\n \"ioc_SHA256\": [\n \"4aab0c3e-f5a7-469e-9f70-592dde177661\",\n \"28ac26c1-d436-4e5c-8d5d-91226fddf782\"\n ],\n \"ioc_ip\": [\n \"4851a726-c582-4c11-81ef-183673cca93e\",\n \"38370a34-6e94-4941-8b57-8a5c064f3eb3\",\n \"70209552-83a1-448a-80d0-710a5eb83bd0\",\n \"b4926c1c-f909-470b-94aa-f10e766cf8ca\",\n \"0d65ae31-516a-43f5-beb4-8670927af2c2\",\n \"528ebcd5-f51e-4a35-a701-433fcbf57b1a\"\n ],\n \"ioc_url\": [\n \"fada1950-d559-47ea-b6a5-d8849b15383d\",\n \"3c979361-7308-4c2e-9238-429c88b06c3d\",\n \"146d65a1-7602-4fa2-9c4b-6caf5cac8be9\"\n ],\n \"ioc_domain\": [\n \"816d21e1-e475-4bde-9509-d3c993393c1e\"\n ],\n \"ioc_fqfn_-_fully_qualified_file_name\": [],\n \"ioc_credit_card\": [],\n \"ioc_email\": [\n \"977416df-c6c5-40f2-a2c8-bdc3dd02ae61\",\n \"02767a53-49fc-466e-a821-2b110d31f254\",\n \"a6469d3d-4c09-44de-9bc5-7985007568dd\"\n ],\n \"ioc_custom\": [],\n \"unique_id\": \"af04369e-27d9-4f0d-8f38-9c4788a7e35b\",\n \"readable_id\": \"INC1737\",\n \"created\": \"2020-02-01T22:36:03Z\",\n \"description\": \"

On Jan 2, 2020, Air Alaska Air-points program participants were notified that their personal data was affected in a data breach due to a group of employees falling victim to an email phishing attack..

\",\n \"modified\": \"2020-10-12T13:13:10.130133Z\",\n \"title\": \"\\\"Air Alaska\\\" falls victim to a data breach affecting over 10150 Air-points staff members.\",\n \"machine_generated\": false,\n \"incident_date\": \"2020-02-16T07:16:26Z\",\n \"detection_date\": \"2020-01-01T18:30:00Z\",\n \"status\": \"open\",\n \"machine_name\": null,\n \"closed_on\": null,\n \"ie_num_of_pii_exposed\": 34,\n \"title_display\": \"\\\"Air Alaska\\\" falls victim to a data breach affecting over 10150 Air-points staff members.\",\n \"days_open\": 719,\n \"alert_type\": \"incident\",\n \"is_protected\": false,\n \"is_removed\": false,\n \"level\": \"High\",\n \"types\": [\n \"7115b055-a4da-4a17-9c46-6fa4c0414a61\",\n \"a5126521-aecf-4ef8-8446-3fbded2ca6b1\",\n \"ce9fd9d1-78c3-4feb-bcd4-22f99c7da305\",\n \"1ace271b-91c6-4da5-be8d-a8eb7dddbbb2\",\n \"925459a6-0ff8-4389-8fc3-fa3e4a500195\",\n \"de8c7dc4-097f-4fbe-8ffe-09e6d4f7c7f5\"\n ],\n \"phase\": \"Test 1\",\n \"ie_incident_type\": \"Phishing\",\n \"is_paused\": false,\n \"opened_on\": \"2020-01-08T10:49:39.829367Z\",\n \"can_close_instance\": true,\n \"assignment_sla\": null,\n \"resolution_sla\": null,\n \"total_cost\": 415886.57,\n \"time_to_detect\": {\n \"days\": -46,\n \"hours\": 11,\n \"minutes\": 13,\n \"seconds\": 34\n },\n \"time_to_resolve\": null,\n \"is_bookmarked\": true,\n \"permanently_closed\": false,\n \"resolution_due_date\": null,\n \"total_ownership_duration\": {\n \"days\": 743,\n \"hours\": 21,\n \"minutes\": 19,\n \"seconds\": 3\n },\n \"can_update_instance\": true,\n \"paused_by\": null,\n \"paused_by_data\": null,\n \"opened_by_data\": null,\n \"parent_data\": null,\n \"modified_by_data\": {\n \"username\": \"jacob\",\n \"first_name\": \"Jake\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"431976ad-bc70-4bdd-9b00-349a84412549\",\n \"is_active\": false,\n \"email\": \"jacob.smith@example.com\",\n \"full_name\": \"Jake Smith\"\n },\n \"assigned_group\": \"776a0b27-83b8-4819-835f-2f0bfda5001d\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"776a0b27-83b8-4819-835f-2f0bfda5001d\",\n \"group_name\": \"SOC L1 Analyst Group\"\n },\n \"created_by\": \"be43156f-97f3-48d4-be8b-3b533574efed\",\n \"created_by_data\": {\n \"username\": \"annaharris\",\n \"first_name\": \"Anna\",\n \"last_name\": \"Harris\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"be43156f-97f3-48d4-be8b-3b533574efed\",\n \"is_active\": true,\n \"email\": \"anna.harris@example.com\",\n \"full_name\": \"Anna Harris\"\n },\n \"closed_by_data\": null,\n \"assigned_to\": null,\n \"assigned_to_data\": {},\n \"schema\": \"5ca19332-75e2-4e1b-953a-22f8b467ea1d\",\n \"schema_data\": {\n \"title\": \"NIST\",\n \"description\": null,\n \"unique_id\": \"5ca19332-75e2-4e1b-953a-22f8b467ea1d\",\n \"phase_flow\": \"LINEAR\"\n },\n \"sources\": [\n \"25d394da-80bb-4925-ab8f-d83fa29a02c0\"\n ],\n \"sources_data\": {\n \"unique_id\": \"25d394da-80bb-4925-ab8f-d83fa29a02c0\",\n \"source_type\": \"a0b3a3d0-69e2-4ded-84bf-0160c4439a0a\",\n \"value\": \"Email\",\n \"source_type_data\": {\n \"unique_id\": \"a0b3a3d0-69e2-4ded-84bf-0160c4439a0a\",\n \"created\": \"2018-05-18T12:42:36.508118Z\",\n \"title\": \"Internal Employee\"\n },\n \"created\": \"2018-05-18T12:45:41.133324Z\",\n \"source_display_name\": \"Internal Employee-Email\",\n \"modified\": \"2018-05-18T12:45:41.134641Z\"\n },\n \"labels\": [\n \"41510eae-3a7e-41be-9baa-93f0e6c94476\",\n \"6021c233-e259-4d9a-9e69-7a2000e7b96c\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"41510eae-3a7e-41be-9baa-93f0e6c94476\",\n \"title\": \"L2 - Critical\",\n \"color_code\": \"#060E96\",\n \"created\": \"2019-02-11T15:43:33.129081Z\",\n \"modified\": \"2020-01-10T06:07:20.970091Z\"\n },\n {\n \"unique_id\": \"6021c233-e259-4d9a-9e69-7a2000e7b96c\",\n \"title\": \"Security Event - L2\",\n \"color_code\": \"#045F14\",\n \"created\": \"2019-02-11T17:18:10.745489Z\",\n \"modified\": \"2020-01-10T06:08:52.275239Z\"\n }\n ],\n \"tactic_technique_pair\": [\n \"d02ff831-1325-4723-87d7-24ae3c622251\",\n \"fd8beb1e-edaf-4ca4-a37a-4559bcf10670\"\n ],\n \"tactic_technique_pair_data\": [\n {\n \"unique_id\": \"d02ff831-1325-4723-87d7-24ae3c622251\",\n \"attack_technique_data\": {\n \"title\": \"Exploit Public-Facing Application\",\n \"unique_id\": \"7108ddb6-7b4f-483f-8bdc-054a0afc0a3e\"\n },\n \"attack_tactic_data\": {\n \"title\": \"Initial Access\",\n \"unique_id\": \"e9e9ca00-bcdb-43ca-99cf-755e3179100c\"\n },\n \"sub_technique_data\": null\n },\n {\n \"unique_id\": \"fd8beb1e-edaf-4ca4-a37a-4559bcf10670\",\n \"attack_technique_data\": {\n \"title\": \"Valid Accounts\",\n \"unique_id\": \"bb4bcc96-bcc9-46cf-92c8-1e5a0f4105a2\"\n },\n \"attack_tactic_data\": {\n \"title\": \"Initial Access\",\n \"unique_id\": \"e9e9ca00-bcdb-43ca-99cf-755e3179100c\"\n },\n \"sub_technique_data\": null\n }\n ],\n \"business_units_impacted_data\": {\n \"title\": \"Commercial\",\n \"unique_id\": \"dcfed0ce-aca0-494b-9cc9-3e5a44ef2e84\"\n },\n \"locations_impacted_data\": [\n {\n \"title\": \"Austin\",\n \"unique_id\": \"47c2896b-4d43-4d49-af14-7df5ad5959b6\"\n },\n {\n \"title\": \"California\",\n \"unique_id\": \"3fb76dd5-508c-49d3-aeb5-f95cea0a9d7b\"\n },\n {\n \"title\": \"Charlotte\",\n \"unique_id\": \"7c79b6bf-572f-446c-ae9c-fad344a720f6\"\n },\n {\n \"title\": \"Chengdu\",\n \"unique_id\": \"e6723fef-b8f0-47ba-9635-3f3b09277a9e\"\n },\n {\n \"title\": \"Kalisz\",\n \"unique_id\": \"a24b49b9-386f-4f22-ac22-67e42e8df721\"\n },\n {\n \"title\": \"New York\",\n \"unique_id\": \"53783cf3-1d04-42d9-a6af-31f5b5c58516\"\n },\n {\n \"title\": \"Shanghai\",\n \"unique_id\": \"f39de1a7-8314-497d-90d1-d7ae31fa602a\"\n }\n ],\n \"phase_data\": {\n \"unique_id\": \"6c1bdc29-94eb-488f-8797-584bce3a6676\",\n \"option_name\": \"Test 1\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"a351c231-be7c-4403-80ea-316f0d967576\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"ie_incident_type_data\": {\n \"unique_id\": \"7115b055-a4da-4a17-9c46-6fa4c0414a61\",\n \"option_name\": \"Phishing\",\n \"is_active\": true,\n \"order\": 9,\n \"option_field\": \"85abb58b-ac00-4a5b-83be-75110320a2f3\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"level_data\": {\n \"unique_id\": \"c82037c9-67b4-40d4-a740-738c0c9bac72\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"3e5a9dbc-da69-43ba-bab3-d8d5e429fe3b\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"ie_root_cause_data\": {\n \"unique_id\": \"cca8d495-06dd-4d19-95b3-a0e55801988a\",\n \"option_name\": \"Misconfiguration\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"86787f1d-4e73-44f4-93bd-2a180cf1dcc0\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"ie_customer_notification_required_data\": {\n \"unique_id\": \"7848a822-702c-419e-a8de-6a511e9284fb\",\n \"option_name\": \"Yes - Something\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"2b053078-9d1d-4338-aa10-5e560115d69f\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"false_positive_data\": {\n \"unique_id\": \"91da417c-6100-420e-97ff-de8ad52d9440\",\n \"option_name\": \"No\",\n \"is_active\": true,\n \"order\": 1002,\n \"option_field\": \"9b67839d-4e68-44f9-9a32-a929730f105d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"kill_chain_phase_data\": {\n \"unique_id\": \"e05bf009-fd41-4a16-bf3b-a09aa691d964\",\n \"option_name\": \"Installation\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"cce4a987-79a3-4ac6-a00e-6229f0d65700\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"tlp_data\": null,\n \"physical_locations_data\": [],\n \"action_data\": null,\n \"test_severity_data\": null,\n \"text_fields_data\": null,\n \"ioc_type_data\": [],\n \"ie_regulatory_reporting_data\": [],\n \"criticality_data\": [],\n \"ie_regulatory_notifications_required_data\": null,\n \"ie_motives_data\": [\n {\n \"unique_id\": \"90da6058-927b-4751-9e94-89522928709b\",\n \"option_name\": \"Business Disruption\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"94039863-45b0-4199-878b-b35d475760ed\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n {\n \"unique_id\": \"e3afa351-cc38-439b-a61d-ce9f547eb6bc\",\n \"option_name\": \"Data Theft\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"94039863-45b0-4199-878b-b35d475760ed\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n {\n \"unique_id\": \"19f56a76-adad-4e0a-b95f-9a1f6e5cfc88\",\n \"option_name\": \"Financial Loss\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"94039863-45b0-4199-878b-b35d475760ed\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n }\n ],\n \"ioc_custom_data\": [],\n \"ioc_ip_data\": [\n {\n \"unique_id\": \"4851a726-c582-4c11-81ef-183673cca93e\",\n \"created\": \"2020-04-21T14:36:31.052753Z\",\n \"modified\": \"2020-04-21T14:36:31.077224Z\",\n \"value\": \"12.32.44.6\",\n \"ioc_type\": \"5a60c40f-975e-400a-be29-768dc70b98ba\",\n \"ioc_type_data\": {\n \"title\": \"ioc_ip\",\n \"unique_id\": \"5a60c40f-975e-400a-be29-768dc70b98ba\",\n \"created\": \"2018-05-17T13:59:12.068798Z\",\n \"modified\": \"2021-02-03T12:27:33.732466Z\",\n \"display_name\": \"IP\"\n },\n \"tlp\": \"WHITE\",\n \"status\": \"none\"\n },\n {\n \"unique_id\": \"38370a34-6e94-4941-8b57-8a5c064f3eb3\",\n \"created\": \"2018-12-18T04:53:27.900057Z\",\n \"modified\": \"2020-02-20T10:46:23.206930Z\",\n \"value\": \"8.8.8.8\",\n \"ioc_type\": \"5a60c40f-975e-400a-be29-768dc70b98ba\",\n \"ioc_type_data\": {\n \"title\": \"ioc_ip\",\n \"unique_id\": \"5a60c40f-975e-400a-be29-768dc70b98ba\",\n \"created\": \"2018-05-17T13:59:12.068798Z\",\n \"modified\": \"2021-02-03T12:27:33.732466Z\",\n \"display_name\": \"IP\"\n },\n \"tlp\": \"GREEN\",\n \"status\": \"none\"\n },\n {\n \"unique_id\": \"70209552-83a1-448a-80d0-710a5eb83bd0\",\n \"created\": \"2020-01-08T12:52:02.785676Z\",\n \"modified\": \"2020-04-07T06:40:09.965519Z\",\n \"value\": \"0:0:0:0:0:ffff:a099:20a5\",\n \"ioc_type\": \"5a60c40f-975e-400a-be29-768dc70b98ba\",\n \"ioc_type_data\": {\n \"title\": \"ioc_ip\",\n \"unique_id\": \"5a60c40f-975e-400a-be29-768dc70b98ba\",\n \"created\": \"2018-05-17T13:59:12.068798Z\",\n \"modified\": \"2021-02-03T12:27:33.732466Z\",\n \"display_name\": \"IP\"\n },\n \"tlp\": \"RED\",\n \"status\": \"malicious\"\n },\n {\n \"unique_id\": \"b4926c1c-f909-470b-94aa-f10e766cf8ca\",\n \"created\": \"2020-04-21T14:36:31.056294Z\",\n \"modified\": \"2020-04-21T14:36:31.078027Z\",\n \"value\": \"6.4.32.2\",\n \"ioc_type\": \"5a60c40f-975e-400a-be29-768dc70b98ba\",\n \"ioc_type_data\": {\n \"title\": \"ioc_ip\",\n \"unique_id\": \"5a60c40f-975e-400a-be29-768dc70b98ba\",\n \"created\": \"2018-05-17T13:59:12.068798Z\",\n \"modified\": \"2021-02-03T12:27:33.732466Z\",\n \"display_name\": \"IP\"\n },\n \"tlp\": \"WHITE\",\n \"status\": \"none\"\n },\n {\n \"unique_id\": \"0d65ae31-516a-43f5-beb4-8670927af2c2\",\n \"created\": \"2020-01-08T12:52:02.787744Z\",\n \"modified\": \"2020-01-09T18:44:13.760627Z\",\n \"value\": \"160.153.32.165\",\n \"ioc_type\": \"5a60c40f-975e-400a-be29-768dc70b98ba\",\n \"ioc_type_data\": {\n \"title\": \"ioc_ip\",\n \"unique_id\": \"5a60c40f-975e-400a-be29-768dc70b98ba\",\n \"created\": \"2018-05-17T13:59:12.068798Z\",\n \"modified\": \"2021-02-03T12:27:33.732466Z\",\n \"display_name\": \"IP\"\n },\n \"tlp\": \"WHITE\",\n \"status\": \"false_positive\"\n },\n {\n \"unique_id\": \"528ebcd5-f51e-4a35-a701-433fcbf57b1a\",\n \"created\": \"2020-01-08T11:06:17.385791Z\",\n \"modified\": \"2020-02-20T14:15:09.261977Z\",\n \"value\": \"160.153.32.161\",\n \"ioc_type\": \"5a60c40f-975e-400a-be29-768dc70b98ba\",\n \"ioc_type_data\": {\n \"title\": \"ioc_ip\",\n \"unique_id\": \"5a60c40f-975e-400a-be29-768dc70b98ba\",\n \"created\": \"2018-05-17T13:59:12.068798Z\",\n \"modified\": \"2021-02-03T12:27:33.732466Z\",\n \"display_name\": \"IP\"\n },\n \"tlp\": \"GREEN\",\n \"status\": \"false_positive\"\n }\n ],\n \"ioc_domain_data\": [\n {\n \"unique_id\": \"816d21e1-e475-4bde-9509-d3c993393c1e\",\n \"created\": \"2020-01-08T11:02:41.173493Z\",\n \"modified\": \"2020-01-08T11:02:41.208364Z\",\n \"value\": \"staff.member.air\",\n \"ioc_type\": \"b7946581-ddb4-4e83-98a7-9f796483b12b\",\n \"ioc_type_data\": {\n \"title\": \"ioc_domain\",\n \"unique_id\": \"b7946581-ddb4-4e83-98a7-9f796483b12b\",\n \"created\": \"2018-05-17T13:59:30.101380Z\",\n \"modified\": \"2021-02-03T12:27:33.825904Z\",\n \"display_name\": \"Domain\"\n },\n \"tlp\": \"WHITE\",\n \"status\": \"blocked\"\n }\n ],\n \"ioc_url_data\": [\n {\n \"unique_id\": \"fada1950-d559-47ea-b6a5-d8849b15383d\",\n \"created\": \"2020-01-10T13:58:54.285602Z\",\n \"modified\": \"2020-01-10T13:58:54.365316Z\",\n \"value\": \"http://www.trenz.pl\",\n \"ioc_type\": \"a783ca1b-b6b3-43ec-a60a-6e4415434a3c\",\n \"ioc_type_data\": {\n \"title\": \"ioc_url\",\n \"unique_id\": \"a783ca1b-b6b3-43ec-a60a-6e4415434a3c\",\n \"created\": \"2018-05-17T14:07:56.826705Z\",\n \"modified\": \"2021-02-03T12:27:33.923007Z\",\n \"display_name\": \"URL\"\n },\n \"tlp\": \"WHITE\",\n \"status\": \"none\"\n },\n {\n \"unique_id\": \"3c979361-7308-4c2e-9238-429c88b06c3d\",\n \"created\": \"2020-01-08T11:08:44.215954Z\",\n \"modified\": \"2020-01-08T11:08:44.260409Z\",\n \"value\": \"https://air.alaska.air-staff/?members\",\n \"ioc_type\": \"a783ca1b-b6b3-43ec-a60a-6e4415434a3c\",\n \"ioc_type_data\": {\n \"title\": \"ioc_url\",\n \"unique_id\": \"a783ca1b-b6b3-43ec-a60a-6e4415434a3c\",\n \"created\": \"2018-05-17T14:07:56.826705Z\",\n \"modified\": \"2021-02-03T12:27:33.923007Z\",\n \"display_name\": \"URL\"\n },\n \"tlp\": \"WHITE\",\n \"status\": \"cleaned\"\n },\n {\n \"unique_id\": \"146d65a1-7602-4fa2-9c4b-6caf5cac8be9\",\n \"created\": \"2020-01-08T12:52:28.008655Z\",\n \"modified\": \"2020-01-08T12:52:28.057195Z\",\n \"value\": \"http://air.alaska/mails\",\n \"ioc_type\": \"a783ca1b-b6b3-43ec-a60a-6e4415434a3c\",\n \"ioc_type_data\": {\n \"title\": \"ioc_url\",\n \"unique_id\": \"a783ca1b-b6b3-43ec-a60a-6e4415434a3c\",\n \"created\": \"2018-05-17T14:07:56.826705Z\",\n \"modified\": \"2021-02-03T12:27:33.923007Z\",\n \"display_name\": \"URL\"\n },\n \"tlp\": \"WHITE\",\n \"status\": \"cleaned\"\n }\n ],\n \"ioc_email_data\": [\n {\n \"unique_id\": \"977416df-c6c5-40f2-a2c8-bdc3dd02ae61\",\n \"created\": \"2020-01-08T12:52:39.464706Z\",\n \"modified\": \"2020-01-08T12:52:39.465710Z\",\n \"value\": \"mail@air.alaska\",\n \"ioc_type\": \"97158535-9d84-4cfe-9e1a-3cd424be6652\",\n \"ioc_type_data\": {\n \"title\": \"ioc_email\",\n \"unique_id\": \"97158535-9d84-4cfe-9e1a-3cd424be6652\",\n \"created\": \"2018-05-18T09:36:22.636938Z\",\n \"modified\": \"2021-02-03T12:27:34.012918Z\",\n \"display_name\": \"Email\"\n },\n \"tlp\": \"WHITE\",\n \"status\": \"false_positive\"\n },\n {\n \"unique_id\": \"02767a53-49fc-466e-a821-2b110d31f254\",\n \"created\": \"2020-01-08T11:09:09.250783Z\",\n \"modified\": \"2020-01-08T11:09:09.251787Z\",\n \"value\": \"staff@air.alaska\",\n \"ioc_type\": \"97158535-9d84-4cfe-9e1a-3cd424be6652\",\n \"ioc_type_data\": {\n \"title\": \"ioc_email\",\n \"unique_id\": \"97158535-9d84-4cfe-9e1a-3cd424be6652\",\n \"created\": \"2018-05-18T09:36:22.636938Z\",\n \"modified\": \"2021-02-03T12:27:34.012918Z\",\n \"display_name\": \"Email\"\n },\n \"tlp\": \"WHITE\",\n \"status\": \"malicious\"\n },\n {\n \"unique_id\": \"a6469d3d-4c09-44de-9bc5-7985007568dd\",\n \"created\": \"2020-02-20T14:09:42.820923Z\",\n \"modified\": \"2020-02-20T15:55:22.164447Z\",\n \"value\": \"google@member.alaska\",\n \"ioc_type\": \"97158535-9d84-4cfe-9e1a-3cd424be6652\",\n \"ioc_type_data\": {\n \"title\": \"ioc_email\",\n \"unique_id\": \"97158535-9d84-4cfe-9e1a-3cd424be6652\",\n \"created\": \"2018-05-18T09:36:22.636938Z\",\n \"modified\": \"2021-02-03T12:27:34.012918Z\",\n \"display_name\": \"Email\"\n },\n \"tlp\": \"GREEN\",\n \"status\": \"blocked\"\n }\n ],\n \"ioc_MD5_data\": [\n {\n \"unique_id\": \"db26607c-5d76-4d05-b43d-f271f185a809\",\n \"created\": \"2020-01-08T11:10:38.666089Z\",\n \"modified\": \"2020-01-08T11:10:38.667103Z\",\n \"value\": \"f99ff63ddbfa12e3b95b0c0841e529e1\",\n \"ioc_type\": \"2a8e1285-6252-46d1-8d78-44d5cd4ef218\",\n \"ioc_type_data\": {\n \"title\": \"ioc_MD5\",\n \"unique_id\": \"2a8e1285-6252-46d1-8d78-44d5cd4ef218\",\n \"created\": \"2018-11-14T16:51:03.190773Z\",\n \"modified\": \"2021-02-03T12:27:34.103778Z\",\n \"display_name\": \"MD5\"\n },\n \"tlp\": \"WHITE\",\n \"status\": \"cleaned\"\n },\n {\n \"unique_id\": \"499d06cd-88aa-4408-9f24-3d0928cc9b4e\",\n \"created\": \"2020-01-08T12:55:22.319534Z\",\n \"modified\": \"2020-01-08T12:55:22.320523Z\",\n \"value\": \"291a913a38b68562d7cbb387c850c6c9\",\n \"ioc_type\": \"2a8e1285-6252-46d1-8d78-44d5cd4ef218\",\n \"ioc_type_data\": {\n \"title\": \"ioc_MD5\",\n \"unique_id\": \"2a8e1285-6252-46d1-8d78-44d5cd4ef218\",\n \"created\": \"2018-11-14T16:51:03.190773Z\",\n \"modified\": \"2021-02-03T12:27:34.103778Z\",\n \"display_name\": \"MD5\"\n },\n \"tlp\": \"WHITE\",\n \"status\": \"whitelisted\"\n }\n ],\n \"ioc_SHA1_data\": [\n {\n \"unique_id\": \"99d9a54d-b574-41c6-94e2-9ff3b6be6439\",\n \"created\": \"2020-01-08T12:55:11.319915Z\",\n \"modified\": \"2020-01-09T18:44:11.301544Z\",\n \"value\": \"a03c040d0ca81805aadeaea33c5e71863ba75b90\",\n \"ioc_type\": \"bdeaec82-83c3-4595-8661-1a921218d983\",\n \"ioc_type_data\": {\n \"title\": \"ioc_SHA1\",\n \"unique_id\": \"bdeaec82-83c3-4595-8661-1a921218d983\",\n \"created\": \"2018-11-14T16:48:21.941379Z\",\n \"modified\": \"2021-02-03T12:27:34.198553Z\",\n \"display_name\": \"SHA1\"\n },\n \"tlp\": \"WHITE\",\n \"status\": \"malicious\"\n },\n {\n \"unique_id\": \"e57e6ea3-6bb3-48a9-802c-967dde1219c7\",\n \"created\": \"2020-01-08T11:10:48.012031Z\",\n \"modified\": \"2020-01-08T11:10:48.013090Z\",\n \"value\": \"ea00662d65c398c1b9fc14b299fb662b88799b2d\",\n \"ioc_type\": \"bdeaec82-83c3-4595-8661-1a921218d983\",\n \"ioc_type_data\": {\n \"title\": \"ioc_SHA1\",\n \"unique_id\": \"bdeaec82-83c3-4595-8661-1a921218d983\",\n \"created\": \"2018-11-14T16:48:21.941379Z\",\n \"modified\": \"2021-02-03T12:27:34.198553Z\",\n \"display_name\": \"SHA1\"\n },\n \"tlp\": \"WHITE\",\n \"status\": \"false_positive\"\n }\n ],\n \"ioc_SHA256_data\": [\n {\n \"unique_id\": \"4aab0c3e-f5a7-469e-9f70-592dde177661\",\n \"created\": \"2020-01-08T11:10:59.233879Z\",\n \"modified\": \"2020-01-08T11:10:59.234824Z\",\n \"value\": \"c04211e13675d2dba4467d0ee860042081b8ce2895c53e71991a48bfa50a648a\",\n \"ioc_type\": \"5db1ff07-37e1-43d4-bd44-75ba0ab5c72f\",\n \"ioc_type_data\": {\n \"title\": \"ioc_SHA256\",\n \"unique_id\": \"5db1ff07-37e1-43d4-bd44-75ba0ab5c72f\",\n \"created\": \"2019-01-28T06:24:34.778778Z\",\n \"modified\": \"2021-02-03T12:27:34.292924Z\",\n \"display_name\": \"SHA256\"\n },\n \"tlp\": \"WHITE\",\n \"status\": \"false_positive\"\n },\n {\n \"unique_id\": \"28ac26c1-d436-4e5c-8d5d-91226fddf782\",\n \"created\": \"2020-01-08T12:53:32.580212Z\",\n \"modified\": \"2020-01-08T12:53:32.581197Z\",\n \"value\": \"c04211e13675d2dba4467d0ee860042081b8ce2895c53e71991a48bfa50a648b\",\n \"ioc_type\": \"5db1ff07-37e1-43d4-bd44-75ba0ab5c72f\",\n \"ioc_type_data\": {\n \"title\": \"ioc_SHA256\",\n \"unique_id\": \"5db1ff07-37e1-43d4-bd44-75ba0ab5c72f\",\n \"created\": \"2019-01-28T06:24:34.778778Z\",\n \"modified\": \"2021-02-03T12:27:34.292924Z\",\n \"display_name\": \"SHA256\"\n },\n \"tlp\": \"WHITE\",\n \"status\": \"whitelisted\"\n }\n ],\n \"ioc_registry_key_data\": [],\n \"ioc_credit_card_data\": [],\n \"ioc_fqfn_-_fully_qualified_file_name_data\": [],\n \"ioc_test_doc_data\": []\n}"}],"_postman_id":"9bf91892-28c9-4886-8f94-a69d43f247eb"},{"name":"Get Incident Details (Advanced)","event":[{"listen":"prerequest","script":{"id":"a9dc1d2d-cc3a-46aa-81f1-ec3b40d04836","exec":["var accessid = pm.environment.get(\"open_api_access_id\");","var secret_key = pm.environment.get(\"open_api_secret_key\");","/*"," -generating epochtime"," -epochtime is being send in expires parameter of params"," -sign is generated and then passed for generating signature","*/","pm.environment.set(\"unixtimestamp\",Math.round(Date.now()/1000));","var expires = pm.environment.get(\"unixtimestamp\")+15;","pm.environment.set('UTC Timezone', new Date().toISOString());","pm.environment.set(\"expires\", expires);","var to_sign = accessid+\"\\n\"+expires;","/*","Generate Signature for Authentication"," -Key based hashing is done using HMAC-SHA1 Algorithm"," -This is then converted into base64"," -Finally the generated signature is URL Encoded so as to make all the special characters URL Safe","*/","var hash = CryptoJS.HmacSHA1(to_sign, secret_key);","var hashInBase64 = encodeURIComponent(CryptoJS.enc.Base64.stringify(hash));","pm.environment.set(\"signature\",hashInBase64);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"8a40691e-9bd9-47ab-a7a1-eda9381bf4e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{base_url}}v1/incident/qb/extended/:incident_unique_or_readable_id/?AccessID={{open_api_access_id}}&Signature={{signature}}&Expires={{expires}}","description":"

Retrieves additional details of an incident using its readable ID.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

Response Parameters | Regulatory Fields

Parameter	Type	Description
`title`	String	Title of the incident.
`unique_id`	String	Unique Identifier String of UUID-4 format of the incident.
`readable_id`	String	Readable ID of the incident. For example, INC320.
`incident_date`	String	Date and time of when the incident happened.
`detection_date`	String	Date and time when the incident was detected as malicious.
`status`	String	Status of the incident workflow. Allowed values: - active - inactive
`phase`	String	Current phase of the incident. The phase describes the UUID of phase, part of the Incident Workflow.
`machine_generated`	Boolean	Displays if the incident is machine generated or not.
`phase_data`	Object	Details of the current phase of the incident.
`level`	String	Severity level of the incident. For example, high.
`level_data`	Object	Details of the severity level of the incident.
`created_by`	String	`user_id` of the user who created the incident.
`is_protected`	Boolean	Shows if the incident is protected or not.
`is_removed`	Boolean	Shows if the incident is in the deleted state or not.
`created_by_data`	Object	Details of user who created the incident.
`modified_by_data`	Object	Details of the user who last modified the incident.
`closed_by_data`	Object	Details of used who closed the incident.
`created`	String	Incident creation date and time.
`modified`	String	Last updated date and time of the incident.
`Opened_on`	Datetime	Date and time when the incident was opened.
`closed_on`	Datetime	Date and time when the incident was closed. If incident is not closed, value of this param will be Null.
`ie_num_of_pii_exposed`	Integer	Number of PIRs that were exposed in the incident.
`description`	String	Description of the Incident.
`assigned_to`	String	`user_id` of the assigned user.
`assigned_to_data`	Object	Details of the assigned user.
`assigned_group`	String	`group_comm_id` of the assigned user group.
`assigned_group_data`	Object	Details of the assigned user group.
`assignment_sla`	String	Assignment SLA details of the incident. It has two keys: 1. `color`: Associated color code(according to SLA breach level). 2. `data`: It has two keys: - `sla_duration`: SLA Breach time. - `elapsed_time`: Time elapsed between incident opening and SLA completion.
`ie_incident_type`	Strings	The type of incident. Example, hacking.
`days_open`	Integer	Number of days the incident is open.
`resolution_sla`	String	Resolution SLA details of the incident. It has two keys: 1. `color`: Associated color code(according to SLA breach level). 2. `data`: It has two keys: - `sla_duration`: SLA Breach time. - `elapsed_time`: Time elapsed between incident opening and SLA completion.
`notification_sla`	String	Details of the Incident notifications (if enabled in admin).
`total_cost`	Integer	Total cost incurred due to the incident.
`is_bookmarked`	Boolean	Shows if the incident is bookmarked or not.
`permanently_closed`	Boolean	Shows if the incident is permanently closed or not.
`resolution_due_date`	String	Resolution SLA breach date of the incident.
`can_update_instance`	Boolean	Shows whether the instance can be updated by the user who requested it or not.
`is_paused`	Boolean	Shows if the incident is paused or not.
`paused_by`	String	`user_id` of the user who paused the incident.
`paused_by_data`	Object	Details of the user who paused the incident.
`schema`	String	Unique ID of the Incident Workflow that is being used by the incident.
`schema_type`	String	Type of the incident Workflow. Allowed values: 'draft' or 'published'
`schema_data`	Object	Details of the Incident Workflow that is being used by the incident.
`sources`	Array	List of the sources for the incident.
`sources_data`	Array of Objects	Details of the sources for the incident.
`labels`	Array	List of the labels that are added to the incident.
`labels_data`	Array of Objects	Details of the labels that are added to the incident.
`tactic_technique_pair`	Array	List of the tactics and techniques used by the incident.
`tactic_technique_pair_data`	Array of Objects	Details of the tactics and techniques used by the incident.
`business_units_impacted_data`	Array of Objects	List of business units that are impacted by the incident.
`locations_impacted_data`	Array of Objects	List of locations that are impacted by the incident.
`incident_state`	String	State of the incident. For example, open, closed, merged.
`mapped_playbooks`	Array of Objects	Returns the playbook details such as title, hash, tags, and more fields associated with the incident.
`activity_logs`	Array of Objects	Returns the activity logs of the incident. The activity log details include tenant ID, user, action, and more parameters.
`status_data`	Object	Details of the status of the incident.
`first_assigned_on_timestamp`	String	Timestamp when the incident was first assigned to a user.

Response Parameters | Connect The Dots

Parameter	Type	Description
`applications`	Array of UUID Strings	List of `unique_id` of the connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`softwares`	Array of UUID Strings	List of `unique_id` of the connected softwares.
`softwares_data`	Array of Objects	Details of the connected softwares.
`users`	Array of UUID Strings	List of `unique_id` of the connected users.
`users_data`	Array of Objects	Details of the connected users.
`endpoints`	Array of UUID Strings	List of `unique_id` of the connected devices.
`endpoints_data`	Array of Objects	Details of the connected devices.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.
`enhancements`	Array of UUID Strings	List of unique_id of the connected enhancements.

Response Parameters | Default Indicators

Following are the seven standard indicators that are included by default in the CFTR platform, which reflect in the incident's response data with the following keys:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`ioc_SHA1`	Array of UUID Strings	List of `unique_id` of the connected SHA1 Threat Intels.
`ioc_SHA1_data`	Array of Objects	Details of the connected SHA1 Threat Intels.
`ioc_MD5`	Array of UUID Strings	List of `unique_id` of the connected MD5 Threat Intels.
`ioc_MD5_data`	Array of Objects	Details of the connected MD5 Threat Intels.
`ioc_SHA256`	Array of UUID Strings	List of `unique_id` of the connected SHA256 Threat Intels.
`ioc_SHA256_data`	Array of Objects	Details of the connected SHA256 Threat Intels.
`ioc_ip`	Array of UUID Strings	List of `unique_id` of the connected IP Threat Intels.
`ioc_ip_data`	Array of Objects	Details of the connected IP Threat Intels.
`ioc_url`	Array of UUID Strings	List of `unique_id` of the connected URL Threat Intels.
`ioc_url_data`	Array of Objects	Details of the connected URL Threat Intels.
`ioc_domain`	Array of UUID Strings	List of `unique_id` of the connected domain Threat Intels.
`ioc_domain_data`	Array of Objects	Details of the connected domain Threat Intels.
`ioc_email`	Array of UUID Strings	List of `unique_id` of the connected email Threat Intels.
`ioc_email_data`	Array of Objects	Details of the connected email Threat Intels.

Response Parameters | Custom Indicators

The Example of a custom indicator parameter in the Incident's response is shown below.

\n
Note: The parameter key for custom indicator(s) may vary as per the Custom Threat Intel's name
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`ioc_credit_card`	Array of UUID Strings	List of UUID-4 formatted `unique_id` Strings corresponding to the Custom Threat Intel Credit Card, which are connected to the Incident
`ioc_credit_card_data`	Array of Objects	List of basic details of the Custom Indicator Credit Card connected to the Incident

Response Parameters | Custom Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type
summary_card_host_pairs	String
ie_port_numbers_impacted	String
incident_learning	String
recovery_details	String

Response Parameters | Attachments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
attachments_data	Array of Objects	Details of each attachment of the incident.

Response Parameters | Actions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
actions_data	Array of Objects	Details of the actions that are added to the incident.

Response Parameters | Enhancements

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
enhancements	Array of UUID Strings	List of the enhancements that are added to the incident.
enhancements_data	Array of Objects	Details of the enhancements that are added to the incident.

Response Parameters | PIRs

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
pirs_data	Array of Objects	Details of the PIRs that are added to the incident.

Response Parameters | Knowledge Base

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
knowledge_base	Array of UUID Strings	List of the knowledge base records that are added to the incident.
knowledge_base_data	Array of Objects	Details of the knowledge base records that are added to the incident. This also includes the attachments or files added to the knowledge base article.

Response Parameters | System Form Fields

These fields include:

All Connect the Dots params: You can retrieve the corresponding UUID-4 from the details page browser URL of the instance.
\n
All Indicators params: You can retrieve the corresponding UUID-4 from the details page browser URL of the instance.
\n
Assigned User / Assigned Group related params: You can retrieve the corresponding UUID-4 from the User Management and Group Management sections respectively.
\n
Business Unit, Location: You can retrieve the corresponding UUID-4 from Admin > Settings section.
\n

\n","urlObject":{"path":["incident","qb","extended",":incident_unique_or_readable_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Signature","value":"{{signature}}"},{"key":"Expires","value":"{{expires}}"}],"variable":[{"description":{"content":"

Pass the unique ID or readable ID of the incident.

\n","type":"text/plain"},"type":"any","value":"INC178","key":"incident_unique_or_readable_id"}]}},"response":[{"id":"5d915e75-5171-43a1-8b17-0d7dc0de6dc2","name":"Get Incident Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/incident/qb/extended/INC187/?AccessID={{open_api_access_id}}&Signature={{signature}}&Expires={{expires}}","host":["{{base_url}}v1"],"path":["incident","qb","extended","INC187",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Signature","value":"{{signature}}"},{"key":"Expires","value":"{{expires}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 17 Feb 2026 09:13:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET"},{"key":"Vary","value":"origin, Cookie"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"Content-Security-Policy","value":"img-src https: http: data: blob:;"},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"knowledge_base\": [],\n \"knowledge_base_data\": [],\n \"applications\": [],\n \"applications_data\": [],\n \"softwares\": [],\n \"softwares_data\": [],\n \"users\": [],\n \"users_data\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"enhancements\": [],\n \"enhancements_data\": [],\n \"pirs_data\": [],\n \"briefings\": [],\n \"briefings_data\": [],\n \"campaigns\": [],\n \"campaigns_data\": [],\n \"malwares\": [],\n \"malwares_data\": [],\n \"threat_actors\": [],\n \"threat_actors_data\": [],\n \"actions\": [],\n \"actions_data\": [],\n \"vulnerabilities\": [],\n \"vulnerabilities_data\": [],\n \"attachments_data\": [],\n \"related_incidents\": [],\n \"related_incidents_data\": [],\n \"ir_source\": null,\n \"ir_org_id\": null,\n \"ir_user_id\": null,\n \"is_ir_revision\": false,\n \"source_ip\": null,\n \"source_hostname\": null,\n \"source_port\": null,\n \"destination_ip\": null,\n \"destination_hostname\": null,\n \"destination_port\": null,\n \"containment_host\": null,\n \"containment_url\": null,\n \"containment_hash\": null,\n \"containment_summary\": null,\n \"containment_ip\": null,\n \"containment_result\": null,\n \"ie_malware_analysis_summary\": null,\n \"ie_log_analysis_summary\": null,\n \"ie_impact_on_intellectual_property\": null,\n \"ie_invegtigation_eradication_exception\": null,\n \"ie_findings_summary\": null,\n \"ie_port_numbers_impacted\": null,\n \"ie_forensics_details\": null,\n \"ie_lessons_learned\": null,\n \"methods_validate_recovery_actions\": null,\n \"methods_monitor_recovery_actions\": null,\n \"recovery_details\": null,\n \"base_line_changes\": null,\n \"incident_learning\": null,\n \"closure_comments\": null,\n \"incident_analysis\": null,\n \"url_reputation\": null,\n \"ip_reputation\": null,\n \"textfield_41154\": null,\n \"textfield_41155\": null,\n \"textfield_41152\": null,\n \"textfield_411510\": null,\n \"textfield_41151\": null,\n \"textfield_41158\": null,\n \"textfield_41159\": null,\n \"textfield_41156\": null,\n \"textfield_41153\": null,\n \"textfield_41157\": null,\n \"ie_num_of_assets_impacted\": 40,\n \"ie_num_of_users_impacted\": null,\n \"ie_regulatory_reporting_date\": null,\n \"attack_vector\": null,\n \"ie_root_cause\": null,\n \"ie_customer_notification_required\": null,\n \"ie_regulatory_notifications_required\": null,\n \"false_positive\": null,\n \"applicable_compliance\": [],\n \"incident_identified\": [],\n \"ie_motives\": [],\n \"ie_regulatory_reporting\": [],\n \"business_impact\": [\n \"Branding Impact\"\n ],\n \"kill_chain_phase\": null,\n \"ioc_url\": [],\n \"ioc_email\": [],\n \"ioc_threat2026-02-16_05:27:07.006393\": [],\n \"ioc_MD5\": [],\n \"ioc_ip\": [],\n \"ioc_domain\": [],\n \"ioc_SHA256\": [],\n \"ioc_SHA1\": [],\n \"unique_id\": \"e2ea190c-e785-48aa-8284-ca579220b85e\",\n \"readable_id\": \"INC187\",\n \"created\": \"2026-02-16T05:49:32.567942Z\",\n \"description\": \"New incident creation from api automation suite\",\n \"modified\": \"2026-02-16T05:49:43.712214Z\",\n \"title\": \"API Automation Test For Text Field\",\n \"machine_generated\": false,\n \"incident_date\": null,\n \"detection_date\": null,\n \"status\": \"Open\",\n \"machine_name\": null,\n \"closed_on\": null,\n \"ie_num_of_pii_exposed\": null,\n \"title_display\": \"API Automation Test For Text Field\",\n \"days_open\": 1,\n \"alert_type\": \"incident\",\n \"is_protected\": false,\n \"is_removed\": false,\n \"level\": \"Low\",\n \"types\": [],\n \"phase\": \"Containment\",\n \"ie_incident_type\": \"Malware\",\n \"is_paused\": true,\n \"opened_on\": \"2026-02-16T05:49:32.566608Z\",\n \"can_close_instance\": false,\n \"assignment_sla\": null,\n \"resolution_sla\": null,\n \"notification_sla\": null,\n \"total_cost\": 0,\n \"time_to_detect\": null,\n \"time_to_resolve\": null,\n \"is_ctix_generated\": false,\n \"is_bookmarked\": false,\n \"permanently_closed\": false,\n \"resolution_due_date\": null,\n \"total_ownership_duration\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 0,\n \"seconds\": 2\n },\n \"can_update_instance\": true,\n \"can_update_full\": true,\n \"paused_by\": \"92b31347-b184-442c-adcf-b43f04d2e496\",\n \"paused_by_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"92b31347-b184-442c-adcf-b43f04d2e496\",\n \"display_pic\": \"https://3479.cftr.spotio.cywaredev.com/cftr/file-server/download/image.png?file_key=file-server-92b31347-b184-442c-adcf-b43f04d2e496&show_preview=True\",\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System Default\"\n },\n \"opened_by_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"92b31347-b184-442c-adcf-b43f04d2e496\",\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System Default\"\n },\n \"parent_data\": null,\n \"modified_by_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"92b31347-b184-442c-adcf-b43f04d2e496\",\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System Default\"\n },\n \"assigned_group\": \"d0d089bf-b8d3-46b5-b7b9-f75d0ebfd7c3\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"d0d089bf-b8d3-46b5-b7b9-f75d0ebfd7c3\",\n \"group_name\": \"CFTR Admin\"\n },\n \"created_by\": \"92b31347-b184-442c-adcf-b43f04d2e496\",\n \"created_by_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"92b31347-b184-442c-adcf-b43f04d2e496\",\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System Default\"\n },\n \"closed_by_data\": null,\n \"assigned_to\": null,\n \"assigned_to_data\": {},\n \"schema\": \"83e0e851-1565-4551-90eb-144d270f7ff7\",\n \"schema_data\": {\n \"title\": \"NIST\",\n \"description\": null,\n \"unique_id\": \"83e0e851-1565-4551-90eb-144d270f7ff7\",\n \"phase_flow\": \"LINEAR\",\n \"check_mandatory_fields_on_phase_change\": false\n },\n \"sources\": [],\n \"sources_data\": null,\n \"labels\": [],\n \"labels_data\": [],\n \"tactic_technique_pair\": [],\n \"tactic_technique_pair_data\": [],\n \"business_units_impacted\": [\n \"55e326b3-47c8-40dd-931b-f0d05b0eb609\"\n ],\n \"business_units_impacted_data\": {\n \"title\": \"System\",\n \"unique_id\": \"55e326b3-47c8-40dd-931b-f0d05b0eb609\",\n \"email_list\": null\n },\n \"locations_impacted\": [\n \"178de3e5-d373-479e-9a52-79bd78b0a41d\"\n ],\n \"locations_impacted_data\": [\n {\n \"title\": \"System\",\n \"unique_id\": \"178de3e5-d373-479e-9a52-79bd78b0a41d\",\n \"is_active\": true\n }\n ],\n \"is_schema_updated\": false,\n \"update_index\": 7,\n \"slack_notify\": false,\n \"teams_notify\": false,\n \"is_sla_paused\": false,\n \"handoff_note\": null,\n \"incident_state\": \"Open\",\n \"first_assigned_on\": \"2026-02-16T05:49:32.566613Z\",\n \"paused_on\": null,\n \"paused_duration\": \"00:00:00\",\n \"closed_duration\": \"00:00:00\",\n \"duplicate_marked_on\": null,\n \"mapped_playbooks\": [],\n \"activity_logs\": [\n {\n \"tenant_id\": \"c8233066-4024-4805-b9b0-eebfd5d24865\",\n \"user\": \"system.default\",\n \"action\": \"RUN\",\n \"object_ctype\": 10,\n \"object_id\": \"e2ea190c-e785-48aa-8284-ca579220b85e\",\n \"object_display_name\": \"(INC187) API Automation Test For Text Field\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"sub_object_id\": \"01K1CYE0VA4FHKK4P4XKDQQ0VF\",\n \"sub_object_display_name\": \"#PLB108: playbook with n output and n category\",\n \"object_type\": \"incident\",\n \"sub_object_type\": \"playbook\",\n \"created\": \"2026-02-16T05:49:58.305675+00:00\",\n \"timestamp\": 1771220998,\n \"timestamp_ms\": 1771220998.3056822,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": \"https://3479.cftr.spotio.cywaredev.com/cftrbucket/cftr-3479/profile-pics/image.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minio%2F20260217%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260217T091359Z&X-Amz-Expires=120&X-Amz-SignedHeaders=host&X-Amz-Signature=e02e8cae3685918e516fefe00a5aac78941ddbf24f4f9050fbece96bcc01a430\",\n \"sentence_html\": \"@system.default executed playbook #PLB108: playbook with n output and n category \"\n },\n ],\n \"phase_data\": {\n \"unique_id\": \"d36e75db-f6d5-4755-a771-181a0598c56e\",\n \"option_name\": \"Containment\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"0f05c8ba-fa77-4ee1-b252-a21e0c6ecf64\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"status_data\": {\n \"unique_id\": \"3bba34ae-8541-43ef-94bf-e97ede95810f\",\n \"option_name\": \"Open\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"88d94d70-db10-47cb-8ad7-b00349975200\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": \"#E53535\"\n },\n \"incident_identified_data\": [],\n \"level_data\": {\n \"unique_id\": \"f3039354-5d5e-4829-b715-a2b661cba7f2\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"2f7c607e-c562-48dd-9b32-f331ccb2e2b8\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"ie_incident_type_data\": {\n \"unique_id\": \"6e92c112-3868-4832-b1c1-0dadba9b14ea\",\n \"option_name\": \"Malware\",\n \"is_active\": true,\n \"order\": 6,\n \"option_field\": \"af3bcdbb-e326-4034-a535-f568be8f0a51\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"business_impact_data\": [\n {\n \"unique_id\": \"cac88c96-9c2d-4c94-97aa-9fa738fb69c1\",\n \"option_name\": \"Branding Impact\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"8b9eb6f2-3554-4093-b385-93364b6ab8e2\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"kill_chain_phase_data\": null,\n \"applicable_compliance_data\": [],\n \"ie_motives_data\": [],\n \"ie_regulatory_reporting_data\": [],\n \"ioc_ip_data\": [],\n \"ioc_domain_data\": [],\n \"ioc_url_data\": [],\n \"ioc_email_data\": [],\n \"ioc_MD5_data\": [],\n \"ioc_SHA1_data\": [],\n \"ioc_SHA256_data\": [],\n \"ioc_threat2026-02-16_05:27:07.006393_data\": [],\n \"created_timestamp\": 1771220972.567942,\n \"modified_timestamp\": 1771220983.712214,\n \"opened_on_timestamp\": 1771220972.566608,\n \"first_assigned_on_timestamp\": 1771220972.566613\n}"}],"_postman_id":"8a40691e-9bd9-47ab-a7a1-eda9381bf4e2"},{"name":"Create Incident Using Field UUID","id":"e0dd3a70-874a-44d7-ba38-03d1bd21ab51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"test incident\",\n \"description\": \"

test incident

\",\n \"assigned_group\": \"6803b013-82f0-4b8d-a3c7-a166bed27de6\",\n \"business_units_impacted\": \"034d98c7-e8a0-445f-9b0e-e305d8db1c11\",\n \"applicable_compliance\": [\n \"PCI\"\n ],\n \"ie_incident_type\": \"APT\",\n \"level\": \"Low\",\n \"locations_impacted\": [\n \"e0626033-e84b-4cdf-a802-8a30e25474ad\"\n ],\n \"sources\": \"5272f77d-aef7-4753-8afa-64c15a073199\",\n \"kill_chain_phase\": \"Action on Objectives\",\n \"business_impact\": [\n \"Branding Impact\"\n ],\n \"assigned_to\": \"26dee00f-21b3-4a48-91e5-5e4597bf9f30\",\n \"incident_date\": \"2022-01-17T07:38:50.000Z\",\n \"detection_date\": \"2022-01-18T07:38:50.000Z\",\n \"status\": \"open\",\n \"attack_vector\": \"Network\",\n \"source_ip\": \"12.12.12.12\",\n \"destination_ip\": \"13.13.13.13\",\n \"ie_customer_notification_required\": \"No\"\n}"},"url":"{{base_url}}v1/incident/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Create incidents in your CFTR application using the UUID of locations, business units, sources, assigned groups, and assigned users.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/incident/?

Request Parameters

Note:

The default value of all the optional parameters is None, if the default value is not mentioned.
\n
To create an Untriaged incident, title is mandatory and all the other fields are optional.
\n
To create an incident in Open status, title, business_units_impacted, locations_impacted, and assigned_group fields are mandatory.
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
title	string	Mandatory	Enter a title for the incident.
description	string	Optional	Enter a description that best describes the key details of the incident.
status	string	Optional	Enter the status of the incident. Allowed values: * untriaged * open * closed * merged Example: \"untriaged\" Default value: \"open\"
phase	String	Optional Note: By default, the incident phase will be the initial phase of the Incident Workflow as configured by your CFTR admin.	Enter the phase of the incident. Sample phases: • Detection Analysis • Containment • Investigation and Eradication • Recovery • Closure Example: “Detection Analysis”
ie_incident_type	String	Optional	Enter the type of the Incident. Some of the examples Incident Types are: • Malware • Phishing • Spearphishing Example: “Malware”
business_units_impacted	Array	Mandatory	Enter the unique IDs of the impacted Business Units. You can retrieve the list of available Business Units and their Unique IDs using the following API endpoint: `/openapi/v1/utils/business-unit/` Note: You can add one or more business units impacted, depending on the settings configured in Admin Panel > Configurations > Incident > Other Settings.
locations_impacted	Array	Mandatory	Enter the unique IDs of the impacted locations. You can retrieve the list of available locations and their unique IDs using the following API endpoint: `/openapi/v1/utils/location/`
sources	String	Optional	Enter the unique ID of the Sources. You can retrieve the list of all available Sources and their unique IDs using the following API endpoint: `/openapi/v1/utils/source/`
incident_date	datetime	Optional	Enter the date of occurrence of the incident.
detection_date	datetime	Optional	Enter the incident detection date.
level	String	Optional	Enter the severity level of the incident. Some of the example Severity Levels are: • Critical • High • Medium • Low Example: “Critical”
assigned_group	String	Mandatory	Enter the unique ID of the user group to assign the incident. You can use the following API endpoint to retrieve the list of User Groups: `/openapi/v1/rest-auth/permission/group/`

Response Parameters

Response Parameters | Regulatory Fields

Parameter	Type	Description
`title`	String	Title of the incident.
`unique_id`	String	Unique ID of the incident.
`status`	String	Current status of the incident. Allowed values: open closed untriaged merged
`phase`	String	Current phase of the incident. The phase describes the UUID of phase, part of the Incident Workflow.
`phase_data`	Object	Details of the current phase of the incident.
`level`	String	Severit level of the incident.
`level_data`	Object	Details of the severity level of the incident.
`created_by`	String	`user_id` of the user who created the incident.
`created_by_data`	Object	Details of user who created the incident.
`modified_by_data`	Object	Details of the user who last modified the incident.
`machine_generated`	Boolean	Shows if the incident is machine generated or not.
`closed_by_data`	Object	Details of used who closed the incident.
`created`	String	Incident creation date and time.
`modified`	String	Last updated date and time of the incident.
`opened_on`	String	Date and time of when the incident was moved to open state.
`opened_by_data`	Object	Details of the user who moved the incident to the open state.
`closed_on`	String	Date and time when the incident was closed. If incident is not closed, value of this param will be Null.
`incident_date`	String	Date and time of the incident creation.
`detection_date`	String	Date and time of when the incident was detected as malicious.
`is_protected`	Boolean	Shows if the incident is protected or not.
`is_removed`	Boolean	Shows if the incident is in the deleted state or not.
`description`	String	Description of the Incident.
`assigned_to`	String	`user_id` of the assigned user.
`assigned_to_data`	Object	Details of the assigned user.
`assigned_group`	String	`group_comm_id` of the assigned user group.
`assigned_group_data`	Object	Details of the assigned user group.
`assignment_sla`	String	Assignment SLA details of the incident. It has two keys: 1. `color`: Associated color code(according to SLA breach level). 2. `data`: It has two keys: - `sla_duration`: SLA Breach time. - `elapsed_time`: Time elapsed between incident opening and SLA completion.
`resolution_sla`	String	Resolution SLA details of the incident. It has two keys: 1. `color`: Associated color code(according to SLA breach level). 2. `data`: It has two keys: - `sla_duration`: SLA Breach time. - `elapsed_time`: Time elapsed between incident opening and SLA completion.
`notification_sla`	List of Objects	Details of the configured incident notifications (If enabled).
`total_cost`	Integer	Total cost incurred due to the incident.
`is_bookmarked`	Boolean	Shows if the incident is bookmarked or not.
`permanently_closed`	Boolean	Shows if the incident is permanently closed or not.
`resolution_due_date`	String	Resolution SLA breach date of the incident.
`can_update_instance`	Boolean	Shows whether the incident can be updated by the user who requested it or not.
`can_close_instance`	Boolean	Shows if the user who requested it can close the incident or not.
`is_paused`	Boolean	Shows if the incident is in the paused state or not.
`paused_by`	String	`user_id` of the user who paused the incident.
`paused_by_data`	Object	Details of the user who paused the incident.
`schema`	String	Unique ID of the Incident Workflow that is being used by the incident.
`schema_data`	Object	Details of the Incident Workflow that is being used by the incident.
`sources`	Array	List of the sources added to the incident.
`sources_data`	Array of Objects	Details of the sources for the incident.
`labels`	Array	List of the labels that are added to the incident.
`labels_data`	Array of Objects	Details of the labels that are added to the incident.
`tactic_technique_pair`	Array	List of the tactics and techniques used by the incident.
`tactic_technique_pair_data`	Array of Objects	Details of the tactics and techniques used by the incident.
`business_units_impacted_data`	Array of Objects	List of business units that are impacted by the incident.
`locations_impacted_data`	Array of Objects	List of locations that are impacted by the incident.

Response Parameters | Connect The Dots

Following are the response parameters corresponding the Connect The Dots section of the incident. The parameters ending with data contain the meta information for each connected component. The non `__data` parameters just include an array of unique_id referencing to connected components.

Parameter	Type	Description
`applications`	Array of UUID Strings	List of `unique_id` of the connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`softwares`	Array of UUID Strings	List of `unique_id` of the connected software.
`softwares_data`	Array of Objects	Details of the connected software.
`users`	Array of UUID Strings	List of `unique_id` of the connected users.
`users_data`	Array of Objects	Details of the connected users.
`endpoints`	Array of UUID Strings	List of `unique_id` of the connected devices.
`endpoints_data`	Array of Objects	Details of the connected devices.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.

Response Parameters | Default Indicators

Following are the seven standard indicators that are included by default in the CFTR platform, which reflect in the incident's response data with the following keys:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`ioc_SHA1`	Array of UUID Strings	List of `unique_id` of the connected SHA1 Threat Intels.
`ioc_SHA1_data`	Array of Objects	Details of the connected SHA1 Threat Intels.
`ioc_MD5`	Array of UUID Strings	List of `unique_id` of the connected MD5 Threat Intels.
`ioc_MD5_data`	Array of Objects	Details of the connected MD5 Threat Intels.
`ioc_SHA256`	Array of UUID Strings	List of `unique_id` of the connected SHA256 Threat Intels.
`ioc_SHA256_data`	Array of Objects	Details of the connected SHA256 Threat Intels.
`ioc_ip`	Array of UUID Strings	List of `unique_id` of the connected IP Threat Intels.
`ioc_ip_data`	Array of Objects	Details of the connected IP Threat Intels.
`ioc_url`	Array of UUID Strings	List of `unique_id` of the connected URL Threat Intels.
`ioc_url_data`	Array of Objects	Details of the connected URL Threat Intels.
`ioc_domain`	Array of UUID Strings	List of `unique_id` of the connected domain Threat Intels.
`ioc_domain_data`	Array of Objects	Details of the connected domain Threat Intels.
`ioc_email`	Array of UUID Strings	List of `unique_id` of the connected email Threat Intels.
`ioc_email_data`	Array of Objects	Details of the connected email Threat Intels.

Response Parameters | Custom Indicators

Custom Indicators are created, configured, and maintained through Form Management Threat Intel Section. Parameter Key is nomenclature is formed with the syntax: ioc_{{camel_case_of_threat_intel_name}}

The Example of a custom indicator parameter in the Incident's response is shown below.

\n
Note: The parameter key for custom indicator(s) may vary as per the Custom Threat Intel's name
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`ioc_credit_card`	Array of UUID Strings	List of UUID-4 formatted `unique_id` Strings corresponding to the Custom Threat Intel Credit Card, which are connected to the Incident.
`ioc_credit_card_data`	Array of Objects	List of basic details of the Custom Indicator Credit Card connected to the Incident.

Response Parameters | Custom Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type
summary_card_host_pairs	String
ie_port_numbers_impacted	String
incident_learning	String
recovery_details	String

Response Parameters | Attachments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
attachments_data	Array of Objects	Details of each attachment of the incident.

Response Parameters | Actions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
actions_data	Array of Objects	Details of the actions that are added to the incident.

Response Parameters | Enhancements

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
enhancements	Array of UUID Strings	List of the enhancements that are added to the incident.
enhancements_data	Array of Objects	Details of the enhancements that are added to the incident.

Response Parameters | PIRs

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
pirs_data	Array of Objects	Details of the PIRs that are added to the incident.

Response Parameters | Knowledge Base

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
knowledge_base	Array of UUID Strings	List of the knowledge base records that are added to the incident.
knowledge_base_data	Array of Objects	Details of the knowledge base records that are added to the incident.

Response Parameters | System Form Fields

These fields include:

All Connect the Dots params: You can retrieve the corresponding UUID-4 from the details page browser URL of the instance.
\n
All Indicators params: You can retrieve the corresponding UUID-4 from the details page browser URL of the instance.
\n
Assigned User / Assigned Group related params: You can retrieve the corresponding UUID-4 from the User Management and Group Management sections respectively.
\n
Business Unit, Location: You can retrieve the corresponding UUID-4 from Admin > Settings section.
\n

\n","urlObject":{"path":["incident",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"8aee840e-a2f5-4940-8ef5-e6ad8e91a4d1","name":"Eg: Create Incident With Open Status","originalRequest":{"method":"POST","header":[{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"sec-ch-ua","value":"\" Not;A Brand\";v=\"99\", \"Google Chrome\";v=\"97\", \"Chromium\";v=\"97\""},{"key":"sec-ch-ua-mobile","value":"?0"},{"key":"Authorization","value":"CYW 3bQlSm2T0T22hYiBqRtkX7YRQd0HzQGRHdOvs2xPjXUzQCGZxSh49JkogkK+LRH5Mr+TnZ/qiRqScjI5ke34B+6H8iG/m6sE9gHeyS1uXqdxLr92VIVVbL/KT6+lLz9Vn5ale6OZ34r4xdRKrpCQtaMkfTCvzZHNQFga1OHHdSi42tOjTazG/HANDhTkJV2fkJgxpm8wdVOHa8VQSx//tZV3jSYH4l4fEBIoqPZLLL6ya1NDFolZ7qzT2+ZtztQm"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json, text/plain, */*"},{"key":"User-Agent","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/97.0.4692.99 Safari/537.36"},{"key":"cyw-api-key","value":"7d13a88e-3178-4b28-ae6e-91b627f85bcf"},{"key":"If-Modified-Since","value":"0"},{"key":"sec-ch-ua-platform","value":"\"macOS\""},{"key":"Origin","value":"http://127.0.0.1:8080"},{"key":"Sec-Fetch-Site","value":"same-origin"},{"key":"Sec-Fetch-Mode","value":"cors"},{"key":"Sec-Fetch-Dest","value":"empty"},{"key":"Referer","value":"http://127.0.0.1:8080/cftr/incident/tab/21/new?parent=858e4324-b606-41c1-aa0d-67b14b42d0e3"},{"key":"Accept-Language","value":"en-GB,en-US;q=0.9,en;q=0.8"},{"key":"Cookie","value":"csrftoken=JFqrb6Wg4oFSrxmOuRDSBDZhqI9UDiCqAsrxJx1eRMuln37SodJBdju95byJSFys"}],"body":{"mode":"raw","raw":"{\n \"title\": \"test incident\",\n \"description\": \"

test incident

\",\n \"assigned_group\": \"9518ecfb-f091-4959-8c22-b7e50494b98f\",\n \"business_units_impacted\": \"9750d6df-2d7f-4899-b20d-bfbba0a9084d\",\n \"applicable_compliance\": [\n \"PCI\"\n ],\n \"ie_incident_type\": \"APT\",\n \"level\": \"Low\",\n \"locations_impacted\": [\n \"671961e6-0119-460c-8d55-9b697f6e2d6e\"\n ],\n \"sources\": \"9587ae7b-3c67-4c24-a973-775c0cc22af0\",\n \"kill_chain_phase\": \"Action on Objectives\",\n \"business_impact\": [\n \"Branding Impact\"\n ],\n \"assigned_to\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"incident_date\": \"2022-01-17T07:38:50.000Z\",\n \"detection_date\": \"2022-01-18T07:38:50.000Z\",\n \"status\": \"open\",\n \"attack_vector\": \"Network\",\n \"source_ip\": \"12.12.12.12\",\n \"destination_ip\": \"13.13.13.13\",\n \"ie_customer_notification_required\": \"No\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/incident/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["incident",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Tue, 25 Jan 2022 07:59:32 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"7458","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Access-Control-Allow-Origin","value":"http://127.0.0.1:8080","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"knowledge_base\": [],\n \"knowledge_base_data\": [],\n \"applications\": [],\n \"applications_data\": [],\n \"softwares\": [],\n \"softwares_data\": [],\n \"users\": [],\n \"users_data\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"enhancements\": [],\n \"enhancements_data\": [],\n \"pirs_data\": [],\n \"briefings\": [],\n \"briefings_data\": [],\n \"campaigns\": [],\n \"campaigns_data\": [],\n \"malwares\": [],\n \"malwares_data\": [],\n \"threat_actors\": [],\n \"threat_actors_data\": [],\n \"actions_data\": [],\n \"vulnerabilities\": [],\n \"vulnerabilities_data\": [],\n \"attachments_data\": [],\n \"related_incidents\": [],\n \"related_incidents_data\": [],\n \"source_ip\": \"12.12.12.12\",\n \"source_hostname\": null,\n \"source_port\": null,\n \"destination_ip\": \"13.13.13.13\",\n \"destination_hostname\": null,\n \"destination_port\": null,\n \"containment_host\": null,\n \"containment_url\": null,\n \"containment_hash\": null,\n \"containment_summary\": null,\n \"containment_ip\": null,\n \"containment_result\": null,\n \"ie_malware_analysis_summary\": null,\n \"ie_log_analysis_summary\": null,\n \"ie_impact_on_intellectual_property\": null,\n \"ie_invegtigation_eradication_exception\": null,\n \"ie_findings_summary\": null,\n \"ie_port_numbers_impacted\": null,\n \"ie_forensics_details\": null,\n \"methods_validate_recovery_actions\": null,\n \"methods_monitor_recovery_actions\": null,\n \"recovery_details\": null,\n \"base_line_changes\": null,\n \"incident_learning\": null,\n \"closure_comments\": null,\n \"incident_analysis\": null,\n \"url_reputation\": null,\n \"ip_reputation\": null,\n \"ie_num_of_assets_impacted\": null,\n \"ie_num_of_users_impacted\": null,\n \"ie_regulatory_reporting_date\": null,\n \"attack_vector\": \"Network\",\n \"ie_customer_notification_required\": \"No\",\n \"ie_regulatory_notifications_required\": null,\n \"false_positive\": null,\n \"applicable_compliance\": [\n \"PCI\"\n ],\n \"incident_identified\": [],\n \"ie_motives\": [],\n \"ie_regulatory_reporting\": [],\n \"business_impact\": [\n \"Branding Impact\"\n ],\n \"ioc_MD5\": [],\n \"ioc_email\": [],\n \"ioc_ip\": [],\n \"kill_chain_phase\": \"Action on Objectives\",\n \"ioc_SHA256\": [],\n \"ioc_SHA1\": [],\n \"ioc_url\": [],\n \"ioc_domain\": [],\n \"unique_id\": \"745c8f87-cbb6-4e35-aa2d-89cfe1129446\",\n \"readable_id\": \"INC592\",\n \"created\": \"2022-01-25T07:59:30.432929Z\",\n \"description\": \"

test incident

\",\n \"modified\": \"2022-01-25T07:59:31.646699Z\",\n \"title\": \"test incident\",\n \"machine_generated\": true,\n \"incident_date\": \"2022-01-17T07:38:50Z\",\n \"detection_date\": \"2022-01-18T07:38:50Z\",\n \"status\": \"open\",\n \"machine_name\": null,\n \"closed_on\": null,\n \"ie_num_of_pii_exposed\": null,\n \"title_display\": \"test incident\",\n \"days_open\": 0,\n \"alert_type\": \"incident\",\n \"is_protected\": false,\n \"is_removed\": false,\n \"level\": \"Low\",\n \"types\": [],\n \"phase\": \"Detection Analysis\",\n \"ie_incident_type\": \"APT\",\n \"is_paused\": false,\n \"opened_on\": \"2022-01-25T07:59:30.430937Z\",\n \"can_close_instance\": true,\n \"assignment_sla\": null,\n \"resolution_sla\": {\n \"data\": {\n \"sla_duration\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 30\n }\n },\n \"elapsed_time\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 0\n },\n \"color\": 0\n },\n \"total_cost\": 0,\n \"time_to_detect\": {\n \"days\": 1,\n \"hours\": 0,\n \"minutes\": 0,\n \"seconds\": 0\n },\n \"time_to_resolve\": null,\n \"is_bookmarked\": false,\n \"permanently_closed\": false,\n \"resolution_due_date\": \"2022-01-25T08:29:30.430937Z\",\n \"total_ownership_duration\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 0,\n \"seconds\": 0\n },\n \"can_update_instance\": true,\n \"paused_by\": null,\n \"paused_by_data\": null,\n \"opened_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"parent_data\": null,\n \"modified_by_data\": null,\n \"assigned_group\": \"9518ecfb-f091-4959-8c22-b7e50494b98f\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"9518ecfb-f091-4959-8c22-b7e50494b98f\",\n \"group_name\": \"CFTR Admin\"\n },\n \"created_by\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"created_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"closed_by_data\": null,\n \"assigned_to\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"assigned_to_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"schema\": \"9fcc8071-6b0a-415f-832d-e417d4042410\",\n \"schema_data\": {\n \"title\": \"NIST\",\n \"description\": \"NIST created by me\",\n \"unique_id\": \"9fcc8071-6b0a-415f-832d-e417d4042410\",\n \"phase_flow\": \"LINEAR\"\n },\n \"sources\": [\n \"9587ae7b-3c67-4c24-a973-775c0cc22af0\"\n ],\n \"sources_data\": {\n \"unique_id\": \"9587ae7b-3c67-4c24-a973-775c0cc22af0\",\n \"source_type\": \"0d3f55b3-91c9-4388-8da2-7e56f28e3fcb\",\n \"value\": \"S1\",\n \"source_type_data\": {\n \"unique_id\": \"0d3f55b3-91c9-4388-8da2-7e56f28e3fcb\",\n \"created\": \"2021-06-09T10:26:35.540120Z\",\n \"title\": \"T1\"\n },\n \"created\": \"2021-06-09T10:26:37.228903Z\",\n \"source_display_name\": \"T1-S1\",\n \"modified\": \"2021-06-09T10:26:37.228903Z\"\n },\n \"labels\": [],\n \"labels_data\": [],\n \"tactic_technique_pair\": [],\n \"tactic_technique_pair_data\": [],\n \"business_units_impacted_data\": {\n \"title\": \"Bu 1\",\n \"unique_id\": \"9750d6df-2d7f-4899-b20d-bfbba0a9084d\"\n },\n \"locations_impacted_data\": [\n {\n \"title\": \"Loc 1\",\n \"unique_id\": \"671961e6-0119-460c-8d55-9b697f6e2d6e\"\n }\n ],\n \"is_schema_updated\": false,\n \"phase_data\": {\n \"unique_id\": \"8884b69e-f1fc-4aaa-9583-1ab85652acf8\",\n \"option_name\": \"Detection Analysis\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"fe3b0e23-419d-4df7-b095-ee814a6a6d74\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"incident_identified_data\": [],\n \"attack_vector_data\": {\n \"unique_id\": \"69867405-e7ce-4ae5-bfed-5149ff65687b\",\n \"option_name\": \"Network\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"d761470d-66dc-4ce6-9b33-391774e71ad5\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"kill_chain_phase_data\": {\n \"unique_id\": \"11fbe9a7-a237-4df1-96f9-3b452a402117\",\n \"option_name\": \"Action on Objectives\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"bac118a8-dbb6-4621-a0f6-c23b2a6d531e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"ie_motives_data\": [],\n \"ie_regulatory_reporting_data\": [],\n \"applicable_compliance_data\": [\n {\n \"unique_id\": \"7d94de2b-5c69-4be4-afd0-e768b5fc3dc6\",\n \"option_name\": \"PCI\",\n \"is_active\": true,\n \"order\": 10,\n \"option_field\": \"814a12b5-0ae1-4f1e-b54c-8dccbd541920\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n }\n ],\n \"ie_regulatory_notifications_required_data\": null,\n \"ie_incident_type_data\": {\n \"unique_id\": \"26c922dc-e49b-43a9-8304-140fa78b106c\",\n \"option_name\": \"APT\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"ca9713dc-37d7-4085-8367-3a8923a1e0b7\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"false_positive_data\": null,\n \"business_impact_data\": [\n {\n \"unique_id\": \"c0911952-4aa7-4470-ab5f-20eac856bee4\",\n \"option_name\": \"Branding Impact\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"b4c88412-0c66-4706-ac20-948ebacdc50f\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n }\n ],\n \"level_data\": {\n \"unique_id\": \"9e44ab13-64e5-43ad-a8d1-e1d181681090\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"2fdedb65-b0b7-48af-b34e-714b4f7622bb\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"ie_customer_notification_required_data\": {\n \"unique_id\": \"0134202c-4705-44d4-95ba-2a5572b0155e\",\n \"option_name\": \"No\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"5ddf3029-ecee-4761-a512-69571d5e7a68\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"ioc_ip_data\": [],\n \"ioc_domain_data\": [],\n \"ioc_url_data\": [],\n \"ioc_email_data\": [],\n \"ioc_MD5_data\": [],\n \"ioc_SHA1_data\": [],\n \"ioc_SHA256_data\": []\n}"},{"id":"9eff6e40-6755-4204-b2f6-e7c050b68e30","name":"Eg: Create Untriaged Incident","originalRequest":{"method":"POST","header":[{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"sec-ch-ua","value":"\" Not;A Brand\";v=\"99\", \"Google Chrome\";v=\"97\", \"Chromium\";v=\"97\""},{"key":"sec-ch-ua-mobile","value":"?0"},{"key":"Authorization","value":"CYW 3bQlSm2T0T22hYiBqRtkX7YRQd0HzQGRHdOvs2xPjXUzQCGZxSh49JkogkK+LRH5Mr+TnZ/qiRqScjI5ke34B+6H8iG/m6sE9gHeyS1uXqdxLr92VIVVbL/KT6+lLz9Vn5ale6OZ34r4xdRKrpCQtaMkfTCvzZHNQFga1OHHdSi42tOjTazG/HANDhTkJV2fkJgxpm8wdVOHa8VQSx//tZV3jSYH4l4fEBIoqPZLLL6ya1NDFolZ7qzT2+ZtztQm"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json, text/plain, */*"},{"key":"User-Agent","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/97.0.4692.99 Safari/537.36"},{"key":"cyw-api-key","value":"7d13a88e-3178-4b28-ae6e-91b627f85bcf"},{"key":"If-Modified-Since","value":"0"},{"key":"sec-ch-ua-platform","value":"\"macOS\""},{"key":"Origin","value":"http://127.0.0.1:8080"},{"key":"Sec-Fetch-Site","value":"same-origin"},{"key":"Sec-Fetch-Mode","value":"cors"},{"key":"Sec-Fetch-Dest","value":"empty"},{"key":"Referer","value":"http://127.0.0.1:8080/cftr/incident/tab/21/new?parent=858e4324-b606-41c1-aa0d-67b14b42d0e3"},{"key":"Accept-Language","value":"en-GB,en-US;q=0.9,en;q=0.8"},{"key":"Cookie","value":"csrftoken=JFqrb6Wg4oFSrxmOuRDSBDZhqI9UDiCqAsrxJx1eRMuln37SodJBdju95byJSFys"}],"body":{"mode":"raw","raw":"{\n \"title\": \"test incident\",\n \"description\": \"

test incident

\",\n \"status\": \"untriaged\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/incident/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["incident",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Tue, 25 Jan 2022 08:15:10 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"7473","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Access-Control-Allow-Origin","value":"http://127.0.0.1:8080","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"knowledge_base\": [],\n \"knowledge_base_data\": [],\n \"applications\": [],\n \"applications_data\": [],\n \"softwares\": [],\n \"softwares_data\": [],\n \"users\": [],\n \"users_data\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"enhancements\": [],\n \"enhancements_data\": [],\n \"pirs_data\": [],\n \"briefings\": [],\n \"briefings_data\": [],\n \"campaigns\": [],\n \"campaigns_data\": [],\n \"malwares\": [],\n \"malwares_data\": [],\n \"threat_actors\": [],\n \"threat_actors_data\": [],\n \"actions_data\": [],\n \"vulnerabilities\": [],\n \"vulnerabilities_data\": [],\n \"attachments_data\": [],\n \"related_incidents\": [],\n \"related_incidents_data\": [],\n \"source_ip\": null,\n \"source_hostname\": null,\n \"source_port\": null,\n \"destination_ip\": null,\n \"destination_hostname\": null,\n \"destination_port\": null,\n \"containment_host\": null,\n \"containment_url\": null,\n \"containment_hash\": null,\n \"containment_summary\": null,\n \"containment_ip\": null,\n \"containment_result\": null,\n \"ie_malware_analysis_summary\": null,\n \"ie_log_analysis_summary\": null,\n \"ie_impact_on_intellectual_property\": null,\n \"ie_invegtigation_eradication_exception\": null,\n \"ie_findings_summary\": null,\n \"ie_port_numbers_impacted\": null,\n \"ie_forensics_details\": null,\n \"ie_lessons_learned\": null,\n \"methods_validate_recovery_actions\": null,\n \"methods_monitor_recovery_actions\": null,\n \"recovery_details\": null,\n \"base_line_changes\": null,\n \"incident_learning\": null,\n \"closure_comments\": null,\n \"incident_analysis\": null,\n \"url_reputation\": null,\n \"ip_reputation\": null,\n \"ie_num_of_assets_impacted\": null,\n \"ie_num_of_users_impacted\": null,\n \"ie_regulatory_reporting_date\": null,\n \"attack_vector\": null,\n \"ie_root_cause\": null,\n \"ie_customer_notification_required\": null,\n \"ie_regulatory_notifications_required\": null,\n \"false_positive\": null,\n \"applicable_compliance\": [],\n \"incident_identified\": [],\n \"ie_motives\": [],\n \"ie_regulatory_reporting\": [],\n \"business_impact\": [],\n \"ioc_MD5\": [],\n \"ioc_email\": [],\n \"ioc_ip\": [],\n \"kill_chain_phase\": null,\n \"ioc_SHA256\": [],\n \"ioc_credit_card\": [],\n \"ioc_test\": [],\n \"ioc_SHA1\": [],\n \"ioc_test_5\": [],\n \"ioc_url\": [],\n \"ioc_test_3\": [],\n \"ioc_domain\": [],\n \"ioc_test_2\": [],\n \"ioc_test_6\": [],\n \"unique_id\": \"9569ac4c-e2a2-4e9e-9452-99c644f28e8b\",\n \"readable_id\": \"INC593\",\n \"created\": \"2022-01-25T08:15:08.873992Z\",\n \"description\": \"

test incident

\",\n \"modified\": \"2022-01-25T08:15:09.064877Z\",\n \"title\": \"test incident\",\n \"machine_generated\": true,\n \"incident_date\": \"2022-01-25T08:15:08.871753Z\",\n \"detection_date\": \"2022-01-25T08:15:08.871775Z\",\n \"status\": \"untriaged\",\n \"machine_name\": null,\n \"closed_on\": null,\n \"ie_num_of_pii_exposed\": null,\n \"title_display\": \"test incident\",\n \"days_open\": 0,\n \"alert_type\": \"incident\",\n \"is_protected\": false,\n \"is_removed\": false,\n \"level\": null,\n \"types\": [],\n \"phase\": null,\n \"ie_incident_type\": null,\n \"is_paused\": false,\n \"opened_on\": null,\n \"can_close_instance\": true,\n \"assignment_sla\": null,\n \"resolution_sla\": null,\n \"total_cost\": 0,\n \"time_to_detect\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 0,\n \"seconds\": 0\n },\n \"time_to_resolve\": null,\n \"is_bookmarked\": false,\n \"permanently_closed\": false,\n \"resolution_due_date\": null,\n \"total_ownership_duration\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 0,\n \"seconds\": 0\n },\n \"can_update_instance\": true,\n \"paused_by\": null,\n \"paused_by_data\": null,\n \"opened_by_data\": null,\n \"parent_data\": null,\n \"modified_by_data\": null,\n \"assigned_group\": null,\n \"assigned_group_data\": null,\n \"created_by\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"created_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"email@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"closed_by_data\": null,\n \"assigned_to\": null,\n \"assigned_to_data\": {},\n \"schema\": null,\n \"schema_data\": null,\n \"sources\": [],\n \"sources_data\": null,\n \"labels\": [],\n \"labels_data\": [],\n \"tactic_technique_pair\": [],\n \"tactic_technique_pair_data\": [],\n \"business_units_impacted_data\": {\n \"title\": \"Hidden\",\n \"unique_id\": \"2a29ca02-4676-441c-9d98-ceb14a65b1ea\"\n },\n \"locations_impacted_data\": [\n {\n \"title\": \"System\",\n \"unique_id\": \"4fade178-b589-41ef-a664-59b84df1d85a\"\n }\n ],\n \"is_schema_updated\": false,\n \"phase_data\": null,\n \"incident_identified_data\": [],\n \"attack_vector_data\": null,\n \"kill_chain_phase_data\": null,\n \"ie_motives_data\": [],\n \"ie_regulatory_reporting_data\": [],\n \"applicable_compliance_data\": [],\n \"ie_regulatory_notifications_required_data\": null,\n \"ie_root_cause_data\": null,\n \"ie_incident_type_data\": null,\n \"false_positive_data\": null,\n \"business_impact_data\": [],\n \"level_data\": null,\n \"ie_customer_notification_required_data\": null,\n \"ioc_ip_data\": [],\n \"ioc_domain_data\": [],\n \"ioc_url_data\": [],\n \"ioc_email_data\": [],\n \"ioc_MD5_data\": [],\n \"ioc_SHA1_data\": [],\n \"ioc_SHA256_data\": []\n}"}],"_postman_id":"e0dd3a70-874a-44d7-ba38-03d1bd21ab51"},{"name":"Create Incident Using Field Values","id":"2f9b3b92-a109-418f-aeae-d58f9372dd50","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sources\": \"test\",\n \"assigned_group\": \"CFTR Admin\",\n \"assigned_to\": \"pooja.gunali@cyware.com\",\n \"business_units_impacted\": [\n \"test\"\n ],\n \"locations_impacted\": [\n \"bengaluru\"\n ],\n \"title\": \"test.incident\",\n \"description\": \"

test incident

Creates an incident in your CFTR application by using the field values of locations, business units, sources, assigned groups, and the email IDs of the user you want to assign the incident.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/incident/?

Request Parameters

Notes:

If the default value is not mentioned, then the default value of all the optional parameters is None.
\n
To create an Untriaged incident, title is mandatory and all the other parameters are optional.
\n
To create an incident in Open status, title, business_units_impacted, locations_impacted, and assigned_group are mandatory.
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
title	String	Mandatory	Enter a title for the incident.
description	String	Optional	Enter a description that best describes the key details of the incident.
status	String	Optional	Enter the status of the incident. Allowed values: * untriaged * open * closed * merged Example: \"untriaged\" Default value: \"open\"
phase	String	Optional Note: By default, the incident phase will be the initial phase of the Incident Workflow as configured by your CFTR admin.	Enter the phase of the incident. Sample phases: • Detection Analysis • Containment • Investigation and Eradication • Recovery • Closure Example: “Detection Analysis”
ie_incident_type	String	Optional	Enter the type of Incident. Some examples of Incident Types are: • Malware • Phishing • Spearphishing Example: “Malware”
business_units_impacted	Array	Mandatory	Enter the titles of the impacted business units. You can retrieve the list of available Business Units and their titles using the following API endpoint: `/openapi/v1/utils/business-unit/` Note: You can add one or more business units impacted, depending on the settings configured in Admin Panel > Configurations > Incident > Other Settings.
locations_impacted	Array	Mandatory	Enter the title of the impacted locations. You can retrieve the list of available locations and their titles using the following API endpoint: `/openapi/v1/utils/location/`
sources	String	Optional	Enter the title of the sources. You can retrieve the list of all available sources and their titles using the following API endpoint: `/openapi/v1/utils/source/`
incident_date	String	Optional	Enter the date of occurrence of the incident in EPOCH time format.
detection_date	String	Optional	Enter the incident detection date in EPOCH time format.
level	String	Optional	Enter the severity level of the incident. Some of the example Severity Levels are: • Critical • High • Medium • Low Example: “Critical”
assigned_group	String	Mandatory	Enter the title of the user group to assign the incident. You can use the following API endpoint to retrieve the list of User Groups: `/openapi/v1/rest-auth/permission/group/`
assigned_to	String	Optional	Enter the email ID of the user to assign the incident. You can use the following API endpoint to retrieve the list of User: `/openapi/v1/rest-auth/user/`
labels	Array	Optional	Enter the name of labels to be added to the incident. You can use the following API endpoint to retrieve the list of Labels: /`openapi/v1/utils/label/`

Response Parameters

Response Parameters | Regulatory Fields

Parameter	Type	Description
`title`	String	Title of the incident.
`description`	Text	Description of the incident.
`unique_id`	String	Unique ID of the incident.
`readable_id`	String	Unique readable ID of the incident. It starts with INC followed by a unique number. Example: INC101
`status`	String	Current status of the incident. Allowed values: open closed untriaged merged
`phase`	String	Current phase of the incident. The phase describes the UUID of phase, part of the Incident Workflow.
`phase_data`	Object	Details of the current phase of the incident.
`level`	String	Severit level of the incident.
`level_data`	Object	Details of the severity level of the incident.
`created_by`	String	`user_id` of the user who created the incident.
`created_by_data`	Object	Details of user who created the incident.
`modified_by_data`	Object	Details of the user who last modified the incident.
`machine_generated`	Boolean	Shows if the incident is machine generated or not.
`closed_by_data`	Object	Details of used who closed the incident.
`created`	String	Incident creation date and time.
`modified`	String	Last updated date and time of the incident.
`opened_on`	String	Date and time of when the incident was moved to open state.
`opened_by_data`	Object	Details of the user who moved the incident to the open state.
`closed_on`	String	Date and time when the incident was closed. If incident is not closed, value of this param will be Null.
`incident_date`	String	Date and time of the incident creation.
`detection_date`	String	Date and time of when the incident was detected as malicious.
`is_protected`	Boolean	Shows if the incident is protected or not.
`is_removed`	Boolean	Shows if the incident is in the deleted state or not.
`assigned_to`	String	`user_id` of the assigned user.
`assigned_to_data`	Object	Details of the assigned user.
`assigned_group`	String	`group_comm_id` of the assigned user group.
`assigned_group_data`	Object	Details of the assigned user group.
`assignment_sla`	String	Assignment SLA details of the incident. It has two keys: 1. `color`: Associated color code(according to SLA breach level). 2. `data`: It has two keys: - `sla_duration`: SLA Breach time. - `elapsed_time`: Time elapsed between incident opening and SLA completion.
`resolution_sla`	String	Resolution SLA details of the incident. It has two keys: 1. `color`: Associated color code(according to SLA breach level). 2. `data`: It has two keys: - `sla_duration`: SLA Breach time. - `elapsed_time`: Time elapsed between incident opening and SLA completion.
`notification_sla`	List of Objects	Details of the configured incident notifications (If enabled).
`total_cost`	Integer	Total cost incurred due to the incident.
`is_bookmarked`	Boolean	Shows if the incident is bookmarked or not.
`permanently_closed`	Boolean	Shows if the incident is permanently closed or not.
`resolution_due_date`	String	Resolution SLA breach date of the incident.
`can_update_instance`	Boolean	Shows whether the instance can be updated by the user who requested it or not.
`can_close_instance`	Boolean	Shows if the user who requested it can close the incident or not.
`is_paused`	Boolean	Shows if the incident is in the paused state or not.
`paused_by`	String	`user_id` of the user who paused the incident.
`paused_by_data`	Object	Details of the user who paused the incident.
`schema`	String	Unique ID of the Incident Workflow that is being used by the incident.
`schema_data`	Object	Details of the Incident Workflow that is being used by the incident.
`sources`	Array	List of the sources for the incident.
`sources_data`	Array of Objects	Details of the sources for the incident.
`labels`	Array	List of the labels that are added to the incident.
`labels_data`	Array of Objects	Details of the labels that are added to the incident.
`tactic_technique_pair`	Array	List of the tactics and techniques used by the incident.
`tactic_technique_pair_data`	Array of Objects	Details of the tactics and techniques used by the incident.
`business_units_impacted_data`	Array of Objects	List of business units that are impacted by the incident.
`locations_impacted_data`	Array of Objects	List of locations that are impacted by the incident.

Response Parameters | Connect The Dots

Following are the response parameters corresponding the Connect The Dots section of the incident. The parameters ending with data contain the meta information for each connected component. The non `__data` parameters just include an array of unique_id referencing to connected components.

Parameter	Type	Description
`applications`	Array of UUID Strings	List of `unique_id` of the connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`softwares`	Array of UUID Strings	List of `unique_id` of the connected software.
`softwares_data`	Array of Objects	Details of the connected software.
`users`	Array of UUID Strings	List of `unique_id` of the connected users.
`users_data`	Array of Objects	Details of the connected users.
`endpoints`	Array of UUID Strings	List of `unique_id` of the connected devices.
`endpoints_data`	Array of Objects	Details of the connected devices.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.

Response Parameters | Default Indicators

Following are the seven standard indicators that are included by default in the CFTR platform, which reflect in the incident's response data with the following keys:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`ioc_SHA1`	Array of UUID Strings	List of `unique_id` of the connected SHA1 Threat Intels.
`ioc_SHA1_data`	Array of Objects	Details of the connected SHA1 Threat Intels.
`ioc_MD5`	Array of UUID Strings	List of `unique_id` of the connected MD5 Threat Intels.
`ioc_MD5_data`	Array of Objects	Details of the connected MD5 Threat Intels.
`ioc_SHA256`	Array of UUID Strings	List of `unique_id` of the connected SHA256 Threat Intels.
`ioc_SHA256_data`	Array of Objects	Details of the connected SHA256 Threat Intels.
`ioc_ip`	Array of UUID Strings	List of `unique_id` of the connected IP Threat Intels.
`ioc_ip_data`	Array of Objects	Details of the connected IP Threat Intels.
`ioc_url`	Array of UUID Strings	List of `unique_id` of the connected URL Threat Intels.
`ioc_url_data`	Array of Objects	Details of the connected URL Threat Intels.
`ioc_domain`	Array of UUID Strings	List of `unique_id` of the connected domain Threat Intels.
`ioc_domain_data`	Array of Objects	Details of the connected domain Threat Intels.
`ioc_email`	Array of UUID Strings	List of `unique_id` of the connected email Threat Intels.
`ioc_email_data`	Array of Objects	Details of the connected email Threat Intels.

Response Parameters | Custom Indicators

The Example of a custom indicator parameter in the Incident's response is shown below.

\n
Note: The parameter key for custom indicator(s) may vary as per the Custom Threat Intel's name
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`ioc_credit_card`	Array of UUID Strings	List of UUID-4 formatted `unique_id` Strings corresponding to the Custom Threat Intel Credit Card, which are connected to the Incident
`ioc_credit_card_data`	Array of Objects	List of basic details of the Custom Indicator Credit Card connected to the Incident

Response Parameters | Custom Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type
summary_card_host_pairs	String
ie_port_numbers_impacted	String
incident_learning	String
recovery_details	String

Response Parameters | Attachments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
attachments_data	Array of Objects	Details of each attachment of the incident.

Response Parameters | Actions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
actions_data	Array of Objects	Details of the actions that are added to the incident.

Response Parameters | Enhancements

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
enhancements	Array of UUID Strings	List of the enhancements that are added to the incident.
enhancements_data	Array of Objects	Details of the enhancements that are added to the incident.

Response Parameters | PIRs

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
pirs_data	Array of Objects	Details of the PIRs that are added to the incident.

Response Parameters | Knowledge Base

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
knowledge_base	Array of UUID Strings	List of the knowledge base records that are added to the incident.
knowledge_base_data	Array of Objects	Details of the knowledge base records that are added to the incident.

Response Parameters | System Form Fields

These fields include:

All Connect the Dots params: You can retrieve the corresponding UUID-4 from the details page browser URL of the instance.
\n
All Indicators params: You can retrieve the corresponding UUID-4 from the details page browser URL of the instance.
\n
Assigned User / Assigned Group related params: You can retrieve the corresponding UUID-4 from the User Management and Group Management sections respectively.
\n
Business Unit, Location: You can retrieve the corresponding UUID-4 from Admin > Settings section.
\n

Do not change the parameter value\nAllows you to create incidents using the values of locations, business units, sources, assigned groups, labels and the email IDs of assigned users.

\n","type":"text/plain"},"key":"values","value":"readable_type"}],"variable":[]}},"response":[{"id":"b222ac30-e8a2-417c-8db1-e9621d4bd6d8","name":"Create Incident from Values","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sources\": \"CERT-IN\",\n \"assigned_group\": \"CFTR Admin\",\n \"assigned_to\": \"peter.smith@example.com\",\n \"business_units_impacted\": [\"Lime Pelican\"],\n \"locations_impacted\": [\"Egypt\", \"Cyprus\"],\n\n \"title\": \"test incident\",\n \"description\": \"

test incident

\",\n \"applicable_compliance\": [\n \"PCI\"\n ],\n \"ie_incident_type\": \"APT\",\n \"level\": \"Low\",\n \"kill_chain_phase\": \"Action on Objectives\",\n \"business_impact\": [\n \"Branding Impact\"\n ],\n \"incident_date\": \"2022-01-17T07:38:50.000Z\",\n \"detection_date\": \"2022-01-18T07:38:50.000Z\",\n \"status\": \"open\",\n \"attack_vector\": \"Network\",\n \"source_ip\": \"12.12.12.12\",\n \"destination_ip\": \"13.13.13.13\",\n \"ie_customer_notification_required\": \"No\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/incident/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","host":["{{base_url}}v1"],"path":["incident",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"values","value":"readable_type","description":"**Do not change the parameter value**\nAllows you to create incidents using the values of locations, business units, sources, assigned groups, labels and the email IDs of assigned users.\n"}]}},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Thu, 08 Dec 2022 06:58:54 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"9483","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Access-Control-Allow-Origin","value":"http://127.0.0.1:8080","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"knowledge_base\": [],\n \"knowledge_base_data\": [],\n \"applications\": [],\n \"applications_data\": [],\n \"softwares\": [],\n \"softwares_data\": [],\n \"users\": [],\n \"users_data\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"enhancements\": [],\n \"enhancements_data\": [],\n \"pirs_data\": [],\n \"briefings\": [],\n \"briefings_data\": [],\n \"campaigns\": [],\n \"campaigns_data\": [],\n \"malwares\": [],\n \"malwares_data\": [],\n \"threat_actors\": [],\n \"threat_actors_data\": [],\n \"actions_data\": [\n {\n \"title\": \"Test 123\",\n \"readable_id\": \"ACT15978\",\n \"created\": \"2022-12-08T06:58:53.998498Z\",\n \"modified\": \"2022-12-08T06:58:53.998498Z\",\n \"status\": \"draft\",\n \"unique_id\": \"a2682e92-0159-4975-96bb-0a175182b468\",\n \"title_display\": \"Test 123\"\n },\n {\n \"title\": \"Action 28/7 ROUND 4\",\n \"readable_id\": \"ACT15977\",\n \"created\": \"2022-12-08T06:58:52.844734Z\",\n \"modified\": \"2022-12-08T06:58:53.418671Z\",\n \"status\": \"draft\",\n \"unique_id\": \"514aa762-0859-411b-851b-6e45441cb9c7\",\n \"title_display\": \"Action 28/7 ROUND 4\"\n }\n ],\n \"vulnerabilities\": [],\n \"vulnerabilities_data\": [],\n \"attachments_data\": [],\n \"related_incidents\": [],\n \"related_incidents_data\": [],\n \"containment_summary\": null,\n \"ie_port_numbers_impacted\": null,\n \"recovery_details\": null,\n \"source_ip\": \"12.12.12.12\",\n \"source_port\": null,\n \"ie_log_analysis_summary\": null,\n \"containment_ip\": null,\n \"ie_malware_analysis_summary\": null,\n \"base_line_changes\": null,\n \"url_reputation\": null,\n \"methods_validate_recovery_actions\": null,\n \"methods_monitor_recovery_actions\": null,\n \"ie_findings_summary\": null,\n \"destination_port\": null,\n \"closure_comments\": null,\n \"user_id\": null,\n \"destination_hostname\": null,\n \"containment_host\": null,\n \"src_ip_reputation\": null,\n \"ie_forensics_details\": null,\n \"ie_invegtigation_eradication_exception\": null,\n \"original_source_url\": null,\n \"containment_result\": null,\n \"source_hostname\": null,\n \"containment_url\": null,\n \"ie_impact_on_intellectual_property\": null,\n \"ie_lessons_learned\": null,\n \"containment_hash\": null,\n \"aql_search_results\": null,\n \"8197_prep_tab_test\": null,\n \"mandatory_field\": null,\n \"false_positive_1\": null,\n \"response_from_user\": null,\n \"test_21st_nov\": null,\n \"ie_num_of_assets_impacted\": null,\n \"int_check_24\": null,\n \"int_check_26\": null,\n \"newfield\": null,\n \"ie_regulatory_reporting_date\": null,\n \"ie_root_cause\": null,\n \"attack_vector\": \"Network\",\n \"ie_regulatory_notifications_required\": null,\n \"false_positive\": null,\n \"new_field_test\": null,\n \"kill_chain_phase\": \"Action on Objectives\",\n \"nidhitest\": null,\n \"new_single_select\": null,\n \"is_user_responded\": null,\n \"ioc_ip\": [],\n \"ioc_custom_inc_8\": [],\n \"ioc_custom_inc_5\": [],\n \"ioc_md5\": [],\n \"ioc_custom_-_sha512\": [],\n \"ioc_domain\": [],\n \"ioc_custom_inc_9\": [],\n \"ioc_custom_inc_4\": [],\n \"ioc_credit_card\": [],\n \"ioc_custom_indicator\": [],\n \"ioc_url\": [],\n \"test_123\": [],\n \"ie_regulatory_reporting\": [],\n \"ioc_test_integration\": [],\n \"ioc_sha1\": [],\n \"ie_motives\": [],\n \"ioc_malware\": [],\n \"ioc_autonomous_system\": [],\n \"ioc_mac_addrr\": [],\n \"ioc_sha256\": [],\n \"ioc_custom_inc_6\": [],\n \"ioc_custom_inc_7\": [],\n \"ioc_custom_inc_10\": [],\n \"ioc_test_v6\": [],\n \"ioc_email\": [],\n \"multi_select_check_20\": [],\n \"ioc_test_25\": [],\n \"unique_id\": \"ac9eede0-0b3b-4edc-9d2a-d1dceb70e448\",\n \"readable_id\": \"INC243740\",\n \"created\": \"2022-12-08T06:58:52.218091Z\",\n \"description\": \"

test incident

\",\n \"modified\": \"2022-12-08T06:58:53.117389Z\",\n \"title\": \"test incident\",\n \"machine_generated\": true,\n \"incident_date\": \"2022-01-17T07:38:50Z\",\n \"detection_date\": \"2022-01-18T07:38:50Z\",\n \"status\": \"open\",\n \"machine_name\": null,\n \"closed_on\": null,\n \"title_display\": \"test incident\",\n \"days_open\": 0,\n \"alert_type\": \"incident\",\n \"is_protected\": false,\n \"is_removed\": false,\n \"level\": \"Low\",\n \"types\": [],\n \"phase\": \"Detection Analysis\",\n \"ie_incident_type\": \"APT\",\n \"is_paused\": false,\n \"opened_on\": \"2022-12-08T06:58:52.215813Z\",\n \"can_close_instance\": true,\n \"assignment_sla\": null,\n \"resolution_sla\": {\n \"data\": {\n \"sla_duration\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 15\n }\n },\n \"elapsed_time\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 0\n },\n \"color\": 0\n },\n \"notification_sla\": [\n {\n \"type\": \"new_notification\",\n \"data_breach\": {\n \"days\": 1,\n \"hours\": 5,\n \"minutes\": 20\n },\n \"data_about_to_breach\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 20\n },\n \"compare_time\": \"2022-12-08T06:58:52.215813Z\"\n },\n {\n \"type\": \"follow_up_1\",\n \"data_breach\": {\n \"days\": 1,\n \"hours\": 1,\n \"minutes\": 50\n },\n \"data_about_to_breach\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 25\n },\n \"compare_time\": null\n },\n {\n \"type\": \"follow_up_2\",\n \"data_breach\": {\n \"days\": 1,\n \"hours\": 1,\n \"minutes\": 25\n },\n \"data_about_to_breach\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 10\n },\n \"compare_time\": null\n },\n {\n \"type\": \"follow_up_3\",\n \"data_breach\": {\n \"days\": 1,\n \"hours\": 1,\n \"minutes\": 1\n },\n \"data_about_to_breach\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 20\n },\n \"compare_time\": null\n }\n ],\n \"total_cost\": 0,\n \"time_to_detect\": {\n \"days\": 1,\n \"hours\": 0,\n \"minutes\": 0,\n \"seconds\": 0\n },\n \"time_to_resolve\": null,\n \"is_ctix_generated\": false,\n \"is_bookmarked\": false,\n \"permanently_closed\": false,\n \"resolution_due_date\": \"2022-12-08T07:13:52.215813Z\",\n \"total_ownership_duration\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 0,\n \"seconds\": 0\n },\n \"can_update_instance\": true,\n \"can_update_full\": true,\n \"paused_by\": null,\n \"paused_by_data\": null,\n \"opened_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"full_name\": \"Peter Smith\"\n },\n \"parent_data\": null,\n \"modified_by_data\": null,\n \"assigned_group\": \"3b3b1351-1cdf-46b7-bf90-8526720608a3\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"3b3b1351-1cdf-46b7-bf90-8526720608a3\",\n \"group_name\": \"CFTR Admin\"\n },\n \"created_by\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"created_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"peter.smith@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"closed_by_data\": null,\n \"assigned_to\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"assigned_to_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"peter.smith@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"schema\": \"d013283f-66ad-499b-8f69-845e1124a062\",\n \"schema_data\": {\n \"title\": \"NIST Flow\",\n \"description\": \"Non Linear\",\n \"unique_id\": \"d013283f-66ad-499b-8f69-845e1124a062\",\n \"phase_flow\": \"NON_LINEAR\"\n },\n \"sources\": [\n \"58a4be41-b7e5-4d26-844c-e891f66b14c3\"\n ],\n \"sources_data\": {\n \"unique_id\": \"58a4be41-b7e5-4d26-844c-e891f66b14c3\",\n \"source_type\": \"af0882c8-f8c2-480a-8d05-8143f694b07c\",\n \"value\": \"CERT-IN\",\n \"source_type_data\": {\n \"unique_id\": \"af0882c8-f8c2-480a-8d05-8143f694b07c\",\n \"created\": \"2020-03-19T10:57:44.168774Z\",\n \"title\": \"Third-Party\"\n },\n \"created\": \"2020-12-01T07:16:25.084807Z\",\n \"source_display_name\": \"Third-Party-CERT-IN\",\n \"modified\": \"2020-12-01T07:16:25.084807Z\"\n },\n \"labels\": [],\n \"labels_data\": [],\n \"tactic_technique_pair\": [],\n \"tactic_technique_pair_data\": [],\n \"business_units_impacted_data\": [\n {\n \"title\": \"Lime Pelican\",\n \"unique_id\": \"88c88e84-7a84-475f-b582-1bafd5b5a155\",\n \"email_list\": null\n }\n ],\n \"locations_impacted_data\": [\n {\n \"title\": \"Cyprus\",\n \"unique_id\": \"247d3574-0765-4f70-b865-9bbfcddeeec8\"\n },\n {\n \"title\": \"Egypt\",\n \"unique_id\": \"2cf7c591-2bf6-46a0-8226-531446caa5c8\"\n }\n ],\n \"is_schema_updated\": false,\n \"update_index\": 6,\n \"slack_notify\": false,\n \"teams_notify\": false,\n \"is_sla_paused\": false,\n \"handoff_note\": null,\n \"phase_data\": {\n \"unique_id\": \"1c4dbf79-b60f-4972-9064-5db56d69b92c\",\n \"option_name\": \"Detection Analysis\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"55b6fde9-1aee-42b5-866b-04e43e50d731\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"ie_motives_data\": [],\n \"ie_root_cause_data\": null,\n \"ie_incident_type_data\": {\n \"unique_id\": \"b0497884-6345-408d-ad01-ffcdf3e8f12a\",\n \"option_name\": \"APT\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"e69bc18b-dc9e-4edb-8fb0-50145f3d1987\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"kill_chain_phase_data\": {\n \"unique_id\": \"b70d74da-4d05-4061-a1c9-1e3172a0c875\",\n \"option_name\": \"Action on Objectives\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"2bafd029-f347-41fb-8f63-7166ff555c92\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"false_positive_data\": null,\n \"level_data\": {\n \"unique_id\": \"391af454-70f0-4b6e-b07d-f25cfb9ac229\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"b3f4829f-8554-4df3-a55c-2c886513a955\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": \"#3170DB\"\n },\n \"ie_regulatory_reporting_data\": [],\n \"attack_vector_data\": {\n \"unique_id\": \"0b789015-fbad-468d-b2a9-19dacc48713b\",\n \"option_name\": \"Network\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"40491cb7-e2da-4e06-b49a-bb2439882b5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"ie_regulatory_notifications_required_data\": null,\n \"is_user_responded_data\": null,\n \"nidhitest_data\": null,\n \"multi_select_check_20_data\": [],\n \"select_field_33_data\": null,\n \"new_single_select_data\": null,\n \"new_field_test_data\": null,\n \"test_123_data\": [],\n \"ioc_ip_data\": [],\n \"ioc_domain_data\": [],\n \"ioc_url_data\": [],\n \"ioc_email_data\": [],\n \"ioc_md5_data\": [],\n \"ioc_sha1_data\": [],\n \"ioc_sha256_data\": [],\n \"ioc_credit_card_data\": [],\n \"ioc_custom_inc_4_data\": [],\n \"ioc_custom_inc_9_data\": [],\n \"ioc_custom_inc_7_data\": [],\n \"ioc_custom_inc_6_data\": [],\n \"ioc_custom_inc_5_data\": [],\n \"ioc_custom_inc_8_data\": [],\n \"ioc_custom_inc_10_data\": [],\n \"ioc_test_25_data\": [],\n \"ioc_custom_indicator_data\": [],\n \"ioc_malware_data\": [],\n \"ioc_test_integration_data\": [],\n \"ioc_test_v6_data\": [],\n \"ioc_autonomous_system_data\": [],\n \"ioc_mac_addrr_data\": [],\n \"ioc_custom_-_sha512_data\": []\n}"}],"_postman_id":"2f9b3b92-a109-418f-aeae-d58f9372dd50"},{"name":"Update Incident Using Field UUID","id":"ff6e9549-6679-4671-b13d-9ccbff3c243b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Phishing incident\"\n}"},"url":"{{base_url}}v1/incident/:incident_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Update the details of an incident in the CFTR application using the field UUID of locations, business units, sources, assigned groups, and assigned users.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/incident/:incident_unique_id/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
title	string	Optional	Enter a title for the incident.
description	string	Optional	Enter a description that best describes the key details of the incident.
status	string	Optional	Enter the status of the incident. Allowed values: * untriaged * open * closed * merged Example: \"untriaged\" Default value: \"open\"
phase	String	Optional Note: By default, the incident phase will be the initial phase of the Incident Workflow as configured by your CFTR admin.	Enter the phase of the incident. Sample phases: • Detection Analysis • Containment • Investigation and Eradication • Recovery • Closure Example: “Detection Analysis”
ie_incident_type	String	Optional	Enter the type of the Incident. Some of the examples Incident Types are: • Malware • Phishing • Spearphishing Example: “Malware”
business_units_impacted	String	Optional	Enter the unique ID of the impacted Business Units. You can retrieve the list of available Business Units and their Unique IDs using the following API endpoint: `/openapi/v1/utils/business-unit/`
locations_impacted	Array	Optional	Enter the unique ID of the impacted locations. You can retrieve the list of available locations and their unique IDs using the following API endpoint: `/openapi/v1/utils/location/`
sources	String	Optional	Enter the unique ID of the Sources. You can retrieve the list of all available Sources and their unique IDs using the following API endpoint: `/openapi/v1/utils/source/`
incident_date	datetime	Optional	Enter the date of occurrence of the incident.
detection_date	datetime	Optional	Enter the incident detection date.
level	String	Optional	Enter the severity level of the incident. Some of the example Severity Levels are: • Critical • High • Medium • Low Example: “Critical”
assigned_group	String	Optional	Enter the unique ID of the user group to assign the incident. You can use the following API endpoint to retrieve the list of User Groups: `/openapi/v1/rest-auth/permission/group/`
handoff_note	Object Dictionary, String	Mandatory (If Assigned Group or Assigned Users are updated for an Incident)	Provide the following details for updating the Group or User assigned to the Incident: `unique_id` – Incident Unique ID handoff_note: `description` – Description for the closure note `comment_type` – handoff Sample Request \"handoff_note\":{ \"comment_type\":\"handoff\", \"description\":\"Note for updating the incident\" }

Request Parameters | Connect The Dots

Provide the following parameters to update the Connect The Dots section of the incident.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`applications`	Array of UUID Strings	List of `unique_id` of the connected applications.
`softwares`	Array of UUID Strings	List of `unique_id` of the connected software.
`users`	Array of UUID Strings	List of `unique_id` of the connected users.
`endpoints`	Array of UUID Strings	List of `unique_id` of the connected devices.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.

Response Parameters

The response of this API endpoint contains limited data. To get all details of the incident, use the following API endpoint:

GET {base_url}/openapi/v1/incident/{incident_unique_id}/

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
modified	Datetime	Date and time of when the incident was last modified
modified_by_data	Object	Details of the user who modified the incident. Details include: username, email, first name, last name, etc.

Example Error Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Description
400	You are not allowed to update this Incident.
404	Invalid Unique ID.

","urlObject":{"path":["incident",":incident_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"type":"any","value":"81ef3632-cba9-469d-be6a-b4f44569e682","key":"incident_unique_id"}]}},"response":[{"id":"563bf0c2-4942-4ab1-a842-edc6be3e66d0","name":"Eg: Update Assignee of Incident","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}"},{"key":"","value":"","disabled":true}],"body":{"mode":"raw","raw":"{\n \"assigned_to\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"handoff_note\":{\"description\":\"

updating assignee

\", \"comment_type\":\"handoff\"}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/incident/745c8f87-cbb6-4e35-aa2d-89cfe1129446/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["incident","745c8f87-cbb6-4e35-aa2d-89cfe1129446",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Tue, 25 Jan 2022 13:56:21 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"301","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"modified\": \"2022-01-25 13:56:20.450040+00:00\",\n \"modified_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"full_name\": \"Peter Smith\"\n }\n}"}],"_postman_id":"ff6e9549-6679-4671-b13d-9ccbff3c243b"},{"name":"Update Incident Using Field Values","id":"5283c68e-6488-4c30-9f52-b9d9d15fd350","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}"}],"body":{"mode":"raw","raw":"{\n \"sources\": \"Email\",\n \"assigned_to\": \"pooja.gunali@cyware.com\",\n \"handoff_note\": {\n \"comment_type\": \"handoff\",\n \"description\": \"Note for updating the incident\"\n },\n \"business_units_impacted\": [\n \"System\"\n],\n\"locations_impacted\": [\n \"Bengaluru\"\n],\n\"labels\": [\n \"Phishing\"\n]\n}"},"url":"{{base_url}}/cftrapi/openapi/v1/incident/:incident_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","description":"

Update the details of an incident in the CFTR application by using the field values of locations, business units, sources, assigned groups, and the email IDs of assigned users.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/incident/:incident_unique_id/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

Parameters	Type	Required	Description
title	string	Optional	Enter a title for the incident.
description	string	Optional	Enter a description that best describes the key details of the incident.
status	string	Optional	Enter the status of the incident. Allowed values: * untriaged * open * closed * merged Example: \"untriaged\" Default value: \"open\"
phase	String	Optional	Enter the phase of the incident. Sample phases: • Detection Analysis • Containment • Investigation and Eradication • Recovery • Closure Example: “Detection Analysis” Note: By default, the incident phase will be the initial phase of the Incident Workflow as configured by your CFTR admin.
ie_incident_type	String	Optional	Enter the type of Incident. Some of the examples Incident Types are: • Malware • Phishing • Spearphishing Example: “Malware”
business_units_impacted	String	Optional	Enter the title of the impacted Business Units. You can retrieve the list of available Business Units and their titles using the following API endpoint: `/openapi/v1/utils/business-unit/`
locations_impacted	Array	Optional	Enter the title of the impacted locations. You can retrieve the list of available locations and their titles using the following API endpoint: `/openapi/v1/utils/location/`
sources	String	Optional	Enter the title of the Sources. You can retrieve the list of all available Sources and their titles using the following API endpoint: `/openapi/v1/utils/source/`
incident_date	String	Optional	Enter the date of occurrence of the incident.
detection_date	String	Optional	Enter the incident detection date.
level	String	Optional	Enter the severity level of the incident. Some of the example Severity Levels are: • Critical • High • Medium • Low Example: “Critical”
assigned_group	String	Optional	Enter the title of the user group to assign the incident. You can use the following API endpoint to retrieve the list of User Groups: `/openapi/v1/rest-auth/permission/group/`
assigned_to	String	Optional	Enter the email ID of the user to assign the incident. You can use the following API endpoint to retrieve the list of users: `/openapi/v1/rest-auth/user/`
handoff_note	Object Dictionary, String	Mandatory (If Assigned Group or Assigned Users are updated for an Incident)	Provide the following details for updating the Group or User assigned to the Incident: `unique_id` – Incident Unique ID handoff_note: `description` – Description for the closure note `comment_type` – handoff Sample Request \"handoff_note\":{ \"comment_type\":\"handoff\", \"description\":\"Note for updating the incident\" }
labels	Array	Optional	Enter the name of labels to be added to the incident. You can use the following API endpoint to retrieve the list of Labels: /`openapi/v1/utils/label/`

Request Parameters | Connect The Dots

Provide the following parameters to update the Connect The Dots section of the incident.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`applications`	Array of UUID Strings	List of `unique_id` of the connected applications.
`softwares`	Array of UUID Strings	List of `unique_id` of the connected software.
`users`	Array of UUID Strings	List of `unique_id` of the connected users.
`endpoints`	Array of UUID Strings	List of `unique_id` of the connected devices.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.

Response Parameters

The response of this API endpoint contains limited data. To get all details of the incident, use the following API endpoint:

GET {base_url}/openapi/v1/incident/{incident_unique_id}/

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
modified	Datetime	Date and time of when the incident was last modified
modified_by_data	Object	Details of user who updated the incident. Details include: username, email, first name, last name, etc.

Example Error Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Description
400	You are not allowed to update this Incident.
404	Invalid Unique ID.

","urlObject":{"path":["cftrapi","openapi","v1","incident",":incident_unique_id",""],"host":["{{base_url}}"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"description":{"content":"

Do not change the parameter value\nAllows you to update incidents using the values of locations, business units, sources, assigned groups, and the email IDs of assigned users.

\n","type":"text/plain"},"key":"values","value":"readable_type"}],"variable":[{"type":"any","value":"","key":"incident_unique_id"}]}},"response":[{"id":"359f996c-bfe0-4d81-ade5-e59ec3b5e845","name":"Update Incident using Readable Values","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}"},{"key":"","value":"","disabled":true}],"body":{"mode":"raw","raw":"{\n \"sources\": \"CERT-IN\",\n \"assigned_to\": \"peter.smith@example.com\",\n \"business_units_impacted\": [\n \"Lime Pelican\"\n ],\n \"locations_impacted\": [\n \"Egypt\",\n \"Cyprus\"\n ],\n \"labels\": [\"Machine Down\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/incident/92324f37-6841-46c3-ae19-c846afa356be/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","host":["{{base_url}}v1"],"path":["incident","92324f37-6841-46c3-ae19-c846afa356be",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"values","value":"readable_type","description":"**Do not change the parameter value**\nAllows you to update incidents using the values of locations, business units, sources, assigned groups, and the email IDs of assigned users.\n"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Tue, 13 Dec 2022 07:04:03 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"modified\": \"2022-12-13 07:04:01.625439+00:00\",\n \"update_index\": 8,\n \"modified_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"peter.smith@example.com\",\n \"full_name\": \"Peter Smith\"\n }\n}"}],"_postman_id":"5283c68e-6488-4c30-9f52-b9d9d15fd350"},{"name":"Closing Incident ","id":"01ace5ba-30fc-4bd3-9bfe-c6bc0bbb09fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"closed\",\n \"closure_note\":{\"description\":\"

closing this incident

\",\"comment_type\":\"closure\"}\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/incident/:incident_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Close an incident in the CFTR application.

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
unique_id	String	Mandatory	Enter the unique ID of the incident.
status	String	Mandatory	Enter “closed”.
closure_note	Object Dictionary, String	Mandatory	Provide the following details in the closure note for closing the Incident: `unique_id` – Incident Unique ID closure_note: `description` – Description for the closure note `comment_type` – closure Sample Request \"closure_note\":{ \"comment_type\":\"closure\", \"description\":\"Note for closing the incident\" }

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
modified	String	Incident closing time.
modified_by_data	Object	Details of the user who closed the incident. Details include: username, email, first name, last name, etc.

Example Error Code

\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Description
400	Incident cannot be closed before completing the phase cycle.

Enter the unique ID of the incident to be closed.

\n","type":"text/plain"},"type":"any","value":"c2a76a82-0f65-41e6-a3df-e54585aa775a","key":"incident_unique_id"}]}},"response":[{"id":"4e6f91ac-b0e1-4fd4-9a6a-a77d31fc69eb","name":"Closing Incident ","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"closed\",\n \"closure_note\":{\"description\":\"

closing this incident

\",\"comment_type\":\"closure\"}\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/incident/c2a76a82-0f65-41e6-a3df-e54585aa775a/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["incident","c2a76a82-0f65-41e6-a3df-e54585aa775a",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Thu, 27 Jan 2022 14:35:55 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"301","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"modified\": \"2022-01-27 14:35:23.371193+00:00\",\n \"modified_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n }\n}"}],"_postman_id":"01ace5ba-30fc-4bd3-9bfe-c6bc0bbb09fc"},{"name":"Add Comment in Incident","id":"c489a599-259d-491a-9b93-c2ceaa697a4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"sec-ch-ua","value":"\" Not;A Brand\";v=\"99\", \"Google Chrome\";v=\"97\", \"Chromium\";v=\"97\""},{"key":"sec-ch-ua-mobile","value":"?0"},{"key":"Authorization","value":"CYW 3bQlSm2T0T22hYiBqRtkX7YRQd0HzQGRHdOvs2xPjXUzQCGZxSh49JkogkK+LRH5Mr+TnZ/qiRqScjI5ke34B+6H8iG/m6sE9gHeyS1uXqdxLr92VIVVbL/KT6+lLz9Vn5ale6OZ34r4xdRKrpCQtaMkfTCvzZHNQFga1OHHdSi42tOjTazG/HANDhTkJV2fkJgxpm8wdVOHa8VQSx//tZV3jSYH4l4fEBIoqPZLLL6ya1NDFolZ7qzT2+ZtztQm"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json, text/plain, */*"},{"key":"User-Agent","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/97.0.4692.99 Safari/537.36"},{"key":"cyw-api-key","value":"7d13a88e-3178-4b28-ae6e-91b627f85bcf"},{"key":"If-Modified-Since","value":"0"},{"key":"sec-ch-ua-platform","value":"\"macOS\""},{"key":"Origin","value":"http://127.0.0.1:8080"},{"key":"Sec-Fetch-Site","value":"same-origin"},{"key":"Sec-Fetch-Mode","value":"cors"},{"key":"Sec-Fetch-Dest","value":"empty"},{"key":"Referer","value":"http://127.0.0.1:8080/cftr/incident/tab/23/edit/c2a76a82-0f65-41e6-a3df-e54585aa775a?parent=c28cda76-c9ef-474c-aae9-e8f0e2abbb6c&child=7991e25e-e8a6-44d4-bdb7-b3cc875e91a5"},{"key":"Accept-Language","value":"en-GB,en-US;q=0.9,en;q=0.8"},{"key":"Cookie","value":"csrftoken=JFqrb6Wg4oFSrxmOuRDSBDZhqI9UDiCqAsrxJx1eRMuln37SodJBdju95byJSFys"}],"body":{"mode":"raw","raw":"{\n \"description\": \"

Note For Incident

\",\n \"mentioned_users_usernames\": []\n}"},"url":"{{base_url}}v1/comments/incident/:incident_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Add notes to an Incident in the CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
description	String	Mandatory	Enter the content of the comment.
mentioned_users_usernames	List of UUID	Optional	Enter the list of usernames of users mentioned in the comment.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
unique_id	String	Unique ID of the comment.
description	Text	Content of the comment.
created_by	Object	Details of the user who added the comment.
modified_by	Object	Details of the user who last updated the comment.
mentioned_users	List of UUID	List of `user_id` of users mentioned in the comment.
mentioned_users_data	List of Objects	Details of the users mentioned in the comment.
created	String	Comment creation time.
modified	String	Comment last updated time.
comment_type	String	Type of Comment. Examples: `discussion`: Notes added in any instance. `handoff`: Handoff notes added while updating the assignee or assigned group. `closure`: Closure Notes added while closing an incident.
content_object	String	Component in which the comment is added. Example: `incident`, `action`, `ioc`, and so on.
content_object_readable_id	String	`readable_id` of the instance in which comment is added
content_object_unique_id	String	`unique_id` of the instance in which comment is added
description_with_img_src	Text	Content of the content with the image URLs (if any image is added in the comment).

","urlObject":{"path":["comments","incident",":incident_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the incident in which the comment to be added.

\n","type":"text/plain"},"type":"any","value":"c2a76a82-0f65-41e6-a3df-e54585aa775a","key":"incident_unique_id"}]}},"response":[{"id":"946d2fdd-ef3a-4c46-8ef1-eaaf92163302","name":"Add Comment in Incident","originalRequest":{"method":"POST","header":[{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache"},{"key":"sec-ch-ua","value":"\" Not;A Brand\";v=\"99\", \"Google Chrome\";v=\"97\", \"Chromium\";v=\"97\""},{"key":"sec-ch-ua-mobile","value":"?0"},{"key":"Authorization","value":"CYW 3bQlSm2T0T22hYiBqRtkX7YRQd0HzQGRHdOvs2xPjXUzQCGZxSh49JkogkK+LRH5Mr+TnZ/qiRqScjI5ke34B+6H8iG/m6sE9gHeyS1uXqdxLr92VIVVbL/KT6+lLz9Vn5ale6OZ34r4xdRKrpCQtaMkfTCvzZHNQFga1OHHdSi42tOjTazG/HANDhTkJV2fkJgxpm8wdVOHa8VQSx//tZV3jSYH4l4fEBIoqPZLLL6ya1NDFolZ7qzT2+ZtztQm"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json, text/plain, */*"},{"key":"User-Agent","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/97.0.4692.99 Safari/537.36"},{"key":"cyw-api-key","value":"7d13a88e-3178-4b28-ae6e-91b627f85bcf"},{"key":"If-Modified-Since","value":"0"},{"key":"sec-ch-ua-platform","value":"\"macOS\""},{"key":"Origin","value":"http://127.0.0.1:8080"},{"key":"Sec-Fetch-Site","value":"same-origin"},{"key":"Sec-Fetch-Mode","value":"cors"},{"key":"Sec-Fetch-Dest","value":"empty"},{"key":"Referer","value":"http://127.0.0.1:8080/cftr/incident/tab/23/edit/c2a76a82-0f65-41e6-a3df-e54585aa775a?parent=c28cda76-c9ef-474c-aae9-e8f0e2abbb6c&child=7991e25e-e8a6-44d4-bdb7-b3cc875e91a5"},{"key":"Accept-Language","value":"en-GB,en-US;q=0.9,en;q=0.8"},{"key":"Cookie","value":"csrftoken=JFqrb6Wg4oFSrxmOuRDSBDZhqI9UDiCqAsrxJx1eRMuln37SodJBdju95byJSFys"}],"body":{"mode":"raw","raw":"{\n \"description\": \"

Note For Incident

\",\n \"mentioned_users_usernames\": []\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/comments/incident/c2a76a82-0f65-41e6-a3df-e54585aa775a/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["comments","incident","c2a76a82-0f65-41e6-a3df-e54585aa775a",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Tue, 25 Jan 2022 16:17:54 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"859","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Access-Control-Allow-Origin","value":"http://127.0.0.1:8080","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"unique_id\": \"b6d2e7f2-7f07-4990-bebd-105cb8ce7bc6\",\n \"description\": \"

Note For Incident

\",\n \"created_by\": {\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"display_pic\": null,\n \"username\": \"peter\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"Peter Smith\"\n },\n \"modified_by\": null,\n \"is_removed\": false,\n \"mentioned_users\": [],\n \"mentioned_users_data\": [],\n \"created\": \"2022-01-25T16:17:53.840318Z\",\n \"modified\": \"2022-01-25T16:17:53.865103Z\",\n \"email\": null,\n \"internal\": false,\n \"comment_type\": \"discussion\",\n \"command_params\": {},\n \"command_result\": {},\n \"command_status\": \"na\",\n \"attachments_data\": [],\n \"content_object\": \"incident\",\n \"content_object_readable_id\": \"INC591\",\n \"content_object_unique_id\": \"c2a76a82-0f65-41e6-a3df-e54585aa775a\",\n \"attachment_label\": null,\n \"description_with_img_src\": \"

Note For Incident

\"\n}"}],"_postman_id":"c489a599-259d-491a-9b93-c2ceaa697a4d"},{"name":"Upload a File","id":"a6d3bea2-8546-4514-babb-67b8eb0a4b83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"uploaded_file","type":"file","src":"/Users/aashijain/Downloads/ZiClJf-1920w.jpeg"},{"key":"file_type","value":"artifact","type":"text"}]},"url":"{{base_url}}v1/utils/file/incident/:incident_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Upload any type of file in the incident.

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
uploaded_file	File	Mandatory	Enter the file to be uploaded.
file_type	String	Optional	Enter the type of File. Allowed values: `artifact`: Artifact `evidence`: Evidence `miscellaneous`: Miscellaneous Default value: `artifact`.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
title	Text	Name of the file.
uploaded_file	URL	URL of the file from where it can be downloaded.
unique_id	String	Unique ID for the file.
created_by_data	Object	Details of the user who uploaded the file.
created	Datetime	File upload time.
modified	Datetime	File modified time.
readable_id	String	Unique readable ID of the file.
file_hash	String	Hash of the file.
file_type	String	Type of the file. I Allowed values: `artifact`: Artifact `evidence`: Evidence `miscellaneous`: Miscellaneous
file_size	Integer	Size of the file.
parent_readable_id	String	`readable_id` of the incident in which file is uploaded.
parent_component	String	Component name in which file is uploaded. Example: `incident`, `action`, and so on.
parent_unique_id	String	`unique_id` of the incident in which file is uploaded

","urlObject":{"path":["utils","file","incident",":incident_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the incident in which the file is to be uploaded.

\n","type":"text/plain"},"type":"any","value":"c2a76a82-0f65-41e6-a3df-e54585aa775a","key":"incident_unique_id"}]}},"response":[{"id":"66475087-b858-4ad2-b041-374d121fdf50","name":"Upload a File","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"uploaded_file","type":"file","src":"/Users/aashijain/Downloads/ZiClJf-1920w.jpeg"},{"key":"file_type","value":"artifact","type":"text"}]},"url":{"raw":"{{base_url}}v1/utils/file/incident/c2a76a82-0f65-41e6-a3df-e54585aa775a/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["utils","file","incident","c2a76a82-0f65-41e6-a3df-e54585aa775a",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Thu, 27 Jan 2022 10:39:27 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"917","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"ZiClJf-1920w.jpeg\",\n \"description\": null,\n \"uploaded_file\": \"http://host.docker.internal:51620/ciims-dev-1/ciims-data/e9dd252b-ZiClJf-1920w.jpeg?AWSAccessKeyId=minio&Signature=5qIYPb2A3C5%2Bk2yV9SA%2BhRh%2Bb%2B4%3D&Expires=1643280081\",\n \"unique_id\": \"7650762c-0bac-4340-bc35-849009981a93\",\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"full_name\": \"Jane Doe\"\n },\n \"created\": \"2022-01-27T10:39:15.414393Z\",\n \"modified\": \"2022-01-27T10:39:16.292886Z\",\n \"readable_id\": \"ART119\",\n \"is_removed\": false,\n \"readable_id_counter\": 119,\n \"file_hash\": \"bac137d6fd8aded1d0fa8f1d909ffc24\",\n \"file_type\": \"artifact\",\n \"file_size\": 414164,\n \"can_delete\": true,\n \"parent_readable_id\": \"INC591\",\n \"parent_component\": \"incident\",\n \"parent_unique_id\": \"c2a76a82-0f65-41e6-a3df-e54585aa775a\"\n}"}],"_postman_id":"a6d3bea2-8546-4514-babb-67b8eb0a4b83"},{"name":"Recommended Users for Incidents","event":[{"listen":"prerequest","script":{"id":"64a3dfe4-933a-4e40-aad7-47c424e2202c","exec":["var accessid = pm.environment.get(\"open_api_access_id\");","var secret_key = pm.environment.get(\"open_api_secret_key\");","/*"," -generating epochtime"," -epochtime is being send in expires parameter of params"," -sign is generated and then passed for generating signature","*/","pm.environment.set(\"unixtimestamp\",Math.round(Date.now()/1000));","var expires = pm.environment.get(\"unixtimestamp\")+15;","pm.environment.set('UTC Timezone', new Date().toISOString());","pm.environment.set(\"expires\", expires);","var to_sign = accessid+\"\\n\"+expires;","/*","Generate Signature for Authentication"," -Key based hashing is done using HMAC-SHA1 Algorithm"," -This is then converted into base64"," -Finally the generated signature is URL Encoded so as to make all the special characters URL Safe","*/","var hash = CryptoJS.HmacSHA1(to_sign, secret_key);","var hashInBase64 = encodeURIComponent(CryptoJS.enc.Base64.stringify(hash));","pm.environment.set(\"signature\",hashInBase64);","","","","","","","","","",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"aba38f82-6c5a-4284-9ee2-a81d68a6ca24","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/incident/:incident_unique_id/recommended-users/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&allocation_datetime=1738882648","description":"

Retrieve a list of all recommended users for incidents based on the roster.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
results	List of Objects	Returns the recommended users list. Each object provides details of one user.

Response Parameters | Results Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
user_name	String	Returns the user name.
first_name	String	Returns the first name of the user.
last_name	String	Returns the last name of the user.
profile_background_color	String	Returns the hex key of the background color of the user profile.
user_id	String	Returns the unique ID of the user.
display_pic	String	Return the link to the display picture of the user.
email	String	Returns the email ID of the user.
score	Integer	Returns the ML score.

","urlObject":{"path":["incident",":incident_unique_id","recommended-users",""],"host":["{{base_url}}v1"],"query":[{"disabled":true,"description":{"content":"

[optional] Enter the page number of the incident list. This will retrieve the list of all Incidents from the entered page.

Default value: 1

\n","type":"text/plain"},"key":"page","value":"2"},{"disabled":true,"description":{"content":"

[optional] Enter number of incidents per page.\nDefault value: 10

\n","type":"text/plain"},"key":"page_size","value":"4"},{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"allocation_datetime","value":"1738882648"}],"variable":[{"description":{"content":"

Enter the unique ID of an incident to retrieve recommended users. You can retrieve unique IDs of incidents using the Get List of Incidents endpoint.

\n","type":"text/plain"},"type":"any","value":"67df3f62-b454-4e0e-bd8f-e7b826ea69cc","key":"incident_unique_id"}]}},"response":[{"id":"4fe68c73-26ee-4fdd-a1a4-3543c7150427","name":"Recommended Users for Incidents","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/incident/:incident_unique_id/recommended-users/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&allocation_datetime=1738882648","host":["{{base_url}}v1"],"path":["incident",":incident_unique_id","recommended-users",""],"query":[{"key":"status","value":"open","description":"[optional] Enter the status of the incidents.\nAllowed values:\n• open\n• closed\n• untriaged\n• merged\nExample: “open”","disabled":true},{"key":"modified_date__gte","value":"1643283426","description":"[optional] Enter the last modified time of the incidents in EPOCH Time format.\nTime Zone must be as per UTC. All Incidents with modified date later than the entered time will be returned.","disabled":true},{"key":"modified_date__lte","value":"1643283426","description":"[optional] Enter the last modified time of the incidents in EPOCH Time format.\nTime Zone must be as per UTC. All Incidents with modified date earlier than the entered time will be returned.","disabled":true},{"key":"created_date__gte","value":"1643283426","description":"[optional] Enter the creation time of the incidents in EPOCH Time format.\nTime Zone must be as per UTC. All Incidents with creation date later than the entered time will be returned.","disabled":true},{"key":"created_date__lte","value":"1643283426","description":"[optional] Enter the creation time of the incidents in EPOCH Time format.\nTime Zone must be as per UTC. All Incidents with creation date earlier than the entered time will be returned.","disabled":true},{"key":"page","value":"2","description":"[optional] Enter the page number of the incident list. This will retrieve the list of all Incidents from the entered page.\n\nDefault value: 1","disabled":true},{"key":"page_size","value":"4","description":"[optional] Enter number of incidents per page.\nDefault value: 10","disabled":true},{"key":"business_units","value":"9750d6df-2d7f-4899-b20d-bfbba0a9084d","description":"[optional] Enter the unique ID or title of the business unit. This parameter retrieves the incidents associated with the business unit.\n\nYou can retrieve the list of available Business Units with their Unique ID and title using the following API endpoint:\n\n`/openapi/v1/utils/business-unit/`","disabled":true},{"key":"level","value":"9e44ab13-64e5-43ad-a8d1-e1d181681090","description":"[optional] Enter the unique ID or title of the severity level of the incidents. This parameter retrieves the incidents by severity level.","disabled":true},{"key":"phase","value":"a5e04da7-61fb-4436-a11a-ab219eaeb296","description":"[optional] Enter the unique ID or title of a phase. This parameter retrieves the incidents by the entered phase of incidents. ","disabled":true},{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"allocation_datetime","value":"1738882648"}],"variable":[{"key":"incident_unique_id","value":"517d501f-a2bc-4210-9e43-e9b941d1d482"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 06 Feb 2025 07:33:24 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET","enabled":true},{"key":"Vary","value":"origin, Cookie","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: http: data: blob:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"username\": \"john\",\n \"first_name\": \"john\",\n \"last_name\": \"doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"d922272e-0511-455e-bf79-332cdf856d83\",\n \"display_pic\": \"https://3450.cftr.spotio.cywaredev.com/cftr/file-server/download/image.png?file_key=file-server-d922272e-0511-455e-bf79-332cdf856d83&show_preview=True\",\n \"email\": \"john.doe@gmail.com\",\n \"score\": 0\n }\n ]\n}"}],"_postman_id":"aba38f82-6c5a-4284-9ee2-a81d68a6ca24"},{"name":"List Incident Comments (Advanced)","event":[{"listen":"prerequest","script":{"id":"d735bb98-6ac3-451a-8793-ec4fb0a8806f","exec":["var accessid = pm.environment.get(\"open_api_access_id\");","var secret_key = pm.environment.get(\"open_api_secret_key\");","/*"," -generating epochtime"," -epochtime is being send in expires parameter of params"," -sign is generated and then passed for generating signature","*/","pm.environment.set(\"unixtimestamp\",Math.round(Date.now()/1000));","var expires = pm.environment.get(\"unixtimestamp\")+15;","pm.environment.set('UTC Timezone', new Date().toISOString());","pm.environment.set(\"expires\", expires);","var to_sign = accessid+\"\\n\"+expires;","/*","Generate Signature for Authentication"," -Key based hashing is done using HMAC-SHA1 Algorithm"," -This is then converted into base64"," -Finally the generated signature is URL Encoded so as to make all the special characters URL Safe","*/","var hash = CryptoJS.HmacSHA1(to_sign, secret_key);","var hashInBase64 = encodeURIComponent(CryptoJS.enc.Base64.stringify(hash));","pm.environment.set(\"signature\",hashInBase64);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"c5416410-f3b4-43a8-ba96-32488ea55817","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{base_url}}v1/comments/qb/extended/incident/:component_readable_or_unique_object_id/?AccessID={{open_api_access_id}}&Signature={{signature}}&Expires={{expires}}","description":"

Retrieve a list of comments for an incident by providing either its readable ID or unique ID.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
count	Integer	Number of comments added in an incident.
unique_id	String	Unique ID of the comment.
description	Text	Description of the comment.
created_by	Object	Details of the user who added the comment. Details include user id, first_name,
modified_by	Object	Details of the user who last updated the comment.
mentioned_users	List of UUID	List of `user_id` of users mentioned in the comment.
mentioned_users_data	List of Objects	Details of the users mentioned in the comment.
created	Datetime	Comment creation time in EPOCH time format.
modified	Datetime	Comment last updated time in EPOCH time format.
comment_type	String	Type of Comment. Examples: `discussion`: Notes added in an incident. `handoff`: Handoff notes added while updating the assignee or assigned group. `closure`: Closure Notes added while closing an incident.
content_object	String	Component in which the comment is added. Example: `incident`, `action`, `ioc`, and so on.
content_object_readable_id	String	`readable_id` of the incident in which comment is added
content_object_unique_id	String	`unique_id` of the incident in which comment is added
description_with_img_src	Text	Content of the content with the image URLs (if any image is added in the comment).
Pinned	Boolean	Shows if the comment is pinned or not.

","urlObject":{"path":["comments","qb","extended","incident",":component_readable_or_unique_object_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Signature","value":"{{signature}}"},{"key":"Expires","value":"{{expires}}"}],"variable":[{"description":{"content":"

Pass the unique_id or readable_id of the incident to retrieve comments.

\n","type":"text/plain"},"type":"any","value":"INC178","key":"component_readable_or_unique_object_id"}]}},"response":[{"id":"13f6ac5e-2605-4f34-b5a0-ad3cf3bd4614","name":"List Incident Comments","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/comments/qb/extended/incident/7002b4c6-ef09-41b8-a3b4-f19bb64aefd0/?AccessID={{open_api_access_id}}&Signature={{signature}}&Expires={{expires}}","host":["{{base_url}}v1"],"path":["comments","qb","extended","incident","7002b4c6-ef09-41b8-a3b4-f19bb64aefd0",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Signature","value":"{{signature}}"},{"key":"Expires","value":"{{expires}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Wed, 18 Feb 2026 06:13:16 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET"},{"key":"Vary","value":"origin, Cookie"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"Content-Security-Policy","value":"img-src https: http: data: blob:;"},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 1,\n \"results\": [\n {\n \"unique_id\": \"ffce583c-7cfe-44bf-b004-3e18c221137f\",\n \"description\": \"

n n

\",\n \"created_by\": {\n \"user_id\": \"92b31347-b184-442c-adcf-b43f04d2e496\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"email\": \"system@default.tld\",\n \"display_pic\": \"https://3479.cftr.spotio.cywaredev.com/cftr/file-server/download/image.png?file_key=file-server-92b31347-b184-442c-adcf-b43f04d2e496&show_preview=True\",\n \"username\": \"system.default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"System Default\"\n },\n \"modified_by\": null,\n \"is_removed\": false,\n \"mentioned_users\": [],\n \"mentioned_users_data\": [],\n \"created\": \"2026-02-16T05:50:20.555655Z\",\n \"modified\": \"2026-02-16T05:50:20.574710Z\",\n \"email\": null,\n \"internal\": false,\n \"comment_type\": \"closure\",\n \"command_params\": {},\n \"command_result\": {},\n \"command_status\": \"na\",\n \"attachments_data\": [],\n \"content_object\": \"incident\",\n \"content_object_readable_id\": \"INC188\",\n \"content_object_unique_id\": \"7002b4c6-ef09-41b8-a3b4-f19bb64aefd0\",\n \"attachment_label\": null,\n \"description_with_img_src\": \"

n n

\",\n \"pinned\": false,\n \"field\": null,\n \"note_tag\": null,\n \"ir_source\": null,\n \"ir_org_id\": null,\n \"ir_user_id\": null\n }\n ]\n}"}],"_postman_id":"c5416410-f3b4-43a8-ba96-32488ea55817"},{"name":"Comments from Incident","id":"6326d518-38c6-4e7e-a7d2-a702ab501d17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/comments/incident/:incident_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve a list of comments from an incident.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
count	Integer	Number of comments added in an incident.
unique_id	String	Unique ID of the comment.
description	Text	Content of the comment.
created_by	Object	Details of the user who added the comment.
modified_by	Object	Details of the user who last updated the comment.
mentioned_users	List of UUID	List of `user_id` of users mentioned in the comment.
mentioned_users_data	List of Objects	Details of the users mentioned in the comment.
created	Datetime	Comment creation time in EPOCH time format.
modified	Datetime	Comment last updated time in EPOCH time format.
comment_type	String	Type of Comment. Examples: `discussion`: Notes added in an incident. `handoff`: Handoff notes added while updating the assignee or assigned group. `closure`: Closure Notes added while closing an incident.
content_object	String	Component in which the comment is added. Example: `incident`, `action`, `ioc`, and so on.
content_object_readable_id	String	`readable_id` of the incident in which comment is added
content_object_unique_id	String	`unique_id` of the incident in which comment is added
description_with_img_src	Text	Content of the content with the image URLs (if any image is added in the comment).
Pinned	Boolean	Shows if the comment is pinned or not.

[Optional] Enter the group_comm_id of a user group to get all comments added by the users of the user group in an incident.

\n","type":"text/plain"},"key":"user_group","value":"f8238640-e36a-4d1c-bef2-ef6658c69d3e"},{"disabled":true,"description":{"content":"

[Optional] Enter the type of comment. \nAllowed values:\ndiscussion\nhandoff\nclosure

\n","type":"text/plain"},"key":"type","value":"handoff"},{"disabled":true,"description":{"content":"

[Optional] Enter the unique_id of a user to get the comments added by the user.

\n","type":"text/plain"},"key":"created_by","value":"87e5291f-495a-4e52-8777-1e71e3ad1e86"}],"variable":[{"description":{"content":"

Enter the unique_id of an incident.

\n","type":"text/plain"},"type":"any","value":"12c02553-62ee-47cb-9b11-a1ae0c724d63","key":"incident_unique_id"}]}},"response":[{"id":"82d13ebe-ebc1-45a0-b594-172c7a1f175f","name":"Get Comments from Incident","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/comments/incident/:incident_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["comments","incident",":incident_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"user_group","value":"f8238640-e36a-4d1c-bef2-ef6658c69d3e","description":"Enter the `group_comm_id` of User Group to get all comments created by the group members.","disabled":true},{"key":"type","value":"handoff","description":"Enter the type of comment. Allowed values:\ncommand\ndiscussion\nhandoff\nclosure","disabled":true},{"key":"created_by","value":"5c4fbd5d-78da-4a4c-93b2-f3a89e269b53","description":"Enter the `unique_id` of User to get the comments created by a user.","disabled":true}],"variable":[{"key":"incident_unique_id","value":"75dfa348-e67d-4bb0-a5c2-9f953c5e2867","description":"Enter the unique_id of Incident"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 25 Apr 2023 05:26:38 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 3,\n \"results\": [\n {\n \"unique_id\": \"431080d0-631b-45e3-9463-bfa23aafbcc8\",\n \"description\": \"

Affected users reported that their browser suddenly slowed down.

\",\n \"created_by\": {\n \"user_id\": \"b2fb8caf-1073-44b3-937d-ab4eba8af7c5\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@cyware.com\",\n \"display_pic\": null,\n \"username\": \"john.doe\",\n \"profile_background_color\": \"#A0887E\",\n \"is_active\": true,\n \"full_name\": \"John Doe\"\n },\n \"modified_by\": null,\n \"is_removed\": false,\n \"mentioned_users\": [],\n \"mentioned_users_data\": [],\n \"created\": \"2023-04-24T06:55:47.373090Z\",\n \"modified\": \"2023-04-24T06:55:47.419182Z\",\n \"email\": null,\n \"internal\": false,\n \"comment_type\": \"discussion\",\n \"command_params\": {},\n \"command_result\": {},\n \"command_status\": \"na\",\n \"attachments_data\": [],\n \"content_object\": \"incident\",\n \"content_object_readable_id\": \"INC244573\",\n \"content_object_unique_id\": \"75dfa348-e67d-4bb0-a5c2-9f953c5e2867\",\n \"attachment_label\": null,\n \"description_with_img_src\": \"

Affected users reported that their browser suddenly slowed down.

\",\n \"pinned\": false,\n \"field\": null,\n \"note_tag\": null\n },\n {\n \"unique_id\": \"b08feb0d-556a-4e35-b62c-b314a5cb6c75\",\n \"description\": \"

This attachment is an evidence of the incident.

\",\n \"created_by\": {\n \"user_id\": \"b2fb8caf-1073-44b3-937d-ab4eba8af7c5\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@cyware.com\",\n \"display_pic\": null,\n \"username\": \"john.doe\",\n \"profile_background_color\": \"#A0887E\",\n \"is_active\": true,\n \"full_name\": \"John Doe\"\n },\n \"modified_by\": null,\n \"is_removed\": false,\n \"mentioned_users\": [],\n \"mentioned_users_data\": [],\n \"created\": \"2023-04-24T06:52:47.900428Z\",\n \"modified\": \"2023-04-24T06:52:47.909502Z\",\n \"email\": null,\n \"internal\": false,\n \"comment_type\": \"discussion\",\n \"command_params\": {},\n \"command_result\": {},\n \"command_status\": \"na\",\n \"attachments_data\": [],\n \"content_object\": \"file\",\n \"content_object_readable_id\": \"ART4221\",\n \"content_object_unique_id\": \"30d8d1a6-6770-46a3-a9b2-986a5e900caa\",\n \"attachment_label\": \"Incident\",\n \"description_with_img_src\": \"

This attachment is an evidence of the incident.

\",\n \"pinned\": false,\n \"field\": null,\n \"note_tag\": null\n },\n {\n \"unique_id\": \"7248bd09-9a57-4825-925a-caca10304e72\",\n \"description\": \"Start analyzing this incident.\",\n \"created_by\": {\n \"user_id\": \"b2fb8caf-1073-44b3-937d-ab4eba8af7c5\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@cyware.com\",\n \"display_pic\": null,\n \"username\": \"john.doe\",\n \"profile_background_color\": \"#A0887E\",\n \"is_active\": true,\n \"full_name\": \"John Doe\"\n },\n \"modified_by\": null,\n \"is_removed\": false,\n \"mentioned_users\": [],\n \"mentioned_users_data\": [],\n \"created\": \"2023-04-24T06:51:18.151290Z\",\n \"modified\": \"2023-04-24T06:51:18.205861Z\",\n \"email\": null,\n \"internal\": false,\n \"comment_type\": \"handoff\",\n \"command_params\": {},\n \"command_result\": {},\n \"command_status\": \"na\",\n \"attachments_data\": [],\n \"content_object\": \"incident\",\n \"content_object_readable_id\": \"INC244573\",\n \"content_object_unique_id\": \"75dfa348-e67d-4bb0-a5c2-9f953c5e2867\",\n \"attachment_label\": null,\n \"description_with_img_src\": \"Start analyzing this incident.\",\n \"pinned\": false,\n \"field\": null,\n \"note_tag\": null\n }\n ]\n}"}],"_postman_id":"6326d518-38c6-4e7e-a7d2-a702ab501d17"},{"name":"Time Tracking Details","id":"53bdc655-c451-40a2-9da2-27ed18e4a621","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/incident/ownership-collapse/:incident_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&collapse_key=phase","description":"

Retrieves time tracking details of an incident.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`result`	Array of Objects	Time tracking details of an incident. Each object provides the time tracking details of the incident based on the selected filter.

Response Parameters | Results Objects

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`user_data`	Array	Details of the users who are assigned to the incident. Details include: `username`, `user_id`, `email`, and more.
`group_data`	Array	Details of the user group assigned to the incident. Details include: `group_comm_id` and `group_name`.
`Phase_data`	Array	Details of the phase of the incident. Details include: `unique_id`, `option_name`, `is_active`, and more.
`incident_status_data`	Array	Details of the incident status. Details include: `unique_id`, `option_name`, and `is_removed`.
`incident_status`	Array of Strings	Unique identifier of the incident statuses. For example, 76461a6f-ded2-41fe-9b27-dbaf8fc72e86
`duration`	Object	Duration of the incident based on the filter applied. For example, if you select phase, then the total time taken will include the duration of time spent on incident phases. It displays the number of days, hours, minutes, and seconds of the incident. Note: This includes the time duration from the incident creation.
`phase_uid`	List of UUIDs	List of unique identifier of the incident phases in the UUID format.
`user_uid`	List of UUIDs	List of unique identifier of the users assigned to the incident in the UUID format.
`total_duration`	Object	Total time duration taken for incident response. It displays the number of days, hours, minutes, and seconds of the incident.

","urlObject":{"path":["incident","ownership-collapse",":incident_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"description":{"content":"

Mention the filter you want to apply for time tracking of an incident.\nAllowed values:\nuser,\nphase,\ngroup,\nstatus

\n","type":"text/plain"},"key":"collapse_key","value":"phase"}],"variable":[{"description":{"content":"

Enter the unique ID of the incident of which you want to retrieve time tracking details.

\n","type":"text/plain"},"type":"any","value":"4387a051-0869-4d7f-91ba-e5be47a75c60","key":"incident_unique_id"}]}},"response":[{"id":"dd9fbc42-06ec-4d18-a804-677490ea43ba","name":"Retrieve Time Tracking Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/incident/ownership-collapse/:incident_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&collapse_key=user","host":["{{base_url}}v1"],"path":["incident","ownership-collapse",":incident_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"collapse_key","value":"user","description":"Mention the filter you want to apply for time tracking of an incident.\nAllowed values:\nuser\nphase\ngroup\nstatus"}],"variable":[{"key":"incident_unique_id","value":"4387a051-0869-4d7f-91ba-e5be47a75c60","description":"Enter the unique ID of the incident of which you want to retrieve time tracking details."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 19 Jul 2024 12:30:02 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin, Cookie","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: http: data: blob:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"user_data\": [\n {\n \"username\": \"john.doe\",\n \"first_name\": \"john\",\n \"last_name\": \"doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"c2d98859-b766-4415-bfd4-b283e975ae90\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"john.doe@myorg.com\",\n \"full_name\": \"john.doe\"\n }\n ],\n \"group_data\": [\n {\n \"group_comm_id\": \"e649dbda-bafd-4dae-8a30-2f03f6d2a2b6\",\n \"group_name\": \"Respond Admin\"\n }\n ],\n \"phase_data\": [\n {\n \"unique_id\": \"f6a34ae0-2c77-4d8d-996f-2f41a6d8b544\",\n \"option_name\": \"Detection Analysis\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"b7c319cf-e6ef-4e11-a89e-8c7dc61822cd\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n }\n ],\n \"incident_status_data\": [\n {\n \"unique_id\": \"7a9ad233-b1e5-4651-a726-9631aaef2b02\",\n \"option_name\": \"Open\",\n \"is_removed\": false\n }\n ],\n \"incident_status\": [\n \"7a9ad233-b1e5-4651-a726-9631aaef2b02\"\n ],\n \"time_months\": 0,\n \"time_days\": 0,\n \"time_hours\": 0,\n \"time_minutes\": 0,\n \"duration\": {\n \"days\": 0,\n \"hours\": 2,\n \"minutes\": 0,\n \"seconds\": 30\n },\n \"group_uid\": [\n \"d0cffcbd-3f79-44c4-ac2c-ce893666eb5c\"\n ],\n \"phase_uid\": [\n \"199002b8-2103-4472-bac6-8fc590b4acf5\"\n ]\n },\n {\n \"user_data\": [\n {}\n ],\n \"group_data\": [\n {\n \"group_comm_id\": \"e649dbda-bafd-4dae-8a30-2f03f6d2a2b6\",\n \"group_name\": \"CFTR Admin\"\n }\n ],\n \"phase_data\": [\n {\n \"unique_id\": \"f6a34ae0-2c77-4d8d-996f-2f41a6d8b544\",\n \"option_name\": \"Detection Analysis\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"b7c319cf-e6ef-4e11-a89e-8c7dc61822cd\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null,\n \"extra_params\": {}\n }\n ],\n \"incident_status_data\": [\n {\n \"unique_id\": \"d7dc4e92-a243-42df-83f6-b4b0eada0162\",\n \"option_name\": \"Untriaged\",\n \"is_removed\": false\n },\n {\n \"unique_id\": \"7a9ad233-b1e5-4651-a726-9631aaef2b02\",\n \"option_name\": \"Open\",\n \"is_removed\": false\n }\n ],\n \"incident_status\": [\n \"d7dc4e92-a243-42df-83f6-b4b0eada0162\",\n \"7a9ad233-b1e5-4651-a726-9631aaef2b02\"\n ],\n \"time_months\": 0,\n \"time_days\": 0,\n \"time_hours\": 0,\n \"time_minutes\": 0,\n \"duration\": {\n \"days\": 0,\n \"hours\": 20,\n \"minutes\": 8,\n \"seconds\": 8\n },\n \"group_uid\": [\n \"d0cffcbd-3f79-44c4-ac2c-ce893666eb5c\",\n \"e0cftcbd-3j89-33n4-nc5c-ce893996eb8y\"\n ],\n \"phase_uid\": [\n \"699502b8-2103-4472-bac6-8fc590b4acf9\",\n \"199802b8-2103-4472-bac6-8fc590b4acf5\"\n ]\n }\n ],\n \"total_duration\": {\n \"days\": 0,\n \"hours\": 22,\n \"minutes\": 7,\n \"seconds\": 50\n }\n}"}],"_postman_id":"53bdc655-c451-40a2-9da2-27ed18e4a621"}],"id":"a9af1503-6039-485c-8b9d-cd4d2ce91e20","description":"

An Incident is an event that indicates a warning that there may be a threat to the organizational systems, security, confidentiality, integrity, assets, network services, or data. An Incident could also mean that the threat has already been successfully executed despite protective measures put in place for prevention.

This section describes how to use the API endpoints to manage incidents in the CFTR application.

\n","_postman_id":"a9af1503-6039-485c-8b9d-cd4d2ce91e20"},{"name":"Connect the Dots","item":[{"name":"Connect Modules","id":"dc0624a0-e842-4903-989c-1e711eb9e2c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"incident\": [\n \"1d9509c9-501b-4261-ba85-a9690acc5100\",\n \"49b46c68-b10d-41fd-82e7-1681fd8b7787\"\n ],\n \"vulnerability\": [\n \"b4afd23b-a13f-4a4a-bacb-99e6aa465d42\",\n \"eda602cc-4118-48b7-9394-e2bf954c7135\"\n ],\n \"ioc_ip\": [\n \"25f952cf-ff04-43b0-99a6-4ddbd67ba744\",\n \"ecb6a7fb-cb8a-4d56-ad62-96e24412d9a1\"\n ],\n \"ioc_domain\": [\n \"1c2761b0-9bda-48d1-81d5-45b69eb04138\"\n ],\n \"ioc_email\": [\"38670dbc-cd59-4461-bcbe-610fad10b49c\"],\n \"ioc_SHA256\": [\"81e3a43b-c9b8-4027-81c2-6586ce1450e5\"],\n \"device\": [\n \"ccb5c6bf-32b8-4a2f-94e8-6dcdfcd532e1\"\n ],\n \"campaign\": [\n \"5fe20073-ded5-462e-88c8-23f64ea9a662\"\n ],\n \"enhancement\": [\"648a0746-52f6-4e0c-a35b-9ae76cf78335\"],\n \"malware\": [\"7940e65d-7336-4fbd-b3e4-addbd6d70958\"],\n \"action\": [\"983a8175-e3a1-4fe1-8536-537bdc7cce82\", \"660ca3a8-5f67-4959-b4ac-94750104e614\"],\n \"pir\": [\"09ce52b9-e761-4078-aa11-d60f72f5b9da\"],\n \"general-user\": [\"c367f9ff-5120-4789-8a75-771d3ca299a8\"],\n \"asset-software\": [\"9c3000ae-0992-4c35-bc4d-aad049999796\"],\n \"module1\": [\n \"063f8125-d1a4-45c7-a38f-e6092e79ee42\",\n \"7873646b-d781-4bfc-9d45-71f99a3a1b3c\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/connect-the-dots/link-components/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Connect modules to reflect in Connect the Dots of each module. You can also connect custom modules to an incident.

Request Parameters

Parameter	Type	Value
`incident`	List	Enter a list of UUIDs of incidents. Note: Incidents will not be connected with each other as related incidents.
`vulnerability`	List	Enter a list of UUIDs of vulnerabilities.
`ioc_ip`	List	Enter a list of UUIDs of IP addresses.
`ioc_domain`	List	Enter a list of UUIDs of domains.
`ioc_url`	List	Enter a list of UUIDs of URLs.
`ioc_email`	List	Enter a list of UUIDs of emails.
`ioc_MD5`	List	Enter a list of UUIDs of MD5 IOCs.
`ioc_SHA1`	List	Enter a list of UUIDs of SHA1 IOCs.
`ioc_SHA256`	List	Enter a list of UUIDs of SHA256 IOCs.
`device`	List	Enter a list of UUIDs of devices.
`campaign`	List	Enter a list of UUIDs of campaigns.
`enhancement`	List	Enter a list of UUIDs of enhancements.
`malware`	List	Enter a list of UUIDs of malware.
`threat-actor`	List	Enter a list of UUIDs of threat actors.
`threat-briefing`	List	Enter a list of UUIDs of threat briefings.
`pir`	List	Enter a list of UUIDs of PIRs.
`general-user`	List	Enter a list of UUIDs of users.
`asset-software`	List	Enter a list of UUIDs of software.
`component_identifier`	List	Enter a list of UUIDs of the custom module entries. `component_identifier` of custom modules For example, \"module1\", \"module2\" etc... You can retrieve the component identifier of a custom module using the following endpoint: `/openapi/v1/dynamic-model/` You can retrieve the UUIDs of the custom module entries using the following API endpoint: `/openapi/v1/dynamic-model/:component_identifier/`

Response Parameters

This API endpoint does not have any response parameter.

Status Codes

200 (Success): Modules are connected successfully.

400 (Bad Request): You have entered incorrect UUIDs.

\n","urlObject":{"path":["connect-the-dots","link-components",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"e16f7168-5ec7-4273-b38e-f72b2b7f1cab","name":"Connect Modules","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"incident\": [\n \"1d9509c9-501b-4261-ba85-a9690acc5100\",\n \"49b46c68-b10d-41fd-82e7-1681fd8b7787\"\n ],\n \"vulnerability\": [\n \"b4afd23b-a13f-4a4a-bacb-99e6aa465d42\",\n \"eda602cc-4118-48b7-9394-e2bf954c7135\"\n ],\n \"ioc_ip\": [\n \"25f952cf-ff04-43b0-99a6-4ddbd67ba744\",\n \"ecb6a7fb-cb8a-4d56-ad62-96e24412d9a1\"\n ],\n \"ioc_domain\": [\n \"1c2761b0-9bda-48d1-81d5-45b69eb04138\"\n ],\n \"ioc_email\": [\n \"38670dbc-cd59-4461-bcbe-610fad10b49c\"\n ],\n \"ioc_SHA256\": [\n \"81e3a43b-c9b8-4027-81c2-6586ce1450e5\"\n ],\n \"device\": [\n \"ccb5c6bf-32b8-4a2f-94e8-6dcdfcd532e1\"\n ],\n \"campaign\": [\n \"5fe20073-ded5-462e-88c8-23f64ea9a662\"\n ],\n \"enhancement\": [\n \"648a0746-52f6-4e0c-a35b-9ae76cf78335\"\n ],\n \"malware\": [\n \"7940e65d-7336-4fbd-b3e4-addbd6d70958\"\n ],\n \"action\": [\n \"983a8175-e3a1-4fe1-8536-537bdc7cce82\",\n \"660ca3a8-5f67-4959-b4ac-94750104e614\"\n ],\n \"pir\": [\n \"09ce52b9-e761-4078-aa11-d60f72f5b9da\"\n ],\n \"general-user\": [\n \"c367f9ff-5120-4789-8a75-771d3ca299a8\"\n ],\n \"asset-software\": [\n \"9c3000ae-0992-4c35-bc4d-aad049999796\"\n ],\n \"module1\": [\n \"8116aa8c-e9f0-40d1-88e2-022baf088ae3\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/connect-the-dots/link-components/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["connect-the-dots","link-components",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Wed, 26 Apr 2023 12:44:44 GMT","enabled":true},{"key":"Content-Length","value":"0","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"POST","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"dc0624a0-e842-4903-989c-1e711eb9e2c3"},{"name":"Advanced Connect Modules","id":"43ed643d-4522-4d98-81bc-8a0b41959f06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"append\": [\n {\n \"link_from\": {\n \"threat-actor\": \"6dc2fee1-26ef-4de3-b8dd-1c9725eeee3e\"\n },\n \"link_to\": {\n \"action\": [\n \"fc4ded27-5091-44b5-9bb8-f3447d026bfe\"\n ],\n \"application\": [\n \"f52459ba-e0e4-4774-8c7f-39f8c28044ca\"\n ],\n \"asset-software\": [\n \"ebccf03c-d08e-4eb0-9753-d69f72542348\"\n ],\n \"campaign\": [\n \"a065fb5c-fe57-4dd9-9118-b08374cf7684\"\n ],\n \"device\": [\n \"f0020716-af86-43dc-886a-844fd17d0e78\"\n ],\n \"enhancement\": [\n \"019a4492-e136-4a5a-bbdb-8402e9c6858e\"\n ],\n \"incident\": [\n \"077bc291-92d5-4a01-a08b-7a51320d3e72\"\n ],\n \"malware\": [\n \"71358205-f5e1-42a6-81c4-1dba7fc002f7\"\n ],\n \"threat-briefing\": [\n \"9e73990c-9854-44ed-9384-f510fee355d4\"\n ],\n \"vulnerability\": [\n \"5a4e1d91-cb89-49d3-8be2-85ffea15e7a5\"\n ],\n \"module-aesvfes3da-1\": [\n \"aa2e1d91-cb19-23d3-8ee2-85ffed25e7a5\"\n ]\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/connect-the-dots/advanced-link-components/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

This API allows linking between components or custom modules within the platform. You can either append new components or update existing ones.

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Value
`append`	Dict	Enter the Dict containing `link_from` and `link_to` of components and their UUIDs
`update`	Dict	Enter the Dict containing `link_from` and `link_to` of components and their UUIDs

Note: append and update are mutually exclusive. Endpoint expects at least one among them to be present in the payload

Append and Update Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Mandatory	Value
`link_from`	Dict	Required	Enter the `component_identifier` as key and UUID as value for the component for which you want to connect the dots. Note: `link_from` accepts only a single component identifier key.
`link_to`	List	Required	Enter a list of dictionaries, where each dictionary has a `component_type` as the key and a list of UUIDs as the value for the components to which the connection should be established. Note: `link_to` can contain multiple component `component_type`.

Update - Request Parameters

Some links are not supported in append and are allowed only in update, they are:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Link from Component Identifier	Link to Component Type
action	`incident`
application	`general-user-manager`, `general-user-owner`
device	`general-user-manager`, `general-user-owner`

Note:

In update, you can connect to only one target component of each type at a time, while in append, you can connect to multiple.
\n
component_type defines the “type” of the target component being connected.
\n

Allowed Component Links

The following table lists valid mappings between components and the component types they can link to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Link from Component Identifier	Link to Component Type
incident	action, application, asset-software, campaign, device, enhancement, general-user, knowledge-base, malware, pir, related_incident, threat-actor, threat-briefing, vulnerability, ioc_-(IOC Types of IOCs), module-(Component Identifier of Custom Modules)
campaign	action, enhancement, incident, malware, pir, threat-actor, threat-briefing, vulnerability, module-(Component Identifier of Custom Modules)
enhancement	application, campaign, incident, malware, threat-actor, threat-briefing, vulnerability, module-(Component Identifier of Custom Modules)
vulnerability	action, application, asset-software, campaign, device, enhancement, incident, malware, pir, threat-actor, threat-briefing, ioc_-(IOC Types of IOCs), module-(Component Identifier of Custom Modules)
threat-actor	action, application, asset-software, campaign, device, enhancement, incident, malware, threat-actor, threat-briefing, vulnerability, ioc_-(IOC Types of IOCs), module-(Component Identifier of Custom Modules)
malware	action, application, asset-software, campaign, device, enhancement, incident, pir, threat-actor, threat-briefing, vulnerability, ioc_-(IOC Types of IOCs), module-(Component Identifier of Custom Modules)
threat-briefing	action, application, asset-software, campaign, device, enhancement, general-user, incident, malware, pir, threat-actor, vulnerability, module-(Component Identifier of Custom Modules)
knowledge-base	action, incident
action	application, asset-software, campaign, device, general-user, incident, knowledge-base, malware, threat-actor, threat-briefing, vulnerability, module-(Component Identifier of Custom Modules)
pir	campaign, incident, malware, threat-actor, threat-briefing, vulnerability, module-(Component Identifier of Custom Modules)
application	action, asset-software, device, general-user-manager, general-user-owner, incident, malware, threat-actor, threat-briefing, vulnerability, module-(Component Identifier of Custom Modules)
asset-software	application, device, incident, enhancement, malware, threat-actor, threat-briefing, vulnerability, module-(Component Identifier of Custom Modules)
endpoint	action, application, asset-software, general-user-manager, general-user-owner, incident, malware, threat-actor, threat-briefing, vulnerability, module-(Component Identifier of Custom Modules)
general-user	action, incident, managed-application, owned-application, managed-device, owned-device, threat-briefing, module-(Component Identifier of Custom Modules)
module-.*	incident, campaign, enhancement, vulnerability, threat-actor, malware, threat-briefing, action, pir, application, asset-software, endpoint, general-user, module-(Component Identifier of Custom Modules)

Note:

To retrieve the component identifier of a custom module, you can use the List Custom Modules endpoint.
\n
To retrieve the IOC type, you can use the Get List of Threat Intel Types.
\n

Response Parameters

This endpoint does not return any response parameters.

Status Codes

200 (Success): Modules are connected successfully.
\n
400 (Bad Request): Incorrect UUIDs or Invalid Link Payload Provided
\n

\n","urlObject":{"path":["v1","connect-the-dots","advanced-link-components",""],"host":["{{base_url}}"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"3b4b6862-8397-4ae1-aefd-577b97ca4acb","name":"200 OK: Connect Modules via append","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"append\": [\n {\n \"link_from\": {\n \"threat-actor\": \"6dc2fee1-26ef-4de3-b8dd-1c9725eeee3e\"\n },\n \"link_to\": {\n \"action\": [\n \"fc4ded27-5091-44b5-9bb8-f3447d026bfe\"\n ],\n \"application\": [\n \"f52459ba-e0e4-4774-8c7f-39f8c28044ca\"\n ],\n \"asset-software\": [\n \"ebccf03c-d08e-4eb0-9753-d69f72542348\"\n ],\n \"campaign\": [\n \"a065fb5c-fe57-4dd9-9118-b08374cf7684\"\n ],\n \"device\": [\n \"f0020716-af86-43dc-886a-844fd17d0e78\"\n ],\n \"enhancement\": [\n \"019a4492-e136-4a5a-bbdb-8402e9c6858e\"\n ],\n \"incident\": [\n \"077bc291-92d5-4a01-a08b-7a51320d3e72\"\n ],\n \"malware\": [\n \"71358205-f5e1-42a6-81c4-1dba7fc002f7\"\n ],\n \"threat-briefing\": [\n \"9e73990c-9854-44ed-9384-f510fee355d4\"\n ],\n \"vulnerability\": [\n \"5a4e1d91-cb89-49d3-8be2-85ffea15e7a5\"\n ],\n \"module-aesvfes3da-1\": [\n \"aa2e1d91-cb19-23d3-8ee2-85ffed25e7a5\"\n ]\n }\n },\n {\n \"link_from\": {\n \"application\": \"6dc2fee1-26ef-4de3-b8dd-1c9725eeee3e\"\n },\n \"link_to\": {\n \"incident\": [\n \"fc4ded27-5091-44b5-9bb8-f3447d026bfe\"\n ]\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/cftrapi/openapi/v1/connect-the-dots/advanced-link-components/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}"],"path":["cftrapi","openapi","v1","connect-the-dots","advanced-link-components",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Wed, 26 Apr 2023 12:44:44 GMT","enabled":true},{"key":"Content-Length","value":"0","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"POST","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Linking is being processed as a background task\"\n}"},{"id":"1e5767c2-afcd-4c32-8d86-ec7c8e50128c","name":"200 OK: Connect Modules via Update","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"update\": [\n {\n \"link_from\": {\n \"action\": \"6dc2fee1-26ef-4de3-b8dd-1c9725eeee3e\"\n },\n \"link_to\": {\n \"incident\": [\n \"fc4ded27-5091-44b5-9bb8-f3447d026bfe\"\n ]\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/cftrapi/openapi/v1/connect-the-dots/advanced-link-components/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}"],"path":["cftrapi","openapi","v1","connect-the-dots","advanced-link-components",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Wed, 26 Apr 2023 12:44:44 GMT","enabled":true},{"key":"Content-Length","value":"0","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"POST","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Linking is being processed as a background task\"\n}"},{"id":"1fe227a7-b78d-4488-9b62-69ed570670c4","name":"400 Bad Request: Connect Modules","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"append\": [\n {\n \"link_from\": {\n \"threat-actor\": \"6dc2fee1-26ef-4de3-b8dd-1c9725eeee3e\"\n },\n \"link_to\": {\n \"action\": [\"fc4ded27-5091-44b5-9bb8-f3447d026bfe\"],\n \"application\": [\"f52459ba-e0e4-4774-8c7f-39f8c28044ca\"],\n \"asset-software\": [\"ebccf03c-d08e-4eb0-9753-d69f72542348\"],\n \"campaign\": [\"a065fb5c-fe57-4dd9-9118-b08374cf7684\"],\n \"device\": [\"f0020716-af86-43dc-886a-844fd17d0e78\"],\n \"enhancement\": [\"019a4492-e136-4a5a-bbdb-8402e9c6858e\"],\n \"incident\": [\"077bc291-92d5-4a01-a08b-7a51320d3e72\"],\n \"malware\": [\"71358205-f5e1-42a6-81c4-1dba7fc002f7\"],\n \"threat-briefing\": [\"9e73990c-9854-44ed-9384-f510fee355d4\"],\n \"vulnerability\": [\"5a4e1d91-cb89-49d3-8be2-85ffea15e7a5\"],\n \"invalid-component\": [\"23\"]\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/cftrapi/openapi/v1/connect-the-dots/advanced-link-components/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}"],"path":["cftrapi","openapi","v1","connect-the-dots","advanced-link-components",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Wed, 26 Apr 2023 12:44:44 GMT","enabled":true},{"key":"Content-Length","value":"0","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"POST","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"Invalid Link Payload Provided:\": \"'invalid-component' does not match '^(action|application|asset-software|campaign|device|enhancement|incident|malware|threat-briefing|vulnerability|ioc_.*|module-.*)$'\"\n}"}],"_postman_id":"43ed643d-4522-4d98-81bc-8a0b41959f06"}],"id":"79032c21-0f58-4a86-9f99-077251936807","_postman_id":"79032c21-0f58-4a86-9f99-077251936807","description":""},{"name":"Actions","item":[{"name":"Get List of Actions","id":"f626b0b1-5947-46ca-ae3b-b206c34fcb67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}"}],"url":"{{base_url}}v1/action/?Expires={{expires}}&Signature={{signature}}&AccessID={{open_api_access_id}}","description":"

Retrieve the list of all actions from the CFTR application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/action/?

Request Parameters

This API endpoint does not require any request parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` shows the API endpoint to the next page.
`count`	Integer	Total number of Actions in CFTR application as per the query parameters.
`results`	List of Objects	Details of the Actions. Each object provides details of one Action.

Response Parameters | Results Object

Parameters	Type	Description
`title`	String	Returns the title of the action.
`unique_id`	String	Returns the unique ID of the action.
`created`	String	Created date of the action in EPOCH time format.
`modified`	String	Last modified date of the action in EPOCH time format.
`description`	String	Description the an action.
`assigned_to`	String	`User_id` of the assigned user.
`assigned_to_data`	Object	Details of the assigned user.
`assigned_group`	String	`Group_comm_id` of the assigned user group.
`assigned_group_data`	Object	Details of the assigned user group. Details include: group_comm_id and group_name of the user group.
`status`	String	Status of the action. For example, open.
`readable_id`	String	Readable ID of the action. For example, ACT379.
`created_by_data`	Object	Details of the user who created the action. Details include: username, email ,first name, last name, and so on.
`can_update_instance`	Boolean	Shows whether the instance can be updated by the user who requested it or not.
`is_bookmarked`	Boolean	True: Action is bookmarked. False: Action is not bookmarked.
`closed_by_data`	Object	Details of the user who closed the action. Details include: username, email ,first name, last name, and so on.
`closed_on`	String	Closure date of the action in EPOCH time format.
`resolved_on`	String	Resolved date of the action in EPOCH time format.
`assignment_sla`	String	Details of assignment SLA details of the action. This parameter has two keys: 1. color: Associated color code (according to SLA breach level). 2. data: It has two keys: - sla_duration: SLA Breach time. - elapsed_time: time elapsed between action opening and SLA completion.
`resolution_sla`	String	Details of resolution SLA of the action. This parameter has two keys: 1. color: Associated color code (according to SLA breach level). 2. data: It has two keys: - sla_duration: SLA Breach time. - elapsed_time: time elapsed between action opening and SLA completion.
`resolution_due_date`	String	Resolution due date of the action.
`sla_stopped_on`	String	Date and time at which the SLA stopped for the action.
`type`	String	Type of the action. For example, Recovery.
`priority`	String	Priority level of the action
`type_data`	Object	Details of the type of the action. Details include: unique_id, option_name, is_active, and so on.
`priority_data`	Object	Details of the priority level of the action.
`labels`	List of Strings	Unique IDs of the list of labels added to the action.
`labels_data`	Object	Details of the labels added to the action. Details include: unique_id, title, color code, and so on.
`created_from_template`	Boolean	Displays if the action is created using a template or not.

","urlObject":{"path":["action",""],"host":["{{base_url}}v1"],"query":[{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"AccessID","value":"{{open_api_access_id}}"},{"disabled":true,"description":{"content":"

[String] [Optional] Enter the status of the actions to filter response results. Allowed values: open, closed

\n","type":"text/plain"},"key":"status","value":"open"},{"disabled":true,"description":{"content":"

[Integer - EPOCH] [Optional] Enter the created date of the actions to filter the actions that are created on or after the entered EPOCH timestamp.

\n","type":"text/plain"},"key":"created_date__gte","value":"160073800"},{"disabled":true,"description":{"content":"

[Integer - EPOCH] [Optional] Enter the created date of the actions to filter the actions that are created on or before the entered EPOCH timestamp.

\n","type":"text/plain"},"key":"created_date__lte","value":"160073800"},{"disabled":true,"description":{"content":"

[Integer - EPOCH] Enter the last modified time of the actions in EPOCH time format. The time zone must be UTC. Only actions modified on or after the specified time will be returned.

\n","type":"text/plain"},"key":"modified_date__gte","value":"1643999399"},{"disabled":true,"description":{"content":"

[Integer - EPOCH] Enter the last modified time of the actions in EPOCH time format. The time zone must be UTC. Only actions modified before the specified time will be returned.

\n","type":"text/plain"},"key":"modified_date__lte","value":"1643999399"},{"disabled":true,"description":{"content":"

[Optional] Enter a user group name to retrieve actions.

\n","type":"text/plain"},"key":"assigned_group","value":"soc_analyst"},{"disabled":true,"description":{"content":"

[Optional] Enter a priority level to retrieve actions.

\n","type":"text/plain"},"key":"priority","value":"low"}],"variable":[]}},"response":[{"id":"c029a9fe-ff3a-4802-9784-d7eb1553174f","name":"Get List of Actions","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}"},{"key":"","value":"","disabled":true}],"url":{"raw":"{{base_url}}v1/action/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["action",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"status","value":"open","description":"[String] [Optional] Enter the status of the actions to filter response results. Allowed values: open, closed","disabled":true},{"key":"created_date__gte","value":"160073800","description":"[Integer - EPOCH] [Optional] Enter the created date of the actions to filter the actions that are created on or after the entered EPOCH timestamp.","disabled":true},{"key":"created_date__lte","value":"160073800","description":"[Integer - EPOCH] [Optional] Enter the created date of the actions to filter the actions that are created on or before the entered EPOCH timestamp.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 07 Jan 2024 10:39:08 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {\n \"next\": \"openapi/cftrapi/openapi/v1/action/?page=2&page_size=10&AccessID=17d73f6f-516d-4113-a4b3-5aab0bcfa334&Expires=1704623963&Signature=6EbFHZ/cWfm5VqfqpToG00dLYas=\"\n },\n \"count\": 17995,\n \"results\": [\n {\n \"title\": \"add final\",\n \"assigned_to\": null,\n \"assigned_group\": \"3b3b1351-1cdf-46b7-bf90-8526720608a3\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"3b3b1351-1cdf-46b7-bf90-8526720608a3\",\n \"group_name\": \"CFTR Admin\"\n },\n \"unique_id\": \"983a8175-e3a1-4fe1-8536-537bdc7cce82\",\n \"assigned_to_data\": {},\n \"created_by_data\": {\n \"username\": \"shashta_s\",\n \"first_name\": \"shashta\",\n \"last_name\": \"s\",\n \"profile_background_color\": \"#5768CB\",\n \"user_id\": \"c9cbb792-148f-43ab-af2b-5ded13c788d2\",\n \"is_active\": true,\n \"email\": \"shashta.s@cyware.com\",\n \"full_name\": \"shashta s\"\n },\n \"readable_id\": \"ACT18765\",\n \"status\": \"open\",\n \"created\": \"2023-04-25T13:58:20.352165Z\",\n \"modified\": \"2024-01-07T10:28:28.523677Z\",\n \"is_bookmarked\": false,\n \"labels\": [],\n \"labels_data\": [],\n \"created_from_template\": false,\n \"type_data\": {\n \"unique_id\": \"45ae9a72-ffbd-4c01-ab24-57349e24368f\",\n \"option_name\": \"Containment\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"738a4125-07f2-4067-a6dc-d43ab23ef96f\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"type\": \"Containment\",\n \"priority_data\": null,\n \"priority\": null,\n },\n {\n \"title\": \"testing action\",\n \"assigned_to\": null,\n \"assigned_group\": \"3b3b1351-1cdf-46b7-bf90-8526720608a3\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"3b3b1351-1cdf-46b7-bf90-8526720608a3\",\n \"group_name\": \"CFTR Admin\"\n },\n \"unique_id\": \"660ca3a8-5f67-4959-b4ac-94750104e614\",\n \"assigned_to_data\": {},\n \"created_by_data\": {\n \"username\": \"shashta_s\",\n \"first_name\": \"shashta\",\n \"last_name\": \"s\",\n \"profile_background_color\": \"#5768CB\",\n \"user_id\": \"c9cbb792-148f-43ab-af2b-5ded13c788d2\",\n \"is_active\": true,\n \"email\": \"shashta.s@cyware.com\",\n \"full_name\": \"shashta s\"\n },\n \"readable_id\": \"ACT18764\",\n \"status\": \"open\",\n \"created\": \"2023-04-25T13:32:48.989219Z\",\n \"modified\": \"2024-01-07T10:28:28.098304Z\",\n \"is_bookmarked\": false,\n \"labels\": [\n \"08ce5578-abd2-41c4-a703-a5e5894733d1\",\n \"4ee178a6-0a48-4d42-8a58-d4ac3c28a3e7\",\n \"b83eb104-e8ed-4596-a267-978ea1f28932\",\n \"103cbce1-2ffa-4177-826a-169f9294fbf9\",\n \"352b9cd2-60a1-4bc2-a3a5-392bcc929784\",\n \"366b847e-2f5a-4077-b640-a3a6e32460e9\",\n \"f1b24e72-e310-4083-89f9-f97a89113337\",\n \"f9e8e8fd-652b-45f2-83cf-1a1a2161c1a5\",\n \"8805e3df-2d81-4e1c-b67c-dfa1d603cf49\",\n \"cf05f1bf-bd59-48ba-93a6-dbb61086fac0\",\n \"c403588e-0f9f-4c19-8c56-46309d68a195\",\n \"169eb751-31a7-4d5f-8f7d-888aed91cd2c\",\n \"1d934288-58e4-4c79-bccc-e357dd043896\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"08ce5578-abd2-41c4-a703-a5e5894733d1\",\n \"title\": \"CERT-IN\",\n \"color_code\": \"#388E3C\",\n \"created\": \"2020-12-01T07:12:33.181880Z\",\n \"modified\": \"2020-12-01T07:12:33.181880Z\"\n },\n {\n \"unique_id\": \"4ee178a6-0a48-4d42-8a58-d4ac3c28a3e7\",\n \"title\": \"Auto\",\n \"color_code\": \"#040404\",\n \"created\": \"2020-12-18T09:07:05.385193Z\",\n \"modified\": \"2021-01-27T10:50:46.024868Z\"\n },\n {\n \"unique_id\": \"b83eb104-e8ed-4596-a267-978ea1f28932\",\n \"title\": \"CFTR - Action\",\n \"color_code\": \"#AA00FF\",\n \"created\": \"2021-02-25T02:32:59.059402Z\",\n \"modified\": \"2021-09-22T10:54:03.998819Z\"\n },\n {\n \"unique_id\": \"103cbce1-2ffa-4177-826a-169f9294fbf9\",\n \"title\": \"Sanlbl\",\n \"color_code\": \"#777481\",\n \"created\": \"2020-06-04T15:16:03.559012Z\",\n \"modified\": \"2020-06-04T15:16:03.559684Z\"\n },\n {\n \"unique_id\": \"352b9cd2-60a1-4bc2-a3a5-392bcc929784\",\n \"title\": \"New Label\",\n \"color_code\": \"#3BE425\",\n \"created\": \"2019-09-20T08:15:47.991753Z\",\n \"modified\": \"2019-09-20T08:17:12.939414Z\"\n },\n {\n \"unique_id\": \"366b847e-2f5a-4077-b640-a3a6e32460e9\",\n \"title\": \"LBL Beta+\",\n \"color_code\": \"#AD1457\",\n \"created\": \"2020-02-14T06:12:46.718847Z\",\n \"modified\": \"2020-02-14T06:12:46.719477Z\"\n },\n {\n \"unique_id\": \"f1b24e72-e310-4083-89f9-f97a89113337\",\n \"title\": \"New Alpha\",\n \"color_code\": \"#38064D\",\n \"created\": \"2021-03-08T10:11:30.185277Z\",\n \"modified\": \"2021-07-21T03:22:24.051525Z\"\n },\n {\n \"unique_id\": \"f9e8e8fd-652b-45f2-83cf-1a1a2161c1a5\",\n \"title\": \"Application\",\n \"color_code\": \"#989A1B\",\n \"created\": \"2020-03-13T09:49:57.986176Z\",\n \"modified\": \"2020-04-08T18:07:23.722018Z\"\n },\n {\n \"unique_id\": \"8805e3df-2d81-4e1c-b67c-dfa1d603cf49\",\n \"title\": \"test\",\n \"color_code\": \"#344563\",\n \"created\": \"2021-01-27T11:11:32.905162Z\",\n \"modified\": \"2021-01-27T11:11:32.905162Z\"\n },\n {\n \"unique_id\": \"cf05f1bf-bd59-48ba-93a6-dbb61086fac0\",\n \"title\": \"testfx\",\n \"color_code\": \"#00897B\",\n \"created\": \"2020-06-04T00:33:06.780005Z\",\n \"modified\": \"2023-04-12T07:13:17.286874Z\"\n },\n {\n \"unique_id\": \"c403588e-0f9f-4c19-8c56-46309d68a195\",\n \"title\": \"Lab001\",\n \"color_code\": \"#64A2DA\",\n \"created\": \"2020-01-06T09:00:11.637663Z\",\n \"modified\": \"2020-01-06T09:00:11.638272Z\"\n },\n {\n \"unique_id\": \"169eb751-31a7-4d5f-8f7d-888aed91cd2c\",\n \"title\": \"Hello\",\n \"color_code\": \"#00D543\",\n \"created\": \"2020-10-29T12:40:32.856692Z\",\n \"modified\": \"2020-10-29T12:40:32.856692Z\"\n },\n {\n \"unique_id\": \"1d934288-58e4-4c79-bccc-e357dd043896\",\n \"title\": \"Test Automation 1\",\n \"color_code\": \"#ffffff\",\n \"created\": \"2020-12-18T09:15:35.033534Z\",\n \"modified\": \"2020-12-18T09:15:35.033534Z\"\n }\n ],\n \"created_from_template\": false,\n \"type_data\": {\n \"unique_id\": \"84b4ce19-3d55-4d1b-8e90-2637f2cd688d\",\n \"option_name\": \"Corrective\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"738a4125-07f2-4067-a6dc-d43ab23ef96f\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"type\": \"Corrective\",\n \"priority_data\": {\n \"unique_id\": \"3e3028cf-332f-4b76-8072-63ea13f6f537\",\n \"option_name\": \"Very High\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"2fc61464-8900-4de2-a589-b7154ce304af\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"Very High\"\n },\n {\n \"title\": \"test\",\n \"assigned_to\": null,\n \"assigned_group\": null,\n \"assigned_group_data\": null,\n \"unique_id\": \"f629490c-f20d-4719-a7d1-eda2a1f5ab82\",\n \"assigned_to_data\": {},\n \"created_by_data\": {\n \"username\": \"nidhi_p\",\n \"first_name\": \"Nidhi\",\n \"last_name\": \"Priya\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"abb1b37a-ff73-41e0-9081-7aa16d2b330d\",\n \"is_active\": true,\n \"email\": \"nidhi.priya@cyware.com\",\n \"full_name\": \"Nidhi Priya\"\n },\n \"readable_id\": \"ACT20477\",\n \"status\": \"open\",\n \"created\": \"2023-12-27T10:52:22.250641Z\",\n \"modified\": \"2023-12-27T10:52:32.025832Z\",\n \"is_bookmarked\": false,\n \"labels\": [],\n \"labels_data\": [],\n \"created_from_template\": false,\n \"type_data\": null,\n \"type\": null,\n \"priority_data\": null,\n \"priority\": null\n },\n {\n \"title\": \"new action on 19 jan 2023\",\n \"assigned_to\": null,\n \"assigned_group\": \"3b3b1351-1cdf-46b7-bf90-8526720608a3\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"3b3b1351-1cdf-46b7-bf90-8526720608a3\",\n \"group_name\": \"CFTR Admin\"\n },\n \"unique_id\": \"03791c12-3ca6-4303-9066-01a053f9d010\",\n \"assigned_to_data\": {},\n \"created_by_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System-super\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5c1b579e-4f14-4ab9-a950-7631d1f01b0c\",\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System-super Default\"\n },\n \"readable_id\": \"ACT17419\",\n \"status\": \"draft\",\n \"created\": \"2023-01-31T05:08:12.990795Z\",\n \"modified\": \"2023-12-20T11:24:08.094702Z\",\n \"is_bookmarked\": false,\n \"labels\": [],\n \"labels_data\": [],\n \"created_from_template\": true,\n \"type_data\": {\n \"unique_id\": \"45ae9a72-ffbd-4c01-ab24-57349e24368f\",\n \"option_name\": \"Containment\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"738a4125-07f2-4067-a6dc-d43ab23ef96f\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"type\": \"Containment\",\n \"priority_data\": null,\n \"priority\": null\n },\n {\n \"title\": \"New Action template for closure\",\n \"assigned_to\": null,\n \"assigned_group\": \"3b3b1351-1cdf-46b7-bf90-8526720608a3\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"3b3b1351-1cdf-46b7-bf90-8526720608a3\",\n \"group_name\": \"CFTR Admin\"\n },\n \"unique_id\": \"26698fd2-1eea-4799-8751-d1f3578da866\",\n \"assigned_to_data\": {},\n \"created_by_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System-super\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5c1b579e-4f14-4ab9-a950-7631d1f01b0c\",\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System-super Default\"\n },\n \"readable_id\": \"ACT17420\",\n \"status\": \"draft\",\n \"created\": \"2023-01-31T05:08:14.101469Z\",\n \"modified\": \"2023-12-20T11:24:07.589976Z\",\n \"is_bookmarked\": false,\n \"labels\": [\n \"b83eb104-e8ed-4596-a267-978ea1f28932\",\n \"c403588e-0f9f-4c19-8c56-46309d68a195\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"b83eb104-e8ed-4596-a267-978ea1f28932\",\n \"title\": \"CFTR - Action\",\n \"color_code\": \"#AA00FF\",\n \"created\": \"2021-02-25T02:32:59.059402Z\",\n \"modified\": \"2021-09-22T10:54:03.998819Z\"\n },\n {\n \"unique_id\": \"c403588e-0f9f-4c19-8c56-46309d68a195\",\n \"title\": \"Lab001\",\n \"color_code\": \"#64A2DA\",\n \"created\": \"2020-01-06T09:00:11.637663Z\",\n \"modified\": \"2020-01-06T09:00:11.638272Z\"\n }\n ],\n \"created_from_template\": true,\n \"type_data\": {\n \"unique_id\": \"20717cf8-014e-4827-8374-7a606a3cf03d\",\n \"option_name\": \"Remediation\",\n \"is_active\": true,\n \"order\": 5,\n \"option_field\": \"738a4125-07f2-4067-a6dc-d43ab23ef96f\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"type\": \"Remediation\",\n \"priority_data\": {\n \"unique_id\": \"c78bcca6-784e-4d09-9ea4-6d9df8722420\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"2fc61464-8900-4de2-a589-b7154ce304af\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"High\"\n },\n {\n \"title\": \"new action on 19 jan 2023\",\n \"assigned_to\": null,\n \"assigned_group\": \"3b3b1351-1cdf-46b7-bf90-8526720608a3\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"3b3b1351-1cdf-46b7-bf90-8526720608a3\",\n \"group_name\": \"CFTR Admin\"\n },\n \"unique_id\": \"329d6d53-abcf-4162-9391-3d36ec16400b\",\n \"assigned_to_data\": {},\n \"created_by_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System-super\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5c1b579e-4f14-4ab9-a950-7631d1f01b0c\",\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System-super Default\"\n },\n \"readable_id\": \"ACT17422\",\n \"status\": \"draft\",\n \"created\": \"2023-01-31T05:08:15.954910Z\",\n \"modified\": \"2023-12-20T11:24:06.978101Z\",\n \"is_bookmarked\": false,\n \"labels\": [],\n \"labels_data\": [],\n \"created_from_template\": true,\n \"type_data\": {\n \"unique_id\": \"45ae9a72-ffbd-4c01-ab24-57349e24368f\",\n \"option_name\": \"Containment\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"738a4125-07f2-4067-a6dc-d43ab23ef96f\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"type\": \"Containment\",\n \"priority_data\": null,\n \"priority\": null\n },\n {\n \"title\": \"Neww tem test\",\n \"assigned_to\": null,\n \"assigned_group\": null,\n \"assigned_group_data\": null,\n \"unique_id\": \"559663ab-abaa-490f-8883-49d77984d111\",\n \"assigned_to_data\": {},\n \"created_by_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System-super\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5c1b579e-4f14-4ab9-a950-7631d1f01b0c\",\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System-super Default\"\n },\n \"readable_id\": \"ACT17421\",\n \"status\": \"draft\",\n \"created\": \"2023-01-31T05:08:14.995912Z\",\n \"modified\": \"2023-12-20T11:24:05.853766Z\",\n \"is_bookmarked\": false,\n \"labels\": [],\n \"labels_data\": [],\n \"created_from_template\": true,\n \"type_data\": null,\n \"type\": null,\n \"priority_data\": null,\n \"priority\": null,\n \"pjtest_asjhgdc_jh_data\": null,\n \"pjtest_asjhgdc_jh\": null\n },\n {\n \"title\": \"123456756u\",\n \"assigned_to\": \"5c4fbd5d-78da-4a4c-93b2-f3a89e269b53\",\n \"assigned_group\": \"3b3b1351-1cdf-46b7-bf90-8526720608a3\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"3b3b1351-1cdf-46b7-bf90-8526720608a3\",\n \"group_name\": \"CFTR Admin\"\n },\n \"unique_id\": \"e16a3949-a50f-40ff-92e9-0db619f4d87f\",\n \"assigned_to_data\": {\n \"username\": \"sreekanth\",\n \"first_name\": \"Sreekanth\",\n \"last_name\": \"Sree\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5c4fbd5d-78da-4a4c-93b2-f3a89e269b53\",\n \"is_active\": true,\n \"email\": \"sreekanth@cyware.com\",\n \"full_name\": \"Sreekanth Sree\"\n },\n \"created_by_data\": {\n \"username\": \"sreekanth\",\n \"first_name\": \"Sreekanth\",\n \"last_name\": \"Sree\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5c4fbd5d-78da-4a4c-93b2-f3a89e269b53\",\n \"is_active\": true,\n \"email\": \"sreekanth@cyware.com\",\n \"full_name\": \"Sreekanth Sree\"\n },\n \"readable_id\": \"ACT20475\",\n \"status\": \"in_progress\",\n \"created\": \"2023-12-04T13:18:24.517615Z\",\n \"modified\": \"2023-12-18T14:31:00.167190Z\",\n \"is_bookmarked\": false,\n \"labels\": [\n \"08ce5578-abd2-41c4-a703-a5e5894733d1\",\n \"b83eb104-e8ed-4596-a267-978ea1f28932\",\n \"f9e8e8fd-652b-45f2-83cf-1a1a2161c1a5\",\n \"c403588e-0f9f-4c19-8c56-46309d68a195\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"08ce5578-abd2-41c4-a703-a5e5894733d1\",\n \"title\": \"CERT-IN\",\n \"color_code\": \"#388E3C\",\n \"created\": \"2020-12-01T07:12:33.181880Z\",\n \"modified\": \"2020-12-01T07:12:33.181880Z\"\n },\n {\n \"unique_id\": \"b83eb104-e8ed-4596-a267-978ea1f28932\",\n \"title\": \"CFTR - Action\",\n \"color_code\": \"#AA00FF\",\n \"created\": \"2021-02-25T02:32:59.059402Z\",\n \"modified\": \"2021-09-22T10:54:03.998819Z\"\n },\n {\n \"unique_id\": \"f9e8e8fd-652b-45f2-83cf-1a1a2161c1a5\",\n \"title\": \"Application\",\n \"color_code\": \"#989A1B\",\n \"created\": \"2020-03-13T09:49:57.986176Z\",\n \"modified\": \"2020-04-08T18:07:23.722018Z\"\n },\n {\n \"unique_id\": \"c403588e-0f9f-4c19-8c56-46309d68a195\",\n \"title\": \"Lab001\",\n \"color_code\": \"#64A2DA\",\n \"created\": \"2020-01-06T09:00:11.637663Z\",\n \"modified\": \"2020-01-06T09:00:11.638272Z\"\n }\n ],\n \"created_from_template\": false,\n \"type_data\": {\n \"unique_id\": \"0128d42f-6365-4495-b0fe-a0828c769e6b\",\n \"option_name\": \"Mitigation\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"738a4125-07f2-4067-a6dc-d43ab23ef96f\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"type\": \"Mitigation\",\n \"priority_data\": {\n \"unique_id\": \"13f57817-0bb3-4b9f-9478-79c96b900008\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"2fc61464-8900-4de2-a589-b7154ce304af\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"Medium\",\n \"pjtest_asjhgdc_jh_data\": {\n \"unique_id\": \"b27e4b2c-ccc6-4f72-ba4c-33fdc2081659\",\n \"option_name\": \"3\",\n \"is_active\": true,\n \"order\": 10,\n \"option_field\": \"7c1cfbd8-ace8-4b1d-97a7-41a1fbdf5457\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n },\n {\n \"title\": \"New Action template for closure\",\n \"assigned_to\": \"5c1b579e-4f14-4ab9-a950-7631d1f01b0c\",\n \"assigned_group\": \"3b3b1351-1cdf-46b7-bf90-8526720608a3\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"3b3b1351-1cdf-46b7-bf90-8526720608a3\",\n \"group_name\": \"CFTR Admin\"\n },\n \"unique_id\": \"c6e7997e-4c28-412f-af91-219315b9cd33\",\n \"assigned_to_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System-super\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5c1b579e-4f14-4ab9-a950-7631d1f01b0c\",\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System-super Default\"\n },\n \"created_by_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System-super\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5c1b579e-4f14-4ab9-a950-7631d1f01b0c\",\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System-super Default\"\n },\n \"readable_id\": \"ACT19930\",\n \"status\": \"resolved\",\n \"created\": \"2023-07-18T03:59:51.261891Z\",\n \"modified\": \"2023-12-15T14:14:10.283270Z\",\n \"is_bookmarked\": false,\n \"labels\": [\n \"b83eb104-e8ed-4596-a267-978ea1f28932\",\n \"c403588e-0f9f-4c19-8c56-46309d68a195\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"b83eb104-e8ed-4596-a267-978ea1f28932\",\n \"title\": \"CFTR - Action\",\n \"color_code\": \"#AA00FF\",\n \"created\": \"2021-02-25T02:32:59.059402Z\",\n \"modified\": \"2021-09-22T10:54:03.998819Z\"\n },\n {\n \"unique_id\": \"c403588e-0f9f-4c19-8c56-46309d68a195\",\n \"title\": \"Lab001\",\n \"color_code\": \"#64A2DA\",\n \"created\": \"2020-01-06T09:00:11.637663Z\",\n \"modified\": \"2020-01-06T09:00:11.638272Z\"\n }\n ],\n \"created_from_template\": true,\n \"type_data\": {\n \"unique_id\": \"20717cf8-014e-4827-8374-7a606a3cf03d\",\n \"option_name\": \"Remediation\",\n \"is_active\": true,\n \"order\": 5,\n \"option_field\": \"738a4125-07f2-4067-a6dc-d43ab23ef96f\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"type\": \"Remediation\",\n \"priority_data\": {\n \"unique_id\": \"c78bcca6-784e-4d09-9ea4-6d9df8722420\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"2fc61464-8900-4de2-a589-b7154ce304af\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"High\"\n },\n {\n \"title\": \"new action on 19 jan 2023\",\n \"assigned_to\": null,\n \"assigned_group\": \"3b3b1351-1cdf-46b7-bf90-8526720608a3\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"3b3b1351-1cdf-46b7-bf90-8526720608a3\",\n \"group_name\": \"CFTR Admin\"\n },\n \"unique_id\": \"74acfc46-1c24-4183-a4fb-a2bedb62659d\",\n \"assigned_to_data\": {},\n \"created_by_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System-super\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5c1b579e-4f14-4ab9-a950-7631d1f01b0c\",\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System-super Default\"\n },\n \"readable_id\": \"ACT19937\",\n \"status\": \"draft\",\n \"created\": \"2023-07-18T03:59:57.137559Z\",\n \"modified\": \"2023-12-15T14:14:09.677359Z\",\n \"is_bookmarked\": false,\n \"labels\": [],\n \"labels_data\": [],\n \"created_from_template\": true,\n \"type_data\": {\n \"unique_id\": \"45ae9a72-ffbd-4c01-ab24-57349e24368f\",\n \"option_name\": \"Containment\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"738a4125-07f2-4067-a6dc-d43ab23ef96f\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"type\": \"Containment\",\n \"priority_data\": null,\n \"priority\": null\n }\n ]\n}"}],"_postman_id":"f626b0b1-5947-46ca-ae3b-b206c34fcb67"},{"name":"Get Details of an Action","event":[{"listen":"prerequest","script":{"id":"14a1556b-cdd9-42a7-b548-161626c702ae","exec":["var accessid = pm.environment.get(\"open_api_access_id\");","var secret_key = pm.environment.get(\"open_api_secret_key\");","/*"," -generating epochtime"," -epochtime is being send in expires parameter of params"," -sign is generated and then passed for generating signature","*/","pm.environment.set(\"unixtimestamp\",Math.round(Date.now()/1000));","var expires = pm.environment.get(\"unixtimestamp\")+15;","pm.environment.set('UTC Timezone', new Date().toISOString());","pm.environment.set(\"expires\", expires);","var to_sign = accessid+\"\\n\"+expires;","/*","Generate Signature for Authentication"," -Key based hashing is done using HMAC-SHA1 Algorithm"," -This is then converted into base64"," -Finally the generated signature is URL Encoded so as to make all the special characters URL Safe","*/","var hash = CryptoJS.HmacSHA1(to_sign, secret_key);","var hashInBase64 = encodeURIComponent(CryptoJS.enc.Base64.stringify(hash));","pm.environment.set(\"signature\",hashInBase64);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"b09286df-bc1e-424f-a222-6360f3d55bfc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}"}],"url":"{{base_url}}v1/action/:action_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the details of an action.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/action/:action_unique_id/?

Response Parameters

Response Parameters | Regulatory Fields

Parameters	Type	Description
`title`	String	The title of the action.
`unique_id`	String	Unique ID of the action.
`created`	String	Created date of the action in EPOCH time format.
`modified`	String	Last modified date of the action in EPOCH time format.
`description`	String	Description of the action.
`assigned_to`	String	`User_id` of the assigned user.
`assigned_to_data`	Object	Details of the assigned user.
`assigned_group`	String	`Group_comm_id` of the assigned user group.
`assigned_group_data`	Object	Details of the assigned user group. Details include: group_comm_id and group_name of the user group.
`status`	String	Status of the action.
`readable_id`	String	Readable ID of the action. For example, ACT379.
`created_by_data`	Object	Details of the user who created the action. Details include: username, email ,first name, last name, and so on.
`can_update_instance`	Boolean	Shows whether the instance can be updated by the user who requested it or not.
`is_bookmarked`	Boolean	True: Action is bookmarked. False: Action is not bookmarked.
`closed_by_data`	Object	Details of the user who closed the action. Details include: username, email ,first name, last name, and so on.
`closed_on`	String	Closure date of the action in EPOCH time format.
`resolved_on`	String	Resolved date of the action in EPOCH time format.
`assignment_sla`	String	Details of assignment SLA details of the action. This parameter has two keys: 1. color: Associated color code (according to SLA breach level). 2. data: It has two keys: - sla_duration: SLA Breach time. - elapsed_time: time elapsed between action opening and SLA completion.
`resolution_sla`	String	Details of resolution SLA of the action. This parameter has two keys: 1. color: Associated color code (according to SLA breach level). 2. data: It has two keys: - sla_duration: SLA Breach time. - elapsed_time: time elapsed between action opening and SLA completion.
`resolution_due_date`	String	Resolution due date of the action.
`sla_stopped_on`	String	Date and time at which the SLA stopped for the action.
`type`	String	Type of the action.
`priority`	String	Priority level of the action
`type_data`	Object	Details of the type of the action.
`priority_data`	Object	Details of the priority level of the action.
`created_from_template`	Boolean	Displays if the action is created using template or not.

Response Parameters | Connect The Dots

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`users`	Array of UUID-4 Strings	Array of UUID-4 strings containing unique IDs of the connected users.
`users_data`	Array of Objects	Details of the connected users.
`endpoints`	Array of UUID-4 Strings	Array of UUID-4 strings containing unique IDs of connected devices.
`endpoints_data`	Array of Objects	Details of the connected devices.
`softwares`	Array of UUID-4 Strings	Array of UUID-4 strings containing unique IDs of connected software.
`softwares_data`	Array of Objects	Details of the connected software.
`applications`	Array of UUID-4 Strings	Array of UUID-4 strings containing unique IDs of connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`incidents_data`	Object	Details of the connected incidents.
`malwares_data`	Array of Objects	Details of the connected malware.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.

Response Parameters | Custom Form Fields

In addition to the above mentioned parameters, the response parameters may vary as per the form configuration defined by your CFTR admin for actions. For such parameters, the field_readable_key of each parameter is returned in the response. To retrieve the field_readable_key and additional metadata of a parameter, use the Form Tab Structure API for actions.

Example

The following endpoint retrieves the field_readable_key for all custom fields in the action component:

{{base_url}}/openapi/v1/forms/fields/?object_identifier=action\n\n

Following are some of the sample custom fields for actions:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`case_description`	String	Optional
`exception_details`	String	Optional

","urlObject":{"path":["action",":action_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the action in UUID-4 format.

\n","type":"text/plain"},"type":"any","value":"fcb54f78-e1f8-42c3-9765-75e5ada19c0d","key":"action_unique_id"}]}},"response":[{"id":"ec6c2739-eca0-4d02-a859-d9e675bd35d6","name":"Action Details","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}"},{"key":"","value":"","disabled":true}],"url":{"raw":"{{base_url}}v1/action/:action_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["action",":action_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"action_unique_id","value":"fcb54f78-e1f8-42c3-9765-75e5ada19c0d","description":"Mention the unique ID of the action of UUID-4 format."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 27 Jan 2022 12:57:32 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"5164","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"case_description\": null,\n \"exception_details\": null,\n \"itsm_req_ticket_no\": null,\n \"servicenow_request_ticket_id\": null,\n \"return_to_soc_reason\": null,\n \"title\": \"Block URL at Sophos Firewall\",\n \"description\": \"

Block URL: http://trenz.pl/ at Shophos Firewall

\",\n \"assigned_to\": \"f37ab3eb-6d0c-4997-ad31-f6fb71c2e4a4\",\n \"assigned_group\": \"5e749e50-4479-4614-b2f7-b14ccc46cf7b\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"5e749e50-4479-4614-b2f7-b14ccc46cf7b\",\n \"group_name\": \"Admin\"\n },\n \"unique_id\": \"fcb54f78-e1f8-42c3-9765-75e5ada19c0d\",\n \"assigned_to_data\": {\n \"username\": \"janedoe\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"f37ab3eb-6d0c-4997-ad31-f6fb71c2e4a4\",\n \"is_active\": false,\n \"email\": \"jane_doe@example.cpm\",\n \"full_name\": \"Jane Doe\"\n },\n \"created_by_data\": {\n \"username\": \"JohnDoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"be43156f-97f3-48d4-be8b-3b533574efed\",\n \"is_active\": true,\n \"email\": \"John.Doe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"readable_id\": \"ACT3753\",\n \"status\": \"open\",\n \"created\": \"2020-03-26T00:59:43Z\",\n \"briefings_data\": [],\n \"campaigns_data\": [\n {\n \"title\": \"New Threat Changes\",\n \"unique_id\": \"5c0d033c-9f5b-4b3d-b1a7-57cfe03b4ce7\",\n \"readable_id\": \"CMP133\",\n \"created\": \"2019-07-19T12:36:21.229097Z\",\n \"modified\": \"2020-01-10T11:54:50.139621Z\",\n \"title_display\": \"New Threat Changes\",\n \"status\": \"ACTIVE\"\n },\n {\n \"title\": \"Same malware infection observed across various workstations\",\n \"unique_id\": \"97228870-62e8-4625-b4f7-9941ebf431ec\",\n \"readable_id\": \"CMP140\",\n \"created\": \"2020-02-20T13:29:16.662127Z\",\n \"modified\": \"2021-02-03T14:01:57.479911Z\",\n \"title_display\": \"Same malware infection observed across various workstations\",\n \"status\": \"ACTIVE\"\n },\n {\n \"title\": \"Sophisticated ARP spoofing\",\n \"unique_id\": \"679bf67f-1b0e-4647-9fd1-42026cc91944\",\n \"readable_id\": \"CMP138\",\n \"created\": \"2020-01-30T11:08:59.235721Z\",\n \"modified\": \"2020-01-30T11:08:59.245773Z\",\n \"title_display\": \"Sophisticated ARP spoofing\",\n \"status\": \"ACTIVE\"\n }\n ],\n \"incidents_data\": {\n \"unique_id\": \"e5fb68ab-069c-446e-b9d7-fd6846041901\",\n \"readable_id\": \"INC1932\",\n \"e88699e1-531b-4462-afd6-eaa83d391773\": \"Potential SQL Injection Attack Found\",\n \"status\": \"open\",\n \"severity_title\": \"Critical\"\n },\n \"modified\": \"2020-02-20T13:45:10.615513Z\",\n \"can_update_instance\": true,\n \"ioc_set_data\": [],\n \"is_bookmarked\": true,\n \"malwares_data\": [\n {\n \"unique_id\": \"9e1c7fbe-de11-43be-9fd9-790ee1baaf9e\",\n \"readable_id\": \"MLW136\",\n \"title\": \"Carbanak Trojan\",\n \"status\": \"active\",\n \"created\": \"2020-03-27T00:52:06Z\",\n \"modified\": \"2020-02-26T16:13:59.591693Z\",\n \"title_display\": \"Carbanak Trojan\"\n },\n {\n \"unique_id\": \"a9b9a12e-9cc5-4a2a-a576-0e7505a6a94c\",\n \"readable_id\": \"MLW106\",\n \"title\": \"NotPetya Ransomware\",\n \"status\": \"active\",\n \"created\": \"2020-04-01T17:09:30Z\",\n \"modified\": \"2021-04-23T10:42:28.473158Z\",\n \"title_display\": \"NotPetya Ransomware\"\n }\n ],\n \"total_ownership_duration\": {\n \"days\": 706,\n \"hours\": 23,\n \"minutes\": 15,\n \"seconds\": 52\n },\n \"vulnerabilities_data\": [\n {\n \"unique_id\": \"e201d675-eb19-42d5-9267-680dfbc89f6d\",\n \"readable_id\": \"VUL137\",\n \"created\": \"2019-11-15T12:04:43.389041Z\",\n \"modified\": \"2019-12-03T14:06:41.718566Z\",\n \"title\": \"Zero-day Vulnerabilities\",\n \"status\": \"open\",\n \"title_display\": \"Zero-day Vulnerabilities\"\n },\n {\n \"unique_id\": \"ebd53a0f-97d3-41a7-bc61-6ab3709fedc3\",\n \"readable_id\": \"VUL139\",\n \"created\": \"2019-12-10T13:07:55.727911Z\",\n \"modified\": \"2019-12-20T06:54:30.890739Z\",\n \"title\": \"Housing app exposes android token in openapi.\",\n \"status\": \"open\",\n \"title_display\": \"Housing app exposes android token in openapi.\"\n },\n {\n \"unique_id\": \"5c1c0c8d-e59e-417d-ad33-88d5b4bafc5b\",\n \"readable_id\": \"VUL133\",\n \"created\": \"2019-05-27T06:41:20.260365Z\",\n \"modified\": \"2019-06-18T07:12:25.264874Z\",\n \"title\": \"New Vul\",\n \"status\": \"open\",\n \"title_display\": \"New Vul\"\n }\n ],\n \"attachments_data\": [],\n \"threat_actors_data\": [],\n \"closed_by_data\": null,\n \"closed_on\": null,\n \"resolved_on\": null,\n \"title_display\": \"Block URL at Sophos Firewall\",\n \"labels\": [],\n \"labels_data\": [],\n \"applications\": [\n \"4ef37041-3b28-4af1-a531-cb556b44972c\",\n \"bb62b72a-5fec-43e5-9948-c7f3182e2a63\"\n ],\n \"applications_data\": [\n {\n \"unique_id\": \"4ef37041-3b28-4af1-a531-cb556b44972c\",\n \"created\": \"2019-11-15T12:23:50.396524Z\",\n \"modified\": \"2020-02-20T14:45:43.149387Z\",\n \"title\": \"Clevertap_CY\",\n \"production_date\": \"2020-02-12T18:30:00Z\",\n \"readable_id\": \"APL114\",\n \"labels\": [],\n \"labels_data\": [],\n \"title_display\": \"Clevertap_CY\",\n \"status\": \"inactive\"\n },\n {\n \"unique_id\": \"bb62b72a-5fec-43e5-9948-c7f3182e2a63\",\n \"created\": \"2018-12-17T06:40:49.192934Z\",\n \"modified\": \"2020-02-20T12:01:13.773095Z\",\n \"title\": \"OLGA Dynamic Multiphase Flow Simulator\",\n \"production_date\": \"2018-12-17T06:40:49.196723Z\",\n \"readable_id\": \"APL103\",\n \"labels\": [],\n \"labels_data\": [],\n \"title_display\": \"OLGA Dynamic Multiphase Flow Simulator\",\n \"status\": \"inactive\"\n }\n ],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"users\": [],\n \"users_data\": [],\n \"softwares\": [],\n \"softwares_data\": [],\n \"days_spent\": 0,\n \"hours_spent\": 0,\n \"minutes_spent\": 0,\n \"priority\": null,\n \"type\": \"Corrective\",\n \"knowledge_base_data\": [],\n \"assignment_sla\": null,\n \"resolution_sla\": null,\n \"resolution_due_date\": null,\n \"sla_stopped_on\": null,\n \"priority_data\": null,\n \"type_data\": {\n \"unique_id\": \"fe968d25-004d-42f0-b003-6827c0c30e5e\",\n \"option_name\": \"Corrective\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"ddcff70d-b240-4109-a9bb-ab7215aa57fe\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"return_to_soc_reason_data\": null\n}"}],"_postman_id":"b09286df-bc1e-424f-a222-6360f3d55bfc"},{"name":"Create Action Using Field UUID","id":"d3281b2b-3261-49c6-a4f1-481ef0f91473","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}"}],"body":{"mode":"raw","raw":"{\n \"case_description\": \"IP to be blocked\",\n \"exception_details\": \"Internal IP and subnet to be excluded\",\n \"itsm_req_ticket_no\": \"ITS638\",\n \"servicenow_request_ticket_id\": \"SNOW8989\",\n \"return_to_soc_reason\": \"More IPs to be included\",\n \"title\": \"Block IPs on Firewall\",\n \"description\": \"Malicious IPs from Logs needs to be blocked on firewall\",\n \"assigned_to\": \"be43156f-97f3-48d4-be8b-3b533574efed\",\n \"assigned_group\": \"776a0b27-83b8-4819-835f-2f0bfda5001d\",\n \"status\": \"open\",\n \"priority\": \"High\",\n \"type\": \"Mitigation\"\n}"},"url":"{{base_url}}v1/action/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Create an action in the CFTR application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/action/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

Request Parameters | Regulatory Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
`title`	String	Mandatory	Enter a title for the action.
`description`	String	Optional	Enter a description that best describes the key details of the action.
`status`	String	Optional	Enter the status of the action. Allowed values: open closed Example: \"open\" Default value: \"open\"
`priority`	String	Optional	Enter the priority of the action. Allowed values: - Very Low - Very High - Low - Medium - High Example: \"Low\"
`type`	String	Optional	Enter the action type. Some of the action type values are: - Corrective - Containment - Eradication - Mitigation - Recovery - Remediation Example: \"Corrective\"
`due_date`	String	Optional	Enter the due date of the action.
`exception_details`	String	Optional	Enter the exceptions related to the action.
`assigned_group`	String	Mandatory	Enter the name of the CFTR user group to assign the action. This action can only be assigned to the members of the entered user group. You can use the following API endpoint to retrieve the list of user groups: `/openapi/v1/rest-auth/permission/group/`

Request Parameters | Custom Form Fields

In addition to the above mentioned parameters, the response parameters may vary as per the form configuration defined by your CFTR admin for actions. For such parameters, use the field_readable_key of each parameter. To retrieve the field_readable_key and additional metadata of a parameter, use the Form Tab Structure API for actions.

Example

The following endpoint retrieves the field_readable_key for all custom fields in the action component:

{{base-url}}/openapi/v1/forms/fields/?object_identifier=action\n\n

Following are some of the sample custom fields for actions:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`case_description`	String	Optional
`exception_details`	String	Optional

Response Parameters

Response Parameters | Regulatory Fields

Parameters	Type	Description
`title`	String	The title of the action.
`unique_id`	String	Unique ID of the action.
`created`	String	Created date of the action in EPOCH time format.
`modified`	String	Last modified date of the action in EPOCH time format.
`description`	String	Description of the action.
`assigned_to`	String	`User_id` of the user assigned to the action.
`assigned_to_data`	Object	Details of the assigned user. Details include: first_name, last_name, user_id, and so on.
`assigned_group`	String	`Group_comm_id` of the assigned user group.
`assigned_group_data`	Object	Details of the assigned user group.
`status`	String	Status of the action.
`readable_id`	String	Readable ID of the action. For example, ACT380.
`created_by_data`	Object	Details of the user who created the action. Details include: username, email ,first name, last name, and so on.
`can_update_instance`	Boolean	Shows whether the action can be updated by the user who requested it or not.
`is_bookmarked`	Boolean	True: Action is bookmarked. False: Action is not bookmarked.
`closed_by_data`	Object	Details of the user who closed the action. Details include: username, email ,first name, last name, and so on.
`closed_on`	String	Closure date of the action in EPOCH time format.
`resolved_on`	String	Resolved date of the action in EPOCH time format.
`assignment_sla`	String	Details of assignment SLA details of the action. This parameter has two keys: 1. color: Associated color code (according to SLA breach level). 2. data: It has two keys: - sla_duration: SLA Breach time. - elapsed_time: time elapsed between action opening and SLA completion.
`resolution_sla`	String	Details of resolution SLA of the action. This parameter has two keys: 1. color: Associated color code (according to SLA breach level). 2. data: It has two keys: - sla_duration: SLA Breach time. - elapsed_time: time elapsed between action opening and SLA completion.
`resolution_due_date`	String	Resolution due date of the action.
`sla_stopped_on`	String	Date and time at which the SLA stopped for the action.
`type`	String	Type of the action.
`priority`	String	Priority level of the action
`type_data`	Object	Details of the type of the action.
`priority_data`	Object	Details of the priority level of the action.
`created_from_template`	Boolean	Shows if the action was created using template or not.

Response Parameters | Connect The Dots

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`users`	Array of UUID-4 Strings	Array of UUID-4 strings containing unique IDs of the connected users.
`users_data`	Array of Objects	Details of the connected users.
`endpoints`	Array of UUID-4 Strings	Array of UUID-4 strings containing unique IDs of connected devices.
`endpoints_data`	Array of Objects	Details of the connected devices.
`softwares`	Array of UUID-4 Strings	Array of UUID-4 strings containing unique IDs of connected software.
`softwares_data`	Array of Objects	Details of the connected software.
`applications`	Array of UUID-4 Strings	Array of UUID-4 strings containing unique IDs of connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`incidents_data`	Object	Details of the connected incidents.
`malwares_data`	Array of Objects	Details of the connected malware.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.

Response Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the action component:

{{base-url}}/openapi/v1/forms/fields/?object_identifier=action\n\n

Following are some of the sample custom fields for actions:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type
`case_description`	String
`exception_details`	String

","urlObject":{"path":["action",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"8c3605f4-dec8-437b-9f94-b5f92b5983b6","name":"Create Action Using Field UUID","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"","value":"","disabled":true},{"key":"Authorization","value":"{{auth_key}}"}],"body":{"mode":"raw","raw":"{\n \"case_description\": \"IP to be blocked\",\n \"exception_details\": \"Internal IP and subnet to be excluded\",\n \"itsm_req_ticket_no\": \"ITS638\",\n \"servicenow_request_ticket_id\": \"SNOW8989\",\n \"return_to_soc_reason\": \"More IPs to be included\",\n \"title\": \"Block IPs on Firewall\",\n \"description\": \"Malicious IPs from Logs needs to be blocked on firewall\",\n \"assigned_group\": \"4c8a4d5c-6921-4257-aac7-8242f323cad4\",\n \"status\": \"open\",\n \"priority\": \"High\",\n \"type\": \"Mitigation\"\n}"},"url":{"raw":"{{base_url}}v1/action/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["action",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 30 Jan 2024 12:22:34 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"2519","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Server","value":"gunicorn/19.10.0","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"exception_details\": \"Internal IP and subnet to be excluded\",\n \"title\": \"Block IPs on Firewall\",\n \"description\": \"Malicious IPs from Logs needs to be blocked on firewall\",\n \"assigned_to\": null,\n \"assigned_group\": \"4c8a4d5c-6921-4257-aac7-8242f323cad4\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"4c8a4d5c-6921-4257-aac7-8242f323cad4\",\n \"group_name\": \"Automated2024-01-29 22:18:27.481852\"\n },\n \"unique_id\": \"43114c07-6b1a-462c-83c1-09fdb772af6e\",\n \"assigned_to_data\": {},\n \"created_by_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"b3184a17-e59f-46cb-82c3-d8aabbefff7e\",\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System Default\"\n },\n \"readable_id\": \"ACT380\",\n \"status\": \"open\",\n \"created\": \"2024-01-30T12:22:34.080712Z\",\n \"briefings\": [],\n \"briefings_data\": [],\n \"campaigns\": [],\n \"campaigns_data\": [],\n \"incidents_data\": null,\n \"modified\": \"2024-01-30T12:22:34.243838Z\",\n \"can_update_instance\": false,\n \"can_update_full\": false,\n \"ioc_set_data\": [],\n \"is_bookmarked\": false,\n \"malwares\": [],\n \"malwares_data\": [],\n \"total_ownership_duration\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 0,\n \"seconds\": 0\n },\n \"vulnerabilities\": [],\n \"vulnerabilities_data\": [],\n \"attachments_data\": [],\n \"threat_actors\": [],\n \"threat_actors_data\": [],\n \"closed_by_data\": null,\n \"closed_on\": null,\n \"resolved_on\": null,\n \"title_display\": \"Block IPs on Firewall\",\n \"labels\": [],\n \"labels_data\": [],\n \"applications\": [],\n \"applications_data\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"users\": [],\n \"users_data\": [],\n \"softwares\": [],\n \"softwares_data\": [],\n \"days_spent\": 0,\n \"hours_spent\": 0,\n \"minutes_spent\": 0,\n \"priority\": \"High\",\n \"type\": \"Mitigation\",\n \"knowledge_base_data\": [],\n \"assignment_sla\": {\n \"data\": {\n \"sla_duration\": {\n \"days\": 2,\n \"hours\": 10,\n \"minutes\": 30\n }\n },\n \"elapsed_time\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 0\n },\n \"color\": 0\n },\n \"resolution_sla\": {\n \"data\": {\n \"sla_duration\": {\n \"days\": 4,\n \"hours\": 10,\n \"minutes\": 30\n }\n },\n \"elapsed_time\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 0\n },\n \"color\": 0\n },\n \"resolution_due_date\": \"2024-02-03T22:52:34.080712Z\",\n \"sla_stopped_on\": null,\n \"incident_phase_tab\": null,\n \"created_from_template\": true,\n \"handoff_note\": null,\n \"priority_data\": {\n \"unique_id\": \"284f630d-4005-4fe0-8ba3-1eac2418159d\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"7e2e38b3-88b5-4fe6-b6f9-517f542c472f\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"type_data\": {\n \"unique_id\": \"4038b702-7741-4e9e-b932-cc4dbe37f390\",\n \"option_name\": \"Mitigation\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"6f90af89-8526-49c7-bc2d-884fb95141b4\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n}"}],"_postman_id":"d3281b2b-3261-49c6-a4f1-481ef0f91473"},{"name":"Create Action Using Field Values","id":"20633392-d76f-4319-8de5-ab36f215c240","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"case_description\": \"IP to be blocked\",\n \"exception_details\": \"Internal IP and subnet to be excluded\",\n \"itsm_req_ticket_no\": \"ITS638\",\n \"servicenow_request_ticket_id\": \"SNOW8989\",\n \"return_to_soc_reason\": \"More IPs to be included\",\n \"title\": \"Block IPs on Firewall\",\n \"description\": \"Malicious IPs from Logs needs to be blocked on firewall\",\n \"assigned_to\": \"pooja.gunali@cyware.com\",\n \"assigned_group\": \"Admin\",\n \"status\": \"open\",\n \"priority\": \"High\",\n \"type\": \"Mitigation\",\n \"labels\": [\"Auto\"]\n}"},"url":"{{base_url}}v1/action/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","description":"

Create an action in the CFTR application using the values of assigned groups, labels, and the email IDs of assigned users.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/action/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

Request Parameters | Regulatory Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
`title`	String	Mandatory	Enter a title for the action.
`description`	String	Optional	Enter a description that best describes the key details of the action.
`status`	String	Optional	Enter the status of the action. Allowed values: - open - closed Example: \"open\" Default value: \"open\"
`priority`	String	Optional	Enter the priority of the action. Allowed values: - Very Low - Very High - Low - Medium - High Example: \"Low\"
`type`	String	Optional	Enter the action type. Some of the action type values are: - Corrective - Containment - Eradication - Mitigation - Recovery - Remediation Example: \"Corrective\"
`due_date`	String	Optional	Enter the due date of the action.
`exception_details`	String	Optional	Enter the exceptions related to the action.
`assigned_group`	String	Mandatory	Enter the name of the CFTR user group to assign the action. This action can only be assigned to the members of the entered user group. You can use the following API endpoint to retrieve the list of user groups:`/openapi/v1/rest-auth/permission/group/`
`assigned_to`	String	Optional	Enter the email ID of the user to assign the action. You can use the following API endpoint to retrieve the list of users: `/openapi/v1/rest-auth/user/`
`labels`	List	Optional	Enter the list of the names of labels to be added to the action. You can use the following API endpoint to retrieve the list of Labels: `/openapi/v1/utils/label/`

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the action component:

{{base-url}}/openapi/v1/forms/fields/?object_identifier=action\n\n

Following are some of the sample custom fields for actions:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`case_description`	String	Optional
`exception_details`	String	Optional

Response Parameters

Response Parameters | Regulatory Fields

Parameters	Type	Description
`title`	String	The title of the action.
`unique_id`	String	Unique ID of the action.
`created`	String	Created date of the action in EPOCH time format.
`modified`	String	Last modified date of the action in EPOCH time format.
`description`	String	Description of the action.
`assigned_to`	String	`User_id` of the assigned user.
`assigned_to_data`	Object	Details of the assigned user.
`assigned_group`	String	`Group_comm_id` of the assigned user group.
`assigned_group_data`	Object	Details of the assigned user group.
`status`	String	Status of the action.
`readable_id`	String	Readable ID of the action. For example, ACT381
`created_by_data`	Object	Details of the user who created the action. Details include: username, email ,first name, last name, and so on.
`can_update_instance`	Boolean	Shows whether the instance can be updated by the user who requested it or not.
`is_bookmarked`	Boolean	True: Action is bookmarked. False: Action is not bookmarked.
`closed_by_data`	Object	Details of the user who closed the action. Details include: username, email ,first name, last name, and so on.
`closed_on`	String	Closure date of the action in EPOCH time format.
`resolved_on`	String	Resolved date of the action in EPOCH time format.
`assignment_sla`	String	Details of assignment SLA details of the action. This parameter has two keys: 1. color: Associated color code (according to SLA breach level). 2. data: It has two keys: - sla_duration: SLA Breach time. - elapsed_time: time elapsed between action opening and SLA completion.
`resolution_sla`	String	Details of resolution SLA of the action. This parameter has two keys: 1. color: Associated color code (according to SLA breach level). 2. data: It has two keys: - sla_duration: SLA Breach time. - elapsed_time: time elapsed between action opening and SLA completion.
`resolution_due_date`	String	Resolution due date of the action.
`sla_stopped_on`	String	Date and time at which the SLA stopped for the action.
`type`	String	Type of the action.
`priority`	String	Priority level of the action
`type_data`	Object	Details of the type of the action.
`priority_data`	Object	Details of the priority level of the action.
`created_from_template`	Boolean	Shows if the action is created using a template or not.

Response Parameters | Connect The Dots

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`users`	Array of UUID-4 Strings	Array of UUID-4 strings containing unique IDs of the connected users.
`users_data`	Array of Objects	Details of the connected users.
`endpoints`	Array of UUID-4 Strings	Array of UUID-4 strings containing unique IDs of connected devices.
`endpoints_data`	Array of Objects	Details of the connected devices.
`softwares`	Array of UUID-4 Strings	Array of UUID-4 strings containing unique IDs of connected software.
`softwares_data`	Array of Objects	Details of the connected software.
`applications`	Array of UUID-4 Strings	Array of UUID-4 strings containing unique IDs of connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`incidents_data`	Object	Details of the connected incidents.
`malwares_data`	Array of Objects	Details of the connected malware.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.

Response Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the action component:

{{base-url}}/openapi/v1/forms/fields/?object_identifier=action\n\n

Following are some of the sample custom fields for actions:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type
`case_description`	String
`exception_details`	String

Do not change the parameter value\nAllows you to create actions using the values of assigned groups, labels and the email IDs of assigned users.

\n","type":"text/plain"},"key":"values","value":"readable_type"}],"variable":[]}},"response":[{"id":"45b3c8c9-9699-445c-b3e2-5ccdfbafc346","name":"201 Created: Create Action","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"case_description\": \"IP to be blocked\",\n \"exception_details\": \"Internal IP and subnet to be excluded\",\n \"itsm_req_ticket_no\": \"ITS638\",\n \"servicenow_request_ticket_id\": \"SNOW8989\",\n \"return_to_soc_reason\": \"More IPs to be included\",\n \"title\": \"Block IPs on Firewall\",\n \"description\": \"Malicious IPs from Logs needs to be blocked on firewall\",\n \"assigned_to\": \"jane.doe@example.com\",\n \"assigned_group\": \"SOC L1 Analyst Group\",\n \"status\": \"open\",\n \"priority\": \"High\",\n \"type\": \"Mitigation\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/action/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","host":["{{base_url}}v1"],"path":["action",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"values","value":"readable_type","description":"**Do not change the parameter value**\nAllows you to create actions using the values of assigned groups, labels and the email IDs of assigned users."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 28 Jan 2022 08:06:21 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"2449","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"case_description\": \"IP to be blocked\",\n \"exception_details\": \"Internal IP and subnet to be excluded\",\n \"itsm_req_ticket_no\": \"ITS638\",\n \"servicenow_request_ticket_id\": \"SNOW8989\",\n \"return_to_soc_reason\": null,\n \"title\": \"Block IPs on Firewall\",\n \"description\": \"Malicious IPs from Logs needs to be blocked on firewall\",\n \"assigned_to\": \"be43156f-97f3-48d4-be8b-3b533574efed\",\n \"assigned_group\": \"776a0b27-83b8-4819-835f-2f0bfda5001d\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"776a0b27-83b8-4819-835f-2f0bfda5001d\",\n \"group_name\": \"SOC L1 Analyst Group\"\n },\n \"unique_id\": \"aeb94dbf-5714-4b46-b185-8b2484f52a2a\",\n \"assigned_to_data\": {\n \"username\": \"jane.doe\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"be43156f-97f3-48d4-be8b-3b533574efed\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"created_by_data\": {\n \"username\": \"peter.smith\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"cd86b10d-b49d-40eb-983d-3714ef36f726\",\n \"is_active\": true,\n \"email\": \"peter.smith@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"readable_id\": \"ACT7873\",\n \"status\": \"open\",\n \"created\": \"2022-01-28T08:06:20.343113Z\",\n \"briefings_data\": [],\n \"campaigns_data\": [],\n \"incidents_data\": null,\n \"modified\": \"2022-01-28T08:06:20.495716Z\",\n \"can_update_instance\": true,\n \"ioc_set_data\": [],\n \"is_bookmarked\": false,\n \"malwares_data\": [],\n \"total_ownership_duration\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 0,\n \"seconds\": 0\n },\n \"vulnerabilities_data\": [],\n \"attachments_data\": [],\n \"threat_actors_data\": [],\n \"closed_by_data\": null,\n \"closed_on\": null,\n \"resolved_on\": null,\n \"title_display\": \"Block IPs on Firewall\",\n \"labels\": [],\n \"labels_data\": [],\n \"applications\": [],\n \"applications_data\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"users\": [],\n \"users_data\": [],\n \"softwares\": [],\n \"softwares_data\": [],\n \"days_spent\": 0,\n \"hours_spent\": 0,\n \"minutes_spent\": 0,\n \"priority\": \"High\",\n \"type\": \"Mitigation\",\n \"knowledge_base_data\": [],\n \"assignment_sla\": null,\n \"resolution_sla\": null,\n \"resolution_due_date\": null,\n \"sla_stopped_on\": null,\n \"priority_data\": {\n \"unique_id\": \"dd990d0a-55c5-4cda-98a0-8c6223a726d5\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"d9792d47-86f6-4662-90c4-104828cf5eb3\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"type_data\": {\n \"unique_id\": \"87441d24-f257-4817-b08c-195a318bc838\",\n \"option_name\": \"Mitigation\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"ddcff70d-b240-4109-a9bb-ab7215aa57fe\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"return_to_soc_reason_data\": null\n}"}],"_postman_id":"20633392-d76f-4319-8de5-ab36f215c240"},{"name":"Update Action Using Field UUID","id":"6c49b366-221f-4c49-a08b-244e784fa9f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}"}],"body":{"mode":"raw","raw":"{\n \"description\": \"IPs to be blocked on firewall, excluding all the internal matching subnet IPs\",\n \"priority\": \"Medium\"\n}"},"url":"{{base_url}}v1/action/:action_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Update the details of an action in the CFTR application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/action/:action_unique_id/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
`title`	String	Optional	Enter a title for the action.
`description`	String	Optional	Enter a description of the action that best describes the key details of the action.
`status`	String	Optional	Enter the status of the action. Allowed values: - Open - Closed Example: \"open\" Default value: \"open\"
`priority`	String	Optional	Enter the priority for the action. Allowed values: - Very Low - Very High - Low - Medium - High Example: \"Low\"
`type`	String	Optional	Enter the action type. Some of the action type values are: - Corrective - Containment - Eradication - Mitigation - Recovery - Remediation Example: \"Corrective\"
`due_date`	String	Optional	Enter the due date of the action.
`exception_details`	String	Optional	Enter the exceptions related to the action.
`assigned_group`	String	Optional	Enter the name of the CFTR user group to assign the action. This action can only be assigned to the members of this user group. You can use the following API endpoint to retrieve the list of User Groups:`/openapi/v1/rest-auth/permission/group/`
`handoff_note`	Object Dictionary String	Optional	Enter a note for the assigned user group or assigned user. Note: Handoff Note is mandatory for updating Assigned Group or Assigned User for an action. The following details must be provided for updating the User Group or User assigned to an action: handoff_note: - description: Content of the handoff note - unique_id: Unique ID of the action - comment_type: Mention \"handoff\" Sample Request handoff_note\":{ \"comment_type\":\"handoff\", \"description\":\"note for assignee\" }

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the action component:

{{base-url}}/openapi/v1/forms/fields/?object_identifier=action\n\n

Following are some of the sample custom fields for actions:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`case_description`	String	Optional
`exception_details`	String	Optional

Response Parameters

Response Parameters | Regulatory Fields

Parameters	Type	Description
`title`	String	The title of the action.
`unique_id`	String	Unique ID of the action.
`created`	String	Created date of the action in EPOCH time format.
`modified`	String	Last modified date of the action in EPOCH time format.
`description`	String	Description of the action.
`assigned_to`	String	`User_id` of the assigned user.
`assigned_to_data`	Object	Details of the assigned user.
`assigned_group`	String	`Group_comm_id` of the assigned user group.
`assigned_group_data`	Object	Details of the assigned user group. Details include: group_comm_id, group_name.
`status`	String	Status of the action.
`readable_id`	String	Readable ID of the action. For example, ACT379.
`created_by_data`	Object	Details of the user who created the action. Details include: username, email ,first name, last name, and so on.
`can_update_instance`	Boolean	Shows whether the instance can be updated by the user who requested it or not.
`is_bookmarked`	Boolean	True: Action is bookmarked. False: Action is not bookmarked.
`closed_by_data`	Object	Details of the user who closed the action. Details include: username, email ,first name, last name, and so on.
`closed_on`	String	Closure date of the action in EPOCH time format.
`resolved_on`	String	Resolved date of the action in EPOCH time format.
`assignment_sla`	String	Details of assignment SLA details of the action. This parameter has two keys: 1. color: Associated color code (according to SLA breach level). 2. data: It has two keys: - sla_duration: SLA Breach time. - elapsed_time: time elapsed between action opening and SLA completion.
`resolution_sla`	String	Details of resolution SLA of the action. This parameter has two keys: 1. color: Associated color code (according to SLA breach level). 2. data: It has two keys: - sla_duration: SLA Breach time. - elapsed_time: time elapsed between action opening and SLA completion.
`resolution_due_date`	String	Resolution due date of the action.
`sla_stopped_on`	String	Date and time at which the SLA stopped for the action.
`type`	String	Type of the action.
`priority`	String	Priority level of the action
`type_data`	Object	Details of the type of the action.
`priority_data`	Object	Details of the priority level of the action.
`created_from_template`	Boolean	Shows if the action is created using a template or not.

Response Parameters | Connect The Dots

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`users`	Array of UUID-4 Strings	Array of UUID-4 strings containing unique IDs of the connected users.
`users_data`	Array of Objects	Details of the connected users.
`endpoints`	Array of UUID-4 Strings	Array of UUID-4 strings containing unique IDs of connected devices.
`endpoints_data`	Array of Objects	Details of the connected devices.
`softwares`	Array of UUID-4 Strings	Array of UUID-4 strings containing unique IDs of connected software.
`softwares_data`	Array of Objects	Details of the connected software.
`applications`	Array of UUID-4 Strings	Array of UUID-4 strings containing unique IDs of connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`incidents_data`	Object	Details of the connected incidents.
`malwares_data`	Array of Objects	Details of the connected malware.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.

Response Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the action component:

{{base-url}}/openapi/v1/forms/fields/?object_identifier=action\n\n

Following are some of the sample custom fields for actions:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type
`case_description`	String
`exception_details`	String

Enter the unique ID of the action in UUID-4 format.

\n","type":"text/plain"},"type":"any","value":"81602ec9-3329-4b9d-a278-2dbb1ce40160","key":"action_unique_id"}]}},"response":[{"id":"16c6c615-4646-41b8-9b7a-762616fecaf8","name":"200 OK: Multiple Fields Update","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"description\": \"IPs to be blocked on firewall, excluding all the internal matching subnet IPs\",\n \"priority\": \"Medium\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/action/:action_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["action",":action_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"action_unique_id","value":"81602ec9-3329-4b9d-a278-2dbb1ce40160","description":"`unique_id` of Action of UUID-4 format"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 28 Jan 2022 08:21:06 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"2477","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"case_description\": \"IP to be blocked\",\n \"exception_details\": \"Internal IP and subnet to be excluded\",\n \"itsm_req_ticket_no\": \"ITS638\",\n \"servicenow_request_ticket_id\": \"SNOW8989\",\n \"return_to_soc_reason\": null,\n \"title\": \"Block IPs on Firewall\",\n \"description\": \"IPs to be blocked on firewall, excluding all the internal matching subnet IPs\",\n \"assigned_to\": \"be43156f-97f3-48d4-be8b-3b533574efed\",\n \"assigned_group\": \"776a0b27-83b8-4819-835f-2f0bfda5001d\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"776a0b27-83b8-4819-835f-2f0bfda5001d\",\n \"group_name\": \"SOC L1 Analyst Group\"\n },\n \"unique_id\": \"81602ec9-3329-4b9d-a278-2dbb1ce40160\",\n \"assigned_to_data\": {\n \"username\": \"jane.doe\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"be43156f-97f3-48d4-be8b-3b533574efed\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"created_by_data\": {\n \"username\": \"jane.doe\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"cd86b10d-b49d-40eb-983d-3714ef36f726\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"readable_id\": \"ACT7873\",\n \"status\": \"open\",\n \"created\": \"2022-01-28T08:06:20.343113Z\",\n \"briefings_data\": [],\n \"campaigns_data\": [],\n \"incidents_data\": null,\n \"modified\": \"2022-01-28T08:21:05.363022Z\",\n \"can_update_instance\": true,\n \"ioc_set_data\": [],\n \"is_bookmarked\": false,\n \"malwares_data\": [],\n \"total_ownership_duration\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 14,\n \"seconds\": 45\n },\n \"vulnerabilities_data\": [],\n \"attachments_data\": [],\n \"threat_actors_data\": [],\n \"closed_by_data\": null,\n \"closed_on\": null,\n \"resolved_on\": null,\n \"title_display\": \"Block IPs on Firewall\",\n \"labels\": [],\n \"labels_data\": [],\n \"applications\": [],\n \"applications_data\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"users\": [],\n \"users_data\": [],\n \"softwares\": [],\n \"softwares_data\": [],\n \"days_spent\": 0,\n \"hours_spent\": 0,\n \"minutes_spent\": 0,\n \"priority\": \"Medium\",\n \"type\": \"Mitigation\",\n \"knowledge_base_data\": [],\n \"assignment_sla\": null,\n \"resolution_sla\": null,\n \"resolution_due_date\": null,\n \"sla_stopped_on\": null,\n \"priority_data\": {\n \"unique_id\": \"240daa73-a2fd-4e52-85b4-4ad159ff5022\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"d9792d47-86f6-4662-90c4-104828cf5eb3\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"type_data\": {\n \"unique_id\": \"87441d24-f257-4817-b08c-195a318bc838\",\n \"option_name\": \"Mitigation\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"ddcff70d-b240-4109-a9bb-ab7215aa57fe\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"return_to_soc_reason_data\": null\n}"}],"_postman_id":"6c49b366-221f-4c49-a08b-244e784fa9f0"},{"name":"Get Comments from Action","id":"e411d448-2bc0-4e01-a237-2e2d04f70ee2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/comments/action/:action_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve a list of comments from an action.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
count	Integer	Number of comments added in an action.
unique_id	String	Unique ID of the comment.
description	Text	Content of the comment.
created_by	Object	Details of the user who added the comment.
modified_by	Object	Details of the user who last updated the comment.
mentioned_users	List of UUID	List of `user_id` of users mentioned in the comment.
mentioned_users_data	List of Objects	Details of the users mentioned in the comment.
created	Datetime	Comment creation time.
modified	Datetime	Comment last updated time.
comment_type	String	Type of Comment. Examples: `discussion`: Notes added in an action. `handoff`: Handoff notes added while updating the assignee or assigned group. `closure`: Closure Notes added while closing an action.
content_object	String	Component in which the comment is added. Example: `incident`, `action`, `ioc`, and so on.
content_object_readable_id	String	`readable_id` of the action in which comment is added.
content_object_unique_id	String	`unique_id` of the action in which comment is added.
description_with_img_src	Text	Content of the content with the image URLs (if any image is added in the comment).
pinned	Boolean	Shows if the comment is pinned or not.

","urlObject":{"path":["comments","action",":action_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"disabled":true,"description":{"content":"

[Optional] Enter the group_comm_id of a user group to get all comments added by the users of the user group in an action.

\n","type":"text/plain"},"key":"user_group","value":"f8238640-e36a-4d1c-bef2-ef6658c69d3e"},{"disabled":true,"description":{"content":"

[Optional] Enter the type of comment. \nAllowed values:\ndiscussion\nhandoff\nclosure

\n","type":"text/plain"},"key":"type","value":"handoff"},{"disabled":true,"description":{"content":"

[Optional] Enter the unique_id of a user to get the comments added by the user.

\n","type":"text/plain"},"key":"created_by","value":"5c4fbd5d-78da-4a4c-93b2-f3a89e269b53"}],"variable":[{"description":{"content":"

Enter the unique_id of an action.

\n","type":"text/plain"},"type":"any","value":"bbc5debc-1f24-4e73-b620-4b1dc0ecdddb","key":"action_unique_id"}]}},"response":[{"id":"627fc562-0d04-40df-8704-9ab53b0ab7cd","name":"Get Comments from Action","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/comments/action/:action_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["comments","action",":action_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"user_group","value":"f8238640-e36a-4d1c-bef2-ef6658c69d3e","description":"[Optional] Enter the `group_comm_id` of a user group to get all comments added by the users of the user group in an action.","disabled":true},{"key":"type","value":"handoff","description":"[Optional] Enter the type of comment. \nAllowed values:\ncommand\ndiscussion\nhandoff\nclosure","disabled":true},{"key":"created_by","value":"5c4fbd5d-78da-4a4c-93b2-f3a89e269b53","description":"[Optional] Enter the `unique_id` of a user to get the comments added by the user.","disabled":true}],"variable":[{"key":"action_unique_id","value":"bbc5debc-1f24-4e73-b620-4b1dc0ecdddb","description":"Enter the unique_id of an action."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 25 Apr 2023 05:42:34 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 4,\n \"results\": [\n {\n \"unique_id\": \"d93afc1c-3ce0-44d7-aa94-0af940fd4519\",\n \"description\": \"

IP blocked.

\",\n \"created_by\": {\n \"user_id\": \"b2fb8caf-1073-44b3-937d-ab4eba8af7c5\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@cyware.com\",\n \"display_pic\": null,\n \"username\": \"john.doe\",\n \"profile_background_color\": \"#A0887E\",\n \"is_active\": true,\n \"full_name\": \"John Doe\"\n },\n \"modified_by\": null,\n \"is_removed\": false,\n \"mentioned_users\": [],\n \"mentioned_users_data\": [],\n \"created\": \"2023-04-25T05:42:00.622775Z\",\n \"modified\": \"2023-04-25T05:42:00.645053Z\",\n \"email\": null,\n \"internal\": false,\n \"comment_type\": \"discussion\",\n \"command_params\": {},\n \"command_result\": {},\n \"command_status\": \"na\",\n \"attachments_data\": [],\n \"content_object\": \"action\",\n \"content_object_readable_id\": \"ACT18757\",\n \"content_object_unique_id\": \"bbc5debc-1f24-4e73-b620-4b1dc0ecdddb\",\n \"attachment_label\": null,\n \"description_with_img_src\": \"

IP blocked.

\",\n \"pinned\": false,\n \"field\": null,\n \"note_tag\": null\n },\n {\n \"unique_id\": \"5ec74e56-29ee-45a0-b5d8-f8ef01cbdf40\",\n \"description\": \"Need more information on the IP address.\",\n \"created_by\": {\n \"user_id\": \"b2fb8caf-1073-44b3-937d-ab4eba8af7c5\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@cyware.com\",\n \"display_pic\": null,\n \"username\": \"john.doe\",\n \"profile_background_color\": \"#A0887E\",\n \"is_active\": true,\n \"full_name\": \"John Doe\"\n },\n \"modified_by\": null,\n \"is_removed\": false,\n \"mentioned_users\": [],\n \"mentioned_users_data\": [],\n \"created\": \"2023-04-25T05:41:34.092750Z\",\n \"modified\": \"2023-04-25T05:41:34.106485Z\",\n \"email\": null,\n \"internal\": false,\n \"comment_type\": \"handoff\",\n \"command_params\": {},\n \"command_result\": {},\n \"command_status\": \"na\",\n \"attachments_data\": [],\n \"content_object\": \"action\",\n \"content_object_readable_id\": \"ACT18757\",\n \"content_object_unique_id\": \"bbc5debc-1f24-4e73-b620-4b1dc0ecdddb\",\n \"attachment_label\": null,\n \"description_with_img_src\": \"Need more information on the IP address.\",\n \"pinned\": false,\n \"field\": null,\n \"note_tag\": null\n },\n {\n \"unique_id\": \"83b5ce07-dbf1-45d5-801f-3e65661bc30d\",\n \"description\": \"Block the IP address mentioned in the description.\",\n \"created_by\": {\n \"user_id\": \"b2fb8caf-1073-44b3-937d-ab4eba8af7c5\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@cyware.com\",\n \"display_pic\": null,\n \"username\": \"john.doe\",\n \"profile_background_color\": \"#A0887E\",\n \"is_active\": true,\n \"full_name\": \"John Doe\"\n },\n \"modified_by\": null,\n \"is_removed\": false,\n \"mentioned_users\": [],\n \"mentioned_users_data\": [],\n \"created\": \"2023-04-25T05:40:57.742944Z\",\n \"modified\": \"2023-04-25T05:40:57.757351Z\",\n \"email\": null,\n \"internal\": false,\n \"comment_type\": \"handoff\",\n \"command_params\": {},\n \"command_result\": {},\n \"command_status\": \"na\",\n \"attachments_data\": [],\n \"content_object\": \"action\",\n \"content_object_readable_id\": \"ACT18757\",\n \"content_object_unique_id\": \"bbc5debc-1f24-4e73-b620-4b1dc0ecdddb\",\n \"attachment_label\": null,\n \"description_with_img_src\": \"Block the IP address mentioned in the description.\",\n \"pinned\": false,\n \"field\": null,\n \"note_tag\": null\n },\n {\n \"unique_id\": \"ce95499b-b8b6-4232-ab29-b3474a5ca383\",\n \"description\": \"

This attachment shows the details of the Ip address.

\",\n \"created_by\": {\n \"user_id\": \"b2fb8caf-1073-44b3-937d-ab4eba8af7c5\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@cyware.com\",\n \"display_pic\": null,\n \"username\": \"john.doe\",\n \"profile_background_color\": \"#A0887E\",\n \"is_active\": true,\n \"full_name\": \"John Doe\"\n },\n \"modified_by\": null,\n \"is_removed\": false,\n \"mentioned_users\": [],\n \"mentioned_users_data\": [],\n \"created\": \"2023-04-25T05:40:08.921120Z\",\n \"modified\": \"2023-04-25T05:40:08.932618Z\",\n \"email\": null,\n \"internal\": false,\n \"comment_type\": \"discussion\",\n \"command_params\": {},\n \"command_result\": {},\n \"command_status\": \"na\",\n \"attachments_data\": [],\n \"content_object\": \"file\",\n \"content_object_readable_id\": \"ART4259\",\n \"content_object_unique_id\": \"210d2458-a254-450b-8497-4fe4a9f1c75e\",\n \"attachment_label\": \"Action\",\n \"description_with_img_src\": \"

This attachment shows the details of the Ip address.

\",\n \"pinned\": false,\n \"field\": null,\n \"note_tag\": null\n }\n ]\n}"}],"_postman_id":"e411d448-2bc0-4e01-a237-2e2d04f70ee2"},{"name":"Update Action Using Field Values","id":"2be1beb0-275e-4345-bc1c-3554283a8274","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"assigned_group\": \"Automated2024-01-29 22:18:27.481852\",\n \"status\": \"open\",\n \"priority\": \"High\",\n \"type\": \"Mitigation\",\n \"labels\": [\"Machine Down\"]\n}"},"url":"{{base_url}}v1/action/:action_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","description":"

Update the details of an action in the CFTR application using the values of assigned groups, labels, and the email IDs of assigned user.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/action/:action_unique_id/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
`title`	String	Optional	Enter a title for the action.
`description`	String	Optional	Enter a description of the action that best describes the key details of the action.
`status`	String	Optional	Enter the status of the action. Allowed values: - Open - Closed Example: \"open\" Default value: \"open\"
`priority`	String	Optional	Enter the priority for the action. Allowed values: - Very Low - Very High - Low - Medium - High Example: \"Low\"
`type`	String	Optional	Enter the action type. Some of the action type values are: - Corrective - Containment - Eradication - Mitigation - Recovery - Remediation Example: \"Corrective\"
`due_date`	String	Optional	Enter the due date of the action.
`exception_details`	String	Optional	Enter the exceptions related to the action.
`assigned_group`	String	Optional	Enter the name of the CFTR user group to assign the action. This action can only be assigned to the members of this user group. You can use the following API endpoint to retrieve the list of User Groups:`/openapi/v1/res-tauth/permission/group/`
`handoff_note`	Object Dictionary String	Optional	Enter a note for the assigned user group or assigned user. Note: Handoff Note is mandatory for updating Assigned Group or Assigned User for an action. The following details must be provided for updating the User Group or User assigned to an action: handoff_note: - description: Content of the handoff note - unique_id: Unique ID of the action - comment_type: Mention \"handoff\" Sample Request handoff_note\":{ \"comment_type\":\"handoff\", \"description\":\"note for assignee\" }
`assigned_to`	String	Optional	Enter the email ID of the user to assign the action. You can use the following API endpoint to retrieve the list of users: `/openapi/v1/rest-auth/user/`
`labels`	List	Optional	Enter the list of names of the labels to be added to the action. You can use the following API endpoint to retrieve the list of Labels: `/openapi/v1/utils/label/`

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the action component:

{{base-url}}/openapi/v1/forms/fields/?object_identifier=action\n\n

Following are some of the sample custom fields for actions:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`case_description`	String	Optional
`exception_details`	String	Optional

Response Parameters

Response Parameters | Regulatory Fields

Parameters	Type	Description
`title`	String	The title of the action.
`unique_id`	String	Unique ID of the action.
`created`	String	Created date of the action in EPOCH time format.
`modified`	String	Last modified date of the action in EPOCH time format.
`description`	String	Description the an action.
`assigned_to`	String	`User_id` of the assigned user.
`assigned_to_data`	Object	Details of the assigned user.
`assigned_group`	String	`Group_comm_id` of the assigned user group.
`assigned_group_data`	Object	Details of the assigned user group.
`status`	String	Status of the action.
`readable_id`	String	Readable ID of the action. For example, ACT379
`created_by_data`	Object	Details of the user who created the action. Details include: username, email ,first name, last name, and so on.
`can_update_instance`	Boolean	Shows whether the instance can be updated by the user who requested it or not.
`is_bookmarked`	Boolean	True: Action is bookmarked. False: Action is not bookmarked.
`closed_by_data`	Object	Details of the user who closed the action. Details include: username, email ,first name, last name, and so on.
`closed_on`	String	Closure date of the action in EPOCH time format.
`resolved_on`	String	Resolved date of the action in EPOCH time format.
`assignment_sla`	String	Details of assignment SLA details of the action. This parameter has two keys: 1. color: Associated color code (according to SLA breach level). 2. data: It has two keys: - sla_duration: SLA Breach time. - elapsed_time: time elapsed between action opening and SLA completion.
`resolution_sla`	String	Details of resolution SLA of the action. This parameter has two keys: 1. color: Associated color code (according to SLA breach level). 2. data: It has two keys: - sla_duration: SLA Breach time. - elapsed_time: time elapsed between action opening and SLA completion.
`resolution_due_date`	String	Resolution due date of the action.
`sla_stopped_on`	String	Date and time at which the SLA stopped for the action.
`type`	String	Type of the action.
`priority`	String	Priority level of the action
`type_data`	Object	Details of the type of the action.
`priority_data`	Object	Details of the priority level of the action.
`created_from_template`	Boolean	Shows if the action is created using a template.

Response Parameters | Connect The Dots

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`users`	Array of UUID-4 Strings	Array of UUID-4 strings containing unique IDs of the connected users.
`users_data`	Array of Objects	Details of the connected users.
`endpoints`	Array of UUID-4 Strings	Array of UUID-4 strings containing unique IDs of connected devices.
`endpoints_data`	Array of Objects	Details of the connected devices.
`softwares`	Array of UUID-4 Strings	Array of UUID-4 strings containing unique IDs of connected software.
`softwares_data`	Array of Objects	Details of the connected software.
`applications`	Array of UUID-4 Strings	Array of UUID-4 strings containing unique IDs of connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`incidents_data`	Object	Details of the connected incidents.
`malwares_data`	Array of Objects	Details of the connected malware.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.

Response Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the action component:

{{base-url}}/openapi/v1/forms/fields/?object_identifier=action\n\n

Following are some of the sample custom fields for actions:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type
`case_description`	String
`exception_details`	String

Do not change the parameter value\nAllows you to update actions using the values of assigned groups, labels and the email IDs of assigned users.

\n","type":"text/plain"},"key":"values","value":"readable_type"}],"variable":[{"description":{"content":"

Enter the unique ID of the action in UUID-4 format.

\n","type":"text/plain"},"type":"any","value":"a7fec671-378c-4505-aa08-3c2cff6ae763","key":"action_unique_id"}]}},"response":[{"id":"2c69b741-780e-459e-aa28-b65cbdd4aa8d","name":"200 OK: Description Updated","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"","value":"","disabled":true}],"body":{"mode":"raw","raw":"{ \n \"assigned_to\": \"jane.doe@example.com\",\n \"assigned_group\": \"SOC L1 Analyst Group\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/action/:action_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","host":["{{base_url}}v1"],"path":["action",":action_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"values","value":"readable_type","description":"**Do not change the parameter value**\nAllows you to update actions using the values of assigned groups, labels and the email IDs of assigned users."}],"variable":[{"key":"action_unique_id","value":"81602ec9-3329-4b9d-a278-2dbb1ce40160","description":"`unique_id` of Action of UUID-4 format"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 28 Jan 2022 08:19:49 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"2473","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Server","value":"nginx","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"case_description\": \"IP to be blocked\",\n \"exception_details\": \"Internal IP and subnet to be excluded\",\n \"itsm_req_ticket_no\": \"ITS638\",\n \"servicenow_request_ticket_id\": \"SNOW8989\",\n \"return_to_soc_reason\": null,\n \"title\": \"Block IPs on Firewall\",\n \"description\": \"IPs to be blocked on firewall, excluding all the internal matching subnet IPs\",\n \"assigned_to\": \"be43156f-97f3-48d4-be8b-3b533574efed\",\n \"assigned_group\": \"776a0b27-83b8-4819-835f-2f0bfda5001d\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"776a0b27-83b8-4819-835f-2f0bfda5001d\",\n \"group_name\": \"SOC L1 Analyst Group\"\n },\n \"unique_id\": \"81602ec9-3329-4b9d-a278-2dbb1ce40160\",\n \"assigned_to_data\": {\n \"username\": \"jane.doe\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"be43156f-97f3-48d4-be8b-3b533574efed\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n },\n \"created_by_data\": {\n \"username\": \"peter.smith\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"cd86b10d-b49d-40eb-983d-3714ef36f726\",\n \"is_active\": true,\n \"email\": \"peter.smith@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"readable_id\": \"ACT7873\",\n \"status\": \"open\",\n \"created\": \"2022-01-28T08:06:20.343113Z\",\n \"briefings_data\": [],\n \"campaigns_data\": [],\n \"incidents_data\": null,\n \"modified\": \"2022-01-28T08:19:48.808813Z\",\n \"can_update_instance\": true,\n \"ioc_set_data\": [],\n \"is_bookmarked\": false,\n \"malwares_data\": [],\n \"total_ownership_duration\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 13,\n \"seconds\": 28\n },\n \"vulnerabilities_data\": [],\n \"attachments_data\": [],\n \"threat_actors_data\": [],\n \"closed_by_data\": null,\n \"closed_on\": null,\n \"resolved_on\": null,\n \"title_display\": \"Block IPs on Firewall\",\n \"labels\": [],\n \"labels_data\": [],\n \"applications\": [],\n \"applications_data\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"users\": [],\n \"users_data\": [],\n \"softwares\": [],\n \"softwares_data\": [],\n \"days_spent\": 0,\n \"hours_spent\": 0,\n \"minutes_spent\": 0,\n \"priority\": \"High\",\n \"type\": \"Mitigation\",\n \"knowledge_base_data\": [],\n \"assignment_sla\": null,\n \"resolution_sla\": null,\n \"resolution_due_date\": null,\n \"sla_stopped_on\": null,\n \"priority_data\": {\n \"unique_id\": \"dd990d0a-55c5-4cda-98a0-8c6223a726d5\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"d9792d47-86f6-4662-90c4-104828cf5eb3\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"type_data\": {\n \"unique_id\": \"87441d24-f257-4817-b08c-195a318bc838\",\n \"option_name\": \"Mitigation\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"ddcff70d-b240-4109-a9bb-ab7215aa57fe\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"return_to_soc_reason_data\": null\n}"}],"_postman_id":"2be1beb0-275e-4345-bc1c-3554283a8274"},{"name":"Upload a File","id":"1df69f5b-5290-4366-8019-78875c781ed9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"uploaded_file","type":"file","src":"/Users/aashijain/Downloads/ZiClJf-1920w.jpeg"},{"key":"file_type","value":"artifact","type":"text"}]},"url":"{{base_url}}v1/utils/file/action/:action_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Upload any type of file as an attachment in an action.

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`uploaded_file`	File	Mandatory	Enter the file to be uploaded.
`file_type`	String	Optional	Enter the type of File. Allowed values: `artifact`: Artifact `evidence`: Evidence `miscellaneous`: Miscellaneous Default value: `artifact`

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	Text	Name of the file.
`description`	Text	Description of the file.
`uploaded_file`	URL	URL of the file from where it can be downloaded.
`unique_id`	String	Unique ID for the file.
`created_by_data`	Object	Details of the user who uploaded the file.
`created`	String	File upload time in EPOCH time format.
`modified`	String	File modified time in EPOCH time format.
`readable_id`	String	Unique readable ID of the file. For example, ART282
`file_hash`	String	Hash of the file.
`file_type`	String	Type of the file. Allowed values: `artifact`: Artifact `evidence`: Evidence `miscellaneous`: Miscellaneous
`file_size`	Integer	Size of the file.
`can_delete`	Boolean	Shows if the file can be deleted or not.
`parent_readable_id`	String	`readable_id` of the component in which the file is uploaded.
`parent_component`	String	Component name in which the file is uploaded. Example: `incident`, `action`, etc.
`parent_unique_id`	String	`unique_id` of the component in which the file is uploaded.

","urlObject":{"path":["utils","file","action",":action_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the action in UUID-4 format.

\n","type":"text/plain"},"type":"any","value":" ","key":"action_unique_id"}]}},"response":[{"id":"1259ad60-23f5-4d8c-9f5c-56f6e87b4c97","name":"Upload a File","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"uploaded_file","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/Users/aashijain/Downloads/ZiClJf-1920w.jpeg"],"src":"New creds to test api.csv"},{"key":"file_type","value":"artifact","type":"text"}]},"url":{"raw":"{{base_url}}v1/utils/file/action/:action_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["utils","file","action",":action_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"action_unique_id","value":"983a8175-e3a1-4fe1-8536-537bdc7cce82","description":"Enter the unique ID of the action in UUID-4 format."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 07 Jan 2024 19:12:06 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1423","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true}],"cookie":[],"responseTime":null,"body":"[\n {\n \"title\": \"New creds to test api.csv\",\n \"description\": null,\n \"uploaded_file\": \"https://qa.cywareqa.com/cftrbucket/ciims-data/eb092b26-New_creds_to_test_api.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minio%2F20240107%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240107T191206Z&X-Amz-Expires=120&X-Amz-SignedHeaders=host&X-Amz-Signature=ddf300cd50221934fa1d77a9ea41d2947e10b07a48398293901bb118142f5c74\",\n \"unique_id\": \"74707c22-2361-418b-a5cc-bd6649fec7b7\",\n \"created_by_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System-super\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5c1b579e-4f14-4ab9-a950-7631d1f01b0c\",\n \"display_pic\": \"https://qa.cywareqa.com/cftrbucket/profile-pics/system.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minio%2F20240107%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240107T191206Z&X-Amz-Expires=120&X-Amz-SignedHeaders=host&X-Amz-Signature=28f955b6a1fb71e08e600833b764839427a1edbebe316b5853c13044619c4c87\",\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System-super Default\"\n },\n \"created\": \"2024-01-07T19:12:05.034091Z\",\n \"modified\": \"2024-01-07T19:12:05.260782Z\",\n \"readable_id\": \"ART4427\",\n \"is_removed\": false,\n \"readable_id_counter\": 4427,\n \"file_hash\": \"2c3addd1f514ef7f07bcb4e64ec1b098\",\n \"file_type\": \"artifact\",\n \"file_size\": 164,\n \"can_delete\": true,\n \"parent_readable_id\": \"ACT18765\",\n \"parent_component\": \"action\",\n \"parent_unique_id\": \"983a8175-e3a1-4fe1-8536-537bdc7cce82\"\n }\n]"}],"_postman_id":"1df69f5b-5290-4366-8019-78875c781ed9"}],"id":"dbe58546-26e8-4b54-a853-6e389b4e59f2","description":"

The Actions are steps taken by security team members for responding to threats for containment or proactive prevention or for remediating any damage discovered in any phase of the Incident Response process.

This section describes how to use the API endpoints to manage actions in the CFTR application.

\n","_postman_id":"dbe58546-26e8-4b54-a853-6e389b4e59f2"},{"name":"Devices","item":[{"name":"Get List of Devices","id":"52724b89-c280-4aea-a596-604cb5f49457","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/device/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the details of all the devices in CFTR Application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/action/:action_unique_id/?

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` key shows the API endpoint to the next page.
`count`	Integer	The total number of devices returned as per the entered query parameters.
`results`	List of Objects	Details of the devices. Each object provides the details of one device.

Response Parameters | Results Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the device.
`created`	String	Created date of the device in EPOCH time format.
`modified`	String	Last Updated date of the device in EPOCH time format.
`serial_number`	String	Serial Number of the device.
`hostname`	String	Hostname of the device.
`readable_id`	String	Readable ID of the device. Example, DVC116
`labels`	List	List of the labels that are added to the device.
`labels_data`	List of Objects	Details of labels added to the device. The details include: `title`, `unique_id`, `color_code`, and so on.
`ip_address`	String	IP Address of the device.
`title_display`	String	Hostname of the device.
`endpoint_status`	String	Status of the device.
`threat_score`	Float	Risk Score of the device.

[optional] Enter the page number of the device list. This will retrieve the list of all device from the entered page.

Default value: 1

\n","type":"text/plain"},"key":"page","value":"2"},{"disabled":true,"description":{"content":"

[optional] Number of devices per page.\nDefault value: 10

\n","type":"text/plain"},"key":"page_size","value":"15"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID of the business unit. This parameter retrieves the devices associated with the business unit.

You can retrieve the list of available Business Units and their Unique IDs using the following API endpoint:

/openapi/v1/utils/business-unit/

\n","type":"text/plain"},"key":"business_units","value":"9750d6df-2d7f-4899-b20d-bfbba0a9084d"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the devices in EPOCH Time format.\nTime Zone must be as per UTC. All devices with creation date later than the entered time will be returned.

\n","type":"text/plain"},"key":"created_date__gte","value":"1643999399"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the devices in EPOCH Time format.\nTime Zone must be as per UTC. All devices with creation date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"created_date__lte","value":"1643999399"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID of the label. This parameter retrieves the devices associated with the label.\nYou can retrieve the list of available Labels and their Unique IDs using the following API endpoint:\n/openapi/v1/utils/label/

\n","type":"text/plain"},"key":"labels","value":"c741bd45-1825-4dba-a30f-66088dcbbf8d"},{"disabled":true,"description":{"content":"

[optional] Enter the last modified time of the devices in EPOCH Time format.\nTime Zone must be as per UTC. All devices with modified date later than the entered time will be returned.

\n","type":"text/plain"},"key":"modified_date__gte","value":"1643999399"},{"disabled":true,"description":{"content":"

[optional] Enter the last modified time of the devices in EPOCH Time format.\nTime Zone must be as per UTC. All devices with modified date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"modified_date__lte","value":"1643999399"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID of the location. This parameter retrieves the devices associated with the location..\nYou can retrieve the list of available Locations and their Unique IDs using the following API endpoint:\n/openapi/v1/utils/location/

\n","type":"text/plain"},"key":"locations","value":"671961e6-0119-460c-8d55-9b697f6e2d6e"},{"disabled":true,"description":{"content":"

[optional] Enter the status of the devices to filter response results. \nAllowed values:\nclean, suspected, infected, quarantined, remediation_in_progress, remediated

\n","type":"text/plain"},"key":"endpoint_status","value":"clean"}],"variable":[]}},"response":[{"id":"d4389c88-ddb9-4760-bca7-3eebeb637356","name":"Get List of Devices","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/device/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["device",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Tue, 01 Feb 2022 11:05:50 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"4111","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {\n \"next\": \"openapi/v1/device/?page=2&page_size=10&AccessID=769b74b8-23af-4abb-a99f-952ca699ac2c&Expires=1643713564&Signature=OaLiJBzpo46wKX5gcqjiejsgyJg=\"\n },\n \"count\": 1120,\n \"results\": [\n {\n \"unique_id\": \"fb114af7-73a7-472d-b655-23a484107b22\",\n \"created\": \"2021-12-19T12:43:29.499734Z\",\n \"modified\": \"2022-02-01T07:40:10.036330Z\",\n \"serial_number\": \"1234\",\n \"hostname\": \"Device created for demo purpose 1\",\n \"readable_id\": \"DVC1220\",\n \"labels\": [\n \"c741bd45-1825-4dba-a30f-66088dcbbf8d\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"c741bd45-1825-4dba-a30f-66088dcbbf8d\",\n \"title\": \"L1\",\n \"color_code\": \"#827717\",\n \"created\": \"2022-02-01T07:38:20.601410Z\",\n \"modified\": \"2022-02-01T07:38:20.601410Z\"\n }\n ],\n \"ip_address\": \"1.1.1.1\",\n \"title_display\": \"Device created for demo purpose 1\",\n \"endpoint_status\": \"clean\",\n \"threat_score\": null\n },\n {\n \"unique_id\": \"fe8b9369-c1be-4990-8305-d3175f052993\",\n \"created\": \"2021-12-18T12:43:29.499734Z\",\n \"modified\": \"2021-12-20T12:47:21.441152Z\",\n \"serial_number\": null,\n \"hostname\": \"Device created for demo purpose 3\",\n \"readable_id\": \"DVC1219\",\n \"labels\": [],\n \"labels_data\": [],\n \"ip_address\": null,\n \"title_display\": \"Device created for demo purpose 3\",\n \"endpoint_status\": \"clean\",\n \"threat_score\": null\n },\n {\n \"unique_id\": \"3afacfba-aaa2-45dc-89c2-7aafbdecb468\",\n \"created\": \"2021-12-18T12:43:29.499734Z\",\n \"modified\": \"2021-12-20T12:47:21.097670Z\",\n \"serial_number\": null,\n \"hostname\": \"Device created for demo purpose 2\",\n \"readable_id\": \"DVC1218\",\n \"labels\": [],\n \"labels_data\": [],\n \"ip_address\": null,\n \"title_display\": \"Device created for demo purpose 2\",\n \"endpoint_status\": \"clean\",\n \"threat_score\": null\n },\n {\n \"unique_id\": \"d2f6cb54-4114-41c4-8625-bc2bf56e3686\",\n \"created\": \"2021-12-18T12:43:29.499734Z\",\n \"modified\": \"2021-12-20T12:47:20.789347Z\",\n \"serial_number\": null,\n \"hostname\": \"Device created for demo purpose 1\",\n \"readable_id\": \"DVC1217\",\n \"labels\": [],\n \"labels_data\": [],\n \"ip_address\": null,\n \"title_display\": \"Device created for demo purpose 1\",\n \"endpoint_status\": \"clean\",\n \"threat_score\": null\n },\n {\n \"unique_id\": \"9a29c5c8-917b-4f46-bc00-a2d728b8045c\",\n \"created\": \"2021-12-17T12:43:29.499734Z\",\n \"modified\": \"2021-12-20T12:47:20.452066Z\",\n \"serial_number\": null,\n \"hostname\": \"Device created for demo purpose 3\",\n \"readable_id\": \"DVC1216\",\n \"labels\": [],\n \"labels_data\": [],\n \"ip_address\": null,\n \"title_display\": \"Device created for demo purpose 3\",\n \"endpoint_status\": \"clean\",\n \"threat_score\": null\n },\n {\n \"unique_id\": \"0b8a59d1-f7de-4e39-a42e-809dda4170a2\",\n \"created\": \"2021-12-17T12:43:29.499734Z\",\n \"modified\": \"2021-12-20T12:47:20.104819Z\",\n \"serial_number\": null,\n \"hostname\": \"Device created for demo purpose 2\",\n \"readable_id\": \"DVC1215\",\n \"labels\": [],\n \"labels_data\": [],\n \"ip_address\": null,\n \"title_display\": \"Device created for demo purpose 2\",\n \"endpoint_status\": \"clean\",\n \"threat_score\": null\n },\n {\n \"unique_id\": \"103ab0f2-4765-487e-a833-1e3469b06df2\",\n \"created\": \"2021-12-17T12:43:29.499734Z\",\n \"modified\": \"2021-12-20T12:47:19.585186Z\",\n \"serial_number\": null,\n \"hostname\": \"Device created for demo purpose 1\",\n \"readable_id\": \"DVC1214\",\n \"labels\": [],\n \"labels_data\": [],\n \"ip_address\": null,\n \"title_display\": \"Device created for demo purpose 1\",\n \"endpoint_status\": \"clean\",\n \"threat_score\": null\n },\n {\n \"unique_id\": \"2c971f20-2a96-40cc-b4e3-d3a06b90ab66\",\n \"created\": \"2021-12-16T12:43:29.499734Z\",\n \"modified\": \"2021-12-20T12:47:19.070925Z\",\n \"serial_number\": null,\n \"hostname\": \"Device created for demo purpose 3\",\n \"readable_id\": \"DVC1213\",\n \"labels\": [],\n \"labels_data\": [],\n \"ip_address\": null,\n \"title_display\": \"Device created for demo purpose 3\",\n \"endpoint_status\": \"clean\",\n \"threat_score\": null\n },\n {\n \"unique_id\": \"c8814d57-61ba-4177-9d4c-1da1eb511f43\",\n \"created\": \"2021-12-16T12:43:29.499734Z\",\n \"modified\": \"2021-12-20T12:47:18.547937Z\",\n \"serial_number\": null,\n \"hostname\": \"Device created for demo purpose 2\",\n \"readable_id\": \"DVC1212\",\n \"labels\": [],\n \"labels_data\": [],\n \"ip_address\": null,\n \"title_display\": \"Device created for demo purpose 2\",\n \"endpoint_status\": \"clean\",\n \"threat_score\": null\n },\n {\n \"unique_id\": \"cd68bf07-d058-42a5-837a-22cc104c2d3d\",\n \"created\": \"2021-12-16T12:43:29.499734Z\",\n \"modified\": \"2021-12-20T12:47:18.218042Z\",\n \"serial_number\": null,\n \"hostname\": \"Device created for demo purpose 1\",\n \"readable_id\": \"DVC1211\",\n \"labels\": [],\n \"labels_data\": [],\n \"ip_address\": null,\n \"title_display\": \"Device created for demo purpose 1\",\n \"endpoint_status\": \"clean\",\n \"threat_score\": null\n }\n ]\n}"}],"_postman_id":"52724b89-c280-4aea-a596-604cb5f49457"},{"name":"Get Details of a Device","id":"52cf39b3-afdf-4935-b123-63e663236431","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/device/:device_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the details of a device in the CFTR application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/action/:action_unique_id/?

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

Response Parameters | Regulatory Fields

Parameter	Type	Description
`unique_id`	String	Unique ID of the device.
`created`	String	Device creation time in EPOCH time format.
`modified`	String	Device Last Updated Time in EPOCH time format.
`serial_number`	String	Serial number of the device.
`hostname`	String	Hostname of the device.
`readable_id`	String	Readable ID of the device. For example, DVC116.
`endpoint_status`	String	Current status of the device.
`owner`	String	Owner of the device.
`physical_location`	String	Physical location of the device.
`title_display`	String	Hostname of the device
`ip_address`	Float	IP address of the device.
`created_by`	String	`user_id` of the user who created the device.
`created_by_data`	Object	Details of user who created the device. Details include: `username`, `first_name`, `last_name, user_id` and more.
`status`	String	Status of the device.
`labels`	List	List of `unique_id` labels that are added to the device.
`labels_data`	List of Objects	Details of the labels that are added to the device.
`business_units_data`	List of Objects	Details of business units that are impacted by the device.
`locations_data`	List of Objects	Details of locations that are impacted by the device.
`risk`	String	Risk level of the device.
`risk_data`	Object	Details of the risk of the device.
`priority`	String	Priority of the device.
`endpoint_type`	String	Type of the endpoint. For example, Desktop.

Response Parameters | Connect The Dots

Following are the response parameters corresponding to the Connect The Dots section of the device. The parameters ending with _data include the meta information for each connected component. The non _data parameters include an array of unique IDs referencing to the connected components.

Parameter	Type	Description
`applications`	Array of UUID Strings	List of `unique_id` of the connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`softwares`	Array of UUID Strings	List of `unique_id` of the connected software.
`softwares_data`	Array of Objects	Details of the connected software.
`owner_data`	Object	Details of the owner of device.
`manager_data`	Object	Details of the manager of device.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.

Response Parameters | Actions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`actions_data`	Array of Objects	Details of the actions that are added to the device.

Response Parameters | Custom Fields

In addition to the above mentioned parameters, the response parameters may vary as per the form configuration defined by your CFTR admin for devices. For such parameters, the field_readable_key of each parameter is returned in the response. To retrieve the field_readable_key and additional metadata of a parameter, use the Form Tab Structure API for devices.

Example

The following endpoint retrieves the field_readable_key for all custom fields in the device component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=device\n\n

Following are some of the sample custom fields for devices:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type
`annual_maintainance_contract`	String
`device_physical_location`	String

","urlObject":{"path":["device",":device_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the device.

\n","type":"text/plain"},"type":"any","value":"ccb5c6bf-32b8-4a2f-94e8-6dcdfcd532e1","key":"device_unique_id"}]}},"response":[{"id":"909add08-9891-44d0-92f0-0bd6f2d36eef","name":"Get Details of Device","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/device/:device_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["device",":device_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"device_unique_id","value":"fb114af7-73a7-472d-b655-23a484107b22","description":"`unique_id` of device"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Wed, 02 Feb 2022 09:54:20 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"12659","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"device_physical_location\": \"location of device\",\n \"dns_name\": null,\n \"domain_or_workgroup\": null,\n \"virtual_ip_address\": null,\n \"external_ip_address\": null,\n \"subnet_mask\": null,\n \"ports_open\": null,\n \"patches_missing\": null,\n \"endpoint_type\": \"Desktop\",\n \"ownership\": \"Procured\",\n \"annual_maintainance_contract\": \"Yes\",\n \"under_warranty\": \"Yes\",\n \"rogue\": \"Yes\",\n \"av_installed\": \"Yes\",\n \"openshares\": \"No\",\n \"usb_access\": \"Blocked\",\n \"security_patches_deployed\": \"Yes\",\n \"hips_installed\": \"Yes\",\n \"edr_installed\": \"No\",\n \"internet_access\": null,\n \"admin_access\": \"Yes\",\n \"disk_encryption\": \"Yes\",\n \"browsers_installed\": [\n \"Chrome\"\n ],\n \"unique_id\": \"fb114af7-73a7-472d-b655-23a484107b22\",\n \"created\": \"2021-12-19T12:43:29.499734Z\",\n \"modified\": \"2022-02-02T09:51:30.382702Z\",\n \"serial_number\": \"1234\",\n \"hostname\": \"update device hostname from openapi\",\n \"date_of_installation\": \"2021-07-13T07:57:32Z\",\n \"live_date\": \"2021-07-28T07:57:58Z\",\n \"amc_expiry_date\": \"2022-02-03T07:56:19Z\",\n \"warranty_ends\": \"2022-04-13T23:49:54.798445Z\",\n \"end_of_life\": \"2021-08-11T12:05:09.798445Z\",\n \"last_av_definition\": \"2021-07-15T02:09:22.798445Z\",\n \"incidents\": [\n \"c2a76a82-0f65-41e6-a3df-e54585aa775a\",\n \"745c8f87-cbb6-4e35-aa2d-89cfe1129446\",\n \"5b5acc0d-cec4-4780-9b7b-dab61a31675d\"\n ],\n \"incidents_data\": [\n {\n \"unique_id\": \"5b5acc0d-cec4-4780-9b7b-dab61a31675d\",\n \"readable_id\": \"INC594\",\n \"179be082-ac8b-425b-9033-030ffae0733d\": \"demo\",\n \"status\": \"closed\",\n \"created\": \"2022-01-28T11:26:46.783202Z\",\n \"modified\": \"2022-01-28T11:32:41.205160Z\",\n \"title_display\": \"demo\",\n \"severity_title\": \"Unknown\"\n },\n {\n \"unique_id\": \"c2a76a82-0f65-41e6-a3df-e54585aa775a\",\n \"readable_id\": \"INC591\",\n \"179be082-ac8b-425b-9033-030ffae0733d\": \"update openapi incident\",\n \"status\": \"open\",\n \"created\": \"2022-01-25T07:55:36.616482Z\",\n \"modified\": \"2022-01-28T07:13:54.645702Z\",\n \"title_display\": \"update openapi incident\",\n \"severity_title\": \"Low\"\n },\n {\n \"unique_id\": \"745c8f87-cbb6-4e35-aa2d-89cfe1129446\",\n \"readable_id\": \"INC592\",\n \"179be082-ac8b-425b-9033-030ffae0733d\": \"update openapi incident\",\n \"status\": \"open\",\n \"created\": \"2022-01-25T07:59:30.432929Z\",\n \"modified\": \"2022-01-25T13:56:20.450040Z\",\n \"title_display\": \"update openapi incident\",\n \"severity_title\": \"Low\"\n }\n ],\n \"vulnerabilities\": [\n \"e6f50eb7-10d4-481a-8375-d164470455bc\"\n ],\n \"vulnerabilities_data\": [\n {\n \"unique_id\": \"e6f50eb7-10d4-481a-8375-d164470455bc\",\n \"readable_id\": \"VUL101\",\n \"title\": \"Vulnerability 1.0.0\",\n \"status\": \"open\",\n \"created\": \"2022-02-02T09:46:42.881438Z\",\n \"modified\": \"2022-02-02T09:47:01.798086Z\",\n \"title_display\": \"Vulnerability 1.0.0\",\n \"cvss_score\": null,\n \"due_date\": null,\n \"target_remediation_date\": null,\n \"priority\": \"Low\",\n \"risk_data\": {\n \"unique_id\": \"a2a2e6e8-45c9-4f8e-854b-58966237b682\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"3d1492b5-1ea2-45dd-8bce-c10fabe3cd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"risk\": \"Low\",\n \"priority_data\": {\n \"unique_id\": \"7e0dfd0f-263b-4cba-ac41-ecc8e17328b0\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"143dd7a5-880c-4af0-af5b-01b947bf8c16\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n }\n }\n ],\n \"malwares\": [\n \"a4feb001-e913-4da5-97ad-bbe5f4d3228a\",\n \"427e678d-84b1-441b-9d3f-d5a152404a0c\"\n ],\n \"malwares_data\": [\n {\n \"unique_id\": \"a4feb001-e913-4da5-97ad-bbe5f4d3228a\",\n \"readable_id\": \"MLW122\",\n \"title\": \"Malware created for demo purpose 2\",\n \"status\": \"active\",\n \"created\": \"2021-09-09T05:32:19.933053Z\",\n \"modified\": \"2021-12-27T06:27:16.226590Z\",\n \"title_display\": \"Malware created for demo purpose 2\",\n \"type_data\": [\n {\n \"unique_id\": \"29b9b357-14dd-4cbf-a2f8-66b0e847d39a\",\n \"option_name\": \"Worm\",\n \"is_active\": true,\n \"order\": 6,\n \"option_field\": \"44235efa-3033-400f-9b92-576e0504f508\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n }\n ],\n \"type\": [\n \"Worm\"\n ],\n \"platform_data\": [\n {\n \"unique_id\": \"7b12ee24-db00-4c6b-a1a5-e2a837cfab7f\",\n \"option_name\": \"Windows Server 2k12\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"de89828a-ed2e-43ad-bb92-f4b12d38a75c\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n }\n ],\n \"platform\": [\n \"Windows Server 2k12\"\n ]\n },\n {\n \"unique_id\": \"427e678d-84b1-441b-9d3f-d5a152404a0c\",\n \"readable_id\": \"MLW121\",\n \"title\": \"Malware created for demo purpose 1\",\n \"status\": \"active\",\n \"created\": \"2021-11-18T07:57:41.933053Z\",\n \"modified\": \"2021-12-20T12:43:22.037578Z\",\n \"title_display\": \"Malware created for demo purpose 1\",\n \"type_data\": [\n {\n \"unique_id\": \"0a68e4a2-5405-435b-b9ba-36124db859d2\",\n \"option_name\": \"Ransomware\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"44235efa-3033-400f-9b92-576e0504f508\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n }\n ],\n \"type\": [\n \"Ransomware\"\n ],\n \"platform_data\": [],\n \"platform\": []\n }\n ],\n \"threat_actors\": [\n \"19b15b31-0d95-42ef-a476-03a4299ee4cb\",\n \"3822c3e9-3495-4a4a-b2a5-defce57ba5bf\"\n ],\n \"threat_actors_data\": [\n {\n \"unique_id\": \"19b15b31-0d95-42ef-a476-03a4299ee4cb\",\n \"readable_id\": \"ATR194\",\n \"title\": \"TEMP.Veles\",\n \"status\": \"active\",\n \"created\": \"2021-06-09T09:38:58.072233Z\",\n \"modified\": \"2022-01-03T05:02:12.134918Z\",\n \"title_display\": \"TEMP.Veles\"\n },\n {\n \"unique_id\": \"3822c3e9-3495-4a4a-b2a5-defce57ba5bf\",\n \"readable_id\": \"ATR108\",\n \"title\": \"APT28\",\n \"status\": \"active\",\n \"created\": \"2021-06-09T09:38:25.956058Z\",\n \"modified\": \"2022-01-03T05:02:11.352927Z\",\n \"title_display\": \"APT28\"\n }\n ],\n \"readable_id\": \"DVC1220\",\n \"owner_data\": {\n \"unique_id\": \"0d0715cd-0e6d-42f8-92c0-63fe0c94e197\",\n \"created\": \"2021-10-27T12:55:39.793233Z\",\n \"modified\": \"2021-10-27T12:55:39.793233Z\",\n \"email\": \"\",\n \"employee_name\": \"User created for demo purpose 2\",\n \"readable_id\": \"USR123\",\n \"display_name\": \"User created for demo purpose 2\",\n \"title_display\": \"User created for demo purpose 2\",\n \"user_status\": \"active\",\n \"threat_score\": null\n },\n \"manager_data\": {\n \"unique_id\": \"0d0715cd-0e6d-42f8-92c0-63fe0c94e197\",\n \"created\": \"2021-10-27T12:55:39.793233Z\",\n \"modified\": \"2021-10-27T12:55:39.793233Z\",\n \"email\": \"\",\n \"employee_name\": \"User created for demo purpose 2\",\n \"readable_id\": \"USR123\",\n \"display_name\": \"User created for demo purpose 2\",\n \"title_display\": \"User created for demo purpose 2\",\n \"user_status\": \"active\",\n \"threat_score\": null\n },\n \"briefings\": [\n \"968854e1-0735-469e-a123-132df3454a13\"\n ],\n \"briefings_data\": [\n {\n \"unique_id\": \"968854e1-0735-469e-a123-132df3454a13\",\n \"readable_id\": \"BRF101\",\n \"title\": \"a\",\n \"created\": \"2021-12-01T11:18:22.805664Z\",\n \"modified\": \"2021-12-01T11:18:23.194627Z\",\n \"title_display\": \"a\",\n \"status\": \"ACTIVE\"\n }\n ],\n \"applications\": [\n \"155dc4e5-7e85-4509-891d-c67e634a4b98\",\n \"7f92084f-d98b-47a7-b928-3caff8f6c9e2\"\n ],\n \"applications_data\": [\n {\n \"unique_id\": \"155dc4e5-7e85-4509-891d-c67e634a4b98\",\n \"created\": \"2021-10-13T03:49:28.093798Z\",\n \"modified\": \"2021-10-13T03:49:28.093798Z\",\n \"title\": \"App 2\",\n \"production_date\": null,\n \"readable_id\": \"APL102\",\n \"title_display\": \"App 2\",\n \"status\": \"active\"\n },\n {\n \"unique_id\": \"7f92084f-d98b-47a7-b928-3caff8f6c9e2\",\n \"created\": \"2021-07-14T13:26:38.850611Z\",\n \"modified\": \"2021-09-23T07:57:24.751503Z\",\n \"title\": \"App 1\",\n \"production_date\": null,\n \"readable_id\": \"APL101\",\n \"title_display\": \"App 1\",\n \"status\": \"active\"\n }\n ],\n \"softwares\": [\n \"90c8df6e-a0ca-422e-81ef-0f8e969669ba\"\n ],\n \"softwares_data\": [\n {\n \"unique_id\": \"90c8df6e-a0ca-422e-81ef-0f8e969669ba\",\n \"created\": \"2021-06-30T10:00:00.395030Z\",\n \"modified\": \"2021-07-13T06:15:02.067090Z\",\n \"title\": \"Software 1\",\n \"readable_id\": \"SFT101\",\n \"title_display\": \"Software 1\",\n \"software_status\": \"active\"\n }\n ],\n \"labels\": [\n \"c741bd45-1825-4dba-a30f-66088dcbbf8d\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"c741bd45-1825-4dba-a30f-66088dcbbf8d\",\n \"title\": \"L1\",\n \"color_code\": \"#827717\",\n \"created\": \"2022-02-01T07:38:20.601410Z\",\n \"modified\": \"2022-02-01T07:38:20.601410Z\"\n }\n ],\n \"operating_systems_data\": [\n {\n \"title\": \"AIX\",\n \"unique_id\": \"483e7094-47b4-4302-ba77-c3e66b3f1860\"\n }\n ],\n \"manufacturer_data\": {\n \"title\": \"ABS Computer Technologies (Parent: Newegg)\",\n \"unique_id\": \"36f7b0e6-afeb-4b08-b434-cf11305425fe\"\n },\n \"business_units_data\": [\n {\n \"title\": \"BU 3\",\n \"unique_id\": \"c64ddedb-fcd4-4a44-8299-70fbabdf8204\"\n }\n ],\n \"locations_data\": [\n {\n \"title\": \"Loc 5\",\n \"unique_id\": \"0e2a232a-0493-4fda-88e0-de343640fba7\"\n }\n ],\n \"category_data\": null,\n \"ip_address\": \"1.1.1.1\",\n \"created_by\": \"6850886e-e186-44de-bd0b-4730ff705dc9\",\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"6850886e-e186-44de-bd0b-4730ff705dc9\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"title_display\": \"update device hostname from openapi\",\n \"status\": null,\n \"dns_details\": null,\n \"description\": null,\n \"third_party_asset_type\": null,\n \"criticality\": null,\n \"third_party_business_unit\": null,\n \"site_code\": null,\n \"site_region\": null,\n \"site_country\": null,\n \"asset_type\": \"endpoint\",\n \"third_party_asset_type_verbose\": null,\n \"asset\": null,\n \"cftr_site_code\": null,\n \"cftr_site_region\": null,\n \"cftr_site_country\": null,\n \"vendor_supported\": null,\n \"model_id\": null,\n \"operational_status\": null,\n \"physical_location\": null,\n \"third_party_ip_address\": null,\n \"third_party_sync_id\": null,\n \"discovery_source\": null,\n \"mac_address\": null,\n \"endpoint_status\": \"clean\",\n \"threat_score\": null,\n \"actions_data\": [\n {\n \"title\": \"Action related to device DVC1220\",\n \"readable_id\": \"ACT111\",\n \"description\": null,\n \"created\": \"2022-02-02T09:54:13.739272Z\",\n \"modified\": \"2022-02-02T09:54:14.285898Z\",\n \"status\": \"open\",\n \"assigned_to\": null,\n \"unique_id\": \"8316bac2-b482-434d-a9ce-0125adf399c2\",\n \"assigned_to_data\": null,\n \"created_by\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"is_bookmarked\": false,\n \"title_display\": \"Action related to device DVC1220\",\n \"priority_data\": null,\n \"priority\": null,\n \"type_data\": null,\n \"type\": null\n }\n ],\n \"browsers_installed_data\": [\n {\n \"unique_id\": \"92db3820-03cf-4c3e-9a41-97285e6d0a23\",\n \"option_name\": \"Chrome\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"928ae771-07d3-43b3-91fd-aee6cfa2e0f8\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n }\n ],\n \"av_installed_data\": {\n \"unique_id\": \"ad17f01b-cbf9-471b-9a9c-0b9b59436b56\",\n \"option_name\": \"Yes\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"16704a9c-118c-4977-809a-7ec32c6eee51\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"endpoint_type_data\": {\n \"unique_id\": \"6fb49191-c324-4928-8d95-3fd868b53301\",\n \"option_name\": \"Desktop\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"bda36ede-23ad-4536-a6b6-61fe03826a8e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"ownership_data\": {\n \"unique_id\": \"1a9797ea-ac47-486b-aecb-9c01008f26be\",\n \"option_name\": \"Procured\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"d0eb3081-0c56-4b21-8438-c3344beec07a\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"openshares_data\": {\n \"unique_id\": \"d482f7e4-15fb-4214-9f41-39ef8f35b26d\",\n \"option_name\": \"No\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"f819d736-d0ee-48de-8cfe-d428b5aacfe1\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"usb_access_data\": {\n \"unique_id\": \"36a7039b-239f-432d-8fcd-4cb363981925\",\n \"option_name\": \"Blocked\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"70328b6a-5c88-4151-bcab-a6218834922a\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"annual_maintainance_contract_data\": {\n \"unique_id\": \"b147030f-4f53-4e60-8c4b-fdb9f916fda3\",\n \"option_name\": \"Yes\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"17d8e82c-255f-48a1-8805-62fa21cae305\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"security_patches_deployed_data\": {\n \"unique_id\": \"ec15a175-dade-41ae-8319-3f2de349cf41\",\n \"option_name\": \"Yes\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"1d369965-2e96-4b1a-b121-a83b7f14dd72\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"hips_installed_data\": {\n \"unique_id\": \"fcdfea95-ab86-4b44-9efc-1c49a572afbc\",\n \"option_name\": \"Yes\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"f588dea0-4c38-4bc6-84b5-4389fc593b57\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"under_warranty_data\": {\n \"unique_id\": \"abd49602-2189-4b30-884d-86a9fca1d3fe\",\n \"option_name\": \"Yes\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"b73ae3e4-1f7c-455f-bfee-c7e67fe80c54\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"edr_installed_data\": {\n \"unique_id\": \"bd588817-2eb2-443c-bc8f-8aaec0ceb6d3\",\n \"option_name\": \"No\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"834552bd-6829-4d4d-b5bb-0cd4103dd32a\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"internet_access_data\": null,\n \"admin_access_data\": {\n \"unique_id\": \"8bac912b-06ac-4f81-b2f3-4b92ff5c64cd\",\n \"option_name\": \"Yes\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"4300fbb1-83e3-463f-811e-6b1763ec54f6\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"disk_encryption_data\": {\n \"unique_id\": \"ddf96ad6-ff68-465a-978b-8180d2ea4b98\",\n \"option_name\": \"Yes\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"6d54291e-1d2c-42b4-975d-c56c81823e16\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"rogue_data\": {\n \"unique_id\": \"ec9a1cbf-a3ff-45f8-ba45-d7780a32ebd5\",\n \"option_name\": \"Yes\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"4a06dba3-2b32-45ea-811e-2ea904c5e196\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n }\n}"}],"_postman_id":"52cf39b3-afdf-4935-b123-63e663236431"},{"name":"Create Device Using Field UUID","id":"61a56e27-1587-4eac-8700-3352811c6ecc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"endpoint_type\": \"Desktop\",\n \"hostname\": \"desktop\",\n \"device_physical_location\": \"Logitech Desktop Optical Wireless Mouse\",\n \"serial_number\": \"A1001\",\n \"manufacturer\": \"375dd053-bd8d-4fdc-bafa-e3cb6b489b0b\",\n \"annual_maintainance_contract\": \"Yes\",\n \"date_of_installation\": \"2021-12-07T13:31:18.000Z\",\n \"live_date\": \"2021-12-30T13:31:18.000Z\",\n \"ip_address\": \"1.1.1.1\",\n \"browsers_installed\": [\n \"Chrome\"\n ],\n \"av_installed\": \"Yes\",\n \"endpoint_status\": \"clean\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/device/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Add a new device in the CFTR application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/device/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`hostname`	String	Mandatory	The hostname of the device.
`ip_address`	String	Mandatory	IP address of the device.
`endpoint_type`	String	Optional	Enter the device type. Some of the device type values are: - Desktop - Laptop - Router - Printer - Switch - Hub - UPS
`business_units`	List	Optional	Enter the list of unique IDs of Business Units. You can retrieve the list of available Business Units and their unique IDs using the following API endpoint: /v1/utils/business-unit/? `/openapi/v1/utils/business-unit/`
`locations`	List	Optional	Enter the list of unique IDs of the impacted locations. You can retrieve the list of available locations and their unique IDs using the following API endpoint: `/openapi/v1/utils/location/`
`endpoint_status`	String	Optional	Enter the status of the device. Allowed Values: - clean - suspected - infected - quarantined - remediation_in_progress - remediated Default value: \"clean\"

Request Parameters | Custom Form Fields

In addition to the above mentioned parameters, the response parameters may vary as per the form configuration defined by your CFTR admin for devices. For such parameters, use the field_readable_key of each parameter. To retrieve the field_readable_key and additional metadata of a parameter, use the Form Tab Structure API for devices.

Example

The following endpoint retrieves the field_readable_key for all custom fields in the device component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=device\n\n

Following are some of the sample custom fields for devices:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`annual_maintainance_contract`	String	Optional
`device_physical_location`	String	Optional

Response Parameters

Response Parameters | Regulatory Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the device.
`created`	String	Device Creation Time.
`modified`	String	Device Last Updated Time.
`ip_address`	String	IP address of the device.
`hostname`	String	Hostname of device.
`readable_id`	String	Readable ID of device. For example, DVC117.
`serial_number`	String	Serial number of the device.
`endpoint_status`	String	Current Status of the device.
`endpoint_type`	String	Type of the device type. For example, Desktop.
`endpoint_type_data`	Object	Details of the endpoint type.
`title_display`	String	Hostname of the device
`created_by`	String	`user_id` of the user who created the device.
`created_by_data`	Object	Details of user who created the device.
`labels`	List	List of `unique_id` labels that are added to the device.
`labels_data`	List of Objects	Details of the labels that are added to the device.
`business_units_data`	List of Objects	Details of business units that are impacted by the device.
`locations_data`	List of Objects	Details of locations that are impacted by the device.

Response Parameters | Connect The Dots

Parameter	Type	Description
`applications`	Array of UUID Strings	List of `unique_id` of the connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`softwares`	Array of UUID Strings	List of `unique_id` of the connected software.
`softwares_data`	Array of Objects	Details of the connected software.
`owner_data`	Object	Details of the owner of device.
`manager_data`	Object	Details of the manager of device.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.

Response Parameters | Actions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`actions_data`	Array of Objects	Details of the actions that are added to the device.

Response Parameters | Custom Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the device component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=device\n\n

Following are some of the sample custom fields for devices:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type
`annual_maintainance_contract`	String
`device_physical_location`	String

","urlObject":{"path":["device",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"ae21371a-1eee-4ef4-b89c-25a1af509eac","name":"201 Created: Device Created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"hostname\": \"device from openapi\",\n \"endpoint_type\": \"6fb49191-c324-4928-8d95-3fd868b53301\",\n \"device_physical_location\": \"Logitech Desktop Optical Wireless Mouse\",\n \"business_units\": [\n \"9750d6df-2d7f-4899-b20d-bfbba0a9084d\"\n ],\n \"locations\": [\n \"671961e6-0119-460c-8d55-9b697f6e2d6e\",\n \"0483162d-36c2-4f67-bf2b-a6bb46a52828\"\n ],\n \"serial_number\": \"A1001\",\n \"manufacturer\": \"36f7b0e6-afeb-4b08-b434-cf11305425fe\",\n \"annual_maintainance_contract\": \"Yes\",\n \"date_of_installation\": \"2021-12-07T13:31:18.000Z\",\n \"live_date\": \"2021-12-30T13:31:18.000Z\",\n \"ip_address\": \"1.1.1.1\",\n \"browsers_installed\": [\n \"Chrome\"\n ],\n \"av_installed\": \"Yes\",\n \"endpoint_status\": \"clean\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/device/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["device",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Wed, 02 Feb 2022 13:39:54 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"3777","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"device_physical_location\": \"Logitech Desktop Optical Wireless Mouse\",\n \"dns_name\": null,\n \"domain_or_workgroup\": null,\n \"virtual_ip_address\": null,\n \"external_ip_address\": null,\n \"subnet_mask\": null,\n \"ports_open\": null,\n \"patches_missing\": null,\n \"endpoint_type\": \"Desktop\",\n \"ownership\": null,\n \"annual_maintainance_contract\": \"Yes\",\n \"under_warranty\": null,\n \"rogue\": null,\n \"av_installed\": \"Yes\",\n \"openshares\": null,\n \"usb_access\": null,\n \"security_patches_deployed\": null,\n \"hips_installed\": null,\n \"edr_installed\": null,\n \"internet_access\": null,\n \"admin_access\": null,\n \"disk_encryption\": null,\n \"browsers_installed\": [\n \"Chrome\"\n ],\n \"unique_id\": \"6225ab1c-279c-4b8e-91f5-d589e5344027\",\n \"created\": \"2022-02-02T13:39:53.430390Z\",\n \"modified\": \"2022-02-02T13:39:53.513735Z\",\n \"serial_number\": \"A1001\",\n \"hostname\": \"device from openapi\",\n \"date_of_installation\": \"2021-12-07T13:31:18Z\",\n \"live_date\": \"2021-12-30T13:31:18Z\",\n \"amc_expiry_date\": null,\n \"warranty_ends\": null,\n \"end_of_life\": null,\n \"last_av_definition\": null,\n \"incidents\": [],\n \"incidents_data\": [],\n \"vulnerabilities\": [],\n \"vulnerabilities_data\": [],\n \"malwares\": [],\n \"malwares_data\": [],\n \"threat_actors\": [],\n \"threat_actors_data\": [],\n \"readable_id\": \"DVC1223\",\n \"owner_data\": null,\n \"manager_data\": null,\n \"briefings\": [],\n \"briefings_data\": [],\n \"applications\": [],\n \"applications_data\": [],\n \"softwares\": [],\n \"softwares_data\": [],\n \"labels\": [],\n \"labels_data\": [],\n \"operating_systems_data\": [],\n \"manufacturer_data\": {\n \"title\": \"ABS Computer Technologies (Parent: Newegg)\",\n \"unique_id\": \"36f7b0e6-afeb-4b08-b434-cf11305425fe\"\n },\n \"business_units_data\": [\n {\n \"title\": \"Bu 1\",\n \"unique_id\": \"9750d6df-2d7f-4899-b20d-bfbba0a9084d\"\n }\n ],\n \"locations_data\": [\n {\n \"title\": \"Loc 1\",\n \"unique_id\": \"671961e6-0119-460c-8d55-9b697f6e2d6e\"\n },\n {\n \"title\": \"Loc 2\",\n \"unique_id\": \"0483162d-36c2-4f67-bf2b-a6bb46a52828\"\n }\n ],\n \"category_data\": {\n \"title\": \"Cyber\",\n \"unique_id\": \"c886973d-b528-477a-88e8-e694385eb11f\"\n },\n \"ip_address\": \"1.1.1.1\",\n \"created_by\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"title_display\": \"device from openapi\",\n \"status\": null,\n \"dns_details\": null,\n \"description\": null,\n \"third_party_asset_type\": null,\n \"criticality\": null,\n \"third_party_business_unit\": null,\n \"site_code\": null,\n \"site_region\": null,\n \"site_country\": null,\n \"asset_type\": \"endpoint\",\n \"third_party_asset_type_verbose\": null,\n \"asset\": null,\n \"cftr_site_code\": null,\n \"cftr_site_region\": null,\n \"cftr_site_country\": null,\n \"vendor_supported\": null,\n \"model_id\": null,\n \"operational_status\": null,\n \"physical_location\": null,\n \"third_party_ip_address\": null,\n \"third_party_sync_id\": null,\n \"discovery_source\": null,\n \"mac_address\": null,\n \"endpoint_status\": \"clean\",\n \"threat_score\": null,\n \"actions_data\": [],\n \"browsers_installed_data\": [\n {\n \"unique_id\": \"92db3820-03cf-4c3e-9a41-97285e6d0a23\",\n \"option_name\": \"Chrome\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"928ae771-07d3-43b3-91fd-aee6cfa2e0f8\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n }\n ],\n \"av_installed_data\": {\n \"unique_id\": \"ad17f01b-cbf9-471b-9a9c-0b9b59436b56\",\n \"option_name\": \"Yes\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"16704a9c-118c-4977-809a-7ec32c6eee51\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"endpoint_type_data\": {\n \"unique_id\": \"6fb49191-c324-4928-8d95-3fd868b53301\",\n \"option_name\": \"Desktop\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"bda36ede-23ad-4536-a6b6-61fe03826a8e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"ownership_data\": null,\n \"openshares_data\": null,\n \"usb_access_data\": null,\n \"annual_maintainance_contract_data\": {\n \"unique_id\": \"b147030f-4f53-4e60-8c4b-fdb9f916fda3\",\n \"option_name\": \"Yes\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"17d8e82c-255f-48a1-8805-62fa21cae305\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"security_patches_deployed_data\": null,\n \"hips_installed_data\": null,\n \"under_warranty_data\": null,\n \"edr_installed_data\": null,\n \"internet_access_data\": null,\n \"admin_access_data\": null,\n \"disk_encryption_data\": null,\n \"rogue_data\": null\n}"}],"_postman_id":"61a56e27-1587-4eac-8700-3352811c6ecc"},{"name":"Create Device Using Field Values","id":"82573696-4797-4137-bbba-80d0ee404563","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"hostname\": \"device from openapi\",\n \"endpoint_type\": \"Desktop\",\n \"device_physical_location\": \"Logitech Desktop Optical Wireless Mouse\",\n \"business_units\": [\n \"Bu 1\"\n ],\n \"locations\": [\n \"Lo 1\"\n ],\n \"serial_number\": \"A1001\",\n \"manufacturer\": \"AMD\",\n \"annual_maintainance_contract\": \"Yes\",\n \"date_of_installation\": \"2021-12-07T13:31:18.000Z\",\n \"live_date\": \"2021-12-30T13:31:18.000Z\",\n \"ip_address\": \"1.1.1.1\",\n \"browsers_installed\": [\n \"Chrome\"\n ],\n \"av_installed\": \"Yes\",\n \"endpoint_status\": \"clean\",\n \"labels\": [\"Blue Label Devices\"],\n \"ostypes\": [\"AIX\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/device/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","description":"

Add a new device in the CFTR application using the values of locations, business units, manufacturers, labels, and operation system types.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/device/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`hostname`	String	Mandatory	The hostname of the device.
`ip_address`	String	Mandatory	IP address of the device.
`endpoint_type`	String	Optional	Enter the device type. Some of the device type values are: - Desktop - Laptop - Router - Printer - Switch - Hub - UPS
`business_units`	List	Optional	Enter the list of names of Business Units. You can retrieve the list of available Business Units and their names using the following API endpoint: `/openapi/v1/utils/business-unit/`
`locations`	List	Optional	Enter the list of names of impacted locations. You can retrieve the list of available locations and their names using the following API endpoint: `/openapi/v1/utils/location/`
`endpoint_status`	String	Optional	Enter the status of the device. Allowed Values: - clean - suspected - infected - quarantined - remediation_in_progress - remediated Default value: \"clean\"
`manufacturer`	String	Optional	Enter the manufacturer name to be added to the device. You can retrieve the list of available manufactures and their names using the following API endpoint: `/openapi/v1/utils/manufacturers/`
`ostypes`	List	Optional	Enter the list o of names of the operating sytem types to be added to the device. You can retrieve the list of available oerating system types and their names using the following API endpoint: `/openapi/v1/utils/ostypes/`
`labels`	List	Optional	Enter the list of names of the labels to be added to the device. You can retrieve the list of available labels and their names using the following API endpoint: `/openapi/v1/utils/label/`

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the device component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=device\n\n

Following are some of the sample custom fields for devices:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`annual_maintainance_contract`	String	Optional
`device_physical_location`	String	Optional

Response Parameters

Response Parameters | Regulatory Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the device.
`created`	String	Device Creation date and time.
`modified`	String	Device Last Updated date and time.
`serial_number`	String	Serial number of the device.
`hostname`	String	Hostname of device.
`readable_id`	String	Readable ID of device. For example, DVC118.
`endpoint_status`	String	Current Status of the device. For example, clean.
`endpoint_type`	String	Type of the device. For example, Desktop.
`endpoint_type_data`	Object	Details of the device type.
`title_display`	String	Hostname of the device.
`ip_address`	Float	IP address of the device.
`created_by`	String	`user_id` of the user who created the device.
`created_by_data`	Object	Details of user who created the device.
`labels`	List	List of `unique_id` labels that are added to the device.
`labels_data`	List of Objects	Details of the labels that are added to the device.
`business_units_data`	List of Objects	Details of business units that are impacted by the device.
`locations_data`	List of Objects	Details of locations that are impacted by the device.

Response Parameters | Connect The Dots

Parameter	Type	Description
`applications`	Array of UUID Strings	List of `unique_id` of the connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`softwares`	Array of UUID Strings	List of `unique_id` of the connected software.
`softwares_data`	Array of Objects	Details of the connected software.
`owner_data`	Object	Details of the owner of device.
`manager_data`	Object	Details of the manager of device.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.

Response Parameters | Actions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`actions_data`	Array of Objects	Details of the actions that are added to the device.

Response Parameters | Custom Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the device component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=device\n\n

Following are some of the sample custom fields for devices:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type
`annual_maintainance_contract`	String
`device_physical_location`	String

Do not change the parameter value\nAllows you to create devices using the values of locations, business units, manufacturer, labels and operation system types.

\n","type":"text/plain"},"key":"values","value":"readable_type"}],"variable":[]}},"response":[{"id":"829f7db7-8ace-4796-98b3-887ed39a9c69","name":"201 Created: Device Created Using Field Values","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"hostname\": \"device from openapi\",\n \"endpoint_type\": \"Desktop\",\n \"device_physical_location\": \"Logitech Desktop Optical Wireless Mouse\",\n \"business_units\": [\n \"Bu 1\"\n ],\n \"locations\": [\n \"Lo 1\"\n ],\n \"serial_number\": \"A1001\",\n \"manufacturer\": \"AMD\",\n \"annual_maintainance_contract\": \"Yes\",\n \"date_of_installation\": \"2021-12-07T13:31:18.000Z\",\n \"live_date\": \"2021-12-30T13:31:18.000Z\",\n \"ip_address\": \"1.1.1.1\",\n \"browsers_installed\": [\n \"Chrome\"\n ],\n \"av_installed\": \"Yes\",\n \"endpoint_status\": \"clean\",\n \"labels\": [\"Blue Label Devices\"],\n \"ostypes\": [\"AIX\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/device/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","host":["{{base_url}}v1"],"path":["device",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"values","value":"readable_type","description":"**Do not change the parameter value**\nAllows you to create devices using the values of locations, business units, manufacturer, labels and operation system types."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Apr 2023 07:03:05 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"4246","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"device_physical_location\": \"Logitech Desktop Optical Wireless Mouse\",\n \"dns_name\": null,\n \"domain_or_workgroup\": null,\n \"virtual_ip_address\": null,\n \"external_ip_address\": null,\n \"subnet_mask\": null,\n \"ports_open\": null,\n \"patches_missing\": null,\n \"endpoint_type\": \"Desktop\",\n \"ownership\": null,\n \"annual_maintainance_contract\": \"Yes\",\n \"under_warranty\": null,\n \"rogue\": null,\n \"av_installed\": \"Yes\",\n \"openshares\": null,\n \"usb_access\": null,\n \"security_patches_deployed\": null,\n \"hips_installed\": null,\n \"edr_installed\": null,\n \"internet_access\": null,\n \"admin_access\": null,\n \"disk_encryption\": null,\n \"browsers_installed\": [\n \"Chrome\"\n ],\n \"unique_id\": \"492b8f1c-6f9c-4aae-854f-d92acccf3b6f\",\n \"created\": \"2023-04-21T07:03:04.522961Z\",\n \"modified\": \"2023-04-21T07:03:04.635522Z\",\n \"serial_number\": \"A1001\",\n \"hostname\": \"device from openapi\",\n \"owner\": null,\n \"manager\": null,\n \"date_of_installation\": \"2021-12-07T13:31:18Z\",\n \"live_date\": \"2021-12-30T13:31:18Z\",\n \"amc_expiry_date\": null,\n \"warranty_ends\": null,\n \"end_of_life\": null,\n \"last_av_definition\": null,\n \"incidents\": [],\n \"incidents_data\": [],\n \"vulnerabilities\": [],\n \"vulnerabilities_data\": [],\n \"malwares\": [],\n \"malwares_data\": [],\n \"threat_actors\": [],\n \"threat_actors_data\": [],\n \"readable_id\": \"DVC102\",\n \"owner_data\": null,\n \"manager_data\": null,\n \"briefings\": [],\n \"briefings_data\": [],\n \"applications\": [],\n \"applications_data\": [],\n \"softwares\": [],\n \"softwares_data\": [],\n \"labels\": [\n \"ae0364e5-49d9-4a00-a465-ccac7b22b07b\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"ae0364e5-49d9-4a00-a465-ccac7b22b07b\",\n \"title\": \"Blue Label Devices\",\n \"color_code\": \"#BF360C\",\n \"created\": \"2023-04-21T07:02:09.884171Z\",\n \"modified\": \"2023-04-21T07:02:09.884171Z\"\n }\n ],\n \"operating_systems_data\": [],\n \"manufacturer_data\": {\n \"title\": \"AMD\",\n \"unique_id\": \"6222f5d9-cec8-47c6-95e7-fcecc9a393e3\"\n },\n \"business_units_data\": [\n {\n \"title\": \"Bu 1\",\n \"unique_id\": \"f9d39c5a-0fe0-4ee8-bdb6-2e5f8b2fc35c\"\n }\n ],\n \"locations_data\": [\n {\n \"title\": \"Lo 1\",\n \"unique_id\": \"274abeb6-7528-4e94-a6d3-ad9b30073ecd\",\n \"is_active\": true\n }\n ],\n \"category_data\": {\n \"title\": \"Cyber\",\n \"unique_id\": \"81400f66-0d5f-4abb-b3ee-b3feb23f0f14\"\n },\n \"ip_address\": \"1.1.1.1\",\n \"created_by\": \"097d3adb-0def-4e4e-8902-5844b71cd42e\",\n \"created_by_data\": {\n \"username\": \"jane.doe\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"097d3adb-0def-4e4e-8902-5844b71cd42e\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"title_display\": \"device from openapi\",\n \"status\": null,\n \"dns_details\": null,\n \"description\": null,\n \"third_party_asset_type\": null,\n \"criticality\": null,\n \"third_party_business_unit\": null,\n \"site_code\": null,\n \"site_region\": null,\n \"site_country\": null,\n \"asset_type\": \"endpoint\",\n \"third_party_asset_type_verbose\": null,\n \"asset\": null,\n \"cftr_site_code\": null,\n \"cftr_site_region\": null,\n \"cftr_site_country\": null,\n \"vendor_supported\": null,\n \"model_id\": null,\n \"operational_status\": null,\n \"physical_location\": null,\n \"third_party_ip_address\": null,\n \"third_party_sync_id\": null,\n \"discovery_source\": null,\n \"mac_address\": null,\n \"endpoint_status\": \"clean\",\n \"threat_score\": null,\n \"actions_data\": [],\n \"browsers_installed_data\": [\n {\n \"unique_id\": \"29f22339-2340-441b-9208-22fea7a7befa\",\n \"option_name\": \"Chrome\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"c9fd6bab-166b-473f-a631-91516c0138ca\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"av_installed_data\": {\n \"unique_id\": \"4707748b-6bff-433c-b940-46582ec0e653\",\n \"option_name\": \"Yes\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"df4c46eb-94a1-40fb-b391-9687ca10bc85\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"endpoint_type_data\": {\n \"unique_id\": \"657e9ae9-9cfa-4e14-bfc4-b96182e5e68e\",\n \"option_name\": \"Desktop\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"2b20e720-4e3a-4a3e-8343-77769abba9a9\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"openshares_data\": null,\n \"ownership_data\": null,\n \"annual_maintainance_contract_data\": {\n \"unique_id\": \"3736036e-2fb6-46e8-ae1f-15955183715c\",\n \"option_name\": \"Yes\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"369a6ba1-ce10-494a-ac0f-0b345be37c7c\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"usb_access_data\": null,\n \"security_patches_deployed_data\": null,\n \"hips_installed_data\": null,\n \"edr_installed_data\": null,\n \"under_warranty_data\": null,\n \"internet_access_data\": null,\n \"admin_access_data\": null,\n \"disk_encryption_data\": null,\n \"rogue_data\": null\n}"}],"_postman_id":"82573696-4797-4137-bbba-80d0ee404563"},{"name":"Update Device Using Field UUID","id":"7d2aee6f-8cd3-47b7-91ce-6b75e2c9524d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"hostname\": \"update device hostname from openapi\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/device/:device_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Update the details of a device in the CFTR Application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/device/:device_unique_id/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`hostname`	String	Optional	Hostname of Device
`ip_address`	String	Optional	IP Address of the Device.
`endpoint_type`	String	Optional	Enter the Device Type. Some of the device type values are: - Desktop - Laptop - Router - Printer - Switch - Hub - UPS
`business_units`	List	Optional	Enter the list of unique IDs of Business Units. You can retrieve the list of available Business Units and their unique IDs using the following API endpoint: `/openapi/v1/utils/business-unit/`
`locations`	List	Optional	Enter the list of unique IDs of the impacted locations. You can retrieve the list of available locations and their unique IDs using the following API endpoint: `/openapi/v1/utils/location/`
`endpoint_status`	String	Optional	Enter the status of the device. Allowed Values: - clean - suspected - infected - quarantined - remediation_in_progress - remediated By default, the status of device is \"clean\".

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the device component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=device\n\n

Following are some of the sample custom fields for devices:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`annual_maintainance_contract`	String	Optional
`device_physical_location`	String	Optional

Response Parameters

Response Parameters | Regulatory Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the device.
`created`	String	Device creation time.
`modified`	String	Device last updated time.
`serial_number`	String	Serial number of the device.
`hostname`	String	Hostname of device.
`readable_id`	String	Readable ID of device.
`endpoint_status`	String	Current status of the device. For example, clean.
`endpoint_type_data`	Object	Details of the device type.
`title_display`	String	Hostname of the device.
`created_by`	String	`user_id` of the user who created the device.
`created_by_data`	Object	Details of user who created the device.
`labels`	List	List of `unique_id` labels that are added to the device.
`ip_address`	String	IP address of the device.
`labels_data`	List of Objects	Details of the labels that are added to the device.
`business_units_data`	List of Objects	Details of business units that are impacted by the device.
`locations_data`	List of Objects	Details of locations that are impacted by the device.
`ip_address`	Integer	IP address of the device.

Response Parameters | Connect The Dots

Parameter	Type	Description
`applications`	Array of UUID Strings	List of `unique_id` of the connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`softwares`	Array of UUID Strings	List of `unique_id` of the connected software.
`softwares_data`	Array of Objects	Details of the connected software.
`owner_data`	Object	Details of the owner of device.
`manager_data`	Object	Details of the manager of device.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.

Response Parameters | Actions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`actions_data`	Array of Objects	Details of the actions that are added to the device.

Response Parameters | Custom Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the device component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=device\n\n

Following are some of the sample custom fields for devices:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type
`annual_maintainance_contract`	String
`device_physical_location`	String

Enter the unique ID of the device.

\n","type":"text/plain"},"type":"any","value":"fb114af7-73a7-472d-b655-23a484107b22","key":"device_unique_id"}]}},"response":[{"id":"776454cb-3197-4f64-acb0-565f5388df00","name":"200 OK: Update Device","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"hostname\": \"update device hostname from openapi\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/device/fb114af7-73a7-472d-b655-23a484107b22/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["device","fb114af7-73a7-472d-b655-23a484107b22",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Tue, 01 Feb 2022 15:33:46 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"4496","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"device_physical_location\": null,\n \"dns_name\": null,\n \"domain_or_workgroup\": null,\n \"virtual_ip_address\": null,\n \"external_ip_address\": null,\n \"subnet_mask\": null,\n \"ports_open\": null,\n \"patches_missing\": null,\n \"test_field_1\": null,\n \"test_field_2\": null,\n \"test_field_3\": null,\n \"endpoint_type\": \"Desktop\",\n \"ownership\": null,\n \"annual_maintainance_contract\": null,\n \"under_warranty\": null,\n \"rogue\": null,\n \"av_installed\": \"Yes\",\n \"openshares\": \"No\",\n \"usb_access\": \"Blocked\",\n \"security_patches_deployed\": null,\n \"hips_installed\": null,\n \"edr_installed\": \"No\",\n \"internet_access\": null,\n \"admin_access\": \"Yes\",\n \"disk_encryption\": null,\n \"browsers_installed\": [],\n \"unique_id\": \"fb114af7-73a7-472d-b655-23a484107b22\",\n \"created\": \"2021-12-19T12:43:29.499734Z\",\n \"modified\": \"2022-02-01T15:33:46.275188Z\",\n \"serial_number\": \"1234\",\n \"hostname\": \"update device hostname from openapi\",\n \"date_of_installation\": null,\n \"live_date\": null,\n \"amc_expiry_date\": null,\n \"warranty_ends\": \"2022-04-13T23:49:54.798445Z\",\n \"end_of_life\": \"2021-08-11T12:05:09.798445Z\",\n \"last_av_definition\": \"2021-07-15T02:09:22.798445Z\",\n \"incidents\": [],\n \"incidents_data\": [],\n \"vulnerabilities\": [],\n \"vulnerabilities_data\": [],\n \"malwares\": [],\n \"malwares_data\": [],\n \"threat_actors\": [],\n \"threat_actors_data\": [],\n \"readable_id\": \"DVC1220\",\n \"owner_data\": null,\n \"manager_data\": null,\n \"briefings\": [],\n \"briefings_data\": [],\n \"applications\": [],\n \"applications_data\": [],\n \"softwares\": [],\n \"softwares_data\": [],\n \"labels\": [\n \"c741bd45-1825-4dba-a30f-66088dcbbf8d\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"c741bd45-1825-4dba-a30f-66088dcbbf8d\",\n \"title\": \"L1\",\n \"color_code\": \"#827717\",\n \"created\": \"2022-02-01T07:38:20.601410Z\",\n \"modified\": \"2022-02-01T07:38:20.601410Z\"\n }\n ],\n \"operating_systems_data\": [],\n \"manufacturer_data\": null,\n \"business_units_data\": [\n {\n \"title\": \"BU 3\",\n \"unique_id\": \"c64ddedb-fcd4-4a44-8299-70fbabdf8204\"\n }\n ],\n \"locations_data\": [\n {\n \"title\": \"Loc 5\",\n \"unique_id\": \"0e2a232a-0493-4fda-88e0-de343640fba7\"\n }\n ],\n \"category_data\": null,\n \"ip_address\": \"1.1.1.1\",\n \"created_by\": \"6850886e-e186-44de-bd0b-4730ff705dc9\",\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"6850886e-e186-44de-bd0b-4730ff705dc9\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"title_display\": \"update device hostname from openapi\",\n \"status\": null,\n \"dns_details\": null,\n \"description\": null,\n \"third_party_asset_type\": null,\n \"criticality\": null,\n \"third_party_business_unit\": null,\n \"site_code\": null,\n \"site_region\": null,\n \"site_country\": null,\n \"asset_type\": \"endpoint\",\n \"third_party_asset_type_verbose\": null,\n \"asset\": null,\n \"cftr_site_code\": null,\n \"cftr_site_region\": null,\n \"cftr_site_country\": null,\n \"vendor_supported\": null,\n \"model_id\": null,\n \"operational_status\": null,\n \"physical_location\": null,\n \"third_party_ip_address\": null,\n \"third_party_sync_id\": null,\n \"discovery_source\": null,\n \"mac_address\": null,\n \"endpoint_status\": \"clean\",\n \"threat_score\": null,\n \"actions_data\": [],\n \"browsers_installed_data\": [],\n \"av_installed_data\": {\n \"unique_id\": \"ad17f01b-cbf9-471b-9a9c-0b9b59436b56\",\n \"option_name\": \"Yes\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"16704a9c-118c-4977-809a-7ec32c6eee51\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"endpoint_type_data\": {\n \"unique_id\": \"6fb49191-c324-4928-8d95-3fd868b53301\",\n \"option_name\": \"Desktop\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"bda36ede-23ad-4536-a6b6-61fe03826a8e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"ownership_data\": null,\n \"openshares_data\": {\n \"unique_id\": \"d482f7e4-15fb-4214-9f41-39ef8f35b26d\",\n \"option_name\": \"No\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"f819d736-d0ee-48de-8cfe-d428b5aacfe1\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"usb_access_data\": {\n \"unique_id\": \"36a7039b-239f-432d-8fcd-4cb363981925\",\n \"option_name\": \"Blocked\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"70328b6a-5c88-4151-bcab-a6218834922a\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"annual_maintainance_contract_data\": null,\n \"security_patches_deployed_data\": null,\n \"hips_installed_data\": null,\n \"under_warranty_data\": null,\n \"edr_installed_data\": {\n \"unique_id\": \"bd588817-2eb2-443c-bc8f-8aaec0ceb6d3\",\n \"option_name\": \"No\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"834552bd-6829-4d4d-b5bb-0cd4103dd32a\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"internet_access_data\": null,\n \"admin_access_data\": {\n \"unique_id\": \"8bac912b-06ac-4f81-b2f3-4b92ff5c64cd\",\n \"option_name\": \"Yes\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"4300fbb1-83e3-463f-811e-6b1763ec54f6\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"disk_encryption_data\": null,\n \"rogue_data\": null\n}"}],"_postman_id":"7d2aee6f-8cd3-47b7-91ce-6b75e2c9524d"},{"name":"Update Device Using Field Values","id":"376dd63c-c5b0-4166-86cc-ca0368f74616","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"business_units\": [\n \"System\"\n ],\n \"locations\": [\n \"System\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/device/:device_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","description":"

Update the details of a device in the CFTR Application using the values of locations, business units, manufacturers, labels, and operating system types.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/device/:device_unique_id/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`hostname`	String	Optional	Hostname of Device
`ip_address`	String	Optional	IP Address of the Device.
`endpoint_type`	String	Optional	Enter the Device Type. Some of the device type values are: - Desktop - Laptop - Router - Printer - Switch - Hub - UPS
`business_units`	List	Optional	Enter the list of names of the Business Units. You can retrieve the list of available Business Units and their names using the following API endpoint: `/openapi/v1/utils/business-unit/`
`locations`	List	Optional	Enter the list of names of the impacted locations. You can retrieve the list of available locations and their names using the following API endpoint: `/openapi/v1/utils/location/`
`endpoint_status`	String	Optional	Enter the status of the device. Allowed Values: - clean - suspected - infected - quarantined - remediation_in_progress - remediated By default, the status of device is \"clean\".
`manufacturer`	String	Optional	Enter the manufacturer name to be added to the device. You can retrieve the list of available manufactures and their names using the following API endpoint: `/openapi/v1/utils/manufacturers/`
`ostypes`	List	Optional	Enter the list o of names of the operating sytem types to be added to the device. You can retrieve the list of available oerating system types and their names using the following API endpoint: `/openapi/v1/utils/ostypes/`
`labels`	`List`	`Optional`	Enter the list of names of the labels to be added to the device. You can retrieve the list of available labels and their names using the following API endpoint: `/openapi/v1/utils/label/`

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the device component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=device\n\n

Following are some of the sample custom fields for devices:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`annual_maintainance_contract`	String	Optional
`device_physical_location`	String	Optional

Response Parameters

Response Parameters | Regulatory Fields

Parameter	Type	Description
`unique_id`	String	Unique ID of the device.
`created`	String	Device creation date and time.
`modified`	String	Device last updated date and time.
`serial_number`	String	Serial number of the device.
`hostname`	String	Hostname of the device.
`readable_id`	String	Readable ID of the device. For example, DVC118.
`endpoint_status`	String	Current status of the device. For example, clean.
`endpoint_type`	Sting	Type of the device.
`endpoint_type_data`	String	Details of the device type.
`title_display`	String	Hostname of the device.
`created_by`	String	`user_id` of the user who created the device.
`created_by_data`	Object	Details of user who created the device.
`labels`	List	List of `unique_id` labels that are added to the device.
`labels_data`	List of Objects	Details of the labels that are added to the device.
`ip_addess`	String	IP address of the device.
`business_units_data`	List of Objects	Details of business units that are impacted by the device.
`locations_data`	List of Objects	Details of locations that are impacted by the device.
`ip_address`	Integer	IP address of the device.

Response Parameters | Connect The Dots

Parameter	Type	Description
`applications`	Array of UUID Strings	List of `unique_id` of the connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`softwares`	Array of UUID Strings	List of `unique_id` of the connected software.
`softwares_data`	Array of Objects	Details of the connected software.
`owner_data`	Object	Details of the owner of device.
`manager_data`	Object	Details of the manager of device.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.

Response Parameters | Actions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`actions_data`	Array of Objects	Details of the actions that are added to the device.

Response Parameters | Custom Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the device component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=device\n\n

Following are some of the sample custom fields for devices:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type
`annual_maintainance_contract`	String
`device_physical_location`	String

Do not change the parameter value\nAllows you to update devices using the values of locations, business units, manufacturer, labels and operation system types.

\n","type":"text/plain"},"key":"values","value":"readable_type"}],"variable":[{"description":{"content":"

Enter the unique ID of the device.

\n","type":"text/plain"},"type":"any","value":"492b8f1c-6f9c-4aae-854f-d92acccf3b6f","key":"device_unique_id"}]}},"response":[{"id":"2919468c-c164-413e-a21d-9d467b72ea83","name":"200 OK: Update Device Using Field Values","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"business_units\": [\n \"System\"\n ],\n \"locations\": [\n \"System\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/device/:device_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","host":["{{base_url}}v1"],"path":["device",":device_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"values","value":"readable_type","description":"**Do not change the parameter value**\nAllows you to update devices using the values of locations, business units, manufacturer, labels and operation system types."}],"variable":[{"key":"device_unique_id","value":"492b8f1c-6f9c-4aae-854f-d92acccf3b6f","description":"Enter the unique ID of the device."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Apr 2023 07:08:43 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"device_physical_location\": \"Logitech Desktop Optical Wireless Mouse\",\n \"dns_name\": null,\n \"domain_or_workgroup\": null,\n \"virtual_ip_address\": null,\n \"external_ip_address\": null,\n \"subnet_mask\": null,\n \"ports_open\": null,\n \"patches_missing\": null,\n \"endpoint_type\": \"Desktop\",\n \"ownership\": null,\n \"annual_maintainance_contract\": \"Yes\",\n \"under_warranty\": null,\n \"rogue\": null,\n \"av_installed\": \"Yes\",\n \"openshares\": null,\n \"usb_access\": null,\n \"security_patches_deployed\": null,\n \"hips_installed\": null,\n \"edr_installed\": null,\n \"internet_access\": null,\n \"admin_access\": null,\n \"disk_encryption\": null,\n \"browsers_installed\": [\n \"Chrome\"\n ],\n \"unique_id\": \"492b8f1c-6f9c-4aae-854f-d92acccf3b6f\",\n \"created\": \"2023-04-21T07:03:04.522961Z\",\n \"modified\": \"2023-04-21T07:08:42.585162Z\",\n \"serial_number\": \"A1001\",\n \"hostname\": \"device from openapi\",\n \"owner\": null,\n \"manager\": null,\n \"date_of_installation\": \"2021-12-07T13:31:18Z\",\n \"live_date\": \"2021-12-30T13:31:18Z\",\n \"amc_expiry_date\": null,\n \"warranty_ends\": null,\n \"end_of_life\": null,\n \"last_av_definition\": null,\n \"incidents\": [],\n \"incidents_data\": [],\n \"vulnerabilities\": [],\n \"vulnerabilities_data\": [],\n \"malwares\": [],\n \"malwares_data\": [],\n \"threat_actors\": [],\n \"threat_actors_data\": [],\n \"readable_id\": \"DVC102\",\n \"owner_data\": null,\n \"manager_data\": null,\n \"briefings\": [],\n \"briefings_data\": [],\n \"applications\": [],\n \"applications_data\": [],\n \"softwares\": [],\n \"softwares_data\": [],\n \"labels\": [\n \"ae0364e5-49d9-4a00-a465-ccac7b22b07b\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"ae0364e5-49d9-4a00-a465-ccac7b22b07b\",\n \"title\": \"Blue Label Devices\",\n \"color_code\": \"#BF360C\",\n \"created\": \"2023-04-21T07:02:09.884171Z\",\n \"modified\": \"2023-04-21T07:02:09.884171Z\"\n }\n ],\n \"operating_systems_data\": [],\n \"manufacturer_data\": {\n \"title\": \"AMD\",\n \"unique_id\": \"6222f5d9-cec8-47c6-95e7-fcecc9a393e3\"\n },\n \"business_units_data\": [\n {\n \"title\": \"System\",\n \"unique_id\": \"514f171a-0189-4aa5-bd71-564f7478b4b4\"\n }\n ],\n \"locations_data\": [\n {\n \"title\": \"System\",\n \"unique_id\": \"bb655f9f-a910-44a4-86f5-d56350d42dee\",\n \"is_active\": true\n }\n ],\n \"category_data\": {\n \"title\": \"Cyber\",\n \"unique_id\": \"81400f66-0d5f-4abb-b3ee-b3feb23f0f14\"\n },\n \"ip_address\": \"1.1.1.1\",\n \"created_by\": \"097d3adb-0def-4e4e-8902-5844b71cd42e\",\n \"created_by_data\": {\n \"username\": \"jane.doe\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"097d3adb-0def-4e4e-8902-5844b71cd42e\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"title_display\": \"device from openapi\",\n \"status\": null,\n \"dns_details\": null,\n \"description\": null,\n \"third_party_asset_type\": null,\n \"criticality\": null,\n \"third_party_business_unit\": null,\n \"site_code\": null,\n \"site_region\": null,\n \"site_country\": null,\n \"asset_type\": \"endpoint\",\n \"third_party_asset_type_verbose\": null,\n \"asset\": null,\n \"cftr_site_code\": null,\n \"cftr_site_region\": null,\n \"cftr_site_country\": null,\n \"vendor_supported\": null,\n \"model_id\": null,\n \"operational_status\": null,\n \"physical_location\": null,\n \"third_party_ip_address\": null,\n \"third_party_sync_id\": null,\n \"discovery_source\": null,\n \"mac_address\": null,\n \"endpoint_status\": \"clean\",\n \"threat_score\": null,\n \"actions_data\": [],\n \"browsers_installed_data\": [\n {\n \"unique_id\": \"29f22339-2340-441b-9208-22fea7a7befa\",\n \"option_name\": \"Chrome\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"c9fd6bab-166b-473f-a631-91516c0138ca\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"av_installed_data\": {\n \"unique_id\": \"4707748b-6bff-433c-b940-46582ec0e653\",\n \"option_name\": \"Yes\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"df4c46eb-94a1-40fb-b391-9687ca10bc85\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"endpoint_type_data\": {\n \"unique_id\": \"657e9ae9-9cfa-4e14-bfc4-b96182e5e68e\",\n \"option_name\": \"Desktop\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"2b20e720-4e3a-4a3e-8343-77769abba9a9\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"openshares_data\": null,\n \"ownership_data\": null,\n \"annual_maintainance_contract_data\": {\n \"unique_id\": \"3736036e-2fb6-46e8-ae1f-15955183715c\",\n \"option_name\": \"Yes\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"369a6ba1-ce10-494a-ac0f-0b345be37c7c\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"usb_access_data\": null,\n \"security_patches_deployed_data\": null,\n \"hips_installed_data\": null,\n \"edr_installed_data\": null,\n \"under_warranty_data\": null,\n \"internet_access_data\": null,\n \"admin_access_data\": null,\n \"disk_encryption_data\": null,\n \"rogue_data\": null\n}"}],"_postman_id":"376dd63c-c5b0-4166-86cc-ca0368f74616"},{"name":"Add Comment in Device","id":"ee3b1ec5-aec5-440f-9671-4163ab09c667","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"description\": \"

Note For Device

\",\n \"mentioned_users_usernames\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/comments/device/:device_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Add notes to a device in the CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`description`	String	Mandatory	Enter the content of the comment.
`mentioned_users_usernames`	List of UUID	Optional	Enter the list of usernames of users mentioned in the comment.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the comment.
`description`	Text	Description of the comment.
`created_by`	Object	Details of the user who added the comment. Details include: first_name, last_name, email, and more.
`modified_by`	Object	Details of the user who last updated the comment.
`is_removed`	Boolean	Displays if the comment is deleted or not.
`mentioned_users`	List of UUIDs	List of `user_id` of users mentioned in the comment.
`mentioned_users_data`	List of Objects	Details of the users mentioned in the comment.
`created`	String	Comment creation time.
`modified`	String	Comment last updated time.
`comment_type`	String	Type of Comment. Examples: `discussion`: Notes added in any instance.
`content_object`	String	Component in which the comment is added. Example: `device`, `incident`, `action`, `ioc`, and so on.
`content_object_readable_id`	String	`readable_id` of the instance in which comment is added.
`content_object_unique_id`	String	`unique_id` of the instance in which comment is added.
`description_with_img_src`	Text	Description of the content with the image URLs (if any image is added in the comment).
`pinned`	Boolean	Displays whether the comment is pinned or not.

","urlObject":{"path":["comments","device",":device_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the device.

\n","type":"text/plain"},"type":"any","value":"fb114af7-73a7-472d-b655-23a484107b22","key":"device_unique_id"}]}},"response":[{"id":"9a84f782-87be-45fe-81e6-478daa6ae7c1","name":"Add Comment in Device","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"description\": \"

Note For Device

\",\n \"mentioned_users_usernames\": []\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/comments/device/:device_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["comments","device",":device_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"device_unique_id","value":"fb114af7-73a7-472d-b655-23a484107b22","description":"`unique_id` of device"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Wed, 02 Feb 2022 15:03:07 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"854","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"Access-Control-Allow-Origin","value":"http://127.0.0.1:8080","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"unique_id\": \"ab8afdf2-9955-405b-9c21-3c8a15b9228d\",\n \"description\": \"

Note For Device

\",\n \"created_by\": {\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"display_pic\": null,\n \"username\": \"jane\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"Jane Doe\"\n },\n \"modified_by\": null,\n \"is_removed\": false,\n \"mentioned_users\": [],\n \"mentioned_users_data\": [],\n \"created\": \"2022-02-02T15:03:06.656974Z\",\n \"modified\": \"2022-02-02T15:03:06.697873Z\",\n \"email\": null,\n \"internal\": false,\n \"comment_type\": \"discussion\",\n \"command_params\": {},\n \"command_result\": {},\n \"command_status\": \"na\",\n \"attachments_data\": [],\n \"content_object\": \"device\",\n \"content_object_readable_id\": \"DVC1220\",\n \"content_object_unique_id\": \"fb114af7-73a7-472d-b655-23a484107b22\",\n \"attachment_label\": null,\n \"description_with_img_src\": \"

Note For Device

\"\n}"}],"_postman_id":"ee3b1ec5-aec5-440f-9671-4163ab09c667"}],"id":"811e57bb-cfd3-4d54-9dd3-02b6ff6a0b4f","description":"

The compromise of weak endpoints can help cyber criminals in stealing the organization data or personal data from the systems connected to an organizational network. Therefore, securing the Devices is important for an organization. The Device module is configured to provide important hardware and network data associated with the particular Device. Also, actions that are necessary for precaution such as license and servicing details including the software and security patches installed to the Device can be tracked swiftly. This helps in providing prompt response to Device related threats as well as securing the confidentiality, integrity, and availability of information stored by these assets.

This section describes how to use the API endpoints to manage devices in the CFTR application.

\n","_postman_id":"811e57bb-cfd3-4d54-9dd3-02b6ff6a0b4f"},{"name":"Threat Intel","item":[{"name":"Get List of Threat Intel","id":"c1a28e04-7cd5-4c32-a425-2428d87acbb1","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/ioc-module/ioc/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve a list of all the threat intels with details from the CFTR application.

REQUEST PARAMETERS

This API endpoint does not require any input parameter.

RESPONSE PARAMETERS

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` shows the API endpoint to the next page.
`count`	Integer	Total number of Threat Intels in CFTR application.
`results`	List	Details of the Threat Intels. Each object provides details of one Threat Intel.

Response Parameters | Results Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`value`	String	Value of the Threat Intel.
`unique_id`	String	Unique ID of the Threat Intel in UUID-4 format.
`created`	String	Creation date and time of the Threat Intel.
`modified`	String	Last updated date and time of the Threat Intel.
`tlp`	String	TLP associated with the Threat Intel. Allowed values: `RED` `AMBER` `GREEN` `WHITE`
`incidents_data`	List of Objects	Details of Incidents associated with the Threat Intel. Details include: `unique_id`, `readable_id`, and `title`.
`status`	String	Current status of the Threat Intel. Allowed values: `cleaned` `blocked` `malicious` `false_positive` `whitelisted` `none`
`labels_data`	List of Objects	Details of labels added to the Threat Intel. Details include `title`, `color_code`, `unique_id`, `created`, and `modified`.
`malwares_data`	List of Objects	Details of the Malware associated with the Threat Intel. Details include: `unique_id`, `readable_id`, and `title`.
`threat_actors_data`	List of Objects	Details of Threat Actors associated with the Threat Intel.
`vulnerabilities_data`	List of Objects	Details of Vulnerabilities associated with the Threat Intel. Details include: `unique_id`, `readable_id`, and `title`.
`actions_count`	Integer	Number of Actions added to the Threat Intel.
`notes_count`	Integer	Number of comments added to the Threat Intel.
`ioc_type`	String	`unique_id` of the Indicator type.
`ioc_type_data`	Object	Details of the Indicator type.

","urlObject":{"path":["ioc-module","ioc",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"disabled":true,"description":{"content":"

[optional] Enter the page number of the threat intel list to retrieve the list of all threat intels from the entered page.\nDefault value: 1

\n","type":"text/plain"},"key":"page","value":"2"},{"disabled":true,"description":{"content":"

[optional] Enter number of threat intels per page. Default value: 10

\n","type":"text/plain"},"key":"page_size","value":"5"},{"disabled":true,"description":{"content":"

[optional] Enter the title of the threat intel type. This parameter retrieves the threat intels associated with the threat intel type.

You can retrieve the list of available Threat Intel types and their titles using the following API endpoint:\nopenapi/v1/ioc-module/ioc-type/

\n","type":"text/plain"},"key":"type","value":"ioc_ip"},{"disabled":true,"description":{"content":"

[optional] Enter the TLP of the threat intel. Allowed values:

RED
AMBER
GREEN
WHITE

\n","type":"text/plain"},"key":"tlp","value":"RED"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the Threat Intel in EPOCH Time format. Time zone must be as per UTC. All Threat Intels with creation date later than the entered time will be returned.

\n","type":"text/plain"},"key":"created_date__gte","value":"1643283426"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the Threat Intel in EPOCH Time format. Time zone must be as per UTC. All Threat Intels with creation date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"created_date__lte","value":"1643283426"},{"disabled":true,"description":{"content":"

[optional] Enter the status of the threat intel. Allowed values:

cleaned
blocked
malicious
false_positive
whitelisted
none

\n","type":"text/plain"},"key":"status","value":"cleaned"}],"variable":[]}},"response":[{"id":"1ae5b0cb-48b7-43f7-86a9-58817827c433","name":"Get List of Threat Intel","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/ioc-module/ioc/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["ioc-module","ioc",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Tue, 15 Feb 2022 06:55:05 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"9176","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {\n \"next\": \"openapi/v1/ioc-module/ioc/?page=2&page_size=10&AccessID=769b74b8-23af-4abb-a99f-952ca699ac2c&Expires=1644908120&Signature=ubpjqTqffVvDy4zVhLdvhG8nqr4=\"\n },\n \"count\": 14,\n \"results\": [\n {\n \"value\": \"4.4.4.4\",\n \"351684a2-d49c-465d-ae77-04d9782cc595_data\": {\n \"title\": \"ioc_ip\",\n \"unique_id\": \"82b30619-edfc-411a-9d3c-0fd421faf002\",\n \"created\": \"2021-06-09T09:35:59.811357Z\",\n \"modified\": \"2021-06-09T09:37:05.777816Z\",\n \"display_name\": \"IP\"\n },\n \"unique_id\": \"d2419859-df61-4235-9a33-b92390f55b96\",\n \"created\": \"2022-02-10T05:51:20.065908Z\",\n \"modified\": \"2022-02-10T05:51:20.065908Z\",\n \"tlp\": \"WHITE\",\n \"incidents_data\": [\n {\n \"unique_id\": \"c2a76a82-0f65-41e6-a3df-e54585aa775a\",\n \"readable_id\": \"INC591\",\n \"title\": \"update openapi incident\"\n }\n ],\n \"status\": \"none\",\n \"labels_data\": [],\n \"malwares_data\": [],\n \"threat_actors_data\": [],\n \"vulnerabilities_data\": [],\n \"actions_count\": 0,\n \"notes_count\": 0,\n \"ioc_type\": \"82b30619-edfc-411a-9d3c-0fd421faf002\",\n \"ioc_type_data\": {\n \"title\": \"ioc_ip\",\n \"unique_id\": \"82b30619-edfc-411a-9d3c-0fd421faf002\",\n \"created\": \"2021-06-09T09:35:59.811357Z\",\n \"modified\": \"2021-06-09T09:37:05.777816Z\",\n \"display_name\": \"IP\"\n }\n },\n {\n \"value\": \"http://127.0.0.1:8080/\",\n \"351684a2-d49c-465d-ae77-04d9782cc595_data\": {\n \"title\": \"ioc_url\",\n \"unique_id\": \"d8525baf-0193-4d56-9216-3354c0c205d9\",\n \"created\": \"2021-06-09T09:35:59.824229Z\",\n \"modified\": \"2021-06-09T09:37:06.186668Z\",\n \"display_name\": \"URL\"\n },\n \"unique_id\": \"be7e914f-9684-4ef4-9e44-d85eb11dd9a6\",\n \"created\": \"2022-02-09T09:41:05.334173Z\",\n \"modified\": \"2022-02-09T09:41:06.156302Z\",\n \"tlp\": \"WHITE\",\n \"incidents_data\": [\n {\n \"unique_id\": \"9e824ebd-a4ec-45e4-b81e-bd0544e86ecd\",\n \"readable_id\": \"INC590\",\n \"title\": \"test incident\"\n }\n ],\n \"status\": \"none\",\n \"labels_data\": [],\n \"malwares_data\": [],\n \"threat_actors_data\": [],\n \"vulnerabilities_data\": [],\n \"actions_count\": 0,\n \"notes_count\": 0,\n \"ioc_type\": \"d8525baf-0193-4d56-9216-3354c0c205d9\",\n \"ioc_type_data\": {\n \"title\": \"ioc_url\",\n \"unique_id\": \"d8525baf-0193-4d56-9216-3354c0c205d9\",\n \"created\": \"2021-06-09T09:35:59.824229Z\",\n \"modified\": \"2021-06-09T09:37:06.186668Z\",\n \"display_name\": \"URL\"\n }\n },\n {\n \"value\": \"3.3.3.3\",\n \"351684a2-d49c-465d-ae77-04d9782cc595_data\": {\n \"title\": \"ioc_ip\",\n \"unique_id\": \"82b30619-edfc-411a-9d3c-0fd421faf002\",\n \"created\": \"2021-06-09T09:35:59.811357Z\",\n \"modified\": \"2021-06-09T09:37:05.777816Z\",\n \"display_name\": \"IP\"\n },\n \"unique_id\": \"cb73ac9e-370f-4f1e-8b76-18171e8a5041\",\n \"created\": \"2022-02-07T14:33:09.456494Z\",\n \"modified\": \"2022-02-07T14:33:09.456494Z\",\n \"tlp\": \"WHITE\",\n \"incidents_data\": [],\n \"status\": \"none\",\n \"labels_data\": [],\n \"malwares_data\": [],\n \"threat_actors_data\": [],\n \"vulnerabilities_data\": [],\n \"actions_count\": 0,\n \"notes_count\": 0,\n \"ioc_type\": \"82b30619-edfc-411a-9d3c-0fd421faf002\",\n \"ioc_type_data\": {\n \"title\": \"ioc_ip\",\n \"unique_id\": \"82b30619-edfc-411a-9d3c-0fd421faf002\",\n \"created\": \"2021-06-09T09:35:59.811357Z\",\n \"modified\": \"2021-06-09T09:37:05.777816Z\",\n \"display_name\": \"IP\"\n }\n },\n {\n \"value\": \"2.2.2.2\",\n \"351684a2-d49c-465d-ae77-04d9782cc595_data\": {\n \"title\": \"ioc_ip\",\n \"unique_id\": \"82b30619-edfc-411a-9d3c-0fd421faf002\",\n \"created\": \"2021-06-09T09:35:59.811357Z\",\n \"modified\": \"2021-06-09T09:37:05.777816Z\",\n \"display_name\": \"IP\"\n },\n \"unique_id\": \"0c799edc-e540-4eb2-b580-a8475cea0863\",\n \"created\": \"2022-02-07T14:33:09.440391Z\",\n \"modified\": \"2022-02-07T14:33:09.440391Z\",\n \"tlp\": \"WHITE\",\n \"incidents_data\": [\n {\n \"unique_id\": \"c2a76a82-0f65-41e6-a3df-e54585aa775a\",\n \"readable_id\": \"INC591\",\n \"title\": \"update openapi incident\"\n }\n ],\n \"status\": \"none\",\n \"labels_data\": [],\n \"malwares_data\": [],\n \"threat_actors_data\": [],\n \"vulnerabilities_data\": [],\n \"actions_count\": 0,\n \"notes_count\": 0,\n \"ioc_type\": \"82b30619-edfc-411a-9d3c-0fd421faf002\",\n \"ioc_type_data\": {\n \"title\": \"ioc_ip\",\n \"unique_id\": \"82b30619-edfc-411a-9d3c-0fd421faf002\",\n \"created\": \"2021-06-09T09:35:59.811357Z\",\n \"modified\": \"2021-06-09T09:37:05.777816Z\",\n \"display_name\": \"IP\"\n }\n },\n {\n \"value\": \"tenant_code.example.com\",\n \"351684a2-d49c-465d-ae77-04d9782cc595_data\": {\n \"title\": \"ioc_domain\",\n \"unique_id\": \"d8525baf-0193-4d56-9216-3354c0c205d9\",\n \"created\": \"2021-06-09T09:35:59.824229Z\",\n \"modified\": \"2021-06-09T09:37:06.186668Z\",\n \"display_name\": \"Domain\"\n },\n \"unique_id\": \"ea3214cd-482a-4531-a0be-5e297e693abb\",\n \"created\": \"2022-01-19T13:15:24.965062Z\",\n \"modified\": \"2022-01-19T13:15:58.250409Z\",\n \"tlp\": \"WHITE\",\n \"incidents_data\": [\n {\n \"unique_id\": \"6bc1d2b8-1254-4268-a3c6-249149f98d28\",\n \"readable_id\": \"INC585\",\n \"title\": \"t\"\n }\n ],\n \"status\": \"none\",\n \"labels_data\": [],\n \"malwares_data\": [],\n \"threat_actors_data\": [],\n \"vulnerabilities_data\": [],\n \"actions_count\": 0,\n \"notes_count\": 1,\n \"ioc_type\": \"d8525baf-0193-4d56-9216-3354c0c205d9\",\n \"ioc_type_data\": {\n \"title\": \"ioc_url\",\n \"unique_id\": \"d8525baf-0193-4d56-9216-3354c0c205d9\",\n \"created\": \"2021-06-09T09:35:59.824229Z\",\n \"modified\": \"2021-06-09T09:37:06.186668Z\",\n \"display_name\": \"URL\"\n }\n },\n {\n \"value\": \"10.20.81.51\",\n \"351684a2-d49c-465d-ae77-04d9782cc595_data\": {\n \"title\": \"ioc_ip\",\n \"unique_id\": \"82b30619-edfc-411a-9d3c-0fd421faf002\",\n \"created\": \"2021-06-09T09:35:59.811357Z\",\n \"modified\": \"2021-06-09T09:37:05.777816Z\",\n \"display_name\": \"IP\"\n },\n \"unique_id\": \"ca0ef982-4b67-4968-9d2c-4bff531dbd5d\",\n \"created\": \"2021-12-23T06:33:54.233918Z\",\n \"modified\": \"2022-01-06T15:38:25.279695Z\",\n \"tlp\": \"WHITE\",\n \"incidents_data\": [\n {\n \"unique_id\": \"9da26277-93d2-4d02-8ff4-55a3177e35ac\",\n \"readable_id\": \"INC579\",\n \"title\": \"Incident created for demo purpose 1\"\n }\n ],\n \"status\": \"none\",\n \"labels_data\": [],\n \"malwares_data\": [],\n \"threat_actors_data\": [],\n \"vulnerabilities_data\": [],\n \"actions_count\": 0,\n \"notes_count\": 2,\n \"ioc_type\": \"82b30619-edfc-411a-9d3c-0fd421faf002\",\n \"ioc_type_data\": {\n \"title\": \"ioc_ip\",\n \"unique_id\": \"82b30619-edfc-411a-9d3c-0fd421faf002\",\n \"created\": \"2021-06-09T09:35:59.811357Z\",\n \"modified\": \"2021-06-09T09:37:05.777816Z\",\n \"display_name\": \"IP\"\n }\n },\n {\n \"value\": \"100.200.300.400\",\n \"351684a2-d49c-465d-ae77-04d9782cc595_data\": {\n \"title\": \"ioc_ip\",\n \"unique_id\": \"82b30619-edfc-411a-9d3c-0fd421faf002\",\n \"created\": \"2021-06-09T09:35:59.811357Z\",\n \"modified\": \"2021-06-09T09:37:05.777816Z\",\n \"display_name\": \"IP\"\n },\n \"unique_id\": \"7129d7ad-0d22-45fd-978e-35d53756f05a\",\n \"created\": \"2021-12-23T07:00:55.412977Z\",\n \"modified\": \"2022-01-06T06:07:49.083166Z\",\n \"tlp\": \"WHITE\",\n \"incidents_data\": [\n {\n \"unique_id\": \"9da26277-93d2-4d02-8ff4-55a3177e35ac\",\n \"readable_id\": \"INC579\",\n \"title\": \"Incident created for demo purpose 1\"\n }\n ],\n \"status\": \"malicious\",\n \"labels_data\": [],\n \"malwares_data\": [],\n \"threat_actors_data\": [],\n \"vulnerabilities_data\": [],\n \"actions_count\": 0,\n \"notes_count\": 2,\n \"ioc_type\": \"82b30619-edfc-411a-9d3c-0fd421faf002\",\n \"ioc_type_data\": {\n \"title\": \"ioc_ip\",\n \"unique_id\": \"82b30619-edfc-411a-9d3c-0fd421faf002\",\n \"created\": \"2021-06-09T09:35:59.811357Z\",\n \"modified\": \"2021-06-09T09:37:05.777816Z\",\n \"display_name\": \"IP\"\n }\n },\n {\n \"value\": \"12345\",\n \"351684a2-d49c-465d-ae77-04d9782cc595_data\": {\n \"title\": \"ioc_test_6\",\n \"unique_id\": \"f295945e-ac32-4fba-8bfd-12193f1c205a\",\n \"created\": \"2021-12-27T06:22:02.445579Z\",\n \"modified\": \"2021-12-27T06:22:02.445579Z\",\n \"display_name\": \"test 6\"\n },\n \"unique_id\": \"7201323c-525a-4dea-ba7c-414cc3143124\",\n \"created\": \"2021-12-27T06:27:12.887870Z\",\n \"modified\": \"2021-12-27T06:31:48.847226Z\",\n \"tlp\": \"WHITE\",\n \"incidents_data\": [\n {\n \"unique_id\": \"9da26277-93d2-4d02-8ff4-55a3177e35ac\",\n \"readable_id\": \"INC579\",\n \"title\": \"Incident created for demo purpose 1\"\n }\n ],\n \"status\": \"false_positive\",\n \"labels_data\": [],\n \"malwares_data\": [\n {\n \"unique_id\": \"a4feb001-e913-4da5-97ad-bbe5f4d3228a\",\n \"readable_id\": \"MLW122\",\n \"title\": \"Malware created for demo purpose 2\"\n }\n ],\n \"threat_actors_data\": [],\n \"vulnerabilities_data\": [],\n \"actions_count\": 0,\n \"notes_count\": 0,\n \"ioc_type\": \"f295945e-ac32-4fba-8bfd-12193f1c205a\",\n \"ioc_type_data\": {\n \"title\": \"ioc_test_6\",\n \"unique_id\": \"f295945e-ac32-4fba-8bfd-12193f1c205a\",\n \"created\": \"2021-12-27T06:22:02.445579Z\",\n \"modified\": \"2021-12-27T06:22:02.445579Z\",\n \"display_name\": \"test 6\"\n }\n },\n {\n \"value\": \"1234\",\n \"351684a2-d49c-465d-ae77-04d9782cc595_data\": {\n \"title\": \"ioc_test_6\",\n \"unique_id\": \"f295945e-ac32-4fba-8bfd-12193f1c205a\",\n \"created\": \"2021-12-27T06:22:02.445579Z\",\n \"modified\": \"2021-12-27T06:22:02.445579Z\",\n \"display_name\": \"test 6\"\n },\n \"unique_id\": \"7494966a-4da0-4b75-b71c-af1f36ba8049\",\n \"created\": \"2021-12-27T06:23:17.351636Z\",\n \"modified\": \"2021-12-27T06:23:17.351636Z\",\n \"tlp\": \"WHITE\",\n \"incidents_data\": [\n {\n \"unique_id\": \"9da26277-93d2-4d02-8ff4-55a3177e35ac\",\n \"readable_id\": \"INC579\",\n \"title\": \"Incident created for demo purpose 1\"\n }\n ],\n \"status\": \"none\",\n \"labels_data\": [],\n \"malwares_data\": [],\n \"threat_actors_data\": [],\n \"vulnerabilities_data\": [],\n \"actions_count\": 0,\n \"notes_count\": 0,\n \"ioc_type\": \"f295945e-ac32-4fba-8bfd-12193f1c205a\",\n \"ioc_type_data\": {\n \"title\": \"ioc_test_6\",\n \"unique_id\": \"f295945e-ac32-4fba-8bfd-12193f1c205a\",\n \"created\": \"2021-12-27T06:22:02.445579Z\",\n \"modified\": \"2021-12-27T06:22:02.445579Z\",\n \"display_name\": \"test 6\"\n }\n },\n {\n \"value\": \"abcd\",\n \"351684a2-d49c-465d-ae77-04d9782cc595_data\": {\n \"title\": \"ioc_test_5\",\n \"unique_id\": \"9de0cd81-c4ca-4f15-bcd4-d19ea2f25108\",\n \"created\": \"2021-12-23T08:39:58.160389Z\",\n \"modified\": \"2021-12-23T08:39:58.160389Z\",\n \"display_name\": \"test 5\"\n },\n \"unique_id\": \"2d7b887c-6a4f-41e8-a9a2-80491137a230\",\n \"created\": \"2021-12-23T08:41:30.367613Z\",\n \"modified\": \"2021-12-23T08:45:14.457206Z\",\n \"tlp\": \"WHITE\",\n \"incidents_data\": [\n {\n \"unique_id\": \"9da26277-93d2-4d02-8ff4-55a3177e35ac\",\n \"readable_id\": \"INC579\",\n \"title\": \"Incident created for demo purpose 1\"\n }\n ],\n \"status\": \"cleaned\",\n \"labels_data\": [],\n \"malwares_data\": [],\n \"threat_actors_data\": [],\n \"vulnerabilities_data\": [],\n \"actions_count\": 0,\n \"notes_count\": 0,\n \"ioc_type\": \"9de0cd81-c4ca-4f15-bcd4-d19ea2f25108\",\n \"ioc_type_data\": {\n \"title\": \"ioc_test_5\",\n \"unique_id\": \"9de0cd81-c4ca-4f15-bcd4-d19ea2f25108\",\n \"created\": \"2021-12-23T08:39:58.160389Z\",\n \"modified\": \"2021-12-23T08:39:58.160389Z\",\n \"display_name\": \"test 5\"\n }\n }\n ]\n}"}],"_postman_id":"c1a28e04-7cd5-4c32-a425-2428d87acbb1"},{"name":"Get Details of a Threat Intel","id":"4f4160ec-5101-46fb-9eac-aa91262d6e59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/ioc-module/ioc/:ioc_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the details of a Threat Intel from the CFTR application.

REQUEST PARAMETERS

This API endpoint does not require any input parameter.

RESPONSE PARAMETERS

Parameter	Type	Description
`value`	String	Value of the Threat Intel.
`unique_id`	String	Unique ID of the Threat Intel in UUID-4 format.
`created`	String	Creation date and time of the Threat Intel.
`modified`	String	Last Updated date and time of the Threat Intel.
`geo_details`	List of Objects	Details of the location of threat intel.
`tlp`	String	TLP associated with the threat intel. Allowed values: `RED` `AMBER` `GREEN` `WHITE`
`incidents_data`	List of Objects	Details of Incidents associated with the Threat Intel. Details include: `unique_id`, `readable_id`, and `title`.
`created_by`	String	`user_id` of the user who created the Threat Intel
`status`	String	Current status of the Threat Intel. Allowed values: `cleaned` `blocked` `malicious` `false_positive` `whitelisted` `none`
`labels`	List	List of `unique_id` of labels added to the Threat Intel.
`labels_data`	List of Objects	Details of labels added to the Threat Intel. Details include `title`, `color_code`, `unique_id`, `created`, and `modified`.
`malwares_data`	List of Objects	Details of Malware associated with the Threat Intel. Details include: `unique_id`, `readable_id,` and `title`.
`threat_actors_data`	List of Objects	Details of Threat Actors associated with the Threat Intel.
`vulnerabilities_data`	List of Objects	Details of Vulnerabilities associated with the Threat Intel. Details include: `unique_id`, `readable_id`, and `title`.
`actions_count`	Integer	Number of Actions added to the Threat Intel.
`notes_count`	Integer	Number of comments added to the Threat Intel.
`ioc_type`	String	`unique_id` of the Indicator Type.
`ioc_type_data`	Object	Details of the Indicator Type.

Response Parameters | Custom Fields

In addition to the above mentioned parameters, the response parameters may vary as per the form configuration defined by your CFTR admin for Threat Intel. For such parameters, the field_readable_key of each parameter is returned in the response. To retrieve the field_readable_key and additional metadata of a parameter, use the Form Tab Structure API for threat intel.

EXAMPLE

The following endpoint retrieves the field_readable_key for all custom fields in the Threat Intel component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=ioc\n\n

","urlObject":{"path":["ioc-module","ioc",":ioc_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of a Threat Intel.

\n","type":"text/plain"},"type":"any","value":"d2419859-df61-4235-9a33-b92390f55b96","key":"ioc_unique_id"}]}},"response":[{"id":"958b740a-200f-4cb0-a6e4-36cf33a83af0","name":"Get Details Of Threat Intel","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/ioc-module/ioc/d2419859-df61-4235-9a33-b92390f55b96/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["ioc-module","ioc","d2419859-df61-4235-9a33-b92390f55b96",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Tue, 15 Feb 2022 10:10:21 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1919","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"4.4.4.4\",\n \"351684a2-d49c-465d-ae77-04d9782cc595\": \"82b30619-edfc-411a-9d3c-0fd421faf002\",\n \"351684a2-d49c-465d-ae77-04d9782cc595_data\": {\n \"title\": \"ioc_ip\",\n \"unique_id\": \"82b30619-edfc-411a-9d3c-0fd421faf002\",\n \"created\": \"2021-06-09T09:35:59.811357Z\",\n \"modified\": \"2021-06-09T09:37:05.777816Z\",\n \"display_name\": \"IP\"\n },\n \"unique_id\": \"d2419859-df61-4235-9a33-b92390f55b96\",\n \"created\": \"2022-02-10T05:51:20.065908Z\",\n \"geo_details\": {\n \"country\": {\n \"country_code\": \"US\",\n \"country_name\": \"United States\"\n },\n \"city\": {\n \"city\": null,\n \"continent_code\": \"NA\",\n \"continent_name\": \"North America\",\n \"country_code\": \"US\",\n \"country_name\": \"United States\",\n \"dma_code\": null,\n \"is_in_european_union\": false,\n \"latitude\": 37.751,\n \"longitude\": -97.822,\n \"postal_code\": null,\n \"region\": null,\n \"time_zone\": null\n }\n },\n \"modified\": \"2022-02-15T10:07:55.657923Z\",\n \"tlp\": \"WHITE\",\n \"incidents_data\": [\n {\n \"unique_id\": \"c2a76a82-0f65-41e6-a3df-e54585aa775a\",\n \"readable_id\": \"INC591\",\n \"title\": \"update openapi incident\"\n }\n ],\n \"created_by\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"status\": \"cleaned\",\n \"labels\": [\n \"aa0e179f-b87f-4701-bbef-6db059abbd70\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"aa0e179f-b87f-4701-bbef-6db059abbd70\",\n \"title\": \"L1\",\n \"color_code\": \"#4527A0\",\n \"created\": \"2022-02-15T09:48:00.518119Z\",\n \"modified\": \"2022-02-15T09:48:00.518119Z\"\n }\n ],\n \"malwares_data\": [\n {\n \"unique_id\": \"a4feb001-e913-4da5-97ad-bbe5f4d3228a\",\n \"readable_id\": \"MLW122\",\n \"title\": \"Malware created for demo purpose 2\"\n },\n {\n \"unique_id\": \"427e678d-84b1-441b-9d3f-d5a152404a0c\",\n \"readable_id\": \"MLW121\",\n \"title\": \"Malware created for demo purpose 1\"\n }\n ],\n \"threat_actors_data\": [],\n \"vulnerabilities_data\": [\n {\n \"unique_id\": \"e6f50eb7-10d4-481a-8375-d164470455bc\",\n \"readable_id\": \"VUL101\",\n \"title\": \"Vulnerability 1.0.0\"\n }\n ],\n \"actions_count\": 0,\n \"notes_count\": 0,\n \"ioc_type\": \"82b30619-edfc-411a-9d3c-0fd421faf002\",\n \"ioc_type_data\": {\n \"title\": \"ioc_ip\",\n \"unique_id\": \"82b30619-edfc-411a-9d3c-0fd421faf002\",\n \"created\": \"2021-06-09T09:35:59.811357Z\",\n \"modified\": \"2021-06-09T09:37:05.777816Z\",\n \"display_name\": \"IP\"\n }\n}"}],"_postman_id":"4f4160ec-5101-46fb-9eac-aa91262d6e59"},{"name":"Get List of Threat Intel Types","id":"25f7cde5-9cd0-480e-937a-fb392e0d0723","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/ioc-module/ioc-type/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the details of all the Threat Intel types in CFTR application.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` shows the API endpoint to the next page.
`count`	Integer	Total number of Threat Intel types in CFTR application.
`results`	List	Details of the Threat Intel types. Each object provides details of one Threat Intel type.

Response Parameters | Results Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	Title of the Threat Intel type. This key is used to refer to Threat Intel type by other APIs.
`unique_id`	String	Unique ID of the Threat Intel type.
`created`	String	Creation date and time of the Threat Intel type.
`modified`	String	Last updated date and time of the Threat Intel type.
`display_name`	String	Name of the Threat Intel type.

","urlObject":{"path":["ioc-module","ioc-type",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"disabled":true,"description":{"content":"

[optional] Enter the name of the Threat Intel type. This key filters Threat Intel types by their display names. Examples:\nIP, Domain, URL, Email, SHA1, SHA256, MD5.

\n","type":"text/plain"},"key":"display_name","value":"IP"},{"disabled":true,"description":{"content":"

[optional] Enter the title of the Threat Intel. This key filters Threat Intels by their title. Examples:\nioc_ip, ioc_domain, ioc_email, ioc_url, ioc_SHA1, ioc_SHA256, ioc_MD5.

\n","type":"text/plain"},"key":"title","value":"ioc_ip"}],"variable":[]}},"response":[{"id":"dcf187a4-ab36-4799-8092-47e269db3765","name":"Get List of Threat Intel Types","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/ioc-module/ioc-type/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["ioc-module","ioc-type",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Tue, 15 Feb 2022 10:41:44 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"2046","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {\n \"next\": \"openapi/v1/ioc-module/ioc-type/?page=2&page_size=10&AccessID=769b74b8-23af-4abb-a99f-952ca699ac2c&Expires=1644921719&Signature=3+2KSd08mZGr1V3EVrhp+EdITLo=\"\n },\n \"count\": 18,\n \"results\": [\n {\n \"title\": \"hash\",\n \"unique_id\": \"48dda6e9-17c5-4a8d-bdee-c0fa1789ae21\",\n \"created\": \"2021-06-09T09:41:38.809554Z\",\n \"modified\": \"2021-06-09T09:41:38.809554Z\",\n \"display_name\": \"\"\n },\n {\n \"title\": \"ioc_SHA256\",\n \"unique_id\": \"2bc7781b-4b06-4eae-8ff9-bebd4078d28b\",\n \"created\": \"2021-06-09T09:35:59.835830Z\",\n \"modified\": \"2021-06-09T09:37:07.055271Z\",\n \"display_name\": \"SHA256\"\n },\n {\n \"title\": \"ioc_SHA1\",\n \"unique_id\": \"d133dd7a-adfc-45a2-ad4d-1a04afc40384\",\n \"created\": \"2021-06-09T09:35:59.843341Z\",\n \"modified\": \"2021-06-09T09:37:06.823703Z\",\n \"display_name\": \"SHA1\"\n },\n {\n \"title\": \"ioc_MD5\",\n \"unique_id\": \"a84cc825-8c76-4a4e-b7b7-d2ca4fb78ea3\",\n \"created\": \"2021-06-09T09:35:59.850729Z\",\n \"modified\": \"2021-06-09T09:37:06.618686Z\",\n \"display_name\": \"MD5\"\n },\n {\n \"title\": \"ioc_email\",\n \"unique_id\": \"547ca705-ad6b-4b29-9250-4298adf20449\",\n \"created\": \"2021-06-09T09:35:59.817532Z\",\n \"modified\": \"2021-06-09T09:37:06.414607Z\",\n \"display_name\": \"Email\"\n },\n {\n \"title\": \"ioc_url\",\n \"unique_id\": \"d8525baf-0193-4d56-9216-3354c0c205d9\",\n \"created\": \"2021-06-09T09:35:59.824229Z\",\n \"modified\": \"2021-06-09T09:37:06.186668Z\",\n \"display_name\": \"URL\"\n },\n {\n \"title\": \"ioc_domain\",\n \"unique_id\": \"17f5e655-e492-4e02-b57c-6e70e13c36a9\",\n \"created\": \"2021-06-09T09:35:59.805028Z\",\n \"modified\": \"2021-06-09T09:37:05.970350Z\",\n \"display_name\": \"Domain\"\n },\n {\n \"title\": \"ioc_ip\",\n \"unique_id\": \"82b30619-edfc-411a-9d3c-0fd421faf002\",\n \"created\": \"2021-06-09T09:35:59.811357Z\",\n \"modified\": \"2021-06-09T09:37:05.777816Z\",\n \"display_name\": \"IP\"\n },\n {\n \"title\": \"Sender's email address\",\n \"unique_id\": \"5ccb4615-4b3a-44b9-9f4e-b970f85ece82\",\n \"created\": \"2021-06-09T09:35:59.798478Z\",\n \"modified\": \"2021-06-09T09:35:59.798478Z\",\n \"display_name\": \"Sender's email address\"\n },\n {\n \"title\": \"Origin IP Address\",\n \"unique_id\": \"d7ebc2d9-9f2c-4c4b-b0ba-3386f4fc1228\",\n \"created\": \"2021-06-09T09:35:59.792003Z\",\n \"modified\": \"2021-06-09T09:35:59.792003Z\",\n \"display_name\": \"Origin IP Address\"\n }\n ],\n \"mapping\": {\n \"dropdown_display_name\": \"readable_id\"\n }\n}"}],"_postman_id":"25f7cde5-9cd0-480e-937a-fb392e0d0723"},{"name":"Create Threat Intel in Bulk","id":"8ebe6a84-59e7-4bf0-8b29-e9c02e86b85f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"iocs\": {\n \"ioc_email\": [\n \"test@example.com\",\n \"test2@example.com\"\n ],\n \"ioc_domain\": [\n \"example.com\"\n ],\n \"ioc_MD5\": [],\n \"ioc_SHA1\": [],\n \"ioc_SHA256\": [],\n \"ioc_url\":[],\n \"ioc_ip\": []\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/ioc-module/ioc/bulk-create/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Create multiple Threat Intels in the CFTR application.

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`iocs`	Object	Mandatory	Key-value pairs of Threat Intel type and list of Threat Intels. Example: `\"iocs\": { \"ioc_ip\": [\"127.0.0.1\"] }`

You can retrieve the list of all threat intel types can be retrieved using the following API:

{{base_url}}/cftrapi/openapi/v1/ioc-module/ioc-type/\n\n

Note: From the response of this API endpoint, use the values of title parameters as the Threat Intel types.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`iocs`	Object	Key-value pairs of Threat Intel type and the corresponding Threat Intel `unique_id`.
`iocs_data`	Object	Key-value pairs of Threat Intel type and the corresponding Threat Intel data. Threat Intel data includes the following details: `value`, `tlp`, `status`, and `unique_id`.

","urlObject":{"path":["ioc-module","ioc","bulk-create",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"8fc47426-7611-4f05-9605-7818de45594c","name":"Create Threat Intel in Bulk","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"iocs\": {\n \"ioc_email\": [\n \"test@example.com\",\n \"test2@example.com\"\n ],\n \"ioc_domain\": [\n \"example.com\"\n ],\n \"ioc_MD5\": [],\n \"ioc_SHA1\": [],\n \"ioc_SHA256\": [],\n \"ioc_url\":[],\n \"ioc_ip\": []\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/v1/ioc-module/ioc/bulk-create/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}"],"path":["v1","ioc-module","ioc","bulk-create",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 30 Jan 2024 19:07:00 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"2834","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Server","value":"gunicorn/19.10.0","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"iocs\": {\n \"ioc_email\": [\n \"2418457e-6f88-4794-83ad-312a96ca765d\",\n \"548901f4-6bbb-450e-82ed-306e3daf59f1\"\n ],\n \"ioc_domain\": [\n \"084d4f06-ce20-4fd7-8fc1-0435c60e07c6\"\n ],\n \"ioc_MD5\": [],\n \"ioc_SHA1\": [],\n \"ioc_SHA256\": [],\n \"ioc_url\": [],\n \"ioc_ip\": []\n },\n \"iocs_data\": {\n \"ioc_email\": [\n {\n \"value\": \"test2@example.com\",\n \"51fa04aa-e439-4a03-941d-022f0f0fa8c2\": \"17e481bb-fe70-47f3-9b85-ff5d0fbffefb\",\n \"51fa04aa-e439-4a03-941d-022f0f0fa8c2_data\": {\n \"title\": \"ioc_email\",\n \"unique_id\": \"17e481bb-fe70-47f3-9b85-ff5d0fbffefb\",\n \"created\": \"2024-01-24T05:34:00.708126Z\",\n \"modified\": \"2024-01-24T05:34:00.708126Z\",\n \"display_name\": \"Email\",\n \"ctix_sdo_key\": null\n },\n \"unique_id\": \"2418457e-6f88-4794-83ad-312a96ca765d\",\n \"created\": \"2024-01-30T19:07:00.024563Z\",\n \"geo_details\": null,\n \"modified\": \"2024-01-30T19:07:00.176436Z\",\n \"tlp\": \"WHITE\",\n \"status\": \"none\",\n \"ctix_source\": null,\n \"ctix_object_id\": null,\n \"ioc_type\": \"17e481bb-fe70-47f3-9b85-ff5d0fbffefb\",\n \"ioc_type_data\": {\n \"title\": \"ioc_email\",\n \"unique_id\": \"17e481bb-fe70-47f3-9b85-ff5d0fbffefb\",\n \"created\": \"2024-01-24T05:34:00.708126Z\",\n \"modified\": \"2024-01-24T05:34:00.708126Z\",\n \"display_name\": \"Email\",\n \"ctix_sdo_key\": null\n }\n },\n {\n \"value\": \"test@example.com\",\n \"51fa04aa-e439-4a03-941d-022f0f0fa8c2\": \"17e481bb-fe70-47f3-9b85-ff5d0fbffefb\",\n \"51fa04aa-e439-4a03-941d-022f0f0fa8c2_data\": {\n \"title\": \"ioc_email\",\n \"unique_id\": \"17e481bb-fe70-47f3-9b85-ff5d0fbffefb\",\n \"created\": \"2024-01-24T05:34:00.708126Z\",\n \"modified\": \"2024-01-24T05:34:00.708126Z\",\n \"display_name\": \"Email\",\n \"ctix_sdo_key\": null\n },\n \"unique_id\": \"548901f4-6bbb-450e-82ed-306e3daf59f1\",\n \"created\": \"2024-01-30T19:07:00.026063Z\",\n \"geo_details\": null,\n \"modified\": \"2024-01-30T19:07:00.181485Z\",\n \"tlp\": \"WHITE\",\n \"status\": \"none\",\n \"ctix_source\": null,\n \"ctix_object_id\": null,\n \"ioc_type\": \"17e481bb-fe70-47f3-9b85-ff5d0fbffefb\",\n \"ioc_type_data\": {\n \"title\": \"ioc_email\",\n \"unique_id\": \"17e481bb-fe70-47f3-9b85-ff5d0fbffefb\",\n \"created\": \"2024-01-24T05:34:00.708126Z\",\n \"modified\": \"2024-01-24T05:34:00.708126Z\",\n \"display_name\": \"Email\",\n \"ctix_sdo_key\": null\n }\n }\n ],\n \"ioc_domain\": [\n {\n \"value\": \"example.com\",\n \"51fa04aa-e439-4a03-941d-022f0f0fa8c2\": \"b45d2356-f966-4840-a952-268e76b5b350\",\n \"51fa04aa-e439-4a03-941d-022f0f0fa8c2_data\": {\n \"title\": \"ioc_domain\",\n \"unique_id\": \"b45d2356-f966-4840-a952-268e76b5b350\",\n \"created\": \"2024-01-24T05:34:00.425033Z\",\n \"modified\": \"2024-01-24T05:34:00.425033Z\",\n \"display_name\": \"Domain\",\n \"ctix_sdo_key\": null\n },\n \"unique_id\": \"084d4f06-ce20-4fd7-8fc1-0435c60e07c6\",\n \"created\": \"2024-01-30T19:07:00.030617Z\",\n \"geo_details\": null,\n \"modified\": \"2024-01-30T19:07:00.030617Z\",\n \"tlp\": \"WHITE\",\n \"status\": \"none\",\n \"ctix_source\": null,\n \"ctix_object_id\": null,\n \"ioc_type\": \"b45d2356-f966-4840-a952-268e76b5b350\",\n \"ioc_type_data\": {\n \"title\": \"ioc_domain\",\n \"unique_id\": \"b45d2356-f966-4840-a952-268e76b5b350\",\n \"created\": \"2024-01-24T05:34:00.425033Z\",\n \"modified\": \"2024-01-24T05:34:00.425033Z\",\n \"display_name\": \"Domain\",\n \"ctix_sdo_key\": null\n }\n }\n ],\n \"ioc_MD5\": [],\n \"ioc_SHA1\": [],\n \"ioc_SHA256\": [],\n \"ioc_url\": [],\n \"ioc_ip\": []\n }\n}"}],"_postman_id":"8ebe6a84-59e7-4bf0-8b29-e9c02e86b85f"},{"name":"Update Threat Intel","id":"a60d1e1d-1a64-4fc7-a407-efda92ec8919","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": \"whitelisted\",\n \"tlp\": \"GREEN\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/ioc-module/ioc/:ioc_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Update a Threat Intel in the CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`tlp`	String	Optional	TLP associated with the threat intel. Allowed values: `RED` `AMBER` `GREEN` `WHITE` Default value: `WHITE`
`status`	String	Optional	Current status of the Threat Intel. Allowed values: `cleaned` `blocked` `malicious` `false_positive` `whitelisted` `none`
`labels`	List of UUID	Optional	List of `unique_id` of labels added to the Threat Intel.

Response Parameters

Parameter	Type	Description
`value`	String	Value of the Threat Intel.
`unique_id`	String	Unique ID of the Threat Intel in UUID-4 format.
`created`	String	Creation date and time of the Threat Intel.
`geo_details`	List of Objects	Details of the location of the Threat Intel.
`modified`	String	Last updated date and time of the Threat Intel.
`tlp`	String	TLP associated with the threat intel. Allowed values: `RED` `AMBER` `GREEN` `WHITE`
`incidents_data`	List of Objects	Details of Incidents associated with the Threat Intel. Details include: `unique_id`, `readable_id`, and `title`.
`created_by`	String	`user_id` of the user who created the Threat Intel.
`status`	String	Current status of the Threat Intel. Allowed values: `cleaned` `blocked` `malicious` `false_positive` `whitelisted` `none`
`labels`	List	List of `unique_id` of labels added to the Threat Intel.
`labels_data`	List of Objects	Details of Labels added to the Threat Intel. Details include `title`, `color_code`, `unique_id`, `created`, and `modified`.
`malwares_data`	List of Objects	Details of Malware associated with the Threat Intel. Details include: `unique_id`, `readable_id`, and `title`.
`threat_actors_data`	List of Objects	Details of Threat Actors associated with the Threat Intel.
`vulnerabilities_data`	List of Objects	Details of Vulnerabilities associated with the Threat Intel. Details include: `unique_id`, `readable_id`, and `title`.
`actions_count`	Integer	Number of Actions added to the Threat Intel.
`notes_count`	Integer	Number of comments added to the Threat Intel.
`ioc_type`	String	`unique_id` of the Indicator type.
`ioc_type_data`	Object	Details of the Indicator type.

Response Parameters | Custom Fields

In addition to the above mentioned parameters, the response parameters may vary as per the form configuration defined by your CFTR admin for threat intel. For such parameters, the field_readable_key of each parameter is returned in the response. To retrieve the field_readable_key and additional metadata of a parameter, use the Form Tab Structure API for threat intel.

EXAMPLE

The following endpoint retrieves the field_readable_key for all custom fields in the threat intel component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=ioc\n\n

\n","urlObject":{"path":["ioc-module","ioc",":ioc_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the Threat Intel.

\n","type":"text/plain"},"type":"any","value":"d2419859-df61-4235-9a33-b92390f55b96","key":"ioc_unique_id"}]}},"response":[{"id":"d1d5e741-00b0-4d74-bce4-55d7adc16c3a","name":"Update Threat Intel","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": \"whitelisted\",\n \"tlp\": \"GREEN\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/ioc-module/ioc/:ioc_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["ioc-module","ioc",":ioc_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"ioc_unique_id","value":"d2419859-df61-4235-9a33-b92390f55b96","description":"Unique ID of the Threat Intel"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Wed, 16 Feb 2022 07:22:08 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1967","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"4.4.4.4\",\n \"351684a2-d49c-465d-ae77-04d9782cc595\": \"82b30619-edfc-411a-9d3c-0fd421faf002\",\n \"351684a2-d49c-465d-ae77-04d9782cc595_data\": {\n \"title\": \"ioc_ip\",\n \"unique_id\": \"82b30619-edfc-411a-9d3c-0fd421faf002\",\n \"created\": \"2021-06-09T09:35:59.811357Z\",\n \"modified\": \"2021-06-09T09:37:05.777816Z\",\n \"display_name\": \"IP\"\n },\n \"unique_id\": \"d2419859-df61-4235-9a33-b92390f55b96\",\n \"created\": \"2022-02-10T05:51:20.065908Z\",\n \"geo_details\": {\n \"country\": {\n \"country_code\": \"US\",\n \"country_name\": \"United States\"\n },\n \"city\": {\n \"city\": null,\n \"continent_code\": \"NA\",\n \"continent_name\": \"North America\",\n \"country_code\": \"US\",\n \"country_name\": \"United States\",\n \"dma_code\": null,\n \"is_in_european_union\": false,\n \"latitude\": 37.751,\n \"longitude\": -97.822,\n \"postal_code\": null,\n \"region\": null,\n \"time_zone\": null\n }\n },\n \"modified\": \"2022-02-16T07:22:07.915003Z\",\n \"tlp\": \"GREEN\",\n \"incidents_data\": [\n {\n \"unique_id\": \"c2a76a82-0f65-41e6-a3df-e54585aa775a\",\n \"readable_id\": \"INC591\",\n \"title\": \"update openapi incident\"\n }\n ],\n \"created_by\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"status\": \"whitelisted\",\n \"labels\": [\n \"aa0e179f-b87f-4701-bbef-6db059abbd70\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"aa0e179f-b87f-4701-bbef-6db059abbd70\",\n \"title\": \"L1\",\n \"color_code\": \"#4527A0\",\n \"created\": \"2022-02-15T09:48:00.518119Z\",\n \"modified\": \"2022-02-15T09:48:00.518119Z\"\n }\n ],\n \"malwares_data\": [\n {\n \"unique_id\": \"a4feb001-e913-4da5-97ad-bbe5f4d3228a\",\n \"readable_id\": \"MLW122\",\n \"title\": \"Malware created for demo purpose 2\"\n },\n {\n \"unique_id\": \"427e678d-84b1-441b-9d3f-d5a152404a0c\",\n \"readable_id\": \"MLW121\",\n \"title\": \"Malware created for demo purpose 1\"\n }\n ],\n \"threat_actors_data\": [],\n \"vulnerabilities_data\": [\n {\n \"unique_id\": \"e6f50eb7-10d4-481a-8375-d164470455bc\",\n \"readable_id\": \"VUL101\",\n \"title\": \"Vulnerability 1.0.0\"\n }\n ],\n \"actions_count\": 0,\n \"notes_count\": 2,\n \"ioc_type\": \"82b30619-edfc-411a-9d3c-0fd421faf002\",\n \"ioc_type_data\": {\n \"title\": \"ioc_ip\",\n \"unique_id\": \"82b30619-edfc-411a-9d3c-0fd421faf002\",\n \"created\": \"2021-06-09T09:35:59.811357Z\",\n \"modified\": \"2021-06-09T09:37:05.777816Z\",\n \"display_name\": \"IP\"\n }\n}"},{"id":"56a73742-b670-40bc-a931-5d38fac5140d","name":"400 Bad Request: TLP: Not a Valid Choice","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"tlp\": \"BLUE\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/ioc-module/ioc/:ioc_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["ioc-module","ioc",":ioc_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"ioc_unique_id","value":"d2419859-df61-4235-9a33-b92390f55b96","description":"Unique ID of the Threat Intel"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Wed, 16 Feb 2022 07:42:26 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"43","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"tlp\": [\n \"\\\"BLUE\\\" is not a valid choice.\"\n ]\n}"},{"id":"9bb6f974-27eb-4b73-936a-702c9c513808","name":"400 Bad Request: Status: Not a Valid Choice","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"whitelist\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/ioc-module/ioc/:ioc_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["ioc-module","ioc",":ioc_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"ioc_unique_id","value":"d2419859-df61-4235-9a33-b92390f55b96","description":"Unique ID of the Threat Intel"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Wed, 16 Feb 2022 07:43:13 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"51","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": [\n \"\\\"whitelist\\\" is not a valid choice.\"\n ]\n}"}],"_postman_id":"a60d1e1d-1a64-4fc7-a407-efda92ec8919"},{"name":"Add Comment in Threat Intel","id":"165d1582-363c-4d9b-8e3a-9b7f047892e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"description\": \"

Note For Threat Intel

\",\n \"mentioned_users_usernames\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/comments/ioc/:ioc_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Add notes to a Threat Intel in the CFTR application.

REQUEST PARAMETERS

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`description`	String	Mandatory	Enter the content of the comment.
`mentioned_users_usernames`	List of UUID	Optional	Enter the list of usernames of the users mentioned in the comment.

RESPONSE PARAMETERS

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the comment.
`description`	Text	Description of the comment.
`created_by`	Object	Details of the user who added the comment.
`modified_by`	Object	Details of the user who last updated the comment.
`mentioned_users`	List of UUID	List of `user_id` of users mentioned in the comment.
`mentioned_users_data`	List of Objects	Details of the users mentioned in the comment.
`created`	String	Comment creation time.
`modified`	String	Comment last updated time.
`comment_type`	String	Type of comment. Examples: `discussion`: Notes added in an instance.
`content_object`	String	Component in which the comment is added. Example: `device`, `incident`, `action`, `ioc`, and so on.
`content_object_readable_id`	String	`value` of the Threat Intel in which the comment is added.
`content_object_unique_id`	String	`unique_id` of the Threat Intel in which the comment is added.
`description_with_img_src`	Text	Description with the image URLs (if any image is added in the comment).
`pinned`	Boolean	Displays whether the comment is pinned or not.

","urlObject":{"path":["comments","ioc",":ioc_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the Threat Intel in which you want to add a comment.

\n","type":"text/plain"},"type":"any","value":"d2419859-df61-4235-9a33-b92390f55b96","key":"ioc_unique_id"}]}},"response":[{"id":"93ca795f-b912-4640-95a3-a1d8b968acf7","name":"Add Comment in Threat Intel","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"description\": \"

Note For Threat Intel

\",\n \"mentioned_users_usernames\": []\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/comments/ioc/:ioc_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["comments","ioc",":ioc_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"ioc_unique_id","value":"d2419859-df61-4235-9a33-b92390f55b96","description":"Unique ID of Threat Intel in which you want to add comment"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Wed, 16 Feb 2022 07:10:36 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"863","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"unique_id\": \"7d3957e3-5da1-472a-bbbf-5dd2f2c5e683\",\n \"description\": \"

Note For Threat Intel

\",\n \"created_by\": {\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"display_pic\": null,\n \"username\": \"jane\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"Jane Doe\"\n },\n \"modified_by\": null,\n \"is_removed\": false,\n \"mentioned_users\": [],\n \"mentioned_users_data\": [],\n \"created\": \"2022-02-16T07:10:36.535481Z\",\n \"modified\": \"2022-02-16T07:10:36.573920Z\",\n \"email\": null,\n \"internal\": false,\n \"comment_type\": \"discussion\",\n \"command_params\": {},\n \"command_result\": {},\n \"command_status\": \"na\",\n \"attachments_data\": [],\n \"content_object\": \"ioc\",\n \"content_object_readable_id\": \"4.4.4.4\",\n \"content_object_unique_id\": \"d2419859-df61-4235-9a33-b92390f55b96\",\n \"attachment_label\": null,\n \"description_with_img_src\": \"

Note For Threat Intel

\"\n}"}],"_postman_id":"165d1582-363c-4d9b-8e3a-9b7f047892e7"}],"id":"952e2bd2-074f-43fd-9d32-ba1626aecb08","description":"

Threat Intel of a threat indicator includes the indicator details such as IP address, domain, URL, and hash values added from Incidents, Malware, Vulnerabilities, Threat Actors, and Assets.

This section describes how to use the API endpoints to manage threat intel data in the CFTR application.

\n","_postman_id":"952e2bd2-074f-43fd-9d32-ba1626aecb08"},{"name":"Vulnerabilities","item":[{"name":"Get List of Vulnerabilities","id":"21330ab2-ae32-49cb-9f15-bda39a8fb6e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/vulnerability/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the list of all the vulnerabilities in CFTR Application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/vulnerability/?

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` key shows the API endpoint to the next page.
`count`	Integer	Total number of vulnerabilities returned as per the entered query parameters.
`results`	List of Objects	Details of the vulnerabilities. Each object provides the details of one vulnerability.

Response Parameters | Results Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the vulnerability.
`readable_id`	String	Readable ID of the vulnerability. For example, VUL115.
`title`	String	Title of the vulnerability.
`status`	String	Current status of the vulnerability. Allowed values: - `open` - `closed`
`created`	String	Created date of the vulnerability.
`modified`	String	Last updated date of the vulnerability.
`title_display`	String	Title of the vulnerability.
`is_bookmarked`	Boolean	Shows whether the vulnerability is bookmarked or not.
`labels`	List	List of `unique_id` of the attached labels.
`labels_data`	List of Objects	Details of the attached labels.
`risk_data`	Object	Details of risk associated with the vulnerability.
`risk`	String	Risk level associated with the vulnerability. Allowed Values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`risk_data`	Object	Details of the risk associated with the vulnerability.
`priority_data`	Object	Details of the priority of the vulnerability.
`priority`	String	Priority level of the vulnerability. Allowed values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`

[optional] Enter the page number of the vulnerability list. This will retrieve the list of all vulnerabilities from the entered page.

Default value: 1

\n","type":"text/plain"},"key":"page","value":"2"},{"disabled":true,"description":{"content":"

[optional] Enter the number of vulnerabilities per page.\nDefault value: 10

\n","type":"text/plain"},"key":"page_size","value":"5"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the vulnerabilities in EPOCH Time format.\nTime Zone must be as per UTC. All vulnerabilities with creation date later than the entered time will be returned.

\n","type":"text/plain"},"key":"created_date__gte","value":"1644345000"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the vulnerabilities in EPOCH Time format.\nTime Zone must be as per UTC. All vulnerabilities with creation date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"created_date__lte","value":"1644345000"},{"disabled":true,"description":{"content":"

[optional] Enter the last modified time of the vulnerabilities in EPOCH Time format.\nTime Zone must be as per UTC. All vulnerabilities with modified date later than the entered time will be returned.

\n","type":"text/plain"},"key":"modified_date__gte","value":"1644345000"},{"disabled":true,"description":{"content":"

[optional] Enter the last modified time of the vulnerabilities in EPOCH Time format.\nTime Zone must be as per UTC. All vulnerabilities with modified date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"modified_date__lte","value":"1644345000"},{"disabled":true,"description":{"content":"

[optional] Enter the status of the vulnerabilities to filter response results.\nAllowed values:

open
closed

\n","type":"text/plain"},"key":"status","value":"open"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID of a priority of the vulnerabilities. This parameter retrieves the vulnerabilities by the priority.

\n","type":"text/plain"},"key":"priority","value":"c741bd45-1825-4dba-a30f-66088dcbbf8d"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID of the label. This parameter retrieves the vulnerabilities associated with the label.

You can retrieve the list of available Labels and their Unique IDs using the following API endpoint:\n/openapi/v1/utils/label/

\n","type":"text/plain"},"key":"labels","value":"c741bd45-1825-4dba-a30f-66088dcbbf8d"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID of a type of the vulnerabilities. This parameter retrieves the vulnerabilities by the type.

\n","type":"text/plain"},"key":"type","value":"c741bd45-1825-4dba-a30f-66088dcbbf8d"}],"variable":[]}},"response":[{"id":"7e54f291-633a-448e-afee-1158f62f2f61","name":"Get List of Vulnerabilities","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/vulnerability/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&page=2&page_size=5","host":["{{base_url}}v1"],"path":["vulnerability",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"page","value":"2"},{"key":"page_size","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Mon, 21 Feb 2022 08:59:12 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"2743","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {\n \"previous\": \"openapi/v1/vulnerability/?page=1&page_size=5&AccessID=769b74b8-23af-4abb-a99f-952ca699ac2c&Expires=1645433967&Signature=MCH4i7yyE+DvmzZoYezlViGXBLE=\"\n },\n \"count\": 8,\n \"results\": [\n {\n \"unique_id\": \"a421f2b4-9b49-4fae-b729-70a685f77ac0\",\n \"readable_id\": \"VUL103\",\n \"title\": \"Vulnerability 3.0.0\",\n \"status\": \"open\",\n \"created\": \"2022-02-17T12:04:07.246755Z\",\n \"modified\": \"2022-02-17T12:04:07.344742Z\",\n \"title_display\": \"Vulnerability 3.0.0\",\n \"is_bookmarked\": false,\n \"cvss_score\": null,\n \"due_date\": null,\n \"labels\": [],\n \"labels_data\": [],\n \"target_remediation_date\": null,\n \"risk_data\": {\n \"unique_id\": \"79eaa5b2-5776-412e-86d8-f4a3b1f9719d\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"3d1492b5-1ea2-45dd-8bce-c10fabe3cd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"risk\": \"Medium\",\n \"priority_data\": {\n \"unique_id\": \"39dc21a9-6b45-4058-a861-d5d2c9ed3bc0\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"143dd7a5-880c-4af0-af5b-01b947bf8c16\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"priority\": \"High\"\n },\n {\n \"unique_id\": \"3c3436a6-2e17-4b60-8fc5-e094530f39e8\",\n \"readable_id\": \"VUL102\",\n \"title\": \"Vulnerability 2.0.0\",\n \"status\": \"open\",\n \"created\": \"2022-02-17T08:26:27.412017Z\",\n \"modified\": \"2022-02-17T08:26:42.732878Z\",\n \"title_display\": \"Vulnerability 2.0.0\",\n \"is_bookmarked\": false,\n \"cvss_score\": null,\n \"due_date\": null,\n \"labels\": [],\n \"labels_data\": [],\n \"target_remediation_date\": null,\n \"risk_data\": {\n \"unique_id\": \"a2a2e6e8-45c9-4f8e-854b-58966237b682\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"3d1492b5-1ea2-45dd-8bce-c10fabe3cd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"risk\": \"Low\",\n \"priority_data\": {\n \"unique_id\": \"7e0dfd0f-263b-4cba-ac41-ecc8e17328b0\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"143dd7a5-880c-4af0-af5b-01b947bf8c16\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"priority\": \"Low\"\n },\n {\n \"unique_id\": \"e6f50eb7-10d4-481a-8375-d164470455bc\",\n \"readable_id\": \"VUL101\",\n \"title\": \"Vulnerability 1.0.0\",\n \"status\": \"open\",\n \"created\": \"2022-02-02T09:46:42.881438Z\",\n \"modified\": \"2022-02-15T09:48:37.005616Z\",\n \"title_display\": \"Vulnerability 1.0.0\",\n \"is_bookmarked\": false,\n \"cvss_score\": null,\n \"due_date\": null,\n \"labels\": [],\n \"labels_data\": [],\n \"target_remediation_date\": null,\n \"risk_data\": {\n \"unique_id\": \"a2a2e6e8-45c9-4f8e-854b-58966237b682\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"3d1492b5-1ea2-45dd-8bce-c10fabe3cd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"risk\": \"Low\",\n \"priority_data\": {\n \"unique_id\": \"7e0dfd0f-263b-4cba-ac41-ecc8e17328b0\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"143dd7a5-880c-4af0-af5b-01b947bf8c16\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"priority\": \"Low\"\n }\n ]\n}"},{"id":"1fb5dd22-2533-4cce-98cd-9f06e5031bc6","name":"Access Page 4 of Vulnerability Listing","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/vulnerability/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&page=4","host":["{{base_url}}v1"],"path":["vulnerability",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"page","value":"2","description":"[optional] Enter the page number of the vulnerability list. This will retrieve the list of all vulnerabilities from the entered page.\n\nDefault value: 1","disabled":true},{"key":"page_size","value":"5","description":"[optional] Number of vulnerability per page.\nDefault value: 10","disabled":true},{"key":"created_date__gte","value":"1644345000","description":"[optional] Enter the creation time of the vulnerabilities in EPOCH Time format.\nTime Zone must be as per UTC. All vulnerabilities with creation date later than the entered time will be returned.","disabled":true},{"key":"created_date__lte","value":"1644345000","description":"[optional] Enter the creation time of the vulnerabilities in EPOCH Time format.\nTime Zone must be as per UTC. All vulnerabilities with creation date earlier than the entered time will be returned.","disabled":true},{"key":"modified_date__gte","value":"1644345000","description":"[optional] Enter the last modified time of the vulnerabilities in EPOCH Time format.\nTime Zone must be as per UTC. All vulnerabilities with modified date later than the entered time will be returned.","disabled":true},{"key":"modified_date__lte","value":"1644345000","description":"[optional] Enter the last modified time of the vulnerabilities in EPOCH Time format.\nTime Zone must be as per UTC. All vulnerabilities with modified date earlier than the entered time will be returned.","disabled":true},{"key":"status","value":"open","description":"[optional] Enter the status of the vulnerabilities to filter response results.\nAllowed Values:\n- `open`\n- `closed`","disabled":true},{"key":"priority","value":"c741bd45-1825-4dba-a30f-66088dcbbf8d","description":"[optional] Enter the unique ID of a priority of the vulnerabilities. This parameter retrieves the vulnerabilities by the priority.","disabled":true},{"key":"labels","value":"c741bd45-1825-4dba-a30f-66088dcbbf8d","description":"[optional] Enter the unique ID of the label. This parameter retrieves the vulnerabilities associated with the label.\n\nYou can retrieve the list of available Labels and their Unique IDs using the following API endpoint:\n`/openapi/v1/utils/label/`","disabled":true},{"key":"type","value":"c741bd45-1825-4dba-a30f-66088dcbbf8d","description":"[optional] Enter the unique ID of a type of the vulnerabilities. This parameter retrieves the vulnerabilities by the type.","disabled":true},{"key":"page","value":"4"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Thu, 24 Feb 2022 12:01:29 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1265","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {\n \"next\": \"openapi/v1/vulnerability/?page=5&AccessID=769b74b8-23af-4abb-a99f-952ca699ac2c&Expires=1645704104&Signature=AOB831zqb01XtmKuqWvfjP/39io=\",\n \"previous\": \"openapi/v1/vulnerability/?page=3&AccessID=769b74b8-23af-4abb-a99f-952ca699ac2c&Expires=1645704104&Signature=AOB831zqb01XtmKuqWvfjP/39io=\"\n },\n \"count\": 90,\n \"results\": [\n {\n \"unique_id\": \"0fda4848-29a3-4a00-bcbc-5fbf820b9b8d\",\n \"readable_id\": \"VUL108\",\n \"title\": \"Vulnerability 8.0.0\",\n \"status\": \"closed\",\n \"created\": \"2022-02-21T08:23:21.596366Z\",\n \"modified\": \"2022-02-24T11:56:56.191845Z\",\n \"title_display\": \"Vulnerability 8.0.0\",\n \"is_bookmarked\": false,\n \"cvss_score\": 5.0,\n \"due_date\": null,\n \"labels\": [\n \"c55f15ac-9678-414c-bbaf-8bfca7a9650a\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"c55f15ac-9678-414c-bbaf-8bfca7a9650a\",\n \"title\": \"L1\",\n \"color_code\": \"#FF6D00\",\n \"created\": \"2022-02-21T10:27:08.450294Z\",\n \"modified\": \"2022-02-21T10:27:08.450294Z\"\n }\n ],\n \"target_remediation_date\": \"2022-02-20T08:10:01Z\",\n \"risk_data\": {\n \"unique_id\": \"79eaa5b2-5776-412e-86d8-f4a3b1f9719d\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"3d1492b5-1ea2-45dd-8bce-c10fabe3cd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"Medium\",\n \"priority_data\": {\n \"unique_id\": \"39dc21a9-6b45-4058-a861-d5d2c9ed3bc0\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"143dd7a5-880c-4af0-af5b-01b947bf8c16\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"High\"\n },\n {\n \"unique_id\": \"17f0824b-facf-44d8-8913-a2ef2348885f\",\n \"readable_id\": \"VUL109\",\n \"title\": \"Vulnerability 7.0.0\",\n \"status\": \"open\",\n \"created\": \"2022-02-21T11:42:55.759199Z\",\n \"modified\": \"2022-02-24T08:20:41.313044Z\",\n \"title_display\": \"Vulnerability 7.0.0\",\n \"is_bookmarked\": false,\n \"cvss_score\": null,\n \"due_date\": null,\n \"labels\": [],\n \"labels_data\": [],\n \"target_remediation_date\": \"2033-04-21T12:05:49Z\",\n \"risk_data\": {\n \"unique_id\": \"a2a2e6e8-45c9-4f8e-854b-58966237b682\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"3d1492b5-1ea2-45dd-8bce-c10fabe3cd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"Low\",\n \"priority_data\": {\n \"unique_id\": \"a5950bcc-5eb4-450d-a36f-367d906be3b5\",\n \"option_name\": \"Very High\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"143dd7a5-880c-4af0-af5b-01b947bf8c16\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"Very High\"\n },\n {\n \"unique_id\": \"b8907aa1-d591-4d28-a83f-8c5dfc2384f7\",\n \"readable_id\": \"VUL107\",\n \"title\": \"Vulnerability 7.0.0\",\n \"status\": \"open\",\n \"created\": \"2022-02-17T12:17:27.001499Z\",\n \"modified\": \"2022-02-17T12:17:27.165131Z\",\n \"title_display\": \"Vulnerability 7.0.0\",\n \"is_bookmarked\": false,\n \"cvss_score\": null,\n \"due_date\": null,\n \"labels\": [],\n \"labels_data\": [],\n \"target_remediation_date\": \"2022-02-16T12:05:49Z\",\n \"risk_data\": {\n \"unique_id\": \"a2a2e6e8-45c9-4f8e-854b-58966237b682\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"3d1492b5-1ea2-45dd-8bce-c10fabe3cd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"Low\",\n \"priority_data\": {\n \"unique_id\": \"a5950bcc-5eb4-450d-a36f-367d906be3b5\",\n \"option_name\": \"Very High\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"143dd7a5-880c-4af0-af5b-01b947bf8c16\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"Very High\"\n },\n {\n \"unique_id\": \"0a9b11c3-8bd3-415d-96db-038f0017d613\",\n \"readable_id\": \"VUL106\",\n \"title\": \"Vulnerability 6.0.0\",\n \"status\": \"open\",\n \"created\": \"2022-02-17T12:06:55.404889Z\",\n \"modified\": \"2022-02-17T12:06:55.496543Z\",\n \"title_display\": \"Vulnerability 6.0.0\",\n \"is_bookmarked\": false,\n \"cvss_score\": null,\n \"due_date\": null,\n \"labels\": [],\n \"labels_data\": [],\n \"target_remediation_date\": \"2022-02-16T12:05:49Z\",\n \"risk_data\": {\n \"unique_id\": \"a2a2e6e8-45c9-4f8e-854b-58966237b682\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"3d1492b5-1ea2-45dd-8bce-c10fabe3cd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"Low\",\n \"priority_data\": {\n \"unique_id\": \"a5950bcc-5eb4-450d-a36f-367d906be3b5\",\n \"option_name\": \"Very High\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"143dd7a5-880c-4af0-af5b-01b947bf8c16\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"Very High\"\n },\n {\n \"unique_id\": \"6dbc5f62-4a6c-476e-bdff-9b63c2e63748\",\n \"readable_id\": \"VUL105\",\n \"title\": \"Vulnerability 5.0.0\",\n \"status\": \"open\",\n \"created\": \"2022-02-17T12:05:34.867967Z\",\n \"modified\": \"2022-02-17T12:05:35.019828Z\",\n \"title_display\": \"Vulnerability 5.0.0\",\n \"is_bookmarked\": false,\n \"cvss_score\": null,\n \"due_date\": null,\n \"labels\": [],\n \"labels_data\": [],\n \"target_remediation_date\": null,\n \"risk_data\": {\n \"unique_id\": \"2b4c5f7d-850b-4ebf-8022-d331ac1a7ac8\",\n \"option_name\": \"Very High\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"3d1492b5-1ea2-45dd-8bce-c10fabe3cd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"Very High\",\n \"priority_data\": {\n \"unique_id\": \"849773fe-d566-4002-a312-8840e3d1936a\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"143dd7a5-880c-4af0-af5b-01b947bf8c16\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"Medium\"\n },\n {\n \"unique_id\": \"63bfb75f-a982-4828-98ef-b26ad4739a09\",\n \"readable_id\": \"VUL104\",\n \"title\": \"Vulnerability 4.0.0\",\n \"status\": \"open\",\n \"created\": \"2022-02-17T12:04:41.867890Z\",\n \"modified\": \"2022-02-17T12:04:41.948939Z\",\n \"title_display\": \"Vulnerability 4.0.0\",\n \"is_bookmarked\": false,\n \"cvss_score\": null,\n \"due_date\": null,\n \"labels\": [],\n \"labels_data\": [],\n \"target_remediation_date\": null,\n \"risk_data\": {\n \"unique_id\": \"94783f02-9b0c-4485-919c-5811c08aa8c6\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"3d1492b5-1ea2-45dd-8bce-c10fabe3cd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"High\",\n \"priority_data\": {\n \"unique_id\": \"39dc21a9-6b45-4058-a861-d5d2c9ed3bc0\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"143dd7a5-880c-4af0-af5b-01b947bf8c16\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"High\"\n },\n {\n \"unique_id\": \"a421f2b4-9b49-4fae-b729-70a685f77ac0\",\n \"readable_id\": \"VUL103\",\n \"title\": \"Vulnerability 3.0.0\",\n \"status\": \"open\",\n \"created\": \"2022-02-17T12:04:07.246755Z\",\n \"modified\": \"2022-02-17T12:04:07.344742Z\",\n \"title_display\": \"Vulnerability 3.0.0\",\n \"is_bookmarked\": false,\n \"cvss_score\": null,\n \"due_date\": null,\n \"labels\": [],\n \"labels_data\": [],\n \"target_remediation_date\": null,\n \"risk_data\": {\n \"unique_id\": \"79eaa5b2-5776-412e-86d8-f4a3b1f9719d\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"3d1492b5-1ea2-45dd-8bce-c10fabe3cd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"Medium\",\n \"priority_data\": {\n \"unique_id\": \"39dc21a9-6b45-4058-a861-d5d2c9ed3bc0\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"143dd7a5-880c-4af0-af5b-01b947bf8c16\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"High\"\n },\n {\n \"unique_id\": \"3c3436a6-2e17-4b60-8fc5-e094530f39e8\",\n \"readable_id\": \"VUL102\",\n \"title\": \"Vulnerability 2.0.0\",\n \"status\": \"open\",\n \"created\": \"2022-02-17T08:26:27.412017Z\",\n \"modified\": \"2022-02-17T08:26:42.732878Z\",\n \"title_display\": \"Vulnerability 2.0.0\",\n \"is_bookmarked\": false,\n \"cvss_score\": null,\n \"due_date\": null,\n \"labels\": [],\n \"labels_data\": [],\n \"target_remediation_date\": null,\n \"risk_data\": {\n \"unique_id\": \"a2a2e6e8-45c9-4f8e-854b-58966237b682\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"3d1492b5-1ea2-45dd-8bce-c10fabe3cd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"Low\",\n \"priority_data\": {\n \"unique_id\": \"7e0dfd0f-263b-4cba-ac41-ecc8e17328b0\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"143dd7a5-880c-4af0-af5b-01b947bf8c16\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"Low\"\n },\n {\n \"unique_id\": \"e6f50eb7-10d4-481a-8375-d164470455bc\",\n \"readable_id\": \"VUL101\",\n \"title\": \"Vulnerability 1.0.0\",\n \"status\": \"open\",\n \"created\": \"2022-02-02T09:46:42.881438Z\",\n \"modified\": \"2022-02-15T09:48:37.005616Z\",\n \"title_display\": \"Vulnerability 1.0.0\",\n \"is_bookmarked\": false,\n \"cvss_score\": null,\n \"due_date\": null,\n \"labels\": [],\n \"labels_data\": [],\n \"target_remediation_date\": null,\n \"risk_data\": {\n \"unique_id\": \"a2a2e6e8-45c9-4f8e-854b-58966237b682\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"3d1492b5-1ea2-45dd-8bce-c10fabe3cd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"Low\",\n \"priority_data\": {\n \"unique_id\": \"7e0dfd0f-263b-4cba-ac41-ecc8e17328b0\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"143dd7a5-880c-4af0-af5b-01b947bf8c16\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"Low\"\n }\n ]\n}"},{"id":"7121d0e5-7ece-4a7c-b7c6-101f785286a2","name":"Customizable Page Size","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/vulnerability/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&page_size=15","host":["{{base_url}}v1"],"path":["vulnerability",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"page","value":"2","description":"[optional] Enter the page number of the vulnerability list. This will retrieve the list of all vulnerabilities from the entered page.\n\nDefault value: 1","disabled":true},{"key":"page_size","value":"5","description":"[optional] Number of vulnerability per page.\nDefault value: 10","disabled":true},{"key":"created_date__gte","value":"1644345000","description":"[optional] Enter the creation time of the vulnerabilities in EPOCH Time format.\nTime Zone must be as per UTC. All vulnerabilities with creation date later than the entered time will be returned.","disabled":true},{"key":"created_date__lte","value":"1644345000","description":"[optional] Enter the creation time of the vulnerabilities in EPOCH Time format.\nTime Zone must be as per UTC. All vulnerabilities with creation date earlier than the entered time will be returned.","disabled":true},{"key":"modified_date__gte","value":"1644345000","description":"[optional] Enter the last modified time of the vulnerabilities in EPOCH Time format.\nTime Zone must be as per UTC. All vulnerabilities with modified date later than the entered time will be returned.","disabled":true},{"key":"modified_date__lte","value":"1644345000","description":"[optional] Enter the last modified time of the vulnerabilities in EPOCH Time format.\nTime Zone must be as per UTC. All vulnerabilities with modified date earlier than the entered time will be returned.","disabled":true},{"key":"status","value":"open","description":"[optional] Enter the status of the vulnerabilities to filter response results.\nAllowed Values:\n- `open`\n- `closed`","disabled":true},{"key":"priority","value":"c741bd45-1825-4dba-a30f-66088dcbbf8d","description":"[optional] Enter the unique ID of a priority of the vulnerabilities. This parameter retrieves the vulnerabilities by the priority.","disabled":true},{"key":"labels","value":"c741bd45-1825-4dba-a30f-66088dcbbf8d","description":"[optional] Enter the unique ID of the label. This parameter retrieves the vulnerabilities associated with the label.\n\nYou can retrieve the list of available Labels and their Unique IDs using the following API endpoint:\n`/openapi/v1/utils/label/`","disabled":true},{"key":"type","value":"c741bd45-1825-4dba-a30f-66088dcbbf8d","description":"[optional] Enter the unique ID of a type of the vulnerabilities. This parameter retrieves the vulnerabilities by the type.","disabled":true},{"key":"Signature","value":"{{signature}}"},{"key":"page_size","value":"15"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Thu, 24 Feb 2022 12:05:25 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"8334","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 9,\n \"results\": [\n {\n \"unique_id\": \"0fda4848-29a3-4a00-bcbc-5fbf820b9b8d\",\n \"readable_id\": \"VUL108\",\n \"title\": \"Vulnerability 8.0.0\",\n \"status\": \"closed\",\n \"created\": \"2022-02-21T08:23:21.596366Z\",\n \"modified\": \"2022-02-24T11:56:56.191845Z\",\n \"title_display\": \"Vulnerability 8.0.0\",\n \"is_bookmarked\": false,\n \"cvss_score\": 5,\n \"due_date\": null,\n \"labels\": [\n \"c55f15ac-9678-414c-bbaf-8bfca7a9650a\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"c55f15ac-9678-414c-bbaf-8bfca7a9650a\",\n \"title\": \"L1\",\n \"color_code\": \"#FF6D00\",\n \"created\": \"2022-02-21T10:27:08.450294Z\",\n \"modified\": \"2022-02-21T10:27:08.450294Z\"\n }\n ],\n \"target_remediation_date\": \"2022-02-20T08:10:01Z\",\n \"risk_data\": {\n \"unique_id\": \"79eaa5b2-5776-412e-86d8-f4a3b1f9719d\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"3d1492b5-1ea2-45dd-8bce-c10fabe3cd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"Medium\",\n \"priority_data\": {\n \"unique_id\": \"39dc21a9-6b45-4058-a861-d5d2c9ed3bc0\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"143dd7a5-880c-4af0-af5b-01b947bf8c16\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"High\"\n },\n {\n \"unique_id\": \"17f0824b-facf-44d8-8913-a2ef2348885f\",\n \"readable_id\": \"VUL109\",\n \"title\": \"Vulnerability 7.0.0\",\n \"status\": \"open\",\n \"created\": \"2022-02-21T11:42:55.759199Z\",\n \"modified\": \"2022-02-24T08:20:41.313044Z\",\n \"title_display\": \"Vulnerability 7.0.0\",\n \"is_bookmarked\": false,\n \"cvss_score\": null,\n \"due_date\": null,\n \"labels\": [],\n \"labels_data\": [],\n \"target_remediation_date\": \"2033-04-21T12:05:49Z\",\n \"risk_data\": {\n \"unique_id\": \"a2a2e6e8-45c9-4f8e-854b-58966237b682\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"3d1492b5-1ea2-45dd-8bce-c10fabe3cd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"Low\",\n \"priority_data\": {\n \"unique_id\": \"a5950bcc-5eb4-450d-a36f-367d906be3b5\",\n \"option_name\": \"Very High\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"143dd7a5-880c-4af0-af5b-01b947bf8c16\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"Very High\"\n },\n {\n \"unique_id\": \"b8907aa1-d591-4d28-a83f-8c5dfc2384f7\",\n \"readable_id\": \"VUL107\",\n \"title\": \"Vulnerability 7.0.0\",\n \"status\": \"open\",\n \"created\": \"2022-02-17T12:17:27.001499Z\",\n \"modified\": \"2022-02-17T12:17:27.165131Z\",\n \"title_display\": \"Vulnerability 7.0.0\",\n \"is_bookmarked\": false,\n \"cvss_score\": null,\n \"due_date\": null,\n \"labels\": [],\n \"labels_data\": [],\n \"target_remediation_date\": \"2022-02-16T12:05:49Z\",\n \"risk_data\": {\n \"unique_id\": \"a2a2e6e8-45c9-4f8e-854b-58966237b682\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"3d1492b5-1ea2-45dd-8bce-c10fabe3cd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"Low\",\n \"priority_data\": {\n \"unique_id\": \"a5950bcc-5eb4-450d-a36f-367d906be3b5\",\n \"option_name\": \"Very High\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"143dd7a5-880c-4af0-af5b-01b947bf8c16\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"Very High\"\n },\n {\n \"unique_id\": \"0a9b11c3-8bd3-415d-96db-038f0017d613\",\n \"readable_id\": \"VUL106\",\n \"title\": \"Vulnerability 6.0.0\",\n \"status\": \"open\",\n \"created\": \"2022-02-17T12:06:55.404889Z\",\n \"modified\": \"2022-02-17T12:06:55.496543Z\",\n \"title_display\": \"Vulnerability 6.0.0\",\n \"is_bookmarked\": false,\n \"cvss_score\": null,\n \"due_date\": null,\n \"labels\": [],\n \"labels_data\": [],\n \"target_remediation_date\": \"2022-02-16T12:05:49Z\",\n \"risk_data\": {\n \"unique_id\": \"a2a2e6e8-45c9-4f8e-854b-58966237b682\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"3d1492b5-1ea2-45dd-8bce-c10fabe3cd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"Low\",\n \"priority_data\": {\n \"unique_id\": \"a5950bcc-5eb4-450d-a36f-367d906be3b5\",\n \"option_name\": \"Very High\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"143dd7a5-880c-4af0-af5b-01b947bf8c16\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"Very High\"\n },\n {\n \"unique_id\": \"6dbc5f62-4a6c-476e-bdff-9b63c2e63748\",\n \"readable_id\": \"VUL105\",\n \"title\": \"Vulnerability 5.0.0\",\n \"status\": \"open\",\n \"created\": \"2022-02-17T12:05:34.867967Z\",\n \"modified\": \"2022-02-17T12:05:35.019828Z\",\n \"title_display\": \"Vulnerability 5.0.0\",\n \"is_bookmarked\": false,\n \"cvss_score\": null,\n \"due_date\": null,\n \"labels\": [],\n \"labels_data\": [],\n \"target_remediation_date\": null,\n \"risk_data\": {\n \"unique_id\": \"2b4c5f7d-850b-4ebf-8022-d331ac1a7ac8\",\n \"option_name\": \"Very High\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"3d1492b5-1ea2-45dd-8bce-c10fabe3cd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"Very High\",\n \"priority_data\": {\n \"unique_id\": \"849773fe-d566-4002-a312-8840e3d1936a\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"143dd7a5-880c-4af0-af5b-01b947bf8c16\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"Medium\"\n },\n {\n \"unique_id\": \"63bfb75f-a982-4828-98ef-b26ad4739a09\",\n \"readable_id\": \"VUL104\",\n \"title\": \"Vulnerability 4.0.0\",\n \"status\": \"open\",\n \"created\": \"2022-02-17T12:04:41.867890Z\",\n \"modified\": \"2022-02-17T12:04:41.948939Z\",\n \"title_display\": \"Vulnerability 4.0.0\",\n \"is_bookmarked\": false,\n \"cvss_score\": null,\n \"due_date\": null,\n \"labels\": [],\n \"labels_data\": [],\n \"target_remediation_date\": null,\n \"risk_data\": {\n \"unique_id\": \"94783f02-9b0c-4485-919c-5811c08aa8c6\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"3d1492b5-1ea2-45dd-8bce-c10fabe3cd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"High\",\n \"priority_data\": {\n \"unique_id\": \"39dc21a9-6b45-4058-a861-d5d2c9ed3bc0\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"143dd7a5-880c-4af0-af5b-01b947bf8c16\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"High\"\n },\n {\n \"unique_id\": \"a421f2b4-9b49-4fae-b729-70a685f77ac0\",\n \"readable_id\": \"VUL103\",\n \"title\": \"Vulnerability 3.0.0\",\n \"status\": \"open\",\n \"created\": \"2022-02-17T12:04:07.246755Z\",\n \"modified\": \"2022-02-17T12:04:07.344742Z\",\n \"title_display\": \"Vulnerability 3.0.0\",\n \"is_bookmarked\": false,\n \"cvss_score\": null,\n \"due_date\": null,\n \"labels\": [],\n \"labels_data\": [],\n \"target_remediation_date\": null,\n \"risk_data\": {\n \"unique_id\": \"79eaa5b2-5776-412e-86d8-f4a3b1f9719d\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"3d1492b5-1ea2-45dd-8bce-c10fabe3cd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"Medium\",\n \"priority_data\": {\n \"unique_id\": \"39dc21a9-6b45-4058-a861-d5d2c9ed3bc0\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"143dd7a5-880c-4af0-af5b-01b947bf8c16\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"High\"\n },\n {\n \"unique_id\": \"3c3436a6-2e17-4b60-8fc5-e094530f39e8\",\n \"readable_id\": \"VUL102\",\n \"title\": \"Vulnerability 2.0.0\",\n \"status\": \"open\",\n \"created\": \"2022-02-17T08:26:27.412017Z\",\n \"modified\": \"2022-02-17T08:26:42.732878Z\",\n \"title_display\": \"Vulnerability 2.0.0\",\n \"is_bookmarked\": false,\n \"cvss_score\": null,\n \"due_date\": null,\n \"labels\": [],\n \"labels_data\": [],\n \"target_remediation_date\": null,\n \"risk_data\": {\n \"unique_id\": \"a2a2e6e8-45c9-4f8e-854b-58966237b682\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"3d1492b5-1ea2-45dd-8bce-c10fabe3cd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"Low\",\n \"priority_data\": {\n \"unique_id\": \"7e0dfd0f-263b-4cba-ac41-ecc8e17328b0\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"143dd7a5-880c-4af0-af5b-01b947bf8c16\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"Low\"\n },\n {\n \"unique_id\": \"e6f50eb7-10d4-481a-8375-d164470455bc\",\n \"readable_id\": \"VUL101\",\n \"title\": \"Vulnerability 1.0.0\",\n \"status\": \"open\",\n \"created\": \"2022-02-02T09:46:42.881438Z\",\n \"modified\": \"2022-02-15T09:48:37.005616Z\",\n \"title_display\": \"Vulnerability 1.0.0\",\n \"is_bookmarked\": false,\n \"cvss_score\": null,\n \"due_date\": null,\n \"labels\": [],\n \"labels_data\": [],\n \"target_remediation_date\": null,\n \"risk_data\": {\n \"unique_id\": \"a2a2e6e8-45c9-4f8e-854b-58966237b682\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"3d1492b5-1ea2-45dd-8bce-c10fabe3cd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"Low\",\n \"priority_data\": {\n \"unique_id\": \"7e0dfd0f-263b-4cba-ac41-ecc8e17328b0\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"143dd7a5-880c-4af0-af5b-01b947bf8c16\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"Low\"\n }\n ]\n}"}],"_postman_id":"21330ab2-ae32-49cb-9f15-bda39a8fb6e7"},{"name":"Get Details of a Vulnerability","id":"454c7db7-8fed-4351-8d1d-ef8f171b7e90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/vulnerability/:vulnerabillity_unique_id?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the details of a vulnerability.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/vulnerability/:vulnerabillity_unique_id/?

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

Response Parameters | Regulatory Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	Title of the vulnerability.
`unique_id`	String	Unique ID of the vulnerability.
`readable_id`	String	Readable ID of the vulnerability.
`description`	Text	Description of the vulnerability.
`created`	String	Creation time of the vulnerability in ISO format.
`modified`	String	Last Updated time of the vulnerability in ISO format.
`status`	String	Current status of the vulnerability. Allowed values: `open` `closed`
`risk`	String	Risk associated with the vulnerability. Allowed Values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`priority`	String	Priority of the vulnerability. Allowed values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`created_by_data`	Object	Details of user who created the vulnerability.
`closed_by`	String	`user_id` of the user who closed the vulnerability.
`closed_by_data`	Object	Details of user who closed the vulnerability.
`closed_on`	String	Closing date of the vulnerability in ISO format.
`is_bookmarked`	Boolean	Shows whether the vulnerability is bookmarked or not.

Response Parameters | Connect The Dots

Following are the response parameters corresponding the Connect The Dots section of the vulnerability. The parameters ending with _data contain the meta information for each connected component. The non _data parameters include an array of unique IDs of the connected components.

Parameter	Type	Description
`applications`	Array of UUID Strings	List of `unique_id` of the connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`softwares`	Array of UUID Strings	List of `unique_id` of the connected software.
`softwares_data`	Array of Objects	Details of the connected software.
`users`	Array of UUID Strings	List of `unique_id` of the connected users.
`users_data`	Array of Objects	Details of the connected users.
`endpoints`	Array of UUID Strings	List of `unique_id` of the connected devices.
`endpoints_data`	Array of Objects	Details of the connected devices.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.

Response Parameters | Default Indicators

Following are the seven standard indicators that are included by default in the CFTR platform, which reflect in the vulnerability's response data with the following keys:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`ioc_SHA1`	Array of UUID Strings	List of `unique_id` of the connected SHA1 Threat Intels.
`ioc_SHA1_data`	Array of Objects	Details of the connected SHA1 Threat Intels.
`ioc_MD5`	Array of UUID Strings	List of `unique_id` of the connected MD5 Threat Intels.
`ioc_MD5_data`	Array of Objects	Details of the connected MD5 Threat Intels.
`ioc_SHA256`	Array of UUID Strings	List of `unique_id` of the connected SHA256 Threat Intels.
`ioc_SHA256_data`	Array of Objects	Details of the connected SHA256 Threat Intels.
`ioc_ip`	Array of UUID Strings	List of `unique_id` of the connected IP Threat Intels.
`ioc_ip_data`	Array of Objects	Details of the connected IP Threat Intels.
`ioc_url`	Array of UUID Strings	List of `unique_id` of the connected URL Threat Intels.
`ioc_url_data`	Array of Objects	Details of the connected URL Threat Intels.
`ioc_domain`	Array of UUID Strings	List of `unique_id` of the connected domain Threat Intels.
`ioc_domain_data`	Array of Objects	Details of the connected domain Threat Intels.
`ioc_email`	Array of UUID Strings	List of `unique_id` of the connected email Threat Intels.
`ioc_email_data`	Array of Objects	Details of the connected email Threat Intels.

Response Parameters | Custom Indicators

Custom indicators are managed using the Form Management for Threat Intel.

Parameter key syntax: ioc_{{camel_case_of_threat_intel_name}}

Example

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`ioc_credit_card`	Array of UUID Strings	List of unique IDs of indicators in UUID-4 format corresponding to the Credit Card Threat Intel.
`ioc_credit_card_data`	Array of Objects	Details of the indicators.

Response Parameters | Custom Form Fields

In addition to the above mentioned parameters, the response parameters may vary as per the form configuration defined by your CFTR admin for vulnerabilities. For such parameters, the field_readable_key of each parameter is returned in the response. To retrieve the field_readable_key and additional metadata of a parameter, use the Form Tab Structure API for vulnerabilities.

Example

The following endpoint retrieves the field_readable_key for all custom fields in the vulnerability component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=vulnerability\n\n

Following are some of the sample custom fields for vulnerabilities:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters | Attachments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`attachments_data`	Array of Objects	Details of each attachment of the vulnerability.

Response Parameters | Actions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`actions_data`	Array of Objects	Details of the actions that are added for the vulnerability.

Response Parameters | Enhancements

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`enhancements`	Array of UUID Strings	List of the enhancements that are added for the vulnerability.
`enhancements_data`	Array of Objects	Details of the enhancements that are added for the vulnerability.

Response Parameters | PIRs

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`pirs_data`	Array of Objects	Details of the PIRs that are added for the vulnerability.

","urlObject":{"path":["vulnerability",":vulnerabillity_unique_id"],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of a vulnerability.

\n","type":"text/plain"},"type":"any","value":"0fda4848-29a3-4a00-bcbc-5fbf820b9b8d","key":"vulnerabillity_unique_id"}]}},"response":[{"id":"59f6e99a-0a35-4f97-8de2-163b341840b0","name":"Get Details of a Vulnerability","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/vulnerability/:vulnerabillity_unique_id?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["vulnerability",":vulnerabillity_unique_id"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"vulnerabillity_unique_id","value":"0fda4848-29a3-4a00-bcbc-5fbf820b9b8d","description":"Unique ID of the vulnerability"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Mon, 21 Feb 2022 09:01:51 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"4145","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"description\": \"

Vulnerability 8.0.0

\",\n \"risk\": \"Medium\",\n \"priority\": \"High\",\n \"privileges_required\": \"Minimal\",\n \"user_interaction_required\": \"No\",\n \"source\": [\n \"Manual\",\n \"Qualys\"\n ],\n \"type\": [\n \"Local Exploit\"\n ],\n \"cia_impact\": [\n \"Availability\"\n ],\n \"unique_id\": \"0fda4848-29a3-4a00-bcbc-5fbf820b9b8d\",\n \"readable_id\": \"VUL108\",\n \"created\": \"2022-02-21T08:23:21.596366Z\",\n \"modified\": \"2022-02-21T10:24:05.326636Z\",\n \"title\": \"Vulnerability 8.0.0\",\n \"status\": \"closed\",\n \"briefings\": [\n \"968854e1-0735-469e-a123-132df3454a13\"\n ],\n \"briefings_data\": [\n {\n \"unique_id\": \"968854e1-0735-469e-a123-132df3454a13\",\n \"readable_id\": \"BRF101\",\n \"title\": \"a\",\n \"created\": \"2021-12-01T11:18:22.805664Z\",\n \"modified\": \"2022-02-03T06:30:39.584303Z\",\n \"labels_data\": [],\n \"labels\": [],\n \"title_display\": \"a\",\n \"status\": \"ACTIVE\"\n }\n ],\n \"incidents_data\": [\n {\n \"unique_id\": \"fd7f9ac2-8e3c-41a4-8412-98e62e2078bb\",\n \"readable_id\": \"INC483\",\n \"179be082-ac8b-425b-9033-030ffae0733d\": \"Inc 3\",\n \"status\": \"open\",\n \"created\": \"2021-07-02T12:23:57.160827Z\",\n \"modified\": \"2022-02-18T10:22:57.254586Z\",\n \"title_display\": \"Inc 3\",\n \"severity_title\": \"Low\"\n },\n {\n \"unique_id\": \"9e824ebd-a4ec-45e4-b81e-bd0544e86ecd\",\n \"readable_id\": \"INC590\",\n \"179be082-ac8b-425b-9033-030ffae0733d\": \"test incident\",\n \"status\": \"closed\",\n \"created\": \"2022-01-25T07:52:52.449126Z\",\n \"modified\": \"2022-02-18T09:47:42.017396Z\",\n \"title_display\": \"test incident\",\n \"severity_title\": \"Low\"\n }\n ],\n \"campaigns\": [\n \"9a759095-9ab0-4241-9062-cdb6910b18db\"\n ],\n \"campaigns_data\": [\n {\n \"title\": \"new campaign\",\n \"unique_id\": \"9a759095-9ab0-4241-9062-cdb6910b18db\",\n \"readable_id\": \"CMP101\",\n \"created\": \"2021-09-17T13:54:24.331033Z\",\n \"modified\": \"2021-10-31T07:42:45.116467Z\",\n \"title_display\": \"new campaign\",\n \"status\": \"ACTIVE\"\n }\n ],\n \"incidents\": [\n \"9e824ebd-a4ec-45e4-b81e-bd0544e86ecd\",\n \"fd7f9ac2-8e3c-41a4-8412-98e62e2078bb\"\n ],\n \"is_bookmarked\": false,\n \"cvss_score\": 5.0,\n \"actions_data\": [\n {\n \"title\": \"Act 1\",\n \"readable_id\": \"ACT112\",\n \"description\": null,\n \"created\": \"2022-02-21T10:24:36.132552Z\",\n \"modified\": \"2022-02-21T10:24:36.702140Z\",\n \"status\": \"open\",\n \"assigned_to\": null,\n \"unique_id\": \"96f4b3a1-8be2-4155-b5a9-ceaa964bcbb5\",\n \"assigned_to_data\": null,\n \"created_by\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"is_bookmarked\": false,\n \"title_display\": \"Act 1\"\n }\n ],\n \"sla\": null,\n \"due_date\": null,\n \"enhancements\": [\n \"09b84217-1ad3-4c57-8f94-83c4e3e50239\"\n ],\n \"enhancements_data\": [\n {\n \"title\": \"Enh 1\",\n \"readable_id\": \"ENH102\",\n \"description\": null,\n \"due_date\": null,\n \"created\": \"2022-02-21T10:24:20.883666Z\",\n \"modified\": \"2022-02-21T10:24:21.469498Z\",\n \"status\": \"open\",\n \"assigned_to\": null,\n \"unique_id\": \"09b84217-1ad3-4c57-8f94-83c4e3e50239\",\n \"assigned_to_data\": null,\n \"created_by\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"is_bookmarked\": false,\n \"title_display\": \"Enh 1\"\n }\n ],\n \"malwares\": [\n \"a4feb001-e913-4da5-97ad-bbe5f4d3228a\",\n \"427e678d-84b1-441b-9d3f-d5a152404a0c\"\n ],\n \"malwares_data\": [\n {\n \"unique_id\": \"a4feb001-e913-4da5-97ad-bbe5f4d3228a\",\n \"readable_id\": \"MLW122\",\n \"created\": \"2021-09-09T05:32:19.933053Z\",\n \"modified\": \"2022-02-15T09:46:30.215274Z\",\n \"title\": \"Malware created for demo purpose 2\",\n \"status\": \"active\",\n \"title_display\": \"Malware created for demo purpose 2\"\n },\n {\n \"unique_id\": \"427e678d-84b1-441b-9d3f-d5a152404a0c\",\n \"readable_id\": \"MLW121\",\n \"created\": \"2021-11-18T07:57:41.933053Z\",\n \"modified\": \"2022-02-15T10:06:46.945152Z\",\n \"title\": \"Malware created for demo purpose 1\",\n \"status\": \"active\",\n \"title_display\": \"Malware created for demo purpose 1\"\n }\n ],\n \"treat_actors\": [\n \"19b15b31-0d95-42ef-a476-03a4299ee4cb\",\n \"3822c3e9-3495-4a4a-b2a5-defce57ba5bf\"\n ],\n \"treat_actors_data\": [\n {\n \"unique_id\": \"19b15b31-0d95-42ef-a476-03a4299ee4cb\",\n \"readable_id\": \"ATR194\",\n \"title\": \"TEMP.Veles\",\n \"status\": \"active\",\n \"created\": \"2021-06-09T09:38:58.072233Z\",\n \"modified\": \"2022-02-06T05:17:41.133519Z\",\n \"title_display\": \"TEMP.Veles\"\n },\n {\n \"unique_id\": \"3822c3e9-3495-4a4a-b2a5-defce57ba5bf\",\n \"readable_id\": \"ATR108\",\n \"title\": \"APT28\",\n \"status\": \"active\",\n \"created\": \"2021-06-09T09:38:25.956058Z\",\n \"modified\": \"2022-02-06T05:17:40.834250Z\",\n \"title_display\": \"APT28\"\n }\n ],\n \"can_close_instance\": true,\n \"attachments_data\": [],\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"closed_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"title_display\": \"Vulnerability 8.0.0\",\n \"labels\": [\n \"c55f15ac-9678-414c-bbaf-8bfca7a9650a\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"c55f15ac-9678-414c-bbaf-8bfca7a9650a\",\n \"title\": \"L1\",\n \"color_code\": \"#FF6D00\",\n \"created\": \"2022-02-21T10:27:08.450294Z\",\n \"modified\": \"2022-02-21T10:27:08.450294Z\"\n }\n ],\n \"scan_date\": \"2022-02-08T08:10:01Z\",\n \"custom_risk_score\": null,\n \"publish_date\": \"2022-02-17T08:10:01Z\",\n \"last_updated\": \"2022-02-19T18:30:00Z\",\n \"target_remediation_date\": \"2022-02-20T08:10:01Z\",\n \"applications\": [\n \"155dc4e5-7e85-4509-891d-c67e634a4b98\"\n ],\n \"applications_data\": [\n {\n \"unique_id\": \"155dc4e5-7e85-4509-891d-c67e634a4b98\",\n \"created\": \"2021-10-13T03:49:28.093798Z\",\n \"modified\": \"2021-10-13T03:49:28.093798Z\",\n \"title\": \"App 2\",\n \"production_date\": null,\n \"readable_id\": \"APL102\",\n \"labels\": [],\n \"labels_data\": [],\n \"title_display\": \"App 2\",\n \"status\": \"active\"\n }\n ],\n \"endpoints\": [\n \"fb114af7-73a7-472d-b655-23a484107b22\",\n \"b145fbb1-c01a-43c4-b84b-3ae8d6b66e5c\"\n ],\n \"endpoints_data\": [\n {\n \"unique_id\": \"fb114af7-73a7-472d-b655-23a484107b22\",\n \"created\": \"2021-12-19T12:43:29.499734Z\",\n \"modified\": \"2022-02-04T10:41:56.597408Z\",\n \"hostname\": \"update device hostname from openapi\",\n \"serial_number\": \"1234\",\n \"readable_id\": \"DVC1220\",\n \"labels\": [\n \"c741bd45-1825-4dba-a30f-66088dcbbf8d\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"c741bd45-1825-4dba-a30f-66088dcbbf8d\",\n \"title\": \"L1\",\n \"color_code\": \"#827717\",\n \"created\": \"2022-02-01T07:38:20.601410Z\",\n \"modified\": \"2022-02-01T07:38:20.601410Z\"\n }\n ],\n \"title_display\": \"update device hostname from openapi\",\n \"ip_address\": \"1.1.1.1\",\n \"mac_address\": null,\n \"endpoint_status\": \"clean\"\n },\n {\n \"unique_id\": \"b145fbb1-c01a-43c4-b84b-3ae8d6b66e5c\",\n \"created\": \"2022-02-02T13:32:28.485806Z\",\n \"modified\": \"2022-02-02T14:16:31.441299Z\",\n \"hostname\": \"device from openapi\",\n \"serial_number\": \"A1001\",\n \"readable_id\": \"DVC1222\",\n \"labels\": [],\n \"labels_data\": [],\n \"title_display\": \"device from openapi\",\n \"ip_address\": \"1.1.1.1\",\n \"mac_address\": null,\n \"endpoint_status\": \"clean\"\n }\n ],\n \"softwares\": [\n \"90c8df6e-a0ca-422e-81ef-0f8e969669ba\"\n ],\n \"softwares_data\": [\n {\n \"unique_id\": \"90c8df6e-a0ca-422e-81ef-0f8e969669ba\",\n \"created\": \"2021-06-30T10:00:00.395030Z\",\n \"modified\": \"2021-07-13T06:15:02.067090Z\",\n \"title\": \"Software 1\",\n \"readable_id\": \"SFT101\",\n \"title_display\": \"Software 1\",\n \"software_status\": \"active\"\n }\n ],\n \"pirs_data\": [\n {\n \"unique_id\": \"f17b4068-9f6f-4f7d-a5da-3fdce560d2f6\",\n \"readable_id\": \"PIR102\",\n \"title\": \"PIR 1\",\n \"status\": \"open\",\n \"created\": \"2022-02-21T10:24:51.544017Z\",\n \"modified\": \"2022-02-21T10:24:52.051940Z\",\n \"title_display\": \"PIR 1\",\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"is_bookmarked\": false,\n \"assigned_to_data\": []\n }\n ],\n \"closed_on\": \"2022-02-21T10:23:03.955950Z\",\n \"closed_by\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"type_data\": [\n {\n \"unique_id\": \"4f2aa462-9a8d-4eb6-8131-eb3b01658b61\",\n \"option_name\": \"Local Exploit\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"c3391585-a17c-40af-a192-e6aa3dac0700\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n }\n ],\n \"risk_data\": {\n \"unique_id\": \"79eaa5b2-5776-412e-86d8-f4a3b1f9719d\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"3d1492b5-1ea2-45dd-8bce-c10fabe3cd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"source_data\": [\n {\n \"unique_id\": \"78b5ba51-7bae-4695-855f-7c817dd4f300\",\n \"option_name\": \"Manual\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"43827c71-7790-4e62-a521-cc300df1abe3\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n {\n \"unique_id\": \"07f83d29-3831-43b9-8a3e-7cf650f0426f\",\n \"option_name\": \"Qualys\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"43827c71-7790-4e62-a521-cc300df1abe3\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n }\n ],\n \"privileges_required_data\": {\n \"unique_id\": \"d4bf34d0-7095-477b-b192-6f7a0ab3e738\",\n \"option_name\": \"Minimal\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"e9689886-c0f9-470d-8d18-5f0719e2bf19\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"user_interaction_required_data\": {\n \"unique_id\": \"0284e93d-ed4a-48be-b578-6ea4d5b8fa9e\",\n \"option_name\": \"No\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"f0788a69-ba89-47cd-8b1a-8029c73db4eb\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"cia_impact_data\": [\n {\n \"unique_id\": \"a66e5638-696e-4de8-b95f-70e4ec2c4bc5\",\n \"option_name\": \"Availability\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"123b3e62-9ffd-45f6-9bfa-cdab51394b6c\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n }\n ],\n \"remediation_status_data\": {\n \"unique_id\": \"9b69c18a-9075-4025-86b2-2f6f6b838a59\",\n \"option_name\": \"In Progress\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"6b0ba666-0671-4997-a55e-955d886d1f5c\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"priority_data\": {\n \"unique_id\": \"39dc21a9-6b45-4058-a861-d5d2c9ed3bc0\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"143dd7a5-880c-4af0-af5b-01b947bf8c16\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"ioc_url\": [],\n \"ioc_SHA1\": [],\n \"ioc_MD5\": [],\n \"ioc_email\": [\n \"7b83f977-b4f4-4980-978e-a3473f9961c1\"\n ],\n \"ioc_domain\": [\n \"04863927-ec80-42b6-85b6-6ea72cc77b59\"\n ],\n \"ioc_SHA256\": [],\n \"ioc_ip\": [\n \"3454c450-6662-49ad-ac8e-298f9045ea19\"\n ],\n \"ioc_ip_data\": [\n {\n \"unique_id\": \"3454c450-6662-49ad-ac8e-298f9045ea19\",\n \"created\": \"2021-06-11T13:29:22.535109Z\",\n \"modified\": \"2021-06-11T13:29:22.535109Z\",\n \"value\": \"1.1.1.1\",\n \"ioc_type\": \"82b30619-edfc-411a-9d3c-0fd421faf002\",\n \"ioc_type_data\": {\n \"title\": \"ioc_ip\",\n \"unique_id\": \"82b30619-edfc-411a-9d3c-0fd421faf002\",\n \"created\": \"2021-06-09T09:35:59.811357Z\",\n \"modified\": \"2021-06-09T09:37:05.777816Z\",\n \"display_name\": \"IP\"\n },\n \"tlp\": \"WHITE\",\n \"status\": \"none\"\n }\n ],\n \"ioc_domain_data\": [\n {\n \"unique_id\": \"04863927-ec80-42b6-85b6-6ea72cc77b59\",\n \"created\": \"2022-02-15T10:46:28.794681Z\",\n \"modified\": \"2022-02-15T10:46:29.039600Z\",\n \"value\": \"example.com\",\n \"ioc_type\": \"17f5e655-e492-4e02-b57c-6e70e13c36a9\",\n \"ioc_type_data\": {\n \"title\": \"ioc_domain\",\n \"unique_id\": \"17f5e655-e492-4e02-b57c-6e70e13c36a9\",\n \"created\": \"2021-06-09T09:35:59.805028Z\",\n \"modified\": \"2021-06-09T09:37:05.970350Z\",\n \"display_name\": \"Domain\"\n },\n \"tlp\": \"WHITE\",\n \"status\": \"none\"\n }\n ],\n \"ioc_url_data\": [],\n \"ioc_email_data\": [\n {\n \"unique_id\": \"7b83f977-b4f4-4980-978e-a3473f9961c1\",\n \"created\": \"2022-02-21T09:10:05.936031Z\",\n \"modified\": \"2022-02-21T09:10:05.936031Z\",\n \"value\": \"example@example.com\",\n \"ioc_type\": \"547ca705-ad6b-4b29-9250-4298adf20449\",\n \"ioc_type_data\": {\n \"title\": \"ioc_email\",\n \"unique_id\": \"547ca705-ad6b-4b29-9250-4298adf20449\",\n \"created\": \"2021-06-09T09:35:59.817532Z\",\n \"modified\": \"2021-06-09T09:37:06.414607Z\",\n \"display_name\": \"Email\"\n },\n \"tlp\": \"WHITE\",\n \"status\": \"none\"\n }\n ],\n \"ioc_MD5_data\": [],\n \"ioc_SHA1_data\": [],\n \"ioc_SHA256_data\": [],\n \"cve\": null,\n \"remediation_owner\": null,\n \"impact\": null,\n \"mitigation\": null,\n \"reference_link\": null,\n \"additional_comments\": null\n}"}],"_postman_id":"454c7db7-8fed-4351-8d1d-ef8f171b7e90"},{"name":"Create Vulnerability Using Field UUID","id":"06189c3d-cb81-4369-9a80-0ac8e6ef6b1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Vulnerability 7.0.0\",\n \"risk\": \"Low\",\n \"source\": [\n \"Manual\",\n \"Nessus\",\n \"Qualys\"\n ],\n \"priority\": \"Very High\",\n \"type\": [\n \"Local Exploit\",\n \"Mobile Application Vulnerability\"\n ],\n \"scan_date\": \"2022-02-14T18:30:00.000Z\",\n \"publish_date\": \"2022-02-16T12:05:49.000Z\",\n \"remediation_status\": \"In Progress\",\n \"last_updated\": \"2022-02-16T12:05:49.000Z\",\n \"target_remediation_date\": \"2022-02-16T12:05:49.000Z\",\n \"cia_impact\": [\n \"Confidentiality\"\n ],\n \"user_interaction_required\": \"Yes\",\n \"privileges_required\": \"Medium\",\n \"description\": \"

Vulnerability 7.0.0

\",\n \"status\": \"open\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/vulnerability/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Add a new vulnerability in the CFTR application using the UUID values of the fields.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/vulnerability/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`title`	String	Mandatory	Enter a title for the vulnerability
`risk`	String	Mandatory	Enter the risk associated with the vulnerability. Allowed values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`source`	List	Mandatory	Enter the list of sources of the vulnerability. Examples of sources: - `Qualys` - `Nessus` - `N-map` - `Manual`
`priority`	String	Mandatory	Enter the priority of the vulnerability. Allowed values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`description`	Text	Optional	Enter a description of the vulnerability.
`status`	String	Optional	Enter the status of the vulnerability. Allowed values: - `open` - `closed` Default value: `open`
`type`	List	Optional	Enter the list of the types of the vulnerability. Allowed values: - `Configuration Issue` - `Denial of Service` - `Local Exploit` - `Mobile Application Vulnerability` - `Network Vulnerability` - `Privilege Escalation` - `Remote Exploit` - `Web Application Vulnerability`
`scan_date`	String	Optional	Enter the scan date of the vulnerability in ISO format.
`remediation_status`	String	Optional	Enter the remediation status of the vulnerability. Allowed values: - `Open` - `In Progress` - `Remediated`
`labels`	List	Optional	Enter the list of the names of labels to be added to the vulnerability. You can use the following API endpoint to retrieve the list of Labels: /`openapi/v1/utils/label/`

Request Parameters | Custom Form Fields

In addition to the above mentioned parameters, the request parameters may vary as per the form configuration defined by your CFTR admin for vulnerabilities. For such parameters, use the field_readable_key of each parameter. To retrieve the field_readable_key and additional metadata of a parameter, use the Form Tab Structure API for vulnerabilities.

Example

The following endpoint retrieves the field_readable_key for all custom fields in the vulnerability component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=vulnerability\n\n

Following are some of the sample custom fields for vulnerabilities:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters

Response Parameters | Regulatory Fields

Parameter	Type	Description
`title`	String	Title of the vulnerability.
`unique_id`	String	Unique ID of the vulnerability.
`readable_id`	String	Readable ID of the vulnerability.
`description`	Text	Description of the vulnerability.
`created`	String	Creation date and time of the vulnerability in ISO format.
`modified`	String	Last Updated date and time of the vulnerability in ISO format.
`status`	String	Current status of the vulnerability. Allowed values: `open` `closed`
`risk`	String	Risk associated with the vulnerability. Allowed values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`priority`	String	Priority of the vulnerability. Allowed values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`created_by_data`	Object	Details of user who created the vulnerability.
`closed_by`	String	`user_id` of the user who closed the vulnerability.
`closed_by_data`	Object	Details of user who closed the vulnerability.
`closed_on`	String	Closing date of the vulnerability in ISO format.
`is_bookmarked`	Boolean	Shows whether the vulnerability is bookmarked or not.
`labels`	List	List of `unique_id` of labels that are added to the vulnerability.
`labels_data`	List of Objects	Details of the labels that are added to the vulnerability.
`risk_data`	Object	Details of the risk associated with the Vulnerability.
`priority_data`	Object	Details of the priority of the vulnerability.
`source_data`	List of Objects	Details of the source associated with the vulnerability.

Response Parameters | Connect The Dots

Parameter	Type	Description
`applications`	Array of UUID Strings	List of `unique_id` of the connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`softwares`	Array of UUID Strings	List of `unique_id` of the connected software.
`softwares_data`	Array of Objects	Details of the connected software.
`users`	Array of UUID Strings	List of `unique_id` of the connected users.
`users_data`	Array of Objects	Details of the connected users.
`endpoints`	Array of UUID Strings	List of `unique_id` of the connected devices.
`endpoints_data`	Array of Objects	Details of the connected devices.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.

Response Parameters | Default Indicators

Following are the seven standard indicators that are included by default in the CFTR platform, which reflect in the vulnerability's response data with the following keys:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`ioc_SHA1`	Array of UUID Strings	List of `unique_id` of the connected SHA1 Threat Intels.
`ioc_SHA1_data`	Array of Objects	Details of the connected SHA1 Threat Intels.
`ioc_MD5`	Array of UUID Strings	List of `unique_id` of the connected MD5 Threat Intels.
`ioc_MD5_data`	Array of Objects	Details of the connected MD5 Threat Intels.
`ioc_SHA256`	Array of UUID Strings	List of `unique_id` of the connected SHA256 Threat Intels.
`ioc_SHA256_data`	Array of Objects	Details of the connected SHA256 Threat Intels.
`ioc_ip`	Array of UUID Strings	List of `unique_id` of the connected IP Threat Intels.
`ioc_ip_data`	Array of Objects	Details of the connected IP Threat Intels.
`ioc_url`	Array of UUID Strings	List of `unique_id` of the connected URL Threat Intels.
`ioc_url_data`	Array of Objects	Details of the connected URL Threat Intels.
`ioc_domain`	Array of UUID Strings	List of `unique_id` of the connected domain Threat Intels.
`ioc_domain_data`	Array of Objects	Details of the connected domain Threat Intels.
`ioc_email`	Array of UUID Strings	List of `unique_id` of the connected email Threat Intels.
`ioc_email_data`	Array of Objects	Details of the connected email Threat Intels.

Response Parameters | Custom Indicators

Custom indicators are managed using the Form Management for Threat Intel.

Parameter key syntax: ioc_{{camel_case_of_threat_intel_name}}

Example

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`ioc_credit_card`	Array of UUID Strings	List of unique IDs of indicators in UUID-4 format corresponding to the Credit Card Threat Intel.
`ioc_credit_card_data`	Array of Objects	Details of the indicators.

Response Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the vulnerability component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=vulnerability\n\n

Following are some of the sample custom fields for vulnerabilities:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters | Attachments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`attachments_data`	Array of Objects	Details of each attachment of the vulnerability.

Response Parameters | Actions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`actions_data`	Array of Objects	Details of the actions that are added for the vulnerability.

Response Parameters | Enhancements

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`enhancements`	Array of UUID Strings	List of the enhancements that are added for the vulnerability.
`enhancements_data`	Array of Objects	Details of the enhancements that are added for the vulnerability.

Response Parameters | PIRs

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`pirs_data`	Array of Objects	Details of the PIRs that are added for the vulnerability.

","urlObject":{"path":["vulnerability",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"e7bf9605-d96e-460d-8fc6-e5223ca64f27","name":"Create Vulnerability","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Vulnerability 7.0.0\",\n \"risk\": \"Low\",\n \"source\": [\n \"Manual\",\n \"Nessus\",\n \"Qualys\"\n ],\n \"priority\": \"Very High\",\n \"type\": [\n \"Local Exploit\",\n \"Mobile Application Vulnerability\"\n ],\n \"scan_date\": \"2022-02-14T18:30:00.000Z\",\n \"publish_date\": \"2022-02-16T12:05:49.000Z\",\n \"remediation_status\": \"In Progress\",\n \"last_updated\": \"2022-02-16T12:05:49.000Z\",\n \"target_remediation_date\": \"2022-02-16T12:05:49.000Z\",\n \"cia_impact\": [\n \"Confidentiality\"\n ],\n \"user_interaction_required\": \"Yes\",\n \"privileges_required\": \"Medium\",\n \"description\": \"

Vulnerability 7.0.0

\",\n \"status\": \"open\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/vulnerability/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["vulnerability",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Thu, 17 Feb 2022 12:17:28 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"4664","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"description\": \"

Vulnerability 7.0.0

\",\n \"risk\": \"Low\",\n \"priority\": \"Very High\",\n \"privileges_required\": \"Medium\",\n \"user_interaction_required\": \"Yes\",\n \"source\": [\n \"Manual\",\n \"Nessus\",\n \"Qualys\"\n ],\n \"type\": [\n \"Local Exploit\",\n \"Mobile Application Vulnerability\"\n ],\n \"cia_impact\": [\n \"Confidentiality\"\n ],\n \"ioc_url\": [],\n \"ioc_SHA1\": [],\n \"ioc_MD5\": [],\n \"ioc_email\": [],\n \"ioc_domain\": [],\n \"ioc_SHA256\": [],\n \"ioc_ip\": [],\n \"unique_id\": \"b8907aa1-d591-4d28-a83f-8c5dfc2384f7\",\n \"readable_id\": \"VUL107\",\n \"created\": \"2022-02-17T12:17:27.001499Z\",\n \"modified\": \"2022-02-17T12:17:27.165131Z\",\n \"title\": \"Vulnerability 7.0.0\",\n \"status\": \"open\",\n \"briefings\": [],\n \"briefings_data\": [],\n \"incidents_data\": [],\n \"campaigns\": [],\n \"campaigns_data\": [],\n \"incidents\": [],\n \"is_bookmarked\": false,\n \"cvss_score\": null,\n \"actions_data\": [],\n \"sla\": null,\n \"due_date\": null,\n \"enhancements\": [],\n \"enhancements_data\": [],\n \"malwares\": [],\n \"malwares_data\": [],\n \"treat_actors\": [],\n \"treat_actors_data\": [],\n \"can_close_instance\": true,\n \"attachments_data\": [],\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"closed_by_data\": null,\n \"title_display\": \"Vulnerability 7.0.0\",\n \"labels\": [],\n \"labels_data\": [],\n \"scan_date\": \"2022-02-14T18:30:00Z\",\n \"custom_risk_score\": null,\n \"publish_date\": \"2022-02-16T12:05:49Z\",\n \"last_updated\": \"2022-02-16T12:05:49Z\",\n \"target_remediation_date\": \"2022-02-16T12:05:49Z\",\n \"applications\": [],\n \"applications_data\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"softwares\": [],\n \"softwares_data\": [],\n \"pirs_data\": [],\n \"closed_on\": null,\n \"closed_by\": null,\n \"type_data\": [\n {\n \"unique_id\": \"4f2aa462-9a8d-4eb6-8131-eb3b01658b61\",\n \"option_name\": \"Local Exploit\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"c3391585-a17c-40af-a192-e6aa3dac0700\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n {\n \"unique_id\": \"d186cff8-8a82-486e-899b-d004e6a1a9bb\",\n \"option_name\": \"Mobile Application Vulnerability\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"c3391585-a17c-40af-a192-e6aa3dac0700\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n }\n ],\n \"risk_data\": {\n \"unique_id\": \"a2a2e6e8-45c9-4f8e-854b-58966237b682\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"3d1492b5-1ea2-45dd-8bce-c10fabe3cd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"source_data\": [\n {\n \"unique_id\": \"78b5ba51-7bae-4695-855f-7c817dd4f300\",\n \"option_name\": \"Manual\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"43827c71-7790-4e62-a521-cc300df1abe3\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n {\n \"unique_id\": \"dc075247-cede-489e-925b-6b28923b2410\",\n \"option_name\": \"Nessus\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"43827c71-7790-4e62-a521-cc300df1abe3\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n {\n \"unique_id\": \"07f83d29-3831-43b9-8a3e-7cf650f0426f\",\n \"option_name\": \"Qualys\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"43827c71-7790-4e62-a521-cc300df1abe3\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n }\n ],\n \"privileges_required_data\": {\n \"unique_id\": \"b91ff63e-8150-486f-ad90-4a29e62c6b07\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"e9689886-c0f9-470d-8d18-5f0719e2bf19\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"user_interaction_required_data\": {\n \"unique_id\": \"4273d93b-e7ea-4b93-af85-f99b577f2781\",\n \"option_name\": \"Yes\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"f0788a69-ba89-47cd-8b1a-8029c73db4eb\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"cia_impact_data\": [\n {\n \"unique_id\": \"8bb6b807-461e-4f9b-acf6-c9f29e7d43dc\",\n \"option_name\": \"Confidentiality\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"123b3e62-9ffd-45f6-9bfa-cdab51394b6c\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n }\n ],\n \"remediation_status_data\": {\n \"unique_id\": \"9b69c18a-9075-4025-86b2-2f6f6b838a59\",\n \"option_name\": \"In Progress\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"6b0ba666-0671-4997-a55e-955d886d1f5c\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"priority_data\": {\n \"unique_id\": \"a5950bcc-5eb4-450d-a36f-367d906be3b5\",\n \"option_name\": \"Very High\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"143dd7a5-880c-4af0-af5b-01b947bf8c16\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false\n },\n \"ioc_ip_data\": [],\n \"ioc_domain_data\": [],\n \"ioc_url_data\": [],\n \"ioc_email_data\": [],\n \"ioc_MD5_data\": [],\n \"ioc_SHA1_data\": [],\n \"ioc_SHA256_data\": [],\n \"cve\": null,\n \"remediation_owner\": null,\n \"impact\": null,\n \"mitigation\": null,\n \"reference_link\": null,\n \"additional_comments\": null\n}"}],"_postman_id":"06189c3d-cb81-4369-9a80-0ac8e6ef6b1a"},{"name":"Create Vulnerability Using Field Values","id":"5c5ebb98-087b-4bb0-a7b2-72c181b66883","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Vulnerability 7.0.0\",\n \"risk\": \"Low\",\n \"source\": [\n \"Manual\",\n \"Nessus\",\n \"Qualys\"\n ],\n \"priority\": \"Very High\",\n \"type\": [\n \"Local Exploit\",\n \"Mobile Application Vulnerability\"\n ],\n \"scan_date\": \"2022-02-14T18:30:00.000Z\",\n \"publish_date\": \"2022-02-16T12:05:49.000Z\",\n \"remediation_status\": \"In Progress\",\n \"last_updated\": \"2022-02-16T12:05:49.000Z\",\n \"target_remediation_date\": \"2022-02-16T12:05:49.000Z\",\n \"cia_impact\": [\n \"Confidentiality\"\n ],\n \"user_interaction_required\": \"Yes\",\n \"privileges_required\": \"Medium\",\n \"description\": \"

Vulnerability 7.0.0

\",\n \"status\": \"open\",\n \"labels\": [\"Blue Label Vulnerability\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/vulnerability/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","description":"

Add a new vulnerability in the CFTR application using the field values.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/vulnerability/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`title`	String	Mandatory	Enter a title for the vulnerability
`risk`	String	Mandatory	Enter the risk associated with the vulnerability. Allowed values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`source`	List	Mandatory	Enter the list of sources of the vulnerability. Examples of sources: - `Qualys` - `Nessus` - `N-map` - `Manual`
`priority`	String	Mandatory	Enter the priority of the vulnerability. Allowed values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`description`	Text	Optional	Enter a description of the vulnerability.
`status`	String	Optional	Enter the status of the vulnerability. Allowed values: - `open` - `closed` Default value: `open`
`type`	List	Optional	Enter the list of the types of the vulnerability. Allowed values: - `Configuration Issue` - `Denial of Service` - `Local Exploit` - `Mobile Application Vulnerability` - `Network Vulnerability` - `Privilege Escalation` - `Remote Exploit` - `Web Application Vulnerability`
`scan_date`	String	Optional	Enter the scan date of the vulnerability in ISO format.
`remediation_status`	String	Optional	Enter the remediation status of the vulnerability. Allowed values: - `Open` - `In Progress` - `Remediated`
`labels`	List	Optional	Enter the list of the names of labels to be added to the vulnerability. You can use the following API endpoint to retrieve the list of Labels: /`openapi/v1/utils/label/`

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the vulnerability component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=vulnerability\n\n

Following are some of the sample custom fields for vulnerabilities:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters

Response Parameters | Regulatory Fields

Parameter	Type	Description
`title`	String	Title of the vulnerability.
`unique_id`	String	Unique ID of the vulnerability.
`readable_id`	String	Readable ID of the vulnerability.
`description`	Text	Description of the vulnerability.
`created`	String	Creation date and time of the vulnerability in ISO format.
`modified`	String	Last updated date and time of the vulnerability in ISO format.
`status`	String	Current status of the vulnerability. Allowed values: `open` `closed`
`type`	List	List of types added to the vulerability. For example, Local Exploit, Mobile Application Vulnerability.
`risk`	String	Risk associated with the vulnerability. Allowed values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`priority`	String	Priority of the vulnerability. Allowed values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`created_by_data`	Object	Details of user who created the vulnerability.
`closed_by`	String	`user_id` of the user who closed the vulnerability.
`closed_by_data`	Object	Details of user who closed the vulnerability.
`closed_on`	String	Closing date of the vulnerability in ISO format.
`is_bookmarked`	Boolean	Shows whether the vulnerability is bookmarked or not.
`labels`	List	List of `unique_id`of the labels added to the vulnerability.
`labels_data`	List of Objects	Details of the labels that are added to the vulnerability.
`risk_data`	Object	Details of the risk associated with the vulnerability.
`source_data`	List of Objects	Details of the sourced associated with the vulnerability.

Response Parameters | Connect The Dots

Parameter	Type	Description
`applications`	Array of UUID Strings	List of `unique_id` of the connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`softwares`	Array of UUID Strings	List of `unique_id` of the connected software.
`softwares_data`	Array of Objects	Details of the connected software.
`users`	Array of UUID Strings	List of `unique_id` of the connected users.
`users_data`	Array of Objects	Details of the connected users.
`endpoints`	Array of UUID Strings	List of `unique_id` of the connected devices.
`endpoints_data`	Array of Objects	Details of the connected devices.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.

Response Parameters | Default Indicators

Following are the seven standard indicators that are included by default in the CFTR platform, which reflect in the vulnerability's response data with the following keys:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`ioc_SHA1`	Array of UUID Strings	List of `unique_id` of the connected SHA1 Threat Intels.
`ioc_SHA1_data`	Array of Objects	Details of the connected SHA1 Threat Intels.
`ioc_MD5`	Array of UUID Strings	List of `unique_id` of the connected MD5 Threat Intels.
`ioc_MD5_data`	Array of Objects	Details of the connected MD5 Threat Intels.
`ioc_SHA256`	Array of UUID Strings	List of `unique_id` of the connected SHA256 Threat Intels.
`ioc_SHA256_data`	Array of Objects	Details of the connected SHA256 Threat Intels.
`ioc_ip`	Array of UUID Strings	List of `unique_id` of the connected IP Threat Intels.
`ioc_ip_data`	Array of Objects	Details of the connected IP Threat Intels.
`ioc_url`	Array of UUID Strings	List of `unique_id` of the connected URL Threat Intels.
`ioc_url_data`	Array of Objects	Details of the connected URL Threat Intels.
`ioc_domain`	Array of UUID Strings	List of `unique_id` of the connected domain Threat Intels.
`ioc_domain_data`	Array of Objects	Details of the connected domain Threat Intels.
`ioc_email`	Array of UUID Strings	List of `unique_id` of the connected email Threat Intels.
`ioc_email_data`	Array of Objects	Details of the connected email Threat Intels.

Response Parameters | Custom Indicators

Custom indicators are managed using the Form Management for Threat Intel.

Parameter key syntax: ioc_{{camel_case_of_threat_intel_name}}

Example

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`ioc_credit_card`	Array of UUID Strings	List of unique IDs of indicators in UUID-4 format corresponding to the Credit Card Threat Intel.
`ioc_credit_card_data`	Array of Objects	Details of the indicators.

Response Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the vulnerability component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=vulnerability\n\n

Following are some of the sample custom fields for vulnerabilities:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters | Attachments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`attachments_data`	Array of Objects	Details of each attachment of the vulnerability.

Response Parameters | Actions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`actions_data`	Array of Objects	Details of the actions that are added for the vulnerability.

Response Parameters | Enhancements

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`enhancements`	Array of UUID Strings	List of the enhancements that are added for the vulnerability.
`enhancements_data`	Array of Objects	Details of the enhancements that are added for the vulnerability.

Response Parameters | PIRs

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`pirs_data`	Array of Objects	Details of the PIRs that are added for the vulnerability.

Do not change the parameter value\nAllows you to create vulnerabilites using the values of labels.

\n","type":"text/plain"},"key":"values","value":"readable_type"}],"variable":[]}},"response":[{"id":"33a2924f-c664-4e4e-80b1-0d759cef003e","name":"201 Created: Create Vulnerability Using Field Values","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Vulnerability 7.0.0\",\n \"risk\": \"Low\",\n \"source\": [\n \"Manual\",\n \"Nessus\",\n \"Qualys\"\n ],\n \"priority\": \"Very High\",\n \"type\": [\n \"Local Exploit\",\n \"Mobile Application Vulnerability\"\n ],\n \"scan_date\": \"2022-02-14T18:30:00.000Z\",\n \"publish_date\": \"2022-02-16T12:05:49.000Z\",\n \"remediation_status\": \"In Progress\",\n \"last_updated\": \"2022-02-16T12:05:49.000Z\",\n \"target_remediation_date\": \"2022-02-16T12:05:49.000Z\",\n \"cia_impact\": [\n \"Confidentiality\"\n ],\n \"user_interaction_required\": \"Yes\",\n \"privileges_required\": \"Medium\",\n \"description\": \"

Vulnerability 7.0.0

\",\n \"status\": \"open\",\n \"labels\": [\"Blue Label Vulnerability\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/vulnerability/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","host":["{{base_url}}v1"],"path":["vulnerability",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"values","value":"readable_type","description":"**Do not change the parameter value**\nAllows you to create vulnerabilites using the values of labels."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Apr 2023 07:58:08 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"4946","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"cve\": null,\n \"remediation_owner\": null,\n \"impact\": null,\n \"mitigation\": null,\n \"reference_link\": null,\n \"additional_comments\": null,\n \"description\": \"

Vulnerability 7.0.0

\",\n \"risk\": \"Low\",\n \"remediation_status\": \"In Progress\",\n \"priority\": \"Very High\",\n \"privileges_required\": \"Medium\",\n \"user_interaction_required\": \"Yes\",\n \"source\": [\n \"Manual\",\n \"Nessus\",\n \"Qualys\"\n ],\n \"type\": [\n \"Local Exploit\",\n \"Mobile Application Vulnerability\"\n ],\n \"cia_impact\": [\n \"Confidentiality\"\n ],\n \"ioc_ip\": [],\n \"ioc_url\": [],\n \"ioc_SHA256\": [],\n \"ioc_MD5\": [],\n \"ioc_domain\": [],\n \"ioc_email\": [],\n \"ioc_SHA1\": [],\n \"unique_id\": \"85adc5a1-2893-4779-83dc-c2493baa8742\",\n \"readable_id\": \"VUL102\",\n \"created\": \"2023-04-21T07:58:06.994727Z\",\n \"modified\": \"2023-04-21T07:58:07.120601Z\",\n \"title\": \"Vulnerability 7.0.0\",\n \"status\": \"open\",\n \"briefings\": [],\n \"briefings_data\": [],\n \"incidents_data\": [],\n \"campaigns\": [],\n \"campaigns_data\": [],\n \"incidents\": [],\n \"is_bookmarked\": false,\n \"cvss_score\": null,\n \"actions_data\": [],\n \"sla\": null,\n \"due_date\": null,\n \"enhancements\": [],\n \"enhancements_data\": [],\n \"malwares\": [],\n \"malwares_data\": [],\n \"treat_actors\": [],\n \"treat_actors_data\": [],\n \"can_close_instance\": true,\n \"attachments_data\": [],\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"closed_by_data\": null,\n \"title_display\": \"Vulnerability 7.0.0\",\n \"labels\": [\n \"105cdef7-53f2-4342-8906-3dc18feefcce\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"105cdef7-53f2-4342-8906-3dc18feefcce\",\n \"title\": \"Blue Label Vulnerability\",\n \"color_code\": \"#5E35B1\",\n \"created\": \"2023-04-21T07:56:06.019777Z\",\n \"modified\": \"2023-04-21T07:56:06.019777Z\"\n }\n ],\n \"scan_date\": \"2022-02-14T18:30:00Z\",\n \"custom_risk_score\": null,\n \"publish_date\": \"2022-02-16T12:05:49Z\",\n \"last_updated\": \"2022-02-16T12:05:49Z\",\n \"target_remediation_date\": \"2022-02-16T12:05:49Z\",\n \"applications\": [],\n \"applications_data\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"softwares\": [],\n \"softwares_data\": [],\n \"pirs_data\": [],\n \"closed_on\": null,\n \"closed_by\": null,\n \"risk_data\": {\n \"unique_id\": \"51cc7271-ceda-49a9-a344-2980bb6ab9b2\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"9f2177c3-c061-4ba8-8a38-8447508ca6a5\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"source_data\": [\n {\n \"unique_id\": \"a34bd2c2-f09d-4dea-8a95-4f7d1ca76282\",\n \"option_name\": \"Manual\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"1b295987-7a9c-4e46-8beb-c44a444e4cbb\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"3646d101-0d1d-4ae9-a8d8-5e4701c926b8\",\n \"option_name\": \"Nessus\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"1b295987-7a9c-4e46-8beb-c44a444e4cbb\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"54a0be21-b098-4790-8997-666100d2ff6f\",\n \"option_name\": \"Qualys\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"1b295987-7a9c-4e46-8beb-c44a444e4cbb\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"remediation_status_data\": {\n \"unique_id\": \"2499cc0c-6d9b-4281-9f4c-36ff6e9e46b4\",\n \"option_name\": \"In Progress\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"d2c90405-d193-4c9f-8ae7-2ab7891136c4\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority_data\": {\n \"unique_id\": \"489111b9-bfd6-4657-ae53-7e9f2de53027\",\n \"option_name\": \"Very High\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"82927525-94d6-4987-8496-d0cc73dfffbf\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"type_data\": [\n {\n \"unique_id\": \"a6130a16-d626-4f01-9c01-f1e1dc5156ac\",\n \"option_name\": \"Local Exploit\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"1ca901ea-5c6b-49b6-ab0c-31ee6c60d88b\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"ed2d4c6e-d798-405b-a1ff-ead9e9ec1ab1\",\n \"option_name\": \"Mobile Application Vulnerability\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"1ca901ea-5c6b-49b6-ab0c-31ee6c60d88b\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"privileges_required_data\": {\n \"unique_id\": \"d7ff8fdf-0c42-4ae8-ab03-9795f9302008\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"1743edc5-2dee-49c1-a6dc-2c77b9166695\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"user_interaction_required_data\": {\n \"unique_id\": \"f2301f7d-e88e-4b31-8719-9121f866551e\",\n \"option_name\": \"Yes\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"4286def3-2f99-4851-89dc-493d6e89e018\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"cia_impact_data\": [\n {\n \"unique_id\": \"71a06a44-33af-46e2-8b4a-3ed9bb2646ff\",\n \"option_name\": \"Confidentiality\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"11757bd0-1714-466b-849e-c050e9b4b578\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"ioc_ip_data\": [],\n \"ioc_domain_data\": [],\n \"ioc_url_data\": [],\n \"ioc_email_data\": [],\n \"ioc_MD5_data\": [],\n \"ioc_SHA1_data\": [],\n \"ioc_SHA256_data\": []\n}"}],"_postman_id":"5c5ebb98-087b-4bb0-a7b2-72c181b66883"},{"name":"Update a Vulnerability Using Field UUID","id":"2cdb9310-70a1-41a6-b5a6-ee8969661a61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": \"closed\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/vulnerability/:vulnerabillity_unique_id?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Update details of a vulnerability in the CFTR Application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/vulnerability/:vulnerabillity_unique_id/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`title`	String	Optional	Enter a title for the vulnerability
`risk`	String	Optional	Enter the risk associated with the vulnerability. Allowed values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`source`	List	Optional	Enter the list of sources of the vulnerability. Examples of sources: - `Qualys` - `Nessus` - `N-map` - `Manual`
`priority`	String	Optional	Enter the priority of the vulnerability. Allowed values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`description`	Text	Optional	Enter a description of the vulnerability.
`status`	String	Optional	Enter the status of the vulnerability. Allowed values: - `open` - `closed` Default value: `open`
`type`	List	Optional	Enter the list of the types of the vulnerability. Allowed values: - `Configuration Issue` - `Denial of Service` - `Local Exploit` - `Mobile Application Vulnerability` - `Network Vulnerability` - `Privilege Escalation` - `Remote Exploit` - `Web Application Vulnerability`
`scan_date`	String	Optional	Enter the scan date of the vulnerability in ISO format.
`remediation_status`	String	Optional	Enter the remediation status of the vulnerability. Allowed values: - `Open` - `In Progress` - `Remediated`

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the vulnerability component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=vulnerability\n\n

Following are some of the sample custom fields for vulnerabilities:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters

Response Parameters | Regulatory Fields

Parameter	Type	Description
`title`	String	Title of the vulnerability.
`unique_id`	String	Unique ID of the vulnerability.
`readable_id`	String	Readable ID of the vulnerability.
`description`	Text	Description of the vulnerability.
`created`	String	Creation date and time of the vulnerability in ISO format.
`modified`	String	Last Updated date and time of the vulnerability in ISO format.
`status`	String	Current status of the vulnerability. Allowed values: `open` `closed`
`type`	List	List of types added to the vulerability. For example, Local Exploit, Mobile Application Vulnerability.
`risk`	String	Risk associated with the vulnerability. Allowed values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`priority`	String	Priority of the vulnerability. Allowed values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`created_by_data`	Object	Details of user who created the vulnerability.
`closed_by`	String	`user_id` of the user who closed the vulnerability.
`closed_by_data`	Object	Details of user who closed the vulnerability.
`closed_on`	String	Closing date of the vulnerability in ISO format.
`is_bookmarked`	Boolean	Shows whether the vulnerability is bookmarked or not.
`risk_data`	Object	Details of the risk of the vulnerability.
`source_data`	List of Objects	Details of the source of the vulnerability.
`priority_data`	Object	Details of the priority of the vulnerability.
`type_data`	List of Objects	Details of the type of the vulnerability.

Response Parameters | Connect The Dots

Parameter	Type	Description
`applications`	Array of UUID Strings	List of `unique_id` of the connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`softwares`	Array of UUID Strings	List of `unique_id` of the connected software.
`softwares_data`	Array of Objects	Details of the connected software.
`users`	Array of UUID Strings	List of `unique_id` of the connected users.
`users_data`	Array of Objects	Details of the connected users.
`endpoints`	Array of UUID Strings	List of `unique_id` of the connected devices.
`endpoints_data`	Array of Objects	Details of the connected devices.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.

Response Parameters | Default Indicators

Following are the seven standard indicators that are included by default in the CFTR platform, which reflect in the vulnerability's response data with the following keys:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`ioc_SHA1`	Array of UUID Strings	List of `unique_id` of the connected SHA1 Threat Intels.
`ioc_SHA1_data`	Array of Objects	Details of the connected SHA1 Threat Intels.
`ioc_MD5`	Array of UUID Strings	List of `unique_id` of the connected MD5 Threat Intels.
`ioc_MD5_data`	Array of Objects	Details of the connected MD5 Threat Intels.
`ioc_SHA256`	Array of UUID Strings	List of `unique_id` of the connected SHA256 Threat Intels.
`ioc_SHA256_data`	Array of Objects	Details of the connected SHA256 Threat Intels.
`ioc_ip`	Array of UUID Strings	List of `unique_id` of the connected IP Threat Intels.
`ioc_ip_data`	Array of Objects	Details of the connected IP Threat Intels.
`ioc_url`	Array of UUID Strings	List of `unique_id` of the connected URL Threat Intels.
`ioc_url_data`	Array of Objects	Details of the connected URL Threat Intels.
`ioc_domain`	Array of UUID Strings	List of `unique_id` of the connected domain Threat Intels.
`ioc_domain_data`	Array of Objects	Details of the connected domain Threat Intels.
`ioc_email`	Array of UUID Strings	List of `unique_id` of the connected email Threat Intels.
`ioc_email_data`	Array of Objects	Details of the connected email Threat Intels.

Response Parameters | Custom Indicators

Custom indicators are managed using the Form Management for Threat Intel.

Parameter key syntax: ioc_{{camel_case_of_threat_intel_name}}

Example

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`ioc_credit_card`	Array of UUID Strings	List of unique IDs of indicators in UUID-4 format corresponding to the Credit Card Threat Intel.
`ioc_credit_card_data`	Array of Objects	Details of the indicators.

Response Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the vulnerability component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=vulnerability\n\n

Following are some of the sample custom fields for vulnerabilities:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters | Attachments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`attachments_data`	Array of Objects	Details of each attachment of the vulnerability.

Response Parameters | Actions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`actions_data`	Array of Objects	Details of the actions that are added for the vulnerability.

Response Parameters | Enhancements

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`enhancements`	Array of UUID Strings	List of the enhancements that are added for the vulnerability.
`enhancements_data`	Array of Objects	Details of the enhancements that are added for the vulnerability.

Response Parameters | PIRs

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`pirs_data`	Array of Objects	Details of the PIRs that are added for the vulnerability.

Enter the unique ID of a vulnerability.

\n","type":"text/plain"},"type":"any","value":"0fda4848-29a3-4a00-bcbc-5fbf820b9b8d","key":"vulnerabillity_unique_id"}]}},"response":[{"id":"88c480ce-b63a-4692-a3e3-fd985b02dd04","name":"Update a Vulnerability Using Field UUID","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": \"closed\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/vulnerability/:vulnerabillity_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["vulnerability",":vulnerabillity_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"vulnerabillity_unique_id","value":"e61dd74b-7700-4ac3-bcef-c02390e5da70","description":"Enter the unique ID of a vulnerability."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 15 Jan 2024 11:45:13 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: http: data: blob:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"cve\": null,\n \"remediation_owner\": null,\n \"impact\": null,\n \"mitigation\": null,\n \"reference_link\": null,\n \"additional_comments\": null,\n \"description\": \"

Vulnerability 7.0.0

\",\n \"t1\": null,\n \"t2\": null,\n \"risk\": \"Low\",\n \"remediation_status\": \"In Progress\",\n \"priority\": \"Very High\",\n \"privileges_required\": \"Medium\",\n \"user_interaction_required\": \"Yes\",\n \"source\": [\n \"Manual\",\n \"Nessus\",\n \"Qualys\"\n ],\n \"type\": [\n \"Local Exploit\",\n \"Mobile Application Vulnerability\"\n ],\n \"cia_impact\": [\n \"Confidentiality\"\n ],\n \"ioc_ip\": [],\n \"ioc_SHA256\": [],\n \"ioc_url\": [],\n \"ioc_MD5\": [],\n \"ioc_email\": [],\n \"ioc_ti1\": [],\n \"ioc_ti2\": [],\n \"ioc_SHA1\": [],\n \"ioc_domain\": [],\n \"unique_id\": \"e61dd74b-7700-4ac3-bcef-c02390e5da70\",\n \"readable_id\": \"VUL137\",\n \"created\": \"2024-01-15T09:14:50.292094Z\",\n \"modified\": \"2024-01-15T11:45:13.401603Z\",\n \"title\": \"Vulnerability 7.0.0\",\n \"status\": \"closed\",\n \"briefings\": [],\n \"briefings_data\": [],\n \"incidents_data\": [],\n \"campaigns\": [],\n \"campaigns_data\": [],\n \"incidents\": [],\n \"is_bookmarked\": false,\n \"cvss_score\": null,\n \"actions_data\": [],\n \"sla\": null,\n \"due_date\": null,\n \"enhancements\": [],\n \"enhancements_data\": [],\n \"malwares\": [],\n \"malwares_data\": [],\n \"treat_actors\": [],\n \"treat_actors_data\": [],\n \"can_close_instance\": true,\n \"attachments_data\": [],\n \"created_by_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"c1918f8a-28ea-4124-9aea-814ea07cfba2\",\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System Default\"\n },\n \"closed_by_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"c1918f8a-28ea-4124-9aea-814ea07cfba2\",\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System Default\"\n },\n \"title_display\": \"Vulnerability 7.0.0\",\n \"labels\": [],\n \"labels_data\": [],\n \"scan_date\": \"2022-02-14T18:30:00Z\",\n \"custom_risk_score\": null,\n \"publish_date\": \"2022-02-16T12:05:49Z\",\n \"last_updated\": \"2022-02-16T12:05:49Z\",\n \"target_remediation_date\": \"2022-02-16T12:05:49Z\",\n \"applications\": [],\n \"applications_data\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"softwares\": [],\n \"softwares_data\": [],\n \"pirs_data\": [],\n \"closed_on\": \"2024-01-15T11:45:13.400283Z\",\n \"closed_by\": \"c1918f8a-28ea-4124-9aea-814ea07cfba2\",\n \"risk_data\": {\n \"unique_id\": \"b48700a2-f900-4c59-a9fe-5ae768f5f243\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"2cc22eab-46db-4a20-bdc4-d8851f8dad1b\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"source_data\": [\n {\n \"unique_id\": \"2ba8a0eb-bf85-4de6-831b-10c6d6cbc92d\",\n \"option_name\": \"Manual\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"7a1e6fc9-2bd2-489a-9904-c50b2d4b9f6b\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"f062f56f-53b8-4e9d-a167-9f7f331e72a5\",\n \"option_name\": \"Nessus\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"7a1e6fc9-2bd2-489a-9904-c50b2d4b9f6b\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"9d2092e5-9b16-4cbc-9527-97672bd5d77d\",\n \"option_name\": \"Qualys\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"7a1e6fc9-2bd2-489a-9904-c50b2d4b9f6b\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"remediation_status_data\": {\n \"unique_id\": \"8ffe61bb-2909-455b-924d-cd96388af6e6\",\n \"option_name\": \"In Progress\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"4cd24852-bb53-4685-a5cc-634e8cd61c10\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority_data\": {\n \"unique_id\": \"dd1e1b39-f7f0-4914-b245-e7fa7c170757\",\n \"option_name\": \"Very High\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"31fbc1cb-9811-4210-a729-86b40b1dae94\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"type_data\": [\n {\n \"unique_id\": \"2383942d-ad71-40be-bbb1-8b9dfcb64eb0\",\n \"option_name\": \"Local Exploit\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"0f5d91d1-c3ec-49d3-8741-e98373fbd1bd\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"05d8dab0-6060-45b6-98ea-233834a1346e\",\n \"option_name\": \"Mobile Application Vulnerability\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"0f5d91d1-c3ec-49d3-8741-e98373fbd1bd\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"privileges_required_data\": {\n \"unique_id\": \"918d942b-e57f-4275-954c-3d0f3610918d\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"6b4f4877-e2b4-4a5c-a0be-472535467e15\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"user_interaction_required_data\": {\n \"unique_id\": \"b9e6ddcd-5faf-4c28-8d03-fa75b591c6b2\",\n \"option_name\": \"Yes\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"f73f5c4f-3fa7-4f26-a1e1-ece5624d5082\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"cia_impact_data\": [\n {\n \"unique_id\": \"2d0a1428-d287-4de4-8ece-c59403bdcfad\",\n \"option_name\": \"Confidentiality\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"d938d50f-414b-4364-9e7d-b5e43361d604\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"ioc_ip_data\": [],\n \"ioc_domain_data\": [],\n \"ioc_url_data\": [],\n \"ioc_email_data\": [],\n \"ioc_MD5_data\": [],\n \"ioc_SHA1_data\": [],\n \"ioc_SHA256_data\": [],\n \"ioc_ti2_data\": [],\n \"ioc_ti1_data\": []\n}"}],"_postman_id":"2cdb9310-70a1-41a6-b5a6-ee8969661a61"},{"name":"Update Vulnerability Using Field Values","id":"23510393-d97a-44ab-91bc-9381a8d82c71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"labels\": [\"Red Label Vulnerability\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/vulnerability/:vulnerabillity_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","description":"

Update details of a vulnerability in the CFTR Application using the values of labels.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/vulnerability/:vulnerabillity_unique_id/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`title`	String	Optional	Enter a title for the vulnerability
`risk`	String	Optional	Enter the risk associated with the vulnerability. Allowed values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`source`	List	Optional	Enter the list of sources of the vulnerability. Examples of sources: - `Qualys` - `Nessus` - `N-map` - `Manual`
`priority`	String	Optional	Enter the priority of the vulnerability. Allowed values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`description`	Text	Optional	Enter a description of the vulnerability.
`status`	String	Optional	Enter the status of the vulnerability. Allowed values: - `open` - `closed` Default value: `open`
`type`	List	Optional	Enter the list of the types of the vulnerability. Allowed values: - `Configuration Issue` - `Denial of Service` - `Local Exploit` - `Mobile Application Vulnerability` - `Network Vulnerability` - `Privilege Escalation` - `Remote Exploit` - `Web Application Vulnerability`
`scan_date`	String	Optional	Enter the scan date of the vulnerability in ISO format.
`remediation_status`	String	Optional	Enter the remediation status of the vulnerability. Allowed values: - `Open` - `In Progress` - `Remediated`
`labels`	List	Optional	Enter the list of the names of labels to be added to the action. You can use the following API endpoint to retrieve the list of Labels: `/openapi/v1/utils/label/`

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the vulnerability component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=vulnerability\n\n

Following are some of the sample custom fields for vulnerabilities:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters

Response Parameters | Regulatory Fields

Parameter	Type	Description
`title`	String	Title of the vulnerability.
`unique_id`	String	Unique ID of the vulnerability.
`readable_id`	String	Readable ID of the vulnerability.
`description`	Text	Description of the vulnerability.
`created`	String	Creation date and time of the vulnerability in ISO format.
`modified`	String	Last Updated date and time of the vulnerability in ISO format.
`status`	String	Current status of the vulnerability. Allowed values: `open` `closed`
`risk`	String	Risk associated with the vulnerability. Allowed values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`priority`	String	Priority of the vulnerability. Allowed values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`created_by_data`	Object	Details of user who created the vulnerability.
`closed_by`	String	`user_id` of the user who closed the vulnerability.
`closed_by_data`	Object	Details of user who closed the vulnerability.
`closed_on`	String	Closing date of the vulnerability in ISO format.
`is_bookmarked`	Boolean	Shows whether the vulnerability is bookmarked or not.
`risk_data`	Object	Details of the risk of the vulnerability.
`source_data`	List of Objects	Details of the source of the vulnerability.
`priority_data`	Object	Details of the priority of the vulnerability.
`type_data`	List of Objects	Details of the type of the vulnerability.

Response Parameters | Connect The Dots

Parameter	Type	Description
`applications`	Array of UUID Strings	List of `unique_id` of the connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`softwares`	Array of UUID Strings	List of `unique_id` of the connected software.
`softwares_data`	Array of Objects	Details of the connected software.
`users`	Array of UUID Strings	List of `unique_id` of the connected users.
`users_data`	Array of Objects	Details of the connected users.
`endpoints`	Array of UUID Strings	List of `unique_id` of the connected devices.
`endpoints_data`	Array of Objects	Details of the connected devices.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.

Response Parameters | Default Indicators

Following are the seven standard indicators that are included by default in the CFTR platform, which reflect in the vulnerability's response data with the following keys:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`ioc_SHA1`	Array of UUID Strings	List of `unique_id` of the connected SHA1 Threat Intels.
`ioc_SHA1_data`	Array of Objects	Details of the connected SHA1 Threat Intels.
`ioc_MD5`	Array of UUID Strings	List of `unique_id` of the connected MD5 Threat Intels.
`ioc_MD5_data`	Array of Objects	Details of the connected MD5 Threat Intels.
`ioc_SHA256`	Array of UUID Strings	List of `unique_id` of the connected SHA256 Threat Intels.
`ioc_SHA256_data`	Array of Objects	Details of the connected SHA256 Threat Intels.
`ioc_ip`	Array of UUID Strings	List of `unique_id` of the connected IP Threat Intels.
`ioc_ip_data`	Array of Objects	Details of the connected IP Threat Intels.
`ioc_url`	Array of UUID Strings	List of `unique_id` of the connected URL Threat Intels.
`ioc_url_data`	Array of Objects	Details of the connected URL Threat Intels.
`ioc_domain`	Array of UUID Strings	List of `unique_id` of the connected domain Threat Intels.
`ioc_domain_data`	Array of Objects	Details of the connected domain Threat Intels.
`ioc_email`	Array of UUID Strings	List of `unique_id` of the connected email Threat Intels.
`ioc_email_data`	Array of Objects	Details of the connected email Threat Intels.

Response Parameters | Custom Indicators

Custom indicators are managed using the Form Management for Threat Intel.

Parameter key syntax: ioc_{{camel_case_of_threat_intel_name}}

Example

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`ioc_credit_card`	Array of UUID Strings	List of unique IDs of indicators in UUID-4 format corresponding to the Credit Card Threat Intel.
`ioc_credit_card_data`	Array of Objects	Details of the indicators.

Response Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the vulnerability component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=vulnerability\n\n

Following are some of the sample custom fields for vulnerabilities:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters | Attachments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`attachments_data`	Array of Objects	Details of each attachment of the vulnerability.

Response Parameters | Actions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`actions_data`	Array of Objects	Details of the actions that are added for the vulnerability.

Response Parameters | Enhancements

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`enhancements`	Array of UUID Strings	List of the enhancements that are added for the vulnerability.
`enhancements_data`	Array of Objects	Details of the enhancements that are added for the vulnerability.

Response Parameters | PIRs

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`pirs_data`	Array of Objects	Details of the PIRs that are added for the vulnerability.

","urlObject":{"path":["vulnerability",":vulnerabillity_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"description":{"content":"

Do not change the parameter value\nAllows you to update vulnerabilities using the values of labels.

\n","type":"text/plain"},"key":"values","value":"readable_type"}],"variable":[{"description":{"content":"

Enter the unique ID of a vulnerability.

\n","type":"text/plain"},"type":"any","value":"85adc5a1-2893-4779-83dc-c2493baa8742","key":"vulnerabillity_unique_id"}]}},"response":[{"id":"19c7a4f2-cf76-4345-970e-5760aa6f5db6","name":"200 OK: Update Vulnerability Using Field Values","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"labels\": [\"Red Label Vulnerability\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/vulnerability/:vulnerabillity_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","host":["{{base_url}}v1"],"path":["vulnerability",":vulnerabillity_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"values","value":"readable_type","description":"**Do not change the parameter value**\nAllows you to update vulnerabilites using the values of labels."}],"variable":[{"key":"vulnerabillity_unique_id","value":"85adc5a1-2893-4779-83dc-c2493baa8742","description":"Enter the unique ID of a vulnerability."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Apr 2023 08:05:47 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"cve\": null,\n \"remediation_owner\": null,\n \"impact\": null,\n \"mitigation\": null,\n \"reference_link\": null,\n \"additional_comments\": null,\n \"description\": \"

Vulnerability 7.0.0

\",\n \"risk\": \"Low\",\n \"remediation_status\": \"In Progress\",\n \"priority\": \"Very High\",\n \"privileges_required\": \"Medium\",\n \"user_interaction_required\": \"Yes\",\n \"source\": [\n \"Manual\",\n \"Nessus\",\n \"Qualys\"\n ],\n \"type\": [\n \"Local Exploit\",\n \"Mobile Application Vulnerability\"\n ],\n \"cia_impact\": [\n \"Confidentiality\"\n ],\n \"ioc_ip\": [],\n \"ioc_url\": [],\n \"ioc_SHA256\": [],\n \"ioc_MD5\": [],\n \"ioc_domain\": [],\n \"ioc_email\": [],\n \"ioc_SHA1\": [],\n \"unique_id\": \"85adc5a1-2893-4779-83dc-c2493baa8742\",\n \"readable_id\": \"VUL102\",\n \"created\": \"2023-04-21T07:58:06.994727Z\",\n \"modified\": \"2023-04-21T08:05:46.859920Z\",\n \"title\": \"Vulnerability 7.0.0\",\n \"status\": \"open\",\n \"briefings\": [],\n \"briefings_data\": [],\n \"incidents_data\": [],\n \"campaigns\": [],\n \"campaigns_data\": [],\n \"incidents\": [],\n \"is_bookmarked\": false,\n \"cvss_score\": null,\n \"actions_data\": [],\n \"sla\": null,\n \"due_date\": null,\n \"enhancements\": [],\n \"enhancements_data\": [],\n \"malwares\": [],\n \"malwares_data\": [],\n \"treat_actors\": [],\n \"treat_actors_data\": [],\n \"can_close_instance\": true,\n \"attachments_data\": [],\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"closed_by_data\": null,\n \"title_display\": \"Vulnerability 7.0.0\",\n \"labels\": [\n \"f8537635-174c-4fb7-8526-8a36ff1c05e5\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"f8537635-174c-4fb7-8526-8a36ff1c05e5\",\n \"title\": \"Red Label Vulnerability\",\n \"color_code\": \"#009688\",\n \"created\": \"2023-04-21T08:03:14.150611Z\",\n \"modified\": \"2023-04-21T08:03:14.150611Z\"\n }\n ],\n \"scan_date\": \"2022-02-14T18:30:00Z\",\n \"custom_risk_score\": null,\n \"publish_date\": \"2022-02-16T12:05:49Z\",\n \"last_updated\": \"2022-02-16T12:05:49Z\",\n \"target_remediation_date\": \"2022-02-16T12:05:49Z\",\n \"applications\": [],\n \"applications_data\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"softwares\": [],\n \"softwares_data\": [],\n \"pirs_data\": [],\n \"closed_on\": null,\n \"closed_by\": null,\n \"risk_data\": {\n \"unique_id\": \"51cc7271-ceda-49a9-a344-2980bb6ab9b2\",\n \"option_name\": \"Low\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"9f2177c3-c061-4ba8-8a38-8447508ca6a5\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"source_data\": [\n {\n \"unique_id\": \"a34bd2c2-f09d-4dea-8a95-4f7d1ca76282\",\n \"option_name\": \"Manual\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"1b295987-7a9c-4e46-8beb-c44a444e4cbb\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"3646d101-0d1d-4ae9-a8d8-5e4701c926b8\",\n \"option_name\": \"Nessus\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"1b295987-7a9c-4e46-8beb-c44a444e4cbb\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"54a0be21-b098-4790-8997-666100d2ff6f\",\n \"option_name\": \"Qualys\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"1b295987-7a9c-4e46-8beb-c44a444e4cbb\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"remediation_status_data\": {\n \"unique_id\": \"2499cc0c-6d9b-4281-9f4c-36ff6e9e46b4\",\n \"option_name\": \"In Progress\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"d2c90405-d193-4c9f-8ae7-2ab7891136c4\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority_data\": {\n \"unique_id\": \"489111b9-bfd6-4657-ae53-7e9f2de53027\",\n \"option_name\": \"Very High\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"82927525-94d6-4987-8496-d0cc73dfffbf\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"type_data\": [\n {\n \"unique_id\": \"a6130a16-d626-4f01-9c01-f1e1dc5156ac\",\n \"option_name\": \"Local Exploit\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"1ca901ea-5c6b-49b6-ab0c-31ee6c60d88b\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"ed2d4c6e-d798-405b-a1ff-ead9e9ec1ab1\",\n \"option_name\": \"Mobile Application Vulnerability\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"1ca901ea-5c6b-49b6-ab0c-31ee6c60d88b\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"privileges_required_data\": {\n \"unique_id\": \"d7ff8fdf-0c42-4ae8-ab03-9795f9302008\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"1743edc5-2dee-49c1-a6dc-2c77b9166695\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"user_interaction_required_data\": {\n \"unique_id\": \"f2301f7d-e88e-4b31-8719-9121f866551e\",\n \"option_name\": \"Yes\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"4286def3-2f99-4851-89dc-493d6e89e018\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"cia_impact_data\": [\n {\n \"unique_id\": \"71a06a44-33af-46e2-8b4a-3ed9bb2646ff\",\n \"option_name\": \"Confidentiality\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"11757bd0-1714-466b-849e-c050e9b4b578\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"ioc_ip_data\": [],\n \"ioc_domain_data\": [],\n \"ioc_url_data\": [],\n \"ioc_email_data\": [],\n \"ioc_MD5_data\": [],\n \"ioc_SHA1_data\": [],\n \"ioc_SHA256_data\": []\n}"}],"_postman_id":"23510393-d97a-44ab-91bc-9381a8d82c71"},{"name":"Add Comment in Vulnerability","id":"9fd4bdbd-29eb-4bb2-9a32-a95c39a0b10d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"description\": \"

Note For Vulnerability

\",\n \"mentioned_users_usernames\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/comments/vulnerability/:vulnerability_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Add notes to a vulnerability in the CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`description`	String	Mandatory	Enter the content of the comment.
`mentioned_users_usernames`	List of UUID	Optional	Enter the list of usernames of the users to be mentioned in the comment.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the comment.
`description`	Text	Description of the comment.
`created_by`	Object	Details of the user who added the comment.
`modified_by`	Object	Details of the user who last updated the comment.
`mentioned_users`	List of UUID	List of `user_id` of users mentioned in the comment.
`mentioned_users_data`	List of Objects	Details of the users mentioned in the comment.
`created`	String	Comment creation time.
`modified`	String	Comment last updated time.
`comment_type`	String	Type of Comment. Examples: `discussion`: Notes added in an instance.
`content_object`	String	Component in which the comment is added. Example: `device`, `incident`, `action`, `ioc`, `vulnerability`, and so on.
`content_object_readable_id`	String	`readable_id` of the vulnerability in which the comment is added.
`content_object_unique_id`	String	`unique_id` of the vulnerability in which the comment is added.
`description_with_img_src`	Text	Description with the image URLs (if image is added in the comment).
`pinned`	Boolean	Displays whether the comment is pinned or not.
`is_removed`	Boolean	Displays whether the comments is deleted or not.

","urlObject":{"path":["comments","vulnerability",":vulnerability_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of a vulnerability.

\n","type":"text/plain"},"type":"any","value":"0fda4848-29a3-4a00-bcbc-5fbf820b9b8d","key":"vulnerability_unique_id"}]}},"response":[{"id":"cd04221f-077f-45bb-a654-27f6271a3d2b","name":"Add Comment in Vulnerability","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"description\": \"

Note For Vulnerability

\",\n \"mentioned_users_usernames\": []\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/comments/vulnerability/:vulnerability_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["comments","vulnerability",":vulnerability_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"vulnerability_unique_id","value":"0fda4848-29a3-4a00-bcbc-5fbf820b9b8d","description":"Unique ID of the Vulnerability"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Thu, 24 Feb 2022 08:33:03 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"874","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"unique_id\": \"d7e05109-87ec-43b1-845d-c865bd5063cc\",\n \"description\": \"

Note For Vulnerability

\",\n \"created_by\": {\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"display_pic\": null,\n \"username\": \"jane\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"Jane Doe\"\n },\n \"modified_by\": null,\n \"is_removed\": false,\n \"mentioned_users\": [],\n \"mentioned_users_data\": [],\n \"created\": \"2022-02-24T08:33:02.347338Z\",\n \"modified\": \"2022-02-24T08:33:02.401127Z\",\n \"email\": null,\n \"internal\": false,\n \"comment_type\": \"discussion\",\n \"command_params\": {},\n \"command_result\": {},\n \"command_status\": \"na\",\n \"attachments_data\": [],\n \"content_object\": \"vulnerability\",\n \"content_object_readable_id\": \"VUL108\",\n \"content_object_unique_id\": \"0fda4848-29a3-4a00-bcbc-5fbf820b9b8d\",\n \"attachment_label\": null,\n \"description_with_img_src\": \"

Note For Vulnerability

\"\n}"}],"_postman_id":"9fd4bdbd-29eb-4bb2-9a32-a95c39a0b10d"},{"name":"Upload a File","id":"6908b573-e23f-48a3-ab09-36545deda226","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"key":"uploaded_file","type":"file","src":"New creds to test api.csv"}]},"url":"{{base_url}}v1/utils/file/vulnerability/:vulnerability_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Upload a file as an attachment in a vulnerability.

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`uploaded_file`	File	Mandatory	Enter the file to be uploaded.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	Text	Name of the file.
`description`	Text	Description of the file.
`uploaded_file`	URL	URL of the file from where it can be downloaded.
`unique_id`	String	Unique ID for the file.
`created_by_data`	Object	Details of the user who uploaded the file.
`created`	String	Upload date and time of the file.
`modified`	String	Last modified date and time of the file.
`readable_id`	String	Unique readable ID of the file.
`file_hash`	String	Hash value of the file.
`file_type`	String	Type of the file. Default value: `artifact`: Artifact
`file_size`	Integer	Size of the file.
`parent_readable_id`	String	`readable_id` of the vulnerability in which the file is uploaded.
`parent_component`	String	Component name in which the file is uploaded. Example: `incident`, `action`, `vulnerability` , and so on.
`parent_unique_id`	String	`unique_id` of the vulnerability in which the file is uploaded.
`is_removed`	Boolean	Displays whether the file is deleted or not.

","urlObject":{"path":["utils","file","vulnerability",":vulnerability_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of a vulnerability.

\n","type":"text/plain"},"type":"any","value":"b5a630a8-2096-4b80-8ace-732c26679d81","key":"vulnerability_unique_id"}]}},"response":[{"id":"a34ee55a-8cc9-49cf-baa1-300bf5c12afe","name":"Upload a File","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"key":"uploaded_file","type":"file","src":"/Users/aashijain/Downloads/ZiClJf-1920w.jpeg"}]},"url":{"raw":"{{base_url}}v1/utils/file/vulnerability/:vulnerability_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["utils","file","vulnerability",":vulnerability_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"vulnerability_unique_id","value":"0fda4848-29a3-4a00-bcbc-5fbf820b9b8d","description":"Unique ID of the Vulnerability"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Thu, 24 Feb 2022 11:56:57 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1084","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"ZiClJf-1920w.jpeg\",\n \"description\": null,\n \"uploaded_file\": \"http://host.docker.internal:51620/ciims-dev-1/ciims-data/e29ed8ad-ZiClJf-1920w.jpeg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minio%2F20220224%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20220224T115657Z&X-Amz-Expires=120&X-Amz-SignedHeaders=host&X-Amz-Signature=2a004b5315f13f3e63f536c1ab49588d24f29664586ffd0c9f4879ec07363cd9\",\n \"unique_id\": \"7e1804c9-4705-4d50-92ea-40c705b0d0df\",\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"created\": \"2022-02-24T11:56:52.056553Z\",\n \"modified\": \"2022-02-24T11:56:56.137194Z\",\n \"readable_id\": \"ART123\",\n \"is_removed\": false,\n \"readable_id_counter\": 123,\n \"file_hash\": \"bac137d6fd8aded1d0fa8f1d909ffc24\",\n \"file_type\": \"artifact\",\n \"file_size\": 414164,\n \"can_delete\": true,\n \"parent_readable_id\": \"VUL108\",\n \"parent_component\": \"vulnerability\",\n \"parent_unique_id\": \"0fda4848-29a3-4a00-bcbc-5fbf820b9b8d\"\n}"}],"_postman_id":"6908b573-e23f-48a3-ab09-36545deda226"}],"id":"5cfe0f14-6a73-4afd-98a4-99d68e9e5d3c","description":"

Vulnerabilities are security weaknesses in software and systems that can be exploited by threat actors and cause threat to confidentiality, integrity, and availability of data.

This section describes how to use the API endpoints to manage the vulnerabilities.

\n","_postman_id":"5cfe0f14-6a73-4afd-98a4-99d68e9e5d3c"},{"name":"Activity Logs","item":[{"name":"Get All Activity Logs","id":"93810efd-2383-4916-87f3-2853fc9a4568","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/activity-log/user-activity-logs/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&action&component×tamp_gte×tamp_lte&user","description":"

Get User Activity Logs

Retrieves a list of user activity logs from Respond.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

Parameter	Type	Description
`tenant_id`	String	Returns the unique identifier of the tenant in UUID format.
`user`	String	Returns the username who triggered the activity.
`action`	String	Returns the type of action performed. For example, `CREATE`, `UPDATE`
`object_ctype`	Integer	Returns the type or model identifier for the primary object associated with the activity.
`object_id`	String	Returns the unique identifier of the primary object on which the action was performed.
`object_display_name`	String	Returns the human‑readable name or label of the object.
`first_name`	String	Returns the first name of the user associated with the activity.
`last_name`	String	Returns the last name of the user associated with the activity log.
`component_display_name`	String	Returns the display name of the module where the activity occurred. For example, `Open API`, `Form Management`, `PIR`.
`object_type`	String	Returns the type of the object For example, `openapi`, `form-tabs`, `ctix-configuration`, `pir`
`created`	String	Returns the timestamp indicating when the activity was performed, in ISO format with timezone.
`timestamp`	Integer	Returns the Unix timestamp (seconds) representing the time of the activity log.
`timestamp_ms`	Integer	Returns the Unix timestamp including milliseconds representing the time of the activity log.
`user_profile_backgroup_color`	String	Returns the Hex color code of the user profile background.
`user_display_pic`	String	Returns the display pic of the user who performed the activity.
`sentence_html`	String	Returns the HTML text describing the activity log in a human‑readable sentence format.
`sub_object_id`	String	null
`sub_object_display_name`	String	null
`old_field_values`	String	Returns the previous value of the field.
`new_field_values`	String	Returns the updated value of the field.
`field_format`	String	Returns the format of the field. For example, text
`field_type`	String	Returns the field type. For example, text
`old_values_display_key`	String	Returns the key displayed for the previous value.
`new_values_display_key`	String	Returns the key displayed for the new value.

QUERY PARAMS

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`AccessID`	`{{open_api_access_id}}`.
`Expires`	{{expires}}
`Signature`	{{signature}}
`action`	[optional] Enter the unique key of the action to filter activity logs.
`component`	[optional] Enter the unique key of the component to filter activity logs.
`timestamp_gte`	[optional] Pass the time of the activity log to filter them. Time Zone must be as per UTC. All activity logs with creation date later than the entered time will be returned.
`timestamp_lte`	[optional] Enter the time of the activity log in EPOCH Time format. Time Zone must be as per UTC. All activity logs with creation date earlier than the entered time will be returned.
`user`	[optional] Enter the unique ID of the user to filter activity logs.

\n","urlObject":{"path":["activity-log","user-activity-logs",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"description":{"content":"

[optional] Enter the unique key of the action to filter activity logs.

\n","type":"text/plain"},"key":"action","value":""},{"description":{"content":"

[optional] Enter the unique key of the component to filter activity logs.

\n","type":"text/plain"},"key":"component","value":""},{"description":{"content":"

[optional] Enter the creation time of the activity log in EPOCH Time format.\nTime Zone must be as per UTC. All activity logs with creation date later than the entered time will be returned.

\n","type":"text/plain"},"key":"timestamp_gte","value":""},{"description":{"content":"

[optional] Enter the creation time of the activity log in EPOCH Time format.\nTime Zone must be as per UTC. All activity logs with creation date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"timestamp_lte","value":""},{"description":{"content":"

[optional] Enter the unique ID of the user to filter activity logs.

\n","type":"text/plain"},"key":"user","value":""}],"variable":[]}},"response":[{"id":"b21b236c-ffe6-4910-8d0f-8964a0d45188","name":"Get All Activity Logs","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/activity-log/user-activity-logs/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["activity-log","user-activity-logs",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"action","value":null,"description":"[optional] Enter the unique key of the action to filter activity logs.","disabled":true},{"key":"component","value":null,"description":"[optional] Enter the unique key of the component to filter activity logs.","disabled":true},{"key":"timestamp_gte","value":null,"description":"[optional] Enter the creation time of the activity log in EPOCH Time format.\nTime Zone must be as per UTC. All activity logs with creation date later than the entered time will be returned.","disabled":true},{"key":"timestamp_lte","value":null,"description":"[optional] Enter the creation time of the activity log in EPOCH Time format.\nTime Zone must be as per UTC. All activity logs with creation date earlier than the entered time will be returned.","disabled":true},{"key":"user","value":null,"description":"[optional] Enter the unique ID of the user to filter activity logs.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Thu, 05 Feb 2026 09:23:54 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET"},{"key":"Vary","value":"origin, Cookie"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"Content-Security-Policy","value":"img-src https: http: data: blob:;"},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"tenant_id\": \"c8233066-4024-4805-b9b0-eebfd5d24865\",\n \"user\": \"john.doe\",\n \"action\": \"CREATE\",\n \"object_ctype\": 101,\n \"object_id\": \"311ce937-8ca9-445b-8339-d3abe793a0e4\",\n \"object_display_name\": \"Doc test\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"component_display_name\": \"Open API\",\n \"object_type\": \"openapi\",\n \"created\": \"2026-02-05T09:22:37.128952+00:00\",\n \"timestamp\": 1770283357,\n \"timestamp_ms\": 1770283357.1289608,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"sentence_html\": \"@system.default created OpenAPI Doc test\"\n },\n {\n \"tenant_id\": \"c8233066-4024-4805-b9b0-eebfd5d24865\",\n \"user\": \"Sree\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 17,\n \"object_id\": \"21a109b1-a4c5-4edb-a9f7-53babfe5d41f\",\n \"new_field_values\": \"Asia/Calcutta\",\n \"object_display_name\": \"John\",\n \"first_name\": \"john\",\n \"last_name\": \"doe\",\n \"object_type\": \"ciims-user\",\n \"sub_object_id\": \"browser_timezone\",\n \"sub_object_display_name\": \"Browser Time Zone\",\n \"component_display_name\": \"User Management\",\n \"created\": \"2026-02-05T07:10:13.310621+00:00\",\n \"timestamp\": 1770275413,\n \"timestamp_ms\": 1770275413.3106294,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_field_values\": \"None\",\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@Sree updated Browser Time Zone for User Sree\"\n }\n \"component_display_name\": \"Incident\",\n \"object_type\": \"incident\",\n \"created\": \"2026-02-04T11:17:08.678606+00:00\",\n \"timestamp\": 1770203828,\n \"timestamp_ms\": 1770203828.6786149,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"sentence_html\": \"@system.default created Incident (INC102) [1, 2] through #PLB557(RL-01KGM5XEPDWR71DQMWM6ERWCKE)\"\n }\n]"}],"_postman_id":"93810efd-2383-4916-87f3-2853fc9a4568"},{"name":"Get API Request Logs","id":"0aac87f3-a062-429a-b132-66ac6998eeda","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/v1/utils/request-log/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Get API Request Logs

Retrieves API request logs for your tenant, including details about each request and response for monitoring, debugging, and audit purposes.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	object	Returns the following two keys: `previous` and `next` `previous` key shows the API endpoint to the previous page. `next` shows the API endpoint to the next page.
`next`	string	Returns the URL link to the next page.
`count`	integer	Returns the total number of API request log records matching the current query (across all pages).
`results`	array of objects	Returns a list of request logs for the current page. Each item represents a single API request processed by the system.

Response Parameters | Results Object

Parameter	Type	Description
`request_log_id`	string	Returns the unique identifier for the request log record.
`tenant_id`	string (UUID)	Returns Identifier of the tenant (organization) under which this request was executed.
`server_url`	string	Returns the base URL of the instance that processed the request.
`user_id`	string	Returns the unique identifier of the user associated with the API request.
`username`	string	Username of the user who initiated the API request. For example, john.doe
`user_ip_address`	string	Returns IP address of the user from which the request originated.
`request_method`	string	HTTP method of the request. For example, `GET`, `POST`
`request_full_path`	string	Returns the full URL of the request including scheme, host, path, and query string.
`request_timestamp`	number (float)	Returns request time represented in Unix timestamp.
`request_timestamp_readable`	string	Returns human‑readable representation of the request timestamp For example, `YYYY-MM-DD HH:MM:SS +0000`).
`response_timestamp`	number (float)	Returns the time when the response was generated in Unix timestamp.
`response_timestamp_readable`	string	Returns human‑readable representation of the response timestamp.
`response_status_code`	integer	Returns the HTTP status code returned for this request For example, `200`, `400`, `500`
`user_agent`	string	Returns the user‑agent header sent by the client
`request_path`	string	Returns the URL path of the request.
`request_query_path`	string	Returns the path including query string of the URL.
`error_response_data`	object	Returns any errors that occurred.
`transaction_id`	string (UUID)	Returns ID used for tracing this request across services and logs.
`error_traceback`	string	null
`log_type`	string	Returns the outcome of the request. For example, `SUCCESS`
`duration`	number (float)	Returns the time taken to process the request in seconds.
`query_params_text`	string	Returns the URL‑encoded representation of the query parameters sent with the request.

QUERY PARAMS

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
`AccessID`	{{open_api_access_id}}
`Expires`	{{expires}}
`Signature`	{{signature}}
`page`	[Optional] Pass the page number to retrieve the list of API request logs. Default value: 1
`page_size`	[optional] Pass the number of items to retrieve per page. Default value: 10
`request_method`	[optional] Pass the request method to filter the API request logs. For example, PUT, POST, GET, DELETE
`response_status_code`	[optional] Pass the status codes to filter the API request logs. For example, 200, 201, 400 , 403 ,404.
`request_timestamp__gte`	[optional] Enter the request time of the API request log in EPOCH Time format. All activity logs with request time greater than the entered time will be returned.
`request_timestamp__lte`	[optional] Enter the request time of the API request log in EPOCH Time format. All activity logs with request time lesser than the entered time will be returned.
`username`	[optional] Pass the username to filter API request logs.

","urlObject":{"path":["v1","utils","request-log",""],"host":["{{base_url}}"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"disabled":true,"description":{"content":"

[string] [optional] Enter the module name to retrieve the activity logs of a specific module. For example, incident,action,malware, and so on.

\n","type":"text/plain"},"key":"component","value":"action"},{"disabled":true,"description":{"content":"

[string] [optional] Enter the username to retrieve the activity logs of a specific user.

\n","type":"text/plain"},"key":"user","value":"pooja_b"}],"variable":[]}},"response":[{"id":"a7528216-4a1d-460d-9a7c-3ed3d1b0941c","name":"Get API Request Logs","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/v1/utils/request-log/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&page&page_size&request_method&response_status_code&request_timestamp__gte&request_timestamp__lte&username","host":["{{base_url}}"],"path":["v1","utils","request-log",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"page","value":null},{"key":"page_size","value":null},{"key":"request_method","value":null},{"key":"response_status_code","value":null},{"key":"request_timestamp__gte","value":null},{"key":"request_timestamp__lte","value":null},{"key":"username","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Thu, 05 Feb 2026 09:40:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET"},{"key":"Vary","value":"origin, Cookie"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"Content-Security-Policy","value":"img-src https: http: data: blob:;"},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {\n \"next\": \"openapi/v1/utils/request-log/?page=2&page_size=10&AccessID=286906ab-c717-40db-86b0-ff23cf50afab&Expires=1770284445&Signature=q0RM6MpjDfK+eqTTsrHvRz88QkM=\"\n },\n \"count\": 2034,\n \"results\": [\n {\n \"request_log_id\": \"NLQpLZwBHQm096UGqFL9\",\n \"tenant_id\": \"c8233066-4024-4805-b9b0-eebfd5d24865\",\n \"server_url\": \"https://3479.cftr.spotio.cywaredev.com/cftrapi/\",\n \"user_id\": \"92b31347-b184-442c-adcf-b43f04d2e496\",\n \"username\": \"system.default\",\n \"user_ip_address\": \"182.71.120.154\",\n \"request_method\": \"GET\",\n \"request_full_path\": \"https://3479.cftr.spotio.cywaredev.com/cftrapi/utils/sse/validate/?token=CYW+k8FUO1zn0oL%2BK0YJLkrTYJEy3ANq8v6usqILC57Zwga2t7WcPNboYreWgEaoS%2BcJi%2BHuzIc7YZeNbfHDUBkVetHW%2Bs6exXkyT1u%2BLGyQCLQOHdNsgAFAA4XPnAT0nnjVfJksZCy5Ip9st3%2BjyqNKLdU6s%2FrYyPFC3AL%2F0s5%2BTCLWk3KwFDVTlpKdrJf4qUra3yDWhL2FECyJ1s6InN4j6NTCgCO7D9qaLvfYhnqE4UP20EFPE99Ot7sPyiuO0udI\",\n \"request_timestamp\": 1770284230.893854,\n \"request_timestamp_readable\": \"2026-02-05 09:37:10 +0000\",\n \"response_timestamp\": 1770284230.904359,\n \"response_timestamp_readable\": \"2026-02-05 09:37:10 +0000\",\n \"response_status_code\": 200,\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/144.0.0.0 Safari/537.36\",\n \"request_path\": \"/utils/sse/validate/?token=CYW+k8FUO1zn0oL%2BK0YJLkrTYJEy3ANq8v6usqILC57Zwga2t7WcPNboYreWgEaoS%2BcJi%2BHuzIc7YZeNbfHDUBkVetHW%2Bs6exXkyT1u%2BLGyQCLQOHdNsgAFAA4XPnAT0nnjVfJksZCy5Ip9st3%2BjyqNKLdU6s%2FrYyPFC3AL%2F0s5%2BTCLWk3KwFDVTlpKdrJf4qUra3yDWhL2FECyJ1s6InN4j6NTCgCO7D9qaLvfYhnqE4UP20EFPE99Ot7sPyiuO0udI\",\n \"request_query_path\": \"/utils/sse/validate/?token=CYW+k8FUO1zn0oL%2BK0YJLkrTYJEy3ANq8v6usqILC57Zwga2t7WcPNboYreWgEaoS%2BcJi%2BHuzIc7YZeNbfHDUBkVetHW%2Bs6exXkyT1u%2BLGyQCLQOHdNsgAFAA4XPnAT0nnjVfJksZCy5Ip9st3%2BjyqNKLdU6s%2FrYyPFC3AL%2F0s5%2BTCLWk3KwFDVTlpKdrJf4qUra3yDWhL2FECyJ1s6InN4j6NTCgCO7D9qaLvfYhnqE4UP20EFPE99Ot7sPyiuO0udI\",\n \"error_response_data\": null,\n \"transaction_id\": \"a963cfa7-4034-42c7-a907-a810a6a26f05\",\n \"error_traceback\": null,\n \"log_type\": \"SUCCESS\",\n \"duration\": 0.010505199432373047,\n \"query_params_text\": \"token=CYW+k8FUO1zn0oL%2BK0YJLkrTYJEy3ANq8v6usqILC57Zwga2t7WcPNboYreWgEaoS%2BcJi%2BHuzIc7YZeNbfHDUBkVetHW%2Bs6exXkyT1u%2BLGyQCLQOHdNsgAFAA4XPnAT0nnjVfJksZCy5Ip9st3%2BjyqNKLdU6s%2FrYyPFC3AL%2F0s5%2BTCLWk3KwFDVTlpKdrJf4qUra3yDWhL2FECyJ1s6InN4j6NTCgCO7D9qaLvfYhnqE4UP20EFPE99Ot7sPyiuO0udI\"\n },\n {\n \"request_log_id\": \"M7QpLZwBHQm096UGQFKr\",\n \"tenant_id\": \"c8233066-4024-4805-b9b0-eebfd5d24865\",\n \"server_url\": \"https://3479.cftr.spotio.cywaredev.com/cftrapi/\",\n \"user_id\": \"21a109b1-a4c5-4edb-a9f7-53babfe5d41f\",\n \"username\": \"Sree\",\n \"user_ip_address\": \"182.71.120.154\",\n \"request_method\": \"GET\",\n \"request_full_path\": \"https://3479.cftr.spotio.cywaredev.com/cftrapi/utils/sse/validate/?token=CYW+%2FPBrBh85yFr%2F2G1%2BWI%2FsYXoX5MrpL1b0fl2CnXxI0pzyiJOWxThymh5yREsaMlceGd87r2UPWIbD346KO6El8wQYzgMhaZ%2BpUPbM1Hc4MJjkp72d7xOdPXZJCBJm1N94%2FyEi8tT7tCwrFXmcSXUH3%2BtT708%2F8MDRekhFAN%2BWOjCUUccyE%2FnWQN1HvHBp04QxbRXMJHyM7uq0wW6cMAbYL4%2BJaXhseeSR9OAjpdUVgwPd6mDc8K276vExCfqEzoSf\",\n \"request_timestamp\": 1770284204.187848,\n \"request_timestamp_readable\": \"2026-02-05 09:36:44 +0000\",\n \"response_timestamp\": 1770284204.199006,\n \"response_timestamp_readable\": \"2026-02-05 09:36:44 +0000\",\n \"response_status_code\": 200,\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/144.0.0.0 Safari/537.36\",\n \"request_path\": \"/utils/sse/validate/?token=CYW+%2FPBrBh85yFr%2F2G1%2BWI%2FsYXoX5MrpL1b0fl2CnXxI0pzyiJOWxThymh5yREsaMlceGd87r2UPWIbD346KO6El8wQYzgMhaZ%2BpUPbM1Hc4MJjkp72d7xOdPXZJCBJm1N94%2FyEi8tT7tCwrFXmcSXUH3%2BtT708%2F8MDRekhFAN%2BWOjCUUccyE%2FnWQN1HvHBp04QxbRXMJHyM7uq0wW6cMAbYL4%2BJaXhseeSR9OAjpdUVgwPd6mDc8K276vExCfqEzoSf\",\n \"request_query_path\": \"/utils/sse/validate/?token=CYW+%2FPBrBh85yFr%2F2G1%2BWI%2FsYXoX5MrpL1b0fl2CnXxI0pzyiJOWxThymh5yREsaMlceGd87r2UPWIbD346KO6El8wQYzgMhaZ%2BpUPbM1Hc4MJjkp72d7xOdPXZJCBJm1N94%2FyEi8tT7tCwrFXmcSXUH3%2BtT708%2F8MDRekhFAN%2BWOjCUUccyE%2FnWQN1HvHBp04QxbRXMJHyM7uq0wW6cMAbYL4%2BJaXhseeSR9OAjpdUVgwPd6mDc8K276vExCfqEzoSf\",\n \"error_response_data\": null,\n \"transaction_id\": \"2f7e73dd-0315-466f-a34c-f4e6cbd1e616\",\n \"error_traceback\": null,\n \"log_type\": \"SUCCESS\",\n \"duration\": 0.011157989501953125,\n \"query_params_text\": \"token=CYW+%2FPBrBh85yFr%2F2G1%2BWI%2FsYXoX5MrpL1b0fl2CnXxI0pzyiJOWxThymh5yREsaMlceGd87r2UPWIbD346KO6El8wQYzgMhaZ%2BpUPbM1Hc4MJjkp72d7xOdPXZJCBJm1N94%2FyEi8tT7tCwrFXmcSXUH3%2BtT708%2F8MDRekhFAN%2BWOjCUUccyE%2FnWQN1HvHBp04QxbRXMJHyM7uq0wW6cMAbYL4%2BJaXhseeSR9OAjpdUVgwPd6mDc8K276vExCfqEzoSf\"\n },\n {\n \"request_log_id\": \"MrQlLZwBHQm096UGB1L-\",\n \"tenant_id\": \"c8233066-4024-4805-b9b0-eebfd5d24865\",\n \"server_url\": \"https://3479.cftr.spotio.cywaredev.com/cftrapi/\",\n \"user_id\": \"92b31347-b184-442c-adcf-b43f04d2e496\",\n \"username\": \"system.default\",\n \"user_ip_address\": \"182.71.120.154\",\n \"request_method\": \"GET\",\n \"request_full_path\": \"https://3479.cftr.spotio.cywaredev.com/cftrapi/utils/sse/validate/?token=CYW+k8FUO1zn0oL%2BK0YJLkrTYJEy3ANq8v6usqILC57Zwga2t7WcPNboYreWgEaoS%2BcJi%2BHuzIc7YZeNbfHDUBkVetHW%2Bs6exXkyT1u%2BLGyQCLQOHdNsgAFAA4XPnAT0nnjVfJksZCy5Ip9st3%2BjyqNKLdU6s%2FrYyPFC3AL%2F0s5%2BTCLWk3KwFDVTlpKdrJf4qUra3yDWhL2FECyJ1s6InN4j6NTCgCO7D9qaLvfYhnqE4UP20EFPE99Ot7sPyiuO0udI\",\n \"request_timestamp\": 1770283927.536683,\n \"request_timestamp_readable\": \"2026-02-05 09:32:07 +0000\",\n \"response_timestamp\": 1770283927.54514,\n \"response_timestamp_readable\": \"2026-02-05 09:32:07 +0000\",\n \"response_status_code\": 200,\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/144.0.0.0 Safari/537.36\",\n \"request_path\": \"/utils/sse/validate/?token=CYW+k8FUO1zn0oL%2BK0YJLkrTYJEy3ANq8v6usqILC57Zwga2t7WcPNboYreWgEaoS%2BcJi%2BHuzIc7YZeNbfHDUBkVetHW%2Bs6exXkyT1u%2BLGyQCLQOHdNsgAFAA4XPnAT0nnjVfJksZCy5Ip9st3%2BjyqNKLdU6s%2FrYyPFC3AL%2F0s5%2BTCLWk3KwFDVTlpKdrJf4qUra3yDWhL2FECyJ1s6InN4j6NTCgCO7D9qaLvfYhnqE4UP20EFPE99Ot7sPyiuO0udI\",\n \"request_query_path\": \"/utils/sse/validate/?token=CYW+k8FUO1zn0oL%2BK0YJLkrTYJEy3ANq8v6usqILC57Zwga2t7WcPNboYreWgEaoS%2BcJi%2BHuzIc7YZeNbfHDUBkVetHW%2Bs6exXkyT1u%2BLGyQCLQOHdNsgAFAA4XPnAT0nnjVfJksZCy5Ip9st3%2BjyqNKLdU6s%2FrYyPFC3AL%2F0s5%2BTCLWk3KwFDVTlpKdrJf4qUra3yDWhL2FECyJ1s6InN4j6NTCgCO7D9qaLvfYhnqE4UP20EFPE99Ot7sPyiuO0udI\",\n \"error_response_data\": null,\n \"transaction_id\": \"c2e007d0-e5f4-4e8d-a96b-3d62ccce5b56\",\n \"error_traceback\": null,\n \"log_type\": \"SUCCESS\",\n \"duration\": 0.008456945419311523,\n \"query_params_text\": \"token=CYW+k8FUO1zn0oL%2BK0YJLkrTYJEy3ANq8v6usqILC57Zwga2t7WcPNboYreWgEaoS%2BcJi%2BHuzIc7YZeNbfHDUBkVetHW%2Bs6exXkyT1u%2BLGyQCLQOHdNsgAFAA4XPnAT0nnjVfJksZCy5Ip9st3%2BjyqNKLdU6s%2FrYyPFC3AL%2F0s5%2BTCLWk3KwFDVTlpKdrJf4qUra3yDWhL2FECyJ1s6InN4j6NTCgCO7D9qaLvfYhnqE4UP20EFPE99Ot7sPyiuO0udI\"\n },\n {\n \"request_log_id\": \"MbQkLZwBHQm096UGn1KS\",\n \"tenant_id\": \"c8233066-4024-4805-b9b0-eebfd5d24865\",\n \"server_url\": \"https://3479.cftr.spotio.cywaredev.com/cftrapi/\",\n \"user_id\": \"21a109b1-a4c5-4edb-a9f7-53babfe5d41f\",\n \"username\": \"Sree\",\n \"user_ip_address\": \"182.71.120.154\",\n \"request_method\": \"GET\",\n \"request_full_path\": \"https://3479.cftr.spotio.cywaredev.com/cftrapi/utils/sse/validate/?token=CYW+%2FPBrBh85yFr%2F2G1%2BWI%2FsYXoX5MrpL1b0fl2CnXxI0pzyiJOWxThymh5yREsaMlceGd87r2UPWIbD346KO6El8wQYzgMhaZ%2BpUPbM1Hc4MJjkp72d7xOdPXZJCBJm1N94%2FyEi8tT7tCwrFXmcSXUH3%2BtT708%2F8MDRekhFAN%2BWOjCUUccyE%2FnWQN1HvHBp04QxbRXMJHyM7uq0wW6cMAbYL4%2BJaXhseeSR9OAjpdUVgwPd6mDc8K276vExCfqEzoSf\",\n \"request_timestamp\": 1770283900.803085,\n \"request_timestamp_readable\": \"2026-02-05 09:31:40 +0000\",\n \"response_timestamp\": 1770283900.813883,\n \"response_timestamp_readable\": \"2026-02-05 09:31:40 +0000\",\n \"response_status_code\": 200,\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/144.0.0.0 Safari/537.36\",\n \"request_path\": \"/utils/sse/validate/?token=CYW+%2FPBrBh85yFr%2F2G1%2BWI%2FsYXoX5MrpL1b0fl2CnXxI0pzyiJOWxThymh5yREsaMlceGd87r2UPWIbD346KO6El8wQYzgMhaZ%2BpUPbM1Hc4MJjkp72d7xOdPXZJCBJm1N94%2FyEi8tT7tCwrFXmcSXUH3%2BtT708%2F8MDRekhFAN%2BWOjCUUccyE%2FnWQN1HvHBp04QxbRXMJHyM7uq0wW6cMAbYL4%2BJaXhseeSR9OAjpdUVgwPd6mDc8K276vExCfqEzoSf\",\n \"request_query_path\": \"/utils/sse/validate/?token=CYW+%2FPBrBh85yFr%2F2G1%2BWI%2FsYXoX5MrpL1b0fl2CnXxI0pzyiJOWxThymh5yREsaMlceGd87r2UPWIbD346KO6El8wQYzgMhaZ%2BpUPbM1Hc4MJjkp72d7xOdPXZJCBJm1N94%2FyEi8tT7tCwrFXmcSXUH3%2BtT708%2F8MDRekhFAN%2BWOjCUUccyE%2FnWQN1HvHBp04QxbRXMJHyM7uq0wW6cMAbYL4%2BJaXhseeSR9OAjpdUVgwPd6mDc8K276vExCfqEzoSf\",\n \"error_response_data\": null,\n \"transaction_id\": \"8318344e-4cf2-4ebc-9050-43b4381dce2e\",\n \"error_traceback\": null,\n \"log_type\": \"SUCCESS\",\n \"duration\": 0.010797977447509766,\n \"query_params_text\": \"token=CYW+%2FPBrBh85yFr%2F2G1%2BWI%2FsYXoX5MrpL1b0fl2CnXxI0pzyiJOWxThymh5yREsaMlceGd87r2UPWIbD346KO6El8wQYzgMhaZ%2BpUPbM1Hc4MJjkp72d7xOdPXZJCBJm1N94%2FyEi8tT7tCwrFXmcSXUH3%2BtT708%2F8MDRekhFAN%2BWOjCUUccyE%2FnWQN1HvHBp04QxbRXMJHyM7uq0wW6cMAbYL4%2BJaXhseeSR9OAjpdUVgwPd6mDc8K276vExCfqEzoSf\"\n },\n {\n \"request_log_id\": \"MLQgLZwBHQm096UGZ1IL\",\n \"tenant_id\": \"c8233066-4024-4805-b9b0-eebfd5d24865\",\n \"server_url\": \"https://3479.cftr.spotio.cywaredev.com/cftrapi/\",\n \"user_id\": \"92b31347-b184-442c-adcf-b43f04d2e496\",\n \"username\": \"system.default\",\n \"user_ip_address\": \"182.71.120.154\",\n \"request_method\": \"GET\",\n \"request_full_path\": \"https://3479.cftr.spotio.cywaredev.com/cftrapi/utils/sse/validate/?token=CYW+k8FUO1zn0oL%2BK0YJLkrTYJEy3ANq8v6usqILC57Zwga2t7WcPNboYreWgEaoS%2BcJi%2BHuzIc7YZeNbfHDUBkVetHW%2Bs6exXkyT1u%2BLGyQCLQOHdNsgAFAA4XPnAT0nnjVfJksZCy5Ip9st3%2BjyqNKLdU6s%2FrYyPFC3AL%2F0s5%2BTCLWk3KwFDVTlpKdrJf4qUra3yDWhL2FECyJ1s6InN4j6NTCgCO7D9qaLvfYhnqE4UP20EFPE99Ot7sPyiuO0udI\",\n \"request_timestamp\": 1770283624.181961,\n \"request_timestamp_readable\": \"2026-02-05 09:27:04 +0000\",\n \"response_timestamp\": 1770283624.19811,\n \"response_timestamp_readable\": \"2026-02-05 09:27:04 +0000\",\n \"response_status_code\": 200,\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/144.0.0.0 Safari/537.36\",\n \"request_path\": \"/utils/sse/validate/?token=CYW+k8FUO1zn0oL%2BK0YJLkrTYJEy3ANq8v6usqILC57Zwga2t7WcPNboYreWgEaoS%2BcJi%2BHuzIc7YZeNbfHDUBkVetHW%2Bs6exXkyT1u%2BLGyQCLQOHdNsgAFAA4XPnAT0nnjVfJksZCy5Ip9st3%2BjyqNKLdU6s%2FrYyPFC3AL%2F0s5%2BTCLWk3KwFDVTlpKdrJf4qUra3yDWhL2FECyJ1s6InN4j6NTCgCO7D9qaLvfYhnqE4UP20EFPE99Ot7sPyiuO0udI\",\n \"request_query_path\": \"/utils/sse/validate/?token=CYW+k8FUO1zn0oL%2BK0YJLkrTYJEy3ANq8v6usqILC57Zwga2t7WcPNboYreWgEaoS%2BcJi%2BHuzIc7YZeNbfHDUBkVetHW%2Bs6exXkyT1u%2BLGyQCLQOHdNsgAFAA4XPnAT0nnjVfJksZCy5Ip9st3%2BjyqNKLdU6s%2FrYyPFC3AL%2F0s5%2BTCLWk3KwFDVTlpKdrJf4qUra3yDWhL2FECyJ1s6InN4j6NTCgCO7D9qaLvfYhnqE4UP20EFPE99Ot7sPyiuO0udI\",\n \"error_response_data\": null,\n \"transaction_id\": \"469ea835-b9c7-416e-8885-d0f0b577b939\",\n \"error_traceback\": null,\n \"log_type\": \"SUCCESS\",\n \"duration\": 0.016149044036865234,\n \"query_params_text\": \"token=CYW+k8FUO1zn0oL%2BK0YJLkrTYJEy3ANq8v6usqILC57Zwga2t7WcPNboYreWgEaoS%2BcJi%2BHuzIc7YZeNbfHDUBkVetHW%2Bs6exXkyT1u%2BLGyQCLQOHdNsgAFAA4XPnAT0nnjVfJksZCy5Ip9st3%2BjyqNKLdU6s%2FrYyPFC3AL%2F0s5%2BTCLWk3KwFDVTlpKdrJf4qUra3yDWhL2FECyJ1s6InN4j6NTCgCO7D9qaLvfYhnqE4UP20EFPE99Ot7sPyiuO0udI\"\n },\n {\n \"request_log_id\": \"L7QfLZwBHQm096UG-1L7\",\n \"tenant_id\": \"c8233066-4024-4805-b9b0-eebfd5d24865\",\n \"server_url\": \"https://3479.cftr.spotio.cywaredev.com/cftrapi/\",\n \"user_id\": \"21a109b1-a4c5-4edb-a9f7-53babfe5d41f\",\n \"username\": \"Sree\",\n \"user_ip_address\": \"182.71.120.154\",\n \"request_method\": \"GET\",\n \"request_full_path\": \"https://3479.cftr.spotio.cywaredev.com/cftrapi/utils/sse/validate/?token=CYW+%2FPBrBh85yFr%2F2G1%2BWI%2FsYXoX5MrpL1b0fl2CnXxI0pzyiJOWxThymh5yREsaMlceGd87r2UPWIbD346KO6El8wQYzgMhaZ%2BpUPbM1Hc4MJjkp72d7xOdPXZJCBJm1N94%2FyEi8tT7tCwrFXmcSXUH3%2BtT708%2F8MDRekhFAN%2BWOjCUUccyE%2FnWQN1HvHBp04QxbRXMJHyM7uq0wW6cMAbYL4%2BJaXhseeSR9OAjpdUVgwPd6mDc8K276vExCfqEzoSf\",\n \"request_timestamp\": 1770283596.765116,\n \"request_timestamp_readable\": \"2026-02-05 09:26:36 +0000\",\n \"response_timestamp\": 1770283596.778427,\n \"response_timestamp_readable\": \"2026-02-05 09:26:36 +0000\",\n \"response_status_code\": 200,\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/144.0.0.0 Safari/537.36\",\n \"request_path\": \"/utils/sse/validate/?token=CYW+%2FPBrBh85yFr%2F2G1%2BWI%2FsYXoX5MrpL1b0fl2CnXxI0pzyiJOWxThymh5yREsaMlceGd87r2UPWIbD346KO6El8wQYzgMhaZ%2BpUPbM1Hc4MJjkp72d7xOdPXZJCBJm1N94%2FyEi8tT7tCwrFXmcSXUH3%2BtT708%2F8MDRekhFAN%2BWOjCUUccyE%2FnWQN1HvHBp04QxbRXMJHyM7uq0wW6cMAbYL4%2BJaXhseeSR9OAjpdUVgwPd6mDc8K276vExCfqEzoSf\",\n \"request_query_path\": \"/utils/sse/validate/?token=CYW+%2FPBrBh85yFr%2F2G1%2BWI%2FsYXoX5MrpL1b0fl2CnXxI0pzyiJOWxThymh5yREsaMlceGd87r2UPWIbD346KO6El8wQYzgMhaZ%2BpUPbM1Hc4MJjkp72d7xOdPXZJCBJm1N94%2FyEi8tT7tCwrFXmcSXUH3%2BtT708%2F8MDRekhFAN%2BWOjCUUccyE%2FnWQN1HvHBp04QxbRXMJHyM7uq0wW6cMAbYL4%2BJaXhseeSR9OAjpdUVgwPd6mDc8K276vExCfqEzoSf\",\n \"error_response_data\": null,\n \"transaction_id\": \"c11e656a-2649-417d-b55e-d339e485cf21\",\n \"error_traceback\": null,\n \"log_type\": \"SUCCESS\",\n \"duration\": 0.013310909271240234,\n \"query_params_text\": \"token=CYW+%2FPBrBh85yFr%2F2G1%2BWI%2FsYXoX5MrpL1b0fl2CnXxI0pzyiJOWxThymh5yREsaMlceGd87r2UPWIbD346KO6El8wQYzgMhaZ%2BpUPbM1Hc4MJjkp72d7xOdPXZJCBJm1N94%2FyEi8tT7tCwrFXmcSXUH3%2BtT708%2F8MDRekhFAN%2BWOjCUUccyE%2FnWQN1HvHBp04QxbRXMJHyM7uq0wW6cMAbYL4%2BJaXhseeSR9OAjpdUVgwPd6mDc8K276vExCfqEzoSf\"\n },\n {\n \"request_log_id\": \"LrQdLZwBHQm096UGzVKr\",\n \"tenant_id\": \"c8233066-4024-4805-b9b0-eebfd5d24865\",\n \"server_url\": \"https://3479.cftr.spotio.cywaredev.com/cftrapi/\",\n \"user_id\": \"21a109b1-a4c5-4edb-a9f7-53babfe5d41f\",\n \"username\": \"Sree\",\n \"user_ip_address\": \"182.71.120.154\",\n \"request_method\": \"GET\",\n \"request_full_path\": \"https://3479.cftr.spotio.cywaredev.com/cftrapi/utils/sse/validate/?token=CYW+%2FPBrBh85yFr%2F2G1%2BWI%2FsYXoX5MrpL1b0fl2CnXxI0pzyiJOWxThymh5yREsaMlceGd87r2UPWIbD346KO6El8wQYzgMhaZ%2BpUPbM1Hc4MJjkp72d7xOdPXZJCBJm1N94%2FyEi8tT7tCwrFXmcSXUH3%2BtT708%2F8MDRekhFAN%2BWOjCUUccyE%2FnWQN1HvHBp04QxbRXMJHyM7uq0wW6cMAbYL4%2BJaXhseeSR9OAjpdUVgwPd6mDc8K276vExCfqEzoSf\",\n \"request_timestamp\": 1770283453.848644,\n \"request_timestamp_readable\": \"2026-02-05 09:24:13 +0000\",\n \"response_timestamp\": 1770283453.862178,\n \"response_timestamp_readable\": \"2026-02-05 09:24:13 +0000\",\n \"response_status_code\": 200,\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/144.0.0.0 Safari/537.36\",\n \"request_path\": \"/utils/sse/validate/?token=CYW+%2FPBrBh85yFr%2F2G1%2BWI%2FsYXoX5MrpL1b0fl2CnXxI0pzyiJOWxThymh5yREsaMlceGd87r2UPWIbD346KO6El8wQYzgMhaZ%2BpUPbM1Hc4MJjkp72d7xOdPXZJCBJm1N94%2FyEi8tT7tCwrFXmcSXUH3%2BtT708%2F8MDRekhFAN%2BWOjCUUccyE%2FnWQN1HvHBp04QxbRXMJHyM7uq0wW6cMAbYL4%2BJaXhseeSR9OAjpdUVgwPd6mDc8K276vExCfqEzoSf\",\n \"request_query_path\": \"/utils/sse/validate/?token=CYW+%2FPBrBh85yFr%2F2G1%2BWI%2FsYXoX5MrpL1b0fl2CnXxI0pzyiJOWxThymh5yREsaMlceGd87r2UPWIbD346KO6El8wQYzgMhaZ%2BpUPbM1Hc4MJjkp72d7xOdPXZJCBJm1N94%2FyEi8tT7tCwrFXmcSXUH3%2BtT708%2F8MDRekhFAN%2BWOjCUUccyE%2FnWQN1HvHBp04QxbRXMJHyM7uq0wW6cMAbYL4%2BJaXhseeSR9OAjpdUVgwPd6mDc8K276vExCfqEzoSf\",\n \"error_response_data\": null,\n \"transaction_id\": \"2bdafbc6-14ab-4c33-8133-cd346e103881\",\n \"error_traceback\": null,\n \"log_type\": \"SUCCESS\",\n \"duration\": 0.013534069061279297,\n \"query_params_text\": \"token=CYW+%2FPBrBh85yFr%2F2G1%2BWI%2FsYXoX5MrpL1b0fl2CnXxI0pzyiJOWxThymh5yREsaMlceGd87r2UPWIbD346KO6El8wQYzgMhaZ%2BpUPbM1Hc4MJjkp72d7xOdPXZJCBJm1N94%2FyEi8tT7tCwrFXmcSXUH3%2BtT708%2F8MDRekhFAN%2BWOjCUUccyE%2FnWQN1HvHBp04QxbRXMJHyM7uq0wW6cMAbYL4%2BJaXhseeSR9OAjpdUVgwPd6mDc8K276vExCfqEzoSf\"\n },\n {\n \"request_log_id\": \"LbQdLZwBHQm096UGgVJF\",\n \"tenant_id\": \"c8233066-4024-4805-b9b0-eebfd5d24865\",\n \"server_url\": \"https://3479.cftr.spotio.cywaredev.com/cftrapi/\",\n \"user_id\": \"92b31347-b184-442c-adcf-b43f04d2e496\",\n \"username\": \"system.default\",\n \"user_ip_address\": \"182.71.120.154\",\n \"request_method\": \"GET\",\n \"request_full_path\": \"https://3479.cftr.spotio.cywaredev.com/cftrapi/openapi/v1/activity-log/user-activity-logs/?AccessID=286906ab-c717-40db-86b0-ff23cf50afab&Expires=1770283449&Signature=F76r%2F%2BqmZidgqmw6IB5BRmB1Y3Y%3D\",\n \"request_timestamp\": 1770283434.235906,\n \"request_timestamp_readable\": \"2026-02-05 09:23:54 +0000\",\n \"response_timestamp\": 1770283434.304026,\n \"response_timestamp_readable\": \"2026-02-05 09:23:54 +0000\",\n \"response_status_code\": 200,\n \"user_agent\": \"PostmanRuntime/7.51.1\",\n \"request_path\": \"/openapi/v1/activity-log/user-activity-logs/?AccessID=286906ab-c717-40db-86b0-ff23cf50afab&Expires=1770283449&Signature=F76r%2F%2BqmZidgqmw6IB5BRmB1Y3Y%3D\",\n \"request_query_path\": \"/openapi/v1/activity-log/user-activity-logs/?AccessID=286906ab-c717-40db-86b0-ff23cf50afab&Expires=1770283449&Signature=F76r%2F%2BqmZidgqmw6IB5BRmB1Y3Y%3D\",\n \"error_response_data\": null,\n \"transaction_id\": \"e77d3ab9-b977-415b-80d5-49575e830529\",\n \"error_traceback\": null,\n \"log_type\": \"SUCCESS\",\n \"duration\": 0.06812000274658203,\n \"query_params_text\": \"AccessID=286906ab-c717-40db-86b0-ff23cf50afab&Expires=1770283449&Signature=F76r%2F%2BqmZidgqmw6IB5BRmB1Y3Y%3D\"\n },\n {\n \"request_log_id\": \"LLQcLZwBHQm096UG81L0\",\n \"tenant_id\": \"c8233066-4024-4805-b9b0-eebfd5d24865\",\n \"server_url\": \"https://3479.cftr.spotio.cywaredev.com/cftrapi/\",\n \"user_id\": \"92b31347-b184-442c-adcf-b43f04d2e496\",\n \"username\": \"system.default\",\n \"user_ip_address\": \"182.71.120.154\",\n \"request_method\": \"GET\",\n \"request_full_path\": \"https://3479.cftr.spotio.cywaredev.com/cftrapi/openapi/v1/activity-log/user-activity-logs/?AccessID=286906ab-c717-40db-86b0-ff23cf50afab&Expires=1770283410&Signature=yhHv09XVZupmLW8v4Ig42QCYBCA%3D&action&component×tamp_gte×tamp_lte&user\",\n \"request_timestamp\": 1770283397.140119,\n \"request_timestamp_readable\": \"2026-02-05 09:23:17 +0000\",\n \"response_timestamp\": 1770283398.127532,\n \"response_timestamp_readable\": \"2026-02-05 09:23:18 +0000\",\n \"response_status_code\": 200,\n \"user_agent\": \"PostmanRuntime/7.51.1\",\n \"request_path\": \"/openapi/v1/activity-log/user-activity-logs/?AccessID=286906ab-c717-40db-86b0-ff23cf50afab&Expires=1770283410&Signature=yhHv09XVZupmLW8v4Ig42QCYBCA%3D&action&component×tamp_gte×tamp_lte&user\",\n \"request_query_path\": \"/openapi/v1/activity-log/user-activity-logs/?AccessID=286906ab-c717-40db-86b0-ff23cf50afab&Expires=1770283410&Signature=yhHv09XVZupmLW8v4Ig42QCYBCA%3D&action&component×tamp_gte×tamp_lte&user\",\n \"error_response_data\": null,\n \"transaction_id\": \"a4213db5-bb85-4416-9cb1-b4f59a74b16b\",\n \"error_traceback\": null,\n \"log_type\": \"SUCCESS\",\n \"duration\": 0.9874129295349121,\n \"query_params_text\": \"AccessID=286906ab-c717-40db-86b0-ff23cf50afab&Expires=1770283410&Signature=yhHv09XVZupmLW8v4Ig42QCYBCA%3D&action&component×tamp_gte×tamp_lte&user\"\n },\n {\n \"request_log_id\": \"K7QcLZwBHQm096UGU1Le\",\n \"tenant_id\": \"c8233066-4024-4805-b9b0-eebfd5d24865\",\n \"server_url\": \"https://3479.cftr.spotio.cywaredev.com/cftrapi/\",\n \"user_id\": \"92b31347-b184-442c-adcf-b43f04d2e496\",\n \"username\": \"system.default\",\n \"user_ip_address\": \"182.71.120.154\",\n \"request_method\": \"POST\",\n \"request_full_path\": \"https://3479.cftr.spotio.cywaredev.com/cftrapi/openapi/credentials/\",\n \"request_timestamp\": 1770283357.066403,\n \"request_timestamp_readable\": \"2026-02-05 09:22:37 +0000\",\n \"response_timestamp\": 1770283357.146323,\n \"response_timestamp_readable\": \"2026-02-05 09:22:37 +0000\",\n \"response_status_code\": 201,\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/144.0.0.0 Safari/537.36\",\n \"request_path\": \"/openapi/credentials/\",\n \"request_query_path\": \"/openapi/credentials/\",\n \"error_response_data\": null,\n \"transaction_id\": \"cf4f764a-64e9-49de-8c10-a0af372f7775\",\n \"error_traceback\": null,\n \"log_type\": \"SUCCESS\",\n \"duration\": 0.07992005348205566,\n \"query_params_text\": \"\"\n }\n ]\n}"}],"_postman_id":"0aac87f3-a062-429a-b132-66ac6998eeda"},{"name":"Get Activity Logs","id":"88faff69-c50e-4834-a083-b1285b0831ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/activity-log/:component_identifier/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the activity logs of a component.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

Parameter	Type	Description
`tenant_id`	String	Unique ID of the tenant.
`user`	String	`username` of the user who performed the activity.
`action`	String	Action performed in the activity. Examples: - `CREATE` - `UPDATE` - `DELETE` - `COMMENT` - `UPLOAD`
`object_id`	String	Unique ID of the updated record.
`old_field_values`	String	Previous value of the updated field.
`new_field_values`	String	Updated value of the field.
`object_display_name`	String	Title of the updated record.
`first_name`	String	`first_name` of the user who performed the activity.
`last_name`	String	`last_name` of the user who performed the activity.
`sub_object_id`	String	`unique_id` or `readable_id` of the updated field.
`sub_object_display_name`	String	`name` of the updated field.
`field_format`	String	Format of the updated field. Allowed values: - `calendar`: DateTime fields - `text`: Text fields
`field_type`	String	Type of the updated field. Allowed values: - `text` - `integer` - `calendar` - `textarea` - `select` - `multiselect`
`object_type`	String	Component identifier of the updated component type.
`created`	String	Activity time in ISO format.
`timestamp`	Integer	Activity time in EPOCH format.
`sentence_html`	Text	Description of the activity in HTML format.
`user_profile_backgroup_color`	String	Hex key of the background color of the user profile.
`user_display_pic`	String	The link to the display picture of the user.

","urlObject":{"path":["activity-log",":component_identifier",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"disabled":true,"description":{"content":"

[optional] Enter the unique key of the action to be filtered.

\n","type":"text/plain"},"key":"action","value":"create__CREATE"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the activity log in EPOCH Time format.\nTime Zone must be as per UTC. All activity logs with creation date later than the entered time will be returned.

\n","type":"text/plain"},"key":"timestamp__gte","value":"1644345000"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the activity log in EPOCH Time format.\nTime Zone must be as per UTC. All activity logs with creation date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"timestamp__lte","value":"1644604199"}],"variable":[{"description":{"content":"

Enter the component identifier for which the activity logs are requested. Allowed values:

incident: Incident
\n
action: Action
\n
device: Device
\n
malware: Malware
\n
enhancement: Enhancement
\n
application: Application
\n
asset-sofware: Asset Software
\n
general-user: General User
\n
campaign: Campaign
\n
vulnerability: Vulnerability
\n
threat-actor: Threat Actor
\n
document: Knowledge Base
\n
threat-briefing: Threat Briefing
\n
pir: PIR
\n
ioc-type: Indicator Type
\n
ioc: Threat Intel
\n
Admin Panel
\n
openapi: Open APIs
\n
ciims-user: User Management
\n
user-group: User Group Management
\n
incident-sla: Incident SLA
\n
action-sla: Action SLA
\n
escalation-level-users: Escalation User
\n
roster: Roster
\n
shift-model: Shift
\n
custom-email-templates: Email Customization
\n
tenant_configuration: Tenant Management\nTemplate Management
\n
component-export-templates: Export Template
\n
merge-incident-templates: Merge Template\nSettings
\n
- location: Location
- business-unit: Business Units
- source-type: Source Type
- label: Label
- ostypes: OSType
- manufacturers: Manufacturer\nConfigurations
- incident-configuration: Incident Configuration
- backup-configuration: Data Policy
- csol-configuration: Cyware Orchestrate Integration\n Authentication\n- user-pass/config/auth: User-Password Authentication\n- ldap/config/auth: LDAP Authentication\n- saml/config/auth: SAML Authentication
\n

\n","type":"text/plain"},"type":"any","value":"incident","key":"component_identifier"}]}},"response":[{"id":"c73b7780-b79b-462f-a4a2-6d129ff2d7df","name":"Get Incident Activity Logs","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/activity-log/incident/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["activity-log","incident",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Thu, 24 Feb 2022 14:43:59 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"10066","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"[\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 8,\n \"object_id\": \"c2a76a82-0f65-41e6-a3df-e54585aa775a\",\n \"old_field_values\": \"closed\",\n \"new_field_values\": \"open\",\n \"object_display_name\": \"(INC591) update openapi incident\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"status\",\n \"sub_object_display_name\": \"status\",\n \"field_format\": \"text\",\n \"field_type\": \"text\",\n \"object_type\": \"incident\",\n \"created\": \"2022-02-24T09:45:13.843372+00:00\",\n \"timestamp\": 1645695913,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated status for Incident (INC591) update openapi incident\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 8,\n \"object_id\": \"c2a76a82-0f65-41e6-a3df-e54585aa775a\",\n \"old_field_values\": \"open\",\n \"new_field_values\": \"closed\",\n \"object_display_name\": \"(INC591) update openapi incident\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"status\",\n \"sub_object_display_name\": \"status\",\n \"field_format\": \"text\",\n \"field_type\": \"text\",\n \"object_type\": \"incident\",\n \"created\": \"2022-02-24T09:42:44.164339+00:00\",\n \"timestamp\": 1645695764,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated status for Incident (INC591) update openapi incident\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"COMMENT\",\n \"object_ctype\": 8,\n \"object_id\": \"c2a76a82-0f65-41e6-a3df-e54585aa775a\",\n \"new_field_values\": \"

\",\n \"object_display_name\": \"(INC591) update openapi incident\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"object_type\": \"incident\",\n \"sub_object_ctype\": 78,\n \"sub_object_id\": \"e9b85446-ed9a-44a1-a3ba-d72ddd3ec471\",\n \"sub_object_display_name\": \"comment\",\n \"sub_object_type\": \"comment\",\n \"created\": \"2022-02-24T09:42:43.646359+00:00\",\n \"timestamp\": 1645695763,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_field_values\": \"None\",\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane commented on Incidents (INC591) update openapi incident\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 8,\n \"object_id\": \"c2a76a82-0f65-41e6-a3df-e54585aa775a\",\n \"new_field_values\": \"o2\",\n \"object_display_name\": \"(INC591) update openapi incident\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"9f57b5c3-5caf-42ac-9c87-0bdd93aac1bc\",\n \"sub_object_display_name\": \"test field - edited\",\n \"field_format\": \"text\",\n \"field_type\": \"select\",\n \"object_type\": \"incident\",\n \"created\": \"2022-02-24T09:42:36.730057+00:00\",\n \"timestamp\": 1645695756,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_field_values\": \"None\",\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated test field - edited for Incident (INC591) update openapi incident\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 8,\n \"object_id\": \"fd7f9ac2-8e3c-41a4-8412-98e62e2078bb\",\n \"new_field_values\": [\n \"example@example.com\"\n ],\n \"object_display_name\": \"(INC483) Inc 3\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"d9fcf8a9-8aa5-4e8f-8a9f-5c0ac90ed3d0\",\n \"sub_object_display_name\": \"Email\",\n \"field_format\": \"text\",\n \"field_type\": \"multiselect\",\n \"object_type\": \"incident\",\n \"created\": \"2022-02-23T11:49:05.099508+00:00\",\n \"timestamp\": 1645616945,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_field_values\": \"None\",\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated Email for Incident (INC483) Inc 3\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 8,\n \"object_id\": \"fd7f9ac2-8e3c-41a4-8412-98e62e2078bb\",\n \"old_field_values\": [\n \"www.example.com\"\n ],\n \"new_field_values\": [\n \"www.example.com\",\n \"www.example.com\"\n ],\n \"object_display_name\": \"(INC483) Inc 3\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"2a8c5e6c-919b-4d70-b473-6aff7a4cdd90\",\n \"sub_object_display_name\": \"Domain\",\n \"field_format\": \"text\",\n \"field_type\": \"multiselect\",\n \"object_type\": \"incident\",\n \"created\": \"2022-02-23T11:47:37.569357+00:00\",\n \"timestamp\": 1645616857,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated Domain for Incident (INC483) Inc 3\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 8,\n \"object_id\": \"fd7f9ac2-8e3c-41a4-8412-98e62e2078bb\",\n \"old_field_values\": [\n \"2.2.2.2\",\n \"3.3.3.3\"\n ],\n \"new_field_values\": [\n \"3.3.3.3\"\n ],\n \"object_display_name\": \"(INC483) Inc 3\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"b8986c14-b50c-43c6-a0c7-69eab40cb7a5\",\n \"sub_object_display_name\": \"IP\",\n \"field_format\": \"text\",\n \"field_type\": \"multiselect\",\n \"object_type\": \"incident\",\n \"created\": \"2022-02-23T11:47:02.940962+00:00\",\n \"timestamp\": 1645616822,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated IP for Incident (INC483) Inc 3\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 8,\n \"object_id\": \"fd7f9ac2-8e3c-41a4-8412-98e62e2078bb\",\n \"new_field_values\": [\n \"www.example.com\"\n ],\n \"object_display_name\": \"(INC483) Inc 3\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"2a8c5e6c-919b-4d70-b473-6aff7a4cdd90\",\n \"sub_object_display_name\": \"Domain\",\n \"field_format\": \"text\",\n \"field_type\": \"multiselect\",\n \"object_type\": \"incident\",\n \"created\": \"2022-02-23T11:46:47.277921+00:00\",\n \"timestamp\": 1645616807,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_field_values\": \"None\",\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated Domain for Incident (INC483) Inc 3\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 8,\n \"object_id\": \"fd7f9ac2-8e3c-41a4-8412-98e62e2078bb\",\n \"old_field_values\": [\n \"2.2.2.2\",\n \"1.1.1.1\"\n ],\n \"new_field_values\": [\n \"2.2.2.2\",\n \"3.3.3.3\"\n ],\n \"object_display_name\": \"(INC483) Inc 3\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"b8986c14-b50c-43c6-a0c7-69eab40cb7a5\",\n \"sub_object_display_name\": \"IP\",\n \"field_format\": \"text\",\n \"field_type\": \"multiselect\",\n \"object_type\": \"incident\",\n \"created\": \"2022-02-23T11:45:33.355950+00:00\",\n \"timestamp\": 1645616733,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated IP for Incident (INC483) Inc 3\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 8,\n \"object_id\": \"fd7f9ac2-8e3c-41a4-8412-98e62e2078bb\",\n \"old_field_values\": [\n \"Initial Access-Phishing\"\n ],\n \"new_field_values\": [\n \"Initial Access-Phishing\",\n \"Execution-Command and Scripting Interpreter\"\n ],\n \"object_display_name\": \"(INC483) Inc 3\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"f098ee9c-b10a-401d-bcfc-31a5c5a4817e\",\n \"sub_object_display_name\": \"Tactic-Technique-SubTechnique\",\n \"field_format\": \"text\",\n \"field_type\": \"dependent_select\",\n \"object_type\": \"incident\",\n \"created\": \"2022-02-22T07:18:22.611947+00:00\",\n \"timestamp\": 1645514302,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated Tactic-Technique-SubTechnique for Incident (INC483) Inc 3\"\n }\n]"},{"id":"a541aafa-2475-4a15-b6ef-2a0d060c3512","name":"Get Incident Activity Logs with Action UPDATE","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/activity-log/:component_identifier/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&action=update__UPDATE","host":["{{base_url}}v1"],"path":["activity-log",":component_identifier",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"action","value":"update__UPDATE","description":"`unique_key` of action that is to be filtered."}],"variable":[{"key":"component_identifier","value":"incident","description":"Define the component for which the activity logs are required. Available Options: \n- `incident`: Incident\n- `action`: Action\n- `device`: Device\n- `malware`: Malware\n- `enhancement`: Enhancement\n- `application`: Application\n- `asset-sofware`: Asset Software\n- `general-user`: General User\n- `campaign`: Campaign\n- `vulnerability`: Vulnerability\n- `threat-actor`: Threat Actor\n- `document`: Knowledge Base\n- `threat-briefing`: Threat Briefing\n- `pir`: PIR\n- `ioc-type`: Indicator Type\n- `ioc`: Threat Intel\n\n\n Admin Panel\n- `openapi`: Open APIs\n- `ciims-user`: User Management\n- `user-group`: User Group Management\n- `incident-sla`: Incident SLA\n- `action-sla`: Action SLA\n- `escalation-level-users`: Escalation User\n- `roster`: Roster\n- `shift-model`: Shift\n- `custom-email-templates`: Email Customization\n- `tenant_configuration`: Tenant Management\nTemplate Management\n - `component-export-templates`: Export Template\n - `merge-incident-templates`: Merge Template\nSettings\n - `location`: Location\n - `business-unit`: Business Units\n - `source-type`: Source Type\n - `label`: Label\n - `ostypes`: OSType\n - `manufacturers`: Manufacturer\nConfigurations\n - `incident-configuration`: Incident Configuration\n - `backup-configuration`: Data Policy\n - `csol-configuration`: Cyware Orchestrate Integration\n Authentication\n - `user-pass/config/auth`: User-Password Authentication\n - `ldap/config/auth`: LDAP Authentication\n - `saml/config/auth`: SAML Authentication"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Mon, 28 Feb 2022 07:36:47 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"10030","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"[\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 8,\n \"object_id\": \"c2a76a82-0f65-41e6-a3df-e54585aa775a\",\n \"old_field_values\": \"closed\",\n \"new_field_values\": \"open\",\n \"object_display_name\": \"(INC591) update openapi incident\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"status\",\n \"sub_object_display_name\": \"status\",\n \"field_format\": \"text\",\n \"field_type\": \"text\",\n \"object_type\": \"incident\",\n \"created\": \"2022-02-24T09:45:13.843372+00:00\",\n \"timestamp\": 1645695913,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated status for Incident (INC591) update openapi incident\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 8,\n \"object_id\": \"c2a76a82-0f65-41e6-a3df-e54585aa775a\",\n \"old_field_values\": \"open\",\n \"new_field_values\": \"closed\",\n \"object_display_name\": \"(INC591) update openapi incident\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"status\",\n \"sub_object_display_name\": \"status\",\n \"field_format\": \"text\",\n \"field_type\": \"text\",\n \"object_type\": \"incident\",\n \"created\": \"2022-02-24T09:42:44.164339+00:00\",\n \"timestamp\": 1645695764,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated status for Incident (INC591) update openapi incident\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 8,\n \"object_id\": \"c2a76a82-0f65-41e6-a3df-e54585aa775a\",\n \"new_field_values\": \"o2\",\n \"object_display_name\": \"(INC591) update openapi incident\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"9f57b5c3-5caf-42ac-9c87-0bdd93aac1bc\",\n \"sub_object_display_name\": \"test field - edited\",\n \"field_format\": \"text\",\n \"field_type\": \"select\",\n \"object_type\": \"incident\",\n \"created\": \"2022-02-24T09:42:36.730057+00:00\",\n \"timestamp\": 1645695756,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_field_values\": \"None\",\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated test field - edited for Incident (INC591) update openapi incident\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 8,\n \"object_id\": \"fd7f9ac2-8e3c-41a4-8412-98e62e2078bb\",\n \"new_field_values\": [\n \"example@example.com\"\n ],\n \"object_display_name\": \"(INC483) Inc 3\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"d9fcf8a9-8aa5-4e8f-8a9f-5c0ac90ed3d0\",\n \"sub_object_display_name\": \"Email\",\n \"field_format\": \"text\",\n \"field_type\": \"multiselect\",\n \"object_type\": \"incident\",\n \"created\": \"2022-02-23T11:49:05.099508+00:00\",\n \"timestamp\": 1645616945,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_field_values\": \"None\",\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated Email for Incident (INC483) Inc 3\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 8,\n \"object_id\": \"fd7f9ac2-8e3c-41a4-8412-98e62e2078bb\",\n \"old_field_values\": [\n \"www.example.com\"\n ],\n \"new_field_values\": [\n \"www.google.com\",\n \"www.example.com\"\n ],\n \"object_display_name\": \"(INC483) Inc 3\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"2a8c5e6c-919b-4d70-b473-6aff7a4cdd90\",\n \"sub_object_display_name\": \"Domain\",\n \"field_format\": \"text\",\n \"field_type\": \"multiselect\",\n \"object_type\": \"incident\",\n \"created\": \"2022-02-23T11:47:37.569357+00:00\",\n \"timestamp\": 1645616857,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated Domain for Incident (INC483) Inc 3\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 8,\n \"object_id\": \"fd7f9ac2-8e3c-41a4-8412-98e62e2078bb\",\n \"old_field_values\": [\n \"2.2.2.2\",\n \"3.3.3.3\"\n ],\n \"new_field_values\": [\n \"3.3.3.3\"\n ],\n \"object_display_name\": \"(INC483) Inc 3\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"b8986c14-b50c-43c6-a0c7-69eab40cb7a5\",\n \"sub_object_display_name\": \"IP\",\n \"field_format\": \"text\",\n \"field_type\": \"multiselect\",\n \"object_type\": \"incident\",\n \"created\": \"2022-02-23T11:47:02.940962+00:00\",\n \"timestamp\": 1645616822,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated IP for Incident (INC483) Inc 3\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 8,\n \"object_id\": \"fd7f9ac2-8e3c-41a4-8412-98e62e2078bb\",\n \"new_field_values\": [\n \"www.example.com\"\n ],\n \"object_display_name\": \"(INC483) Inc 3\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"2a8c5e6c-919b-4d70-b473-6aff7a4cdd90\",\n \"sub_object_display_name\": \"Domain\",\n \"field_format\": \"text\",\n \"field_type\": \"multiselect\",\n \"object_type\": \"incident\",\n \"created\": \"2022-02-23T11:46:47.277921+00:00\",\n \"timestamp\": 1645616807,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_field_values\": \"None\",\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated Domain for Incident (INC483) Inc 3\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 8,\n \"object_id\": \"fd7f9ac2-8e3c-41a4-8412-98e62e2078bb\",\n \"old_field_values\": [\n \"2.2.2.2\",\n \"1.1.1.1\"\n ],\n \"new_field_values\": [\n \"2.2.2.2\",\n \"3.3.3.3\"\n ],\n \"object_display_name\": \"(INC483) Inc 3\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"b8986c14-b50c-43c6-a0c7-69eab40cb7a5\",\n \"sub_object_display_name\": \"IP\",\n \"field_format\": \"text\",\n \"field_type\": \"multiselect\",\n \"object_type\": \"incident\",\n \"created\": \"2022-02-23T11:45:33.355950+00:00\",\n \"timestamp\": 1645616733,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated IP for Incident (INC483) Inc 3\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 8,\n \"object_id\": \"fd7f9ac2-8e3c-41a4-8412-98e62e2078bb\",\n \"old_field_values\": [\n \"Initial Access-Phishing\"\n ],\n \"new_field_values\": [\n \"Initial Access-Phishing\",\n \"Execution-Command and Scripting Interpreter\"\n ],\n \"object_display_name\": \"(INC483) Inc 3\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"f098ee9c-b10a-401d-bcfc-31a5c5a4817e\",\n \"sub_object_display_name\": \"Tactic-Technique-SubTechnique\",\n \"field_format\": \"text\",\n \"field_type\": \"dependent_select\",\n \"object_type\": \"incident\",\n \"created\": \"2022-02-22T07:18:22.611947+00:00\",\n \"timestamp\": 1645514302,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated Tactic-Technique-SubTechnique for Incident (INC483) Inc 3\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 8,\n \"object_id\": \"fd7f9ac2-8e3c-41a4-8412-98e62e2078bb\",\n \"new_field_values\": [\n \"2.2.2.2\",\n \"1.1.1.1\"\n ],\n \"object_display_name\": \"(INC483) Inc 3\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"b8986c14-b50c-43c6-a0c7-69eab40cb7a5\",\n \"sub_object_display_name\": \"IP\",\n \"field_format\": \"text\",\n \"field_type\": \"multiselect\",\n \"object_type\": \"incident\",\n \"created\": \"2022-02-22T07:18:03.873682+00:00\",\n \"timestamp\": 1645514283,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_field_values\": \"None\",\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated IP for Incident (INC483) Inc 3\"\n }\n]"}],"_postman_id":"88faff69-c50e-4834-a083-b1285b0831ac"},{"name":"Get Activity Logs of a Record","id":"040fcc58-a2b0-47eb-9781-8d5b6325e4a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/activity-log/:component_identifier/:component_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the activity logs of a specific component record.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

Parameter	Type	Description
`tenant_id`	String	Unique ID of the tenant.
`user`	String	`username` of the user who performed the activity.
`action`	String	Action performed in the activity. Examples: - `CREATE` - `UPDATE` - `DELETE` - `COMMENT` - `UPLOAD`
`object_id`	String	Unique ID of the updated record.
`old_field_values`	String	Previous value of the updated field.
`new_field_values`	String	Updated value of the field.
`object_display_name`	String	Title of the updated record.
`first_name`	String	`first_name` of the user who performed the activity.
`last_name`	String	`last_name` of the user who performed the activity.
`sub_object_id`	String	`unique_id` or `readable_id` of the updated field.
`sub_object_display_name`	String	`name` of the updated field.
`field_format`	String	Format of the updated field. Allowed values: - `calendar`: DateTime fields - `text`: Text fields
`field_type`	String	Type of the updated field. Allowed values: - `text` - `integer` - `calendar` - `textarea` - `select` - `multiselect`
`object_type`	String	Component identifier of the updated component type.
`created`	String	Activity time in ISO format.
`timestamp`	Integer	Activity time in EPOCH format.
`sentence_html`	Text	Description of the activity in HTML format.
`user_profile_background_color`	String	Hex key of the background color of the user profile.
`user_display_pic`	String	The link to the display picture of the user.

","urlObject":{"path":["activity-log",":component_identifier",":component_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the activity log in EPOCH Time format.\nTime Zone must be as per UTC. All activity logs with creation date later than the entered time will be returned.

\n","type":"text/plain"},"key":"timestamp__gte","value":"1644345000"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the activity log in EPOCH Time format.\nTime Zone must be as per UTC. All activity logs with creation date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"timestamp__lte","value":"1644345000"}],"variable":[{"description":{"content":"

Enter the component identifier for which the activity logs are requested. Allowed values:

incident: Incident
\n
action: Action
\n
device: Device
\n
malware: Malware
\n
enhancement: Enhancement
\n
application: Application
\n
asset-sofware: Asset Software
\n
general-user: General User
\n
campaign: Campaign
\n
vulnerability: Vulnerability
\n
threat-actor: Threat Actor
\n
document: Knowledge Base
\n
threat-briefing: Threat Briefing
\n
pir: PIR
\n
ioc-type: Indicator Type
\n
ioc: Threat Intel
\n
Admin Panel
\n
openapi: Open APIs
\n
ciims-user: User Management
\n
user-group: User Group Management
\n
incident-sla: Incident SLA
\n
action-sla: Action SLA
\n
escalation-level-users: Escalation User
\n
roster: Roster
\n
shift-model: Shift
\n
custom-email-templates: Email Customization
\n
tenant_configuration: Tenant Management\nTemplate Management
\n
component-export-templates: Export Template
\n
merge-incident-templates: Merge Template\nSettings
\n
- location: Location
- business-unit: Business Units
- source-type: Source Type
- label: Label
- ostypes: OSType
- manufacturers: Manufacturer\nConfigurations
- incident-configuration: Incident Configuration
- backup-configuration: Data Policy
- csol-configuration: Cyware Orchestrate Integration\n Authentication\n- user-pass/config/auth: User-Password Authentication\n- ldap/config/auth: LDAP Authentication\n- saml/config/auth: SAML Authentication
\n

\n","type":"text/plain"},"type":"any","value":"incident","key":"component_identifier"},{"description":{"content":"

Enter the unique ID of the component record for which activity logs are requested.

\n","type":"text/plain"},"type":"any","value":"2a7744d4-05d3-4cf1-83ab-8765be5f0700","key":"component_unique_id"}]}},"response":[{"id":"fa882ed4-317f-4daa-9732-ea345ec760e0","name":"Get Activity Logs of an Instance","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/activity-log/instance/fd7f9ac2-8e3c-41a4-8412-98e62e2078bb/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["activity-log","instance","fd7f9ac2-8e3c-41a4-8412-98e62e2078bb",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Mon, 28 Feb 2022 05:51:29 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"8189","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"[\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 8,\n \"object_id\": \"fd7f9ac2-8e3c-41a4-8412-98e62e2078bb\",\n \"new_field_values\": [\n \"example@example.com\"\n ],\n \"object_display_name\": \"(INC483) Inc 3\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"d9fcf8a9-8aa5-4e8f-8a9f-5c0ac90ed3d0\",\n \"sub_object_display_name\": \"Email\",\n \"field_format\": \"text\",\n \"field_type\": \"multiselect\",\n \"object_type\": \"incident\",\n \"created\": \"2022-02-23T11:49:05.099508+00:00\",\n \"timestamp\": 1645616945,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_field_values\": \"None\",\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated Email\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 8,\n \"object_id\": \"fd7f9ac2-8e3c-41a4-8412-98e62e2078bb\",\n \"old_field_values\": [\n \"www.example.com\"\n ],\n \"new_field_values\": [\n \"www.google.com\",\n \"www.example.com\"\n ],\n \"object_display_name\": \"(INC483) Inc 3\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"2a8c5e6c-919b-4d70-b473-6aff7a4cdd90\",\n \"sub_object_display_name\": \"Domain\",\n \"field_format\": \"text\",\n \"field_type\": \"multiselect\",\n \"object_type\": \"incident\",\n \"created\": \"2022-02-23T11:47:37.569357+00:00\",\n \"timestamp\": 1645616857,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated Domain\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 8,\n \"object_id\": \"fd7f9ac2-8e3c-41a4-8412-98e62e2078bb\",\n \"old_field_values\": [\n \"2.2.2.2\",\n \"3.3.3.3\"\n ],\n \"new_field_values\": [\n \"3.3.3.3\"\n ],\n \"object_display_name\": \"(INC483) Inc 3\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"b8986c14-b50c-43c6-a0c7-69eab40cb7a5\",\n \"sub_object_display_name\": \"IP\",\n \"field_format\": \"text\",\n \"field_type\": \"multiselect\",\n \"object_type\": \"incident\",\n \"created\": \"2022-02-23T11:47:02.940962+00:00\",\n \"timestamp\": 1645616822,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated IP\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 8,\n \"object_id\": \"fd7f9ac2-8e3c-41a4-8412-98e62e2078bb\",\n \"new_field_values\": [\n \"www.example.com\"\n ],\n \"object_display_name\": \"(INC483) Inc 3\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"2a8c5e6c-919b-4d70-b473-6aff7a4cdd90\",\n \"sub_object_display_name\": \"Domain\",\n \"field_format\": \"text\",\n \"field_type\": \"multiselect\",\n \"object_type\": \"incident\",\n \"created\": \"2022-02-23T11:46:47.277921+00:00\",\n \"timestamp\": 1645616807,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_field_values\": \"None\",\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated Domain\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 8,\n \"object_id\": \"fd7f9ac2-8e3c-41a4-8412-98e62e2078bb\",\n \"old_field_values\": [\n \"2.2.2.2\",\n \"1.1.1.1\"\n ],\n \"new_field_values\": [\n \"2.2.2.2\",\n \"3.3.3.3\"\n ],\n \"object_display_name\": \"(INC483) Inc 3\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"b8986c14-b50c-43c6-a0c7-69eab40cb7a5\",\n \"sub_object_display_name\": \"IP\",\n \"field_format\": \"text\",\n \"field_type\": \"multiselect\",\n \"object_type\": \"incident\",\n \"created\": \"2022-02-23T11:45:33.355950+00:00\",\n \"timestamp\": 1645616733,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated IP\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 8,\n \"object_id\": \"fd7f9ac2-8e3c-41a4-8412-98e62e2078bb\",\n \"old_field_values\": [\n \"Initial Access-Phishing\"\n ],\n \"new_field_values\": [\n \"Initial Access-Phishing\",\n \"Execution-Command and Scripting Interpreter\"\n ],\n \"object_display_name\": \"(INC483) Inc 3\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"f098ee9c-b10a-401d-bcfc-31a5c5a4817e\",\n \"sub_object_display_name\": \"Tactic-Technique-SubTechnique\",\n \"field_format\": \"text\",\n \"field_type\": \"dependent_select\",\n \"object_type\": \"incident\",\n \"created\": \"2022-02-22T07:18:22.611947+00:00\",\n \"timestamp\": 1645514302,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated Tactic-Technique-SubTechnique\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 8,\n \"object_id\": \"fd7f9ac2-8e3c-41a4-8412-98e62e2078bb\",\n \"new_field_values\": [\n \"2.2.2.2\",\n \"1.1.1.1\"\n ],\n \"object_display_name\": \"(INC483) Inc 3\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"b8986c14-b50c-43c6-a0c7-69eab40cb7a5\",\n \"sub_object_display_name\": \"IP\",\n \"field_format\": \"text\",\n \"field_type\": \"multiselect\",\n \"object_type\": \"incident\",\n \"created\": \"2022-02-22T07:18:03.873682+00:00\",\n \"timestamp\": 1645514283,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_field_values\": \"None\",\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated IP\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 8,\n \"object_id\": \"fd7f9ac2-8e3c-41a4-8412-98e62e2078bb\",\n \"new_field_values\": \"(VUL108) Vulnerability 8.0.0\",\n \"object_display_name\": \"(INC483) Inc 3\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"object_type\": \"incident\",\n \"sub_object_id\": \"adc17f76-1062-4682-b326-85b0b5370aba\",\n \"sub_object_display_name\": \"Vulnerability\",\n \"created\": \"2022-02-21T09:04:58.887883+00:00\",\n \"timestamp\": 1645434298,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_field_values\": \"None\",\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated Vulnerability\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 8,\n \"object_id\": \"fd7f9ac2-8e3c-41a4-8412-98e62e2078bb\",\n \"new_field_values\": [\n \"Initial Access-Phishing\"\n ],\n \"object_display_name\": \"(INC483) Inc 3\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"f098ee9c-b10a-401d-bcfc-31a5c5a4817e\",\n \"sub_object_display_name\": \"Tactic-Technique-SubTechnique\",\n \"field_format\": \"text\",\n \"field_type\": \"dependent_select\",\n \"object_type\": \"incident\",\n \"created\": \"2022-02-18T10:22:57.182330+00:00\",\n \"timestamp\": 1645179777,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_field_values\": \"None\",\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated Tactic-Technique-SubTechnique\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"SLA_ESCALATION\",\n \"object_ctype\": 8,\n \"object_id\": \"fd7f9ac2-8e3c-41a4-8412-98e62e2078bb\",\n \"object_display_name\": \"(INC483) Inc 3\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"template_params\": {\n \"level\": \"3\",\n \"sla_type\": \"resolution\",\n \"sla_title\": \"SLA 2\"\n },\n \"object_type\": \"incident\",\n \"created\": \"2022-01-24T10:21:16.250916+00:00\",\n \"timestamp\": 1643019676,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"sentence_html\": \"Resolution SLA SLA 2 Level 3 has breached\"\n }\n]"}],"_postman_id":"040fcc58-a2b0-47eb-9781-8d5b6325e4a0"},{"name":"Get Action Filters for a Component","id":"8754ad0e-8faf-469c-9ae1-bad53068d0b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/activity-log/action-filters/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the actions for filtering the activity logs of a component.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` shows the API endpoint to the next page.
`count`	Integer	Total number of actions for activity logs of a component in CFTR.
`results`	List of Objects	Details of the actions for activity logs. Each object provides details of one action.

Response Parameters | Results Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`action_display_name`	String	Name of the action filter.
`unique_key`	String	Value of the action filter.

","urlObject":{"path":["activity-log","action-filters",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"disabled":true,"description":{"content":"

Enter the component identifier for which the activity logs are requested. Allowed values:

incident: Incident
action: Action
device: Device
malware: Malware
enhancement: Enhancement
application: Application
asset-sofware: Asset Software
general-user: General User
campaign: Campaign
vulnerability: Vulnerability
threat-actor: Threat Actor
document: Knowledge Base
threat-briefing: Threat Briefing
pir: PIR
ioc-type: Indicator Type
ioc: Threat Intel\nAdmin Panel
openapi: Open APIs
ciims-user: User Management
user-group: User Group Management
incident-sla: Incident SLA
action-sla: Action SLA
escalation-level-users: Escalation User
roster: Roster
shift-model: Shift
custom-email-templates: Email Customization
tenant_configuration: Tenant Management\nTemplate Management
component-export-templates: Export Template
merge-incident-templates: Merge Template\nSettings
- location: Location
- business-unit: Business Units
- source-type: Source Type
- label: Label
- ostypes: OSType
- manufacturers: Manufacturer\nConfigurations
- incident-configuration: Incident Configuration
- backup-configuration: Data Policy
- csol-configuration: Cyware Orchestrate Integration
\n

\n","type":"text/plain"},"key":"component","value":"incident"}],"variable":[]}},"response":[{"id":"4a7f30aa-22f1-487f-97bc-24471ae05380","name":"Get Action Filters for Incident","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/activity-log/action-filters/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["activity-log","action-filters",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"component","value":"incident","description":"Define the component for which the activity logs are required. Available Options: \n- `incident`: Incident\n- `action`: Action\n- `device`: Device\n- `malware`: Malware\n- `enhancement`: Enhancement\n- `application`: Application\n- `asset-sofware`: Asset Software\n- `general-user`: General User\n- `campaign`: Campaign\n- `vulnerability`: Vulnerability\n- `threat-actor`: Threat Actor\n- `document`: Knowledge Base\n- `threat-briefing`: Threat Briefing\n- `pir`: PIR\n- `ioc-type`: Indicator Type\n- `ioc`: Threat Intel\n Admin Panel\n- `openapi`: Open APIs\n- `ciims-user`: User Management\n- `user-group`: User Group Management\n- `incident-sla`: Incident SLA\n- `action-sla`: Action SLA\n- `escalation-level-users`: Escalation User\n- `roster`: Roster\n- `shift-model`: Shift\n- `custom-email-templates`: Email Customization\n- `tenant_configuration`: Tenant Management\nTemplate Management\n - `component-export-templates`: Export Template\n - `merge-incident-templates`: Merge Template\nSettings\n - `location`: Location\n - `business-unit`: Business Units\n - `source-type`: Source Type\n - `label`: Label\n - `ostypes`: OSType\n - `manufacturers`: Manufacturer\nConfigurations\n - `incident-configuration`: Incident Configuration\n - `backup-configuration`: Data Policy\n - `csol-configuration`: Cyware Orchestrate Integration","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Mon, 28 Feb 2022 07:05:18 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"623","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 8,\n \"results\": [\n {\n \"action_display_name\": \"SLA Escalation\",\n \"unique_key\": \"sla_escalation__SLA_ESCALATION\"\n },\n {\n \"action_display_name\": \"Attachment Upload\",\n \"unique_key\": \"attachment_upload__UPLOAD\"\n },\n {\n \"action_display_name\": \"Playbook Run\",\n \"unique_key\": \"playbook_run__RUN\"\n },\n {\n \"action_display_name\": \"Merge Child\",\n \"unique_key\": \"merge_child__CHILD_MERGED\"\n },\n {\n \"action_display_name\": \"Comment\",\n \"unique_key\": \"comment__COMMENT\"\n },\n {\n \"action_display_name\": \"Update\",\n \"unique_key\": \"update__UPDATE\"\n },\n {\n \"action_display_name\": \"Create\",\n \"unique_key\": \"create__CREATE\"\n },\n {\n \"action_display_name\": \"Merge Parent\",\n \"unique_key\": \"merge_parent__MERGED\"\n }\n ]\n}"},{"id":"db6b1825-e587-46c0-a4c5-50aab9c380e6","name":"Get Action Filters for a Component","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/activity-log/action-filters/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["activity-log","action-filters",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"component","value":"incident","description":"Enter the component identifier for which the activity logs are requested. Allowed values: \n- `incident`: Incident\n- `action`: Action\n- `device`: Device\n- `malware`: Malware\n- `enhancement`: Enhancement\n- `application`: Application\n- `asset-sofware`: Asset Software\n- `general-user`: General User\n- `campaign`: Campaign\n- `vulnerability`: Vulnerability\n- `threat-actor`: Threat Actor\n- `document`: Knowledge Base\n- `threat-briefing`: Threat Briefing\n- `pir`: PIR\n- `ioc-type`: Indicator Type\n- `ioc`: Threat Intel\n Admin Panel\n- `openapi`: Open APIs\n- `ciims-user`: User Management\n- `user-group`: User Group Management\n- `incident-sla`: Incident SLA\n- `action-sla`: Action SLA\n- `escalation-level-users`: Escalation User\n- `roster`: Roster\n- `shift-model`: Shift\n- `custom-email-templates`: Email Customization\n- `tenant_configuration`: Tenant Management\nTemplate Management\n - `component-export-templates`: Export Template\n - `merge-incident-templates`: Merge Template\nSettings\n - `location`: Location\n - `business-unit`: Business Units\n - `source-type`: Source Type\n - `label`: Label\n - `ostypes`: OSType\n - `manufacturers`: Manufacturer\nConfigurations\n - `incident-configuration`: Incident Configuration\n - `backup-configuration`: Data Policy\n - `csol-configuration`: Cyware Orchestrate Integration","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 15 Jan 2024 18:10:28 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: http: data: blob:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {\n \"next\": \"openapi/cftrapi/openapi/v1/activity-log/action-filters/?page=2&page_size=10&AccessID=d9e2430a-eb0b-4751-acb2-6a9b66615e1a&Expires=1705342243&Signature=uNuYG/rfp7gXh1343732sn40sn4=\"\n },\n \"count\": 179,\n \"results\": [\n {\n \"action_display_name\": \"Delete\",\n \"unique_key\": \"delete__DELETE\"\n },\n {\n \"action_display_name\": \"Update\",\n \"unique_key\": \"update__UPDATE\"\n },\n {\n \"action_display_name\": \"Create\",\n \"unique_key\": \"create__CREATE\"\n },\n {\n \"action_display_name\": \"Delete\",\n \"unique_key\": \"delete__DELETE\"\n },\n {\n \"action_display_name\": \"Update\",\n \"unique_key\": \"update__UPDATE\"\n },\n {\n \"action_display_name\": \"Create\",\n \"unique_key\": \"create__CREATE\"\n },\n {\n \"action_display_name\": \"Delete\",\n \"unique_key\": \"delete__DELETE\"\n },\n {\n \"action_display_name\": \"Update\",\n \"unique_key\": \"update__UPDATE\"\n },\n {\n \"action_display_name\": \"Create\",\n \"unique_key\": \"create__CREATE\"\n },\n {\n \"action_display_name\": \"Update\",\n \"unique_key\": \"update__UPDATE\"\n }\n ]\n}"}],"_postman_id":"8754ad0e-8faf-469c-9ae1-bad53068d0b3"},{"name":"Get Incident Workflow Activity Logs","id":"1bdfce31-1923-4a2e-b8b6-426a8896b50c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/activity-log/dynamic-form-tab/incident/schema/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the activity logs of an Incident Workflow.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

Parameter	Type	Description
`tenant_id`	String	Unique ID of the tenant.
`user`	String	`username` of the user who performed the activity.
`action`	String	Action performed in the activity. Examples: - `CREATE` - `UPDATE` - `DELETE` - `COMMENT` - `UPLOAD`
`object_id`	String	Unique ID of the updated record.
`old_field_values`	String	Previous value of the updated field.
`new_field_values`	String	Updated value of the field.
`object_display_name`	String	Title of the updated record.
`first_name`	String	`first_name` of the user who performed the activity.
`last_name`	String	`last_name` of the user who performed the activity.
`sub_object_id`	String	`unique_id` or `readable_id` of the updated field.
`sub_object_display_name`	String	`name` of the updated field.
`field_format`	String	Format of the updated field. Allowed values: - `calendar`: DateTime fields - `text`: Text fields
`field_type`	String	Type of the updated field. Allowed values: - `text` - `integer` - `calendar` - `textarea` - `select` - `multiselect`
`object_type`	String	Component identifier of the updated component type.
`created`	String	Activity time in ISO format.
`timestamp`	Integer	Activity time in EPOCH format.
`sentence_html`	Text	Description of the activity in HTML format.
`user_profile_backgroup_color`	String	Hex key of the background color of the user profile.
`user_display_pic`	String	The link to the display picture of the user.

","urlObject":{"path":["activity-log","dynamic-form-tab","incident","schema",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the activity log in EPOCH Time format.\nTime Zone must be as per UTC. All activity logs with creation date later than the entered time will be returned.

\n","type":"text/plain"},"key":"timestamp__gte","value":"1644345000"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the activity log in EPOCH Time format.\nTime Zone must be as per UTC. All activity logs with creation date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"timestamp__lte","value":"1644345000"}],"variable":[]}},"response":[{"id":"ff0742e2-6217-4d02-810e-f892c8c241f6","name":"Get Incident Workflow activity logs","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/activity-log/dynamic-form-tab/incident/schema/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["activity-log","dynamic-form-tab","incident","schema",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Mon, 28 Feb 2022 07:41:06 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"6792","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"[\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"ADDED_FIELD\",\n \"object_ctype\": 168,\n \"object_id\": \"b11a6815-6d65-4e6b-8add-2bb937f71ca7\",\n \"object_display_name\": \"test closure\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"object_type\": \"schema\",\n \"sub_object_display_name\": \"Regulatory Notification Required\",\n \"created\": \"2022-02-24T09:43:03.630299+00:00\",\n \"timestamp\": 1645695783,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"sentence_html\": \" @jane added field Regulatory Notification Required to Workflow test closure \"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"ADDED_FIELD\",\n \"object_ctype\": 168,\n \"object_id\": \"3da532fc-c86a-4d85-8243-1a2ce29425d5\",\n \"object_display_name\": \"NIST - original\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"object_type\": \"schema\",\n \"sub_object_display_name\": \"ftest\",\n \"created\": \"2022-02-24T09:38:35.278179+00:00\",\n \"timestamp\": 1645695515,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"sentence_html\": \" @jane added field ftest to Workflow NIST - original \"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"REMOVED_FIELD\",\n \"object_ctype\": 168,\n \"object_id\": \"0dc28d94-b892-41f2-9628-b0ac9bd00f0a\",\n \"object_display_name\": \"2 [Clone]\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"object_type\": \"schema\",\n \"sub_object_display_name\": \"Regulatory Notification Required\",\n \"created\": \"2022-02-10T09:55:42.234053+00:00\",\n \"timestamp\": 1644486942,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"sentence_html\": \" @jane removed field Regulatory Notification Required from Workflow 2 [Clone] \"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 168,\n \"object_id\": \"0dc28d94-b892-41f2-9628-b0ac9bd00f0a\",\n \"old_field_values\": \"Draft\",\n \"new_field_values\": \"Published\",\n \"object_display_name\": \"2 [Clone]\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"schema_type\",\n \"sub_object_display_name\": \"Workflow Type\",\n \"field_format\": \"text\",\n \"field_type\": \"text\",\n \"object_type\": \"schema\",\n \"created\": \"2022-02-10T09:55:36.043762+00:00\",\n \"timestamp\": 1644486936,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated Workflow Type for Workflow 2 [Clone]\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"CLONE\",\n \"object_ctype\": 168,\n \"object_id\": \"0dc28d94-b892-41f2-9628-b0ac9bd00f0a\",\n \"object_display_name\": \"2 [Clone]\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"template_params\": {\n \"is_cloned\": true,\n \"schema\": \"2\"\n },\n \"object_type\": \"schema\",\n \"created\": \"2022-02-10T09:55:27.140473+00:00\",\n \"timestamp\": 1644486927,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"sentence_html\": \" @jane cloned 2 [Clone] from 2\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 168,\n \"object_id\": \"b11a6815-6d65-4e6b-8add-2bb937f71ca7\",\n \"new_field_values\": \"test 1\",\n \"object_display_name\": \"test closure\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"closure_phase\",\n \"sub_object_display_name\": \"closure phase\",\n \"field_format\": \"text\",\n \"field_type\": \"text\",\n \"object_type\": \"schema\",\n \"created\": \"2022-01-31T10:23:37.357898+00:00\",\n \"timestamp\": 1643624617,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_field_values\": \"None\",\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated closure phase for Workflow test closure\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"ADDED_FIELD\",\n \"object_ctype\": 168,\n \"object_id\": \"b11a6815-6d65-4e6b-8add-2bb937f71ca7\",\n \"object_display_name\": \"test closure\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"object_type\": \"schema\",\n \"sub_object_display_name\": \"test field - edited\",\n \"created\": \"2022-01-28T11:31:29.794596+00:00\",\n \"timestamp\": 1643369489,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"sentence_html\": \" @jane added field test field - edited to Workflow test closure \"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"REMOVED_FIELD\",\n \"object_ctype\": 168,\n \"object_id\": \"b11a6815-6d65-4e6b-8add-2bb937f71ca7\",\n \"object_display_name\": \"test closure\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"object_type\": \"schema\",\n \"sub_object_display_name\": \"Incident Analysis\",\n \"created\": \"2022-01-28T11:29:25.400894+00:00\",\n \"timestamp\": 1643369365,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"sentence_html\": \" @jane removed field Incident Analysis from Workflow test closure \"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"DEFAULT\",\n \"object_ctype\": 168,\n \"object_id\": \"b11a6815-6d65-4e6b-8add-2bb937f71ca7\",\n \"object_display_name\": \"test closure\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"object_type\": \"schema\",\n \"created\": \"2022-01-28T11:24:48.827874+00:00\",\n \"timestamp\": 1643369088,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"sentence_html\": \"@jane marked the Workflow test closure as default Workflow \"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"DEFAULT\",\n \"object_ctype\": 168,\n \"object_id\": \"9fcc8071-6b0a-415f-832d-e417d4042410\",\n \"object_display_name\": \"NIST\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"object_type\": \"schema\",\n \"created\": \"2022-01-25T07:59:19.582232+00:00\",\n \"timestamp\": 1643097559,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"sentence_html\": \"@jane marked the Workflow NIST as default Workflow \"\n }\n]"}],"_postman_id":"1bdfce31-1923-4a2e-b8b6-426a8896b50c"},{"name":"Get Form Management Activity Logs","id":"2453d297-d349-43c1-b4a8-1bd73b0801c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/activity-log/dynamic-form-tab/:component_identifier/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the activity logs of the form management module.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

Parameter	Type	Description
`tenant_id`	String	Unique ID of the tenant.
`user`	String	`username` of the user who performed the activity.
`action`	String	Action performed in the activity. Examples: - `CREATE` - `UPDATE` - `DELETE` - `COMMENT` - `UPLOAD`
`object_id`	String	Unique ID of the updated record.
`old_field_values`	String	Previous value of the updated field.
`new_field_values`	String	Updated value of the field.
`object_display_name`	String	Title of the updated record.
`first_name`	String	`first_name` of the user who performed the activity.
`last_name`	String	`last_name` of the user who performed the activity.
`sub_object_id`	String	`unique_id` or `readable_id` of the updated field.
`sub_object_display_name`	String	`name` of the updated field.
`field_format`	String	Format of the updated field. Allowed values: - `calendar`: DateTime fields - `text`: Text fields
`field_type`	String	Type of the updated field. Allowed values: - `text` - `integer` - `calendar` - `textarea` - `select` - `multiselect`
`object_type`	String	Component identifier of the updated component type.
`created`	String	Activity time in ISO format.
`timestamp`	Integer	Activity time in EPOCH format.
`sentence_html`	Text	Description of the activity in HTML format.
`user_profile_background_color`	String	Hex key of the background color of the user profile.
`display_pic`	String	The link to the display picture of the user.

","urlObject":{"path":["activity-log","dynamic-form-tab",":component_identifier",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the activity log in EPOCH Time format.\nTime Zone must be as per UTC. All activity logs with creation date later than the entered time will be returned.

\n","type":"text/plain"},"key":"timestamp__gte","value":"1644345000"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the activity log in EPOCH Time format.\nTime Zone must be as per UTC. All activity logs with creation date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"timestamp__lte","value":"1644345000"}],"variable":[{"description":{"content":"

Enter the component identifier for which the activity logs are requested. Allowed values:

action: Action
device: Device
malware: Malware
enhancement: Enhancement
application: Application
asset-sofware: Asset Software
general-user: User
campaign: Campaign
vulnerability: Vulnerability
threat-actor: Threat Actor
threat-briefing: Threat Briefing
pir: PIR
ioc: Threat Intel

\n","type":"text/plain"},"type":"any","value":"action","key":"component_identifier"}]}},"response":[{"id":"7b7507c5-be61-4adb-8a35-d1bee3acbb51","name":"Get Form Management Activity Logs for Actions","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/activity-log/dynamic-form-tab/:component_identifier/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["activity-log","dynamic-form-tab",":component_identifier",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"component_identifier","value":"action","description":"Define the component for which the form management activity logs are required. Available Options: \n- `action`: Action\n- `device`: Device\n- `malware`: Malware\n- `enhancement`: Enhancement\n- `application`: Application\n- `asset-sofware`: Asset Software\n- `general-user`: User\n- `campaign`: Campaign\n- `vulnerability`: Vulnerability\n- `threat-actor`: Threat Actor\n- `threat-briefing`: Threat Briefing\n- `pir`: PIR\n- `ioc`: Threat Intel"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Mon, 28 Feb 2022 08:36:43 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"8160","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"[\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"CREATE\",\n \"object_ctype\": 49,\n \"object_id\": \"53d90cac-667b-4cfc-ada5-0451173dca90\",\n \"object_display_name\": \"PIN\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"object_type\": \"form-field\",\n \"ancestors\": [\n {\n \"object_id\": \"1a4aa70b-e6c8-4251-8492-ac8cd88f407c\",\n \"object_ctype\": 52,\n \"object_type\": \"form-tab\",\n \"object_display_name\": \"credit card\"\n }\n ],\n \"created\": \"2022-02-15T14:10:29.616764+00:00\",\n \"timestamp\": 1644934229,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"sentence_html\": \"@jane created Field PIN under credit card tab\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 50,\n \"object_id\": \"3586fe0b-ec61-4cee-ae78-6a53f9a69f79\",\n \"old_field_values\": \"red\",\n \"new_field_values\": \"blue\",\n \"object_display_name\": \"test2\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"object_type\": \"form-field-option\",\n \"sub_object_display_name\": \"color\",\n \"sub_object_id\": \"color\",\n \"ancestors\": [\n {\n \"object_id\": \"858e4324-b606-41c1-aa0d-67b14b42d0e3\",\n \"object_ctype\": 52,\n \"object_type\": \"form-tab\",\n \"object_display_name\": \"preparation\"\n },\n {\n \"object_id\": \"2fdedb65-b0b7-48af-b34e-714b4f7622bb\",\n \"object_ctype\": 49,\n \"object_type\": \"form-field\",\n \"object_display_name\": \"Severity\"\n }\n ],\n \"template_params\": {\n \"field_name\": \"Severity\"\n },\n \"created\": \"2022-02-15T13:07:01.738379+00:00\",\n \"timestamp\": 1644930421,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated Option for Field Severity in preparation tab\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"CREATE\",\n \"object_ctype\": 50,\n \"object_id\": \"3586fe0b-ec61-4cee-ae78-6a53f9a69f79\",\n \"object_display_name\": \"test2\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"object_type\": \"form-field-option\",\n \"ancestors\": [\n {\n \"object_id\": \"858e4324-b606-41c1-aa0d-67b14b42d0e3\",\n \"object_ctype\": 52,\n \"object_type\": \"form-tab\",\n \"object_display_name\": \"preparation\"\n },\n {\n \"object_id\": \"2fdedb65-b0b7-48af-b34e-714b4f7622bb\",\n \"object_ctype\": 49,\n \"object_type\": \"form-field\",\n \"object_display_name\": \"Severity\"\n }\n ],\n \"template_params\": {\n \"field_name\": \"Severity\"\n },\n \"created\": \"2022-02-15T13:06:37.024455+00:00\",\n \"timestamp\": 1644930397,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"sentence_html\": \"@jane created Option test2 for Field Severity in preparation tab\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"CREATE\",\n \"object_ctype\": 50,\n \"object_id\": \"b44efe2a-a9db-4d6c-9d45-0e4456d30fb0\",\n \"object_display_name\": \"test\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"object_type\": \"form-field-option\",\n \"ancestors\": [\n {\n \"object_id\": \"858e4324-b606-41c1-aa0d-67b14b42d0e3\",\n \"object_ctype\": 52,\n \"object_type\": \"form-tab\",\n \"object_display_name\": \"preparation\"\n },\n {\n \"object_id\": \"2fdedb65-b0b7-48af-b34e-714b4f7622bb\",\n \"object_ctype\": 49,\n \"object_type\": \"form-field\",\n \"object_display_name\": \"Severity\"\n }\n ],\n \"template_params\": {\n \"field_name\": \"Severity\"\n },\n \"created\": \"2022-02-15T13:05:13.348763+00:00\",\n \"timestamp\": 1644930313,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"sentence_html\": \"@jane created Option test for Field Severity in preparation tab\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"UPDATE\",\n \"object_ctype\": 52,\n \"object_id\": \"f3e8dfe8-1a14-4768-8108-94a1fce7cbb0\",\n \"old_field_values\": \"test 2\",\n \"new_field_values\": \"test 20\",\n \"object_display_name\": \"test 20\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"sub_object_id\": \"tab_name\",\n \"sub_object_display_name\": \"Tab Name\",\n \"field_format\": \"text\",\n \"field_type\": \"text\",\n \"object_type\": \"form-tabs\",\n \"created\": \"2022-02-15T10:38:47.226136+00:00\",\n \"timestamp\": 1644921527,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"old_values_display_key\": \"PREVIOUS\",\n \"new_values_display_key\": \"CURRENT\",\n \"sentence_html\": \"@jane updated Tab Name for Tab test 20\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"DELETE\",\n \"object_ctype\": 49,\n \"object_id\": \"846aa7af-5f7b-4008-9328-c301adb72f2b\",\n \"object_display_name\": \"test6-f2\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"object_type\": \"form-field\",\n \"ancestors\": [\n {\n \"object_id\": \"59db70ee-72b2-472c-a1a4-8f0c5311de22\",\n \"object_ctype\": 52,\n \"object_type\": \"form-tab\",\n \"object_display_name\": \"test 6\"\n }\n ],\n \"created\": \"2022-02-15T10:10:10.145547+00:00\",\n \"timestamp\": 1644919810,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"sentence_html\": \"@jane deleted Field test6-f2 under test 6 tab\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"DELETE\",\n \"object_ctype\": 49,\n \"object_id\": \"08394781-519f-4d8e-bb11-2756b0d9a9f5\",\n \"object_display_name\": \"test6-f1\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"object_type\": \"form-field\",\n \"ancestors\": [\n {\n \"object_id\": \"59db70ee-72b2-472c-a1a4-8f0c5311de22\",\n \"object_ctype\": 52,\n \"object_type\": \"form-tab\",\n \"object_display_name\": \"test 6\"\n }\n ],\n \"created\": \"2022-02-15T10:10:07.149774+00:00\",\n \"timestamp\": 1644919807,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"sentence_html\": \"@jane deleted Field test6-f1 under test 6 tab\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"DELETE\",\n \"object_ctype\": 49,\n \"object_id\": \"748058f8-cd39-4130-b007-df517a0e7eb7\",\n \"object_display_name\": \"test 1\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"object_type\": \"form-field\",\n \"ancestors\": [\n {\n \"object_id\": \"5c8f74bc-f735-4e29-ac9f-6d3533bf0e41\",\n \"object_ctype\": 52,\n \"object_type\": \"form-tab\",\n \"object_display_name\": \"Test\"\n }\n ],\n \"created\": \"2022-02-15T10:10:02.677565+00:00\",\n \"timestamp\": 1644919802,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"sentence_html\": \"@jane deleted Field test 1 under Test tab\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"DELETE\",\n \"object_ctype\": 49,\n \"object_id\": \"de3551ab-644e-40bc-8efc-dbeb8104e5fc\",\n \"object_display_name\": \"card no\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"object_type\": \"form-field\",\n \"ancestors\": [\n {\n \"object_id\": \"1a4aa70b-e6c8-4251-8492-ac8cd88f407c\",\n \"object_ctype\": 52,\n \"object_type\": \"form-tab\",\n \"object_display_name\": \"credit card\"\n }\n ],\n \"created\": \"2022-02-15T10:09:58.728553+00:00\",\n \"timestamp\": 1644919798,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"sentence_html\": \"@jane deleted Field card no under credit card tab\"\n },\n {\n \"tenant_id\": \"f098aaed-18b8-4cbc-80a6-14219639c281\",\n \"user\": \"jane\",\n \"action\": \"DELETE\",\n \"object_ctype\": 49,\n \"object_id\": \"13cd22a1-f4fc-40a8-b7d9-79f79527ee7b\",\n \"object_display_name\": \"PIN\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"object_type\": \"form-field\",\n \"ancestors\": [\n {\n \"object_id\": \"1a4aa70b-e6c8-4251-8492-ac8cd88f407c\",\n \"object_ctype\": 52,\n \"object_type\": \"form-tab\",\n \"object_display_name\": \"credit card\"\n }\n ],\n \"created\": \"2022-02-15T10:09:55.248918+00:00\",\n \"timestamp\": 1644919795,\n \"user_profile_backgroup_color\": \"#dcdcdc\",\n \"user_profile_background_color\": \"#dcdcdc\",\n \"user_display_pic\": null,\n \"sentence_html\": \"@jane deleted Field PIN under credit card tab\"\n }\n]"}],"_postman_id":"2453d297-d349-43c1-b4a8-1bd73b0801c8"}],"id":"57c3274f-2da7-4cbd-9fac-20276611d77a","_postman_id":"57c3274f-2da7-4cbd-9fac-20276611d77a","description":""},{"name":"Malware","item":[{"name":"Get List of Malware","id":"3e37e182-0fbb-4625-b846-1d3369d7e32d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/malware/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&status=active","description":"

Retrieve a list of malware from your CFTR application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/malware/?

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` shows the API endpoint to the next page.
`count`	Integer	Total number of malware for activity logs of a component in CFTR.
`results`	List of Objects	Details of the malware for activity logs. Each object provides details of one malware.

Response Parameters | Results Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Description
`unique_id`	String	Unique ID of the malware.
`readable_id`	String	Readable ID of the malware.
`created`	String	Created date of the malware in EPOCH time format.
`modified`	String	Last modified date of the malware in EPOCH time format.
`title`	String	Title of the malware.
`status`	String	Status of the malware.
`is_bookmarked`	Boolean	Shows if the malware is bookmarked or not.
`created_by_data`	Object	Details of the user who created the malware. Details include: username, email, first name, last name, and so on.
`title_display`	String	Title of the malware.
`labels`	Object	Unique IDs of the associated labels.
`labels_data`	Object	Details of the associated labels, such as unique_id, title, color_code, and so on.
`type_data`	Object	Details of the type of malware.
`type`	Object	Type of the malware.
`file_type_data`	Object	Details of malware file type.
`file_type`	Object	Malware file type. For example, exe, bat, dll, zip, and so on_._
`platform_data`	Object	Details of platform affected by the malware.
`platform`	Object	Lists platforms affected by malware. For example, Windows, Windows XP, and so on.

","urlObject":{"path":["malware",""],"host":["{{base_url}}v1"],"query":[{"description":{"content":"

OpenAPI access id

\n","type":"text/plain"},"key":"AccessID","value":"{{open_api_access_id}}"},{"description":{"content":"

openapi Expieres

\n","type":"text/plain"},"key":"Expires","value":"{{expires}}"},{"description":{"content":"

openapi signature

\n","type":"text/plain"},"key":"Signature","value":"{{signature}}"},{"description":{"content":"

Status of Malware. Allowed values: active, inactive

\n","type":"text/plain"},"key":"status","value":"active"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the malware in EPOCH Time format.\nTime Zone must be as per UTC. All malware with creation date later than the entered time will be returned.

\n","type":"text/plain"},"key":"created_date__gte","value":"1658487638"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the malware in EPOCH Time format.\nTime Zone must be as per UTC. All malware with creation date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"created_date__lte","value":"1659092438"},{"disabled":true,"description":{"content":"

[optional] Enter the file type of the malware to filter the result.

\n","type":"text/plain"},"key":"file_type","value":"458faf2f-7579-491d-bb62-0c5cce4254f2"},{"disabled":true,"description":{"content":"

[optional] Enter the first seen time of the malware in EPOCH Time format.\nTime Zone must be as per UTC. All malware with first seen date later than the entered time will be returned.

\n","type":"text/plain"},"key":"first_seen__gte","value":"1627556501"},{"disabled":true,"description":{"content":"

[optional] Enter the first seen time of the malware in EPOCH Time format.\nTime Zone must be as per UTC. All malware with first seen date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"first_seen__lte","value":"1659092501"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID of the label. This parameter retrieves the malware associated with the label.

\n","type":"text/plain"},"key":"labels","value":"f4114a5d-0bdc-416b-a067-77b80b4f1aca"},{"disabled":true,"description":{"content":"

[optional] Enter the last modified time of the malware in EPOCH Time format.\nTime Zone must be as per UTC. All malware with modified date later than the entered time will be returned.

\n","type":"text/plain"},"key":"modified_date__gte","value":"1658487756"},{"disabled":true,"description":{"content":"

[optional] Enter the last modified time of the malware in EPOCH Time format.\nTime Zone must be as per UTC. All malware with modified date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"modified_date__lte","value":"1659092556"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID of a type of the malware. This parameter retrieves the malware by the type.

\n","type":"text/plain"},"key":"type","value":"835d8e8f-7368-451d-98e9-48df4d46a44c"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID of the affected platform of the malware.

\n","type":"text/plain"},"key":"platform","value":"4329f857-74cb-4c03-9584-d4df3da7ac4a"}],"variable":[]}},"response":[{"id":"6f5b6909-ca48-48f7-a817-ccdb0acf9965","name":"Get List of Malwares","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/malware/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["malware",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 28 Jun 2022 07:01:47 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"23303","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {\n \"next\": \"openapi/v1/malware/?page=2&page_size=10&AccessID=4c5fde40-92fc-4156-80b2-975c77041b5c&Expires=1656399721&Signature=tUlgiRDOu4VPSsG5IXRJRAP/tVs=\"\n },\n \"count\": 2367,\n \"results\": [\n {\n \"unique_id\": \"782049e8-75ff-4478-9cc2-90bf03ff4fd7\",\n \"readable_id\": \"MLW2502\",\n \"created\": \"2022-06-20T05:20:49.468928Z\",\n \"modified\": \"2022-06-20T05:20:49.541298Z\",\n \"title\": \"New Malware on 20/06/2022: 10:50\",\n \"status\": \"active\",\n \"is_bookmarked\": false,\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"title_display\": \"New Malware on 20/06/2022: 10:50\",\n \"labels\": [\n \"8ccb6c69-58d2-4a0d-86d3-db65c082cde3\",\n \"4163ee22-5617-4eb0-948a-283d4c5067c7\",\n \"a8c221a4-6840-42da-b1f2-f57cf9a2bcdd\",\n \"0a01d6d1-729e-4940-8c80-9fa7f202e69e\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"8ccb6c69-58d2-4a0d-86d3-db65c082cde3\",\n \"title\": \"mlw-6\",\n \"color_code\": \"#ffffff\",\n \"created\": \"2021-01-22T05:31:10.971418Z\",\n \"modified\": \"2021-01-22T05:31:10.971418Z\"\n },\n {\n \"unique_id\": \"4163ee22-5617-4eb0-948a-283d4c5067c7\",\n \"title\": \"mlw-5\",\n \"color_code\": \"#ffffff\",\n \"created\": \"2021-01-22T05:31:09.218177Z\",\n \"modified\": \"2021-01-22T05:31:09.218177Z\"\n },\n {\n \"unique_id\": \"a8c221a4-6840-42da-b1f2-f57cf9a2bcdd\",\n \"title\": \"mlw-2\",\n \"color_code\": \"#ffffff\",\n \"created\": \"2021-01-22T05:30:33.584561Z\",\n \"modified\": \"2021-01-22T05:30:33.584561Z\"\n },\n {\n \"unique_id\": \"0a01d6d1-729e-4940-8c80-9fa7f202e69e\",\n \"title\": \"mlw-3\",\n \"color_code\": \"#ffffff\",\n \"created\": \"2021-01-22T05:31:05.837503Z\",\n \"modified\": \"2021-01-22T05:31:05.837503Z\"\n }\n ],\n \"type_data\": [\n {\n \"unique_id\": \"abb93a96-37ef-4a76-8937-ff960aef947d\",\n \"option_name\": \"Destructive\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"1ecfc252-6c39-4dba-b1be-eda236dfcba4\",\n \"option_name\": \"Ransomware\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"17a617c1-8e8b-4381-9533-8071750e7d29\",\n \"option_name\": \"Trojan\",\n \"is_active\": true,\n \"order\": 5,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"4aff58ab-d394-4145-bac1-4ada8b8c3a8e\",\n \"option_name\": \"Worm\",\n \"is_active\": true,\n \"order\": 6,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"type\": [\n \"Destructive\",\n \"Ransomware\",\n \"Trojan\",\n \"Worm\"\n ],\n \"file_type_data\": [],\n \"file_type\": [],\n \"platform_data\": [\n {\n \"unique_id\": \"32d39572-92e3-42ab-8949-cbe15745cfd5\",\n \"option_name\": \"Windows Server 2k12\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"43e5e63f-9623-4b89-b670-21650dbc8518\",\n \"option_name\": \"Windows XP\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"7c8caab9-ee10-4bf0-8f55-f73e55c35c07\",\n \"option_name\": \"Linux\",\n \"is_active\": true,\n \"order\": 5,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"e2fd9095-84af-4a3b-9dbb-cc083e3054da\",\n \"option_name\": \"Mac\",\n \"is_active\": true,\n \"order\": 6,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"platform\": [\n \"Windows Server 2k12\",\n \"Windows XP\",\n \"Linux\",\n \"Mac\"\n ]\n },\n {\n \"unique_id\": \"9b6d4ff8-ef4f-400b-b53b-6db63c8cd3b4\",\n \"readable_id\": \"MLW2500\",\n \"created\": \"2022-01-20T23:04:40.483598Z\",\n \"modified\": \"2022-06-16T12:06:46.772999Z\",\n \"title\": \"Cyware Test#222 - 8/21/2018 8:00 AM\",\n \"status\": \"inactive\",\n \"is_bookmarked\": false,\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"title_display\": \"Cyware Test#222 - 8/21/2018 8:00 AM\",\n \"labels\": [\n \"82654464-91fc-4a06-9b16-e77c8ba105f4\",\n \"f4114a5d-0bdc-416b-a067-77b80b4f1aca\",\n \"a8c221a4-6840-42da-b1f2-f57cf9a2bcdd\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"82654464-91fc-4a06-9b16-e77c8ba105f4\",\n \"title\": \"mlw-1\",\n \"color_code\": \"#340707\",\n \"created\": \"2021-01-22T05:30:31.850795Z\",\n \"modified\": \"2022-06-10T13:22:32.471464Z\"\n },\n {\n \"unique_id\": \"f4114a5d-0bdc-416b-a067-77b80b4f1aca\",\n \"title\": \"Malware\",\n \"color_code\": \"#43B9D1\",\n \"created\": \"2019-11-27T11:57:24.814602Z\",\n \"modified\": \"2019-11-27T11:57:24.815138Z\"\n },\n {\n \"unique_id\": \"a8c221a4-6840-42da-b1f2-f57cf9a2bcdd\",\n \"title\": \"mlw-2\",\n \"color_code\": \"#ffffff\",\n \"created\": \"2021-01-22T05:30:33.584561Z\",\n \"modified\": \"2021-01-22T05:30:33.584561Z\"\n }\n ],\n \"type_data\": [\n {\n \"unique_id\": \"b2eb3b18-33b2-4863-a029-90688ba1c95f\",\n \"option_name\": \"Botnet\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"abb93a96-37ef-4a76-8937-ff960aef947d\",\n \"option_name\": \"Destructive\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"835d8e8f-7368-451d-98e9-48df4d46a44c\",\n \"option_name\": \"Exploit Kit\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"type\": [\n \"Botnet\",\n \"Destructive\",\n \"Exploit Kit\"\n ],\n \"file_type_data\": [],\n \"file_type\": [],\n \"platform_data\": [\n {\n \"unique_id\": \"d40c3a1d-b6d3-4990-8a30-cf36ccb0d992\",\n \"option_name\": \"Windows 10\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"platform\": [\n \"Windows 10\"\n ]\n },\n {\n \"unique_id\": \"8dc12a67-faea-4dae-8a9a-03f26ccf58e6\",\n \"readable_id\": \"MLW2441\",\n \"created\": \"2021-03-18T08:24:31.858845Z\",\n \"modified\": \"2022-06-03T07:35:02.086973Z\",\n \"title\": \"New Malware #1941 18/03/2021 01:54:19 PM\",\n \"status\": \"active\",\n \"is_bookmarked\": false,\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"title_display\": \"New Malware #1941 18/03/2021 01:54:19 PM\",\n \"labels\": [\n \"82654464-91fc-4a06-9b16-e77c8ba105f4\",\n \"a8c221a4-6840-42da-b1f2-f57cf9a2bcdd\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"82654464-91fc-4a06-9b16-e77c8ba105f4\",\n \"title\": \"mlw-1\",\n \"color_code\": \"#340707\",\n \"created\": \"2021-01-22T05:30:31.850795Z\",\n \"modified\": \"2022-06-10T13:22:32.471464Z\"\n },\n {\n \"unique_id\": \"a8c221a4-6840-42da-b1f2-f57cf9a2bcdd\",\n \"title\": \"mlw-2\",\n \"color_code\": \"#ffffff\",\n \"created\": \"2021-01-22T05:30:33.584561Z\",\n \"modified\": \"2021-01-22T05:30:33.584561Z\"\n }\n ],\n \"type_data\": [\n {\n \"unique_id\": \"1ecfc252-6c39-4dba-b1be-eda236dfcba4\",\n \"option_name\": \"Ransomware\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"abb93a96-37ef-4a76-8937-ff960aef947d\",\n \"option_name\": \"Destructive\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"type\": [\n \"Ransomware\",\n \"Destructive\"\n ],\n \"file_type_data\": [],\n \"file_type\": [],\n \"platform_data\": [\n {\n \"unique_id\": \"e2fd9095-84af-4a3b-9dbb-cc083e3054da\",\n \"option_name\": \"Mac\",\n \"is_active\": true,\n \"order\": 6,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"db8785a4-5dc2-4c1f-8647-d9bf4411ae42\",\n \"option_name\": \"Windows 7\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"platform\": [\n \"Mac\",\n \"Windows 7\"\n ]\n },\n {\n \"unique_id\": \"c71defcd-329f-40ed-87ac-43958b6b1116\",\n \"readable_id\": \"MLW2501\",\n \"created\": \"2022-06-02T06:36:23.670437Z\",\n \"modified\": \"2022-06-02T06:36:23.760691Z\",\n \"title\": \"⚠️ Malware\",\n \"status\": \"active\",\n \"is_bookmarked\": false,\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"title_display\": \"⚠️ Malware\",\n \"labels\": [],\n \"labels_data\": [],\n \"type_data\": [\n {\n \"unique_id\": \"abb93a96-37ef-4a76-8937-ff960aef947d\",\n \"option_name\": \"Destructive\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"type\": [\n \"Destructive\"\n ],\n \"file_type_data\": [],\n \"file_type\": [],\n \"platform_data\": [\n {\n \"unique_id\": \"4329f857-74cb-4c03-9584-d4df3da7ac4a\",\n \"option_name\": \"Windows Server 2k8\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"platform\": [\n \"Windows Server 2k8\"\n ]\n },\n {\n \"unique_id\": \"8a167249-2c12-4440-9fa3-d231c7c25a1a\",\n \"readable_id\": \"MLW2498\",\n \"created\": \"2021-11-26T06:09:17.320626Z\",\n \"modified\": \"2022-05-31T12:37:20.548043Z\",\n \"title\": \"New Malware on 26/11/2021: 11:38.\",\n \"status\": \"active\",\n \"is_bookmarked\": false,\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"title_display\": \"New Malware on 26/11/2021: 11:38.\",\n \"labels\": [\n \"a439317e-60a5-4971-8723-9d676657b46d\",\n \"d3ad59c3-8c64-45c1-a66e-c469e4c7b305\",\n \"4163ee22-5617-4eb0-948a-283d4c5067c7\",\n \"f4114a5d-0bdc-416b-a067-77b80b4f1aca\",\n \"a8c221a4-6840-42da-b1f2-f57cf9a2bcdd\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"a439317e-60a5-4971-8723-9d676657b46d\",\n \"title\": \"MLW LBL\",\n \"color_code\": \"#A3E9AA\",\n \"created\": \"2019-09-17T08:15:09.163036Z\",\n \"modified\": \"2019-09-17T08:15:09.163558Z\"\n },\n {\n \"unique_id\": \"d3ad59c3-8c64-45c1-a66e-c469e4c7b305\",\n \"title\": \"mlw-4\",\n \"color_code\": \"#A31616\",\n \"created\": \"2021-01-22T05:31:07.462573Z\",\n \"modified\": \"2021-03-17T10:18:25.020432Z\"\n },\n {\n \"unique_id\": \"4163ee22-5617-4eb0-948a-283d4c5067c7\",\n \"title\": \"mlw-5\",\n \"color_code\": \"#ffffff\",\n \"created\": \"2021-01-22T05:31:09.218177Z\",\n \"modified\": \"2021-01-22T05:31:09.218177Z\"\n },\n {\n \"unique_id\": \"f4114a5d-0bdc-416b-a067-77b80b4f1aca\",\n \"title\": \"Malware\",\n \"color_code\": \"#43B9D1\",\n \"created\": \"2019-11-27T11:57:24.814602Z\",\n \"modified\": \"2019-11-27T11:57:24.815138Z\"\n },\n {\n \"unique_id\": \"a8c221a4-6840-42da-b1f2-f57cf9a2bcdd\",\n \"title\": \"mlw-2\",\n \"color_code\": \"#ffffff\",\n \"created\": \"2021-01-22T05:30:33.584561Z\",\n \"modified\": \"2021-01-22T05:30:33.584561Z\"\n }\n ],\n \"type_data\": [\n {\n \"unique_id\": \"abb93a96-37ef-4a76-8937-ff960aef947d\",\n \"option_name\": \"Destructive\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"1ecfc252-6c39-4dba-b1be-eda236dfcba4\",\n \"option_name\": \"Ransomware\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"17a617c1-8e8b-4381-9533-8071750e7d29\",\n \"option_name\": \"Trojan\",\n \"is_active\": true,\n \"order\": 5,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"4aff58ab-d394-4145-bac1-4ada8b8c3a8e\",\n \"option_name\": \"Worm\",\n \"is_active\": true,\n \"order\": 6,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"type\": [\n \"Destructive\",\n \"Ransomware\",\n \"Trojan\",\n \"Worm\"\n ],\n \"file_type_data\": [\n {\n \"unique_id\": \"946497d3-2e65-446d-8340-f4daef4f9242\",\n \"option_name\": \"dll\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"c9943cc8-2712-484a-bad8-d11f31034455\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"b05b9472-d628-4d87-b946-ce40265b298a\",\n \"option_name\": \"zip\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"c9943cc8-2712-484a-bad8-d11f31034455\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"file_type\": [\n \"dll\",\n \"zip\"\n ],\n \"platform_data\": [\n {\n \"unique_id\": \"32d39572-92e3-42ab-8949-cbe15745cfd5\",\n \"option_name\": \"Windows Server 2k12\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"db8785a4-5dc2-4c1f-8647-d9bf4411ae42\",\n \"option_name\": \"Windows 7\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"d40c3a1d-b6d3-4990-8a30-cf36ccb0d992\",\n \"option_name\": \"Windows 10\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"7c8caab9-ee10-4bf0-8f55-f73e55c35c07\",\n \"option_name\": \"Linux\",\n \"is_active\": true,\n \"order\": 5,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"platform\": [\n \"Windows Server 2k12\",\n \"Windows 7\",\n \"Windows 10\",\n \"Linux\"\n ]\n },\n {\n \"unique_id\": \"95bca2b9-d182-4e59-bfaf-4564e0d629d8\",\n \"readable_id\": \"MLW2499\",\n \"created\": \"2022-01-15T00:55:47.665266Z\",\n \"modified\": \"2022-01-15T00:55:47.854959Z\",\n \"title\": \"MD5 Blocked via CFTR Incident by Analyst\",\n \"status\": \"active\",\n \"is_bookmarked\": false,\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"title_display\": \"MD5 Blocked via CFTR Incident by Analyst\",\n \"labels\": [],\n \"labels_data\": [],\n \"type_data\": [\n {\n \"unique_id\": \"abb93a96-37ef-4a76-8937-ff960aef947d\",\n \"option_name\": \"Destructive\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"835d8e8f-7368-451d-98e9-48df4d46a44c\",\n \"option_name\": \"Exploit Kit\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"type\": [\n \"Destructive\",\n \"Exploit Kit\"\n ],\n \"file_type_data\": [],\n \"file_type\": [],\n \"platform_data\": [\n {\n \"unique_id\": \"d40c3a1d-b6d3-4990-8a30-cf36ccb0d992\",\n \"option_name\": \"Windows 10\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"platform\": [\n \"Windows 10\"\n ]\n },\n {\n \"unique_id\": \"f9764516-443e-4a63-bc0d-c2b2f2149cbb\",\n \"readable_id\": \"MLW2496\",\n \"created\": \"2021-11-16T10:57:47.306656Z\",\n \"modified\": \"2021-12-16T09:34:23.626393Z\",\n \"title\": \"Ransom\",\n \"status\": \"active\",\n \"is_bookmarked\": false,\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"title_display\": \"Ransom\",\n \"labels\": [],\n \"labels_data\": [],\n \"type_data\": [\n {\n \"unique_id\": \"abb93a96-37ef-4a76-8937-ff960aef947d\",\n \"option_name\": \"Destructive\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"type\": [\n \"Destructive\"\n ],\n \"file_type_data\": [],\n \"file_type\": [],\n \"platform_data\": [\n {\n \"unique_id\": \"43e5e63f-9623-4b89-b670-21650dbc8518\",\n \"option_name\": \"Windows XP\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"platform\": [\n \"Windows XP\"\n ]\n },\n {\n \"unique_id\": \"08a2e1d1-9cfa-4d15-afe0-0490237f63fc\",\n \"readable_id\": \"MLW2484\",\n \"created\": \"2021-05-05T14:54:59.141876Z\",\n \"modified\": \"2021-11-29T06:25:45.031184Z\",\n \"title\": \"Malware new\",\n \"status\": \"active\",\n \"is_bookmarked\": false,\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"title_display\": \"Malware new\",\n \"labels\": [],\n \"labels_data\": [],\n \"type_data\": [\n {\n \"unique_id\": \"b2eb3b18-33b2-4863-a029-90688ba1c95f\",\n \"option_name\": \"Botnet\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"type\": [\n \"Botnet\"\n ],\n \"file_type_data\": [],\n \"file_type\": [],\n \"platform_data\": [\n {\n \"unique_id\": \"43e5e63f-9623-4b89-b670-21650dbc8518\",\n \"option_name\": \"Windows XP\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"7c8caab9-ee10-4bf0-8f55-f73e55c35c07\",\n \"option_name\": \"Linux\",\n \"is_active\": true,\n \"order\": 5,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"platform\": [\n \"Windows XP\",\n \"Linux\"\n ]\n },\n {\n \"unique_id\": \"0f8c7ec2-908a-4e09-acbd-69f3cee00513\",\n \"readable_id\": \"MLW2489\",\n \"created\": \"2021-09-14T11:55:14.349362Z\",\n \"modified\": \"2021-11-29T06:24:44.201059Z\",\n \"title\": \"Malware #02\",\n \"status\": \"active\",\n \"is_bookmarked\": false,\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"title_display\": \"Malware #02\",\n \"labels\": [],\n \"labels_data\": [],\n \"type_data\": [\n {\n \"unique_id\": \"b2eb3b18-33b2-4863-a029-90688ba1c95f\",\n \"option_name\": \"Botnet\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"abb93a96-37ef-4a76-8937-ff960aef947d\",\n \"option_name\": \"Destructive\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"type\": [\n \"Botnet\",\n \"Destructive\"\n ],\n \"file_type_data\": [],\n \"file_type\": [],\n \"platform_data\": [\n {\n \"unique_id\": \"43e5e63f-9623-4b89-b670-21650dbc8518\",\n \"option_name\": \"Windows XP\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"7c8caab9-ee10-4bf0-8f55-f73e55c35c07\",\n \"option_name\": \"Linux\",\n \"is_active\": true,\n \"order\": 5,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"platform\": [\n \"Windows XP\",\n \"Linux\"\n ]\n },\n {\n \"unique_id\": \"a6a80e6c-a535-45b1-9d25-4cc8e218f33d\",\n \"readable_id\": \"MLW2497\",\n \"created\": \"2021-11-25T11:00:33.040428Z\",\n \"modified\": \"2021-11-25T11:03:49.343484Z\",\n \"title\": \"New Malware on 25/11/2021: 16:30\",\n \"status\": \"active\",\n \"is_bookmarked\": false,\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"title_display\": \"New Malware on 25/11/2021: 16:30\",\n \"labels\": [\n \"a439317e-60a5-4971-8723-9d676657b46d\",\n \"d3ad59c3-8c64-45c1-a66e-c469e4c7b305\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"a439317e-60a5-4971-8723-9d676657b46d\",\n \"title\": \"MLW LBL\",\n \"color_code\": \"#A3E9AA\",\n \"created\": \"2019-09-17T08:15:09.163036Z\",\n \"modified\": \"2019-09-17T08:15:09.163558Z\"\n },\n {\n \"unique_id\": \"d3ad59c3-8c64-45c1-a66e-c469e4c7b305\",\n \"title\": \"mlw-4\",\n \"color_code\": \"#A31616\",\n \"created\": \"2021-01-22T05:31:07.462573Z\",\n \"modified\": \"2021-03-17T10:18:25.020432Z\"\n }\n ],\n \"type_data\": [\n {\n \"unique_id\": \"abb93a96-37ef-4a76-8937-ff960aef947d\",\n \"option_name\": \"Destructive\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"835d8e8f-7368-451d-98e9-48df4d46a44c\",\n \"option_name\": \"Exploit Kit\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"type\": [\n \"Destructive\",\n \"Exploit Kit\"\n ],\n \"file_type_data\": [\n {\n \"unique_id\": \"b05b9472-d628-4d87-b946-ce40265b298a\",\n \"option_name\": \"zip\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"c9943cc8-2712-484a-bad8-d11f31034455\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"file_type\": [\n \"zip\"\n ],\n \"platform_data\": [\n {\n \"unique_id\": \"32d39572-92e3-42ab-8949-cbe15745cfd5\",\n \"option_name\": \"Windows Server 2k12\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"43e5e63f-9623-4b89-b670-21650dbc8518\",\n \"option_name\": \"Windows XP\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"platform\": [\n \"Windows Server 2k12\",\n \"Windows XP\"\n ]\n }\n ]\n}"}],"_postman_id":"3e37e182-0fbb-4625-b846-1d3369d7e32d"},{"name":"Get Details of Malware","id":"5c922f46-5874-4c28-81ff-eb455037f1a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/malware/:malware_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the details of a specific malware from the CFTR application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/malware/:malware_unique_id/?

Response Parameters

Response Parameters | Regulatory Fields

Parameters	Type	Description
`type`	Object	Type of the malware.
`ioc_email`	Object	Unique IDs of the email IOC type.
`platform`	Object	List of affected platforms.
`ioc_ip`	Object	Unique IDs of the IP IOC type.
`ioc_md5`	Object	Unique IDs of the MD5 Hash IOC type.
`file_type`	Object	File types of the malware. For example, dll, exe, docx, zip.
`ioc_domain`	Object	Unique IDs of the domain IOC type.
`ioc_sha1`	Object	Unique IDs of the SHA1 IOC type.
`ioc_sha256`	Object	Unique IDs of the SHA256 IOC type.
`ioc_url`	Object	Unique IDs of the URL IOC type.
`unique_id`	String	Unique ID of the malware.
`readable_id`	String	Readable ID of the malware.
`created`	String	Created date of the malware in EPOCH time format.
`modified`	String	Last modified date of the malware in EPOCH time format.
`title`	String	Title of the malware.
`description`	String	Description of the malware.
`incidents`	Object	Unique ID of the linked incidents.
`status`	String	Status of the malware.
`briefings`	Object	Unique ID of the linked threat briefings.
`briefings_data`	Object	Details of the linked threat briefings.
`incidents_data`	Object	Details of the linked incidents.
`is_bookmarked`	Boolean	Shows if the malware is bookmarked or not.
`actions_data`	Object	Details of the linked actions.
`campaigns`	Object	Unique ID of the linked campaigns.
`campaigns_data`	Object	Details of the linked campaigns.
`vulnerabilities`	Object	Unique ID of the linked vulnerabilities.
`vulnerabilities_data`	Object	Details of the linked vulnerabilities.
`threat_actors`	Object	Unique ID of the linked threat actors.
`threat_actors_data`	Object	Details of the linked threat actors.
`pirs_data`	Object	Details of the linked PIRs.
`attachments_data`	Object	Details of the attachments.
`created_by_data`	Object	Details of the user who created the malware. Details include: username, email, first name, last name, and so on.
`labels`	Object	Unique ID of the linked labels.
`labels_data`	Object	Details of the linked labels.
`tactic_technique_pair_data`	Object	Details of the linked tactic technique pairs.
`first_seen`	String	Date on which malware is seen for the first time.
`last_modified`	Object	Last modified date of the malware.
`applications`	Object	Unique ID of the linked applications.
`applications_data`	Object	Details of the linked applications.
`asset_softwares`	Object	Unique ID of the linked software.
`asset_softwares_data`	Object	Details of the Linked Asset Softwares.
`endpoints`	Object	Unique ID of the linked devices.
`endpoints_data`	Object	Details of the linked devices.
`enhancements`	Object	Unique ID of the linked enhancements.
`enhancements_data`	Object	Details of the linked enhancements.
`type_data`	Object	Details of the malware type.
`file_type_data`	Object	Details of the malware file type.
`platform_data`	Object	Details of the affected platforms.

","urlObject":{"path":["malware",":malware_unique_id",""],"host":["{{base_url}}v1"],"query":[{"description":{"content":"

Descrip

\n","type":"text/plain"},"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"type":"any","value":"4cd80798-4520-4724-be03-da6552ded9eb","key":"malware_unique_id"}]}},"response":[{"id":"e5490919-d5d0-468b-a599-54a91faf2041","name":"Get Details of Malware","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/malware/782049e8-75ff-4478-9cc2-90bf03ff4fd7/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["malware","782049e8-75ff-4478-9cc2-90bf03ff4fd7",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}","description":"Descrip"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 28 Jun 2022 08:15:39 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"5853","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"remediation\": null,\n \"additional_information\": null,\n \"test_malware\": null,\n \"associated_bitcoin_addresses\": null,\n \"file_size\": null,\n \"type\": [\n \"Destructive\",\n \"Ransomware\",\n \"Trojan\",\n \"Worm\"\n ],\n \"ioc_email\": [],\n \"platform\": [\n \"Windows Server 2k12\",\n \"Windows XP\",\n \"Linux\",\n \"Mac\"\n ],\n \"ioc_ip\": [],\n \"ioc_custom_inc_10\": [],\n \"ioc_credit_card\": [],\n \"ioc_malware\": [],\n \"ioc_md5\": [],\n \"ioc_custom_inc_8\": [],\n \"file_type\": [],\n \"ioc_custom_-_sha512\": [],\n \"ioc_domain\": [],\n \"ioc_custom_inc_7\": [],\n \"ioc_custom_indicator\": [],\n \"ioc_test_integration\": [],\n \"ioc_sha1\": [],\n \"ioc_custom_inc_4\": [],\n \"ioc_sha256\": [],\n \"ioc_url\": [],\n \"ioc_autonomous_system\": [],\n \"ioc_mac_addrr\": [],\n \"ioc_custom_inc_9\": [],\n \"ioc_custom_inc_6\": [],\n \"ioc_test_25\": [],\n \"ioc_custom_inc_5\": [],\n \"ioc_test_v6\": [],\n \"unique_id\": \"782049e8-75ff-4478-9cc2-90bf03ff4fd7\",\n \"readable_id\": \"MLW2502\",\n \"created\": \"2022-06-20T05:20:49.468928Z\",\n \"modified\": \"2022-06-20T05:20:49.541298Z\",\n \"title\": \"New Malware on 20/06/2022: 10:50\",\n \"description\": \"

New Malware on 20/06/2022: 10:50

\",\n \"incidents\": [],\n \"status\": \"active\",\n \"briefings\": [],\n \"briefings_data\": [],\n \"incidents_data\": [],\n \"is_bookmarked\": false,\n \"actions_data\": [],\n \"campaigns\": [\n \"d5c6f1a5-bd76-4b96-9cb1-ebccade0a85f\"\n ],\n \"campaigns_data\": [\n {\n \"title\": \"New Campaign For Regression\",\n \"unique_id\": \"d5c6f1a5-bd76-4b96-9cb1-ebccade0a85f\",\n \"readable_id\": \"CMP1413\",\n \"created\": \"2022-06-28T07:42:49.468474Z\",\n \"modified\": \"2022-06-28T07:56:44.782292Z\",\n \"title_display\": \"New Campaign For Regression\",\n \"status\": \"INACTIVE\"\n }\n ],\n \"vulnerabilities\": [],\n \"vulnerabilities_data\": [],\n \"threat_actors\": [],\n \"threat_actors_data\": [],\n \"pirs_data\": [],\n \"attachments_data\": [],\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"title_display\": \"New Malware on 20/06/2022: 10:50\",\n \"labels\": [\n \"8ccb6c69-58d2-4a0d-86d3-db65c082cde3\",\n \"4163ee22-5617-4eb0-948a-283d4c5067c7\",\n \"a8c221a4-6840-42da-b1f2-f57cf9a2bcdd\",\n \"0a01d6d1-729e-4940-8c80-9fa7f202e69e\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"8ccb6c69-58d2-4a0d-86d3-db65c082cde3\",\n \"title\": \"mlw-6\",\n \"color_code\": \"#ffffff\",\n \"created\": \"2021-01-22T05:31:10.971418Z\",\n \"modified\": \"2021-01-22T05:31:10.971418Z\"\n },\n {\n \"unique_id\": \"4163ee22-5617-4eb0-948a-283d4c5067c7\",\n \"title\": \"mlw-5\",\n \"color_code\": \"#ffffff\",\n \"created\": \"2021-01-22T05:31:09.218177Z\",\n \"modified\": \"2021-01-22T05:31:09.218177Z\"\n },\n {\n \"unique_id\": \"a8c221a4-6840-42da-b1f2-f57cf9a2bcdd\",\n \"title\": \"mlw-2\",\n \"color_code\": \"#ffffff\",\n \"created\": \"2021-01-22T05:30:33.584561Z\",\n \"modified\": \"2021-01-22T05:30:33.584561Z\"\n },\n {\n \"unique_id\": \"0a01d6d1-729e-4940-8c80-9fa7f202e69e\",\n \"title\": \"mlw-3\",\n \"color_code\": \"#ffffff\",\n \"created\": \"2021-01-22T05:31:05.837503Z\",\n \"modified\": \"2021-01-22T05:31:05.837503Z\"\n }\n ],\n \"tactic_technique_pair_data\": [],\n \"version\": null,\n \"first_seen\": null,\n \"last_modified\": null,\n \"applications\": [],\n \"applications_data\": [],\n \"asset_softwares\": [],\n \"asset_softwares_data\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"enhancements\": [],\n \"enhancements_data\": [],\n \"type_data\": [\n {\n \"unique_id\": \"abb93a96-37ef-4a76-8937-ff960aef947d\",\n \"option_name\": \"Destructive\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"1ecfc252-6c39-4dba-b1be-eda236dfcba4\",\n \"option_name\": \"Ransomware\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"17a617c1-8e8b-4381-9533-8071750e7d29\",\n \"option_name\": \"Trojan\",\n \"is_active\": true,\n \"order\": 5,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"4aff58ab-d394-4145-bac1-4ada8b8c3a8e\",\n \"option_name\": \"Worm\",\n \"is_active\": true,\n \"order\": 6,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"file_type_data\": [],\n \"platform_data\": [\n {\n \"unique_id\": \"32d39572-92e3-42ab-8949-cbe15745cfd5\",\n \"option_name\": \"Windows Server 2k12\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"43e5e63f-9623-4b89-b670-21650dbc8518\",\n \"option_name\": \"Windows XP\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"7c8caab9-ee10-4bf0-8f55-f73e55c35c07\",\n \"option_name\": \"Linux\",\n \"is_active\": true,\n \"order\": 5,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"e2fd9095-84af-4a3b-9dbb-cc083e3054da\",\n \"option_name\": \"Mac\",\n \"is_active\": true,\n \"order\": 6,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"ioc_ip_data\": [],\n \"ioc_domain_data\": [],\n \"ioc_url_data\": [],\n \"ioc_email_data\": [],\n \"ioc_md5_data\": [],\n \"ioc_sha1_data\": [],\n \"ioc_sha256_data\": [],\n \"ioc_custom_inc_10_data\": [],\n \"ioc_custom_inc_8_data\": [],\n \"ioc_custom_inc_7_data\": [],\n \"ioc_custom_inc_9_data\": [],\n \"ioc_custom_inc_5_data\": [],\n \"ioc_custom_inc_4_data\": [],\n \"ioc_credit_card_data\": [],\n \"ioc_custom_inc_6_data\": [],\n \"ioc_malware_data\": [],\n \"ioc_test_integration_data\": [],\n \"ioc_test_v6_data\": [],\n \"ioc_test_25_data\": [],\n \"ioc_autonomous_system_data\": [],\n \"ioc_custom_indicator_data\": [],\n \"ioc_custom_-_sha512_data\": [],\n \"ioc_mac_addrr_data\": []\n}"}],"_postman_id":"5c922f46-5874-4c28-81ff-eb455037f1a3"},{"name":"Create Malware Using Field UUID","id":"7128e334-52e8-4734-91ff-21727aa85c0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": [\n \"Destructive\",\n \"Ransomware\",\n \"Trojan\",\n \"Worm\"\n ],\n \"ioc_email\": [],\n \"platform\": [\n \"Windows Server 2k12\",\n \"Windows XP\",\n \"Linux\",\n \"Mac\"\n ],\n \"ioc_ip\": [],\n \"ioc_malware\": [],\n \"ioc_md5\": [],\n \"file_type\": [],\n \"ioc_domain\": [],\n \"ioc_sha1\": [],\n \"ioc_sha256\": [],\n \"ioc_url\": [],\n \"title\": \"New Malware on 20/06/2022: 10:50\",\n \"description\": \"

New Malware on 20/06/2022: 10:50

\",\n \"incidents\": [],\n \"status\": \"active\",\n \"briefings\": [],\n \"is_bookmarked\": true,\n \"vulnerabilities\": [],\n \"threat_actors\": [],\n \"title_display\": \"New Malware on 20/06/2022: 10:50\",\n \"tactic_technique_pair\": [],\n \"version\": null,\n \"first_seen\": null,\n \"applications\": [],\n \"asset_softwares\": [],\n \"endpoints\": [],\n \"enhancements\": []\n}"},"url":"{{base_url}}v1/malware/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Add a new malware in the CFTR application using Field UUIDs.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/malware/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`title`	String	Mandatory	Enter a title for the malware.
`description`	Text	Optional	Enter a description of the malware.
`status`	String	Optional	Enter the status of the malware. Allowed values: - active - inactive Default value: active
`type`	List	Mandatory	Enter the list of the types of the malware.
`first_seen`	String	Optional	Enter the date on which the malware was first seen.
`platform`	List	Mandatory	Enter the unique IDs of the affected platforms.
`labels`	List	Optional	Enter the unique IDs of the labels.
`tactic_technique_pair`	List	Optional	Enter the tactic technique pair used by the malware.

Request Parameters | Custom Form Fields

In addition to the above mentioned parameters, the request parameters may vary as per the form configuration defined by your CFTR admin for malware. For such parameters, use the field_readable_key of each parameter. To retrieve the field_readable_key and additional metadata of a parameter, use the Form Tab Structure API for malware.

Example

The following endpoint retrieves the field_readable_key for all custom fields in the malware component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=malware\n\n

Following are some of the sample custom fields for malware:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters

Response Parameters | Regulatory Fields

Parameters	Type	Description
`type`	Object	Type of the malware.
`ioc_email`	Object	Unique IDs of the email IOC type.
`platform`	Object	Platforms affected by malware.
`ioc_ip`	Object	Unique IDs of the IP IOC type.
`ioc_md5`	Object	Unique IDs of the MD5 Hash IOC type.
`file_type`	Object	File types of the malware. For example, dll, exe, docx, zip.
`ioc_domain`	Object	Unique IDs of the domain IOC type.
`ioc_sha1`	Object	Unique IDs of the SHA1 IOC type.
`ioc_sha256`	Object	Unique IDs of the SHA256 IOC type.
`ioc_url`	Object	Unique IDs of the URL IOC type.
`unique_id`	String	Unique ID of the malware.
`readable_id`	String	Readable ID of the malware.
`created`	String	Created date of the malware in EPOCH time format.
`modified`	String	Last modified date of the malware in EPOCH time format.
`title`	String	The title of the malware.
`description`	String	Description of the malware.
`incidents`	Object	Unique IDs of the linked incidents.
`status`	String	Status of the malware.
`briefings`	Object	Unique ID of the linked threat briefings.
`briefings_data`	Object	Details of the linked threat briefings.
`incidents_data`	Object	Details of the linked incidents.
`is_bookmarked`	Boolean	Shows if the malware is bookmarked or not.
`actions_data`	Object	Details of the linked actions.
`campaigns`	Object	Unique ID of the linked campaigns.
`campaigns_data`	Object	Details of the linked campaigns.
`vulnerabilities`	Object	Unique ID of the linked vulnerabilities.
`vulnerabilities_data`	Object	Details of the linked vulnerabilities.
`threat_actors`	Object	Unique ID of the linked threat actors.
`threat_actors_data`	Object	Details of the linked threat actors.
`pirs_data`	Object	Details of the linked PIRs.
`attachments_data`	Object	Details of the linked attachments.
`created_by_data`	Object	Details of the user who created the malware. Details include: username, email, first name, last name, and so on.
`labels`	Object	Unique ID of the linked labels.
`labels_data`	Object	Details of the linked labels.
`tactic_technique_pair_data`	Object	Details of the linked Tactic Technique pairs.
`first_seen`	String	Date on which malware is seen for the first time.
`last_modified`	Object	Last modified date of the malware.
`applications`	Object	Unique ID of the linked applications.
`applications_data`	Object	Details of the linked applications.
`asset_softwares`	Object	Unique ID of the linked software.
`asset_softwares_data`	Object	Linked Asset Software(s) data
`endpoints`	Object	Unique ID of the linked devices.
`endpoints_data`	Object	Details of the linked devices.
`enhancements`	Object	Unique ID of the linked enhancements.
`enhancements_data`	Object	Details of the linked enhancements.
`type_data`	Object	Details of the malware type.
`file_type_data`	Object	Details of the malware file type.
`platform_data`	Object	Details of the affected platforms.

","urlObject":{"path":["malware",""],"host":["{{base_url}}v1"],"query":[{"description":{"content":"

Descrip

\n","type":"text/plain"},"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"708073d7-da47-4e2d-be7c-e24516a32f0a","name":"201 Created: Create Malware","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": [\n \"Destructive\",\n \"Ransomware\",\n \"Trojan\",\n \"Worm\"\n ],\n \"ioc_email\": [],\n \"platform\": [\n \"Windows Server 2k12\",\n \"Windows XP\",\n \"Linux\",\n \"Mac\"\n ],\n \"ioc_ip\": [],\n \"ioc_malware\": [],\n \"ioc_md5\": [],\n \"file_type\": [],\n \"ioc_domain\": [],\n \"ioc_sha1\": [],\n \"ioc_sha256\": [],\n \"ioc_url\": [],\n \"title\": \"New Malware on 20/06/2022: 10:50\",\n \"description\": \"

New Malware on 20/06/2022: 10:50

\",\n \"incidents\": [],\n \"status\": \"active\",\n \"briefings\": [],\n \"is_bookmarked\": true,\n \"campaigns\": [\n \"d5c6f1a5-bd76-4b96-9cb1-ebccade0a85f\"\n ],\n \"vulnerabilities\": [],\n \"threat_actors\": [],\n \"title_display\": \"New Malware on 20/06/2022: 10:50\",\n \"labels\": [\n \"8ccb6c69-58d2-4a0d-86d3-db65c082cde3\",\n \"4163ee22-5617-4eb0-948a-283d4c5067c7\",\n \"a8c221a4-6840-42da-b1f2-f57cf9a2bcdd\",\n \"0a01d6d1-729e-4940-8c80-9fa7f202e69e\"\n ],\n \"tactic_technique_pair\": [],\n \"version\": null,\n \"first_seen\": null,\n \"applications\": [],\n \"asset_softwares\": [],\n \"endpoints\": [],\n \"enhancements\": []\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/malware/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["malware",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}","description":"Descrip"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 28 Jun 2022 12:28:48 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"5865","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"remediation\": null,\n \"additional_information\": null,\n \"test_malware\": null,\n \"associated_bitcoin_addresses\": null,\n \"file_size\": null,\n \"type\": [\n \"Destructive\",\n \"Ransomware\",\n \"Trojan\",\n \"Worm\"\n ],\n \"ioc_email\": [],\n \"platform\": [\n \"Windows Server 2k12\",\n \"Windows XP\",\n \"Linux\",\n \"Mac\"\n ],\n \"ioc_ip\": [],\n \"ioc_custom_inc_10\": [],\n \"ioc_credit_card\": [],\n \"ioc_malware\": [],\n \"ioc_md5\": [],\n \"ioc_custom_inc_8\": [],\n \"file_type\": [],\n \"ioc_custom_-_sha512\": [],\n \"ioc_domain\": [],\n \"ioc_custom_inc_7\": [],\n \"ioc_custom_indicator\": [],\n \"ioc_test_integration\": [],\n \"ioc_sha1\": [],\n \"ioc_custom_inc_4\": [],\n \"ioc_sha256\": [],\n \"ioc_url\": [],\n \"ioc_autonomous_system\": [],\n \"ioc_mac_addrr\": [],\n \"ioc_custom_inc_9\": [],\n \"ioc_custom_inc_6\": [],\n \"ioc_test_25\": [],\n \"ioc_custom_inc_5\": [],\n \"ioc_test_v6\": [],\n \"unique_id\": \"4c2567e8-d361-45a6-9ccb-241376bcea14\",\n \"readable_id\": \"MLW2505\",\n \"created\": \"2022-06-28T12:28:47.142601Z\",\n \"modified\": \"2022-06-28T12:28:47.425131Z\",\n \"title\": \"New Malware on 20/06/2022: 10:50\",\n \"description\": \"

New Malware on 20/06/2022: 10:50

\",\n \"incidents\": [],\n \"status\": \"active\",\n \"briefings\": [],\n \"briefings_data\": [],\n \"incidents_data\": [],\n \"is_bookmarked\": false,\n \"actions_data\": [],\n \"campaigns\": [\n \"d5c6f1a5-bd76-4b96-9cb1-ebccade0a85f\"\n ],\n \"campaigns_data\": [\n {\n \"title\": \"New Campaign For Regression\",\n \"unique_id\": \"d5c6f1a5-bd76-4b96-9cb1-ebccade0a85f\",\n \"readable_id\": \"CMP1413\",\n \"created\": \"2022-06-28T07:42:49.468474Z\",\n \"modified\": \"2022-06-28T07:56:44.782292Z\",\n \"title_display\": \"New Campaign For Regression\",\n \"status\": \"INACTIVE\"\n }\n ],\n \"vulnerabilities\": [],\n \"vulnerabilities_data\": [],\n \"threat_actors\": [],\n \"threat_actors_data\": [],\n \"pirs_data\": [],\n \"attachments_data\": [],\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"title_display\": \"New Malware on 20/06/2022: 10:50\",\n \"labels\": [\n \"8ccb6c69-58d2-4a0d-86d3-db65c082cde3\",\n \"4163ee22-5617-4eb0-948a-283d4c5067c7\",\n \"a8c221a4-6840-42da-b1f2-f57cf9a2bcdd\",\n \"0a01d6d1-729e-4940-8c80-9fa7f202e69e\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"8ccb6c69-58d2-4a0d-86d3-db65c082cde3\",\n \"title\": \"mlw-6\",\n \"color_code\": \"#ffffff\",\n \"created\": \"2021-01-22T05:31:10.971418Z\",\n \"modified\": \"2021-01-22T05:31:10.971418Z\"\n },\n {\n \"unique_id\": \"4163ee22-5617-4eb0-948a-283d4c5067c7\",\n \"title\": \"mlw-5\",\n \"color_code\": \"#ffffff\",\n \"created\": \"2021-01-22T05:31:09.218177Z\",\n \"modified\": \"2021-01-22T05:31:09.218177Z\"\n },\n {\n \"unique_id\": \"a8c221a4-6840-42da-b1f2-f57cf9a2bcdd\",\n \"title\": \"mlw-2\",\n \"color_code\": \"#ffffff\",\n \"created\": \"2021-01-22T05:30:33.584561Z\",\n \"modified\": \"2021-01-22T05:30:33.584561Z\"\n },\n {\n \"unique_id\": \"0a01d6d1-729e-4940-8c80-9fa7f202e69e\",\n \"title\": \"mlw-3\",\n \"color_code\": \"#ffffff\",\n \"created\": \"2021-01-22T05:31:05.837503Z\",\n \"modified\": \"2021-01-22T05:31:05.837503Z\"\n }\n ],\n \"tactic_technique_pair_data\": [],\n \"version\": null,\n \"first_seen\": null,\n \"last_modified\": null,\n \"applications\": [],\n \"applications_data\": [],\n \"asset_softwares\": [],\n \"asset_softwares_data\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"enhancements\": [],\n \"enhancements_data\": [],\n \"type_data\": [\n {\n \"unique_id\": \"abb93a96-37ef-4a76-8937-ff960aef947d\",\n \"option_name\": \"Destructive\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"1ecfc252-6c39-4dba-b1be-eda236dfcba4\",\n \"option_name\": \"Ransomware\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"17a617c1-8e8b-4381-9533-8071750e7d29\",\n \"option_name\": \"Trojan\",\n \"is_active\": true,\n \"order\": 5,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"4aff58ab-d394-4145-bac1-4ada8b8c3a8e\",\n \"option_name\": \"Worm\",\n \"is_active\": true,\n \"order\": 6,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"file_type_data\": [],\n \"platform_data\": [\n {\n \"unique_id\": \"32d39572-92e3-42ab-8949-cbe15745cfd5\",\n \"option_name\": \"Windows Server 2k12\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"43e5e63f-9623-4b89-b670-21650dbc8518\",\n \"option_name\": \"Windows XP\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"7c8caab9-ee10-4bf0-8f55-f73e55c35c07\",\n \"option_name\": \"Linux\",\n \"is_active\": true,\n \"order\": 5,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"e2fd9095-84af-4a3b-9dbb-cc083e3054da\",\n \"option_name\": \"Mac\",\n \"is_active\": true,\n \"order\": 6,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"ioc_ip_data\": [],\n \"ioc_domain_data\": [],\n \"ioc_url_data\": [],\n \"ioc_email_data\": [],\n \"ioc_md5_data\": [],\n \"ioc_sha1_data\": [],\n \"ioc_sha256_data\": [],\n \"ioc_custom_inc_10_data\": [],\n \"ioc_custom_inc_8_data\": [],\n \"ioc_custom_inc_7_data\": [],\n \"ioc_custom_inc_9_data\": [],\n \"ioc_custom_inc_5_data\": [],\n \"ioc_custom_inc_4_data\": [],\n \"ioc_credit_card_data\": [],\n \"ioc_custom_inc_6_data\": [],\n \"ioc_malware_data\": [],\n \"ioc_test_integration_data\": [],\n \"ioc_test_v6_data\": [],\n \"ioc_test_25_data\": [],\n \"ioc_autonomous_system_data\": [],\n \"ioc_custom_indicator_data\": [],\n \"ioc_custom_-_sha512_data\": [],\n \"ioc_mac_addrr_data\": []\n}"}],"_postman_id":"7128e334-52e8-4734-91ff-21727aa85c0c"},{"name":"Create Malware Using Field Values","id":"eebdbf4d-1438-45d1-8faf-bf09f4687010","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": [\n \"Destructive\",\n \"Ransomware\",\n \"Trojan\",\n \"Worm\"\n ],\n \"ioc_email\": [],\n \"platform\": [\n \"Windows Server 2k12\",\n \"Windows XP\",\n \"Linux\",\n \"Mac\"\n ],\n \"ioc_ip\": [],\n \"ioc_malware\": [],\n \"ioc_md5\": [],\n \"file_type\": [],\n \"ioc_domain\": [],\n \"ioc_sha1\": [],\n \"ioc_sha256\": [],\n \"ioc_url\": [],\n \"title\": \"New Malware on 20/06/2022: 10:50\",\n \"description\": \"

New Malware on 20/06/2022: 10:50

\",\n \"incidents\": [],\n \"status\": \"active\",\n \"briefings\": [],\n \"is_bookmarked\": true,\n \"vulnerabilities\": [],\n \"threat_actors\": [],\n \"title_display\": \"New Malware on 20/06/2022: 10:50\",\n \"tactic_technique_pair\": [],\n \"version\": null,\n \"first_seen\": null,\n \"applications\": [],\n \"asset_softwares\": [],\n \"endpoints\": [],\n \"enhancements\": []\n}"},"url":"{{base_url}}v1/malware/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","description":"

Add a new malware in the CFTR application using the field values.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/malware/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`title`	String	Mandatory	Enter a title for the malware.
`description`	Text	Optional	Enter a description for the malware.
`status`	String	Optional	Enter the status of the malware. Allowed values: - active - inactive Default value: active
`type`	List	Mandatory	Enter the list of the types of the malware.
`first_seen`	String	Optional	Enter the date on which the malware was first seen.
`platform`	List	Mandatory	Enter the unique IDs of the affected platforms.
`labels`	List	Optional	Enter the names of the labels to associate. You can use the following API endpoint to retrieve the list of Labels: `/openapi/v1/utils/label/`
`tactic_technique_pair`	List	Optional	Enter the tactic technique pair used by the malware.

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the malware component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=malware\n\n

Following are some of the sample custom fields for malware:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters

Response Parameters | Regulatory Fields

Parameters	Type	Description
`type`	Object	Type of the malware.
`ioc_email`	Object	Unique IDs of the email IOC type.
`platform`	Object	Platforms affected by the malware.
`ioc_ip`	Object	Unique IDs of the IP IOC type.
`ioc_md5`	Object	Unique IDs of the MD5 Hash IOC type.
`file_type`	Object	File types of the malware. For example, dll, exe, docx, zip.
`ioc_domain`	Object	Unique IDs of the domain IOC type.
`ioc_sha1`	Object	Unique IDs of the SHA1 IOC type.
`ioc_sha256`	Object	Unique IDs of the SHA256 IOC type.
`ioc_url`	Object	Unique IDs of the URL IOC type.
`unique_id`	String	Unique ID of the malware.
`readable_id`	String	Readable ID of the malware.
`created`	String	Created date of the malware in EPOCH time format.
`modified`	String	Last modified date of the malware in EPOCH time format.
`title`	String	The title of the malware.
`description`	String	Description of the malware.
`incidents`	Object	Unique ID of the linked incidents.
`status`	String	Status of the malware.
`briefings`	Object	Unique ID of the linked threat briefings.
`briefings_data`	Object	Details of the linked threat briefings.
`incidents_data`	Object	Details of the linked incidents.
`is_bookmarked`	Boolean	Shows if the malware is bookmarked or not.
`actions_data`	Object	Details of the linked actions.
`campaigns`	Object	Unique ID of the linked campaigns.
`campaigns_data`	Object	Details of the linked campaigns.
`vulnerabilities`	Object	Unique ID of the linked vulnerabilities.
`vulnerabilities_data`	Object	Details of the linked vulnerabilities.
`threat_actors`	Object	Unique ID of the linked threat actors.
`threat_actors_data`	Object	Details of the linked threat actors.
`pirs_data`	Object	Details of the linked PIRs.
`attachments_data`	Object	Details of the attachments.
`created_by_data`	Object	Details of the user who created the malware. Details include: username, email, first name, last name, and so on.
`labels`	Object	Unique ID of the linked labels.
`labels_data`	Object	Details of the linked labels.
`tactic_technique_pair_data`	Object	Details of the linked Tactic Technique pairs.
`first_seen`	String	Date on which malware is seen for the first time.
`last_modified`	Object	Last modified date of the malware.
`applications`	Object	Unique ID of the linked applications.
`applications_data`	Object	Details of the linked applications.
`asset_softwares`	Object	Unique ID of the linked software.
`asset_softwares_data`	Object	Linked Asset Software(s) data
`endpoints`	Object	Unique ID of the linked devices.
`endpoints_data`	Object	Details of the linked devices.
`enhancements`	Object	Unique ID of the linked enhancements.
`enhancements_data`	Object	Details of the linked enhancements.
`type_data`	Object	Details of the malware type.
`file_type_data`	Object	Details of the malware file type.
`platform_data`	Object	Details of the affected platforms.

","urlObject":{"path":["malware",""],"host":["{{base_url}}v1"],"query":[{"description":{"content":"

Descrip

\n","type":"text/plain"},"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"description":{"content":"

Do not change the parameter value\nAllows you to create malwares using the values of labels.

\n","type":"text/plain"},"key":"values","value":"readable_type"}],"variable":[]}},"response":[{"id":"6d293058-b194-42d7-a77a-be1d3021628e","name":"201 Created: Create Malware Using Field Values","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": [\n \"Destructive\",\n \"Ransomware\",\n \"Trojan\",\n \"Worm\"\n ],\n \"ioc_email\": [],\n \"platform\": [\n \"Windows Server 2k12\",\n \"Windows XP\",\n \"Linux\",\n \"Mac\"\n ],\n \"ioc_ip\": [],\n \"ioc_malware\": [],\n \"ioc_md5\": [],\n \"file_type\": [],\n \"ioc_domain\": [],\n \"ioc_sha1\": [],\n \"ioc_sha256\": [],\n \"ioc_url\": [],\n \"title\": \"New Malware on 20/06/2022: 10:50\",\n \"description\": \"

New Malware on 20/06/2022: 10:50

\",\n \"incidents\": [],\n \"status\": \"active\",\n \"briefings\": [],\n \"is_bookmarked\": true,\n \"vulnerabilities\": [],\n \"threat_actors\": [],\n \"title_display\": \"New Malware on 20/06/2022: 10:50\",\n \"labels\": [\n \"Blue Label Malware\"\n ],\n \"tactic_technique_pair\": [],\n \"version\": null,\n \"first_seen\": null,\n \"applications\": [],\n \"asset_softwares\": [],\n \"endpoints\": [],\n \"enhancements\": []\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/malware/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","host":["{{base_url}}v1"],"path":["malware",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}","description":"Descrip"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"values","value":"readable_type","description":"**Do not change the parameter value**\nAllows you to create malwares using the values of labels."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Apr 2023 08:20:27 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"3878","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"references\": null,\n \"aliases\": null,\n \"file_size\": null,\n \"additional_information\": null,\n \"associated_bitcoin_addresses\": null,\n \"remediation\": null,\n \"zero_day\": null,\n \"type\": [\n \"Destructive\",\n \"Ransomware\",\n \"Trojan\",\n \"Worm\"\n ],\n \"file_type\": [],\n \"platform\": [\n \"Windows Server 2k12\",\n \"Windows XP\",\n \"Linux\",\n \"Mac\"\n ],\n \"ioc_email\": [],\n \"ioc_MD5\": [],\n \"ioc_url\": [],\n \"ioc_SHA256\": [],\n \"ioc_domain\": [],\n \"ioc_SHA1\": [],\n \"ioc_ip\": [],\n \"unique_id\": \"a0f3afb3-4136-4ae1-89fe-1d1f69241138\",\n \"readable_id\": \"MLW101\",\n \"created\": \"2023-04-21T08:20:24.756027Z\",\n \"modified\": \"2023-04-21T08:20:25.689331Z\",\n \"title\": \"New Malware on 20/06/2022: 10:50\",\n \"description\": \"

New Malware on 20/06/2022: 10:50

\",\n \"incidents\": [],\n \"status\": \"active\",\n \"briefings\": [],\n \"briefings_data\": [],\n \"incidents_data\": [],\n \"is_bookmarked\": false,\n \"actions_data\": [],\n \"campaigns\": [],\n \"campaigns_data\": [],\n \"vulnerabilities\": [],\n \"vulnerabilities_data\": [],\n \"threat_actors\": [],\n \"threat_actors_data\": [],\n \"pirs_data\": [],\n \"attachments_data\": [],\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"title_display\": \"New Malware on 20/06/2022: 10:50\",\n \"labels\": [\n \"debe3f2c-85a9-4bf3-a7b8-ab7773429c24\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"debe3f2c-85a9-4bf3-a7b8-ab7773429c24\",\n \"title\": \"Blue Label Malware\",\n \"color_code\": \"#004D40\",\n \"created\": \"2023-04-21T08:19:43.911994Z\",\n \"modified\": \"2023-04-21T08:19:43.911994Z\"\n }\n ],\n \"tactic_technique_pair_data\": [],\n \"version\": null,\n \"first_seen\": null,\n \"last_modified\": null,\n \"applications\": [],\n \"applications_data\": [],\n \"asset_softwares\": [],\n \"asset_softwares_data\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"enhancements\": [],\n \"enhancements_data\": [],\n \"type_data\": [\n {\n \"unique_id\": \"a3918224-ca64-454d-986c-542f827732d4\",\n \"option_name\": \"Destructive\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"d25cee97-66c2-4a33-abb1-4c85c2a75bd5\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"fafed9c7-d7dc-46d6-b89b-38f5bedf1668\",\n \"option_name\": \"Ransomware\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"d25cee97-66c2-4a33-abb1-4c85c2a75bd5\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"c262480a-7924-4839-89c7-f697c5f87312\",\n \"option_name\": \"Trojan\",\n \"is_active\": true,\n \"order\": 5,\n \"option_field\": \"d25cee97-66c2-4a33-abb1-4c85c2a75bd5\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"d90c50a7-63e2-4570-9928-5677c24b048b\",\n \"option_name\": \"Worm\",\n \"is_active\": true,\n \"order\": 6,\n \"option_field\": \"d25cee97-66c2-4a33-abb1-4c85c2a75bd5\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"file_type_data\": [],\n \"platform_data\": [\n {\n \"unique_id\": \"ceaa6289-bab5-4591-a627-924fabc1c816\",\n \"option_name\": \"Windows Server 2k12\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"fe2af4ff-a316-4ca1-b5eb-96b17c36cbce\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"411fec39-f1d0-4729-9eef-526b6d8d1d79\",\n \"option_name\": \"Windows XP\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"fe2af4ff-a316-4ca1-b5eb-96b17c36cbce\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"37b68799-c7a1-4fa7-9c60-5d5256184a79\",\n \"option_name\": \"Linux\",\n \"is_active\": true,\n \"order\": 5,\n \"option_field\": \"fe2af4ff-a316-4ca1-b5eb-96b17c36cbce\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"a589dc51-0d9b-4510-846e-36f7c6545a49\",\n \"option_name\": \"Mac\",\n \"is_active\": true,\n \"order\": 6,\n \"option_field\": \"fe2af4ff-a316-4ca1-b5eb-96b17c36cbce\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"zero_day_data\": null,\n \"ioc_ip_data\": [],\n \"ioc_domain_data\": [],\n \"ioc_url_data\": [],\n \"ioc_email_data\": [],\n \"ioc_MD5_data\": [],\n \"ioc_SHA1_data\": [],\n \"ioc_SHA256_data\": []\n}"}],"_postman_id":"eebdbf4d-1438-45d1-8faf-bf09f4687010"},{"name":"Update Malware Using Field UUID","id":"6aad5130-8638-44ea-af85-44ab707c417b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": [\n \"Destructive\",\n \"Ransomware\",\n \"Trojan\",\n \"Worm\"\n ],\n \"ioc_email\": [],\n \"platform\": [\n \"Windows Server 2k12\",\n \"Windows XP\",\n \"Linux\",\n \"Mac\"\n ],\n \"ioc_ip\": [],\n \"ioc_malware\": [],\n \"ioc_md5\": [],\n \"file_type\": [],\n \"ioc_domain\": [],\n \"ioc_sha1\": [],\n \"ioc_sha256\": [],\n \"ioc_url\": [],\n \"title\": \"New Malware on 20/06/2022: 10:50\",\n \"description\": \"

New Malware on 20/06/2022: 10:50

Update the details of a malware in the CFTR application using the field UUID values of assigned groups, labels, and the email IDs of assigned users.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/malware/:malware_unique_id/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`title`	String	Optional	Enter a title for the malware.
`description`	Text	Optional	Enter a description of the malware.
`status`	String	Optional	Enter the status of the malware. Allowed values: - active - inactive Default value: active
`type`	List	Optional	Enter the list of the types of the malware.
`first_seen`	String	Optional	Enter the date on which the malware was first seen.
`platform`	List	Optional	Enter the unique IDs of the affected platforms.
`labels`	List	Optional	Enter the unique IDs of the labels to associate.
`tactic_technique_pair`	List	Optional	Enter the tactic technique pair used by the malware.

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the malware component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=malware\n\n

Following are some of the sample custom fields for malware:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters

Response Parameters | Regulatory Fields

Parameters	Type	Description
`type`	Object	Type of the malware.
`ioc_email`	Object	Unique IDs of the email IOC type.
`platform`	Object	Affected platforms by the malware.
`ioc_ip`	Object	Unique IDs of the IP IOC type.
`ioc_md5`	Object	Unique IDs of the MD5 Hash IOC type.
`file_type`	Object	File types of the malware. For example, dll, exe, docx, zip.
`ioc_domain`	Object	Unique IDs of the domain IOC type.
`ioc_sha1`	Object	Unique IDs of the SHA1 IOC type.
`ioc_sha256`	Object	Unique IDs of the SHA256 IOC type.
`ioc_url`	Object	Unique IDs of the URL IOC type.
`unique_id`	String	Unique ID of the malware.
`readable_id`	String	Readable ID of the malware.
`created`	String	Created date of the malware in EPOCH time format.
`modified`	String	Last modified date of the malware in EPOCH time format.
`title`	String	The title of the malware.
`description`	String	Description of the malware.
`incidents`	Object	Unique ID of the linked incidents.
`status`	String	Status of the malware.
`briefings`	Object	Unique ID of the linked threat briefings.
`briefings_data`	Object	Details of the linked threat briefings.
`incidents_data`	Object	Details of the linked incidents.
`is_bookmarked`	Boolean	Shows if the malware is bookmarked or not.
`actions_data`	Object	Details of the linked actions.
`campaigns`	Object	Unique ID of the linked campaigns.
`campaigns_data`	Object	Details of the linked campaigns.
`vulnerabilities`	Object	Unique ID of the linked vulnerabilities.
`vulnerabilities_data`	Object	Details of the linked vulnerabilities.
`threat_actors`	Object	Unique ID of the linked threat actors.
`threat_actors_data`	Object	Details of the linked threat actors.
`pirs_data`	Object	Details of the linked PIRs.
`attachments_data`	Object	Details of the attachments.
`created_by_data`	Object	Details of the user who created the malware. Details include: username, email, first name, last name, and so on.
`labels`	Object	Unique ID of the linked labels.
`labels_data`	Object	Details of the linked labels.
`tactic_technique_pair_data`	Object	Details of the linked Tactic Technique pairs.
`first_seen`	String	Date on which malware is seen for the first time.
`last_modified`	Object	Last modified date of the malware.
`applications`	Object	Unique ID of the linked applications.
`applications_data`	Object	Details of the linked applications.
`asset_softwares`	Object	Unique ID of the linked software.
`asset_softwares_data`	Object	Linked Asset Software(s) data
`endpoints`	Object	Unique ID of the linked devices.
`endpoints_data`	Object	Details of the linked devices.
`enhancements`	Object	Unique ID of the linked enhancements.
`enhancements_data`	Object	Details of the linked enhancements.
`type_data`	Object	Details of the malware type.
`file_type_data`	Object	Details of the malware file type.
`platform_data`	Object	Details of the affected platforms.

","urlObject":{"path":["malware",":malware_unique_id",""],"host":["{{base_url}}v1"],"query":[{"description":{"content":"

Descrip

Enter the unique ID of a malware.

\n","type":"text/plain"},"type":"any","value":"4cd80798-4520-4724-be03-da6552ded9eb","key":"malware_unique_id"}]}},"response":[{"id":"1ec47f26-5aac-4cbb-a237-0952a3623b3b","name":"200 OK: Update Malware","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": [\n \"Destructive\",\n \"Ransomware\",\n \"Trojan\",\n \"Worm\"\n ],\n \"ioc_email\": [],\n \"platform\": [\n \"Windows Server 2k12\",\n \"Windows XP\",\n \"Linux\",\n \"Mac\"\n ],\n \"ioc_ip\": [],\n \"ioc_malware\": [],\n \"ioc_md5\": [],\n \"file_type\": [],\n \"ioc_domain\": [],\n \"ioc_sha1\": [],\n \"ioc_sha256\": [],\n \"ioc_url\": [],\n \"title\": \"New Malware on 20/06/2022: 10:50\",\n \"description\": \"

New Malware on 20/06/2022: 10:50

\",\n \"incidents\": [],\n \"status\": \"active\",\n \"briefings\": [],\n \"briefings_data\": [],\n \"incidents_data\": [],\n \"is_bookmarked\": false,\n \"actions_data\": [],\n \"campaigns\": [\n \"d5c6f1a5-bd76-4b96-9cb1-ebccade0a85f\"\n ],\n \"campaigns_data\": [\n {\n \"title\": \"New Campaign For Regression\",\n \"unique_id\": \"d5c6f1a5-bd76-4b96-9cb1-ebccade0a85f\",\n \"readable_id\": \"CMP1413\",\n \"created\": \"2022-06-28T07:42:49.468474Z\",\n \"modified\": \"2022-06-28T07:56:44.782292Z\",\n \"title_display\": \"New Campaign For Regression\",\n \"status\": \"INACTIVE\"\n }\n ],\n \"vulnerabilities\": [],\n \"vulnerabilities_data\": [],\n \"threat_actors\": [],\n \"threat_actors_data\": [],\n \"pirs_data\": [],\n \"attachments_data\": [],\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"title_display\": \"New Malware on 20/06/2022: 10:50\",\n \"labels\": [\n \"8ccb6c69-58d2-4a0d-86d3-db65c082cde3\",\n \"4163ee22-5617-4eb0-948a-283d4c5067c7\",\n \"a8c221a4-6840-42da-b1f2-f57cf9a2bcdd\",\n \"0a01d6d1-729e-4940-8c80-9fa7f202e69e\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"8ccb6c69-58d2-4a0d-86d3-db65c082cde3\",\n \"title\": \"mlw-6\",\n \"color_code\": \"#ffffff\",\n \"created\": \"2021-01-22T05:31:10.971418Z\",\n \"modified\": \"2021-01-22T05:31:10.971418Z\"\n },\n {\n \"unique_id\": \"4163ee22-5617-4eb0-948a-283d4c5067c7\",\n \"title\": \"mlw-5\",\n \"color_code\": \"#ffffff\",\n \"created\": \"2021-01-22T05:31:09.218177Z\",\n \"modified\": \"2021-01-22T05:31:09.218177Z\"\n },\n {\n \"unique_id\": \"a8c221a4-6840-42da-b1f2-f57cf9a2bcdd\",\n \"title\": \"mlw-2\",\n \"color_code\": \"#ffffff\",\n \"created\": \"2021-01-22T05:30:33.584561Z\",\n \"modified\": \"2021-01-22T05:30:33.584561Z\"\n },\n {\n \"unique_id\": \"0a01d6d1-729e-4940-8c80-9fa7f202e69e\",\n \"title\": \"mlw-3\",\n \"color_code\": \"#ffffff\",\n \"created\": \"2021-01-22T05:31:05.837503Z\",\n \"modified\": \"2021-01-22T05:31:05.837503Z\"\n }\n ],\n \"tactic_technique_pair_data\": [],\n \"version\": null,\n \"first_seen\": null,\n \"last_modified\": null,\n \"applications\": [],\n \"applications_data\": [],\n \"asset_softwares\": [],\n \"asset_softwares_data\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"enhancements\": [],\n \"enhancements_data\": [],\n \"type_data\": [\n {\n \"unique_id\": \"abb93a96-37ef-4a76-8937-ff960aef947d\",\n \"option_name\": \"Destructive\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"1ecfc252-6c39-4dba-b1be-eda236dfcba4\",\n \"option_name\": \"Ransomware\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"17a617c1-8e8b-4381-9533-8071750e7d29\",\n \"option_name\": \"Trojan\",\n \"is_active\": true,\n \"order\": 5,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"4aff58ab-d394-4145-bac1-4ada8b8c3a8e\",\n \"option_name\": \"Worm\",\n \"is_active\": true,\n \"order\": 6,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"file_type_data\": [],\n \"platform_data\": [\n {\n \"unique_id\": \"32d39572-92e3-42ab-8949-cbe15745cfd5\",\n \"option_name\": \"Windows Server 2k12\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"43e5e63f-9623-4b89-b670-21650dbc8518\",\n \"option_name\": \"Windows XP\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"7c8caab9-ee10-4bf0-8f55-f73e55c35c07\",\n \"option_name\": \"Linux\",\n \"is_active\": true,\n \"order\": 5,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"e2fd9095-84af-4a3b-9dbb-cc083e3054da\",\n \"option_name\": \"Mac\",\n \"is_active\": true,\n \"order\": 6,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"ioc_ip_data\": [],\n \"ioc_domain_data\": [],\n \"ioc_url_data\": [],\n \"ioc_email_data\": [],\n \"ioc_md5_data\": [],\n \"ioc_sha1_data\": [],\n \"ioc_sha256_data\": [],\n \"ioc_custom_inc_10_data\": [],\n \"ioc_custom_inc_8_data\": [],\n \"ioc_custom_inc_7_data\": [],\n \"ioc_custom_inc_9_data\": [],\n \"ioc_custom_inc_5_data\": [],\n \"ioc_custom_inc_4_data\": [],\n \"ioc_credit_card_data\": [],\n \"ioc_custom_inc_6_data\": [],\n \"ioc_malware_data\": [],\n \"ioc_test_integration_data\": [],\n \"ioc_test_v6_data\": [],\n \"ioc_test_25_data\": [],\n \"ioc_autonomous_system_data\": [],\n \"ioc_custom_indicator_data\": [],\n \"ioc_custom_-_sha512_data\": [],\n \"ioc_mac_addrr_data\": []\n}"}],"_postman_id":"6aad5130-8638-44ea-af85-44ab707c417b"},{"name":"Update Malware Using Field Values","id":"8869b7f1-2f37-42c1-96e4-49ea0bc1e114","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"labels\": [\"Red Label Malware\"]\n}"},"url":"{{base_url}}v1/malware/:malware_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","description":"

Update the details of a malware in the CFTR application using the values of assigned groups, labels, and the email IDs of assigned users.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/malware/:malware_unique_id/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`title`	String	Optional	Enter a title for the malware.
`description`	Text	Optional	Enter a description of the malware.
`status`	String	Optional	Enter the status of the malware. Allowed values: - active - inactive Default value: active
`type`	List	Optional	Enter the list of the types of the malware.
`first_seen`	String	Optional	Enter the date on which the malware was first seen.
`platform`	List	Optional	Enter the unique IDs of the affected platforms.
`labels`	List	Optional	Enter the names of the labels to associate. You can use the following API endpoint to retrieve the list of Labels: `/openapi/v1/utils/label/`
`tactic_technique_pair`	List	Optional	Enter the tactic technique pair used by the malware.

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the malware component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=malware\n\n

Following are some of the sample custom fields for malware:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters

Response Parameters | Regulatory Fields

Parameters	Type	Description
`type`	Object	Type of the malware.
`ioc_email`	Object	Unique IDs of the email IOC type.
`platform`	Object	Platforms affected by the malware.
`ioc_ip`	Object	Unique IDs of the IP IOC type.
`ioc_md5`	Object	Unique IDs of the MD5 Hash IOC type.
`file_type`	Object	File types. For example, dll, exe, docx, zip.
`ioc_domain`	Object	Unique IDs of the domain IOC type.
`ioc_sha1`	Object	Unique IDs of the SHA1 IOC type.
`ioc_sha256`	Object	Unique IDs of the SHA256 IOC type.
`ioc_url`	Object	Unique IDs of the URL IOC type.
`unique_id`	String	Unique ID of the malware.
`readable_id`	String	Readable ID of the malware.
`created`	String	Created date of the malware in EPOCH time format.
`modified`	String	Last modified date of the malware in EPOCH time format.
`title`	String	The title of the malware.
`description`	String	Description of the malware.
`incidents`	Object	Unique ID of the linked incidents.
`status`	String	Status of the malware.
`briefings`	Object	Unique ID of the linked threat briefings.
`briefings_data`	Object	Details of the linked threat briefings.
`incidents_data`	Object	Details of the linked incidents.
`is_bookmarked`	Boolean	Shows if the malware is bookmarked or not.
`actions_data`	Object	Details of the linked actions.
`campaigns`	Object	Unique ID of the linked campaigns.
`campaigns_data`	Object	Details of the linked campaigns.
`vulnerabilities`	Object	Unique ID of the linked vulnerabilities.
`vulnerabilities_data`	Object	Details of the linked vulnerabilities.
`threat_actors`	Object	Unique ID of the linked threat actors.
`threat_actors_data`	Object	Details of the linked threat actors.
`pirs_data`	Object	Details of the linked PIRs.
`attachments_data`	Object	Details of the attachments.
`created_by_data`	Object	Details of the user who created the malware. Details include: username, email, first name, last name, and so on.
`labels`	Object	Unique ID of the linked labels.
`labels_data`	Object	Details of the linked labels.
`tactic_technique_pair_data`	Object	Details of the linked Tactic Technique pairs.
`first_seen`	String	Date on which malware is seen for the first time.
`last_modified`	Object	Last modified date of the malware.
`applications`	Object	Unique ID of the linked applications.
`applications_data`	Object	Details of the linked applications.
`asset_softwares`	Object	Unique ID of the linked software.
`asset_softwares_data`	Object	Linked Asset Software(s) data
`endpoints`	Object	Unique ID of the linked devices.
`endpoints_data`	Object	Details of the linked devices.
`enhancements`	Object	Unique ID of the linked enhancements.
`enhancements_data`	Object	Details of the linked enhancements.
`type_data`	Object	Details of the malware type.
`file_type_data`	Object	Details of the malware file type.
`platform_data`	Object	Details of the affected platforms.

","urlObject":{"path":["malware",":malware_unique_id",""],"host":["{{base_url}}v1"],"query":[{"description":{"content":"

Descrip

\n","type":"text/plain"},"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"description":{"content":"

Do not change the parameter value\nAllows you to update malwares using the values of labels.

\n","type":"text/plain"},"key":"values","value":"readable_type"}],"variable":[{"description":{"content":"

Enter the unique ID of a malware.

\n","type":"text/plain"},"type":"any","value":"a0f3afb3-4136-4ae1-89fe-1d1f69241138","key":"malware_unique_id"}]}},"response":[{"id":"7a281cf5-ba8e-4d8e-bef7-fb1956bdfb8c","name":"200 OK: Update Malware Using Field Library","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"labels\": [\"Red Label Malware\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/malware/:malware_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","host":["{{base_url}}v1"],"path":["malware",":malware_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}","description":"Descrip"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"values","value":"readable_type","description":"**Do not change the parameter value**\nAllows you to update malwares using the values of labels."}],"variable":[{"key":"malware_unique_id","value":"a0f3afb3-4136-4ae1-89fe-1d1f69241138","description":"Enter the unique ID of a malware."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Apr 2023 08:25:45 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"references\": null,\n \"aliases\": null,\n \"file_size\": null,\n \"additional_information\": null,\n \"associated_bitcoin_addresses\": null,\n \"remediation\": null,\n \"zero_day\": null,\n \"type\": [\n \"Destructive\",\n \"Ransomware\",\n \"Trojan\",\n \"Worm\"\n ],\n \"file_type\": [],\n \"platform\": [\n \"Windows Server 2k12\",\n \"Windows XP\",\n \"Linux\",\n \"Mac\"\n ],\n \"ioc_email\": [],\n \"ioc_MD5\": [],\n \"ioc_url\": [],\n \"ioc_SHA256\": [],\n \"ioc_domain\": [],\n \"ioc_SHA1\": [],\n \"ioc_ip\": [],\n \"unique_id\": \"a0f3afb3-4136-4ae1-89fe-1d1f69241138\",\n \"readable_id\": \"MLW101\",\n \"created\": \"2023-04-21T08:20:24.756027Z\",\n \"modified\": \"2023-04-21T08:25:41.670033Z\",\n \"title\": \"New Malware on 20/06/2022: 10:50\",\n \"description\": \"

New Malware on 20/06/2022: 10:50

\",\n \"incidents\": [],\n \"status\": \"active\",\n \"briefings\": [],\n \"briefings_data\": [],\n \"incidents_data\": [],\n \"is_bookmarked\": false,\n \"actions_data\": [],\n \"campaigns\": [],\n \"campaigns_data\": [],\n \"vulnerabilities\": [],\n \"vulnerabilities_data\": [],\n \"threat_actors\": [],\n \"threat_actors_data\": [],\n \"pirs_data\": [],\n \"attachments_data\": [],\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"title_display\": \"New Malware on 20/06/2022: 10:50\",\n \"labels\": [\n \"8c161b1c-d511-4fa3-9d0d-71eb6d8f6979\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"8c161b1c-d511-4fa3-9d0d-71eb6d8f6979\",\n \"title\": \"Red Label Malware\",\n \"color_code\": \"#006064\",\n \"created\": \"2023-04-21T08:19:09.141964Z\",\n \"modified\": \"2023-04-21T08:19:17.566469Z\"\n }\n ],\n \"tactic_technique_pair_data\": [],\n \"version\": null,\n \"first_seen\": null,\n \"last_modified\": null,\n \"applications\": [],\n \"applications_data\": [],\n \"asset_softwares\": [],\n \"asset_softwares_data\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"enhancements\": [],\n \"enhancements_data\": [],\n \"type_data\": [\n {\n \"unique_id\": \"a3918224-ca64-454d-986c-542f827732d4\",\n \"option_name\": \"Destructive\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"d25cee97-66c2-4a33-abb1-4c85c2a75bd5\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"fafed9c7-d7dc-46d6-b89b-38f5bedf1668\",\n \"option_name\": \"Ransomware\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"d25cee97-66c2-4a33-abb1-4c85c2a75bd5\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"c262480a-7924-4839-89c7-f697c5f87312\",\n \"option_name\": \"Trojan\",\n \"is_active\": true,\n \"order\": 5,\n \"option_field\": \"d25cee97-66c2-4a33-abb1-4c85c2a75bd5\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"d90c50a7-63e2-4570-9928-5677c24b048b\",\n \"option_name\": \"Worm\",\n \"is_active\": true,\n \"order\": 6,\n \"option_field\": \"d25cee97-66c2-4a33-abb1-4c85c2a75bd5\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"file_type_data\": [],\n \"platform_data\": [\n {\n \"unique_id\": \"ceaa6289-bab5-4591-a627-924fabc1c816\",\n \"option_name\": \"Windows Server 2k12\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"fe2af4ff-a316-4ca1-b5eb-96b17c36cbce\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"411fec39-f1d0-4729-9eef-526b6d8d1d79\",\n \"option_name\": \"Windows XP\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"fe2af4ff-a316-4ca1-b5eb-96b17c36cbce\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"37b68799-c7a1-4fa7-9c60-5d5256184a79\",\n \"option_name\": \"Linux\",\n \"is_active\": true,\n \"order\": 5,\n \"option_field\": \"fe2af4ff-a316-4ca1-b5eb-96b17c36cbce\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"a589dc51-0d9b-4510-846e-36f7c6545a49\",\n \"option_name\": \"Mac\",\n \"is_active\": true,\n \"order\": 6,\n \"option_field\": \"fe2af4ff-a316-4ca1-b5eb-96b17c36cbce\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"zero_day_data\": null,\n \"ioc_ip_data\": [],\n \"ioc_domain_data\": [],\n \"ioc_url_data\": [],\n \"ioc_email_data\": [],\n \"ioc_MD5_data\": [],\n \"ioc_SHA1_data\": [],\n \"ioc_SHA256_data\": []\n}"}],"_postman_id":"8869b7f1-2f37-42c1-96e4-49ea0bc1e114"}],"id":"0d204808-c2db-4a7d-8dfa-a31ff73d11a6","description":"

Malware is a malicious piece of software or code that is designed to infect, explore, or virtually conduct any defined behavior that is harmful to an organization. Generally, malware is delivered over the network or using infected hardware. Malware is a common term used for malicious software such as viruses, worms, Trojans, rootkits, Remote Administration Tools (RATs), botnets, spyware, and so on.

This section describes how to use the API endpoints to manage the malware.

\n","_postman_id":"0d204808-c2db-4a7d-8dfa-a31ff73d11a6"},{"name":"Custom Modules","item":[{"name":"List Custom Modules","id":"f5720e4d-1b50-437f-818b-d0769cae7f99","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/dynamic-model/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve all the custom module names and the corresponding component identifiers.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
link	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` shows the API endpoint to the next page.
count	Integer	Total number of custom modules in CFTR application according to the filters applied.
results	List of Objects	Details of the custom modules. Each object provides details of one incident.

Response Parameters | Results Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`component_identifier`	String	Component identifier of a custom module. Example, MOD.
`module_name`	String	Name of the custom module.
`icon`	String	The icon identifier that is being used for the custom module.
`unique_id`	String	Unique ID of the custom module.
`is_removable`	Boolean	Shows whether the custom module can be deleted or not. `- true` indicates that there is no entry created for the module and the module can be deleted. `- false` indicates that entries for the custom module are already created and the module cannot be deleted.

","urlObject":{"path":["dynamic-model",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"0e378377-2c66-44be-9d32-468deeb20f38","name":"Custom Module Mapping","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/dynamic-model/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["dynamic-model",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Mon, 13 Jun 2022 06:48:16 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1819","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 3,\n \"results\": [\n {\n \"component_identifier\": \"module1\",\n \"module_name\": \"Case\",\n \"icon\": \"icon 1\",\n \"unique_id\": \"24d2f1d8-6867-4cf2-b643-a2b5c52c9ec8\",\n \"is_removable\": false\n },\n {\n \"component_identifier\": \"module2\",\n \"module_name\": \"Event\",\n \"icon\": \"icon 2\",\n \"unique_id\": \"171acda0-857f-48f7-b0c9-05fecd43557d\",\n \"is_removable\": false\n },\n {\n \"component_identifier\": \"module3\",\n \"module_name\": \"Alert\",\n \"icon\": \"icon 3\",\n \"unique_id\": \"d9d56d84-c02d-443f-9e6e-6f420c864b0b\",\n \"is_removable\": true\n }\n ],\n \"mapping\": {\n \"dropdown_display_name\": \"readable_id\"\n }\n}"}],"_postman_id":"f5720e4d-1b50-437f-818b-d0769cae7f99"},{"name":"List Custom Module Entries","id":"2108103d-c581-4597-811e-d045b9889e8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/dynamic-model/:component_identifier/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve a list of all the entries of a custom module with details from the CFTR application.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` shows the API endpoint to the next page.
`count`	Integer	Total number of entries of the custom module in CFTR application as per the filters applied.
`results`	List of Objects	Details of the entries of the custom module. Each object provides details of one entry.

Response Parameters | Results Object

Parameter	Type	Description
`unique_id`	String	Unique ID of the entry in UUID-4 format.
`readable_id`	String	Unique readable ID of the entry. It starts with the configured Module Identifier followed by a unique number.
`created`	String	Creation date and time of the entry.
`modified`	String	Last updated date and time of the entry.
`labels`	List	List of labels added to the entry.
`modified_by_user_id`	String	UUID of the user who last modified the custom module entry.
`created_by_user_id`	String	UUID of the user who created the custom module entry.
`title`	Text	Title of the entry.
`description`	Text	Description of the entry.
`status`	String	Current status of the entry.
`status_data`	Object	Details of the status of the entry. Details include: `unique_id`, `option_name`, `is_active`, and so on.
`is_bookmarked`	Boolean	Shows if the entry is bookmarked or not.
`modified_by_data`	Object	Details of the user who last updated the entry. Details include: `username`, `email` ,`first_name`, `last_name`, and so on.
`created_by_data`	Object	Details of the user who created the entry. Details include: `username`, `email` ,`first_name`, `last_name`, and so on.
`labels_data`	List of Objects	Details of labels added to the entry. Details include: `title`, `unique_id`, `color_code`, and so on.
`is_bookmarked`	Boolean	Displays whether the entry is bookmarked or not.
`is_removed`	Boolean	Displays whether the custom module entry is in the deleted state or not.
`readable_id_counter`	Integer	Unique number of the entry.

","urlObject":{"path":["dynamic-model",":component_identifier",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the component Identifier of the module.

\n","type":"text/plain"},"type":"any","value":"module","key":"component_identifier"}]}},"response":[{"id":"29dddb52-b087-423d-b599-76ddfebec2d0","name":"Get List of Custom Module","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/dynamic-model/module1/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["dynamic-model","module1",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Mon, 13 Jun 2022 06:39:32 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"6590","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 4,\n \"results\": [\n {\n \"unique_id\": \"822c2781-8ea0-4122-8176-8995a4c81dca\",\n \"tenant_id\": \"fb31d9bf-41dd-42a9-8b56-5c022333181c\",\n \"schema_unique_id\": \"a07f5cce-bb8e-4f5d-8830-cd918c250c30\",\n \"schema_id\": \"f91a0179-189e-4e4a-8ff5-34ee1d306a5b\",\n \"created\": \"2022-05-18T09:10:52.831853Z\",\n \"modified\": \"2022-05-18T09:10:52.831867Z\",\n \"is_removed\": false,\n \"deleted_token\": \"default\",\n \"readable_id\": \"CAS104\",\n \"readable_id_counter\": 104,\n \"labels\": [\n \"2554f557-6d66-41ec-9328-df5164568e07\"\n ],\n \"created_by_user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"modified_by_user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"assigned_group_comm_id\": null,\n \"assigned_to_user_id\": null,\n \"status\": \"Open\",\n \"title\": \"case title\",\n \"description\": \"case description\",\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"modified_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"can_update_instance\": true,\n \"can_update_full\": true,\n \"labels_data\": [\n {\n \"unique_id\": \"2554f557-6d66-41ec-9328-df5164568e07\",\n \"title\": \"L1\",\n \"color_code\": \"#5E35B1\",\n \"created\": \"2022-05-18T09:09:39.314961Z\",\n \"modified\": \"2022-05-18T09:09:39.314961Z\"\n }\n ],\n \"assigned_group\": null,\n \"assigned_to\": null,\n \"assigned_group_data\": null,\n \"assigned_to_data\": null,\n \"status_data\": {\n \"unique_id\": \"56aa44c6-dfa5-4652-9b03-f034d27197ab\",\n \"option_name\": \"Open\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"17b58afc-d052-4af3-a7ee-248deb9b596b\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": \"#008565\"\n },\n \"is_bookmarked\": false\n },\n {\n \"unique_id\": \"f5898f08-ddf9-4c3e-a261-a3ca9f1687a0\",\n \"tenant_id\": \"fb31d9bf-41dd-42a9-8b56-5c022333181c\",\n \"schema_unique_id\": \"a07f5cce-bb8e-4f5d-8830-cd918c250c30\",\n \"schema_id\": \"f91a0179-189e-4e4a-8ff5-34ee1d306a5b\",\n \"created\": \"2022-05-18T09:10:05.951343Z\",\n \"modified\": \"2022-05-18T09:10:05.951357Z\",\n \"is_removed\": false,\n \"deleted_token\": \"default\",\n \"readable_id\": \"CAS103\",\n \"readable_id_counter\": 103,\n \"labels\": [],\n \"created_by_user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"modified_by_user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"assigned_group_comm_id\": null,\n \"assigned_to_user_id\": null,\n \"status\": \"Open\",\n \"title\": \"case title\",\n \"description\": \"case description\",\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"modified_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"can_update_instance\": true,\n \"can_update_full\": true,\n \"labels_data\": [],\n \"assigned_group\": null,\n \"assigned_to\": null,\n \"assigned_group_data\": null,\n \"assigned_to_data\": null,\n \"status_data\": {\n \"unique_id\": \"56aa44c6-dfa5-4652-9b03-f034d27197ab\",\n \"option_name\": \"Open\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"17b58afc-d052-4af3-a7ee-248deb9b596b\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": \"#008565\"\n },\n \"is_bookmarked\": false\n },\n {\n \"unique_id\": \"8f63139e-b6fa-4b6f-ae94-16a8417554cc\",\n \"tenant_id\": \"fb31d9bf-41dd-42a9-8b56-5c022333181c\",\n \"schema_unique_id\": \"a07f5cce-bb8e-4f5d-8830-cd918c250c30\",\n \"schema_id\": \"f91a0179-189e-4e4a-8ff5-34ee1d306a5b\",\n \"created\": \"2022-05-13T11:27:05.781291Z\",\n \"modified\": \"2022-05-13T11:27:05.781308Z\",\n \"is_removed\": false,\n \"deleted_token\": \"default\",\n \"readable_id\": \"CAS102\",\n \"readable_id_counter\": 102,\n \"labels\": [],\n \"created_by_user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"modified_by_user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"assigned_group_comm_id\": null,\n \"assigned_to_user_id\": null,\n \"status\": \"Open\",\n \"title\": \"case title\",\n \"description\": \"case description\",\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"modified_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"can_update_instance\": true,\n \"can_update_full\": true,\n \"labels_data\": [],\n \"assigned_group\": null,\n \"assigned_to\": null,\n \"assigned_group_data\": null,\n \"assigned_to_data\": null,\n \"status_data\": {\n \"unique_id\": \"56aa44c6-dfa5-4652-9b03-f034d27197ab\",\n \"option_name\": \"Open\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"17b58afc-d052-4af3-a7ee-248deb9b596b\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": \"#008565\"\n },\n \"is_bookmarked\": false\n },\n {\n \"unique_id\": \"9c292695-3eb9-46bd-9b11-7a733ff4f27c\",\n \"tenant_id\": \"fb31d9bf-41dd-42a9-8b56-5c022333181c\",\n \"schema_unique_id\": \"a07f5cce-bb8e-4f5d-8830-cd918c250c30\",\n \"schema_id\": \"f91a0179-189e-4e4a-8ff5-34ee1d306a5b\",\n \"created\": \"2022-05-13T11:26:51.613631Z\",\n \"modified\": \"2022-05-13T11:26:51.613677Z\",\n \"is_removed\": false,\n \"deleted_token\": \"default\",\n \"readable_id\": \"CAS101\",\n \"readable_id_counter\": 101,\n \"labels\": [],\n \"created_by_user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"modified_by_user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"assigned_group_comm_id\": null,\n \"assigned_to_user_id\": null,\n \"status\": \"Open\",\n \"title\": \"case title\",\n \"description\": null,\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"modified_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"can_update_instance\": true,\n \"can_update_full\": true,\n \"labels_data\": [],\n \"assigned_group\": null,\n \"assigned_to\": null,\n \"assigned_group_data\": null,\n \"assigned_to_data\": null,\n \"status_data\": {\n \"unique_id\": \"56aa44c6-dfa5-4652-9b03-f034d27197ab\",\n \"option_name\": \"Open\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"17b58afc-d052-4af3-a7ee-248deb9b596b\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": \"#008565\"\n },\n \"is_bookmarked\": false\n }\n ]\n}"}],"_postman_id":"2108103d-c581-4597-811e-d045b9889e8e"},{"name":"Details of a Custom Module Entry","id":"07d8b442-e3e2-4bf2-a0b0-9da71d7c7756","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/dynamic-model/:component_identifier/:instance_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the details of a custom module entry.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters:

Response Parameters | Regulatory Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	Title of the entry.
`unique_id`	String	Unique ID of the entry.
`status`	String	Current status of the entry.
`description`	Text	Description of the entry.
`created_by_user_id`	String	`user_id` of the user who created the entry.
`modified_by_user_id`	String	`user_id` of the user who last modified the entry.
`created_by_data`	Object	Details of the user who created the entry.
`modified_by_data`	Object	Details of the user who last modified the entry.
`created`	String	Creation date and time of the entry.
`modified`	String	Last updated date and time of the entry.
`is_bookmarked`	Boolean	Shows if the entry is bookmarked or not.
`can_update_instance`	Boolean	Shows whether the entry can be updated by the user who requested it or not.
`labels`	Array	List of the labels that are added to the entry.
`labels_data`	Array of Objects	Details of the labels that are added to the entry.
`is_removed`	Boolean	Displays if the entry is in deleted state or not.
`status_data`	Array of Objects	Displays the details of the status of the entry.

Response Parameters | Custom Form Fields

In addition to the above-mentioned parameters, the response parameters may vary as per the form configuration defined by your CFTR admin for custom modules. For such parameters, the field_readable_key of each parameter is returned in the response. To retrieve the field_readable_key and additional metadata of a parameter, use the Form Tab Structure API for custom modules.

Example

The following endpoint retrieves the field_readable_key for all custom fields in the custom module:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=:component_identifier\n\n

Following are some of the sample custom fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters | Attachments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`attachments_data`	Array of Objects	Details of each attachment of the entry.

","urlObject":{"path":["dynamic-model",":component_identifier",":instance_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the component Identifier of the module.

\n","type":"text/plain"},"type":"any","value":"module1","key":"component_identifier"},{"description":{"content":"

Enter the unique ID of the entry.

\n","type":"text/plain"},"type":"any","value":"822c2781-8ea0-4122-8176-8995a4c81dca","key":"instance_unique_id"}]}},"response":[{"id":"8000fc7f-bd1c-4c9d-a4b9-cadc087de2a7","name":"Get Details of Custom Module","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/dynamic-model/module1/822c2781-8ea0-4122-8176-8995a4c81dca/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["dynamic-model","module1","822c2781-8ea0-4122-8176-8995a4c81dca",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Mon, 13 Jun 2022 07:13:50 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1797","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"unique_id\": \"822c2781-8ea0-4122-8176-8995a4c81dca\",\n \"tenant_id\": \"fb31d9bf-41dd-42a9-8b56-5c022333181c\",\n \"schema_unique_id\": \"a07f5cce-bb8e-4f5d-8830-cd918c250c30\",\n \"schema_id\": \"f91a0179-189e-4e4a-8ff5-34ee1d306a5b\",\n \"created\": \"2022-05-18T09:10:52.831853Z\",\n \"modified\": \"2022-05-18T09:10:52.831867Z\",\n \"is_removed\": false,\n \"deleted_token\": \"default\",\n \"readable_id\": \"CAS104\",\n \"readable_id_counter\": 104,\n \"labels\": [\n \"2554f557-6d66-41ec-9328-df5164568e07\"\n ],\n \"created_by_user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"modified_by_user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"assigned_group_comm_id\": null,\n \"assigned_to_user_id\": null,\n \"status\": \"Open\",\n \"title\": \"case title\",\n \"description\": \"case description\",\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"modified_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"can_update_instance\": true,\n \"can_update_full\": true,\n \"labels_data\": [\n {\n \"unique_id\": \"2554f557-6d66-41ec-9328-df5164568e07\",\n \"title\": \"L1\",\n \"color_code\": \"#5E35B1\",\n \"created\": \"2022-05-18T09:09:39.314961Z\",\n \"modified\": \"2022-05-18T09:09:39.314961Z\"\n }\n ],\n \"assigned_group\": null,\n \"assigned_to\": null,\n \"assigned_group_data\": null,\n \"assigned_to_data\": null,\n \"status_data\": {\n \"unique_id\": \"56aa44c6-dfa5-4652-9b03-f034d27197ab\",\n \"option_name\": \"Open\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"17b58afc-d052-4af3-a7ee-248deb9b596b\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": \"#008565\"\n },\n \"is_bookmarked\": false\n}"}],"_postman_id":"07d8b442-e3e2-4bf2-a0b0-9da71d7c7756"},{"name":"Create Custom Module Entry","id":"99359ffd-8e53-4352-9831-9e212d864f2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"test custom module\",\n \"description\": \"Custom Module Description\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/dynamic-model/:component_identifier/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Create a new entry for a custom module in the CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`title`	String	Mandatory	Enter a title for the entry.
`description`	String	Optional	Enter a description of the entry.

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the custom module:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=:component_identifier\n\n

Following are some of the sample custom fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters:

Response Parameters | Regulatory Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	Title of the entry.
`description`	Text	Description of the entry.
`unique_id`	String	Unique ID of the entry.
`status`	String	Current status of the entry.
`readable_id`	String	Unique readable ID of the entry. It starts with the configured Module Identifier followed by a unique number.
`created_by_user_id`	String	`user_id` of the user who created the entry.
`modified_by_user_id`	String	`user_id` of the user who last modified the entry.
`created_by_data`	Object	Details of the user who created the entry.
`modified_by_data`	Object	Details of the user who last modified the entry.
`created`	String	Creation date and time of the entry.
`modified`	String	Last updated date and time of the entry.
`is_bookmarked`	Boolean	Shows if the entry is bookmarked or not.
`can_update_instance`	Boolean	Shows whether the entry can be updated by the user who requested it or not.
`labels`	Array	List of the labels that are added to the entry.
`labels_data`	Array of Objects	Details of the labels that are added to the entry.
`is_removed`	Boolean	Displays if the entry is in the deleted state or not.
`status_data`	Object	Details of the status of the entry.

Response Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the custom module component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=:component_identifier\n\n

Following are some of the sample custom fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters | Attachments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`attachments_data`	Array of Objects	Details of each attachment of the entry.

Enter the component Identifier of the module.

\n","type":"text/plain"},"type":"any","value":"module1","key":"component_identifier"}]}},"response":[{"id":"ed028165-e6b2-4a0a-b150-a17786b62369","name":"Create Custom Module","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"test custom module\",\n \"description\": \"Custom Module Description\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/dynamic-model/module1/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["dynamic-model","module1",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Mon, 13 Jun 2022 06:46:50 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1607","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"unique_id\": \"2e7699f8-aae1-494b-914c-570c2b45c5fc\",\n \"tenant_id\": \"fb31d9bf-41dd-42a9-8b56-5c022333181c\",\n \"schema_unique_id\": \"a07f5cce-bb8e-4f5d-8830-cd918c250c30\",\n \"schema_id\": \"f91a0179-189e-4e4a-8ff5-34ee1d306a5b\",\n \"created\": \"2022-06-13T06:46:48.421602Z\",\n \"modified\": \"2022-06-13T06:46:48.421623Z\",\n \"is_removed\": false,\n \"deleted_token\": \"default\",\n \"readable_id\": \"CAS105\",\n \"readable_id_counter\": 105,\n \"labels\": [],\n \"created_by_user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"modified_by_user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"assigned_group_comm_id\": null,\n \"assigned_to_user_id\": null,\n \"status\": \"Open\",\n \"title\": \"test custom module\",\n \"description\": \"Custom Module Description\",\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"modified_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"can_update_instance\": true,\n \"can_update_full\": true,\n \"labels_data\": [],\n \"assigned_group\": null,\n \"assigned_to\": null,\n \"assigned_group_data\": null,\n \"assigned_to_data\": null,\n \"status_data\": {\n \"unique_id\": \"56aa44c6-dfa5-4652-9b03-f034d27197ab\",\n \"option_name\": \"Open\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"17b58afc-d052-4af3-a7ee-248deb9b596b\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": \"#008565\"\n },\n \"is_bookmarked\": false\n}"}],"_postman_id":"99359ffd-8e53-4352-9831-9e212d864f2e"},{"name":"Update Custom Module Entry","id":"40afc881-57d7-45eb-a31b-5c5c8d6565d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"update instance\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/dynamic-model/:component_identifier/:instance_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Update an existing entry of a custom module in the CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`title`	String	Optional	Enter a title for the entry.
`description`	String	Optional	Enter a description of the entry.

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the custom module:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=:component_identifier\n\n

Following are some of the sample custom fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters:

Response Parameters | Regulatory Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	Title of the entry.
`description`	Text	Description of the entry.
`unique_id`	String	Unique ID of the entry.
`readable_id`	String	Unique readable ID of the entry. It starts with the configured Module Identifier followed by a unique number.
`status`	String	Current status of the entry.
`created_by_user_id`	String	`user_id` of the user who created the entry.
`modified_by_user_id`	String	`user_id` of the user who last modified the entry.
`created_by_data`	Object	Details of the user who created the entry.
`modified_by_data`	Object	Details of the user who last modified the entry.
`created`	String	Creation date and time of the entry.
`modified`	String	Last updated date and time of the entry.
`is_removed`	Boolean	Displays if the entry is in the deleted state or not.
`is_bookmarked`	Boolean	Shows if the entry is bookmarked or not.
`can_update_instance`	Boolean	Shows whether the entry can be updated by the user who requested it or not.
`labels`	Array	List of the labels that are added to the entry.
`labels_data`	Array of Objects	Details of the labels that are added to the entry.
`status_data`	Object	Details of the status of the entry.

Response Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the custom module:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=:component_identifier\n\n

Following are some of the sample custom fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters | Attachments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`attachments_data`	Array of Objects	Details of each attachment of the entry.

Enter the component Identifier of the module.

\n","type":"text/plain"},"type":"any","value":"module21","key":"component_identifier"},{"description":{"content":"

Enter the unique ID of the entry.

\n","type":"text/plain"},"type":"any","value":"822c2781-8ea0-4122-8176-8995a4c81dca","key":"instance_unique_id"}]}},"response":[{"id":"3b4a27ad-9d3d-43d7-9c81-5ff67b66bf72","name":"Update Custom Module","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"update instance\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/dynamic-model/module1/822c2781-8ea0-4122-8176-8995a4c81dca/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["dynamic-model","module1","822c2781-8ea0-4122-8176-8995a4c81dca",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Mon, 13 Jun 2022 09:33:03 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1802","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"unique_id\": \"822c2781-8ea0-4122-8176-8995a4c81dca\",\n \"tenant_id\": \"fb31d9bf-41dd-42a9-8b56-5c022333181c\",\n \"schema_unique_id\": \"a07f5cce-bb8e-4f5d-8830-cd918c250c30\",\n \"schema_id\": \"f91a0179-189e-4e4a-8ff5-34ee1d306a5b\",\n \"created\": \"2022-05-18T09:10:52.831853Z\",\n \"modified\": \"2022-05-18T09:10:52.831867Z\",\n \"is_removed\": false,\n \"deleted_token\": \"default\",\n \"readable_id\": \"CAS104\",\n \"readable_id_counter\": 104,\n \"labels\": [\n \"2554f557-6d66-41ec-9328-df5164568e07\"\n ],\n \"created_by_user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"modified_by_user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"assigned_group_comm_id\": null,\n \"assigned_to_user_id\": null,\n \"status\": \"Open\",\n \"title\": \"update instance\",\n \"description\": \"case description\",\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"modified_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"4d79d22f-1e1a-4777-88ec-f669ebfbf337\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"can_update_instance\": true,\n \"can_update_full\": true,\n \"labels_data\": [\n {\n \"unique_id\": \"2554f557-6d66-41ec-9328-df5164568e07\",\n \"title\": \"L1\",\n \"color_code\": \"#5E35B1\",\n \"created\": \"2022-05-18T09:09:39.314961Z\",\n \"modified\": \"2022-05-18T09:09:39.314961Z\"\n }\n ],\n \"assigned_group\": null,\n \"assigned_to\": null,\n \"assigned_group_data\": null,\n \"assigned_to_data\": null,\n \"status_data\": {\n \"unique_id\": \"56aa44c6-dfa5-4652-9b03-f034d27197ab\",\n \"option_name\": \"Open\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"17b58afc-d052-4af3-a7ee-248deb9b596b\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": \"#008565\"\n },\n \"is_bookmarked\": false\n}"}],"_postman_id":"40afc881-57d7-45eb-a31b-5c5c8d6565d8"},{"name":"Add Comment in Custom Module","id":"22c15625-2706-4484-b068-db9c7d5d2138","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"description\": \"

Note For Custom Module

\",\n \"mentioned_users_usernames\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/comments/:component_identifier/:instance_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Add notes in an entry of a custom module in the CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
description	String	Mandatory	Enter the content of the comment. For example, \" Note For Custom Module \"
mentioned_users_usernames	List of UUID	Optional	Enter the list of usernames of users mentioned in the comment.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
unique_id	String	Unique ID of the comment.
description	Text	Content of the comment.
created_by	Object	Details of the user who added the comment.
modified_by	Object	Details of the user who last updated the comment.
mentioned_users	List of UUIDs	List of `user_id` of users mentioned in the comment.
mentioned_users_data	List of Objects	Details of the users mentioned in the comment.
created	String	Comment creation time.
modified	String	Comment last updated time.
comment_type	String	Type of Comment. Examples: `discussion`: Notes added in any instance. `handoff`: Handoff notes added while updating the assignee or assigned group. `closure`: Closure Notes added while closing an incident.
content_object	String	Custom module in which the comment is added. Example: `incident`, `action`, `ioc`, and so on.
content_object_readable_id	String	`readable_id` of the entry in which the comment is added
content_object_unique_id	String	`unique_id` of the entry in which the comment is added
description_with_img_src	Text	Content of the comment with the image URLs (if any image is added in the comment).
pinned	Boolean	Displays if the comment is pinned or not.

","urlObject":{"path":["comments",":component_identifier",":instance_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the component Identifier of the module.

\n","type":"text/plain"},"type":"any","value":"module1","key":"component_identifier"},{"description":{"content":"

Enter the unique ID of the entry.

\n","type":"text/plain"},"type":"any","value":"822c2781-8ea0-4122-8176-8995a4c81dca","key":"instance_unique_id"}]}},"response":[{"id":"3e30afd8-eed0-49bc-a0c9-b5dc8da00db7","name":"Add Comment in Custom Module","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"description\": \"

Note For Custom Module

\",\n \"mentioned_users_usernames\": []\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/comments/:component_identifier/:instance_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["comments",":component_identifier",":instance_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"component_identifier","value":"module1","description":"Enter the component Identifier of the module."},{"key":"instance_unique_id","value":"f2cf4b3e-da5d-4a0b-a4f1-b0cf2d8b1ec5","description":"Enter the unique ID of the entry."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 27 Jan 2024 13:42:58 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"931","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Server","value":"gunicorn/19.10.0","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"unique_id\": \"a1c03ad2-8147-4834-a575-f1710be628b0\",\n \"description\": \"

Note For Custom Module

\",\n \"created_by\": {\n \"user_id\": \"b3184a17-e59f-46cb-82c3-d8aabbefff7e\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@default.tld\",\n \"display_pic\": null,\n \"username\": \"john doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"John Doe\"\n },\n \"modified_by\": null,\n \"is_removed\": false,\n \"mentioned_users\": [],\n \"mentioned_users_data\": [],\n \"created\": \"2024-01-27T13:42:58.055409Z\",\n \"modified\": \"2024-01-27T13:42:58.063151Z\",\n \"email\": null,\n \"internal\": false,\n \"comment_type\": \"discussion\",\n \"command_params\": {},\n \"command_result\": {},\n \"command_status\": \"na\",\n \"attachments_data\": [],\n \"content_object\": \"module1\",\n \"content_object_readable_id\": \"ACT106\",\n \"content_object_unique_id\": \"f2cf4b3e-da5d-4a0b-a4f1-b0cf2d8b1ec5\",\n \"attachment_label\": null,\n \"description_with_img_src\": \"

Note For Custom Module

\",\n \"pinned\": false,\n \"field\": null,\n \"note_tag\": null\n}"}],"_postman_id":"22c15625-2706-4484-b068-db9c7d5d2138"},{"name":"Upload a File","id":"e1c7a44b-a14a-45d6-9c16-f5e07258e65c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"key":"uploaded_file","type":"file","src":"/Users/aashijain/Downloads/ZiClJf-1920w.jpeg"},{"key":"","value":"","type":"text","disabled":true}]},"url":"{{base_url}}v1/utils/file/:component_identifier/:instance_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Upload any type of file in the custom module entry as an attachment.

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`uploaded_file`	File	Mandatory	Enter the file to be uploaded.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	Text	Name of the file.
`description`	Text	Description of the file.
`uploaded_file`	URL	URL of the file from where it can be downloaded.
`unique_id`	String	Unique ID of the file.
`created_by_data`	Object	Details of the user who uploaded the file.
`created`	String	Upload date and time of the file.
`modified`	String	Last modified date and time of the file.
`readable_id`	String	Unique readable ID of the file.
`file_hash`	String	Hash value of the file.
`file_size`	Integer	Size of the uploaded file in Bytes.
`file_type`	Sting	Type of file attached. For example, artifact, evidence, and others.
`parent_readable_id`	String	`readable_id` of the entry in which the file is uploaded.
`parent_component`	String	Custom module name in which file is uploaded. Example: `incident`, `action`, and `event`.
`parent_unique_id`	String	`unique_id` of the entry in which the file is uploaded.
`is_removed`	Boolean	Displays if the file is in the deleted state or not.

","urlObject":{"path":["utils","file",":component_identifier",":instance_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the component Identifier of the module.

\n","type":"text/plain"},"type":"any","value":"module1","key":"component_identifier"},{"description":{"content":"

Enter the unique ID of the entry.

\n","type":"text/plain"},"type":"any","value":"822c2781-8ea0-4122-8176-8995a4c81dca","key":"instance_unique_id"}]}},"response":[{"id":"91ff05df-717c-473c-bb61-cbfc2cfdd437","name":"Upload a File","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"key":"uploaded_file","type":"file","src":"New creds to test api.csv"},{"key":"","value":"","type":"text","disabled":true}]},"url":{"raw":"{{base_url}}v1/utils/file/:component_identifier/:instance_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["utils","file",":component_identifier",":instance_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"component_identifier","value":"module1","description":"Enter the component Identifier of the module."},{"key":"instance_unique_id","value":"f2cf4b3e-da5d-4a0b-a4f1-b0cf2d8b1ec5","description":"Enter the unique ID of the entry."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 27 Jan 2024 13:47:47 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1557","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Server","value":"gunicorn/19.10.0","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"New creds to test api.csv\",\n \"description\": \"new attachment\",\n \"uploaded_file\": \"https://s3.ap-south-1.amazonaws.com/saas-cftr-cftrbucket/saas_cftr/ciims-data/b82fd0b3-New_creds_to_test_api.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA6G6UJGUPYQHTYUNW%2F20240127%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20240127T134747Z&X-Amz-Expires=120&X-Amz-SignedHeaders=host&X-Amz-Security-Token=FwoGZXIvYXdzEBcaDPsxUw9472NyeIDvXiLBAW6ac5Yc%2BA4OS5Bm0CInHsiXj2KBwpwuKvz86CT%2Be2I61%2B12Tj2nXz47d6pOkwXz1zvBsNxqn7Z2W7kwc9ADnBwq7TL12BfjD0XKkQDBCmm1YpiG7BKe%2BmDbUOT9DyUs2%2B6eBabdWSqtbkIW73dnTTRXag5jIZkvh3VdWowlAalzsAcJqBsPnCQi3d5z1aaQd5EilJM0dR5ZoFz3pYnnDun7zK2JWj2g%2FaJk%2BJTgoYNZYu0mjbGNH9EvTknAYgromtQogpPUrQYyLR202kU5l0P%2BYq7ENFESmFBmyZCFiGmJA6UBTa5Fvtbudw2ReEKKU0qZOpCneA%3D%3D&X-Amz-Signature=6322ec38a615b4a052ec0a9784e93a52108ad2df36e4bddd323915a9cfbe4f66\",\n \"unique_id\": \"7f693a93-21e6-4610-b054-38657aa85fe5\",\n \"created_by_data\": {\n \"username\": \"jane.d\",\n \"first_name\": \"jane\",\n \"last_name\": \"D\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"b3184a17-e59f-46cb-82c3-d8aabbefff7e\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"Jane D\"\n },\n \"created\": \"2024-01-27T13:47:46.258416Z\",\n \"modified\": \"2024-01-27T13:47:47.167586Z\",\n \"readable_id\": \"ART207\",\n \"is_removed\": false,\n \"readable_id_counter\": 207,\n \"file_hash\": \"2c3addd1f514ef7f07bcb4e64ec1b098\",\n \"file_type\": \"artifact\",\n \"file_size\": 164,\n \"can_delete\": true,\n \"parent_readable_id\": \"MOD106\",\n \"parent_component\": \"module1\",\n \"parent_unique_id\": \"f2cf4b3e-da5d-4a0b-a4f1-b0cf2d8b1ec5\"\n}"}],"_postman_id":"e1c7a44b-a14a-45d6-9c16-f5e07258e65c"}],"id":"b726aebd-024e-4e23-9a29-609bfbb6e4de","description":"

CFTR provides you the flexibility to create your own customized modules to meet your workflow and fusion center requirements. This section describes how to create and manage the entries of custom modules.

\n","_postman_id":"b726aebd-024e-4e23-9a29-609bfbb6e4de"},{"name":"Threat Briefings","item":[{"name":"Get List of Threat Briefings","id":"a777e267-e2ec-402d-81fa-66a1ee1f7546","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/threat-briefing/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve a list of Threat Briefings with details from the CFTR Application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/threat-briefing/?

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` key shows the API endpoint to the next page.
`count`	Integer	The total number of Threat Briefings returned as per the entered query parameters.
`results`	List of Objects	Details of the Threat Briefings. Each object provides the details of one Threat Briefing.

Response Parameters | Results Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the Threat Briefing.
`readable_id`	String	Readable ID of the Threat Briefing.
`title`	String	Title of the Threat Briefing.
`status`	String	Current status of the Threat Briefing. Allowed values: - ACTIVE - INACTIVE
`created`	String	Created date and time of the Threat Briefing.
`modified`	String	Last updated date and time of the Threat Briefing.
`title_display`	String	Title of the Threat Briefing.
`is_bookmarked`	Boolean	Shows whether the Threat Briefing is bookmarked or not.
`labels`	List	List of `unique_id` of the attached labels.
`labels_data`	List of Objects	Details of the attached labels.
`locations_data`	List of Objects	Details of the locations linked to the threat briefing.
`business_units_data`	List of Objects	Details of the business units linked to the threat briefing.
`created_by`	String	Unique ID of the user who created the threat briefing.
`created_by_data`	Object	Details of the user who created the threat briefing.

[optional] Enter the page number of the Threat Briefings list. This will retrieve the list of all threat briefings from the entered page.\nDefault value: 1

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

[optional] Enter the page size.\nAllowed values:\n10\n20\n50\n100

\n","type":"text/plain"},"key":"page_size","value":"10"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the Threat Briefings in EPOCH Time format.\nTime Zone must be as per UTC. All Threat Briefings with a creation date later than the entered time will be returned.

\n","type":"text/plain"},"key":"created_date__gte","value":"1644345000"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the Threat Briefings in EPOCH Time format.\nTime Zone must be as per UTC. All Threat Briefings with a creation date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"created_date__lte","value":"1644345000"},{"disabled":true,"description":{"content":"

[optional] Enter the last modified time of the Threat Briefings in EPOCH Time format.\nTime Zone must be as per UTC. All Threat Briefings with a modified date later than the entered time will be returned.

\n","type":"text/plain"},"key":"modified_date__gte","value":"1644345000"},{"disabled":true,"description":{"content":"

[optional] Enter the last modified time of the Threat Briefings in EPOCH Time format.\nTime Zone must be as per UTC. All Threat Briefings with a modified date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"modified_date__lte","value":"1644345000"},{"disabled":true,"description":{"content":"

[optional] Enter the status of the Threat Briefings to filter response results.\nAllowed values:

ACTIVE
INACTIVE

\n","type":"text/plain"},"key":"status","value":"ACTIVE"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID of the label. This parameter retrieves the Threat Briefings associated with the label.\nYou can retrieve the list of available Labels and their Unique IDs using the following API endpoint:\n/openapi/v1/utils/label/

\n","type":"text/plain"},"key":"labels","value":"4ca639c8-ccfb-486c-aee6-5e0471d959ea"}],"variable":[]}},"response":[{"id":"b5d140a7-6422-4c1d-a913-c3388be0058e","name":"Get list of Threat Briefings","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/cftrapi/openapi/v1/threat-briefing/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}"],"path":["cftrapi","openapi","v1","threat-briefing",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jun 2022 07:43:10 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"2225","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 2,\n \"results\": [\n {\n \"unique_id\": \"e1bbb0be-8ae2-4a54-b359-bf1ed22eefa2\",\n \"readable_id\": \"BRF102\",\n \"created\": \"2022-06-27T07:42:16.498545Z\",\n \"modified\": \"2022-06-27T07:42:16.741153Z\",\n \"locations_data\": [\n {\n \"title\": \"System\",\n \"country\": null,\n \"country_data\": null,\n \"state\": null,\n \"state_data\": null,\n \"city\": null,\n \"site\": null,\n \"pincode\": null,\n \"unique_id\": \"0aa1363d-c979-4268-9bdf-775d66e598ad\",\n \"created\": \"2022-05-26T06:55:00.409473Z\",\n \"modified\": \"2022-05-26T06:55:00.409473Z\"\n }\n ],\n \"business_units_data\": [\n {\n \"title\": \"New\",\n \"description\": \"fd\",\n \"unique_id\": \"b395e173-f8e4-4ad4-b50f-0125894f5ced\",\n \"created\": \"2022-06-02T09:05:11.674926Z\",\n \"modified\": \"2022-06-02T09:05:11.674926Z\",\n \"readable_id\": \"BU103\"\n }\n ],\n \"entity_data\": null,\n \"title\": \"Open\",\n \"status\": \"ACTIVE\",\n \"created_by_data\": {\n \"user_id\": \"3efcdba6-83a8-4921-a11c-4530d1d31947\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@example.com\",\n \"display_pic\": null,\n \"username\": \"john.doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"John Doe\"\n },\n \"created_by\": \"3efcdba6-83a8-4921-a11c-4530d1d31947\",\n \"is_bookmarked\": false,\n \"labels\": [],\n \"labels_data\": [],\n \"title_display\": \"Open\"\n },\n {\n \"unique_id\": \"fd615e0f-6404-4245-9a21-cd5492a55b71\",\n \"readable_id\": \"BRF101\",\n \"created\": \"2022-06-27T07:17:18.123259Z\",\n \"modified\": \"2022-06-27T07:38:37.011034Z\",\n \"locations_data\": [\n {\n \"title\": \"System\",\n \"country\": null,\n \"country_data\": null,\n \"state\": null,\n \"state_data\": null,\n \"city\": null,\n \"site\": null,\n \"pincode\": null,\n \"unique_id\": \"0aa1363d-c979-4268-9bdf-775d66e598ad\",\n \"created\": \"2022-05-26T06:55:00.409473Z\",\n \"modified\": \"2022-05-26T06:55:00.409473Z\"\n }\n ],\n \"business_units_data\": [\n {\n \"title\": \"New\",\n \"description\": \"fd\",\n \"unique_id\": \"b395e173-f8e4-4ad4-b50f-0125894f5ced\",\n \"created\": \"2022-06-02T09:05:11.674926Z\",\n \"modified\": \"2022-06-02T09:05:11.674926Z\",\n \"readable_id\": \"BU103\"\n }\n ],\n \"entity_data\": null,\n \"title\": \"Bridf\",\n \"status\": \"ACTIVE\",\n \"created_by_data\": {\n \"user_id\": \"3efcdba6-83a8-4921-a11c-4530d1d31947\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@example.com\",\n \"display_pic\": null,\n \"username\": \"john.doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"John Doe\"\n },\n \"created_by\": \"3efcdba6-83a8-4921-a11c-4530d1d31947\",\n \"is_bookmarked\": false,\n \"labels\": [],\n \"labels_data\": [],\n \"title_display\": \"Bridf\"\n }\n ]\n}"}],"_postman_id":"a777e267-e2ec-402d-81fa-66a1ee1f7546"},{"name":"Get Details of a Threat Briefing","id":"330699fe-57c7-47a2-9f86-2c210f96b5a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/threat-briefing/:threat_briefing_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the details of a specefic Threat Briefing from the CFTR application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/threat-briefing/:threat_briefing_unique_id/?

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

Response Parameters | Regulatory Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the Threat Briefing.
`readable_id`	String	Readable ID of the Threat Briefing.
`title`	String	Title of the Threat Briefing.
`description`	Text	Description of the threat briefing.
`status`	String	Current status of the Threat Briefing. Allowed values: - ACTIVE - INACTIVE
`created`	String	Created date and time of the Threat Briefing.
`modified`	String	Last updated date and time of the Threat Briefing.
`title_display`	String	Title of the Threat Briefing.
`is_bookmarked`	Boolean	Shows whether the Threat Briefing is bookmarked or not.
`labels`	List	List of `unique_id` of the attached labels.
`labels_data`	List of Objects	Details of the attached labels.
`locations_data`	List of Objects	Details of the locations linked to the Threat Briefing.
`business_units_data`	List of Objects	Details of the business units linked to the Threat Briefing.
`created_by`	String	Unique ID of the user who created the Threat Briefing.
`created_by_data`	Object	Details of the user who created the Threat Briefing.

Response Parameters | Connect The Dots

Following are the response parameters corresponding the Connect The Dots section of the Threat Briefing. The parameters ending with _data contain the meta information for each connected component. The non _data parameters include an array of unique IDs of the connected components.

Parameter	Type	Description
`applications`	Array of UUID Strings	List of `unique_id` of the connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`softwares`	Array of UUID Strings	List of `unique_id` of the connected software.
`softwares_data`	Array of Objects	Details of the connected software.
`users`	Array of UUID Strings	List of `unique_id` of the connected users.
`users_data`	Array of Objects	Details of the connected users.
`endpoints`	Array of UUID Strings	List of `unique_id` of the connected devices.
`endpoints_data`	Array of Objects	Details of the connected devices.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.

Response Parameters | Custom Form Fields

In addition to the above mentioned parameters, the response parameters may vary as per the form configuration defined by your CFTR admin for Threat Briefings. For such parameters, the field_readable_key of each parameter is returned in the response. To retrieve the field_readable_key and additional metadata of a parameter, use the Form Tab Structure API for Threat Briefings.

Example

The following endpoint retrieves the field_readable_key for all custom fields in the Threat Briefing component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=threat-briefing\n\n

Following are some of the sample custom fields for Threat Briefing:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters | Attachments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`attachments_data`	Array of Objects	Details of each attachment of the Threat Briefing.

Response Parameters | Actions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`actions_data`	Array of Objects	Details of the actions that are added for the Threat Briefing.

Response Parameters | Enhancements

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`enhancements`	Array of UUID Strings	List of the enhancements that are added for the Threat Briefing.
`enhancements_data`	Array of Objects	Details of the enhancements that are added for the Threat Briefing.

Response Parameters | PIRs

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`pirs_data`	Array of Objects	Details of the PIRs that are added for the Threat Briefing.

","urlObject":{"path":["threat-briefing",":threat_briefing_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of a Threat Briefing

\n","type":"text/plain"},"type":"any","value":"e1bbb0be-8ae2-4a54-b359-bf1ed22eefa2","key":"threat_briefing_unique_id"}]}},"response":[{"id":"a700a0c4-69e8-4113-acd6-935dfc3993b5","name":"Get details of a specific threat briefing","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/cftrapi/openapi/v1/threat-briefing/:threat_briefing_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}"],"path":["cftrapi","openapi","v1","threat-briefing",":threat_briefing_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"threat_briefing_unique_id","value":"e1bbb0be-8ae2-4a54-b359-bf1ed22eefa2","description":"Enter the unique ID of a Threat Briefing"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jun 2022 08:56:58 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"2088","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"briefing_frequency\": \"Daily\",\n \"unique_id\": \"e1bbb0be-8ae2-4a54-b359-bf1ed22eefa2\",\n \"readable_id\": \"BRF102\",\n \"created\": \"2022-06-27T07:42:16.498545Z\",\n \"modified\": \"2022-06-27T08:56:12.360892Z\",\n \"locations_data\": [\n {\n \"title\": \"System\",\n \"country\": null,\n \"country_data\": null,\n \"state\": null,\n \"state_data\": null,\n \"city\": null,\n \"site\": null,\n \"pincode\": null,\n \"unique_id\": \"0aa1363d-c979-4268-9bdf-775d66e598ad\",\n \"created\": \"2022-05-26T06:55:00.409473Z\",\n \"modified\": \"2022-05-26T06:55:00.409473Z\"\n }\n ],\n \"business_units_data\": [\n {\n \"title\": \"New\",\n \"description\": \"fd\",\n \"unique_id\": \"b395e173-f8e4-4ad4-b50f-0125894f5ced\",\n \"created\": \"2022-06-02T09:05:11.674926Z\",\n \"modified\": \"2022-06-02T09:05:11.674926Z\",\n \"readable_id\": \"BU103\"\n }\n ],\n \"entity_data\": null,\n \"title\": \"Open\",\n \"description\": null,\n \"actions_data\": [],\n \"campaigns_data\": [],\n \"incidents_data\": [],\n \"malwares_data\": [],\n \"threat_actors_data\": [],\n \"vulnerabilities_data\": [\n {\n \"unique_id\": \"b948bc9c-e26b-477c-b1f3-13c2bf5f6736\",\n \"readable_id\": \"VUL101\",\n \"title\": \"fdf\",\n \"status\": \"open\",\n \"created\": \"2022-06-05T07:22:17.579306Z\",\n \"modified\": \"2022-06-05T07:22:17.727201Z\",\n \"title_display\": \"fdf\",\n \"priority\": \"Low\"\n }\n ],\n \"campaigns\": [],\n \"incidents\": [],\n \"malwares\": [],\n \"threat_actors\": [],\n \"vulnerabilities\": [\n \"b948bc9c-e26b-477c-b1f3-13c2bf5f6736\"\n ],\n \"status\": \"ACTIVE\",\n \"created_by_data\": {\n \"user_id\": \"3efcdba6-83a8-4921-a11c-4530d1d31947\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"display_pic\": null,\n \"username\": \"jane.doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"Jane Doe\"\n },\n \"created_by\": \"3efcdba6-83a8-4921-a11c-4530d1d31947\",\n \"is_bookmarked\": false,\n \"enhancements_data\": [],\n \"pirs_data\": [],\n \"attachments_data\": [],\n \"labels\": [],\n \"labels_data\": [],\n \"applications\": [],\n \"applications_data\": [],\n \"asset_softwares\": [],\n \"asset_softwares_data\": [],\n \"users\": [],\n \"users_data\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"title_display\": \"Open\",\n \"briefing_frequency_data\": {\n \"unique_id\": \"3cd8ee93-e2c1-4a71-8553-23f70dc4b66b\",\n \"option_name\": \"Daily\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"6bd7a1b6-f9f5-4f92-a64a-aca5e39cb5bd\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n}"}],"_postman_id":"330699fe-57c7-47a2-9f86-2c210f96b5a1"},{"name":"Create Threat Briefing Using Field UUID","id":"233a887b-9aac-44b3-8466-d8600d5f07c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Threat Briefing 1.0.0\",\n \"business_units\": [\"b395e173-f8e4-4ad4-b50f-0125894f5ced\"],\n \"locations\": [\"0aa1363d-c979-4268-9bdf-775d66e598ad\"],\n \"briefing_frequency\": \"Daily\",\n \"description\": \"

Threat Briefing 7.0.0

\",\n \"status\": \"ACTIVE\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/threat-briefing/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Add a new Threat Briefing in the CFTR application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/threat-briefing/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`title`	String	Mandatory	Enter a title for the Threat Briefing
`business_units`	String	Mandatory	Enter the list of unique IDs of Business Units in UUID format.
`locations`	List	Mandatory	Enter the list of unique IDs of Locations in UUID format.
`briefing_frequency`	String	Optional	Enter the Frequency of the Threat Briefing Allowed values: - Daily - Weekly - Monthly - Special
`description`	Text	Optional	Enter a description of the Threat Briefing.
`status`	String	Optional	Enter the status of the Threat Briefing. Allowed values: - ACTIVE - INACTIVE Default value: ACTIVE

Request Parameters | Custom Form Fields

In addition to the above mentioned parameters, the request parameters may vary as per the form configuration defined by your CFTR admin for Threat Briefings. For such parameters, use the field_readable_key of each parameter. To retrieve the field_readable_key and additional metadata of a parameter, use the Form Tab Structure API for Threat Briefings.

Example

The following endpoint retrieves the field_readable_key for all custom fields in the Threat Briefings component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=threat-briefing\n\n

Following are some of the sample custom fields for Threat Briefings:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the Threat Briefing.
`readable_id`	String	Readable ID of the Threat Briefing.
`briefing_frequency`	String	Frequency of the Threat Briefing.
`title`	String	Title of the Threat Briefing.
`description`	Text	Description of the Threat Briefing.
`status`	String	Current status of the Threat Briefing. Allowed values: - ACTIVE - INACTIVE
`created`	String	Created date of the Threat Briefing.
`modified`	String	Last updated date of the Threat Briefing.
`title_display`	String	Title of the Threat Briefing.
`is_bookmarked`	Boolean	Shows whether the Threat Briefing is bookmarked or not.
`labels`	List	List of `unique_id` of the attached labels.
`labels_data`	List of Objects	Details of the attached labels.
`locations_data`	List of Objects	Details of the locations linked to the threat briefing.
`business_units_data`	List of Objects	Details of the Business units linked to the threat briefing.
`created_by`	String	Unique ID of the user who created the threat briefing.
`created_by_data`	Object	Details of the user who created the threat briefing.

Response Parameters | Connect The Dots

Following are the response parameters corresponding the Connect The Dots section of the threat briefing. The parameters ending with _data contain the meta information for each connected component. The non _data parameters include an array of unique IDs of the connected components.

Parameter	Type	Description
`applications`	Array of UUID Strings	List of `unique_id` of the connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`softwares`	Array of UUID Strings	List of `unique_id` of the connected software.
`softwares_data`	Array of Objects	Details of the connected software.
`users`	Array of UUID Strings	List of `unique_id` of the connected users.
`users_data`	Array of Objects	Details of the connected users.
`endpoints`	Array of UUID Strings	List of `unique_id` of the connected devices.
`endpoints_data`	Array of Objects	Details of the connected devices.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.

Response Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the Threat Briefing component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=threat-briefing\n\n

Following are some of the sample custom fields for threat-briefing:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters | Actions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`actions_data`	Array of Objects	Details of the actions that are added for the Threat Briefing.

Response Parameters | Enhancements

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`enhancements`	Array of UUID Strings	List of the enhancements that are added for the Threat Briefing.
`enhancements_data`	Array of Objects	Details of the enhancements that are added for the Threat Briefing.

Response Parameters | PIRs

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`pirs_data`	Array of Objects	Details of the PIRs that are added for the Threat Briefing.

","urlObject":{"path":["threat-briefing",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"f2b24147-0c4b-4a96-9e78-5b56e4751575","name":"Create Threat Brieifing","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Threat Briefing 1.0.0\",\n \"business_units\": [\"b395e173-f8e4-4ad4-b50f-0125894f5ced\"],\n \"locations\": [\"0aa1363d-c979-4268-9bdf-775d66e598ad\"],\n \"briefing_frequency\": \"Daily\",\n \"description\": \"

Threat Briefing 7.0.0

\",\n \"status\": \"ACTIVE\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/cftrapi/openapi/v1/threat-briefing/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}"],"path":["cftrapi","openapi","v1","threat-briefing",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jun 2022 09:06:31 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"2030","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"briefing_frequency\": \"Daily\",\n \"unique_id\": \"f78436de-40f5-4bf2-a6d2-db210d2c4446\",\n \"readable_id\": \"BRF105\",\n \"created\": \"2022-06-27T09:06:28.470387Z\",\n \"modified\": \"2022-06-27T09:06:28.574636Z\",\n \"locations_data\": [\n {\n \"title\": \"System\",\n \"country\": null,\n \"country_data\": null,\n \"state\": null,\n \"state_data\": null,\n \"city\": null,\n \"site\": null,\n \"pincode\": null,\n \"unique_id\": \"0aa1363d-c979-4268-9bdf-775d66e598ad\",\n \"created\": \"2022-05-26T06:55:00.409473Z\",\n \"modified\": \"2022-05-26T06:55:00.409473Z\"\n }\n ],\n \"business_units_data\": [\n {\n \"title\": \"New\",\n \"description\": \"fd\",\n \"unique_id\": \"b395e173-f8e4-4ad4-b50f-0125894f5ced\",\n \"created\": \"2022-06-02T09:05:11.674926Z\",\n \"modified\": \"2022-06-02T09:05:11.674926Z\",\n \"readable_id\": \"BU103\"\n }\n ],\n \"entity_data\": {\n \"title\": \"Cyber\",\n \"unique_id\": \"05a134a6-418f-49ce-ad2c-de9f9dfa7712\",\n \"created\": \"2022-05-26T06:55:00.384097Z\",\n \"modified\": \"2022-05-26T06:55:00.384097Z\"\n },\n \"title\": \"Threat Briefing 1.0.0\",\n \"description\": \"

Threat Briefing 7.0.0

\",\n \"actions_data\": [],\n \"campaigns_data\": [],\n \"incidents_data\": [],\n \"malwares_data\": [],\n \"threat_actors_data\": [],\n \"vulnerabilities_data\": [],\n \"campaigns\": [],\n \"incidents\": [],\n \"malwares\": [],\n \"threat_actors\": [],\n \"vulnerabilities\": [],\n \"status\": \"ACTIVE\",\n \"created_by_data\": {\n \"user_id\": \"3efcdba6-83a8-4921-a11c-4530d1d31947\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"display_pic\": null,\n \"username\": \"jane.doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"Jane Doe\"\n },\n \"created_by\": \"3efcdba6-83a8-4921-a11c-4530d1d31947\",\n \"is_bookmarked\": false,\n \"enhancements_data\": [],\n \"pirs_data\": [],\n \"attachments_data\": [],\n \"labels\": [],\n \"labels_data\": [],\n \"applications\": [],\n \"applications_data\": [],\n \"asset_softwares\": [],\n \"asset_softwares_data\": [],\n \"users\": [],\n \"users_data\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"title_display\": \"Threat Briefing 1.0.0\",\n \"briefing_frequency_data\": {\n \"unique_id\": \"3cd8ee93-e2c1-4a71-8553-23f70dc4b66b\",\n \"option_name\": \"Daily\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"6bd7a1b6-f9f5-4f92-a64a-aca5e39cb5bd\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n}"}],"_postman_id":"233a887b-9aac-44b3-8466-d8600d5f07c1"},{"name":"Create Threat Briefing Using Field Values","id":"8f29ea6d-0d57-4b41-b5b3-41a45e99e69e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Threat Briefing 1.0.0\",\n \"business_units\": [\"Bu 1\"],\n \"locations\": [\"Lo 1\"],\n \"briefing_frequency\": \"Daily\",\n \"description\": \"

Threat Briefing 7.0.0

\",\n \"status\": \"ACTIVE\",\n \"labels\": [\"Blue Label Threat Briefing\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/threat-briefing/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","description":"

Add a new Threat Briefing in the CFTR application using the values of locations, business units, and labels.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/threat-briefing/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`title`	String	Mandatory	Enter a title for the Threat Briefing
`business_units`	List	Mandatory	Enter the list of names of the Business Units.
`locations`	List	Mandatory	Enter the list of names of the impacted locations.
`briefing_frequency`	String	Optional	Enter the Frequency of the Threat Briefing Allowed values: - Daily - Weekly - Monthly - Special
`description`	Text	Optional	Enter a description of the Threat Briefing.
`status`	String	Optional	Enter the status of the Threat Briefing. Allowed values: - ACTIVE - INACTIVE Default value: ACTIVE
`labels`	List	Optional	Enter the list of the names of labels to be added to the threat briefing. You can use the following API endpoint to retrieve the list of Labels: `/openapi/v1/utils/label/`

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the Threat Briefings component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=threat-briefing\n\n

Following are some of the sample custom fields for Threat Briefings:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the Threat Briefing.
`readable_id`	String	Readable ID of the Threat Briefing.
`title`	String	Title of the Threat Briefing.
`description`	Text	Description of the Threat Briefing.
`status`	String	Current status of the Threat Briefing. Allowed values: - ACTIVE - INACTIVE
`created`	String	Created date of the Threat Briefing.
`modified`	String	Last updated date of the Threat Briefing.
`title_display`	String	Title of the Threat Briefing.
`is_bookmarked`	Boolean	Shows whether the Threat Briefing is bookmarked or not.
`labels`	List	List of `unique_id` of the attached labels.
`labels_data`	List of Objects	Details of the attached labels.
`locations_data`	List of Objects	Details of the locations linked to the threat briefing.
`business_units_data`	List of Objects	Details of the Business units linked to the threat briefing.
`created_by`	String	Unique ID of the user who created the threat briefing.
`created_by_data`	Object	Details of the user who created the threat briefing.
`briefing_frequency`	String	Frequency of the Threat Briefing.
`briefing_frequency_data`	Object	Details of the frequency of the threat briefing.

Response Parameters | Connect The Dots

Parameter	Type	Description
`applications`	Array of UUID Strings	List of `unique_id` of the connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`softwares`	Array of UUID Strings	List of `unique_id` of the connected software.
`softwares_data`	Array of Objects	Details of the connected software.
`users`	Array of UUID Strings	List of `unique_id` of the connected users.
`users_data`	Array of Objects	Details of the connected users.
`endpoints`	Array of UUID Strings	List of `unique_id` of the connected devices.
`endpoints_data`	Array of Objects	Details of the connected devices.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.

Response Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the Threat Briefing component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=threat-briefing\n\n

Following are some of the sample custom fields for threat-briefing:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters | Actions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`actions_data`	Array of Objects	Details of the actions that are added for the Threat Briefing.

Response Parameters | Enhancements

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`enhancements`	Array of UUID Strings	List of the enhancements that are added for the Threat Briefing.
`enhancements_data`	Array of Objects	Details of the enhancements that are added for the Threat Briefing.

Response Parameters | PIRs

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`pirs_data`	Array of Objects	Details of the PIRs that are added for the Threat Briefing.

Do not change the parameter value\nAllows you to create threat briefings using the values of locations, business units and labels.

\n","type":"text/plain"},"key":"values","value":"readable_type"}],"variable":[]}},"response":[{"id":"733c3ea7-a80a-4671-8957-b037e2c8b2b5","name":"201 Created: Create Threat Briefing Using Field Values","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Threat Briefing 1.0.0\",\n \"business_units\": [\"Bu 1\"],\n \"locations\": [\"Lo 1\"],\n \"briefing_frequency\": \"Daily\",\n \"description\": \"

Threat Briefing 7.0.0

\",\n \"status\": \"ACTIVE\",\n \"labels\": [\"Blue Label Threat Briefing\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/cftrapi/openapi/v1/threat-briefing/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","host":["{{base_url}}"],"path":["cftrapi","openapi","v1","threat-briefing",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"values","value":"readable_type","description":"**Do not change the parameter value**\nAllows you to create threat briefings using the values of locations, business units and labels."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Apr 2023 08:58:10 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"2156","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"briefing_frequency\": \"Daily\",\n \"unique_id\": \"a922eb95-9bec-48a4-83ba-a76d97facad8\",\n \"readable_id\": \"BRF102\",\n \"created\": \"2023-04-21T08:58:08.320170Z\",\n \"modified\": \"2023-04-21T08:58:08.557779Z\",\n \"locations_data\": [\n {\n \"title\": \"Lo 1\",\n \"unique_id\": \"274abeb6-7528-4e94-a6d3-ad9b30073ecd\",\n \"is_active\": true\n }\n ],\n \"business_units_data\": [\n {\n \"title\": \"Bu 1\",\n \"description\": \"First Bu\",\n \"unique_id\": \"f9d39c5a-0fe0-4ee8-bdb6-2e5f8b2fc35c\",\n \"created\": \"2023-04-21T07:00:09.971099Z\",\n \"modified\": \"2023-04-21T07:00:09.971099Z\",\n \"readable_id\": \"BU103\",\n \"email_list\": null\n }\n ],\n \"entity_data\": {\n \"title\": \"Cyber\",\n \"unique_id\": \"81400f66-0d5f-4abb-b3ee-b3feb23f0f14\",\n \"created\": \"2023-03-02T11:18:34.270849Z\",\n \"modified\": \"2023-03-02T11:18:34.270849Z\"\n },\n \"title\": \"Threat Briefing 1.0.0\",\n \"description\": \"

Threat Briefing 7.0.0

\",\n \"actions_data\": [],\n \"campaigns_data\": [],\n \"incidents_data\": [],\n \"malwares_data\": [],\n \"threat_actors_data\": [],\n \"vulnerabilities_data\": [],\n \"actions\": [],\n \"campaigns\": [],\n \"incidents\": [],\n \"malwares\": [],\n \"threat_actors\": [],\n \"vulnerabilities\": [],\n \"status\": \"ACTIVE\",\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"created_by\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_bookmarked\": false,\n \"enhancements\": [],\n \"enhancements_data\": [],\n \"pirs\": [],\n \"pirs_data\": [],\n \"attachments_data\": [],\n \"labels\": [\n \"6ce7a88b-1bbf-4008-8e7e-ee3c42d314c7\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"6ce7a88b-1bbf-4008-8e7e-ee3c42d314c7\",\n \"title\": \"Blue Label Threat Briefing\",\n \"color_code\": \"#4A148C\",\n \"created\": \"2023-04-21T08:55:26.596280Z\",\n \"modified\": \"2023-04-21T08:55:26.596280Z\"\n }\n ],\n \"applications\": [],\n \"applications_data\": [],\n \"asset_softwares\": [],\n \"asset_softwares_data\": [],\n \"users\": [],\n \"users_data\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"title_display\": \"Threat Briefing 1.0.0\",\n \"briefing_frequency_data\": {\n \"unique_id\": \"2c14b7d4-72c6-4260-becd-75efb0edba89\",\n \"option_name\": \"Daily\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"8ccb23af-6248-4859-8cf3-fe84217856ac\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n}"}],"_postman_id":"8f29ea6d-0d57-4b41-b5b3-41a45e99e69e"},{"name":"Update Threat Briefing Using Field UUID","id":"79a52a47-06fc-44f1-8b56-7d61fa550ec6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"briefing_frequency\": \"Weekly\",\n \"title\": \"Threat Briefing 2.0.0\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/threat-briefing/:threat_briefing_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Update the details of a Threat Briefing in the CFTR application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/threat-briefing/:threat_briefing_unique_id/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`title`	String	Optional	Enter a title for the Threat Briefing
`business_units`	String	Optional	Enter the list of unique IDs of Business Units in UUID format.
`locations`	List	Optional	Enter the list of unique IDs of Locations in UUID format.
`briefing_frequency`	String	Optional	Enter the Frequency of the Threat Briefing Allowed values: - Daily - Weekly - Monthly - Special
`description`	Text	Optional	Enter a description of the Threat Briefing.
`status`	String	Optional	Enter the status of the Threat Briefing. Allowed values: - ACTIVE - INACTIVE Default value: ACTIVE

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the Threat Briefing component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=threat-briefing\n\n

Following are some of the sample custom fields for Threat Briefings:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the Threat Briefing.
`readable_id`	String	Readable ID of the Threat Briefing.
`title`	String	Title of the Threat Briefing.
`description`	Text	Description of the Threat Briefing.
`status`	String	Current status of the Threat Briefing. Allowed values: - ACTIVE - INACTIVE
`created`	String	Created date of the Threat Briefing.
`modified`	String	Last updated date of the Threat Briefing.
`title_display`	String	Title of the Threat Briefing.
`is_bookmarked`	Boolean	Shows whether the Threat Briefing is bookmarked or not.
`labels`	List	List of `unique_id` of the attached labels.
`labels_data`	List of Objects	Details of the attached labels.
`locations_data`	List of Objects	Details of the locations linked to the threat briefing.
`business_units_data`	List of Objects	Details of the Business units linked to the threat briefing.
`created_by`	String	Unique ID of the user who created the threat briefing.
`created_by_data`	Object	Details of the user who created the threat briefing
`briefing_frequency_data`	Object	Details of the frequency of the threat briefing.

Response Parameters | Connect The Dots

Parameter	Type	Description
`applications`	Array of UUID Strings	List of `unique_id` of the connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`softwares`	Array of UUID Strings	List of `unique_id` of the connected software.
`softwares_data`	Array of Objects	Details of the connected software.
`users`	Array of UUID Strings	List of `unique_id` of the connected users.
`users_data`	Array of Objects	Details of the connected users.
`endpoints`	Array of UUID Strings	List of `unique_id` of the connected devices.
`endpoints_data`	Array of Objects	Details of the connected devices.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.

Response Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the Threat Briefing component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=threat-briefing\n\n

Following are some of the sample custom fields for threat-briefing:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters | Actions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`actions_data`	Array of Objects	Details of the actions that are added for the Threat Briefing.

Response Parameters | Enhancements

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`enhancements`	Array of UUID Strings	List of the enhancements that are added for the Threat Briefing.
`enhancements_data`	Array of Objects	Details of the enhancements that are added for the Threat Briefing.

Response Parameters | PIRs

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`pirs_data`	Array of Objects	Details of the PIRs that are added for the Threat Briefing.

Enter the unique ID of a Threat Briefing.

\n","type":"text/plain"},"type":"any","value":"f78436de-40f5-4bf2-a6d2-db210d2c4446","key":"threat_briefing_unique_id"}]}},"response":[{"id":"2955dd68-f464-4a9c-815e-4ac7b5b2e1f3","name":"Update a Threat Briefing","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"briefing_frequency\": \"Weekly\",\n \"title\": \"Threat Briefing 2.0.0\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/threat-briefing/:threat_briefing_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["threat-briefing",":threat_briefing_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"threat_briefing_unique_id","value":"f78436de-40f5-4bf2-a6d2-db210d2c4446","description":"Enter UUID of a Threat briefing\n"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jun 2022 09:08:45 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"2032","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"briefing_frequency\": \"Weekly\",\n \"unique_id\": \"f78436de-40f5-4bf2-a6d2-db210d2c4446\",\n \"readable_id\": \"BRF105\",\n \"created\": \"2022-06-27T09:06:28.470387Z\",\n \"modified\": \"2022-06-27T09:08:39.059390Z\",\n \"locations_data\": [\n {\n \"title\": \"System\",\n \"country\": null,\n \"country_data\": null,\n \"state\": null,\n \"state_data\": null,\n \"city\": null,\n \"site\": null,\n \"pincode\": null,\n \"unique_id\": \"0aa1363d-c979-4268-9bdf-775d66e598ad\",\n \"created\": \"2022-05-26T06:55:00.409473Z\",\n \"modified\": \"2022-05-26T06:55:00.409473Z\"\n }\n ],\n \"business_units_data\": [\n {\n \"title\": \"New\",\n \"description\": \"fd\",\n \"unique_id\": \"b395e173-f8e4-4ad4-b50f-0125894f5ced\",\n \"created\": \"2022-06-02T09:05:11.674926Z\",\n \"modified\": \"2022-06-02T09:05:11.674926Z\",\n \"readable_id\": \"BU103\"\n }\n ],\n \"entity_data\": {\n \"title\": \"Cyber\",\n \"unique_id\": \"05a134a6-418f-49ce-ad2c-de9f9dfa7712\",\n \"created\": \"2022-05-26T06:55:00.384097Z\",\n \"modified\": \"2022-05-26T06:55:00.384097Z\"\n },\n \"title\": \"Threat Briefing 2.0.0\",\n \"description\": \"

Threat Briefing 7.0.0

\",\n \"actions_data\": [],\n \"campaigns_data\": [],\n \"incidents_data\": [],\n \"malwares_data\": [],\n \"threat_actors_data\": [],\n \"vulnerabilities_data\": [],\n \"campaigns\": [],\n \"incidents\": [],\n \"malwares\": [],\n \"threat_actors\": [],\n \"vulnerabilities\": [],\n \"status\": \"ACTIVE\",\n \"created_by_data\": {\n \"user_id\": \"3efcdba6-83a8-4921-a11c-4530d1d31947\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"display_pic\": null,\n \"username\": \"jane.doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"Jane Doe\"\n },\n \"created_by\": \"3efcdba6-83a8-4921-a11c-4530d1d31947\",\n \"is_bookmarked\": false,\n \"enhancements_data\": [],\n \"pirs_data\": [],\n \"attachments_data\": [],\n \"labels\": [],\n \"labels_data\": [],\n \"applications\": [],\n \"applications_data\": [],\n \"asset_softwares\": [],\n \"asset_softwares_data\": [],\n \"users\": [],\n \"users_data\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"title_display\": \"Threat Briefing 2.0.0\",\n \"briefing_frequency_data\": {\n \"unique_id\": \"87c8e072-024e-4b3a-9f44-b8dee8c02164\",\n \"option_name\": \"Weekly\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"6bd7a1b6-f9f5-4f92-a64a-aca5e39cb5bd\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n}"}],"_postman_id":"79a52a47-06fc-44f1-8b56-7d61fa550ec6"},{"name":"Update Threat Briefing Using Field Values","id":"eedc54f9-b458-427a-b7e8-6610729cf20d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"business_units\": [\"System\"],\n \"locations\": [\"System\"],\n \"labels\": [\"Red Label Threat Briefing\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/threat-briefing/:threat_briefing_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","description":"

Update the details of a Threat Briefing in the CFTR application using the values of locations, business units, and labels.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/threat-briefing/:threat_briefing_unique_id/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`title`	String	Optional	Enter a title for the Threat Briefing
`business_units`	String	Optional	Enter the list of names of the Business Units.
`locations`	List	Optional	Enter the list of names of the impacted Locations.
`briefing_frequency`	String	Optional	Enter the Frequency of the Threat Briefing Allowed values: - Daily - Weekly - Monthly - Special
`description`	Text	Optional	Enter a description of the Threat Briefing.
`status`	String	Optional	Enter the status of the Threat Briefing. Allowed values: - ACTIVE - INACTIVE Default value: ACTIVE
`labels`	List	Optional	Enter the list of the names of labels to be added to the threat briefing. You can use the following API endpoint to retrieve the list of Labels: /openapi/v1/utils/label/

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the Threat Briefing component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=threat-briefing\n\n

Following are some of the sample custom fields for Threat Briefings:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the Threat Briefing.
`readable_id`	String	Readable ID of the Threat Briefing.
`title`	String	Title of the Threat Briefing.
`description`	Text	Description of the Threat Briefing.
`status`	String	Current status of the Threat Briefing. Allowed values: - ACTIVE - INACTIVE
`created`	String	Created date of the Threat Briefing.
`modified`	String	Last updated date of the Threat Briefing.
`title_display`	String	Title of the Threat Briefing.
`is_bookmarked`	Boolean	Shows whether the Threat Briefing is bookmarked or not.
`labels`	List	List of `unique_id` of the attached labels.
`labels_data`	List of Objects	Details of the attached labels.
`locations_data`	List of Objects	Details of the locations linked to the threat briefing
`business_units_data`	List of Objects	Details of the Business units linked to the threat briefing
`created_by`	String	Unique ID of the user who created the threat briefing.
`created_by_data`	Object	Details of the user who created the threat briefing
`briefing_frequency_data`	Object	Details of the frequency of the threat briefing.

Response Parameters | Connect The Dots

Parameter	Type	Description
`applications`	Array of UUID Strings	List of `unique_id` of the connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`softwares`	Array of UUID Strings	List of `unique_id` of the connected software.
`softwares_data`	Array of Objects	Details of the connected software.
`users`	Array of UUID Strings	List of `unique_id` of the connected users.
`users_data`	Array of Objects	Details of the connected users.
`endpoints`	Array of UUID Strings	List of `unique_id` of the connected devices.
`endpoints_data`	Array of Objects	Details of the connected devices.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.

Response Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the Threat Briefing component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=threat-briefing\n\n

Following are some of the sample custom fields for threat-briefing:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters | Actions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`actions_data`	Array of Objects	Details of the actions that are added for the Threat Briefing.

Response Parameters | Enhancements

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`enhancements`	Array of UUID Strings	List of the enhancements that are added for the Threat Briefing.
`enhancements_data`	Array of Objects	Details of the enhancements that are added for the Threat Briefing.

Response Parameters | PIRs

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`pirs_data`	Array of Objects	Details of the PIRs that are added for the Threat Briefing.

Do not change the parameter value\nAllows you to update threat briefings using the values of locations, business units and labels.

\n","type":"text/plain"},"key":"values","value":"readable_type"}],"variable":[{"description":{"content":"

Enter the unique ID of a Threat Briefing.

\n","type":"text/plain"},"type":"any","value":"a922eb95-9bec-48a4-83ba-a76d97facad8","key":"threat_briefing_unique_id"}]}},"response":[{"id":"0bff0805-7205-4b09-bae8-9b7cd87a230b","name":"200 OK: Update Threat Briefing Using Field Values","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"business_units\": [\"System\"],\n \"locations\": [\"System\"],\n \"labels\": [\"Red Label Threat Briefing\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/threat-briefing/:threat_briefing_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","host":["{{base_url}}v1"],"path":["threat-briefing",":threat_briefing_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"values","value":"readable_type","description":"**Do not change the parameter value**\nAllows you to update threat briefings using the values of locations, business units and labels."}],"variable":[{"key":"threat_briefing_unique_id","value":"a922eb95-9bec-48a4-83ba-a76d97facad8","description":"Enter the unique ID of a Threat Briefing."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Apr 2023 09:01:58 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"briefing_frequency\": \"Daily\",\n \"unique_id\": \"a922eb95-9bec-48a4-83ba-a76d97facad8\",\n \"readable_id\": \"BRF102\",\n \"created\": \"2023-04-21T08:58:08.320170Z\",\n \"modified\": \"2023-04-21T09:01:57.427217Z\",\n \"locations_data\": [\n {\n \"title\": \"System\",\n \"unique_id\": \"bb655f9f-a910-44a4-86f5-d56350d42dee\",\n \"is_active\": true\n }\n ],\n \"business_units_data\": [\n {\n \"title\": \"System\",\n \"description\": null,\n \"unique_id\": \"514f171a-0189-4aa5-bd71-564f7478b4b4\",\n \"created\": \"2023-03-02T11:18:34.273811Z\",\n \"modified\": \"2023-03-02T11:18:34.273811Z\",\n \"readable_id\": \"BU102\",\n \"email_list\": null\n }\n ],\n \"entity_data\": {\n \"title\": \"Cyber\",\n \"unique_id\": \"81400f66-0d5f-4abb-b3ee-b3feb23f0f14\",\n \"created\": \"2023-03-02T11:18:34.270849Z\",\n \"modified\": \"2023-03-02T11:18:34.270849Z\"\n },\n \"title\": \"Threat Briefing 1.0.0\",\n \"description\": \"

Threat Briefing 7.0.0

\",\n \"actions_data\": [],\n \"campaigns_data\": [],\n \"incidents_data\": [],\n \"malwares_data\": [],\n \"threat_actors_data\": [],\n \"vulnerabilities_data\": [],\n \"actions\": [],\n \"campaigns\": [],\n \"incidents\": [],\n \"malwares\": [],\n \"threat_actors\": [],\n \"vulnerabilities\": [],\n \"status\": \"ACTIVE\",\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"created_by\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_bookmarked\": false,\n \"enhancements\": [],\n \"enhancements_data\": [],\n \"pirs\": [],\n \"pirs_data\": [],\n \"attachments_data\": [],\n \"labels\": [\n \"860d1e6c-a6ff-4f60-adb0-bae0dccea8e1\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"860d1e6c-a6ff-4f60-adb0-bae0dccea8e1\",\n \"title\": \"Red Label Threat Briefing\",\n \"color_code\": \"#E64A19\",\n \"created\": \"2023-04-21T08:54:50.319446Z\",\n \"modified\": \"2023-04-21T08:54:50.319446Z\"\n }\n ],\n \"applications\": [],\n \"applications_data\": [],\n \"asset_softwares\": [],\n \"asset_softwares_data\": [],\n \"users\": [],\n \"users_data\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"title_display\": \"Threat Briefing 1.0.0\",\n \"briefing_frequency_data\": {\n \"unique_id\": \"2c14b7d4-72c6-4260-becd-75efb0edba89\",\n \"option_name\": \"Daily\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"8ccb23af-6248-4859-8cf3-fe84217856ac\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n}"}],"_postman_id":"eedc54f9-b458-427a-b7e8-6610729cf20d"},{"name":"Add Comment in a Threat Brieifing","id":"3881cfe4-9e21-4bf1-9d2c-839a4cb12d07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"description\": \"

Note For Threat Brieifing

\",\n \"mentioned_users_usernames\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/comments/threat-briefing/:threat_brieifing_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Add notes to a Threat Briefing in the CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`description`	String	Mandatory	Enter the content of the comment.
`mentioned_users_usernames`	List of UUID	Optional	Enter the list of usernames of the users to be mentioned in the comment.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the comment.
`description`	Text	Content of the comment.
`created_by`	Object	Details of the user who added the comment.
`modified_by`	Object	Details of the user who last updated the comment.
`mentioned_users`	List of UUID	List of `user_id` of users mentioned in the comment.
`mentioned_users_data`	List of Objects	Details of the users mentioned in the comment.
`created`	String	Comment creation time.
`modified`	String	Comment last updated time.
`comment_type`	String	Type of Comment. Examples: `discussion`: Notes added in an instance.
`content_object`	String	Component in which the comment is added. Example: `device`, `incident`, `action`, `ioc`, `vulnerability`, and so on.
`content_object_readable_id`	String	`readable_id` of the Threat Briefing in which the comment is added.
`content_object_unique_id`	String	`unique_id` of the Threat Briefing in which the comment is added.
`description_with_img_src`	Text	Description with the image URLs (if image is added in the comment).
`is_removed`	Boolean	Displays if the commented is in the deleted state or not.
`pinned`	Boolean	Displays if the comment is pinned or not.

","urlObject":{"path":["comments","threat-briefing",":threat_brieifing_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of a Threat Briefing.

\n","type":"text/plain"},"type":"any","value":"fd615e0f-6404-4245-9a21-cd5492a55b71","key":"threat_brieifing_unique_id"}]}},"response":[{"id":"1659e84e-036b-48f3-be2b-82286f6a2661","name":"Add Comment in a Threat Brieifing","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"description\": \"

Note For Threat Brieifing

\",\n \"mentioned_users_usernames\": []\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/comments/threat-briefing/:threat_brieifing_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["comments","threat-briefing",":threat_brieifing_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"threat_brieifing_unique_id","value":"645e53e6-be0d-4e0b-8f04-17ae04fee7d2","description":"Enter the unique ID of a Threat Briefing."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 27 Jan 2024 18:48:10 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"945","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Server","value":"gunicorn/19.10.0","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"unique_id\": \"d1c0ad38-a671-46d1-b545-8dcd6e30a6a4\",\n \"description\": \"

Note For Threat Brieifing

\",\n \"created_by\": {\n \"user_id\": \"b3184a17-e59f-46cb-82c3-d8aabbefff7e\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"display_pic\": null,\n \"username\": \"jane.doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"Jane Doe\"\n },\n \"modified_by\": null,\n \"is_removed\": false,\n \"mentioned_users\": [],\n \"mentioned_users_data\": [],\n \"created\": \"2024-01-27T18:48:10.677476Z\",\n \"modified\": \"2024-01-27T18:48:10.686422Z\",\n \"email\": null,\n \"internal\": false,\n \"comment_type\": \"discussion\",\n \"command_params\": {},\n \"command_result\": {},\n \"command_status\": \"na\",\n \"attachments_data\": [],\n \"content_object\": \"threat-briefing\",\n \"content_object_readable_id\": \"BRF118\",\n \"content_object_unique_id\": \"645e53e6-be0d-4e0b-8f04-17ae04fee7d2\",\n \"attachment_label\": null,\n \"description_with_img_src\": \"

Note For Threat Brieifing

\",\n \"pinned\": false,\n \"field\": null,\n \"note_tag\": null\n}"}],"_postman_id":"3881cfe4-9e21-4bf1-9d2c-839a4cb12d07"}],"id":"77458b14-8379-4b66-92de-8d2f89f322ab","description":"

Threat briefing is an act of communicating CFTR users with advanced intelligence and investigative information about a threat and the resources assigned to an incident response process.

This section describes how to use the API endpoints to manage threat briefings in the CFTR application.

\n","_postman_id":"77458b14-8379-4b66-92de-8d2f89f322ab"},{"name":"Applications","item":[{"name":"List Applications","id":"2883fdf6-1ba1-47ca-9185-de9241d2ba0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/application/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the details of a list of applications in CFTR.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/application/?

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the applications to the previous page. `next` key shows the API endpoint to the next page.
`count`	Integer	The total number of applications returned as per the entered query parameters.
`results`	List of Objects	Details of the applications. Each object provides the details of one application.

Response Parameters | Results Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the application.
`created`	String	Created date and time of the application.
`modified`	String	Last updated date and time of the application.
`title`	String	Title of the application.
`production_date`	String	Production date of application.
`readable_id`	String	Readable ID of the application.
`labels`	List	List of the labels associated with the application.
`labels_data`	List of Objects	Details of labels added to the application. The details include: `title`, `unique_id`, `color_code`, and so on.
`status`	String	Status of the application.

","urlObject":{"path":["application",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"disabled":true,"description":{"content":"

[optional] Enter the page number of the application list. This will retrieve the list of all application from the entered page.\nDefault value: 1

\n","type":"text/plain"},"key":"page","value":"2"},{"disabled":true,"description":{"content":"

[optional] Number of applications per page.\nDefault value: 10

\n","type":"text/plain"},"key":"page_size","value":"15"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID of the business unit. This parameter retrieves the applications associated with the business unit.\nYou can retrieve the list of available Business Units and their Unique IDs using the following API endpoint:\n/openapi/v1/utils/business-unit/

\n","type":"text/plain"},"key":"business_units","value":"9750d6df-2d7f-4899-b20d-bfbba0a9084d"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the applications in EPOCH Time format.\nTime Zone must be as per UTC. All applications with creation date later than the entered time will be returned.

\n","type":"text/plain"},"key":"created_date__gte","value":"1643999399"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the applications in EPOCH Time format.\nTime Zone must be as per UTC. All applications with creation date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"created_date__lte","value":"1643999399"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID of the label. This parameter retrieves the applications associated with the label.\nYou can retrieve the list of available Labels and their Unique IDs using the following API endpoint:\n/openapi/v1/utils/label/

\n","type":"text/plain"},"key":"labels","value":"c741bd45-1825-4dba-a30f-66088dcbbf8d"},{"disabled":true,"description":{"content":"

[optional] Enter the last modified time of the applications in EPOCH Time format.\nTime Zone must be as per UTC. All devices with modified date later than the entered time will be returned.

\n","type":"text/plain"},"key":"modified_date__gte","value":"1643999399"},{"disabled":true,"description":{"content":"

[optional] Enter the last modified time of the applications in EPOCH Time format.\nTime Zone must be as per UTC. All devices with modified date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"modified_date__lte","value":"1643999399"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID of the location. This parameter retrieves the applications associated with the location..\nYou can retrieve the list of available Locations and their Unique IDs using the following API endpoint:\n/openapi/v1/utils/location/

\n","type":"text/plain"},"key":"locations","value":"671961e6-0119-460c-8d55-9b697f6e2d6e"},{"disabled":true,"description":{"content":"

[optional] Enter the production time of the applications in EPOCH Time format.\nTime Zone must be as per UTC. All devices with modified date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"production_date__gte","value":"1643999399"},{"disabled":true,"description":{"content":"

[optional] Enter the production time of the applications in EPOCH Time format.\nTime Zone must be as per UTC. All devices with modified date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"production_date__gte","value":"1643999399"},{"disabled":true,"description":{"content":"

[optional] Enter the status of the applications to filter response results. \nAllowed values:\nactive, inactive

\n","type":"text/plain"},"key":"status","value":"active"}],"variable":[]}},"response":[{"id":"6e9f062c-e921-4362-ad64-bc633c5a98f0","name":"Get List of Applications","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/cftrapi/openapi/v1/application/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}"],"path":["cftrapi","openapi","v1","application",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"page","value":"2","description":"[optional] Enter the page number of the applicatin list. This will retrieve the list of all application from the entered page.\nDefault value: 1","disabled":true},{"key":"page_size","value":"15","description":"[optional] Number of applications per page.\nDefault value: 10","disabled":true},{"key":"business_units","value":"9750d6df-2d7f-4899-b20d-bfbba0a9084d","description":"[optional] Enter the unique ID of the business unit. This parameter retrieves the applications associated with the business unit.\nYou can retrieve the list of available Business Units and their Unique IDs using the following API endpoint:\n/openapi/v1/utils/business-unit/","disabled":true},{"key":"created_date__gte","value":"1643999399","description":"[optional] Enter the creation time of the applications in EPOCH Time format.\nTime Zone must be as per UTC. All applications with creation date later than the entered time will be returned.","disabled":true},{"key":"created_date__lte","value":"1643999399","description":"[optional] Enter the creation time of the applications in EPOCH Time format.\nTime Zone must be as per UTC. All applications with creation date earlier than the entered time will be returned.","disabled":true},{"key":"labels","value":"c741bd45-1825-4dba-a30f-66088dcbbf8d","description":"[optional] Enter the unique ID of the label. This parameter retrieves the applications associated with the label.\nYou can retrieve the list of available Labels and their Unique IDs using the following API endpoint:\n/openapi/v1/utils/label/","disabled":true},{"key":"modified_date__gte","value":"1643999399","description":"[optional] Enter the last modified time of the applications in EPOCH Time format.\nTime Zone must be as per UTC. All devices with modified date later than the entered time will be returned.","disabled":true},{"key":"modified_date__lte","value":"1643999399","description":"[optional] Enter the last modified time of the applications in EPOCH Time format.\nTime Zone must be as per UTC. All devices with modified date earlier than the entered time will be returned.","disabled":true},{"key":"locations","value":"671961e6-0119-460c-8d55-9b697f6e2d6e","description":"[optional] Enter the unique ID of the location. This parameter retrieves the devices associated with the location..\nYou can retrieve the list of available Locations and their Unique IDs using the following API endpoint:\n/openapi/v1/utils/location/","disabled":true},{"key":"production_date__gte","value":"1643999399","description":"[optional] Enter the production time of the applications in EPOCH Time format.\nTime Zone must be as per UTC. All devices with modified date earlier than the entered time will be returned.","disabled":true},{"key":"production_date__gte","value":"1643999399","description":"[optional] Enter the production time of the applications in EPOCH Time format.\nTime Zone must be as per UTC. All devices with modified date earlier than the entered time will be returned.","disabled":true},{"key":"status","value":"active","description":"[optional] Enter the status of the applications to filter response results. \nAllowed values:\nactive, inactive","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jun 2022 10:12:04 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"3096","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {\n \"next\": \"openapi/v1/application/?page=2&page_size=10&AccessID=8b5e5c6e-f9db-4a94-80cd-5faf77b06429&Expires=1656324738&Signature=TuzVTbOmCznDFYv4upzqdSoXKqY=\"\n },\n \"count\": 158,\n \"results\": [\n {\n \"unique_id\": \"a8007b20-bf76-4ce8-a761-45a453512479\",\n \"created\": \"2021-09-22T06:55:07.998925Z\",\n \"modified\": \"2022-06-27T04:42:12.908601Z\",\n \"title\": \"Regression3\",\n \"production_date\": null,\n \"readable_id\": \"APL249\",\n \"labels\": [],\n \"labels_data\": [],\n \"status\": \"active\"\n },\n {\n \"unique_id\": \"77033e03-dbaf-4fcd-bcb4-acd0a8907c2a\",\n \"created\": \"2022-06-15T13:53:32.548117Z\",\n \"modified\": \"2022-06-16T11:04:24.047517Z\",\n \"title\": \"app regress test\",\n \"production_date\": null,\n \"readable_id\": \"APL258\",\n \"labels\": [],\n \"labels_data\": [],\n \"status\": \"inactive\"\n },\n {\n \"unique_id\": \"34a9c739-457c-410f-8e04-58b8c2fa7f8e\",\n \"created\": \"2022-05-04T06:18:37.271728Z\",\n \"modified\": \"2022-06-15T07:35:59.213703Z\",\n \"title\": \"new test\",\n \"production_date\": null,\n \"readable_id\": \"APL257\",\n \"labels\": [\n \"9fc76c5d-ad08-4615-973f-7ce49485f930\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"9fc76c5d-ad08-4615-973f-7ce49485f930\",\n \"title\": \"app1\",\n \"color_code\": \"#C62828\",\n \"created\": \"2022-06-14T11:33:48.938460Z\",\n \"modified\": \"2022-06-14T11:33:48.938460Z\"\n }\n ],\n \"status\": \"active\"\n },\n {\n \"unique_id\": \"c234bda4-a134-493b-9445-a535c63358ba\",\n \"created\": \"2022-04-18T05:02:46.475616Z\",\n \"modified\": \"2022-06-13T13:26:21.860741Z\",\n \"title\": \"test\",\n \"production_date\": null,\n \"readable_id\": \"APL256\",\n \"labels\": [\n \"3fb8a533-8770-4532-8ef9-8d695d307aab\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"3fb8a533-8770-4532-8ef9-8d695d307aab\",\n \"title\": \"abc1\",\n \"color_code\": \"#43A047\",\n \"created\": \"2021-02-25T02:07:47.352256Z\",\n \"modified\": \"2021-02-25T02:07:47.352256Z\"\n }\n ],\n \"status\": \"inactive\"\n },\n {\n \"unique_id\": \"5153a63c-b460-4b20-b0c5-d508d847759e\",\n \"created\": \"2022-03-01T07:39:21.252456Z\",\n \"modified\": \"2022-04-14T10:20:02.889703Z\",\n \"title\": \"app_1\",\n \"production_date\": null,\n \"readable_id\": \"APL255\",\n \"labels\": [],\n \"labels_data\": [],\n \"status\": \"active\"\n },\n {\n \"unique_id\": \"c92f7d55-2d7e-428e-853f-784544d7beaa\",\n \"created\": \"2021-09-22T06:55:08.872561Z\",\n \"modified\": \"2022-02-03T11:14:10.051037Z\",\n \"title\": \"Regression6\",\n \"production_date\": null,\n \"readable_id\": \"APL252\",\n \"labels\": [],\n \"labels_data\": [],\n \"status\": \"active\"\n },\n {\n \"unique_id\": \"180b76cc-8704-4360-88cc-3e7e1b1a1c63\",\n \"created\": \"2021-09-22T06:55:09.453087Z\",\n \"modified\": \"2021-11-26T08:09:34.492426Z\",\n \"title\": \"Regression8\",\n \"production_date\": null,\n \"readable_id\": \"APL254\",\n \"labels\": [],\n \"labels_data\": [],\n \"status\": \"inactive\"\n },\n {\n \"unique_id\": \"a027b890-f33e-45ad-b85d-d0d95730d164\",\n \"created\": \"2021-09-22T06:55:08.297975Z\",\n \"modified\": \"2021-11-26T06:34:55.942339Z\",\n \"title\": \"Regression4\",\n \"production_date\": null,\n \"readable_id\": \"APL250\",\n \"labels\": [],\n \"labels_data\": [],\n \"status\": \"inactive\"\n },\n {\n \"unique_id\": \"ce866379-34ad-4c99-9ba9-8705e905769d\",\n \"created\": \"2021-09-22T06:55:07.366591Z\",\n \"modified\": \"2021-11-03T15:37:04.511986Z\",\n \"title\": \"Regression1\",\n \"production_date\": null,\n \"readable_id\": \"APL247\",\n \"labels\": [],\n \"labels_data\": [],\n \"status\": \"active\"\n },\n {\n \"unique_id\": \"273b6733-cb29-43b1-9697-14fab01d0590\",\n \"created\": \"2021-09-22T06:55:08.587646Z\",\n \"modified\": \"2021-09-22T06:57:00.774460Z\",\n \"title\": \"Regression5\",\n \"production_date\": null,\n \"readable_id\": \"APL251\",\n \"labels\": [],\n \"labels_data\": [],\n \"status\": \"active\"\n }\n ]\n}"}],"_postman_id":"2883fdf6-1ba1-47ca-9185-de9241d2ba0e"},{"name":"Get Application Details","id":"de8abdaa-9358-480d-aef7-fac5d75311cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/cftrapi/openapi/v1/application/:application_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the details of a specific application in CFTR.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/application/:application_unique_id/?

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

Response Parameters | Regulatory Fields

Parameter	Type	Description
`unique_id`	String	Unique ID of the application.
`created`	String	Application creation date and time.
`modified`	String	Application last updated date and time.
`title`	String	Title of the application.
`version`	Float	Version of the application.
`title_display`	String	Title of the application.
`readable_id`	String	Readable ID of the application.
`status`	String	Current status of the the application.
`application_type`	String	Type of the application. For example, Security.
`application_status`	String	Status of the application. For example, Live.
`production_date`	String	Production date of the application.
`created_by`	String	`user_id` of the user who created the application.
`created_by_data`	Object	Details of user who created the application.
`labels`	List	List of `unique_id` labels that are added to the application.
`labels_data`	List of Objects	Details of the labels that are added to the application.
`business_units_data`	List of Objects	Details of business units that are impacted by the application
`locations_data`	List of Objects	Details of locations that are impacted by the application.
`application_url`	URL	URL of the application.

Response Parameters | Connect The Dots

Following are the response parameters corresponding to the Connect The Dots section of the application. The parameters ending with _data include the meta information for each connected component. The non _data parameters include an array of unique IDs referencing to the connected components.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`owner_data`	Object	Details of the owner of the application.
`owner`	String	UUID of the application owner.
`manager_data`	Object	Details of the manager of the application.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.

Response Parameters | Custom Fields

In addition to the above mentioned parameters, the response parameters may vary as per the form configuration defined by your CFTR admin for applications. For such parameters, the field_readable_key of each parameter is returned in the response. To retrieve the field_readable_key and additional metadata of a parameter, use the Form Tab Structure API for devices.

Example

The following endpoint retrieves the field_readable_key for all custom fields in the application component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=application\n\n

Following are some of the sample custom fields for applications:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`version`	String	Optional
`purpose`	String	Optional

","urlObject":{"path":["cftrapi","openapi","v1","application",":application_unique_id",""],"host":["{{base_url}}"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the application.

\n","type":"text/plain"},"type":"any","value":"a8007b20-bf76-4ce8-a761-45a453512479","key":"application_unique_id"}]}},"response":[{"id":"7216089f-286f-4ca0-8826-370b57328866","name":"Get Application Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/cftrapi/openapi/v1/application/:application_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}"],"path":["cftrapi","openapi","v1","application",":application_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"application_unique_id","value":"4a1da1f9-7d2c-48ad-87d8-1d4b73faeb44","description":"Enter the unique ID of the application."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 27 Jan 2024 19:24:54 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"3330","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Server","value":"gunicorn/19.10.0","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"version\": null,\n \"application_url\": \"test@cyware.com2024-01-26\",\n \"purpose\": null,\n \"application_type\": \"Security\",\n \"application_status\": \"Live\",\n \"hosting_type\": null,\n \"development_type\": null,\n \"interface_type\": null,\n \"app_availability_rating\": \"1\",\n \"infosec_rating\": null,\n \"business_critical\": null,\n \"has_pii\": null,\n \"end_of_life\": null,\n \"internet_facing\": null,\n \"client_facing\": null,\n \"classified_information\": null,\n \"risk_rating\": null,\n \"criticality_rating\": null,\n \"compliance_rating\": null,\n \"pci_scoped_in\": null,\n \"sox_scoped_in\": null,\n \"crown_jewel\": null,\n \"waf_integration\": null,\n \"ddos_protection_coverage\": null,\n \"unique_id\": \"4a1da1f9-7d2c-48ad-87d8-1d4b73faeb44\",\n \"created\": \"2024-01-26T19:45:31.970408Z\",\n \"modified\": \"2024-01-26T19:47:58.808260Z\",\n \"title\": \"Created by Automation2024-01-26 19:44:51.803959\",\n \"production_date\": null,\n \"application_owner\": null,\n \"application_manager\": null,\n \"incidents\": [],\n \"incidents_data\": [],\n \"vulnerabilities\": [],\n \"vulnerabilities_data\": [],\n \"readable_id\": \"APL110\",\n \"application_owner_data\": null,\n \"application_manager_data\": null,\n \"labels\": [],\n \"labels_data\": [],\n \"threat_actors\": [],\n \"threat_actors_data\": [],\n \"briefings\": [],\n \"briefings_data\": [],\n \"malwares\": [],\n \"malwares_data\": [],\n \"enhancements\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"business_units_data\": [\n {\n \"title\": \"Automation2024-01-24 13:55:37.529503\",\n \"description\": null,\n \"unique_id\": \"bb746bfd-2996-45c0-b439-74ef4fd5e73b\",\n \"created\": \"2024-01-24T13:55:42.819333Z\",\n \"modified\": \"2024-01-24T13:55:42.819333Z\",\n \"readable_id\": \"BU104\",\n \"email_list\": null\n }\n ],\n \"actions\": [],\n \"softwares\": [],\n \"softwares_data\": [],\n \"locations_data\": [\n {\n \"title\": \"System\",\n \"unique_id\": \"cf005390-2500-472d-a6b2-73164b0d95fa\",\n \"is_active\": true\n }\n ],\n \"category_data\": null,\n \"created_by\": \"271e340d-e941-4083-99ac-681ed5db5d5c\",\n \"created_by_data\": {\n \"username\": \"automation\",\n \"first_name\": \"Ui\",\n \"last_name\": \"Automation\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"271e340d-e941-4083-99ac-681ed5db5d5c\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"cftr_qa@cyware.com\",\n \"full_name\": \"Ui Automation\"\n },\n \"app_status\": null,\n \"description\": null,\n \"asset_type\": null,\n \"criticality\": null,\n \"status\": \"active\",\n \"app_availability_rating_data\": {\n \"unique_id\": \"a7207786-be8c-4aa8-aca9-712390452061\",\n \"option_name\": \"1\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"837cdfa3-9c42-491e-bb06-6645d334e973\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"infosec_rating_data\": null,\n \"application_type_data\": {\n \"unique_id\": \"73c6b7f9-263a-42f3-902f-c88cd3ccd845\",\n \"option_name\": \"Security\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"48ee0656-f175-493f-9165-4783c76768de\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"business_critical_data\": null,\n \"application_status_data\": {\n \"unique_id\": \"30f08f6d-a806-4c6b-86f7-d75a036580a7\",\n \"option_name\": \"Live\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"a1107d69-c30c-419e-ade7-7188bf581c45\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"has_pii_data\": null,\n \"end_of_life_data\": null,\n \"internet_facing_data\": null,\n \"client_facing_data\": null,\n \"classified_information_data\": null,\n \"risk_rating_data\": null,\n \"hosting_type_data\": null,\n \"criticality_rating_data\": null,\n \"development_type_data\": null,\n \"compliance_rating_data\": null,\n \"interface_type_data\": null,\n \"pci_scoped_in_data\": null,\n \"sox_scoped_in_data\": null,\n \"crown_jewel_data\": null,\n \"waf_integration_data\": null,\n \"ddos_protection_coverage_data\": null\n}"}],"_postman_id":"de8abdaa-9358-480d-aef7-fac5d75311cb"},{"name":"Create Application Using Field UUID","id":"5098c539-f5c4-4425-a044-94eb39d21cf1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"test application from openapi 1\",\n \"application_url\": \"https://test.saasd.com/aswd\",\n \"locations\": [\n \"b3a8306f-6f1f-4c26-8dd0-ccfa40659858\"\n ],\n \"business_units\": [\n \"990b8401-9a8e-47cb-9b7f-67668dccf9c4\"\n ],\n \"application_status\": \"Decommissioned\",\n \"status\": \"inactive\"\n\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/cftrapi/openapi/v1/application/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Add a new application in the CFTR application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/application/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`title`	String	Mandatory	Enter the name of the application.
`application_url`	String	Mandatory	Enter the application URL if the application is internet hosted.
`application_status`	String	Mandatory	Enter the status of the application.
`business_units`	List	Mandatory	Enter the list of unique IDs of Business Units that are affected by the application. You can retrieve the list of available Business Units and their unique IDs using the following API endpoint: `/openapi/v1/utils/business-unit/`
`locations`	List	Mandatory	Enter the unique IDs of the impacted locations. You can retrieve the list of available locations and their unique IDs using the following API endpoint: `/openapi/v1/utils/location/`
`endpoint_status`	String	Optional	Enter the status of the application. Allowed Values: - active - inactive Default value: \"active\"

Request Parameters | Custom Form Fields

In addition to the above-mentioned parameters, the response parameters might vary as per the form configuration defined by your CFTR admin for applications. For such parameters, use the field_readable_key of each parameter. To retrieve the field_readable_key and additional metadata of a parameter, use the Form Tab Structure API for devices.

Example

The following endpoint retrieves the field_readable_key for all custom fields in the device component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=application\n\n

Following are some of the sample custom fields for devices:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`version`	String	Optional
`purpose`	String	Optional

Response Parameters

Response Parameters | Regulatory Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the application.
`created`	String	Application creation date and time.
`modified`	String	Application last updated date and time.
`application_url`	URL	URL of the application.
`title`	String	Title of the application.
`title_display`	String	Title of the application.
`readable_id`	String	Readable ID of the application.
`status`	String	Current status of the the application.
`production_date`	String	Production date of the application.
`created_by`	String	`user_id` of the user who created the application.
`created_by_data`	Object	Details of the user who created the application.
`labels`	List	List of `unique_id` of labels that are added to the application.
`labels_data`	List of Objects	Details of the labels that are added to the application.
`business_units_data`	List of Objects	Details of business units that are impacted by the application
`locations_data`	List of Objects	Details of locations that are impacted by the application.
`category_data`	Object	Details of the category of the application.

Response Parameters | Connect The Dots

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`application_owner_data`	Object	Details of the owner of the application.
`application_owner`	Strings	UUID of the application owner.
`application_manager_data`	Object	Details of the manager of the application.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.

Response Parameters | Custom Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the application component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=application\n\n

Following are some of the sample custom fields for applications:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`version`	String	Optional
`purpose`	String	Optional

","urlObject":{"path":["cftrapi","openapi","v1","application",""],"host":["{{base_url}}"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"d9fde956-7ec7-42dc-9dca-f7ea4ff39cbe","name":"Create Application","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"test application from openapi 1\",\n \"application_url\": \"https://test.saasd.com/aswd\",\n \"locations\": [\n \"b3a8306f-6f1f-4c26-8dd0-ccfa40659858\"\n ],\n \"business_units\": [\n \"990b8401-9a8e-47cb-9b7f-67668dccf9c4\"\n ],\n \"application_status\": \"Decommissioned\",\n \"status\": \"inactive\"\n\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/cftrapi/openapi/v1/application/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}"],"path":["cftrapi","openapi","v1","application",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jun 2022 12:50:35 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"2858","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"version\": null,\n \"test\": null,\n \"application_url\": \"https://test.saasd.com/aswd\",\n \"purpose\": null,\n \"sox_scoped_in\": null,\n \"business_critical\": null,\n \"client_facing\": null,\n \"crown_jewel\": null,\n \"pci_scoped_in\": null,\n \"waf_integration\": null,\n \"internet_facing\": null,\n \"risk_rating\": null,\n \"development_type\": null,\n \"ddos_protection_coverage\": null,\n \"app_availability_rating\": null,\n \"application_type\": null,\n \"classified_information\": null,\n \"application_status\": \"Decommissioned\",\n \"has_pii\": null,\n \"interface_type\": null,\n \"criticality_rating\": null,\n \"compliance_rating\": null,\n \"end_of_life\": null,\n \"infosec_rating\": null,\n \"hosting_type\": null,\n \"app_ms\": [],\n \"unique_id\": \"add4c232-2ebe-45b5-aa94-f922f42d1694\",\n \"created\": \"2022-06-27T12:50:34.788848Z\",\n \"modified\": \"2022-06-27T12:50:34.855221Z\",\n \"title\": \"test application from openapi 1\",\n \"production_date\": null,\n \"application_owner\": null,\n \"application_manager\": null,\n \"incidents_data\": [],\n \"vulnerabilities\": [],\n \"vulnerabilities_data\": [],\n \"readable_id\": \"APL261\",\n \"application_owner_data\": null,\n \"application_manager_data\": null,\n \"labels\": [],\n \"labels_data\": [],\n \"threat_actors\": [],\n \"threat_actors_data\": [],\n \"briefings\": [],\n \"briefings_data\": [],\n \"malwares\": [],\n \"malwares_data\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"business_units_data\": [\n {\n \"title\": \"Alpine Starlight\",\n \"description\": null,\n \"unique_id\": \"990b8401-9a8e-47cb-9b7f-67668dccf9c4\",\n \"created\": \"2021-04-21T06:41:32.755182Z\",\n \"modified\": \"2021-04-21T06:41:32.755182Z\",\n \"readable_id\": \"BU173\"\n }\n ],\n \"softwares\": [],\n \"softwares_data\": [],\n \"locations_data\": [\n {\n \"title\": \"Albania\",\n \"unique_id\": \"b3a8306f-6f1f-4c26-8dd0-ccfa40659858\"\n }\n ],\n \"category_data\": {\n \"title\": \"Cyber\",\n \"unique_id\": \"aa92e79c-2efc-4a8b-be9b-567607c52c36\"\n },\n \"created_by\": \"830ae605-1209-47dd-8382-eded47622436\",\n \"created_by_data\": {\n \"user_id\": \"3efcdba6-83a8-4921-a11c-4530d1d31947\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"display_pic\": null,\n \"username\": \"jane.doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"Jane Doe\"\n },\n \"app_status\": null,\n \"description\": null,\n \"asset_type\": null,\n \"criticality\": null,\n \"status\": \"inactive\",\n \"hosting_type_data\": null,\n \"app_availability_rating_data\": null,\n \"infosec_rating_data\": null,\n \"development_type_data\": null,\n \"has_pii_data\": null,\n \"application_type_data\": null,\n \"application_status_data\": {\n \"unique_id\": \"f5df4c75-3ec7-4384-b144-438ddb3d8375\",\n \"option_name\": \"Decommissioned\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"b4acec86-e15a-48f0-889a-a00ea327adb1\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"end_of_life_data\": null,\n \"interface_type_data\": null,\n \"internet_facing_data\": null,\n \"client_facing_data\": null,\n \"classified_information_data\": null,\n \"app_ms_data\": [],\n \"criticality_rating_data\": null,\n \"risk_rating_data\": null,\n \"business_critical_data\": null,\n \"compliance_rating_data\": null,\n \"pci_scoped_in_data\": null,\n \"sox_scoped_in_data\": null,\n \"crown_jewel_data\": null,\n \"waf_integration_data\": null,\n \"ddos_protection_coverage_data\": null\n}"}],"_postman_id":"5098c539-f5c4-4425-a044-94eb39d21cf1"},{"name":"Create Application Using Field Values","id":"68c4d5d5-bf98-40dd-b7e6-687319b20d7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"test application from openapi 1\",\n \"application_url\": \"https://test.saasd.com/aswd\",\n \"locations\": [\n \"Lo 1\"\n ],\n \"business_units\": [\n \"Bu 1\"\n ],\n \"application_status\": \"Decommissioned\",\n \"status\": \"inactive\",\n \"labels\": [\"Blue Label Application\"]\n\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}v1/application/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","description":"

Add a new application in the CFTR application using the values of locations, business units, and labels.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/application/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`title`	String	Mandatory	Enter the name of the application.
`application_url`	String	Mandatory	Enter the application URL if the application is internet hosted.
`application_status`	String	Mandatory	Enter the status of the application.
`business_units`	List	Mandatory	Enter the list of names of Business Units that are affected by the application. You can retrieve the list of available Business Units and their names using the following API endpoint: `/openapi/v1/utils/business-unit/`
`locations`	List	Mandatory	Enter the list of names of the impacted locations. You can retrieve the list of available locations and their names using the following API endpoint: `/openapi/v1/utils/location/`
`endpoint_status`	String	Optional	Enter the status of the application. Allowed Values: - active - inactive Default value: \"active\"
`labels`	List	Optional	Enter the list of the names of labels to be added to the application. You can use the following API endpoint to retrieve the list of Labels: /`openapi/v1/utils/label/`

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the device component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=application\n\n

Following are some of the sample custom fields for devices:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`version`	String	Optional
`purpose`	String	Optional

Response Parameters

Response Parameters | Regulatory Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the application.
`created`	String	Application creation date and time.
`modified`	String	Application last updated date and time.
`application_url`	URL	URL of the application.
`title`	String	Title of the application.
`title_display`	String	Title of the application.
`readable_id`	String	Readable ID of the application. For example, APL103.
`status`	String	Current status of the the application.
`production_date`	String	Production date of the application.
`created_by`	String	`user_id` of the user who created the application.
`created_by_data`	Object	Details of user who created the application.
`labels`	List	List of `unique_id` labels that are added to the application.
`labels_data`	List of Objects	Details of the labels that are added to the application.
`business_units_data`	List of Objects	Details of business units that are impacted by the application
`locations_data`	List of Objects	Details of locations that are impacted by the application.
`category_data`	Object	Details of the category of the application.

Response Parameters | Connect The Dots

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`application_owner_data`	Object	Details of the owner of the application.
`application_owner`	Strings	UUID of the application owner.
`application_manager_data`	Object	Details of the manager of the application.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.

Response Parameters | Custom Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the application component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=application\n\n

Following are some of the sample custom fields for applications:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`version`	String	Optional
`purpose`	String	Optional

","urlObject":{"path":["application",""],"host":["{{base_url}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"description":{"content":"

Do not change the parameter value\nAllows you to create applications using the values of locations, business units and labels.

\n","type":"text/plain"},"key":"values","value":"readable_type"}],"variable":[]}},"response":[{"id":"d3023d20-482b-4ec0-bb70-e1568b713687","name":"201 Created: Create Application Using Field Values","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"test application from openapi 1\",\n \"application_url\": \"https://test.saasd.com/aswd\",\n \"locations\": [\n \"Lo 1\"\n ],\n \"business_units\": [\n \"Bu 1\"\n ],\n \"application_status\": \"Decommissioned\",\n \"status\": \"inactive\",\n \"labels\": [\"Blue Label Application\"]\n\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/cftrapi/openapi/v1/application/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","host":["{{base_url}}"],"path":["cftrapi","openapi","v1","application",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"values","value":"readable_type","description":"**Do not change the parameter value**\nAllows you to create applications using the values of locations, business units and labels."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Apr 2023 09:19:27 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"3141","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"version\": null,\n \"application_url\": \"https://test.saasd.com/aswd\",\n \"purpose\": null,\n \"application_type\": null,\n \"application_status\": \"Decommissioned\",\n \"hosting_type\": null,\n \"development_type\": null,\n \"interface_type\": null,\n \"app_availability_rating\": null,\n \"infosec_rating\": null,\n \"business_critical\": null,\n \"has_pii\": null,\n \"end_of_life\": null,\n \"internet_facing\": null,\n \"client_facing\": null,\n \"classified_information\": null,\n \"risk_rating\": null,\n \"criticality_rating\": null,\n \"compliance_rating\": null,\n \"pci_scoped_in\": null,\n \"sox_scoped_in\": null,\n \"crown_jewel\": null,\n \"waf_integration\": null,\n \"ddos_protection_coverage\": null,\n \"unique_id\": \"29c7861f-f25b-4835-a0a0-ae4f9526aff0\",\n \"created\": \"2023-04-21T09:19:25.915605Z\",\n \"modified\": \"2023-04-21T09:19:26.058319Z\",\n \"title\": \"test application from openapi 1\",\n \"production_date\": null,\n \"application_owner\": null,\n \"application_manager\": null,\n \"incidents\": [],\n \"incidents_data\": [],\n \"vulnerabilities\": [],\n \"vulnerabilities_data\": [],\n \"readable_id\": \"APL101\",\n \"application_owner_data\": null,\n \"application_manager_data\": null,\n \"labels\": [\n \"771b2875-8732-4ff0-a41d-3448928fa195\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"771b2875-8732-4ff0-a41d-3448928fa195\",\n \"title\": \"Blue Label Application\",\n \"color_code\": \"#2E7D32\",\n \"created\": \"2023-04-21T09:18:41.170110Z\",\n \"modified\": \"2023-04-21T09:18:41.170110Z\"\n }\n ],\n \"threat_actors\": [],\n \"threat_actors_data\": [],\n \"briefings\": [],\n \"briefings_data\": [],\n \"malwares\": [],\n \"malwares_data\": [],\n \"enhancements\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"business_units_data\": [\n {\n \"title\": \"Bu 1\",\n \"description\": \"First Bu\",\n \"unique_id\": \"f9d39c5a-0fe0-4ee8-bdb6-2e5f8b2fc35c\",\n \"created\": \"2023-04-21T07:00:09.971099Z\",\n \"modified\": \"2023-04-21T07:00:09.971099Z\",\n \"readable_id\": \"BU103\",\n \"email_list\": null\n }\n ],\n \"actions\": [],\n \"softwares\": [],\n \"softwares_data\": [],\n \"locations_data\": [\n {\n \"title\": \"Lo 1\",\n \"unique_id\": \"274abeb6-7528-4e94-a6d3-ad9b30073ecd\",\n \"is_active\": true\n }\n ],\n \"category_data\": {\n \"title\": \"Cyber\",\n \"unique_id\": \"81400f66-0d5f-4abb-b3ee-b3feb23f0f14\"\n },\n \"created_by\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"app_status\": null,\n \"description\": null,\n \"asset_type\": null,\n \"criticality\": null,\n \"status\": \"inactive\",\n \"app_availability_rating_data\": null,\n \"infosec_rating_data\": null,\n \"application_type_data\": null,\n \"business_critical_data\": null,\n \"application_status_data\": {\n \"unique_id\": \"10f7a168-fcb2-416a-8efe-d6b24b8aa45b\",\n \"option_name\": \"Decommissioned\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"fa036c9a-39ca-4d34-ac3d-7751b1461827\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"has_pii_data\": null,\n \"end_of_life_data\": null,\n \"internet_facing_data\": null,\n \"client_facing_data\": null,\n \"classified_information_data\": null,\n \"risk_rating_data\": null,\n \"hosting_type_data\": null,\n \"criticality_rating_data\": null,\n \"development_type_data\": null,\n \"compliance_rating_data\": null,\n \"interface_type_data\": null,\n \"pci_scoped_in_data\": null,\n \"sox_scoped_in_data\": null,\n \"crown_jewel_data\": null,\n \"waf_integration_data\": null,\n \"ddos_protection_coverage_data\": null\n}"}],"_postman_id":"68c4d5d5-bf98-40dd-b7e6-687319b20d7a"},{"name":"Update Application Using Field UUID","id":"6a1c2648-4b27-4456-af3d-cbb66b2c18f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": \"active\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/application/:application_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Update the details of an application in the CFTR application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/application/:application_unique_id/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`title`	String	Optional	Enter the name of the application.
`application_url`	String	Optional	Enter the application URL if the application is internet hosted.
`business_units`	List	Optional	Enter the list of unique IDs of Business Units that are affected by the application. You can retrieve the list of available Business Units and their unique IDs using the following API endpoint: `/openapi/v1/utils/business-unit/`
`locations`	List	Optional	Enter the unique IDs of the impacted locations. You can retrieve the list of available locations and their unique IDs using the following API endpoint: `/openapi/v1/utils/location/`
`endpoint_status`	String	Optional	Enter the status of the application. Allowed Values: - active - inactive Default value: \"active\"
application_status	String	Optional	Enter the status of the application.

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the device component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=application\n\n

Following are some of the sample custom fields for devices:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`version`	String	Optional
`purpose`	String	Optional

Response Parameters

Response Parameters | Regulatory Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the application.
`created`	String	Application creation date and time.
`application_url`	URL	URL of the application.
`application_status`	String	Status of the application. For example, Decomissioned.
`modified`	String	Application last updated date and time.
`title`	String	Title of the application.
`title_display`	String	Title of the application.
`readable_id`	String	Readable ID of the application. For example, APL103.
`status`	String	Current status of the the application.
`production_date`	String	Production date of the application.
`created_by`	String	`user_id` of the user who created the application.
`created_by_data`	Object	Details of user who created the application.
`labels`	List	List of `unique_id` labels that are added to the application.
`labels_data`	List of Objects	Details of the labels that are added to the application.
`business_units_data`	List of Objects	Details of business units that are impacted by the application
`locations_data`	List of Objects	Details of locations that are impacted by the application.
`category_data`	Object	Details of the category of the application.

Response Parameters | Connect The Dots

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`application_owner_data`	Object	Details of the owner of the application.
`application_owner`	Strings	UUID of the application owner.
`application_manager_data`	Object	Details of the manager of the application.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.

Response Parameters | Custom Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the application component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=application\n\n

Following are some of the sample custom fields for applications:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`version`	String	Optional
`purpose`	String	Optional

","urlObject":{"path":["application",":application_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the application.

\n","type":"text/plain"},"type":"any","value":"add4c232-2ebe-45b5-aa94-f922f42d1694","key":"application_unique_id"}]}},"response":[{"id":"c980f205-4f7e-43d1-9680-d61e88b79119","name":"Update Application","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": \"active\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/cftrapi/openapi/v1/application/:application_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}"],"path":["cftrapi","openapi","v1","application",":application_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"application_unique_id","value":"add4c232-2ebe-45b5-aa94-f922f42d1694"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jun 2022 13:02:24 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"2856","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"version\": null,\n \"test\": null,\n \"application_url\": \"https://test.saasd.com/aswd\",\n \"purpose\": null,\n \"sox_scoped_in\": null,\n \"business_critical\": null,\n \"client_facing\": null,\n \"crown_jewel\": null,\n \"pci_scoped_in\": null,\n \"waf_integration\": null,\n \"internet_facing\": null,\n \"risk_rating\": null,\n \"development_type\": null,\n \"ddos_protection_coverage\": null,\n \"app_availability_rating\": null,\n \"application_type\": null,\n \"classified_information\": null,\n \"application_status\": \"Decommissioned\",\n \"has_pii\": null,\n \"interface_type\": null,\n \"criticality_rating\": null,\n \"compliance_rating\": null,\n \"end_of_life\": null,\n \"infosec_rating\": null,\n \"hosting_type\": null,\n \"app_ms\": [],\n \"unique_id\": \"add4c232-2ebe-45b5-aa94-f922f42d1694\",\n \"created\": \"2022-06-27T12:50:34.788848Z\",\n \"modified\": \"2022-06-27T13:02:23.563666Z\",\n \"title\": \"test application from openapi 1\",\n \"production_date\": null,\n \"application_owner\": null,\n \"application_manager\": null,\n \"incidents_data\": [],\n \"vulnerabilities\": [],\n \"vulnerabilities_data\": [],\n \"readable_id\": \"APL261\",\n \"application_owner_data\": null,\n \"application_manager_data\": null,\n \"labels\": [],\n \"labels_data\": [],\n \"threat_actors\": [],\n \"threat_actors_data\": [],\n \"briefings\": [],\n \"briefings_data\": [],\n \"malwares\": [],\n \"malwares_data\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"business_units_data\": [\n {\n \"title\": \"Alpine Starlight\",\n \"description\": null,\n \"unique_id\": \"990b8401-9a8e-47cb-9b7f-67668dccf9c4\",\n \"created\": \"2021-04-21T06:41:32.755182Z\",\n \"modified\": \"2021-04-21T06:41:32.755182Z\",\n \"readable_id\": \"BU173\"\n }\n ],\n \"softwares\": [],\n \"softwares_data\": [],\n \"locations_data\": [\n {\n \"title\": \"Albania\",\n \"unique_id\": \"b3a8306f-6f1f-4c26-8dd0-ccfa40659858\"\n }\n ],\n \"category_data\": {\n \"title\": \"Cyber\",\n \"unique_id\": \"aa92e79c-2efc-4a8b-be9b-567607c52c36\"\n },\n \"created_by\": \"830ae605-1209-47dd-8382-eded47622436\",\n \"created_by_data\": {\n \"user_id\": \"3efcdba6-83a8-4921-a11c-4530d1d31947\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"email\": \"jane.doe@example.com\",\n \"display_pic\": null,\n \"username\": \"jane.doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"Jane Doe\"\n },\n \"app_status\": null,\n \"description\": null,\n \"asset_type\": null,\n \"criticality\": null,\n \"status\": \"active\",\n \"hosting_type_data\": null,\n \"app_availability_rating_data\": null,\n \"infosec_rating_data\": null,\n \"development_type_data\": null,\n \"has_pii_data\": null,\n \"application_type_data\": null,\n \"application_status_data\": {\n \"unique_id\": \"f5df4c75-3ec7-4384-b144-438ddb3d8375\",\n \"option_name\": \"Decommissioned\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"b4acec86-e15a-48f0-889a-a00ea327adb1\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"end_of_life_data\": null,\n \"interface_type_data\": null,\n \"internet_facing_data\": null,\n \"client_facing_data\": null,\n \"classified_information_data\": null,\n \"app_ms_data\": [],\n \"criticality_rating_data\": null,\n \"risk_rating_data\": null,\n \"business_critical_data\": null,\n \"compliance_rating_data\": null,\n \"pci_scoped_in_data\": null,\n \"sox_scoped_in_data\": null,\n \"crown_jewel_data\": null,\n \"waf_integration_data\": null,\n \"ddos_protection_coverage_data\": null\n}"}],"_postman_id":"6a1c2648-4b27-4456-af3d-cbb66b2c18f9"},{"name":"Update Application Using Field Values","id":"5a33d3d8-4968-4d0e-8cc6-201e74b8f30c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"locations\": [\n \"System\"\n ],\n \"business_units\": [\n \"System\"\n ],\n \"labels\": [\"Red Label Application\"],\n \"status\": \"active\"\n\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/application/:application_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","description":"

Update the details of an application in the CFTR application using the values of locations, business units, and labels.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/application/:application_unique_id/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`title`	String	Optional	Enter the name of the application.
`application_url`	String	Optonal	Enter the application URL if the application is internet hosted.
`application_status`	String	Optional	Status of the application. For example, decomissioned.
`business_units`	List	Optional	Enter the list of names of Business Units that are affected by the application. You can retrieve the list of available Business Units and their names using the following API endpoint: `/openapi/v1/utils/business-unit/`
`locations`	List	Optional	Enter the list of names of the impacted locations. You can retrieve the list of available locations and their names using the following API endpoint: `/openapi/v1/utils/location/`
`endpoint_status`	String	Optional	Enter the status of the application. Allowed Values: - active - inactive Default value: \"active\"
`labels`	List	Optional	Enter the list of the names of labels to be added to the application. You can use the following API endpoint to retrieve the list of Labels: /`openapi/v1/utils/label/`

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the device component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=application\n\n

Following are some of the sample custom fields for devices:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`version`	String	Optional
`purpose`	String	Optional

Response Parameters

Response Parameters | Regulatory Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the application.
`application_url`	URL	URL of the application.
`application_status`	String	Status of the application.
`created`	String	Application creation date and time.
`modified`	String	Application last updated date and time.
`title`	String	Title of the application.
`readable_id`	String	Readable ID of the application.
`status`	String	Current status of the the application.
`production_date`	String	Production date of the application.
`created_by`	String	`user_id` of the user who created the application.
`created_by_data`	Object	Details of user who created the application.
`labels`	List	List of `unique_id` labels that are added to the application.
`labels_data`	List of Objects	Details of the labels that are added to the application.
`business_units_data`	List of Objects	Details of business units that are impacted by the application
`locations_data`	List of Objects	Details of locations that are impacted by the application.
`category_data`	Object	Details of the category of the data.

Response Parameters | Connect The Dots

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`application_owner_data`	Object	Details of the owner of the application.
`application_owner`	Strings	UUID of the application owner.
`application_manager_data`	Object	Details of the manager of the application.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.

Response Parameters | Custom Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the application component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=application\n\n

Following are some of the sample custom fields for applications:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`version`	String	Optional
`purpose`	String	Optional

Do not change the parameter value\nAllows you to update applications using the values of locations, business units and labels.

\n","type":"text/plain"},"key":"values","value":"readable_type"}],"variable":[{"description":{"content":"

Enter the unique ID of the application.

\n","type":"text/plain"},"type":"any","value":"29c7861f-f25b-4835-a0a0-ae4f9526aff0","key":"application_unique_id"}]}},"response":[{"id":"b161ebf3-da38-4190-b0cb-5619ac0729b9","name":"200 OK: Update Application Using Field Values","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"locations\": [\n \"System\"\n ],\n \"business_units\": [\n \"System\"\n ],\n \"labels\": [\"Red Label Application\"],\n \"status\": \"active\"\n\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/cftrapi/openapi/v1/application/:application_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","host":["{{base_url}}"],"path":["cftrapi","openapi","v1","application",":application_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"values","value":"readable_type","description":"**Do not change the parameter value**\nAllows you to update applications using the values of locations, business units and labels."}],"variable":[{"key":"application_unique_id","value":"29c7861f-f25b-4835-a0a0-ae4f9526aff0","description":"Enter the unique ID of the application."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Apr 2023 09:28:49 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"version\": null,\n \"application_url\": \"https://test.saasd.com/aswd\",\n \"purpose\": null,\n \"application_type\": null,\n \"application_status\": \"Decommissioned\",\n \"hosting_type\": null,\n \"development_type\": null,\n \"interface_type\": null,\n \"app_availability_rating\": null,\n \"infosec_rating\": null,\n \"business_critical\": null,\n \"has_pii\": null,\n \"end_of_life\": null,\n \"internet_facing\": null,\n \"client_facing\": null,\n \"classified_information\": null,\n \"risk_rating\": null,\n \"criticality_rating\": null,\n \"compliance_rating\": null,\n \"pci_scoped_in\": null,\n \"sox_scoped_in\": null,\n \"crown_jewel\": null,\n \"waf_integration\": null,\n \"ddos_protection_coverage\": null,\n \"unique_id\": \"29c7861f-f25b-4835-a0a0-ae4f9526aff0\",\n \"created\": \"2023-04-21T09:19:25.915605Z\",\n \"modified\": \"2023-04-21T09:28:48.887627Z\",\n \"title\": \"test application from openapi 1\",\n \"production_date\": null,\n \"application_owner\": null,\n \"application_manager\": null,\n \"incidents\": [],\n \"incidents_data\": [],\n \"vulnerabilities\": [],\n \"vulnerabilities_data\": [],\n \"readable_id\": \"APL101\",\n \"application_owner_data\": null,\n \"application_manager_data\": null,\n \"labels\": [\n \"242499f6-78cc-4696-8736-d666239e1183\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"242499f6-78cc-4696-8736-d666239e1183\",\n \"title\": \"Red Label Application\",\n \"color_code\": \"#6A1B9A\",\n \"created\": \"2023-04-21T09:18:54.905802Z\",\n \"modified\": \"2023-04-21T09:18:54.905802Z\"\n }\n ],\n \"threat_actors\": [],\n \"threat_actors_data\": [],\n \"briefings\": [],\n \"briefings_data\": [],\n \"malwares\": [],\n \"malwares_data\": [],\n \"enhancements\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"business_units_data\": [\n {\n \"title\": \"System\",\n \"description\": null,\n \"unique_id\": \"514f171a-0189-4aa5-bd71-564f7478b4b4\",\n \"created\": \"2023-03-02T11:18:34.273811Z\",\n \"modified\": \"2023-03-02T11:18:34.273811Z\",\n \"readable_id\": \"BU102\",\n \"email_list\": null\n }\n ],\n \"actions\": [],\n \"softwares\": [],\n \"softwares_data\": [],\n \"locations_data\": [\n {\n \"title\": \"America\",\n \"unique_id\": \"bb655f9f-a910-44a4-86f5-d56350d42dee\",\n \"is_active\": true\n }\n ],\n \"category_data\": {\n \"title\": \"Cyber\",\n \"unique_id\": \"81400f66-0d5f-4abb-b3ee-b3feb23f0f14\"\n },\n \"created_by\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"app_status\": null,\n \"description\": null,\n \"asset_type\": null,\n \"criticality\": null,\n \"status\": \"active\",\n \"app_availability_rating_data\": null,\n \"infosec_rating_data\": null,\n \"application_type_data\": null,\n \"business_critical_data\": null,\n \"application_status_data\": {\n \"unique_id\": \"10f7a168-fcb2-416a-8efe-d6b24b8aa45b\",\n \"option_name\": \"Decommissioned\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"fa036c9a-39ca-4d34-ac3d-7751b1461827\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"has_pii_data\": null,\n \"end_of_life_data\": null,\n \"internet_facing_data\": null,\n \"client_facing_data\": null,\n \"classified_information_data\": null,\n \"risk_rating_data\": null,\n \"hosting_type_data\": null,\n \"criticality_rating_data\": null,\n \"development_type_data\": null,\n \"compliance_rating_data\": null,\n \"interface_type_data\": null,\n \"pci_scoped_in_data\": null,\n \"sox_scoped_in_data\": null,\n \"crown_jewel_data\": null,\n \"waf_integration_data\": null,\n \"ddos_protection_coverage_data\": null\n}"}],"_postman_id":"5a33d3d8-4968-4d0e-8cc6-201e74b8f30c"},{"name":"Add Comment to Application","id":"d0a791fa-aee9-48a0-9d59-a67937965308","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"description\": \"

Note For Application

\",\n \"mentioned_users_usernames\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/comments/application/:application_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Add notes in an application in the CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`description`	String	Mandatory	Enter the content of the comment.
`mentioned_users_usernames`	List of UUID	Optional	Enter the list of usernames of the CFTR users to be mentioned in the comment.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the comment.
`description`	Text	Content of the comment.
`created_by`	Object	Details of the user who added the comment.
`modified_by`	Object	Details of the user who last updated the comment.
`mentioned_users`	List of UUID	List of `user_id` of users mentioned in the comment.
`mentioned_users_data`	List of Objects	Details of the users mentioned in the comment.
`created`	String	Comment creation date and time.
`modified`	String	Comment last updated date and time.
`comment_type`	String	Type of Comment. For examples, `discussion`.
`content_object`	String	Module in which the comment is added. For example, `application`.
`content_object_readable_id`	String	`readable_id` of the application in which the comment is added.
`content_object_unique_id`	String	`unique_id` of the application in which the comment is added.
`description_with_img_src`	Text	Content of the comment with the image URLs (if any image is added in the comment).
`pinned`	Boolean	Displays if the comment is pinned or not.

","urlObject":{"path":["comments","application",":application_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the application.

\n","type":"text/plain"},"type":"any","value":"add4c232-2ebe-45b5-aa94-f922f42d1694","key":"application_unique_id"}]}},"response":[{"id":"a440c006-b0c3-452c-bf26-3608b93ede0c","name":"Add Comment to Application","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"description\": \"

Note For Application

\",\n \"mentioned_users_usernames\": []\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}/cftrapi/openapi/v1/comments/application/:application_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}"],"path":["cftrapi","openapi","v1","comments","application",":application_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"application_unique_id","value":"21745314-b64d-4dd4-acb1-cf32b7fb3b29","description":"Enter the unique ID of the application."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 28 Jan 2024 09:34:03 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"931","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Server","value":"gunicorn/19.10.0","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"unique_id\": \"d2ec7a1e-57d8-45bd-af3e-c043d92dc841\",\n \"description\": \"

Note For Application

\",\n \"created_by\": {\n \"user_id\": \"b3184a17-e59f-46cb-82c3-d8aabbefff7e\",\n \"first_name\": \"Siri\",\n \"last_name\": \"D\",\n \"email\": \"siri@default.tld\",\n \"display_pic\": null,\n \"username\": \"siri.d\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"Siri D\"\n },\n \"modified_by\": null,\n \"is_removed\": false,\n \"mentioned_users\": [],\n \"mentioned_users_data\": [],\n \"created\": \"2024-01-28T09:34:03.108769Z\",\n \"modified\": \"2024-01-28T09:34:03.120860Z\",\n \"email\": null,\n \"internal\": false,\n \"comment_type\": \"discussion\",\n \"command_params\": {},\n \"command_result\": {},\n \"command_status\": \"na\",\n \"attachments_data\": [],\n \"content_object\": \"application\",\n \"content_object_readable_id\": \"APL121\",\n \"content_object_unique_id\": \"21745314-b64d-4dd4-acb1-cf32b7fb3b29\",\n \"attachment_label\": null,\n \"description_with_img_src\": \"

Note For Application

\",\n \"pinned\": false,\n \"field\": null,\n \"note_tag\": null\n}"}],"_postman_id":"d0a791fa-aee9-48a0-9d59-a67937965308"}],"id":"046ba838-1c92-42e1-a3d7-990f25a77684","description":"

Applications in an organization such as Web-based applications can contain private information such as user’s personal information, financial information and in many cases confidential information of an organization. Thus, securing an application is very much important for an organization.

This section describes how to use the API endpoints to manage the applications.

\n","_postman_id":"046ba838-1c92-42e1-a3d7-990f25a77684"},{"name":"Enhancements","item":[{"name":"Get List of Enhancements","id":"761a50e2-400f-4612-9202-03ada260ee80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/enhancement/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve a list of all the enhancements with details from the CFTR application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/enhancement/?

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
link	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` shows the API endpoint to the next page.
count	Integer	Total number of enhancements in the CFTR application as per the filters applied.
results	List of Objects	Details of the enhancements. Each object provides details of one enhancement.

Response Parameters | Results Object

Parameter	Type	Description
unique_id	String	Unique ID of the enhancement in UUID-4 format.
readable_id	String	Unique readable ID of the enhancement. It starts with `ENH` followed by a unique number. Example: ENH101
created	String	Enhancement creation date and time.
description	Text	Description of the enhancement.
modified	String	Last updated date and time of the enhancement.
title	Text	Title of the enhancement.
status	String	Current status of the enhancement. Allowed values: - `open` - `closed`
priority	String	Priority level of the enhancement.
priority_data	Object	Details of the priority assigned. Details include: `unique_id`, `option_name`, and so on.
is_bookmarked	Boolean	Shows if the enhancement is bookmarked or not.
modified_by_data	Object	Details of the user who last updated the enhancement. Details include: `username`, `email` ,`first_name`, `last_name`, and so on.
assigned_group	String	Unique ID of the assigned user group of the enhancement in UUID-4 format.
assigned_group_data	Object	Details of the assigned user group. Details include: `group name` and `group ID`.
created_by_data	Object	Details of user who created the enhancement. Details include `username`, `email` ,`first_name`, `last_name`, and so on.
assigned_to	String	Unique ID of the assigned user of the enhancement in UUID-4 format.
assigned_to_data	Object	Details of the assigned user. Details include `username`, `email` ,`first_name`, `last_name`, and so on.
labels	List of Strings	List of Unique IDs of the labels associated with the enhancement in UUID-4 format.
labels_data	List of Objects	Details of labels added to the enhancement. Details include `title`, `unique_id`, `color_code`, and so on.
enhancement_type	List of Strings	Option name of the enhancement types associated with the enhancement.
enhancement_type_data	List of Objects	Details of the enhancement types associated with the enhancement.

","urlObject":{"path":["enhancement",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"disabled":true,"description":{"content":"

[optional] Enter the status of the enhancements.\nAllowed values:\n• open\n• closed\nExample: “open”

\n","type":"text/plain"},"key":"status","value":"open"},{"disabled":true,"description":{"content":"

[optional] Enter the last modified time of the enhancements in EPOCH Time format.\nTime Zone must be as per UTC. All enhancements with modified date later than the entered time will be returned.

\n","type":"text/plain"},"key":"modified_date__gte","value":"1643283426"},{"disabled":true,"description":{"content":"

[optional] Enter the last modified time of the enhancements in EPOCH Time format.\nTime Zone must be as per UTC. All enhancements with modified date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"modified_date__lte","value":"1643283426"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the enhancements\n in EPOCH Time format.\nTime Zone must be as per UTC. All enhancements with creation date later than the entered time will be returned.

\n","type":"text/plain"},"key":"created_date__gte","value":"1643283426"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the enhancements in EPOCH Time format.\nTime Zone must be as per UTC. All enhancements with creation date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"created_date__lte","value":"1643283426"},{"disabled":true,"description":{"content":"

[optional] Enter the page number of the enhancements list. This will retrieve the list of all enhancemnts from the entered page.

Default value: 1

\n","type":"text/plain"},"key":"page","value":"2"},{"disabled":true,"description":{"content":"

[optional] Enter number of enhancements per page.\nDefault value: 10

\n","type":"text/plain"},"key":"page_size","value":"2"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID of the Incident. This parameter retrieves the Enhancements associated with the Incident.

You can retrieve the list of available Incidents and their Unique IDs using the following API endpoint:

/openapi/v1/incident/

\n","type":"text/plain"},"key":"incidents","value":"75e58cfc-bf31-493d-a4bb-93368541c034"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID of the Campaign. This parameter retrieves the Enhancements associated with the Campaign.

You can retrieve the list of available Campaigns and their Unique IDs using the following API endpoint:

/openapi/v1/campaign/

\n","type":"text/plain"},"key":"campaigns","value":"9e44ab13-64e5-43ad-a8d1-e1d181681090"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID of a User.This parameter retrieves the enhancements created by the user corresponding to the unique ID

\n","type":"text/plain"},"key":"created_by","value":"a5e04da7-61fb-4436-a11a-ab219eaeb296"}],"variable":[]}},"response":[{"id":"088749a8-f0f2-4671-bca7-eae5c8bbae58","name":"Eg: Get List of Enhancements","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/enhancement/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["enhancement",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"status","value":"open","description":"[optional] Enter the status of the enhancements.\nAllowed values:\n• open\n• closed\nExample: “open”","disabled":true},{"key":"modified_date__gte","value":"1643283426","description":"[optional] Enter the last modified time of the enhancements in EPOCH Time format.\nTime Zone must be as per UTC. All enhancements with modified date later than the entered time will be returned.","disabled":true},{"key":"modified_date__lte","value":"1643283426","description":"[optional] Enter the last modified time of the enhancements in EPOCH Time format.\nTime Zone must be as per UTC. All enhancements with modified date earlier than the entered time will be returned.","disabled":true},{"key":"created_date__gte","value":"1643283426","description":"[optional] Enter the creation time of the enhancements\n in EPOCH Time format.\nTime Zone must be as per UTC. All enhancements with creation date later than the entered time will be returned.","disabled":true},{"key":"created_date__lte","value":"1643283426","description":"[optional] Enter the creation time of the enhancements in EPOCH Time format.\nTime Zone must be as per UTC. All enhancements with creation date earlier than the entered time will be returned.","disabled":true},{"key":"page","value":"2","description":"[optional] Enter the page number of the enhancements list. This will retrieve the list of all enhancemnts from the entered page.\n\nDefault value: 1","disabled":true},{"key":"page_size","value":"4","description":"[optional] Enter number of enhancements per page.\nDefault value: 10","disabled":true},{"key":"incident","value":"9750d6df-2d7f-4899-b20d-bfbba0a9084d","description":"[optional] Enter the unique ID of the Incident. This parameter retrieves the Enhancements associated with the Incident.\n\nYou can retrieve the list of available Incidents and their Unique IDs using the following API endpoint:\n\n`/openapi/v1/incident/`","disabled":true},{"key":"campaigns","value":"9e44ab13-64e5-43ad-a8d1-e1d181681090","description":"[optional] Enter the unique ID of the Campaign. This parameter retrieves the Enhancements associated with the Campaign.\n\nYou can retrieve the list of available Campaigns and their Unique IDs using the following API endpoint:\n\n`/openapi/v1/campaign/`","disabled":true},{"key":"created_by","value":"a5e04da7-61fb-4436-a11a-ab219eaeb296","description":"[optional] Enter the unique ID of a User.This parameter retrieves the enhancements created by the user corresponding to the unique ID ","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 24 Jun 2022 09:40:29 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1113","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 1,\n \"results\": [\n {\n \"title\": \"New Enhancement\",\n \"description\": \"Description\",\n \"due_date\": null,\n \"assigned_to\": null,\n \"assigned_to_data\": null,\n \"assigned_group\": \"3219ad24-bf04-4cd3-93f5-01d189b43775\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"3219ad24-bf04-4cd3-93f5-01d189b43775\",\n \"group_name\": \"CFTR Admin\"\n },\n \"unique_id\": \"a2fc5ad1-be71-40f3-95ce-a1273947debd\",\n \"readable_id\": \"ENH101\",\n \"created\": \"2022-06-24T09:24:16.676943Z\",\n \"modified\": \"2022-06-24T09:24:16.770257Z\",\n \"created_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"is_bookmarked\": false,\n \"status\": \"open\",\n \"labels\": [],\n \"labels_data\": [],\n \"enhancement_type_data\": [],\n \"enhancement_type\": [],\n \"priority_data\": {\n \"unique_id\": \"e02aeb3d-b806-4a18-9963-f4f6556e3bd2\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"db8652db-ab75-4e06-abed-317b721db420\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"Medium\"\n }\n ]\n}"},{"id":"b3c77ff4-69e7-4667-b08e-77ef393dce35","name":"Eg: Get List of Enhancements with status 'open'","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/enhancement/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&status=open","host":["{{base_url}}v1"],"path":["enhancement",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"status","value":"open","description":"[optional] Enter the status of the enhancements.\nAllowed values:\n• open\n• closed\nExample: “open”"},{"key":"modified_date__gte","value":"1643283426","description":"[optional] Enter the last modified time of the enhancements in EPOCH Time format.\nTime Zone must be as per UTC. All enhancements with modified date later than the entered time will be returned.","disabled":true},{"key":"modified_date__lte","value":"1643283426","description":"[optional] Enter the last modified time of the enhancements in EPOCH Time format.\nTime Zone must be as per UTC. All enhancements with modified date earlier than the entered time will be returned.","disabled":true},{"key":"created_date__gte","value":"1643283426","description":"[optional] Enter the creation time of the enhancements\n in EPOCH Time format.\nTime Zone must be as per UTC. All enhancements with creation date later than the entered time will be returned.","disabled":true},{"key":"created_date__lte","value":"1643283426","description":"[optional] Enter the creation time of the enhancements in EPOCH Time format.\nTime Zone must be as per UTC. All enhancements with creation date earlier than the entered time will be returned.","disabled":true},{"key":"page","value":"2","description":"[optional] Enter the page number of the enhancements list. This will retrieve the list of all enhancemnts from the entered page.\n\nDefault value: 1","disabled":true},{"key":"page_size","value":"4","description":"[optional] Enter number of enhancements per page.\nDefault value: 10","disabled":true},{"key":"incident","value":"9750d6df-2d7f-4899-b20d-bfbba0a9084d","description":"[optional] Enter the unique ID of the Incident. This parameter retrieves the Enhancements associated with the Incident.\n\nYou can retrieve the list of available Incidents and their Unique IDs using the following API endpoint:\n\n`/openapi/v1/incident/`","disabled":true},{"key":"campaigns","value":"9e44ab13-64e5-43ad-a8d1-e1d181681090","description":"[optional] Enter the unique ID of the Campaign. This parameter retrieves the Enhancements associated with the Campaign.\n\nYou can retrieve the list of available Campaigns and their Unique IDs using the following API endpoint:\n\n`/openapi/v1/campaign/`","disabled":true},{"key":"created_by","value":"a5e04da7-61fb-4436-a11a-ab219eaeb296","description":"[optional] Enter the unique ID of a User.This parameter retrieves the enhancements created by the user corresponding to the unique ID ","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 24 Jun 2022 11:13:44 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1113","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 1,\n \"results\": [\n {\n \"title\": \"New Enhancement\",\n \"description\": \"

Description

\",\n \"due_date\": null,\n \"assigned_to\": null,\n \"assigned_to_data\": null,\n \"assigned_group\": \"3219ad24-bf04-4cd3-93f5-01d189b43775\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"3219ad24-bf04-4cd3-93f5-01d189b43775\",\n \"group_name\": \"CFTR Admin\"\n },\n \"unique_id\": \"a2fc5ad1-be71-40f3-95ce-a1273947debd\",\n \"readable_id\": \"ENH101\",\n \"created\": \"2022-06-24T09:24:16.676943Z\",\n \"modified\": \"2022-06-24T09:24:16.770257Z\",\n \"created_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"is_bookmarked\": false,\n \"status\": \"open\",\n \"labels\": [],\n \"labels_data\": [],\n \"enhancement_type_data\": [],\n \"enhancement_type\": [],\n \"priority_data\": {\n \"unique_id\": \"e02aeb3d-b806-4a18-9963-f4f6556e3bd2\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"db8652db-ab75-4e06-abed-317b721db420\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"Medium\"\n }\n ]\n}"},{"id":"90f1a888-d03e-44fd-9285-2237f20d09a1","name":"Eg: Customizable Page Size","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/enhancement/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&status=open&page_size=2","host":["{{base_url}}v1"],"path":["enhancement",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"status","value":"open","description":"[optional] Enter the status of the enhancements.\nAllowed values:\n• open\n• closed\nExample: “open”"},{"key":"modified_date__gte","value":"1643283426","description":"[optional] Enter the last modified time of the enhancements in EPOCH Time format.\nTime Zone must be as per UTC. All enhancements with modified date later than the entered time will be returned.","disabled":true},{"key":"modified_date__lte","value":"1643283426","description":"[optional] Enter the last modified time of the enhancements in EPOCH Time format.\nTime Zone must be as per UTC. All enhancements with modified date earlier than the entered time will be returned.","disabled":true},{"key":"created_date__gte","value":"1643283426","description":"[optional] Enter the creation time of the enhancements\n in EPOCH Time format.\nTime Zone must be as per UTC. All enhancements with creation date later than the entered time will be returned.","disabled":true},{"key":"created_date__lte","value":"1643283426","description":"[optional] Enter the creation time of the enhancements in EPOCH Time format.\nTime Zone must be as per UTC. All enhancements with creation date earlier than the entered time will be returned.","disabled":true},{"key":"page","value":"2","description":"[optional] Enter the page number of the enhancements list. This will retrieve the list of all enhancemnts from the entered page.\n\nDefault value: 1","disabled":true},{"key":"page_size","value":"2","description":"[optional] Enter number of enhancements per page.\nDefault value: 10"},{"key":"incident","value":"9750d6df-2d7f-4899-b20d-bfbba0a9084d","description":"[optional] Enter the unique ID of the Incident. This parameter retrieves the Enhancements associated with the Incident.\n\nYou can retrieve the list of available Incidents and their Unique IDs using the following API endpoint:\n\n`/openapi/v1/incident/`","disabled":true},{"key":"campaigns","value":"9e44ab13-64e5-43ad-a8d1-e1d181681090","description":"[optional] Enter the unique ID of the Campaign. This parameter retrieves the Enhancements associated with the Campaign.\n\nYou can retrieve the list of available Campaigns and their Unique IDs using the following API endpoint:\n\n`/openapi/v1/campaign/`","disabled":true},{"key":"created_by","value":"a5e04da7-61fb-4436-a11a-ab219eaeb296","description":"[optional] Enter the unique ID of a User.This parameter retrieves the enhancements created by the user corresponding to the unique ID ","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 24 Jun 2022 11:19:16 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"2724","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {\n \"next\": \"openapi/v1/enhancement/?page=2&page_size=2&AccessID=a7a71aff-8383-4cb0-8e1d-4c1f835aea7c&Expires=1656069571&Signature=pdO9ocNTTqB5XJVw1hp8hANorLM=&status=open\"\n },\n \"count\": 3,\n \"results\": [\n {\n \"title\": \"Review and Update based on v.1.23.4 Production Docs\",\n \"description\": null,\n \"due_date\": null,\n \"assigned_to\": null,\n \"assigned_to_data\": null,\n \"assigned_group\": \"3219ad24-bf04-4cd3-93f5-01d189b43775\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"3219ad24-bf04-4cd3-93f5-01d189b43775\",\n \"group_name\": \"CFTR Admin\"\n },\n \"unique_id\": \"2d034703-7800-4a3f-8b70-9b2627bc0579\",\n \"readable_id\": \"ENH103\",\n \"created\": \"2022-06-24T11:19:07.427464Z\",\n \"modified\": \"2022-06-24T11:19:07.467669Z\",\n \"created_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"is_bookmarked\": false,\n \"status\": \"open\",\n \"labels\": [],\n \"labels_data\": [],\n \"enhancement_type_data\": [],\n \"enhancement_type\": [],\n \"priority_data\": {\n \"unique_id\": \"93cc825b-4687-4628-beef-d6e701b1a2fa\",\n \"option_name\": \"Very High\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"db8652db-ab75-4e06-abed-317b721db420\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"Very High\"\n },\n {\n \"title\": \"Enhancement For System User\",\n \"description\": \"

System User requires Immediate Antivirus Update.

\",\n \"due_date\": \"2022-06-25T11:16:17Z\",\n \"assigned_to\": null,\n \"assigned_to_data\": null,\n \"assigned_group\": \"76aa72bc-4df2-41a1-af22-b86b69eb67c0\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"76aa72bc-4df2-41a1-af22-b86b69eb67c0\",\n \"group_name\": \"Forensic Investigator\"\n },\n \"unique_id\": \"60f29c6a-7dbe-4b69-b70d-e50246ffab97\",\n \"readable_id\": \"ENH102\",\n \"created\": \"2022-06-24T11:17:16.789019Z\",\n \"modified\": \"2022-06-24T11:17:16.869409Z\",\n \"created_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"is_bookmarked\": false,\n \"status\": \"open\",\n \"labels\": [],\n \"labels_data\": [],\n \"enhancement_type_data\": [\n {\n \"unique_id\": \"feb95f7e-c444-4d6b-8d54-c622ade62e0a\",\n \"option_name\": \"Process Update\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"9073d47b-bf09-472a-9268-317309565727\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"enhancement_type\": [\n \"Process Update\"\n ],\n \"priority_data\": {\n \"unique_id\": \"e02aeb3d-b806-4a18-9963-f4f6556e3bd2\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"db8652db-ab75-4e06-abed-317b721db420\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"Medium\"\n }\n ]\n}"},{"id":"dab94a3f-5d59-4670-9c8d-449619501f0a","name":"Eg: Get List of Enhancements Filtered on Incident","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/enhancement/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&status=open&incidents=75e58cfc-bf31-493d-a4bb-93368541c034","host":["{{base_url}}v1"],"path":["enhancement",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"status","value":"open","description":"[optional] Enter the status of the enhancements.\nAllowed values:\n• open\n• closed\nExample: “open”"},{"key":"modified_date__gte","value":"1643283426","description":"[optional] Enter the last modified time of the enhancements in EPOCH Time format.\nTime Zone must be as per UTC. All enhancements with modified date later than the entered time will be returned.","disabled":true},{"key":"modified_date__lte","value":"1643283426","description":"[optional] Enter the last modified time of the enhancements in EPOCH Time format.\nTime Zone must be as per UTC. All enhancements with modified date earlier than the entered time will be returned.","disabled":true},{"key":"created_date__gte","value":"1643283426","description":"[optional] Enter the creation time of the enhancements\n in EPOCH Time format.\nTime Zone must be as per UTC. All enhancements with creation date later than the entered time will be returned.","disabled":true},{"key":"created_date__lte","value":"1643283426","description":"[optional] Enter the creation time of the enhancements in EPOCH Time format.\nTime Zone must be as per UTC. All enhancements with creation date earlier than the entered time will be returned.","disabled":true},{"key":"page","value":"2","description":"[optional] Enter the page number of the enhancements list. This will retrieve the list of all enhancemnts from the entered page.\n\nDefault value: 1","disabled":true},{"key":"page_size","value":"2","description":"[optional] Enter number of enhancements per page.\nDefault value: 10","disabled":true},{"key":"incidents","value":"75e58cfc-bf31-493d-a4bb-93368541c034","description":"[optional] Enter the unique ID of the Incident. This parameter retrieves the Enhancements associated with the Incident.\n\nYou can retrieve the list of available Incidents and their Unique IDs using the following API endpoint:\n\n`/openapi/v1/incident/`"},{"key":"campaigns","value":"9e44ab13-64e5-43ad-a8d1-e1d181681090","description":"[optional] Enter the unique ID of the Campaign. This parameter retrieves the Enhancements associated with the Campaign.\n\nYou can retrieve the list of available Campaigns and their Unique IDs using the following API endpoint:\n\n`/openapi/v1/campaign/`","disabled":true},{"key":"created_by","value":"a5e04da7-61fb-4436-a11a-ab219eaeb296","description":"[optional] Enter the unique ID of a User.This parameter retrieves the enhancements created by the user corresponding to the unique ID ","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 24 Jun 2022 11:56:31 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1139","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 1,\n \"results\": [\n {\n \"title\": \"Review and Update based on v.1.23.4 Production Docs\",\n \"description\": null,\n \"due_date\": null,\n \"assigned_to\": null,\n \"assigned_to_data\": null,\n \"assigned_group\": \"3219ad24-bf04-4cd3-93f5-01d189b43775\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"3219ad24-bf04-4cd3-93f5-01d189b43775\",\n \"group_name\": \"CFTR Admin\"\n },\n \"unique_id\": \"2d034703-7800-4a3f-8b70-9b2627bc0579\",\n \"readable_id\": \"ENH103\",\n \"created\": \"2022-06-24T11:19:07.427464Z\",\n \"modified\": \"2022-06-24T11:54:54.041495Z\",\n \"created_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"is_bookmarked\": false,\n \"status\": \"open\",\n \"labels\": [],\n \"labels_data\": [],\n \"enhancement_type_data\": [],\n \"enhancement_type\": [],\n \"priority_data\": {\n \"unique_id\": \"93cc825b-4687-4628-beef-d6e701b1a2fa\",\n \"option_name\": \"Very High\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"db8652db-ab75-4e06-abed-317b721db420\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"Very High\"\n }\n ]\n}"}],"_postman_id":"761a50e2-400f-4612-9202-03ada260ee80"},{"name":"Get Details of an Enhancement","id":"03a16862-b149-40c7-bdb6-a48b0d44ea9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/enhancement/:enhancement_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the details of an enhancement.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/enhancement/:enhancement_unique_id/?

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

Response Parameters | Regulatory Fields

Parameter	Type	Description
unique_id	String	Unique ID of the enhancement in UUID-4 format.
readable_id	String	Unique readable ID of the enhancement. It starts with `ENH` followed by a unique number. Example: ENH101
created	Datetime	Enhancement creation date and time.
description	Text	Description of the enhancement.
modified	Datetime	Last updated date and time of the enhancement.
title	Text	Title of the enhancement.
status	String	Current status of the enhancement. Allowed values: - `open` - `closed`
priority	String	Priority level of the enhancement.
priority_data	Object	Details of the priority assigned. Details include: `unique_id`, `option_name`, and so on.
is_bookmarked	Boolean	Shows if the enhancement is bookmarked or not.
modified_by_data	Object	Details of the user who last updated the enhancement. Details include: `username`, `email` ,`first_name`, `last_name`, and so on.
assigned_group	String	Unique ID of the user group the enhancement belongs to in UUID-4 format.
assigned_group_data	Object	Details of the assigned user group. Details include group name and group ID.
created_by_data	Object	Details of the user who created the enhancement. Details include: `username`, `email` ,`first_name`, `last_name`, and so on.
assigned_to	String	Unique ID of the assigned user of the enhancement in UUID-4 format.
assigned_to_data	Object	Details of the assigned user. Details include: `username`, `email` ,`first_name`, `last_name`, and so on.
labels	List of Strings	List of Unique IDs of the labels attached to the enhancement in UUID-4 format.
labels_data	List of Objects	Details of labels added to the enhancement. Details include: `title`, `unique_id`, `color_code`, and so on.
enhancement_type	List of Strings	Option name of the enhancement types associated with the enhancement.
enhancement_type_data	List of Objects	Details of the enhancement types associated with the enhancement.

Response Parameters | Connect The Dots

Following are the response parameters corresponding to the Connect The Dots section of the enhancement. The parameters ending with _data contain the meta information for each connected component. The non __data_ parameters just include an array of unique_ids referencing the connected components.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`applications`	Array of UUID Strings	List of `unique_id` of the connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.

Response Parameters | Custom Fields

As CFTR form structure is dynamic and configurable, the response parameters might vary.

The following endpoint retrieves the field_readable_key for all custom fields in the enhancement component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=enhancement\n\n

The following table describes some examples of the custom fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type
summary_card_host_pairs	String
ie_port_numbers_impacted	String
enhancement_learning	String
recovery_details	String

Response Parameters | Attachments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
attachments_data	Array of Objects	Details of each attachment of the enhancement.

Response Parameters | Priority Data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
unique_id	String	Unique ID of the priority in UUID-4 format.
option_name	String	Display Name of the priority
color_code	String	Hex value of the priority display color.

Response Parameters | Enhancement Type Data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
unique_id	String	Unique ID of the enhancement in UUID-4 format.
option_name	String	Display Name of the enhancement type
color_code	String	Hex value of the enhancement type display color.

Response Parameters | Labels Data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
unique_id	String	Unique ID of the label in UUID-4 format.
option_name	String	Display name of the label
color_code	String	Hex value of the label display color.

Response Parameters | System Form Fields

Few of the fields/parameters have the values in UUID-4 format. These fields do not intake the Option Name in the request as they are used internally for various additional responsibilities around Analytics, Data Level Permission, Relationships, and Filtering. These fields also include the parameters under Connect the Dots, and other sections.

The fields include:

All the Connect the Dots parameters: You can retrieve the corresponding UUID-4 from the details page browser URL of the instance.
\n
Assigned User / Assigned Group-related parameters: You can retrieve the corresponding UUID-4 from the User Management and Group Management sections respectively.
\n
Labels: You can retrieve the corresponding UUID-4 from Admin > Settings > Labels section.
\n

\n","urlObject":{"path":["enhancement",":enhancement_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the enhancement in UUID format.

\n","type":"text/plain"},"type":"any","value":"2d034703-7800-4a3f-8b70-9b2627bc0579","key":"enhancement_unique_id"}]}},"response":[{"id":"0db69262-6147-409c-8d18-96e29fb03819","name":"Eg: Get Details of an Enhancement","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/enhancement/:enhancement_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["enhancement",":enhancement_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"enhancement_unique_id","value":"2d034703-7800-4a3f-8b70-9b2627bc0579","description":"Enter the unique ID of the enhancement in UUID format."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 24 Jun 2022 12:01:14 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"2129","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"notes\": null,\n \"priority\": \"Very High\",\n \"enhancement_type\": [],\n \"title\": \"Review and Update based on v.1.23.4 Production Docs\",\n \"description\": null,\n \"due_date\": null,\n \"assigned_to\": null,\n \"assigned_to_data\": null,\n \"assigned_group\": \"3219ad24-bf04-4cd3-93f5-01d189b43775\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"3219ad24-bf04-4cd3-93f5-01d189b43775\",\n \"group_name\": \"CFTR Admin\"\n },\n \"unique_id\": \"2d034703-7800-4a3f-8b70-9b2627bc0579\",\n \"readable_id\": \"ENH103\",\n \"created\": \"2022-06-24T11:19:07.427464Z\",\n \"modified\": \"2022-06-24T11:54:54.041495Z\",\n \"created_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"incidents\": [\n \"75e58cfc-bf31-493d-a4bb-93368541c034\"\n ],\n \"incidents_data\": [\n {\n \"unique_id\": \"75e58cfc-bf31-493d-a4bb-93368541c034\",\n \"readable_id\": \"INC102\",\n \"1a38a4a6-b16a-4079-adb2-c5638f7cbe74\": \"Test Incident\",\n \"status\": \"open\",\n \"created\": \"2022-06-24T11:54:04.266775Z\",\n \"modified\": \"2022-06-24T11:54:05.255647Z\",\n \"title_display\": \"Test Incident\",\n \"severity_title\": \"High\"\n }\n ],\n \"briefings_data\": [],\n \"campaigns_data\": [],\n \"is_bookmarked\": false,\n \"status\": \"open\",\n \"can_update_instance\": true,\n \"can_update_full\": true,\n \"vulnerabilities_data\": [],\n \"attachments_data\": [],\n \"closed_on\": null,\n \"closed_by_data\": null,\n \"labels\": [],\n \"labels_data\": [],\n \"applications\": [\n \"984940b2-3f4b-40ea-b3ce-f534cabc692a\"\n ],\n \"applications_data\": [\n {\n \"unique_id\": \"984940b2-3f4b-40ea-b3ce-f534cabc692a\",\n \"created\": \"2022-06-24T05:30:06.433714Z\",\n \"modified\": \"2022-06-24T05:31:01.734959Z\",\n \"title\": \"New Application\",\n \"production_date\": null,\n \"readable_id\": \"APL101\",\n \"labels\": [],\n \"labels_data\": [],\n \"title_display\": \"New Application\",\n \"status\": \"active\"\n }\n ],\n \"malwares_data\": [],\n \"threat_actors_data\": [],\n \"title_display\": \"Review and Update based on v.1.23.4 Production Docs\",\n \"enhancement_type_data\": [],\n \"priority_data\": {\n \"unique_id\": \"93cc825b-4687-4628-beef-d6e701b1a2fa\",\n \"option_name\": \"Very High\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"db8652db-ab75-4e06-abed-317b721db420\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n}"}],"_postman_id":"03a16862-b149-40c7-bdb6-a48b0d44ea9d"},{"name":"Create Enhancement Using Field UUID","id":"4b6bd46e-5295-4d24-b655-1a313530d3e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Newly Created Enhancement\",\n \"description\": \"

Enhancement Description

\",\n \"assigned_group\": \"3219ad24-bf04-4cd3-93f5-01d189b43775\",\n \"due_date\": \"2022-06-25T11:16:17Z\",\n \"priority\": \"Very High\"\n}"},"url":"{{base_url}}v1/enhancement/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Create an enhancement in your CFTR application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/enhancement/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
title	String	Mandatory	Enter a title for the enhancement.
description	String	Optional	Enter a description that best describes the key details of the enhancement.
status	String	Optional	Enter the status of the enhancement. Allowed values: - `open` - `closed` Example: `\"closed\"` Default value:`\"open\"`
enhancement_type	String	Optional	Enter the enhancement type. Some of the examples of Enhancement types are: - Process Update - Strategy Change - Policy Change Example: “Policy Change”
due_date	Datetime	Optional	Enter the due date of the enhancement.
labels	Array of Stings	Optional	List of Unique IDs of the labels to be attached to the enhancement in UUID-4 format.
priority	String	Mandatory	Enter the priority level of the enhancement. Some of the examples of Priority Levels are: • Very High • High • Medium • Low • Very Low Example: “Very Low”
assigned_group	String	Mandatory	Enter the unique ID of the user group to assign the enhancement. You can use the following API endpoint to retrieve the list of User Groups: `/openapi/v1/restauth/permission/group/`

Request Parameters | Custom Fields

In addition to the above-mentioned parameters, the request parameters might vary as per the form configuration defined by your CFTR admin for enhancements. For such parameters, use the field_readable_key of each parameter. To retrieve the field_readable_key and additional metadata of a parameter, use the Form Tab Structure API for enhancements.

Example

The following endpoint retrieves the field_readable_key for all custom fields in the enhancement component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=enhancement\n\n

Following are some of the sample custom fields for enhancements:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
summary_card_host_pairs	String	Optional
ie_port_numbers_impacted	String	Optional
enhancement_learning	String	Optional
recovery_details	String	Optional

Response Parameters

Response Parameters | Regulatory Fields

Parameter	Type	Description
unique_id	String	Unique ID of the enhancement in UUID-4 format.
readable_id	String	Unique readable ID of the enhancement. It starts with `ENH` followed by a unique number. Example: ENH101
created	String	Enhancement creation date and time.
description	Text	Description of the enhancement.
modified	String	Last updated date and time of the enhancement.
title	Text	Title of the enhancement.
status	String	Current status of the enhancement. Allowed values: - `open` - `closed`
priority	String	Priority level of the enhancement.
priority_data	Object	Details of the priority assigned. Details include: `unique_id`, `option_name` and so on.
is_bookmarked	Boolean	Shows if the enhancement is bookmarked or not.
modified_by_data	Object	Details of the user who last updated the enhancement. Details include: `username`, `email` ,`first_name`, `last_name`, and so on.
assigned_group	String	Unique ID of the user group the enhancement belongs to in UUID-4 format.
assigned_group_data	Object	Details of the assigned user group. Details include: group name and group ID.
created_by_data	Object	Details of user who created the enhancement. Details include: `username`, `email` ,`first_name`, `last_name`, and so on.
assigned_to	String	Unique ID of the assigned user of the enhancement in UUID-4 format.
assigned_to_data	Object	Details of the assigned user. Details include: `username`, `email` ,`first_name`, `last_name`, and so on.
labels	List of Strings	List of Unique IDs of the labels attached to the enhancement in UUID-4 format.
labels_data	List of Objects	Details of labels added to the enhancement. Details include: `title`, `unique_id`, `color_code`, and so on.
enhancement_type	List of Strings	Option name of the enhancement types associated with the enhancement.
enhancement_type_data	List of Objects	Details of the enhancement types associated with the enhancement.

Response Parameters | Connect The Dots

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`applications`	Array of UUID Strings	List of `unique_id` of the connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.

Response Parameters | Custom Fields

As CFTR form structure is dynamic and configurable, the response parameters might vary. The following table describes some examples of the custom fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type
summary_card_host_pairs	String
ie_port_numbers_impacted	String
enhancement_learning	String
recovery_details	String

Response Parameters | Attachments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
attachments_data	Array of Objects	Details of each attachment of the enhancement.

Response Parameters | System Form Fields

Few of the fields/parameters have the values in UUID-4 format. These fields do not intake Option Name in the request as they are used internally for various additional responsibilities around Analytics, Data Level Permission, Relationships, and Filtering. These fields also include the parameters under Connect the Dots, Labels, and other sections.

The fields include:

All the Connect the Dots params: You can retrieve the corresponding UUID-4 from the details page browser URL of the instance.
\n
Assigned User / Assigned Group-related params: You can retrieve the corresponding UUID-4 from the User Management and Group Management sections respectively.
\n
Labels: You can retrieve the corresponding UUID-4 from Admin > Settings > Labels section.
\n

\n","urlObject":{"path":["enhancement",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"15bfd73a-35df-4e24-b88e-593bf0739a8d","name":"Eg: Create Enhancement with Very High priority","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Newly Created Enhancement\",\n \"description\": \"

Enhancement Description

\",\n \"assigned_group\": \"3219ad24-bf04-4cd3-93f5-01d189b43775\",\n \"due_date\": \"2022-06-25T11:16:17Z\",\n \"priority\": \"Very High\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/enhancement/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["enhancement",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 24 Jun 2022 12:16:06 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1478","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"notes\": null,\n \"priority\": \"Very High\",\n \"enhancement_type\": [],\n \"title\": \"Newly Created Enhancement\",\n \"description\": \"

Enhancement Description

\",\n \"due_date\": \"2022-06-25T11:16:17Z\",\n \"assigned_to\": null,\n \"assigned_to_data\": null,\n \"assigned_group\": \"3219ad24-bf04-4cd3-93f5-01d189b43775\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"3219ad24-bf04-4cd3-93f5-01d189b43775\",\n \"group_name\": \"CFTR Admin\"\n },\n \"unique_id\": \"331bd09f-08f1-42ae-853c-a5b8b335adf9\",\n \"readable_id\": \"ENH105\",\n \"created\": \"2022-06-24T12:16:05.335210Z\",\n \"modified\": \"2022-06-24T12:16:05.389969Z\",\n \"created_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"incidents\": [],\n \"incidents_data\": [],\n \"briefings_data\": [],\n \"campaigns_data\": [],\n \"is_bookmarked\": false,\n \"status\": \"open\",\n \"can_update_instance\": true,\n \"can_update_full\": true,\n \"vulnerabilities_data\": [],\n \"attachments_data\": [],\n \"closed_on\": null,\n \"closed_by_data\": null,\n \"labels\": [],\n \"labels_data\": [],\n \"applications\": [],\n \"applications_data\": [],\n \"malwares_data\": [],\n \"threat_actors_data\": [],\n \"title_display\": \"Newly Created Enhancement\",\n \"enhancement_type_data\": [],\n \"priority_data\": {\n \"unique_id\": \"93cc825b-4687-4628-beef-d6e701b1a2fa\",\n \"option_name\": \"Very High\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"db8652db-ab75-4e06-abed-317b721db420\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n}"}],"_postman_id":"4b6bd46e-5295-4d24-b655-1a313530d3e6"},{"name":"Create Enhancement Using Field Values","id":"8d6d6388-b75d-4c31-8787-30f622ff3f28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Newly Created Enhancement\",\n \"description\": \"

Enhancement Description

\",\n \"assigned_group\": \"CFTR Admin\",\n \"assigned_to\": \"peter.smith@example.com\",\n \"due_date\": \"2023-06-25T11:16:17Z\",\n \"priority\": \"Very High\",\n \"labels\": [\"Blue Label Enhancement\"]\n}"},"url":"{{base_url}}v1/enhancement/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","description":"

Create an enhancement in your CFTR application using the values of assigned groups, labels, and the email IDs of assigned users.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/enhancement/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
title	String	Mandatory	Enter a title for the enhancement.
description	String	Optional	Enter a description that best describes the key details of the enhancement.
status	String	Optional	Enter the status of the enhancement. Allowed values: - `open` - `closed` Example: `\"closed\"` Default value:`\"open\"`
enhancement_type	String	Optional	Enter the enhancement type. Some of the examples of Enhancement types are: - Process Update - Strategy Change - Policy Change Example: “Policy Change”
due_date	Datetime	Optional	Enter the due date of the enhancement.
labels	List	Optional	Enter the list of names of the labels to be attached to the enhancement. You can use the following API endpoint to retrieve the list of Labels: `/openapi/v1/utils/label/`
priority	String	Mandatory	Enter the priority level of the enhancement. Some of the examples of Priority Levels are: • Very High • High • Medium • Low • Very Low Example: “Very Low”
assigned_group	String	Mandatory	Enter the name of the user group to assign the enhancement. You can use the following API endpoint to retrieve the list of User Groups: `/openapi/v1/rest-auth/permission/group/`
assigned_to	String	Optional	Enter the email ID of the user to assign the enhancement. You can use the following API endpoint to retrieve the list of User:`/openapi/v1/rest-auth/user/`

Request Parameters | Custom Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the enhancement component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=enhancement\n\n

Following are some of the sample custom fields for enhancements:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
summary_card_host_pairs	String	Optional
ie_port_numbers_impacted	String	Optional
enhancement_learning	String	Optional
recovery_details	String	Optional

Response Parameters

Response Parameters | Regulatory Fields

Parameter	Type	Description
unique_id	String	Unique ID of the enhancement in UUID-4 format.
readable_id	String	Unique readable ID of the enhancement. It starts with `ENH` followed by a unique number. Example: ENH101
created	Datetime	Enhancement creation date and time.
description	Text	Description of the enhancement.
modified	Datetime	Last updated date and time of the enhancement.
title	Text	Title of the enhancement.
status	String	Current status of the enhancement. Allowed values: - `open` - `closed`
priority	String	Priority level of the enhancement.
priority_data	Object	Details of the priority assigned. Details include: `unique_id`, `option_name` and so on.
is_bookmarked	Boolean	Shows if the enhancement is bookmarked or not.
modified_by_data	Object	Details of the user who last updated the enhancement. Details include: `username`, `email` ,`first_name`, `last_name`, and so on.
assigned_group	String	Unique ID of the user group the enhancement belongs to in UUID-4 format.
assigned_group_data	Object	Details of the assigned user group. Details include: group name and group ID.
created_by_data	Object	Details of user who created the enhancement. Details include: `username`, `email` ,`first_name`, `last_name`, and so on.
assigned_to	String	Unique ID of the assigned user of the enhancement in UUID-4 format.
assigned_to_data	Object	Details of the assigned user. Details include: `username`, `email` ,`first_name`, `last_name`, and so on.
labels	List of Strings	List of Unique IDs of the labels attached to the enhancement in UUID-4 format.
labels_data	List of Objects	Details of labels added to the enhancement. Details include: `title`, `unique_id`, `color_code`, and so on.
enhancement_type	List of Strings	Option name of the enhancement types associated with the enhancement.
enhancement_type_data	List of Objects	Details of the enhancement types associated with the enhancement.

Response Parameters | Connect The Dots

Following are the response parameters corresponding to the Connect The Dots section of the enhancement. The parameters ending with _data contain the meta information for each connected component. The non `_data` parameters just include an array of unique_id referencing to connected components.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`applications`	Array of UUID Strings	List of `unique_id` of the connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.

Response Parameters | Custom Fields

As CFTR form structure is dynamic and configurable, the response parameters might vary. The following table describes some examples of the custom fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type
summary_card_host_pairs	String
ie_port_numbers_impacted	String
enhancement_learning	String
recovery_details	String

Response Parameters | Attachments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
attachments_data	Array of Objects	Details of each attachment of the enhancement.

Response Parameters | System Form Fields

The fields include:

All the Connect the Dots params: You can retrieve the corresponding UUID-4 from the details page browser URL of the instance.
\n
Assigned User / Assigned Group-related params: You can retrieve the corresponding UUID-4 from the User Management and Group Management sections respectively.
\n
Labels: You can retrieve the corresponding UUID-4 from Admin > Setting > Labels section.
\n

Do not change the parameter value\nAllows you to create enhancements using the values of assigned groups, labels and the email IDs of assigned users.

\n","type":"text/plain"},"key":"values","value":"readable_type"}],"variable":[]}},"response":[{"id":"1d7d8abd-c9ec-4280-b181-8b14105e56f0","name":"201 Created: Create Enhancement Using Field Values","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Newly Created Enhancement\",\n \"description\": \"

Enhancement Description

\",\n \"assigned_group\": \"CFTR Admin\",\n \"assigned_to\": \"peter.smith@example.com\",\n \"due_date\": \"2023-06-25T11:16:17Z\",\n \"priority\": \"Very High\",\n \"labels\": [\"Blue Label Enhancement\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/enhancement/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","host":["{{base_url}}v1"],"path":["enhancement",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"values","value":"readable_type","description":"**Do not change the parameter value**\nAllows you to create enhancements using the values of assigned groups, labels and the email IDs of assigned users."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Apr 2023 09:59:33 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"2073","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"notes\": null,\n \"priority\": \"Very High\",\n \"enhancement_type\": [],\n \"title\": \"Newly Created Enhancement\",\n \"description\": \"

Enhancement Description

\",\n \"due_date\": \"2023-06-25T11:16:17Z\",\n \"assigned_to\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"assigned_to_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"peter.smith@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"assigned_group\": \"b0a6a9a6-f29b-4ea6-97d3-824da65b52f9\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"b0a6a9a6-f29b-4ea6-97d3-824da65b52f9\",\n \"group_name\": \"CFTR Admin\"\n },\n \"unique_id\": \"8a5e387f-0143-4d21-8743-22913580d29e\",\n \"readable_id\": \"ENH102\",\n \"created\": \"2023-04-21T09:59:32.111586Z\",\n \"modified\": \"2023-04-21T09:59:32.260234Z\",\n \"created_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"peter.smith@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"incidents\": [],\n \"incidents_data\": [],\n \"briefings\": [],\n \"briefings_data\": [],\n \"campaigns\": [],\n \"campaigns_data\": [],\n \"is_bookmarked\": false,\n \"status\": \"open\",\n \"can_update_instance\": true,\n \"can_update_full\": true,\n \"vulnerabilities\": [],\n \"vulnerabilities_data\": [],\n \"attachments_data\": [],\n \"closed_on\": null,\n \"closed_by_data\": null,\n \"labels\": [\n \"4e775af2-624a-40de-aa4b-82631dd65165\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"4e775af2-624a-40de-aa4b-82631dd65165\",\n \"title\": \"Blue Label Enhancement\",\n \"color_code\": \"#43A047\",\n \"created\": \"2023-04-21T09:57:34.940636Z\",\n \"modified\": \"2023-04-21T09:57:34.940636Z\"\n }\n ],\n \"applications\": [],\n \"applications_data\": [],\n \"malwares\": [],\n \"malwares_data\": [],\n \"threat_actors\": [],\n \"threat_actors_data\": [],\n \"title_display\": \"Newly Created Enhancement\",\n \"handoff_note\": null,\n \"enhancement_type_data\": [],\n \"priority_data\": {\n \"unique_id\": \"8ecc6cba-1e2b-4e29-b3a9-b07852e1db5f\",\n \"option_name\": \"Very High\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"e76c1eeb-a351-4571-93a6-357fb8a4985a\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n}"}],"_postman_id":"8d6d6388-b75d-4c31-8787-30f622ff3f28"},{"name":"Update Enhancement Using Field UUID","id":"5b5aa3fd-a446-41b9-a30d-4366634f2060","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"assigned_to\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"handoff_note\": {\n \"description\": \"

handing off

\",\n \"comment_type\": \"handoff\"\n }\n}"},"url":"{{base_url}}v1/enhancement/:enhancement_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Update the details of an enhancement in the CFTR application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/enhancement/:enhancement_unique_id/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
title	String	Optional	Enter a title for the enhancement.
description	String	Optional	Enter a description that best describes the key details of the enhancement.
status	String	Optional	Enter the status of the enhancement. Allowed values: - `open` - `closed` Example: \"closed\" Default value: \"open\"
enhancement_type	String	Optional	Enter the enhancement type. Some of the examples of Enhancement types are: • Process Update • Strategy Change • Policy Change Example: “Policy Change”
due_date	Datetime	Optional	Enter the due date of the enhancement.
labels	Array of Strings	Optional	List of Unique IDs of the labels to be attached to the enhancement in UUID-4 format.
priority	String	Optional	Enter the priority level of the enhancement. Some of the examples of Priority Levels are: • Very High • High • Medium • Low • Very Low Example: “Very Low”
assigned_group	String	Optional	Enter the unique ID of the user group to assign the enhancement. You can use the following API endpoint to retrieve the list of User Groups: `/openapi/v1/restauth/permission/group/`
handoff_note	Object Dictionary, String	Mandatory (If Assigned Group or Assigned Users are updated for an enhancement)	Provide the following details to update the Group or User assigned to the enhancement: `unique_id` – Enhancement Unique ID handoff_note: `description` – Description for the closure note `comment_type` – handoff Sample Request: `\"handoff_note\":{ \"comment_type\":\"handoff\", \"description\":\"Note for updating the Enhancement\" }`

Request Parameters | Connect The Dots

Provide the following parameters to update the Connect The Dots section of the Enhancement.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`applications`	Array of UUID Strings	List of `unique_id` of the connected applications.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`endpoints`	Array of UUID Strings	List of `unique_id` of the connected devices.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.

Request Parameters | Custom Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the enhancement component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=enhancement\n\n

Following are some of the sample custom fields for enhancements:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
summary_card_host_pairs	String	Optional
ie_port_numbers_impacted	String	Optional
enhancement_learning	String	Optional
recovery_details	String	Optional

Response Parameters

Response Parameters | Regulatory Fields

Parameter	Type	Description
unique_id	String	Unique ID of the enhancement in UUID-4 format.
readable_id	String	Unique readable ID of the enhancement. It starts with `ENH` followed by a unique number. Example: ENH101
created	String	enhancement creation date and time.
description	Text	Description of the enhancement.
modified	String	Last updated date and time of the enhancement.
title	Text	Title of the enhancement.
status	String	Current status of the enhancement. Allowed values: - `open` - `closed`
priority	String	Priority level of the enhancement.
priority_data	Object	Details of the priority assigned. Details include: `unique_id`, `option_name` and so on.
is_bookmarked	Boolean	Shows if the enhancement is bookmarked or not.
modified_by_data	Object	Details of the user who last updated the enhancement. Details include: `username`, `email` ,`first_name`, `last_name`, and so on.
assigned_group	String	Unique ID of the user group the enhancement belongs to in UUID-4 format.
assigned_group_data	Object	Details of the assigned user group. Details include: group name and group ID.
created_by_data	Object	Details of the user who created the enhancement. Details include: `username`, `email` ,`first_name`, `last_name`, and so on.
assigned_to	String	Unique ID of the assigned user of the enhancement belongs to in UUID-4 format.
assigned_to_data	Object	Details of the assigned user. Details include: `username`, `email` ,`first_name`, `last_name`, and so on.
labels	List of Strings	List of Unique IDs of the labels attached to the enhancement in UUID-4 format.
labels_data	List of Objects	Details of labels added to the enhancement. Details include: `title`, `unique_id`, `color_code`, and so on.
enhancement_type	List of Strings	Option name of the enhancement types associated with the enhancement.
enhancement_type_data	List of Objects	Details of the enhancement types associated with the enhancement.

Response Parameters | Connect The Dots

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`applications`	Array of UUID Strings	List of `unique_id` of the connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.

Response Parameters | Custom Fields

As CFTR form structure is dynamic and configurable, the response parameters might vary. The following table describes some examples of the custom fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type
summary_card_host_pairs	String
ie_port_numbers_impacted	String
enhancement_learning	String
recovery_details	String

Response Parameters | Attachments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
attachments_data	Array of Objects	Details of each attachment of the enhancement.

Response Parameters | Priority Data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
unique_id	String	Unique ID of the priority in UUID-4 format.
option_name	String	Display Name of the priority
color_code	String	Hex value of the priority display color.

Response Parameters | Enhancement Type Data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
unique_id	String	Unique ID of the enhancement in UUID-4 format.
option_name	String	Display Name of the enhancement type.
color_code	String	Hex value of the enhancement type display color.

Response Parameters | Labels Data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
unique_id	String	Unique ID of the label in UUID-4 format.
option_name	String	Display name of the label
color_code	String	Hex value of the label display color.

Example Error Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Description
400	You must be the assigned user to modify this Enhancement.
400	Only users of the assigned group can update the Enhancement.
400	Enhancement cannot be assigned to an inactive user.
404	Invalid Unique ID.

","urlObject":{"path":["enhancement",":enhancement_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the enhancement in UUID format.

\n","type":"text/plain"},"type":"any","value":"331bd09f-08f1-42ae-853c-a5b8b335adf9","key":"enhancement_unique_id"}]}},"response":[{"id":"609909b5-49e0-4a0f-96c0-a22cfa1ecf37","name":"Eg: Update Enhancement assignee","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"assigned_to\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"handoff_note\": {\n \"description\": \"

handing off

\",\n \"comment_type\": \"handoff\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/enhancement/:enhancement_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["enhancement",":enhancement_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"enhancement_unique_id","value":"331bd09f-08f1-42ae-853c-a5b8b335adf9","description":"Enter the unique ID of the enhancement in UUID format."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 24 Jun 2022 12:34:43 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1742","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"notes\": null,\n \"priority\": \"Very High\",\n \"enhancement_type\": [],\n \"title\": \"Updated Enhancement Title\",\n \"description\": \"

Enhancement Description

\",\n \"due_date\": \"2022-06-25T11:16:17Z\",\n \"assigned_to\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"assigned_to_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"assigned_group\": \"3219ad24-bf04-4cd3-93f5-01d189b43775\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"3219ad24-bf04-4cd3-93f5-01d189b43775\",\n \"group_name\": \"CFTR Admin\"\n },\n \"unique_id\": \"331bd09f-08f1-42ae-853c-a5b8b335adf9\",\n \"readable_id\": \"ENH105\",\n \"created\": \"2022-06-24T12:16:05.335210Z\",\n \"modified\": \"2022-06-24T12:34:42.625448Z\",\n \"created_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"incidents\": [],\n \"incidents_data\": [],\n \"briefings_data\": [],\n \"campaigns_data\": [],\n \"is_bookmarked\": false,\n \"status\": \"open\",\n \"can_update_instance\": true,\n \"can_update_full\": true,\n \"vulnerabilities_data\": [],\n \"attachments_data\": [],\n \"closed_on\": null,\n \"closed_by_data\": null,\n \"labels\": [],\n \"labels_data\": [],\n \"applications\": [],\n \"applications_data\": [],\n \"malwares_data\": [],\n \"threat_actors_data\": [],\n \"title_display\": \"Updated Enhancement Title\",\n \"enhancement_type_data\": [],\n \"priority_data\": {\n \"unique_id\": \"93cc825b-4687-4628-beef-d6e701b1a2fa\",\n \"option_name\": \"Very High\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"db8652db-ab75-4e06-abed-317b721db420\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n}"}],"_postman_id":"5b5aa3fd-a446-41b9-a30d-4366634f2060"},{"name":"Update Enhancement Using Field Values","id":"3cbc1dc0-8aa1-49aa-b4ae-d4aa7c2a13f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"assigned_to\": \"peter.smith@example.com\",\n \"handoff_note\": {\n \"description\": \"

handing off

Update the details of an enhancement in the CFTR application using the values of assigned groups, labels, and the email IDs of assigned users.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/enhancement/:enhancement_unique_id/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
title	String	Optional	Enter a title for the enhancement.
description	String	Optional	Enter a description that best describes the key details of the enhancement.
status	String	Optional	Enter the status of the enhancement. Allowed values: - `open` - `closed` Example: \"closed\" Default value: \"open\"
enhancement_type	String	Optional	Enter the enhancement type. Some of the examples of Enhancement types are: • Process Update • Strategy Change • Policy Change Example: “Policy Change”
due_date	Datetime	Optional	Enter the due date of the enhancement.
labels	List	Optional	Enter the list of names of the labels to be attached to the enhancement. You can use the following API endpoint to retrieve the list of Labels: `/openapi/v1/utils/label/`
priority	String	Optional	Enter the priority level of the enhancement. Some of the examples of Priority Levels are: • Very High • High • Medium • Low • Very Low Example: “Very Low”
assigned_group	String	Optional	Enter the name of the user group to assign the enhancement. You can use the following API endpoint to retrieve the list of User Groups: `/openapi/v1/restauth/permission/group/`
handoff_note	Object Dictionary, String	Mandatory (If Assigned Group or Assigned Users are updated for an enhancement)	Provide the following details to update the Group or User assigned to the enhancement: `unique_id` – Enhancement Unique ID handoff_note: `description` – Description for the closure note `comment_type` – handoff Sample Request: `\"handoff_note\":{ \"comment_type\":\"handoff\", \"description\":\"Note for updating the Enhancement\" }`
assigned_to	String	Optional	Enter the email ID of the user to assign the enhancement. You can use the following API endpoint to retrieve the list of User:`/openapi/v1/rest-auth/user/`

Request Parameters | Connect The Dots

Provide the following parameters to update the Connect The Dots section of the Enhancement.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`applications`	Array of UUID Strings	List of `unique_id` of the connected applications.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`endpoints`	Array of UUID Strings	List of `unique_id` of the connected devices.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.

Request Parameters | Custom Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the enhancement component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=enhancement\n\n

Following are some of the sample custom fields for enhancements:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
summary_card_host_pairs	String	Optional
ie_port_numbers_impacted	String	Optional
enhancement_learning	String	Optional
recovery_details	String	Optional

Response Parameters

Response Parameters | Regulatory Fields

Parameter	Type	Description
unique_id	String	Unique ID of the enhancement in UUID-4 format.
readable_id	String	Unique readable ID of the enhancement. It starts with `ENH` followed by a unique number. Example: ENH101
created	Datetime	enhancement creation date and time.
description	Text	Description of the enhancement.
modified	Datetime	Last updated date and time of the enhancement.
title	Text	Title of the enhancement.
status	String	Current status of the enhancement. Allowed values: - `open` - `closed`
priority	String	Priority level of the enhancement.
priority_data	Object	Details of the priority assigned. Details include: `unique_id`, `option_name` and so on.
is_bookmarked	Boolean	Shows if the enhancement is bookmarked or not.
modified_by_data	Object	Details of the user who last updated the enhancement. Details include: `username`, `email` ,`first_name`, `last_name`, and so on.
assigned_group	String	Unique ID of the user group the enhancement belongs to in UUID-4 format.
assigned_group_data	Object	Details of the assigned user group. Details include: group name and group ID.
created_by_data	Object	Details of the user who created the enhancement. Details include: `username`, `email` ,`first_name`, `last_name`, and so on.
assigned_to	String	Unique ID of the assigned user of the enhancement belongs to in UUID-4 format.
assigned_to_data	Object	Details of the assigned user. Details include: `username`, `email` ,`first_name`, `last_name`, and so on.
labels	List of Strings	List of Unique IDs of the labels attached to the enhancement in UUID-4 format.
labels_data	List of Objects	Details of labels added to the enhancement. Details include: `title`, `unique_id`, `color_code`, and so on.
enhancement_type	List of Strings	Option name of the enhancement types associated with the enhancement.
enhancement_type_data	List of Objects	Details of the enhancement types associated with the enhancement.

Response Parameters | Connect The Dots

Following are the response parameters corresponding to the Connect The Dots section of the enhancement. The parameters ending with _data contain the meta information for each connected component. The non `_data` parameters just include an array of unique_id referencing to connected components.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`applications`	Array of UUID Strings	List of `unique_id` of the connected applications.
`applications_data`	Array of Objects	Details of the connected applications.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.

Response Parameters | Custom Fields

As CFTR form structure is dynamic and configurable, the response parameters might vary. The following table describes some examples of the custom fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type
summary_card_host_pairs	String
ie_port_numbers_impacted	String
enhancement_learning	String
recovery_details	String

Response Parameters | Attachments

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
attachments_data	Array of Objects	Details of each attachment of the enhancement.

Response Parameters | Priority Data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
unique_id	String	Unique ID of the priority in UUID-4 format.
option_name	String	Display Name of the priority
color_code	String	Hex value of the priority display color.

Response Parameters | Enhancement Type Data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
unique_id	String	Unique ID of the enhancement in UUID-4 format.
option_name	String	Display Name of the enhancement type.
color_code	String	Hex value of the enhancement type display color.

Response Parameters | Labels Data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
unique_id	String	Unique ID of the label in UUID-4 format.
option_name	String	Display name of the label
color_code	String	Hex value of the label display color.

Example Error Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Description
400	You must be the assigned user to modify this Enhancement.
400	Only users of the assigned group can update the Enhancement.
400	Enhancement cannot be assigned to an inactive user.
404	Invalid Unique ID.

Do not change the parameter value\nAllows you to update enhancements using the values of assigned groups, labels and the email IDs of assigned users.

\n","type":"text/plain"},"key":"values","value":"readable_type"}],"variable":[{"description":{"content":"

Enter the unique ID of the enhancement in UUID format.

\n","type":"text/plain"},"type":"any","value":"8a5e387f-0143-4d21-8743-22913580d29e","key":"enhancement_unique_id"}]}},"response":[{"id":"196562bf-9537-4130-9b26-b523300b7be6","name":"200 OK: Update Enhancement Using Field Values","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"assigned_to\": \"peter.smith@example.com\",\n \"handoff_note\": {\n \"description\": \"

handing off

\",\n \"comment_type\": \"handoff\"\n },\n \"assigned_group\": \"CFTR Admin\",\n \"labels\": [\"Red Label Enhancement\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/enhancement/:enhancement_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","host":["{{base_url}}v1"],"path":["enhancement",":enhancement_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"values","value":"readable_type","description":"**Do not change the parameter value**\nAllows you to update enhancements using the values of assigned groups, labels and the email IDs of assigned users."}],"variable":[{"key":"enhancement_unique_id","value":"8a5e387f-0143-4d21-8743-22913580d29e","description":"Enter the unique ID of the enhancement in UUID format."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Apr 2023 10:26:59 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"notes\": null,\n \"priority\": \"Very High\",\n \"enhancement_type\": [],\n \"title\": \"Newly Created Enhancement\",\n \"description\": \"

Enhancement Description

\",\n \"due_date\": \"2023-06-25T11:16:17Z\",\n \"assigned_to\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"assigned_to_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"peter.smith@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"assigned_group\": \"b0a6a9a6-f29b-4ea6-97d3-824da65b52f9\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"b0a6a9a6-f29b-4ea6-97d3-824da65b52f9\",\n \"group_name\": \"CFTR Admin\"\n },\n \"unique_id\": \"8a5e387f-0143-4d21-8743-22913580d29e\",\n \"readable_id\": \"ENH102\",\n \"created\": \"2023-04-21T09:59:32.111586Z\",\n \"modified\": \"2023-04-21T10:26:58.587755Z\",\n \"created_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"peter.smith@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"incidents\": [],\n \"incidents_data\": [],\n \"briefings\": [],\n \"briefings_data\": [],\n \"campaigns\": [],\n \"campaigns_data\": [],\n \"is_bookmarked\": false,\n \"status\": \"open\",\n \"can_update_instance\": true,\n \"can_update_full\": true,\n \"vulnerabilities\": [],\n \"vulnerabilities_data\": [],\n \"attachments_data\": [],\n \"closed_on\": null,\n \"closed_by_data\": null,\n \"labels\": [\n \"6bbff4a1-b77e-4e0f-be7b-c045338cf1ad\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"6bbff4a1-b77e-4e0f-be7b-c045338cf1ad\",\n \"title\": \"Red Label Enhancement\",\n \"color_code\": \"#00897B\",\n \"created\": \"2023-04-21T09:57:55.149855Z\",\n \"modified\": \"2023-04-21T09:57:55.149855Z\"\n }\n ],\n \"applications\": [],\n \"applications_data\": [],\n \"malwares\": [],\n \"malwares_data\": [],\n \"threat_actors\": [],\n \"threat_actors_data\": [],\n \"title_display\": \"Newly Created Enhancement\",\n \"handoff_note\": null,\n \"enhancement_type_data\": [],\n \"priority_data\": {\n \"unique_id\": \"8ecc6cba-1e2b-4e29-b3a9-b07852e1db5f\",\n \"option_name\": \"Very High\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"e76c1eeb-a351-4571-93a6-357fb8a4985a\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n}"}],"_postman_id":"3cbc1dc0-8aa1-49aa-b4ae-d4aa7c2a13f0"},{"name":"Close Enhancement","id":"c50e372c-c250-4fe8-bf2d-09111a588aed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": \"closed\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/enhancement/:enhancement_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Close an enhancement in the CFTR application.

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
status	String	Mandatory	Enter “closed”.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
modified	String	Enhancement closing time.
modified_by_data	Object	Details of the user who closed the enhancement. Details include: username, email, first name, last name, and so on.

Enter the unique ID of the enhancement in UUID format.

\n","type":"text/plain"},"type":"any","value":"2d034703-7800-4a3f-8b70-9b2627bc0579","key":"enhancement_unique_id"}]}},"response":[{"id":"7033a272-c9cf-4f57-8bd9-cc3207bbcd6e","name":"Eg: Close Enhancement","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": \"closed\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/enhancement/:enhancement_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["enhancement",":enhancement_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"enhancement_unique_id","value":"2d034703-7800-4a3f-8b70-9b2627bc0579","description":"Enter the unique ID of the enhancement in UUID format."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 24 Jun 2022 13:10:26 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"2386","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"notes\": null,\n \"priority\": \"Very High\",\n \"enhancement_type\": [],\n \"title\": \"Review and Update based on v.1.23.4 Production Docs\",\n \"description\": null,\n \"due_date\": null,\n \"assigned_to\": null,\n \"assigned_to_data\": null,\n \"assigned_group\": \"3219ad24-bf04-4cd3-93f5-01d189b43775\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"3219ad24-bf04-4cd3-93f5-01d189b43775\",\n \"group_name\": \"CFTR Admin\"\n },\n \"unique_id\": \"2d034703-7800-4a3f-8b70-9b2627bc0579\",\n \"readable_id\": \"ENH103\",\n \"created\": \"2022-06-24T11:19:07.427464Z\",\n \"modified\": \"2022-06-24T13:10:25.637756Z\",\n \"created_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"incidents\": [\n \"75e58cfc-bf31-493d-a4bb-93368541c034\"\n ],\n \"incidents_data\": [\n {\n \"unique_id\": \"75e58cfc-bf31-493d-a4bb-93368541c034\",\n \"readable_id\": \"INC102\",\n \"1a38a4a6-b16a-4079-adb2-c5638f7cbe74\": \"Test Incident\",\n \"status\": \"open\",\n \"created\": \"2022-06-24T11:54:04.266775Z\",\n \"modified\": \"2022-06-24T11:54:05.255647Z\",\n \"title_display\": \"Test Incident\",\n \"severity_title\": \"High\"\n }\n ],\n \"briefings_data\": [],\n \"campaigns_data\": [],\n \"is_bookmarked\": false,\n \"status\": \"closed\",\n \"can_update_instance\": true,\n \"can_update_full\": true,\n \"vulnerabilities_data\": [],\n \"attachments_data\": [],\n \"closed_on\": \"2022-06-24T13:10:25.352903Z\",\n \"closed_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"labels\": [],\n \"labels_data\": [],\n \"applications\": [\n \"984940b2-3f4b-40ea-b3ce-f534cabc692a\"\n ],\n \"applications_data\": [\n {\n \"unique_id\": \"984940b2-3f4b-40ea-b3ce-f534cabc692a\",\n \"created\": \"2022-06-24T05:30:06.433714Z\",\n \"modified\": \"2022-06-24T05:31:01.734959Z\",\n \"title\": \"New Application\",\n \"production_date\": null,\n \"readable_id\": \"APL101\",\n \"labels\": [],\n \"labels_data\": [],\n \"title_display\": \"New Application\",\n \"status\": \"active\"\n }\n ],\n \"malwares_data\": [],\n \"threat_actors_data\": [],\n \"title_display\": \"Review and Update based on v.1.23.4 Production Docs\",\n \"enhancement_type_data\": [],\n \"priority_data\": {\n \"unique_id\": \"93cc825b-4687-4628-beef-d6e701b1a2fa\",\n \"option_name\": \"Very High\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"db8652db-ab75-4e06-abed-317b721db420\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n}"}],"_postman_id":"c50e372c-c250-4fe8-bf2d-09111a588aed"},{"name":"Add Comment in Enhancement","id":"82eba84a-eba1-4ff1-9d8c-c489ee5690f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"description\": \"

Note For Enhancement

\",\n \"mentioned_users_usernames\": []\n}"},"url":"{{base_url}}v1/comments/enhancement/:enhancement_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Add comments or notes to an enhancement in the CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
description	String	Mandatory	Enter the content of the comment.
mentioned_users_usernames	List of UUID	Optional	Enter the list of usernames of users mentioned in the comment.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
unique_id	String	Unique ID of the comment.
description	Text	Content of the comment.
created_by	Object	Details of the user who added the comment.
modified_by	Object	Details of the user who last updated the comment.
mentioned_users	List of UUID	List of `user_id` of users mentioned in the comment.
mentioned_users_data	List of Objects	Details of the users mentioned in the comment.
created	Datetime	Comment creation date and time.
modified	Datetime	Comment last updated date and time.
is_removed	Boolean	Displays if the comment is in deleted state or not.
comment_type	String	Type of Comment. Examples: `discussion`: Notes added in any instance. `handoff`: Handoff notes added while updating the assignee or assigned group.
content_object	String	Component in which the comment is added. Example: `enhancement`, `incident`, `action`, `ioc`, and so on.
content_object_readable_id	String	`readable_id` of the component instance in which comment is added
content_object_unique_id	String	`unique_id` of the component instance in which comment is added
description_with_img_src	Text	Content of the content with the image URLs (if any image is added in the comment).
pinned	Boolean	Displays if the comment is pinned or not.

","urlObject":{"path":["comments","enhancement",":enhancement_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the enhancement in UUID format.

\n","type":"text/plain"},"type":"any","value":"331bd09f-08f1-42ae-853c-a5b8b335adf9","key":"enhancement_unique_id"}]}},"response":[{"id":"1df19159-534f-4cf3-b924-ae327026391c","name":"Add Comment in Enhancement","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"description\": \"

Note For Enhancement

\",\n \"mentioned_users_usernames\": []\n}"},"url":{"raw":"{{base_url}}v1/comments/enhancement/:enhancement_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["comments","enhancement",":enhancement_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"enhancement_unique_id","value":"826191f2-0f24-43af-83b8-399619a43b6b","description":"Enter the unique ID of the enhancement in UUID format."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 28 Jan 2024 11:20:00 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"931","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Server","value":"gunicorn/19.10.0","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"unique_id\": \"9edec6b8-0a02-4f72-8633-c9beea9e6f55\",\n \"description\": \"

Note For Enhancement

\",\n \"created_by\": {\n \"user_id\": \"b3184a17-e59f-46cb-82c3-d8aabbefff7e\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"email\": \"system@default.tld\",\n \"display_pic\": null,\n \"username\": \"system.default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"System Default\"\n },\n \"modified_by\": null,\n \"is_removed\": false,\n \"mentioned_users\": [],\n \"mentioned_users_data\": [],\n \"created\": \"2024-01-28T11:19:59.814033Z\",\n \"modified\": \"2024-01-28T11:19:59.823657Z\",\n \"email\": null,\n \"internal\": false,\n \"comment_type\": \"discussion\",\n \"command_params\": {},\n \"command_result\": {},\n \"command_status\": \"na\",\n \"attachments_data\": [],\n \"content_object\": \"enhancement\",\n \"content_object_readable_id\": \"ENH144\",\n \"content_object_unique_id\": \"826191f2-0f24-43af-83b8-399619a43b6b\",\n \"attachment_label\": null,\n \"description_with_img_src\": \"

Note For Enhancement

\",\n \"pinned\": false,\n \"field\": null,\n \"note_tag\": null\n}"}],"_postman_id":"82eba84a-eba1-4ff1-9d8c-c489ee5690f4"},{"name":"Upload an Attachment","id":"9c9563d3-10cd-4ca5-b3e4-82d96472134c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"key":"uploaded_file","type":"file","src":"/Users/ericjohn/Downloads/Attachment.png"},{"key":"file_type","value":"artifact","type":"text"}]},"url":"{{base_url}}v1/utils/file/enhancement/:enhancement_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Upload any type of file to the enhancement.

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
uploaded_file	File	Mandatory	Enter the file to be uploaded.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
title	String	Name of the file.
description	Text	Description of the file.
uploaded_file	URL	URL of the file from where it can be downloaded.
unique_id	String	Unique ID for the file.
created_by_data	Object	Details of the user who uploaded the file.
created	String	File upload time.
modified	String	File modified time.
readable_id	String	Unique readable ID of the file. For example, ART226.
file_hash	String	Hash of the file.
file_type	String	Value is `artifact` for enhancement.
file_size	Integer	Size of the file.
parent_readable_id	String	`readable_id` of the component instance in which the file is uploaded.
parent_component	String	Component name in which file is uploaded. Example: `enhancement`, `action`, and so on.
parent_unique_id	String	`unique_id` of the component instance in which the file is uploaded
is_removed	Boolean	Displays if the file is in the deleted state or not.

","urlObject":{"path":["utils","file","enhancement",":enhancement_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the enhancement in UUID format.

\n","type":"text/plain"},"type":"any","value":"331bd09f-08f1-42ae-853c-a5b8b335adf9","key":"enhancement_unique_id"}]}},"response":[{"id":"284859e2-058a-4dab-a64c-aecb53f88b7c","name":"Eg: Upload an Attachment","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"key":"uploaded_file","type":"file","src":"/Users/ericjohn/Downloads/Attachment.png"}]},"url":{"raw":"{{base_url}}v1/utils/file/enhancement/:enhancement_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["utils","file","enhancement",":enhancement_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"enhancement_unique_id","value":"331bd09f-08f1-42ae-853c-a5b8b335adf9","description":"Enter the unique ID of the enhancement in UUID format."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 24 Jun 2022 13:20:23 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1095","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"Attachment.png\",\n \"description\": null,\n \"uploaded_file\": \"http://host.docker.internal:51620/cftrbucket/ciims-data/0adaaa8d-Attachment.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minio%2F20220624%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20220624T132022Z&X-Amz-Expires=120&X-Amz-SignedHeaders=host&X-Amz-Signature=5c97b92827a0f2e4cae912809c2517eb87d6790232a9fd1f1e80b30588f9d7a1\",\n \"unique_id\": \"1bf908da-3cf1-4aaa-91ca-b26c9cdc948e\",\n \"created_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"created\": \"2022-06-24T13:20:19.841255Z\",\n \"modified\": \"2022-06-24T13:20:22.062668Z\",\n \"readable_id\": \"ART101\",\n \"is_removed\": false,\n \"readable_id_counter\": 101,\n \"file_hash\": \"a0107e9ccf145f65f245e436cf6e5fef\",\n \"file_type\": \"artifact\",\n \"file_size\": 2819678,\n \"can_delete\": true,\n \"parent_readable_id\": \"ENH105\",\n \"parent_component\": \"enhancement\",\n \"parent_unique_id\": \"331bd09f-08f1-42ae-853c-a5b8b335adf9\"\n}"}],"_postman_id":"9c9563d3-10cd-4ca5-b3e4-82d96472134c"}],"id":"6c1515bf-7c01-4cf3-af37-67c4d4738b5f","description":"

A threat response plan is subjected to enhancements such as changes to security policies, new guidelines, strategy changes for responding to specific incidents, and process updates based on learnings from the previous threats, and so on. These enhancements help the security teams in the steady improvement of the threat response plan by evaluating potential failure modes and situations in which the response could break down and finally making the necessary enhancements to the overall threat response process. Users can create enhancements based on incidents, vulnerabilities, and assets and effectively track them to closure.

This section describes how to use the API endpoints to manage the enhancements in CFTR.

\n","_postman_id":"6c1515bf-7c01-4cf3-af37-67c4d4738b5f"},{"name":"Campaigns","item":[{"name":"Get List of Campaigns","id":"83743626-990c-482f-bf58-09c8944ae157","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/campaign/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&status=ACTIVE","description":"

Retrieve a list of all the campaigns with details from the CFTR application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/campaign/?

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
link	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` shows the API endpoint to the next page.
count	Integer	Total number of campaigns in CFTR application according to the filters applied.
results	List of Objects	Details of the campaigns. Each object provides details of one campaign.

Response Parameters | Results Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
unique_id	String	Unique ID of the campaign in UUID-4 format.
readable_id	String	Unique readable ID of the campaign. It starts with `CMP` followed by a unique number. Example: CMP101
created	String	Campaign creation date and time.
description	Text	Description of the campaign.
modified	String	Last updated date and time of the campaign.
title	String	Title of the campaign.
title_display	String	Title of the campaign.
status	String	Current status of the campaign. Allowed values: `ACTIVE` `INACTIVE`
is_bookmarked	Boolean	Shows if the campaign is bookmarked or not.
created_by_data	Object	Details of user who created the campaign. Details include: `username`, `email` ,`first_name`, `last_name`, and so on.
labels	List of Strings	Unique ID of the labels associated with the campaign in UUID-4 format.
labels_data	List of Objects	Details of labels added to the campaign. Details include: `title`, `unique_id`, `color_code`, and so on.

","urlObject":{"path":["campaign",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"description":{"content":"

[optional] Enter the status of the campaigns\nAllowed values:\n• ACTIVE\n• INACTIVE

Example: “ACTIVE”

\n","type":"text/plain"},"key":"status","value":"ACTIVE"},{"disabled":true,"description":{"content":"

[optional] Enter the last modified time of the campaigns in EPOCH Time format.\nTime Zone must be as per UTC. All campaigns with modified date later than the entered time will be returned.

\n","type":"text/plain"},"key":"modified_date__gte","value":"1643283426"},{"disabled":true,"description":{"content":"

[optional] Enter the last modified time of the campaigns in EPOCH Time format.\nTime Zone must be as per UTC. All campaigns with modified date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"modified_date__lte","value":"1643283426"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the campaigns in EPOCH Time format.\nTime Zone must be as per UTC. All campaigns with creation date later than the entered time will be returned.

\n","type":"text/plain"},"key":"created_date__gte","value":"1643283426"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the campaigns in EPOCH Time format.\nTime Zone must be as per UTC. All campaigns with creation date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"created_date__lte","value":"1643283426"},{"disabled":true,"description":{"content":"

[optional] Enter the page number of the campaigns list. This will retrieve the list of all campaigns from the entered page.

Default value: 1

\n","type":"text/plain"},"key":"page","value":"2"},{"disabled":true,"description":{"content":"

[optional] Enter number of campaigns per page.\nDefault value: 10

\n","type":"text/plain"},"key":"page_size","value":"2"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID of a label associated with campaigns. This parameter retrieves the campaigns with the label.

\n","type":"text/plain"},"key":"labels","value":"9e44ab13-64e5-43ad-a8d1-e1d181681090"}],"variable":[]}},"response":[{"id":"d59e8dee-83db-42f0-a2cb-3f7c5b923118","name":"Eg: Get List of Campaigns","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/campaign/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["campaign",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"status","value":"open","description":"[optional] Enter the status of the incidents.\nAllowed values:\n• open\n• closed\n• untriaged\n• merged\nExample: “open”","disabled":true},{"key":"modified_date__gte","value":"1643283426","description":"[optional] Enter the last modified time of the incidents in EPOCH Time format.\nTime Zone must be as per UTC. All Incidents with modified date later than the entered time will be returned.","disabled":true},{"key":"modified_date__lte","value":"1643283426","description":"[optional] Enter the last modified time of the incidents in EPOCH Time format.\nTime Zone must be as per UTC. All Incidents with modified date earlier than the entered time will be returned.","disabled":true},{"key":"created_date__gte","value":"1643283426","description":"[optional] Enter the creation time of the incidents in EPOCH Time format.\nTime Zone must be as per UTC. All Incidents with creation date later than the entered time will be returned.","disabled":true},{"key":"created_date__lte","value":"1643283426","description":"[optional] Enter the creation time of the incidents in EPOCH Time format.\nTime Zone must be as per UTC. All Incidents with creation date earlier than the entered time will be returned.","disabled":true},{"key":"page","value":"2","description":"[optional] Enter the page number of the incident list. This will retrieve the list of all Incidents from the entered page.\n\nDefault value: 1","disabled":true},{"key":"page_size","value":"4","description":"[optional] Enter number of incidents per page.\nDefault value: 10","disabled":true},{"key":"business_units","value":"9750d6df-2d7f-4899-b20d-bfbba0a9084d","description":"[optional] Enter the unique ID of the business unit. This parameter retrieves the incidents associated with the business unit.\n\nYou can retrieve the list of available Business Units and their Unique IDs using the following API endpoint:\n\n`/openapi/v1/utils/business-unit/`","disabled":true},{"key":"level","value":"9e44ab13-64e5-43ad-a8d1-e1d181681090","description":"[optional] Enter the unique ID of a severity level of the incidents. This parameter retrieves the incidents by the severity level.","disabled":true},{"key":"phase","value":"a5e04da7-61fb-4436-a11a-ab219eaeb296","description":"[optional] Enter the unique ID of a phase.This parameter retrieves the incidents by the entered phase of incidents. ","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jun 2022 13:42:37 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1679","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 3,\n \"results\": [\n {\n \"unique_id\": \"a152c080-ab9d-4512-8b75-978bd13636d6\",\n \"readable_id\": \"CMP103\",\n \"title\": \"Dept Wide Campaign: Analytics\",\n \"status\": \"ACTIVE\",\n \"created\": \"2022-06-27T13:42:28.083302Z\",\n \"modified\": \"2022-06-27T13:42:28.145535Z\",\n \"created_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"is_bookmarked\": false,\n \"title_display\": \"Dept Wide Campaign: Analytics\",\n \"labels_data\": []\n },\n {\n \"unique_id\": \"8f54ae2a-09dc-4397-92c2-71f5d3dbab29\",\n \"readable_id\": \"CMP102\",\n \"title\": \"New Campaign\",\n \"status\": \"ACTIVE\",\n \"created\": \"2022-06-27T13:38:11.609909Z\",\n \"modified\": \"2022-06-27T13:38:11.669500Z\",\n \"created_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"is_bookmarked\": false,\n \"title_display\": \"New Campaign\",\n \"labels_data\": []\n },\n {\n \"unique_id\": \"ba5912e2-8851-47ba-a5d8-5682efb848bc\",\n \"readable_id\": \"CMP101\",\n \"title\": \"Update Resources for Gunicorn\",\n \"status\": \"ACTIVE\",\n \"created\": \"2022-06-27T13:33:39.752824Z\",\n \"modified\": \"2022-06-27T13:33:44.876502Z\",\n \"created_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"is_bookmarked\": false,\n \"title_display\": \"Update Resources for Gunicorn\",\n \"labels_data\": []\n }\n ]\n}"},{"id":"51c083bb-4ed3-405d-8c61-b2118c0e8edf","name":"Eg: Get List of Campaigns from page 2 with page size 2","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/campaign/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&page=2&page_size=2","host":["{{base_url}}v1"],"path":["campaign",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"status","value":"ACTIVE","description":"[optional] Enter the status of the campaigns\nAllowed values:\n• ACTIVE\n• INACTIVE\n\nExample: “ACTIVE”","disabled":true},{"key":"modified_date__gte","value":"1643283426","description":"[optional] Enter the last modified time of the campaigns in EPOCH Time format.\nTime Zone must be as per UTC. All campaigns with modified date later than the entered time will be returned.","disabled":true},{"key":"modified_date__lte","value":"1643283426","description":"[optional] Enter the last modified time of the campaigns in EPOCH Time format.\nTime Zone must be as per UTC. All campaigns with modified date earlier than the entered time will be returned.","disabled":true},{"key":"created_date__gte","value":"1643283426","description":"[optional] Enter the creation time of the campaigns in EPOCH Time format.\nTime Zone must be as per UTC. All campaigns with creation date later than the entered time will be returned.","disabled":true},{"key":"created_date__lte","value":"1643283426","description":"[optional] Enter the creation time of the campaigns in EPOCH Time format.\nTime Zone must be as per UTC. All campaigns with creation date earlier than the entered time will be returned.","disabled":true},{"key":"page","value":"2","description":"[optional] Enter the page number of the campaigns list. This will retrieve the list of all campaigns from the entered page.\n\nDefault value: 1"},{"key":"page_size","value":"2","description":"[optional] Enter number of campaigns per page.\nDefault value: 10"},{"key":"labels","value":"9e44ab13-64e5-43ad-a8d1-e1d181681090","description":"[optional] Enter the unique ID of a label associated with campaigns. This parameter retrieves the campaigns with the label.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jun 2022 13:52:54 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"749","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {\n \"previous\": \"openapi/v1/campaign/?page=1&page_size=2&AccessID=a7a71aff-8383-4cb0-8e1d-4c1f835aea7c&Expires=1656337989&Signature=tut43+j7MnD6puYDdg2E6FY9XWc=\"\n },\n \"count\": 3,\n \"results\": [\n {\n \"unique_id\": \"ba5912e2-8851-47ba-a5d8-5682efb848bc\",\n \"readable_id\": \"CMP101\",\n \"title\": \"Update Resources for Gunicorn\",\n \"status\": \"ACTIVE\",\n \"created\": \"2022-06-27T13:33:39.752824Z\",\n \"modified\": \"2022-06-27T13:33:44.876502Z\",\n \"created_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"is_bookmarked\": false,\n \"title_display\": \"Update Resources for Gunicorn\",\n \"labels_data\": []\n }\n ]\n}"},{"id":"5a750386-9512-408a-be8f-79073a7d2c5a","name":"Eg: Get List of Active Campaigns","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/campaign/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&status=ACTIVE","host":["{{base_url}}v1"],"path":["campaign",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"status","value":"ACTIVE","description":"[optional] Enter the status of the campaigns\nAllowed values:\n• ACTIVE\n• INACTIVE\n\nExample: “ACTIVE”"},{"key":"modified_date__gte","value":"1643283426","description":"[optional] Enter the last modified time of the campaigns in EPOCH Time format.\nTime Zone must be as per UTC. All campaigns with modified date later than the entered time will be returned.","disabled":true},{"key":"modified_date__lte","value":"1643283426","description":"[optional] Enter the last modified time of the campaigns in EPOCH Time format.\nTime Zone must be as per UTC. All campaigns with modified date earlier than the entered time will be returned.","disabled":true},{"key":"created_date__gte","value":"1643283426","description":"[optional] Enter the creation time of the campaigns in EPOCH Time format.\nTime Zone must be as per UTC. All campaigns with creation date later than the entered time will be returned.","disabled":true},{"key":"created_date__lte","value":"1643283426","description":"[optional] Enter the creation time of the campaigns in EPOCH Time format.\nTime Zone must be as per UTC. All campaigns with creation date earlier than the entered time will be returned.","disabled":true},{"key":"page","value":"2","description":"[optional] Enter the page number of the campaigns list. This will retrieve the list of all campaigns from the entered page.\n\nDefault value: 1","disabled":true},{"key":"page_size","value":"2","description":"[optional] Enter number of campaigns per page.\nDefault value: 10","disabled":true},{"key":"labels","value":"9e44ab13-64e5-43ad-a8d1-e1d181681090","description":"[optional] Enter the unique ID of a label associated with campaigns. This parameter retrieves the campaigns with the label.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jun 2022 13:54:32 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1119","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 2,\n \"results\": [\n {\n \"unique_id\": \"8f54ae2a-09dc-4397-92c2-71f5d3dbab29\",\n \"readable_id\": \"CMP102\",\n \"title\": \"New Campaign\",\n \"status\": \"ACTIVE\",\n \"created\": \"2022-06-27T13:38:11.609909Z\",\n \"modified\": \"2022-06-27T13:38:11.669500Z\",\n \"created_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"is_bookmarked\": false,\n \"title_display\": \"New Campaign\",\n \"labels_data\": []\n },\n {\n \"unique_id\": \"ba5912e2-8851-47ba-a5d8-5682efb848bc\",\n \"readable_id\": \"CMP101\",\n \"title\": \"Update Resources for Gunicorn\",\n \"status\": \"ACTIVE\",\n \"created\": \"2022-06-27T13:33:39.752824Z\",\n \"modified\": \"2022-06-27T13:33:44.876502Z\",\n \"created_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"is_bookmarked\": false,\n \"title_display\": \"Update Resources for Gunicorn\",\n \"labels_data\": []\n }\n ]\n}"}],"_postman_id":"83743626-990c-482f-bf58-09c8944ae157"},{"name":"Get Details of a Campaign","id":"5d1e9043-fff7-4565-9bbc-e588a2bc1969","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/campaign/:campaign_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the details of a campaign.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/campaign/:campaign_unique_id/?

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

Response Parameters | Regulatory Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
unique_id	String	Unique ID of the campaign in UUID-4 format.
readable_id	String	Unique readable ID of the campaign. It starts with `CMP` followed by a unique number. Example: CMP101
created	String	Campaign creation date and time.
description	Text	Description of the campaign.
modified	String	Last updated date and time of the campaign.
title	String	Title of the campaign.
title_display	String	Title of the campaign.
status	String	Current status of the campaign. Allowed values: `ACTIVE` `INACTIVE`
is_bookmarked	Boolean	Shows if the campaign is bookmarked or not.
created_by_data	Object	Details of the user who created the campaign. Details include: `username`, `email` ,`first_name`, `last_name`, and so on.
labels	List of Strings	Unique ID of the labels associated with the campaign in UUID-4 format.
labels_data	List of Objects	Details of labels added to the campaign. Details include: `title`, `unique_id`, `color_code`, and so on.

Response Parameters | Connect The Dots

Following are the response parameters corresponding to the Connect The Dots section of the campaign. The parameters ending with _data contain the meta information for each connected component. The non __data_ parameters just include an array of unique_id referencing to connected components.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`incidents`	Array UID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`malwares`	Array UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.

Response Parameters | Actions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
actions_data	Array of Objects	Details of the actions that are added to the campaign.

Response Parameters | PIRs

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
pirs_data	Array of Objects	Details of the PIRs that are added to the campaign.

Response Parameters | Enhancements

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
enhancements_data	Array of Objects	Details of the enhancements that are added to the campaign.

Response Parameters | Custom Fields

As CFTR form structure is dynamic and configurable, the response parameters might vary. The following table describes some examples of the custom fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type
custom_campaign_field	String
campaign_learning	String
recovery_details	String

Response Parameters | System Form Fields

Few of the fields or parameters have the values in UUID-4 format. These fields do not intake Option Name in the request as they are used internally for various additional responsibilities around Analytics, Relationships, and Filtering. These fields also include the parameters under Connect the Dots and Labels.

The fields include:

All Connect the Dots params: You can retrieve the corresponding UUID-4 from the details page browser URL of the instance.
\n
Labels: You can retrieve the corresponding UUID-4 from Admin > Settings > Labels section.
\n

\n","urlObject":{"path":["campaign",":campaign_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the campaign in UUID format.

\n","type":"text/plain"},"type":"any","value":"a152c080-ab9d-4512-8b75-978bd13636d6","key":"campaign_unique_id"}]}},"response":[{"id":"6382e569-f05d-4eb2-82c1-57bc8b9edb0d","name":"Eg: Get Campaign Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/campaign/:campaign_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["campaign",":campaign_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"campaign_unique_id","value":"a152c080-ab9d-4512-8b75-978bd13636d6","description":"Enter the unique ID of the campaign in UUID format."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jun 2022 14:10:49 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1265","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"custom_campaign_field\": \"Critical\",\n \"unique_id\": \"a152c080-ab9d-4512-8b75-978bd13636d6\",\n \"readable_id\": \"CMP103\",\n \"title\": \"Dept Wide Campaign: Analytics\",\n \"description\": \"

Department Wide Campaign for Analytics Department

\",\n \"status\": \"INACTIVE\",\n \"last_activity_time\": 1656337519,\n \"created\": \"2022-06-27T13:42:28.083302Z\",\n \"modified\": \"2022-06-27T13:45:19.319838Z\",\n \"created_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"briefings\": [],\n \"briefings_data\": [],\n \"incidents_data\": [],\n \"threatactors_data\": [],\n \"vulnerability_data\": [],\n \"incidents\": [],\n \"threatactors\": [],\n \"vulnerability\": [],\n \"is_bookmarked\": false,\n \"malwares\": [],\n \"malwares_data\": [],\n \"actions_data\": [],\n \"pirs_data\": [],\n \"enhancements_data\": [],\n \"attachments_data\": [],\n \"title_display\": \"Dept Wide Campaign: Analytics\",\n \"labels\": [],\n \"labels_data\": [],\n \"campaign_cost\": 0,\n \"custom_campaign_field_data\": {\n \"unique_id\": \"ea699934-1fe9-40bd-8644-a5669abdff5e\",\n \"option_name\": \"Critical\",\n \"is_active\": true,\n \"order\": 10,\n \"option_field\": \"c3b2bc9c-7019-4569-b281-3f5ed88ea592\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n}"}],"_postman_id":"5d1e9043-fff7-4565-9bbc-e588a2bc1969"},{"name":"Create Campaign Using Field UUID","id":"8db14193-b872-461a-b219-cd4afa249d4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Test Campaign\",\n \"description\": \"

Test Campaign

\"\n}"},"url":"{{base_url}}v1/campaign/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Create a campaign in your CFTR application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/campaign/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
title	String	Mandatory	Enter a title for the campaign.
description	Text	Optional	Enter a description that best describes the campaign.
labels	List of Strings	Optional	Unique ID of the labels to be associated with the campaign in UUID-4 format.

Request Parameters | Custom Form Fields

In addition to the above-mentioned parameters, the request parameters might vary as per the form configuration defined by your CFTR admin for campaigns. For such parameters, use the field_readable_key of each parameter. To retrieve the field_readable_key and additional metadata of a parameter, use the Form Tab Structure API for campaigns.

Example

The following endpoint retrieves the field_readable_key for all custom fields in the campaign component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=campaign\n\n

Following are some of the sample custom fields for campaigns:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
custom_campaign_field	String	Optional
campaign_learning	String	Optional
recovery_details	String	Optional

Response Parameters

Response Parameters | Regulatory Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
unique_id	String	Unique ID of the campaign in UUID-4 format.
readable_id	String	Unique readable ID of the campaign. It starts with `CMP` followed by a unique number. Example: CMP101
created	String	Campaign creation date and time.
description	Text	Description of the campaign.
modified	String	Last updated date and time of the campaign.
title	String	Title of the campaign.
title_display	String	Title of the campaign.
status	String	Current status of the campaign. Allowed values: `ACTIVE` `INACTIVE`
is_bookmarked	Boolean	Shows if the campaign is bookmarked or not.
created_by_data	Object	Details of the user who created the campaign. Details include: `username`, `email` ,`first_name`, `last_name`, and so on.
labels	List of Strings	Unique ID of the labels associated with the campaign in UUID-4 format.
labels_data	List of Objects	Details of labels added to the campaign. Details include: `title`, `unique_id`, `color_code`, and so on.

Response Parameters | Connect The Dots

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`incidents`	Array UID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`malwares`	Array UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.

Response Parameters | Actions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
actions_data	Array of Objects	Details of the actions that are added to the campaign.

Response Parameters | PIRs

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
pirs_data	Array of Objects	Details of the PIRs that are added to the campaign.

Response Parameters | Enhancements

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
enhancements_data	Array of Objects	Details of the enhancements that are added to the campaign.

Response Parameters | Custom Fields

As CFTR form structure is dynamic and configurable, the response parameters might vary. The following table describes some examples of the custom fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type
custom_campaign_field	String
campaign_learning	String
recovery_details	String

Response Parameters | System Form Fields

Few of the fields or parameters have the values in UUID-4 format. These fields do not intake Option Name in the request as they are used internally for various additional responsibilities around Analytics, Relationships, and Filtering. These fields also include the parameters under Connect the Dots and Labels.

These fields include:

All Connect the Dots params: You can retrieve the corresponding UUID-4 from the details page browser URL of the instance.
\n
Labels: You can retrieve the corresponding UUID-4 from Admin > Settings > Labels section.
\n

\n","urlObject":{"path":["campaign",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"c02f385b-6988-4b61-aeb6-9b437aff3f21","name":"Eg: Create Campaign with ACTIVE Status","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Test Campaign\",\n \"description\": \"

Test Campaign

\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/campaign/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["campaign",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 28 Jun 2022 04:32:08 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"968","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"custom_campaign_field\": null,\n \"unique_id\": \"eddc220b-8b51-4ddd-b225-a2a4e1dd9d3f\",\n \"readable_id\": \"CMP104\",\n \"title\": \"Test Campaign\",\n \"description\": \"

Test Campaign

\",\n \"status\": \"ACTIVE\",\n \"last_activity_time\": 1656390727,\n \"created\": \"2022-06-28T04:32:07.026232Z\",\n \"modified\": \"2022-06-28T04:32:07.096734Z\",\n \"created_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"briefings\": [],\n \"briefings_data\": [],\n \"incidents_data\": [],\n \"threatactors_data\": [],\n \"vulnerability_data\": [],\n \"incidents\": [],\n \"threatactors\": [],\n \"vulnerability\": [],\n \"is_bookmarked\": false,\n \"malwares\": [],\n \"malwares_data\": [],\n \"actions_data\": [],\n \"pirs_data\": [],\n \"enhancements_data\": [],\n \"attachments_data\": [],\n \"title_display\": \"Test Campaign\",\n \"labels\": [],\n \"labels_data\": [],\n \"campaign_cost\": 0,\n \"custom_campaign_field_data\": null\n}"}],"_postman_id":"8db14193-b872-461a-b219-cd4afa249d4f"},{"name":"Create Campaign Using Field Values","id":"96146500-a740-4722-a3cc-28ec91342d47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Test Campaign\",\n \"description\": \"

Test Campaign

\",\n \"labels\": [\"Blue Label Campaign\"]\n}"},"url":"{{base_url}}v1/campaign/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","description":"

Create a campaign in your CFTR application using the values of labels.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/campaign/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
title	String	Mandatory	Enter a title for the campaign.
description	Text	Optional	Enter a description that best describes the campaign.
labels	List	Optional	Enter the list of names of the labels to be attached to the campaign. You can use the following API endpoint to retrieve the list of Labels: `/openapi/v1/utils/label/`

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the campaign component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=campaign\n\n

Following are some of the sample custom fields for campaigns:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
custom_campaign_field	String	Optional
campaign_learning	String	Optional
recovery_details	String	Optional

Response Parameters

Response Parameters | Regulatory Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
unique_id	String	Unique ID of the campaign in UUID-4 format.
readable_id	String	Unique readable ID of the campaign. It starts with `CMP` followed by a unique number. Example: CMP101
created	String	Campaign creation date and time.
description	Text	Description of the campaign.
modified	String	Last updated date and time of the campaign.
title	String	Title of the campaign.
title_display	String	Title of the campaign.
status	String	Current status of the campaign. Allowed values: `ACTIVE` `INACTIVE`
is_bookmarked	Boolean	Shows if the campaign is bookmarked or not.
created_by_data	Object	Details of the user who created the campaign. Details include: `username`, `email` ,`first_name`, `last_name`, and so on.
labels	List of Strings	Unique ID of the labels associated with the campaign in UUID-4 format.
labels_data	List of Objects	Details of labels added to the campaign. Details include: `title`, `unique_id`, `color_code`, and so on.

Response Parameters | Connect The Dots

Following are the response parameters corresponding to the Connect The Dots section of the campaign. The parameters ending with _data contain the meta information for each connected component. The non `_data` parameters just include an array of unique_id referencing to connected components.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`incidents`	Array UID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`malwares`	Array UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.

Response Parameters | Actions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
actions_data	Array of Objects	Details of the actions that are added to the campaign.

Response Parameters | PIRs

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
pirs_data	Array of Objects	Details of the PIRs that are added to the campaign.

Response Parameters | Enhancements

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
enhancements_data	Array of Objects	Details of the enhancements that are added to the campaign.

Response Parameters | Custom Fields

As CFTR form structure is dynamic and configurable, the response parameters might vary. The following table describes some examples of the custom fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type
custom_campaign_field	String
campaign_learning	String
recovery_details	String

Response Parameters | System Form Fields

These fields include:

All Connect the Dots params: You can retrieve the corresponding UUID-4 from the details page browser URL of the instance.
\n
Labels: You can retrieve the corresponding UUID-4 from Admin > Settings > Labels section.
\n

Do not change the parameter value\nAllows you to create campaigns using the values of labels.

\n","type":"text/plain"},"key":"values","value":"readable_type"}],"variable":[]}},"response":[{"id":"e57eedad-cb18-4352-9cd3-aa7b7febd113","name":"201 Created: Create Campaign Using Field Values","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Test Campaign\",\n \"description\": \"

Test Campaign

\",\n \"labels\": [\"Blue Label Campaign\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/campaign/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","host":["{{base_url}}v1"],"path":["campaign",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"values","value":"readable_type","description":"**Do not change the parameter value**\nAllows you to create campaigns using the values of labels."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Apr 2023 10:41:05 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1129","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"unique_id\": \"b5844bf2-bb53-464f-9d95-be561d59cf29\",\n \"readable_id\": \"CMP103\",\n \"title\": \"Test Campaign\",\n \"description\": \"

Test Campaign

\",\n \"status\": \"ACTIVE\",\n \"last_activity_time\": 1682073664,\n \"created\": \"2023-04-21T10:41:04.067806Z\",\n \"modified\": \"2023-04-21T10:41:04.150634Z\",\n \"created_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"peter.smith@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"briefings\": [],\n \"briefings_data\": [],\n \"incidents_data\": [],\n \"threatactors_data\": [],\n \"vulnerability_data\": [],\n \"incidents\": [],\n \"threatactors\": [],\n \"vulnerability\": [],\n \"is_bookmarked\": false,\n \"malwares\": [],\n \"malwares_data\": [],\n \"actions_data\": [],\n \"pirs_data\": [],\n \"enhancements_data\": [],\n \"attachments_data\": [],\n \"title_display\": \"Test Campaign\",\n \"labels\": [\n \"4d6a5111-b67a-4f49-8b0e-19fc5e618a1d\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"4d6a5111-b67a-4f49-8b0e-19fc5e618a1d\",\n \"title\": \"Blue Label Campaign\",\n \"color_code\": \"#BF360C\",\n \"created\": \"2023-04-21T10:37:59.388364Z\",\n \"modified\": \"2023-04-21T10:37:59.388364Z\"\n }\n ],\n \"campaign_cost\": 0\n}"}],"_postman_id":"96146500-a740-4722-a3cc-28ec91342d47"},{"name":"Update Campaign Using Field UUID","id":"5416b012-0154-40c8-bc2e-d3adbbc9c79a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Test Updated Campaign Again\",\n \"labels\": [\"1717be4c-363d-459b-9065-647e0d30f227\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/campaign/:campaign_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Update the details of a campaign.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/campaign/:campaign_unique_id/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
title	String	Optional	Title of the campaign.
description	Text	Optional	Description of the campaign.
labels	List of Strings	Optional	Unique ID of the labels associated with the campaign in UUID-4 format.

Request Parameters | Connect The Dots

Provide the following parameters to update the Connect The Dots section of the campaign.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.

Response Parameters | Custom Fields

In addition to the above mentioned parameters, the request parameters may vary as per the form configuration defined by your CFTR admin for campaigns. For such parameters, use the field_readable_key of each parameter. To retrieve the field_readable_key and additional metadata of a parameter, use the Form Tab Structure API for campaigns.

Example

The following endpoint retrieves the field_readable_key for all custom fields in the campaign component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=campaign\n\n

Following are some of the sample custom fields for campaigns:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
custom_campaign_field	String	Optional
campaign_learning	String	Optional
recovery_details	String	Optional

Response Parameters

Response Parameters | Regulatory Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
unique_id	String	Unique ID of the campaign in UUID-4 format.
readable_id	String	Unique readable ID of the campaign. It starts with `CMP` followed by a unique number. Example: CMP101
created	String	Campaign creation date and time.
description	Text	Description of the campaign.
modified	String	Last updated date and time of the campaign.
title	String	Title of the campaign.
title_display	String	Title of the campaign.
status	String	Current status of the campaign. Allowed values: `ACTIVE` `INACTIVE`
is_bookmarked	Boolean	Shows if the campaign is bookmarked or not.
created_by_data	Object	Details of user who created the campaign. Details include: `username`, `email` ,`first_name`, `last_name`, and so on.
labels	List of Strings	Unique ID of the labels associated with the campaign in UUID-4 format.
labels_data	List of Objects	Details of labels added to the campaign. Details include: `title`, `unique_id`, `color_code`, and so on.

Response Parameters | Connect The Dots

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`incidents`	Array UID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`malwares`	Array UUID Strings	List of `unique_id` of the connected malwares.
`malwares_data`	Array of Objects	Details of the connected malwares.
`threat_actors`	Array UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.

Response Parameters | Actions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
actions_data	Array of Objects	Details of the actions that are added to the campaign.

Response Parameters | PIRs

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
pirs_data	Array of Objects	Details of the pirs that are added to the campaign.

Response Parameters | Enhancements

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
enhancements_data	Array of Objects	Details of the enhancements that are added to the campaign.

Response Parameters | Custom Fields

As CFTR form structure is dynamic/configurable by nature, the response parameters may vary. The following table describes some examples of the custom fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type
custom_campaign_field	String
campaign_learning	String
recovery_details	String

","urlObject":{"path":["campaign",":campaign_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the campaign in UUID format.

\n","type":"text/plain"},"type":"any","value":"eddc220b-8b51-4ddd-b225-a2a4e1dd9d3f","key":"campaign_unique_id"}]}},"response":[{"id":"5ce9d042-9642-4b3a-a3dc-ddd0536cf6d1","name":"Eg: Update Campaign Description and Label","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Test Updated Campaign\",\n \"labels\": [\"1717be4c-363d-459b-9065-647e0d30f227\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/campaign/:campaign_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["campaign",":campaign_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"campaign_unique_id","value":"eddc220b-8b51-4ddd-b225-a2a4e1dd9d3f","description":"Enter the unique ID of the campaign in UUID format."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 28 Jun 2022 04:39:18 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1203","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"custom_campaign_field\": null,\n \"unique_id\": \"eddc220b-8b51-4ddd-b225-a2a4e1dd9d3f\",\n \"readable_id\": \"CMP104\",\n \"title\": \"Test Updated Campaign\",\n \"description\": \"

Test Campaign

\",\n \"status\": \"ACTIVE\",\n \"last_activity_time\": 1656391155,\n \"created\": \"2022-06-28T04:32:07.026232Z\",\n \"modified\": \"2022-06-28T04:39:15.849233Z\",\n \"created_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"briefings\": [],\n \"briefings_data\": [],\n \"incidents_data\": [],\n \"threatactors_data\": [],\n \"vulnerability_data\": [],\n \"incidents\": [],\n \"threatactors\": [],\n \"vulnerability\": [],\n \"is_bookmarked\": false,\n \"malwares\": [],\n \"malwares_data\": [],\n \"actions_data\": [],\n \"pirs_data\": [],\n \"enhancements_data\": [],\n \"attachments_data\": [],\n \"title_display\": \"Test Updated Campaign\",\n \"labels\": [\n \"1717be4c-363d-459b-9065-647e0d30f227\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"1717be4c-363d-459b-9065-647e0d30f227\",\n \"title\": \"Campaign Label\",\n \"color_code\": \"#00897B\",\n \"created\": \"2022-06-28T04:36:11.824574Z\",\n \"modified\": \"2022-06-28T04:38:59.945289Z\"\n }\n ],\n \"campaign_cost\": 0,\n \"custom_campaign_field_data\": null\n}"}],"_postman_id":"5416b012-0154-40c8-bc2e-d3adbbc9c79a"},{"name":"Update Campaign Using Field Value","id":"e19dfd58-60fd-4e5b-8785-c5816a855165","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"labels\": [\"Red Label Campaign\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/campaign/:campaign_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","description":"

Update the details of a campaign using the values of labels.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/campaign/:campaign_unique_id/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
title	String	Optional	Title of the campaign.
description	Text	Optional	Description of the campaign.
labels	List	Optional	Enter the list of names of the labels to be attached to the campaign. You can use the following API endpoint to retrieve the list of Labels: `/openapi/v1/utils/label/`

Request Parameters | Connect The Dots

Provide the following parameters to update the Connect The Dots section of the campaign.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.

Response Parameters | Custom Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the campaign component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=campaign\n\n

Following are some of the sample custom fields for campaigns:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
custom_campaign_field	String	Optional
campaign_learning	String	Optional
recovery_details	String	Optional

Response Parameters

Response Parameters | Regulatory Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
unique_id	String	Unique ID of the campaign in UUID-4 format.
readable_id	String	Unique readable ID of the campaign. It starts with `CMP` followed by a unique number. Example: CMP101
created	String	Campaign creation date and time.
description	Text	Description of the campaign.
modified	String	Last updated date and time of the campaign.
title	String	Title of the campaign.
title_display	String	Title of the campaign.
status	String	Current status of the campaign. Allowed values: `ACTIVE` `INACTIVE`
is_bookmarked	Boolean	Shows if the campaign is bookmarked or not.
created_by_data	Object	Details of user who created the campaign. Details include: `username`, `email` ,`first_name`, `last_name`, and so on.
labels	List of Strings	Unique ID of the labels associated with the campaign in UUID-4 format.
labels_data	List of Objects	Details of labels added to the campaign. Details include: `title`, `unique_id`, `color_code`, and so on.

Response Parameters | Connect The Dots

Following are the response parameters corresponding the Connect The Dots section of the incident. The parameters ending with data contain the meta information for each connected component. The non `data` parameters just include an array of unique_id referencing to connected components.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`incidents`	Array UID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`malwares`	Array UUID Strings	List of `unique_id` of the connected malwares.
`malwares_data`	Array of Objects	Details of the connected malwares.
`threat_actors`	Array UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.

Response Parameters | Actions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
actions_data	Array of Objects	Details of the actions that are added to the campaign.

Response Parameters | PIRs

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
pirs_data	Array of Objects	Details of the pirs that are added to the campaign.

Response Parameters | Enhancements

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
enhancements_data	Array of Objects	Details of the enhancements that are added to the campaign.

Response Parameters | Custom Fields

As CFTR form structure is dynamic/configurable by nature, the response parameters may vary. The following table describes some examples of the custom fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type
custom_campaign_field	String
campaign_learning	String
recovery_details	String

Do not change the parameter value\nAllows you to update campaigns using the values of labels.

\n","type":"text/plain"},"key":"values","value":"readable_type"}],"variable":[{"description":{"content":"

Enter the unique ID of the campaign in UUID format.

\n","type":"text/plain"},"type":"any","value":"b5844bf2-bb53-464f-9d95-be561d59cf29","key":"campaign_unique_id"}]}},"response":[{"id":"f8cfaa97-76c1-48e0-b66a-29b4e840c2f0","name":"200 OK: Update Campaign Using Field Value","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"labels\": [\"Red Label Campaign\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/campaign/:campaign_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","host":["{{base_url}}v1"],"path":["campaign",":campaign_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"values","value":"readable_type","description":"**Do not change the parameter value**\nAllows you to update campaigns using the values of labels."}],"variable":[{"key":"campaign_unique_id","value":"b5844bf2-bb53-464f-9d95-be561d59cf29","description":"Enter the unique ID of the campaign in UUID format."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Apr 2023 10:51:14 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"unique_id\": \"b5844bf2-bb53-464f-9d95-be561d59cf29\",\n \"readable_id\": \"CMP103\",\n \"title\": \"Test Campaign\",\n \"description\": \"

Test Campaign

\",\n \"status\": \"ACTIVE\",\n \"last_activity_time\": 1682074273,\n \"created\": \"2023-04-21T10:41:04.067806Z\",\n \"modified\": \"2023-04-21T10:51:13.190296Z\",\n \"created_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"peter.smith@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"briefings\": [],\n \"briefings_data\": [],\n \"incidents_data\": [],\n \"threatactors_data\": [],\n \"vulnerability_data\": [],\n \"incidents\": [],\n \"threatactors\": [],\n \"vulnerability\": [],\n \"is_bookmarked\": false,\n \"malwares\": [],\n \"malwares_data\": [],\n \"actions_data\": [],\n \"pirs_data\": [],\n \"enhancements_data\": [],\n \"attachments_data\": [],\n \"title_display\": \"Test Campaign\",\n \"labels\": [\n \"b48a1d9a-dda5-4d8c-ae73-cba134cab4f0\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"b48a1d9a-dda5-4d8c-ae73-cba134cab4f0\",\n \"title\": \"Red Label Campaign\",\n \"color_code\": \"#D50000\",\n \"created\": \"2023-04-21T10:38:18.361212Z\",\n \"modified\": \"2023-04-21T10:38:18.361212Z\"\n }\n ],\n \"campaign_cost\": 0\n}"}],"_postman_id":"e19dfd58-60fd-4e5b-8785-c5816a855165"},{"name":"Inactivate Campaign","id":"e9908f0e-0210-4bba-9a77-5a1710f73a98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": \"INACTIVE\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/campaign/:campaign_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Inactivate a campaign in your CFTR application.

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
status	String	Mandatory	Enter “INACTIVE”.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
modified	Datetime	Enhancement deactivation time.
modified_by_data	Object	Details of the user who inactivated the enhancement. Details include: username, email, first name, last name, and so on.

Enter the unique ID of the campaign in UUID format.

\n","type":"text/plain"},"type":"any","value":"eddc220b-8b51-4ddd-b225-a2a4e1dd9d3f","key":"campaign_unique_id"}]}},"response":[{"id":"30a8318e-45e8-4d4e-a28a-b2c43f3130d2","name":"Eg: Make Campaign Inactive","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": \"INACTIVE\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/campaign/:campaign_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["campaign",":campaign_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"campaign_unique_id","value":"eddc220b-8b51-4ddd-b225-a2a4e1dd9d3f","description":"Enter the unique ID of the campaign in UUID format."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 28 Jun 2022 04:43:43 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1205","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"custom_campaign_field\": null,\n \"unique_id\": \"eddc220b-8b51-4ddd-b225-a2a4e1dd9d3f\",\n \"readable_id\": \"CMP104\",\n \"title\": \"Test Updated Campaign\",\n \"description\": \"

Test Campaign

\",\n \"status\": \"INACTIVE\",\n \"last_activity_time\": 1656391421,\n \"created\": \"2022-06-28T04:32:07.026232Z\",\n \"modified\": \"2022-06-28T04:43:41.485511Z\",\n \"created_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"briefings\": [],\n \"briefings_data\": [],\n \"incidents_data\": [],\n \"threatactors_data\": [],\n \"vulnerability_data\": [],\n \"incidents\": [],\n \"threatactors\": [],\n \"vulnerability\": [],\n \"is_bookmarked\": false,\n \"malwares\": [],\n \"malwares_data\": [],\n \"actions_data\": [],\n \"pirs_data\": [],\n \"enhancements_data\": [],\n \"attachments_data\": [],\n \"title_display\": \"Test Updated Campaign\",\n \"labels\": [\n \"1717be4c-363d-459b-9065-647e0d30f227\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"1717be4c-363d-459b-9065-647e0d30f227\",\n \"title\": \"Campaign Label\",\n \"color_code\": \"#00897B\",\n \"created\": \"2022-06-28T04:36:11.824574Z\",\n \"modified\": \"2022-06-28T04:38:59.945289Z\"\n }\n ],\n \"campaign_cost\": 0,\n \"custom_campaign_field_data\": null\n}"}],"_postman_id":"e9908f0e-0210-4bba-9a77-5a1710f73a98"},{"name":"Add Comment to Campaign","id":"a0995645-7bd6-4c0f-ac37-a81816dd55fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"description\": \"

Note For Campaign

\",\n \"mentioned_users_usernames\": []\n}"},"url":"{{base_url}}v1/comments/campaign/:campaign_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Add notes/comments to a campaign in the CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
description	String	Mandatory	Enter the content of the comment.
mentioned_users_usernames	List of UUID	Optional	Enter the list of usernames of users mentioned in the comment.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
unique_id	String	Unique ID of the comment.
description	Text	Content of the comment.
created_by	Object	Details of the user who added the comment.
modified_by	Object	Details of the user who last updated the comment.
mentioned_users	List of UUID	List of `user_id` of users mentioned in the comment.
mentioned_users_data	List of Objects	Details of the users mentioned in the comment.
created	String	Comment creation time.
modified	String	Comment last updated time.
comment_type	String	Type of Comment. Examples: `discussion`: Notes added in any instance.
content_object	String	Component in which the comment is added. Example: `campaign`, `action`, `ioc`, and so on.
content_object_readable_id	String	`readable_id` of the component instance in which the comment is added
content_object_unique_id	String	`unique_id` of the component instance in which the comment is added
description_with_img_src	Text	Content of the content with the image URLs (if any image is added in the comment).
pinned	Boolean	Displays if the comment is pinned or not.

","urlObject":{"path":["comments","campaign",":campaign_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the campaign in UUID format.

\n","type":"text/plain"},"type":"any","value":"eddc220b-8b51-4ddd-b225-a2a4e1dd9d3f","key":"campaign_unique_id"}]}},"response":[{"id":"1280ed30-77b8-4ba6-a3a5-9e2b165c0309","name":"Add Comment to Campaign","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"description\": \"

Note For Campaign

\",\n \"mentioned_users_usernames\": []\n}"},"url":{"raw":"{{base_url}}v1/comments/campaign/:campaign_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["comments","campaign",":campaign_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"campaign_unique_id","value":"1251ae4f-a4c8-489b-9dc6-b32ca0b8efeb","description":"Enter the unique ID of the campaign in UUID format."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 28 Jan 2024 15:46:09 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"922","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Server","value":"gunicorn/19.10.0","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"unique_id\": \"4586662e-a9a0-43ce-b3da-2b624ded2d2f\",\n \"description\": \"

Note For Campaign

\",\n \"created_by\": {\n \"user_id\": \"b3184a17-e59f-46cb-82c3-d8aabbefff7e\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"email\": \"system@default.tld\",\n \"display_pic\": null,\n \"username\": \"system.default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"System Default\"\n },\n \"modified_by\": null,\n \"is_removed\": false,\n \"mentioned_users\": [],\n \"mentioned_users_data\": [],\n \"created\": \"2024-01-28T15:46:09.479117Z\",\n \"modified\": \"2024-01-28T15:46:09.488495Z\",\n \"email\": null,\n \"internal\": false,\n \"comment_type\": \"discussion\",\n \"command_params\": {},\n \"command_result\": {},\n \"command_status\": \"na\",\n \"attachments_data\": [],\n \"content_object\": \"campaign\",\n \"content_object_readable_id\": \"CMP122\",\n \"content_object_unique_id\": \"1251ae4f-a4c8-489b-9dc6-b32ca0b8efeb\",\n \"attachment_label\": null,\n \"description_with_img_src\": \"

Note For Campaign

\",\n \"pinned\": false,\n \"field\": null,\n \"note_tag\": null\n}"}],"_postman_id":"a0995645-7bd6-4c0f-ac37-a81816dd55fc"}],"id":"c5bce42d-0555-4761-9eff-af9f922463a2","description":"

Campaigns are instances of cyber criminals attempting a harmful intent as identified through sets of Incidents, Malware, Vulnerabilities exploited and identified Tactics, Techniques and Procedures (TTPs) of Threat Actors. CFTR allows you to create, manage, and connect cyber threat Campaigns with Incidents, Vulnerabilities, Threat Briefings, Threat Actors, and Malware to gather improved Threat Intelligence using data fusion. CFTR provides a solution that helps the security teams respond effectively to cyber Campaigns targeting your organization.

This section describes how to use the API endpoints to manage the Campaigns.

\n","_postman_id":"c5bce42d-0555-4761-9eff-af9f922463a2"},{"name":"Software","item":[{"name":"List Software","id":"4d1e68e6-8d00-46c2-a5e3-87f1ac562973","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/asset-software/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the details of a list of software assets in the CFTR application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/asset-software/?

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` key shows the API endpoint to the next page.
`count`	Integer	The total number of software returned as per the entered query parameters.
`results`	List of Objects	Details of the softwares. Each object provides the details of one software.

Response Parameters | Results Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the software.
`created`	String	Created date and time of the software.
`modified`	String	Last updated date and time of the software.
`title`	String	Name of the software.
`readable_id`	String	Readable ID of the software.
`labels`	List	List of the labels that are added to the software.
`labels_data`	List of Objects	Details of labels added to the software. The details include: `title`, `unique_id`, `color_code`, and so on.
`software_status`	String	Status of the sofware. For example, active.

[optional] Enter the page number of the software list. This will retrieve the list of all software from the entered page.\nDefault value: 1

\n","type":"text/plain"},"key":"page","value":"2"},{"disabled":true,"description":{"content":"

[optional] Number of software per page.\nDefault value: 10

\n","type":"text/plain"},"key":"page_size","value":"15"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID of the business unit. This parameter retrieves the software associated with the business unit.\nYou can retrieve the list of available Business Units and their Unique IDs using the following API endpoint:\n/openapi/v1/utils/business-unit/

\n","type":"text/plain"},"key":"business_units","value":"9750d6df-2d7f-4899-b20d-bfbba0a9084d"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the software in EPOCH Time format.\nTime Zone must be as per UTC. All softwares with creation date later than the entered time will be returned.

\n","type":"text/plain"},"key":"created_date__gte","value":"1643999399"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the software in EPOCH Time format.\nTime Zone must be as per UTC. All softwares with creation date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"created_date__lte","value":"1643999399"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID of the label. This parameter retrieves the software associated with the label.\nYou can retrieve the list of available Labels and their Unique IDs using the following API endpoint:\n/openapi/v1/utils/label/

\n","type":"text/plain"},"key":"labels","value":"c741bd45-1825-4dba-a30f-66088dcbbf8d"},{"disabled":true,"description":{"content":"

[optional] Enter the last modified time of the software in EPOCH Time format.\nTime Zone must be as per UTC. All softwares with modified date later than the entered time will be returned.

\n","type":"text/plain"},"key":"modified_date__gte","value":"1643999399"},{"disabled":true,"description":{"content":"

[optional] Enter the last modified time of the software in EPOCH Time format.\nTime Zone must be as per UTC. All devices with modified date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"modified_date__lte","value":"1643999399"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID of the location. This parameter retrieves the software associated with the location..\nYou can retrieve the list of available Locations and their Unique IDs using the following API endpoint:\n/openapi/v1/utils/location/

\n","type":"text/plain"},"key":"locations","value":"671961e6-0119-460c-8d55-9b697f6e2d6e"},{"disabled":true,"description":{"content":"

[optional] Enter the status of the software to filter response results. \nAllowed values:\nactive, inactive

\n","type":"text/plain"},"key":"software_status","value":"active"}],"variable":[]}},"response":[{"id":"b1b3b0d2-43ea-49b0-b755-3e36c8f61fe6","name":"Get List of Software","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/asset-software/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["asset-software",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"page","value":"2","description":"[optional] Enter the page number of the user list. This will retrieve the list of all softwares from the entered page.\nDefault value: 1","disabled":true},{"key":"page_size","value":"15","description":"[optional] Number of softwares per page.\nDefault value: 10","disabled":true},{"key":"business_units","value":"9750d6df-2d7f-4899-b20d-bfbba0a9084d","description":"[optional] Enter the unique ID of the business unit. This parameter retrieves the softwares associated with the business unit.\nYou can retrieve the list of available Business Units and their Unique IDs using the following API endpoint:\n/openapi/v1/utils/business-unit/","disabled":true},{"key":"created_date__gte","value":"1643999399","description":"[optional] Enter the creation time of the software in EPOCH Time format.\nTime Zone must be as per UTC. All softwares with creation date later than the entered time will be returned.","disabled":true},{"key":"created_date__lte","value":"1643999399","description":"[optional] Enter the creation time of the software in EPOCH Time format.\nTime Zone must be as per UTC. All softwares with creation date later than the entered time will be returned.","disabled":true},{"key":"labels","value":"c741bd45-1825-4dba-a30f-66088dcbbf8d","description":"[optional] Enter the unique ID of the label. This parameter retrieves the softwares associated with the label.\nYou can retrieve the list of available Labels and their Unique IDs using the following API endpoint:\n/openapi/v1/utils/label/","disabled":true},{"key":"modified_date__gte","value":"1643999399","description":"[optional] Enter the last modified time of the software in EPOCH Time format.\nTime Zone must be as per UTC. All softwares with modified date later than the entered time will be returned.","disabled":true},{"key":"modified_date__lte","value":"1643999399","description":"[optional] Enter the last modified time of the software in EPOCH Time format.\nTime Zone must be as per UTC. All devices with modified date earlier than the entered time will be returned.","disabled":true},{"key":"modified_date__lte","value":"1643999399","description":"[optional] Enter the last modified time of the software in EPOCH Time format.\nTime Zone must be as per UTC. All softwares with modified date earlier than the entered time will be returned.","disabled":true},{"key":"locations","value":"671961e6-0119-460c-8d55-9b697f6e2d6e","description":"[optional] Enter the unique ID of the location. This parameter retrieves the softwares associated with the location..\nYou can retrieve the list of available Locations and their Unique IDs using the following API endpoint:\n/openapi/v1/utils/location/","disabled":true},{"key":"software_status","value":"active","description":"[optional] Enter the status of the software to filter response results. \nAllowed values:\nactive, inactive","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jun 2022 18:21:35 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"4328","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {\n \"next\": \"openapi/v1/asset-software/?page=2&page_size=10&AccessID=8b5e5c6e-f9db-4a94-80cd-5faf77b06429&Expires=1656354110&Signature=kDQFhUSGr8iPv1av9uf3frM9I+o=\"\n },\n \"count\": 18026,\n \"results\": [\n {\n \"unique_id\": \"fb487600-8a14-43df-8e96-5f759aa61cf0\",\n \"created\": \"2022-06-22T08:34:37.006940Z\",\n \"modified\": \"2022-06-22T08:34:47.888998Z\",\n \"title\": \"Activity log export test\",\n \"readable_id\": \"SFT18126\",\n \"labels\": [],\n \"labels_data\": [],\n \"software_status\": \"active\"\n },\n {\n \"unique_id\": \"8c670c6d-7cd6-4252-86ec-d40d1dc936cc\",\n \"created\": \"2020-10-16T11:13:41.709097Z\",\n \"modified\": \"2022-06-20T11:38:13.697334Z\",\n \"title\": \"New Software on 16/10/2020:16:43\",\n \"readable_id\": \"SFT18029\",\n \"labels\": [\n \"00277fc5-efb9-4929-94b6-e5b9dbee59e0\",\n \"4fa2cb65-1071-4f5e-a8ee-ee467c98a52b\",\n \"9c04a82a-9296-484e-9770-832480dd02ab\",\n \"de5af83f-8afe-411e-9981-f41aff4ce9b5\",\n \"5f5bf123-be20-4c8b-beac-37772caf1a6d\",\n \"1aa72234-ed7d-4bc6-b325-013adcf73dc4\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"00277fc5-efb9-4929-94b6-e5b9dbee59e0\",\n \"title\": \"Sft 3\",\n \"color_code\": \"#3E2723\",\n \"created\": \"2021-01-27T09:36:07.283958Z\",\n \"modified\": \"2021-01-27T09:36:07.283958Z\"\n },\n {\n \"unique_id\": \"4fa2cb65-1071-4f5e-a8ee-ee467c98a52b\",\n \"title\": \"fd\",\n \"color_code\": \"#311B92\",\n \"created\": \"2021-01-27T09:36:42.943902Z\",\n \"modified\": \"2021-01-27T09:36:42.943902Z\"\n },\n {\n \"unique_id\": \"9c04a82a-9296-484e-9770-832480dd02ab\",\n \"title\": \"Software Label\",\n \"color_code\": \"#FA8469\",\n \"created\": \"2019-12-24T09:10:03.452165Z\",\n \"modified\": \"2019-12-24T09:10:03.452691Z\"\n },\n {\n \"unique_id\": \"de5af83f-8afe-411e-9981-f41aff4ce9b5\",\n \"title\": \"huhj\",\n \"color_code\": \"#5E35B1\",\n \"created\": \"2021-01-27T09:36:09.238368Z\",\n \"modified\": \"2021-01-27T09:36:09.238368Z\"\n },\n {\n \"unique_id\": \"5f5bf123-be20-4c8b-beac-37772caf1a6d\",\n \"title\": \"dsf\",\n \"color_code\": \"#673AB7\",\n \"created\": \"2021-01-27T09:36:53.947109Z\",\n \"modified\": \"2021-01-27T09:36:53.947109Z\"\n },\n {\n \"unique_id\": \"1aa72234-ed7d-4bc6-b325-013adcf73dc4\",\n \"title\": \"SFT LBL\",\n \"color_code\": \"#A0120A\",\n \"created\": \"2019-09-17T08:17:57.773656Z\",\n \"modified\": \"2019-09-17T08:17:57.774135Z\"\n }\n ],\n \"software_status\": \"active\"\n },\n {\n \"unique_id\": \"f90364ba-c9d3-4d0a-8e2d-44f0e65543b9\",\n \"created\": \"2020-01-25T12:49:50.500881Z\",\n \"modified\": \"2022-06-15T13:26:59.748657Z\",\n \"title\": \"kjsndcjd\",\n \"readable_id\": \"SFT17970\",\n \"labels\": [],\n \"labels_data\": [],\n \"software_status\": \"active\"\n },\n {\n \"unique_id\": \"e0fdb8ea-9222-40e9-b1b3-cb8cbdfe97f7\",\n \"created\": \"2021-09-22T07:23:46.858365Z\",\n \"modified\": \"2022-05-16T06:15:04.436467Z\",\n \"title\": \"Regression Template 7\",\n \"readable_id\": \"SFT18123\",\n \"labels\": [\n \"f85da0e8-c50a-4d74-9f6f-a24939d9947a\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"f85da0e8-c50a-4d74-9f6f-a24939d9947a\",\n \"title\": \"abc1\",\n \"color_code\": \"#BF360C\",\n \"created\": \"2021-01-27T09:36:31.165304Z\",\n \"modified\": \"2021-01-27T09:36:31.165304Z\"\n }\n ],\n \"software_status\": \"active\"\n },\n {\n \"unique_id\": \"1fdc6475-95aa-4cbd-aced-ab040ff11741\",\n \"created\": \"2022-04-18T05:12:29.773709Z\",\n \"modified\": \"2022-04-18T05:17:02.308369Z\",\n \"title\": \"test3\",\n \"readable_id\": \"SFT18125\",\n \"labels\": [\n \"f85da0e8-c50a-4d74-9f6f-a24939d9947a\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"f85da0e8-c50a-4d74-9f6f-a24939d9947a\",\n \"title\": \"abc1\",\n \"color_code\": \"#BF360C\",\n \"created\": \"2021-01-27T09:36:31.165304Z\",\n \"modified\": \"2021-01-27T09:36:31.165304Z\"\n }\n ],\n \"software_status\": \"active\"\n },\n {\n \"unique_id\": \"ab1bb145-dc49-402c-b14e-e3960d603196\",\n \"created\": \"2022-01-24T11:49:55.708385Z\",\n \"modified\": \"2022-02-08T11:26:43.847736Z\",\n \"title\": \"Macos\",\n \"readable_id\": \"SFT18124\",\n \"labels\": [],\n \"labels_data\": [],\n \"software_status\": \"active\"\n },\n {\n \"unique_id\": \"72116102-4f6e-4c3a-a2a8-6f8bab9fde6b\",\n \"created\": \"2021-09-22T07:23:46.475581Z\",\n \"modified\": \"2021-09-22T07:23:46.475581Z\",\n \"title\": \"Regression Template 6\",\n \"readable_id\": \"SFT18122\",\n \"labels\": [],\n \"labels_data\": [],\n \"software_status\": \"active\"\n },\n {\n \"unique_id\": \"1c03c9e4-8efa-495e-bc53-0c136a2af6bc\",\n \"created\": \"2021-09-22T07:23:46.073047Z\",\n \"modified\": \"2021-09-22T07:23:46.073047Z\",\n \"title\": \"Regression Template 5\",\n \"readable_id\": \"SFT18121\",\n \"labels\": [],\n \"labels_data\": [],\n \"software_status\": \"active\"\n },\n {\n \"unique_id\": \"f144d1b1-8585-44cc-a90a-945e62f90a3a\",\n \"created\": \"2021-09-22T07:23:45.686277Z\",\n \"modified\": \"2021-09-22T07:23:45.686277Z\",\n \"title\": \"Regression Template 4\",\n \"readable_id\": \"SFT18120\",\n \"labels\": [],\n \"labels_data\": [],\n \"software_status\": \"active\"\n },\n {\n \"unique_id\": \"d8e97f45-dd4e-4f38-80df-1ea39ebc74c0\",\n \"created\": \"2021-09-22T07:23:45.311956Z\",\n \"modified\": \"2021-09-22T07:23:45.311956Z\",\n \"title\": \"Regression Template 3\",\n \"readable_id\": \"SFT18119\",\n \"labels\": [],\n \"labels_data\": [],\n \"software_status\": \"active\"\n }\n ]\n}"}],"_postman_id":"4d1e68e6-8d00-46c2-a5e3-87f1ac562973"},{"name":"Get Software Details","id":"195f1485-2f0f-4565-8ed6-18de3cf7ab1f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/asset-software/:software_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the details of a sofware in the CFTR application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/asset-software/:software_unique_id/?

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

Response Parameters | Regulatory Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the software.
`created`	String	Software creation date and time.
`modified`	String	Software last updated date and time.
`title`	String	Name of the software.
`software_id`	String	ID of the software.
`software_type`	List	Type of the software. For example, Development Software.
`title_display`	String	Name of software.
`readable_id`	String	Readable ID of software. For example, SFT115.
`software_status`	String	Current status of the software.
`purchase_date`	String	Purchase date of the software.
`created_by`	String	`user_id` of the user who created the software.
`created_by_data`	Object	Details of user who added the software.
`labels`	List	List of `unique_id` labels that are added to the software.
`labels_data`	List of Objects	Details of the labels that are added to the software.
`business_units_data`	List of Objects	Details of business units that are impacted by the software
`locations_data`	List of Objects	Details of locations that are impacted by the software.
`software_type_data`	Object	Details of the software type.

Response Parameters | Connect The Dots

Following are the response parameters corresponding to the Connect The Dots section of the software. The parameters ending with _data include the meta information for each connected component. The non _data parameters include an array of unique IDs referencing to the connected components.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities .
`malwares`	Array of UUID Strings	List of `unique_id` of the connected connected malwares.
`malwares_data`	Array of Objects	Details of the connected malwares .
`endpoints`	Array of UUID Strings	List of `unique_id` of the connected connected devices.
`endpoint_data`	Array of Objects	Details of the connected devices.

Response Parameters | Custom Fields

In addition to the above-mentioned parameters, the response parameters might vary as per the form configuration defined by your CFTR admin for sofware. For such parameters, the field_readable_key of each parameter is returned in the response. To retrieve the field_readable_key and additional metadata of a parameter, use the Form Tab Structure API for software.

Example

The following endpoint retrieves the field_readable_key for all custom fields in the software component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=asset-software\n\n

Following are some of the sample custom fields for users:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`purpose`	String	Optional

","urlObject":{"path":["asset-software",":software_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the software.

\n","type":"text/plain"},"type":"any","value":"8c670c6d-7cd6-4252-86ec-d40d1dc936cc","key":"software_unique_id"}]}},"response":[{"id":"6f85d44c-2665-4521-ac9d-ec7c0c3b0012","name":"Get Details of Software","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/asset-software/:software_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["asset-software",":software_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"software_unique_id","value":"8c670c6d-7cd6-4252-86ec-d40d1dc936cc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jun 2022 20:00:10 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"32190","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"software_version\": null,\n \"purpose\": null,\n \"number_of_assets\": null,\n \"approved_software\": null,\n \"software_type\": [\n \"Development Software\"\n ],\n \"operating_system\": [],\n \"unique_id\": \"b251f6a2-a5b8-41d6-aaf6-8f59ad72d6e3\",\n \"created\": \"2024-01-27T22:20:59.246836Z\",\n \"modified\": \"2024-01-27T22:23:34.391640Z\",\n \"title\": \"CFTR-soft2024-01-27 22:20:37.819896\",\n \"purchase_date\": null,\n \"expiry_date\": \"2020-10-30T18:30:00Z\",\n \"incidents\": [\n \"25e54f12-ad58-4fcd-96cf-cffb31ecec04\",\n \"94a5b24a-59fb-4709-b336-f78099540506\",\n \"1262dc50-e716-4b00-8fb9-427738c19695\",\n \"f979af7d-9a1d-4835-ad0f-54a32df3bc59\",\n \"f1b56356-3350-4361-ac05-adcb8b479ae0\",\n \"0c1208c5-0fe5-4a40-b62b-83411a84aa5e\",\n \"d31db85e-1e12-4ba8-8d49-abf2fd341a52\",\n \"df0ce907-baca-4d21-96ae-15e63f527191\",\n \"8ef0ad66-99ab-43aa-93ed-da640a387f69\",\n \"871f41aa-2bff-4900-95e3-527dcd707d5f\",\n \"8c42fd2d-166f-44e2-9ffa-1a59e3276c45\",\n \"32f54802-7582-4ec3-a7c0-046c5f05bbbe\",\n \"fb5e55ae-0c66-4c38-8464-49a87d24fa12\",\n \"741377af-b1ab-491a-9bac-c9a2b65a576a\",\n \"66df34a9-123f-4649-b3e8-39aefe351b74\",\n \"b6838487-5093-4d58-bfcd-67d950c7fe28\",\n \"554b5cd7-d410-4db4-b501-fd7e71713050\",\n \"063260f5-dffb-4e77-bc8c-3a74d0ea7b39\",\n \"c92c5894-908f-42d3-9be3-956c1d24f3fd\",\n \"b79a3870-7edd-4cf3-b71a-8768a26b46f7\",\n \"7e81521b-4ce5-4ea1-aa77-754692e9d6e1\",\n \"ee9b1b64-5ad6-406c-b46a-25cdb88dc6b3\",\n \"f2c276d3-6c07-4262-94e9-293dbebe9e6f\",\n \"a5af3372-078a-4ce8-b1d3-f23808df8874\",\n \"7b19bb9c-d500-43fc-bdcd-0abc7e47c0af\",\n \"67275bf7-9f54-451f-adcf-0dc278752249\",\n \"778f032d-f2c9-4f15-aeea-580f0d4f5863\",\n \"93c1c783-d0dd-481c-ad11-58a671b35823\",\n \"376017b8-35f6-40af-b43d-7d50fcb0a2d0\",\n \"d6fd90fd-aeb9-496b-a703-0de272dc32f6\",\n \"a1c4d1b0-1eb7-4a87-b635-51aa416b5fac\",\n \"e1fcdaae-5931-4539-8988-5101126dcec4\",\n \"4bdba0b6-9310-415e-b701-1c9964fd786d\",\n \"7be4ceb1-d309-4709-80eb-8556c41f4c75\",\n \"b46ec5b6-c39f-4138-8d7b-bc17553cdcfa\",\n \"ba3eb6b1-eb99-4935-8e51-3188aff9e2dd\",\n \"7ef7a778-e848-4708-8aac-acc024b8143a\",\n \"b7cfe78e-1cd5-4c58-9a38-463af81c4556\",\n \"5dd92250-ccc4-4c79-b5f5-93f116f96b32\",\n \"fdc76a50-1ccf-4f39-b484-564447b0650b\",\n \"44a2968a-4cf3-4cb8-a8d5-a860e204ea08\"\n ],\n \"incidents_data\": [\n {\n \"unique_id\": \"8ef0ad66-99ab-43aa-93ed-da640a387f69\",\n \"readable_id\": \"MOD105204\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"Tap so\",\n \"status\": \"open\",\n \"created\": \"2021-08-10T06:01:14.782189Z\",\n \"modified\": \"2022-06-22T06:14:32.294924Z\",\n \"title_display\": \"Tap so\",\n \"severity_title\": \"Medium\"\n },\n {\n \"unique_id\": \"66df34a9-123f-4649-b3e8-39aefe351b74\",\n \"readable_id\": \"MOD106388\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 12/10/2021: 10:43\",\n \"status\": \"open\",\n \"created\": \"2021-10-12T05:15:20.122254Z\",\n \"modified\": \"2021-12-20T10:52:06.916573Z\",\n \"title_display\": \"New Incident on 12/10/2021: 10:43\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"0c1208c5-0fe5-4a40-b62b-83411a84aa5e\",\n \"readable_id\": \"MOD166339\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"Network Diagram Fixes Check\",\n \"status\": \"open\",\n \"created\": \"2021-12-06T10:38:47.178367Z\",\n \"modified\": \"2021-12-06T15:31:32.955937Z\",\n \"title_display\": \"Network Diagram Fixes Check\",\n \"severity_title\": \"Critical\"\n },\n {\n \"unique_id\": \"554b5cd7-d410-4db4-b501-fd7e71713050\",\n \"readable_id\": \"MOD104022\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 12/03/2021: 10:31\",\n \"status\": \"open\",\n \"created\": \"2021-03-12T05:03:11.848181Z\",\n \"modified\": \"2021-11-25T09:35:51.823017Z\",\n \"title_display\": \"New Incident on 12/03/2021: 10:31\",\n \"severity_title\": \"Critical\"\n },\n {\n \"unique_id\": \"b6838487-5093-4d58-bfcd-67d950c7fe28\",\n \"readable_id\": \"MOD105198\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident On 09/08/2021:13:14\",\n \"status\": \"open\",\n \"created\": \"2021-08-09T07:45:21.666399Z\",\n \"modified\": \"2021-10-29T21:46:41.760747Z\",\n \"title_display\": \"New Incident On 09/08/2021:13:14\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"1262dc50-e716-4b00-8fb9-427738c19695\",\n \"readable_id\": \"MOD106181\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 21/09/2021: 10:34\",\n \"status\": \"merged\",\n \"created\": \"2021-09-21T05:05:05.907653Z\",\n \"modified\": \"2021-09-21T13:42:50.248089Z\",\n \"title_display\": \"New Incident on 21/09/2021: 10:34\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"376017b8-35f6-40af-b43d-7d50fcb0a2d0\",\n \"readable_id\": \"MOD105523\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 07/09/2021: 10:20\",\n \"status\": \"open\",\n \"created\": \"2021-09-07T04:53:07.499965Z\",\n \"modified\": \"2021-09-21T08:40:09.050649Z\",\n \"title_display\": \"New Incident on 07/09/2021: 10:20\",\n \"severity_title\": \"Critical\"\n },\n {\n \"unique_id\": \"7e81521b-4ce5-4ea1-aa77-754692e9d6e1\",\n \"readable_id\": \"MOD106104\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 20/09/2021: 10:30\",\n \"status\": \"open\",\n \"created\": \"2021-09-20T05:00:28.357434Z\",\n \"modified\": \"2021-09-21T08:29:03.872601Z\",\n \"title_display\": \"New Incident on 20/09/2021: 10:30\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"d6fd90fd-aeb9-496b-a703-0de272dc32f6\",\n \"readable_id\": \"MOD105892\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 17/09/2021: 10:37\",\n \"status\": \"open\",\n \"created\": \"2021-09-17T05:07:31.044490Z\",\n \"modified\": \"2021-09-17T11:06:14.752143Z\",\n \"title_display\": \"New Incident on 17/09/2021: 10:37\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"93c1c783-d0dd-481c-ad11-58a671b35823\",\n \"readable_id\": \"MOD105524\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 08/09/2021: 10:34\",\n \"status\": \"open\",\n \"created\": \"2021-09-08T05:04:09.310955Z\",\n \"modified\": \"2021-09-08T05:12:03.248471Z\",\n \"title_display\": \"New Incident on 08/09/2021: 10:34\",\n \"severity_title\": \"Critical\"\n },\n {\n \"unique_id\": \"4bdba0b6-9310-415e-b701-1c9964fd786d\",\n \"readable_id\": \"MOD105497\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 06/09/2021: 10:52\",\n \"status\": \"open\",\n \"created\": \"2021-09-06T05:22:43.906166Z\",\n \"modified\": \"2021-09-06T06:58:07.486830Z\",\n \"title_display\": \"New Incident on 06/09/2021: 10:52\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"df0ce907-baca-4d21-96ae-15e63f527191\",\n \"readable_id\": \"MOD105361\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 13/08/2021: 10:10\",\n \"status\": \"merged\",\n \"created\": \"2021-08-13T04:23:13.238270Z\",\n \"modified\": \"2021-08-16T22:20:27.378697Z\",\n \"title_display\": \"New Incident on 13/08/2021: 10:10\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"f2c276d3-6c07-4262-94e9-293dbebe9e6f\",\n \"readable_id\": \"MOD105131\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 22/07/2021: 10:47\",\n \"status\": \"merged\",\n \"created\": \"2021-07-22T05:18:33.777197Z\",\n \"modified\": \"2021-08-10T06:07:45.882747Z\",\n \"title_display\": \"New Incident on 22/07/2021: 10:47\",\n \"severity_title\": \"Medium\"\n },\n {\n \"unique_id\": \"b46ec5b6-c39f-4138-8d7b-bc17553cdcfa\",\n \"readable_id\": \"MOD105133\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 23/07/2021: 10:52\",\n \"status\": \"merged\",\n \"created\": \"2021-07-23T05:58:11.904307Z\",\n \"modified\": \"2021-08-10T06:06:34.931021Z\",\n \"title_display\": \"New Incident on 23/07/2021: 10:52\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"778f032d-f2c9-4f15-aeea-580f0d4f5863\",\n \"readable_id\": \"MOD105154\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 30/07/2021: 10:34\",\n \"status\": \"merged\",\n \"created\": \"2021-07-30T05:04:10.625099Z\",\n \"modified\": \"2021-08-10T06:04:26.031591Z\",\n \"title_display\": \"New Incident on 30/07/2021: 10:34\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"25e54f12-ad58-4fcd-96cf-cffb31ecec04\",\n \"readable_id\": \"MOD105149\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 29/07/2021: 10:55\",\n \"status\": \"merged\",\n \"created\": \"2021-07-29T05:26:48.512406Z\",\n \"modified\": \"2021-08-10T06:02:18.637104Z\",\n \"title_display\": \"New Incident on 29/07/2021: 10:55\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"b79a3870-7edd-4cf3-b71a-8768a26b46f7\",\n \"readable_id\": \"MOD105135\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 23/07/2021: 17:22\",\n \"status\": \"open\",\n \"created\": \"2021-07-23T11:54:06.112610Z\",\n \"modified\": \"2021-07-26T14:55:53.488125Z\",\n \"title_display\": \"New Incident on 23/07/2021: 17:22\",\n \"severity_title\": \"Critical\"\n },\n {\n \"unique_id\": \"063260f5-dffb-4e77-bc8c-3a74d0ea7b39\",\n \"readable_id\": \"MOD105123\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 20/07/2021: 11:59\",\n \"status\": \"open\",\n \"created\": \"2021-07-20T06:30:48.237166Z\",\n \"modified\": \"2021-07-24T06:42:19.671055Z\",\n \"title_display\": \"New Incident on 20/07/2021: 11:59\",\n \"severity_title\": \"Medium\"\n },\n {\n \"unique_id\": \"32f54802-7582-4ec3-a7c0-046c5f05bbbe\",\n \"readable_id\": \"MOD103922\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 05//03/2021: 12:36\",\n \"status\": \"open\",\n \"created\": \"2021-03-05T07:30:28.710985Z\",\n \"modified\": \"2021-03-08T11:23:59.409666Z\",\n \"title_display\": \"New Incident on 05//03/2021: 12:36\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"7ef7a778-e848-4708-8aac-acc024b8143a\",\n \"readable_id\": \"MOD103887\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 03/03/2021: 10:40\",\n \"status\": \"open\",\n \"created\": \"2021-03-03T05:12:46.718538Z\",\n \"modified\": \"2021-03-03T05:24:47.816998Z\",\n \"title_display\": \"New Incident on 03/03/2021: 10:40\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"67275bf7-9f54-451f-adcf-0dc278752249\",\n \"readable_id\": \"MOD103423\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 01/03/2021: 11:06\",\n \"status\": \"open\",\n \"created\": \"2021-03-01T05:39:46.781958Z\",\n \"modified\": \"2021-03-01T06:58:35.955450Z\",\n \"title_display\": \"New Incident on 01/03/2021: 11:06\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"ba3eb6b1-eb99-4935-8e51-3188aff9e2dd\",\n \"readable_id\": \"MOD79631\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 16/02/2021: 11:20\",\n \"status\": \"open\",\n \"created\": \"2021-02-16T05:52:14.493740Z\",\n \"modified\": \"2021-02-16T10:20:35.227598Z\",\n \"title_display\": \"New Incident on 16/02/2021: 11:20\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"8c42fd2d-166f-44e2-9ffa-1a59e3276c45\",\n \"readable_id\": \"MOD68399\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"Parent\",\n \"status\": \"open\",\n \"created\": \"2020-11-08T09:25:23.878519Z\",\n \"modified\": \"2021-01-17T08:16:48.374083Z\",\n \"title_display\": \"Parent\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"f1b56356-3350-4361-ac05-adcb8b479ae0\",\n \"readable_id\": \"MOD68382\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"CHILD INCIDENT\",\n \"status\": \"open\",\n \"created\": \"2020-11-04T14:22:32.679884Z\",\n \"modified\": \"2021-01-17T08:16:48.357918Z\",\n \"title_display\": \"CHILD INCIDENT\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"fdc76a50-1ccf-4f39-b484-564447b0650b\",\n \"readable_id\": \"MOD75350\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 15/01/2021: 14:31\",\n \"status\": \"open\",\n \"created\": \"2021-01-15T09:01:38.554603Z\",\n \"modified\": \"2021-01-17T07:24:53.828657Z\",\n \"title_display\": \"New Incident on 15/01/2021: 14:31\",\n \"severity_title\": null\n },\n {\n \"unique_id\": \"b7cfe78e-1cd5-4c58-9a38-463af81c4556\",\n \"readable_id\": \"MOD68374\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"Test New Time\",\n \"status\": \"open\",\n \"created\": \"2020-11-03T11:54:41.361649Z\",\n \"modified\": \"2021-01-05T08:35:32.362249Z\",\n \"title_display\": \"Test New Time\",\n \"severity_title\": \"Medium\"\n },\n {\n \"unique_id\": \"44a2968a-4cf3-4cb8-a8d5-a860e204ea08\",\n \"readable_id\": \"MOD74980\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 04/01/2021: 19:33\",\n \"status\": \"open\",\n \"created\": \"2021-01-04T14:04:21.509461Z\",\n \"modified\": \"2021-01-05T07:16:23.972619Z\",\n \"title_display\": \"New Incident on 04/01/2021: 19:33\",\n \"severity_title\": \"Medium\"\n },\n {\n \"unique_id\": \"741377af-b1ab-491a-9bac-c9a2b65a576a\",\n \"readable_id\": \"MOD72071\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 23/11/2020: 11:26\",\n \"status\": \"open\",\n \"created\": \"2020-11-23T05:57:58.384038Z\",\n \"modified\": \"2020-11-24T06:22:54.254115Z\",\n \"title_display\": \"New Incident on 23/11/2020: 11:26\",\n \"severity_title\": \"Medium\"\n },\n {\n \"unique_id\": \"a1c4d1b0-1eb7-4a87-b635-51aa416b5fac\",\n \"readable_id\": \"MOD68488\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 20/11/2020:10:18\",\n \"status\": \"merged\",\n \"created\": \"2020-11-20T04:50:22.082035Z\",\n \"modified\": \"2020-11-20T06:31:17.968914Z\",\n \"title_display\": \"New Incident on 20/11/2020:10:18\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"ee9b1b64-5ad6-406c-b46a-25cdb88dc6b3\",\n \"readable_id\": \"MOD68456\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 19/11/2020:10:30\",\n \"status\": \"open\",\n \"created\": \"2020-11-19T05:03:53.522615Z\",\n \"modified\": \"2020-11-19T10:02:05.270310Z\",\n \"title_display\": \"New Incident on 19/11/2020:10:30\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"e1fcdaae-5931-4539-8988-5101126dcec4\",\n \"readable_id\": \"MOD68451\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 18/11/2020:10:27\",\n \"status\": \"open\",\n \"created\": \"2020-11-18T04:59:30.155034Z\",\n \"modified\": \"2020-11-18T11:55:08.261784Z\",\n \"title_display\": \"New Incident on 18/11/2020:10:27\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"871f41aa-2bff-4900-95e3-527dcd707d5f\",\n \"readable_id\": \"MOD68448\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 17/11/2020:12:27\",\n \"status\": \"open\",\n \"created\": \"2020-11-17T07:13:43.011160Z\",\n \"modified\": \"2020-11-17T07:33:59.979936Z\",\n \"title_display\": \"New Incident on 17/11/2020:12:27\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"f979af7d-9a1d-4835-ad0f-54a32df3bc59\",\n \"readable_id\": \"MOD68384\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 05/11/2020:16:02\",\n \"status\": \"closed\",\n \"created\": \"2020-11-05T10:34:10.481192Z\",\n \"modified\": \"2020-11-12T06:31:37.269736Z\",\n \"title_display\": \"New Incident on 05/11/2020:16:02\",\n \"severity_title\": \"Critical\"\n },\n {\n \"unique_id\": \"7b19bb9c-d500-43fc-bdcd-0abc7e47c0af\",\n \"readable_id\": \"MOD68381\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"~~~~~~~~~\",\n \"status\": \"merged\",\n \"created\": \"2020-11-04T14:21:16.877774Z\",\n \"modified\": \"2020-11-05T10:41:35.421829Z\",\n \"title_display\": \"~~~~~~~~~\",\n \"severity_title\": \"Low\"\n },\n {\n \"unique_id\": \"fb5e55ae-0c66-4c38-8464-49a87d24fa12\",\n \"readable_id\": \"MOD68331\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"The new incident on 29/10/2020: 13:20\",\n \"status\": \"open\",\n \"created\": \"2020-10-29T07:51:56.809640Z\",\n \"modified\": \"2020-10-30T07:01:38.306742Z\",\n \"title_display\": \"The new incident on 29/10/2020: 13:20\",\n \"severity_title\": \"Crisis\"\n },\n {\n \"unique_id\": \"7be4ceb1-d309-4709-80eb-8556c41f4c75\",\n \"readable_id\": \"CAS68317\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 27/10/2020:10:39\",\n \"status\": \"open\",\n \"created\": \"2020-10-27T05:13:31.128949Z\",\n \"modified\": \"2020-10-27T08:15:18.545576Z\",\n \"title_display\": \"New Incident on 27/10/2020:10:39\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"a5af3372-078a-4ce8-b1d3-f23808df8874\",\n \"readable_id\": \"MOD68285\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 22/10/2020:13:56\",\n \"status\": \"open\",\n \"created\": \"2020-10-22T08:27:31.403988Z\",\n \"modified\": \"2020-10-23T09:44:28.455007Z\",\n \"title_display\": \"New Incident on 22/10/2020:13:56\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"d31db85e-1e12-4ba8-8d49-abf2fd341a52\",\n \"readable_id\": \"MOD68226\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 19/10/2020: 13:39\",\n \"status\": \"open\",\n \"created\": \"2020-10-19T08:10:10.672837Z\",\n \"modified\": \"2020-10-21T08:17:11.926666Z\",\n \"title_display\": \"New Incident on 19/10/2020: 13:39\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"c92c5894-908f-42d3-9be3-956c1d24f3fd\",\n \"readable_id\": \"CAS68240\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 20/10/2020:12:56\",\n \"status\": \"open\",\n \"created\": \"2020-10-20T07:27:28.639157Z\",\n \"modified\": \"2020-10-20T11:17:42.452029Z\",\n \"title_display\": \"New Incident on 20/10/2020:12:56\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"94a5b24a-59fb-4709-b336-f78099540506\",\n \"readable_id\": \"MOD68221\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident\",\n \"status\": \"untriaged\",\n \"created\": \"2020-10-16T08:32:49.685223Z\",\n \"modified\": \"2020-10-16T10:47:10.868785Z\",\n \"title_display\": \"New Incident\",\n \"severity_title\": null\n },\n {\n \"unique_id\": \"5dd92250-ccc4-4c79-b5f5-93f116f96b32\",\n \"readable_id\": \"MOD68220\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident\",\n \"status\": \"untriaged\",\n \"created\": \"2020-10-16T08:31:20.037388Z\",\n \"modified\": \"2020-10-16T08:31:20.853870Z\",\n \"title_display\": \"New Incident\",\n \"severity_title\": null\n }\n ],\n \"software_id\": \"12345678ds\",\n \"vulnerabilities\": [\n \"2a128e94-ac20-4a52-a6c6-9e1520fff856\",\n \"e262546b-4060-4561-a4c1-4660c0809fbb\",\n \"436f7f5c-f022-4a4c-b1ad-8e9c2b9efd3c\",\n \"2ad32278-a947-4772-8eab-2a2413e3d15b\",\n \"25eafc92-9cd2-4120-b1e3-a2c8653bfaa7\",\n \"306eb522-3f75-4732-a3a7-0e46572f85f7\"\n ],\n \"vulnerabilities_data\": [\n {\n \"unique_id\": \"2a128e94-ac20-4a52-a6c6-9e1520fff856\",\n \"readable_id\": \"VUL1218\",\n \"title\": \"New Vulnerability on 19/10/2020: 15:28\",\n \"status\": \"open\",\n \"created\": \"2020-10-19T09:59:47.478497Z\",\n \"modified\": \"2020-10-19T10:03:54.077737Z\",\n \"title_display\": \"New Vulnerability on 19/10/2020: 15:28\",\n \"cvss_score\": null,\n \"due_date\": null,\n \"target_remediation_date\": \"2020-10-22T18:30:00Z\",\n \"priority\": \"High\",\n \"risk_data\": {\n \"unique_id\": \"becbfc48-380a-4940-a9de-7bd45a4f0b39\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"588ecd2e-aeb5-4453-b5bc-ffb200f5dd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"High\",\n \"priority_data\": {\n \"unique_id\": \"05798f42-62c4-4f48-afc4-401c2fc1e6cf\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"eaa1900a-1dc2-4b45-bc0b-76dd0e56bb34\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n },\n {\n \"unique_id\": \"e262546b-4060-4561-a4c1-4660c0809fbb\",\n \"readable_id\": \"VUL2311\",\n \"title\": \"New Vulnerability on 22/09/2021: 11:45\",\n \"status\": \"open\",\n \"created\": \"2021-09-22T06:15:48.608206Z\",\n \"modified\": \"2021-09-23T15:17:40.744272Z\",\n \"title_display\": \"New Vulnerability on 22/09/2021: 11:45\",\n \"cvss_score\": null,\n \"due_date\": null,\n \"target_remediation_date\": null,\n \"priority\": \"High\",\n \"risk_data\": {\n \"unique_id\": \"becbfc48-380a-4940-a9de-7bd45a4f0b39\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"588ecd2e-aeb5-4453-b5bc-ffb200f5dd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"High\",\n \"priority_data\": {\n \"unique_id\": \"05798f42-62c4-4f48-afc4-401c2fc1e6cf\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"eaa1900a-1dc2-4b45-bc0b-76dd0e56bb34\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n },\n {\n \"unique_id\": \"436f7f5c-f022-4a4c-b1ad-8e9c2b9efd3c\",\n \"readable_id\": \"VUL1217\",\n \"title\": \"New Vulnerability on 16/10/2020:16:22\",\n \"status\": \"closed\",\n \"created\": \"2020-10-16T10:55:04.104851Z\",\n \"modified\": \"2020-10-16T11:06:13.222457Z\",\n \"title_display\": \"New Vulnerability on 16/10/2020:16:22\",\n \"cvss_score\": null,\n \"due_date\": null,\n \"target_remediation_date\": null,\n \"priority\": \"High\",\n \"risk_data\": {\n \"unique_id\": \"becbfc48-380a-4940-a9de-7bd45a4f0b39\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"588ecd2e-aeb5-4453-b5bc-ffb200f5dd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"High\",\n \"priority_data\": {\n \"unique_id\": \"05798f42-62c4-4f48-afc4-401c2fc1e6cf\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"eaa1900a-1dc2-4b45-bc0b-76dd0e56bb34\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n },\n {\n \"unique_id\": \"2ad32278-a947-4772-8eab-2a2413e3d15b\",\n \"readable_id\": \"VUL219\",\n \"title\": \"New Vulnerability on 14/02/2020:11:30\",\n \"status\": \"open\",\n \"created\": \"2020-02-14T06:01:45.073359Z\",\n \"modified\": \"2020-11-19T04:56:38.943165Z\",\n \"title_display\": \"New Vulnerability on 14/02/2020:11:30\",\n \"cvss_score\": null,\n \"due_date\": null,\n \"target_remediation_date\": null,\n \"priority\": \"High\",\n \"risk_data\": {\n \"unique_id\": \"5cc41427-be13-4749-89c5-558591dff94e\",\n \"option_name\": \"Very Low\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"588ecd2e-aeb5-4453-b5bc-ffb200f5dd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"Very Low\",\n \"priority_data\": {\n \"unique_id\": \"05798f42-62c4-4f48-afc4-401c2fc1e6cf\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"eaa1900a-1dc2-4b45-bc0b-76dd0e56bb34\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n },\n {\n \"unique_id\": \"25eafc92-9cd2-4120-b1e3-a2c8653bfaa7\",\n \"readable_id\": \"VUL2298\",\n \"title\": \"Vul Reg\",\n \"status\": \"closed\",\n \"created\": \"2021-07-22T05:33:21.690478Z\",\n \"modified\": \"2021-07-23T13:01:14.838899Z\",\n \"title_display\": \"Vul Reg\",\n \"cvss_score\": null,\n \"due_date\": null,\n \"target_remediation_date\": null,\n \"priority\": \"High\",\n \"risk_data\": {\n \"unique_id\": \"bb14a5ed-1401-4638-9a52-9d021138eefc\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"588ecd2e-aeb5-4453-b5bc-ffb200f5dd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"Medium\",\n \"priority_data\": {\n \"unique_id\": \"05798f42-62c4-4f48-afc4-401c2fc1e6cf\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"eaa1900a-1dc2-4b45-bc0b-76dd0e56bb34\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n },\n {\n \"unique_id\": \"306eb522-3f75-4732-a3a7-0e46572f85f7\",\n \"readable_id\": \"VUL2299\",\n \"title\": \"Test Vul\",\n \"status\": \"open\",\n \"created\": \"2021-09-13T10:19:02.416733Z\",\n \"modified\": \"2021-09-13T10:52:51.764298Z\",\n \"title_display\": \"Test Vul\",\n \"cvss_score\": null,\n \"due_date\": null,\n \"target_remediation_date\": null,\n \"priority\": \"Medium\",\n \"risk_data\": {\n \"unique_id\": \"becbfc48-380a-4940-a9de-7bd45a4f0b39\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"588ecd2e-aeb5-4453-b5bc-ffb200f5dd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"High\",\n \"priority_data\": {\n \"unique_id\": \"7da31edd-b13d-4b44-89f0-4760e0fd8d0c\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"eaa1900a-1dc2-4b45-bc0b-76dd0e56bb34\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n }\n ],\n \"readable_id\": \"SFT18029\",\n \"labels\": [\n \"00277fc5-efb9-4929-94b6-e5b9dbee59e0\",\n \"4fa2cb65-1071-4f5e-a8ee-ee467c98a52b\",\n \"9c04a82a-9296-484e-9770-832480dd02ab\",\n \"de5af83f-8afe-411e-9981-f41aff4ce9b5\",\n \"5f5bf123-be20-4c8b-beac-37772caf1a6d\",\n \"1aa72234-ed7d-4bc6-b325-013adcf73dc4\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"00277fc5-efb9-4929-94b6-e5b9dbee59e0\",\n \"title\": \"Sft 3\",\n \"color_code\": \"#3E2723\",\n \"created\": \"2021-01-27T09:36:07.283958Z\",\n \"modified\": \"2021-01-27T09:36:07.283958Z\"\n },\n {\n \"unique_id\": \"4fa2cb65-1071-4f5e-a8ee-ee467c98a52b\",\n \"title\": \"fd\",\n \"color_code\": \"#311B92\",\n \"created\": \"2021-01-27T09:36:42.943902Z\",\n \"modified\": \"2021-01-27T09:36:42.943902Z\"\n },\n {\n \"unique_id\": \"9c04a82a-9296-484e-9770-832480dd02ab\",\n \"title\": \"Software Label\",\n \"color_code\": \"#FA8469\",\n \"created\": \"2019-12-24T09:10:03.452165Z\",\n \"modified\": \"2019-12-24T09:10:03.452691Z\"\n },\n {\n \"unique_id\": \"de5af83f-8afe-411e-9981-f41aff4ce9b5\",\n \"title\": \"huhj\",\n \"color_code\": \"#5E35B1\",\n \"created\": \"2021-01-27T09:36:09.238368Z\",\n \"modified\": \"2021-01-27T09:36:09.238368Z\"\n },\n {\n \"unique_id\": \"5f5bf123-be20-4c8b-beac-37772caf1a6d\",\n \"title\": \"dsf\",\n \"color_code\": \"#673AB7\",\n \"created\": \"2021-01-27T09:36:53.947109Z\",\n \"modified\": \"2021-01-27T09:36:53.947109Z\"\n },\n {\n \"unique_id\": \"1aa72234-ed7d-4bc6-b325-013adcf73dc4\",\n \"title\": \"SFT LBL\",\n \"color_code\": \"#A0120A\",\n \"created\": \"2019-09-17T08:17:57.773656Z\",\n \"modified\": \"2019-09-17T08:17:57.774135Z\"\n }\n ],\n \"threat_actors\": [\n \"1b2a40dc-cae9-4f2b-a201-0ec33498470b\",\n \"8f736587-e249-434c-bcf6-29e5fda7c1fb\",\n \"4f7f4e47-f848-4c44-8673-2d4fa1ac219c\",\n \"6c2c8717-67fa-4704-b92d-6b9203f9eb0b\"\n ],\n \"threat_actors_data\": [\n {\n \"unique_id\": \"1b2a40dc-cae9-4f2b-a201-0ec33498470b\",\n \"readable_id\": \"ATR153\",\n \"title\": \"Threat Actor\",\n \"status\": \"active\",\n \"created\": \"2020-09-02T19:37:49.046011Z\",\n \"modified\": \"2020-09-09T10:45:47.796516Z\",\n \"title_display\": \"Threat Actor\"\n },\n {\n \"unique_id\": \"8f736587-e249-434c-bcf6-29e5fda7c1fb\",\n \"readable_id\": \"ATR344\",\n \"title\": \"New Threat Actor on 21/09/2021: 19:17\",\n \"status\": \"active\",\n \"created\": \"2021-09-21T13:48:38.336973Z\",\n \"modified\": \"2022-02-08T11:16:56.593138Z\",\n \"title_display\": \"New Threat Actor on 21/09/2021: 19:17\"\n },\n {\n \"unique_id\": \"4f7f4e47-f848-4c44-8673-2d4fa1ac219c\",\n \"readable_id\": \"ATR139\",\n \"title\": \"New Threat Actor\",\n \"status\": \"active\",\n \"created\": \"2020-08-04T13:24:34.222589Z\",\n \"modified\": \"2021-02-05T10:26:31.357116Z\",\n \"title_display\": \"New Threat Actor\"\n },\n {\n \"unique_id\": \"6c2c8717-67fa-4704-b92d-6b9203f9eb0b\",\n \"readable_id\": \"ATR336\",\n \"title\": \"Reg Threat Actor\",\n \"status\": \"active\",\n \"created\": \"2021-07-21T03:54:22.591332Z\",\n \"modified\": \"2021-07-21T04:15:30.224407Z\",\n \"title_display\": \"Reg Threat Actor\"\n }\n ],\n \"malwares\": [\n \"206fb536-4e19-43d3-9f63-28daf03f7dfd\",\n \"eea569cd-c1be-420c-aa7b-fa120e1c278f\"\n ],\n \"malwares_data\": [\n {\n \"unique_id\": \"206fb536-4e19-43d3-9f63-28daf03f7dfd\",\n \"readable_id\": \"MLW221\",\n \"title\": \"Malw001\",\n \"status\": \"active\",\n \"created\": \"2020-07-29T20:03:03.491361Z\",\n \"modified\": \"2021-03-05T17:21:01.216738Z\",\n \"title_display\": \"Malw001\",\n \"type_data\": [\n {\n \"unique_id\": \"b2eb3b18-33b2-4863-a029-90688ba1c95f\",\n \"option_name\": \"Botnet\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"type\": [\n \"Botnet\"\n ],\n \"platform_data\": [\n {\n \"unique_id\": \"db8785a4-5dc2-4c1f-8647-d9bf4411ae42\",\n \"option_name\": \"Windows 7\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"platform\": [\n \"Windows 7\"\n ]\n },\n {\n \"unique_id\": \"eea569cd-c1be-420c-aa7b-fa120e1c278f\",\n \"readable_id\": \"MLW241\",\n \"title\": \"New Malware on 17/09/2020:14:42\",\n \"status\": \"active\",\n \"created\": \"2020-09-17T09:15:42.409425Z\",\n \"modified\": \"2020-09-17T09:15:42.409425Z\",\n \"title_display\": \"New Malware on 17/09/2020:14:42\",\n \"type_data\": [\n {\n \"unique_id\": \"abb93a96-37ef-4a76-8937-ff960aef947d\",\n \"option_name\": \"Destructive\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"1ecfc252-6c39-4dba-b1be-eda236dfcba4\",\n \"option_name\": \"Ransomware\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"type\": [\n \"Destructive\",\n \"Ransomware\"\n ],\n \"platform_data\": [\n {\n \"unique_id\": \"32d39572-92e3-42ab-8949-cbe15745cfd5\",\n \"option_name\": \"Windows Server 2k12\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"43e5e63f-9623-4b89-b670-21650dbc8518\",\n \"option_name\": \"Windows XP\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"platform\": [\n \"Windows Server 2k12\",\n \"Windows XP\"\n ]\n }\n ],\n \"applications\": [\n \"0fbc0e3a-08f8-4398-8277-5ed86cce3734\",\n \"784f4277-50c3-40bf-a5fe-1dd52a751d9a\",\n \"101cc9c3-2fac-4501-8785-6a6a417fa9ef\"\n ],\n \"applications_data\": [\n {\n \"unique_id\": \"0fbc0e3a-08f8-4398-8277-5ed86cce3734\",\n \"created\": \"2020-10-19T11:45:57.926536Z\",\n \"modified\": \"2020-10-19T11:49:21.680874Z\",\n \"title\": \"New Application on 19/10/2020:17:14\",\n \"production_date\": \"2020-10-30T18:30:00Z\",\n \"readable_id\": \"APL196\",\n \"title_display\": \"New Application on 19/10/2020:17:14\",\n \"status\": \"inactive\"\n },\n {\n \"unique_id\": \"784f4277-50c3-40bf-a5fe-1dd52a751d9a\",\n \"created\": \"2020-10-09T08:20:36.984629Z\",\n \"modified\": \"2020-10-09T08:20:36.984629Z\",\n \"title\": \"APL889-10\",\n \"production_date\": null,\n \"readable_id\": \"APL192\",\n \"title_display\": \"APL889-10\",\n \"status\": \"inactive\"\n },\n {\n \"unique_id\": \"101cc9c3-2fac-4501-8785-6a6a417fa9ef\",\n \"created\": \"2020-10-16T11:10:40.931249Z\",\n \"modified\": \"2020-10-16T11:12:39.526926Z\",\n \"title\": \"New Application on 16/10/2020:16:39\",\n \"production_date\": null,\n \"readable_id\": \"APL195\",\n \"title_display\": \"New Application on 16/10/2020:16:39\",\n \"status\": \"active\"\n }\n ],\n \"briefings\": [\n \"98ec1b2c-cac0-4e87-8b1d-463a71942209\",\n \"03ff0e23-f3fd-4651-96bf-b3fdcad4deae\",\n \"57afe488-6b4e-471d-b612-93d5d8b0abe6\"\n ],\n \"briefings_data\": [\n {\n \"unique_id\": \"98ec1b2c-cac0-4e87-8b1d-463a71942209\",\n \"readable_id\": \"BRF187\",\n \"title\": \"New Threat Briefing on 14/10/2020:20:45\",\n \"created\": \"2020-10-14T15:18:19.401188Z\",\n \"modified\": \"2020-10-14T15:21:01.273295Z\",\n \"title_display\": \"New Threat Briefing on 14/10/2020:20:45\",\n \"status\": \"INACTIVE\"\n },\n {\n \"unique_id\": \"03ff0e23-f3fd-4651-96bf-b3fdcad4deae\",\n \"readable_id\": \"BRF188\",\n \"title\": \"New Threat Briefing on 15/10/2020: 13:16\",\n \"created\": \"2020-10-15T07:46:22.480957Z\",\n \"modified\": \"2020-10-15T07:46:22.480957Z\",\n \"title_display\": \"New Threat Briefing on 15/10/2020: 13:16\",\n \"status\": \"ACTIVE\"\n },\n {\n \"unique_id\": \"57afe488-6b4e-471d-b612-93d5d8b0abe6\",\n \"readable_id\": \"BRF189\",\n \"title\": \"New Threat Briefing on 19/10/2020: 15:04\",\n \"created\": \"2020-10-19T09:34:40.440305Z\",\n \"modified\": \"2020-10-19T09:39:30.270835Z\",\n \"title_display\": \"New Threat Briefing on 19/10/2020: 15:04\",\n \"status\": \"ACTIVE\"\n }\n ],\n \"endpoints\": [\n \"b6dff24f-0883-47a9-ae39-c9f30ec50f7e\",\n \"029a6ce7-89ad-4ecc-9c4d-db9f6f08fdd2\",\n \"ac484f3e-999f-4570-8f56-07d877d163fa\",\n \"19279ff8-f033-4476-983e-f86159eaf974\",\n \"702e20aa-c257-404d-a889-a481e1015187\"\n ],\n \"endpoints_data\": [\n {\n \"unique_id\": \"b6dff24f-0883-47a9-ae39-c9f30ec50f7e\",\n \"created\": \"2021-07-27T06:31:55.065341Z\",\n \"modified\": \"2021-07-29T06:57:55.686240Z\",\n \"hostname\": \"EC2AMAZ-LJ13GB300\",\n \"serial_number\": null,\n \"readable_id\": \"DVC11433\",\n \"title_display\": \"EC2AMAZ-LJ13GB300\",\n \"ip_address\": \"172.31.14.105\",\n \"mac_address\": null,\n \"endpoint_status\": \"suspected\"\n },\n {\n \"unique_id\": \"029a6ce7-89ad-4ecc-9c4d-db9f6f08fdd2\",\n \"created\": \"2021-07-19T18:21:22.719505Z\",\n \"modified\": \"2021-07-23T09:40:24.197263Z\",\n \"hostname\": \"SAM-QubeOS-Alpine.local-19996\",\n \"serial_number\": \"BSD0934K234BSD1K\",\n \"readable_id\": \"DVC11424\",\n \"title_display\": \"SAM-QubeOS-Alpine.local-19996\",\n \"ip_address\": \"172.98.76.45\",\n \"mac_address\": \"DD:61:D8:A0:E9:82\",\n \"endpoint_status\": \"inactive\"\n },\n {\n \"unique_id\": \"ac484f3e-999f-4570-8f56-07d877d163fa\",\n \"created\": \"2020-10-12T07:03:49.433406Z\",\n \"modified\": \"2021-07-02T12:15:04.830089Z\",\n \"hostname\": \"ec2-v2-vm-ed2\",\n \"serial_number\": null,\n \"readable_id\": \"DVC1110\",\n \"title_display\": \"ec2-v2-vm-ed2\",\n \"ip_address\": \"100.10.12.24\",\n \"mac_address\": null,\n \"endpoint_status\": \"inactive\"\n },\n {\n \"unique_id\": \"19279ff8-f033-4476-983e-f86159eaf974\",\n \"created\": \"2021-08-02T16:39:21.372868Z\",\n \"modified\": \"2021-08-03T13:19:06.656061Z\",\n \"hostname\": \"EC2AMAZ-120990496\",\n \"serial_number\": null,\n \"readable_id\": \"DVC11449\",\n \"title_display\": \"EC2AMAZ-120990496\",\n \"ip_address\": \"18.188.68.48\",\n \"mac_address\": \"06:da:c2:da:4d:e6\",\n \"endpoint_status\": \"clean\"\n },\n {\n \"unique_id\": \"702e20aa-c257-404d-a889-a481e1015187\",\n \"created\": \"2020-10-16T08:32:53.792827Z\",\n \"modified\": \"2021-07-02T12:24:15.879018Z\",\n \"hostname\": \"ec2-v2-vm-ed2\",\n \"serial_number\": null,\n \"readable_id\": \"DVC1115\",\n \"title_display\": \"ec2-v2-vm-ed2\",\n \"ip_address\": \"100.10.12.24\",\n \"mac_address\": null,\n \"endpoint_status\": \"inactive\"\n }\n ],\n \"software_publisher_data\": {\n \"title\": \"Manufacturer\",\n \"unique_id\": \"b4dfb79f-f35b-43e9-b743-87c48dba680f\"\n },\n \"created_by\": \"5c4fbd5d-78da-4a4c-93b2-f3a89e269b53\",\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"software_status\": \"active\",\n \"software_type_data\": [\n {\n \"unique_id\": \"852f97cb-1136-4709-a230-e9b17b89ff69\",\n \"option_name\": \"Development Software\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"de61a381-50f8-4289-943e-da81acb7f07a\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"9f04b873-53dd-47de-a41e-bf7caf4c1bb7\",\n \"option_name\": \"System Utility\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"de61a381-50f8-4289-943e-da81acb7f07a\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"operating_system_data\": [\n {\n \"unique_id\": \"7906ddbc-877a-47b0-8e4c-a5ec36e2f484\",\n \"option_name\": \"Windows Server 2k12\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"a02e150c-c78c-4a13-b8df-27d372a06160\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"3bfcb93e-b1f6-42b0-ad8b-5df2a95f93eb\",\n \"option_name\": \"Widows xp\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"a02e150c-c78c-4a13-b8df-27d372a06160\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"custom_tab_data\": null,\n \"new_single_select_data\": null,\n \"test_data\": [],\n \"sware_ms_data\": [\n {\n \"unique_id\": \"9ee83619-6d7f-4884-a353-741225e4475d\",\n \"option_name\": \"aaa1\",\n \"is_active\": true,\n \"order\": 10,\n \"option_field\": \"c5d31657-fe3e-4c28-9388-6b98577a7ab9\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"multi_select_field_data\": [],\n \"sware_ss_data\": {\n \"unique_id\": \"2189d4c0-9d4e-4fd0-b077-b3c9181b9187\",\n \"option_name\": \"aa\",\n \"is_active\": true,\n \"order\": 10,\n \"option_field\": \"72144615-2595-4d33-a40a-31e6ac31ecbc\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"approved_software_data\": {\n \"unique_id\": \"a6c72829-8895-46de-ba2b-3e4f92782fc9\",\n \"option_name\": \"Yes\",\n \"is_active\": true,\n \"order\": 5,\n \"option_field\": \"43234cb6-13a6-4d56-a7c0-1b838240394f\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n}"}],"_postman_id":"195f1485-2f0f-4565-8ed6-18de3cf7ab1f"},{"name":"Create Software Asset Using Field UUID","id":"4987d5d9-c395-4b8e-9bab-3c5d8c931f0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"test software from openapi\",\n \"software_id\": \"1234212id\",\n \"software_type\": [\"Development Software\"],\n \"software_publisher\": \"b4dfb79f-f35b-43e9-b743-87c48dba680f\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/asset-software/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Add a new software in the CFTR application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/asset-software/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`title`	String	Mandatory	Enter the name of the software.
`software_id`	String	Mandatory	Enter the sofware ID.
`software_type`	List	Mandatory	Enter the list of software types.
`software_publisher`	String	Mandatory	Enter the unique ID of the software publisher.
`software_status`	String	Optional	Enter the status of the software. Allowed Values: - active - inactive Default value: \"active\"
`purchase_date`	Integer	Optional	Enter the EPOCH timestamp of the purchase date of the software.
`expiry_date`	Integer	Optional`	Enter the EPOCH format timestamp of the expiry of the software.

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the software component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=asset-software\n\n

Following are some of the sample custom fields for users:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`purpose`	String	Optional

Response Parameters

Response Parameters | Regulatory Fields

Parameter	Type	Description
`unique_id`	String	Unique ID of the software.
`created`	String	Software creation date and time.
`modified`	String	Software last updated date and time.
`title`	String	Name of the software.
`software_id`	String	ID of the software.
`software_type`	List	Type of the software.
`title_display`	String	Name of software.
`readable_id`	String	Readable ID of software.
`software_status`	String	Current status of the software.
`purchase_date`	String	Purchase date of the software.
`created_by`	String	`user_id` of the user who created the software.
`created_by_data`	Object	Details of user who added the software.
`labels`	List	List of `unique_id` labels that are added to the software.
`labels_data`	List of Objects	Details of the labels that are added to the software.
`business_units_data`	List of Objects	Details of business units that are impacted by the software
`locations_data`	List of Objects	Details of locations that are impacted by the software.
`software_publisher_data`	Object	Details of the software publisher. Details include: `title` and `unique_id`.
`software_type_data`	Object	Details of the type of the software. Details include: `unique_id`, `is_active`, `order`, and so on.

Response Parameters | Connect The Dots

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities .
`malwares`	Array of UUID Strings	List of `unique_id` of the connected connected malwares.
`malwares_data`	Array of Objects	Details of the connected vulnerabilities .
`endpoints`	Array of UUID Strings	List of `unique_id` of the connected connected devices.
`endpoint_data`	Array of Objects	Details of the connected devices.

Response Parameters | Custom Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the software component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=asset-software\n\n

Following are some of the sample custom fields for users:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`purpose`	String	Optional

","urlObject":{"path":["asset-software",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"bb596ebf-6f82-4ee0-b8ef-dafede085ce5","name":"201 Created: Create Asset Software","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"test software from openapi\",\n \"software_id\": \"1234212id\",\n \"software_type\": [\"Development Software\"],\n \"software_publisher\": \"b4dfb79f-f35b-43e9-b743-87c48dba680f\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/asset-software/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["asset-software",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jun 2022 20:39:45 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1781","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"company\": null,\n \"number_of_assets\": null,\n \"software_type_custom_tab\": null,\n \"software_version\": null,\n \"purpose\": null,\n \"software_name\": null,\n \"sware_ss\": null,\n \"new_single_select\": null,\n \"custom_tab\": null,\n \"approved_software\": null,\n \"multi_select_field\": [],\n \"software_type\": [\n \"Development Software\"\n ],\n \"operating_system\": [],\n \"sware_ms\": [],\n \"test\": [],\n \"unique_id\": \"44c74376-1252-40ed-9fed-5c56e8dcb021\",\n \"created\": \"2022-06-27T20:39:45.282837Z\",\n \"modified\": \"2022-06-27T20:39:45.358439Z\",\n \"title\": \"test software from openapi\",\n \"purchase_date\": null,\n \"expiry_date\": null,\n \"incidents\": [],\n \"incidents_data\": [],\n \"software_id\": \"1234212id\",\n \"vulnerabilities\": [],\n \"vulnerabilities_data\": [],\n \"readable_id\": \"SFT18127\",\n \"labels\": [],\n \"labels_data\": [],\n \"threat_actors\": [],\n \"threat_actors_data\": [],\n \"malwares\": [],\n \"malwares_data\": [],\n \"applications\": [],\n \"applications_data\": [],\n \"briefings\": [],\n \"briefings_data\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"software_publisher_data\": {\n \"title\": \"Manufacturer\",\n \"unique_id\": \"b4dfb79f-f35b-43e9-b743-87c48dba680f\"\n },\n \"created_by\": \"830ae605-1209-47dd-8382-eded47622436\",\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"software_status\": \"active\",\n \"software_type_data\": [\n {\n \"unique_id\": \"852f97cb-1136-4709-a230-e9b17b89ff69\",\n \"option_name\": \"Development Software\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"de61a381-50f8-4289-943e-da81acb7f07a\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"operating_system_data\": [],\n \"custom_tab_data\": null,\n \"new_single_select_data\": null,\n \"test_data\": [],\n \"sware_ms_data\": [],\n \"multi_select_field_data\": [],\n \"sware_ss_data\": null,\n \"approved_software_data\": null\n}"}],"_postman_id":"4987d5d9-c395-4b8e-9bab-3c5d8c931f0e"},{"name":"Create Software Asset Using Field Values","id":"b8d3bdcc-90d8-4bbf-9f25-7b4ed989d21e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Software Created from OpenAPI\",\n \"software_id\": \"1dce213dc137634\",\n \"software_type\": [\"Development Software\"],\n \"software_publisher\": \"AMD\",\n \"labels\": [\"Red Label Software\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/asset-software/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","description":"

Add a new software in the CFTR application using the values of labels.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/asset-software/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`title`	String	Mandatory	Enter the name of the software.
`software_id`	String	Mandatory	Enter the sofware ID.
`software_type`	List	Mandatory	Enter the list of software types.
`software_publisher`	String	Mandatory	Enter the unique ID of the software publisher.
`software_status`	String	Optional	Enter the status of the software. Allowed Values: - active - inactive Default value: \"active\"
`purchase_date`	Integer	Optional	Enter the EPOCH timestamp of the purchase date of the software.
`expiry_date`	Integer	Optional	Enter the EPOCH format timestamp of the expiry of the software.
`labels`	List	Optional	Enter the list of names of the labels to be attached to the software asset. You can use the following API endpoint to retrieve the list of Labels: `/openapi/v1/utils/label/`

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the software component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=asset-software\n\n

Following are some of the sample custom fields for users:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`purpose`	String	Optional

Response Parameters

Response Parameters | Regulatory Fields

Parameter	Type	Description
`unique_id`	String	Unique ID of the software.
`created`	String	Software creation date and time.
`modified`	String	Software last updated date and time.
`title`	String	Name of the software.
`software_type`	List	Type of the software. For example, Development Software.
`software_id`	String	ID of the software.
`title_display`	String	Name of software.
`readable_id`	String	Readable ID of software.
`software_status`	String	Current status of the software.
`purchase_date`	String	Purchase date of the software.
`created_by`	String	`user_id` of the user who created the software.
`created_by_data`	Object	Details of user who added the software.
`labels`	List	List of `unique_id` labels that are added to the software.
`labels_data`	List of Objects	Details of the labels that are added to the software.
`business_units_data`	List of Objects	Details of business units that are impacted by the software
`locations_data`	List of Objects	Details of locations that are impacted by the software.
`software_publisher_data`	Object	Details of the software publisher. Details include: title and unique_id.
`software_type_data`	Object	Details of the type of the software. Details include: unique_id, is_active, order, and so on.

Response Parameters | Connect The Dots

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities .
`malwares`	Array of UUID Strings	List of `unique_id` of the connected connected malwares.
`malwares_data`	Array of Objects	Details of the connected malwares.
`endpoints`	Array of UUID Strings	List of `unique_id` of the connected connected devices.
`endpoint_data`	Array of Objects	Details of the connected devices.

Response Parameters | Custom Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the software component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=asset-software\n\n

Following are some of the sample custom fields for users:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`purpose`	String	Optional

Do not change the parameter value\nAllows you to create software asset using the values of labels, manufacturers.

\n","type":"text/plain"},"key":"values","value":"readable_type"}],"variable":[]}},"response":[{"id":"71a71b1d-6c3e-4b1f-b468-bbaa948a0d4a","name":"201 Created: Create Software Asset Using Field Values","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Software Created from OpenAPI\",\n \"software_id\": \"1dce213dc137634\",\n \"software_type\": [\"Development Software\"],\n \"software_publisher\": \"AMD\",\n \"labels\": [\"Red Label Software\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/asset-software/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","host":["{{base_url}}v1"],"path":["asset-software",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"values","value":"readable_type","description":"**Do not change the parameter value**\nAllows you to create software asset using the values of labels, manufacturers."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Apr 2023 06:56:23 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1715","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"software_version\": null,\n \"purpose\": null,\n \"number_of_assets\": null,\n \"approved_software\": null,\n \"software_type\": [\n \"Development Software\"\n ],\n \"operating_system\": [],\n \"unique_id\": \"cb642e1a-4bdc-4e1c-898c-3705c5592021\",\n \"created\": \"2023-04-26T06:56:21.845379Z\",\n \"modified\": \"2023-04-26T06:56:22.026597Z\",\n \"title\": \"Software Created from OpenAPI\",\n \"purchase_date\": null,\n \"expiry_date\": null,\n \"incidents\": [],\n \"incidents_data\": [],\n \"software_id\": \"1dce213dc137634\",\n \"vulnerabilities\": [],\n \"vulnerabilities_data\": [],\n \"readable_id\": \"SFT101\",\n \"labels\": [\n \"67e3fbda-e645-42ad-8bd5-49a103dd5d0c\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"67e3fbda-e645-42ad-8bd5-49a103dd5d0c\",\n \"title\": \"Red Label Software\",\n \"color_code\": \"#3E2723\",\n \"created\": \"2023-04-26T06:52:51.466358Z\",\n \"modified\": \"2023-04-26T06:53:07.010482Z\"\n }\n ],\n \"threat_actors\": [],\n \"threat_actors_data\": [],\n \"malwares\": [],\n \"malwares_data\": [],\n \"applications\": [],\n \"applications_data\": [],\n \"briefings\": [],\n \"briefings_data\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"software_publisher_data\": {\n \"title\": \"AMD\",\n \"unique_id\": \"6222f5d9-cec8-47c6-95e7-fcecc9a393e3\"\n },\n \"created_by\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"created_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"peter.smith@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"software_status\": \"active\",\n \"software_type_data\": [\n {\n \"unique_id\": \"aac42609-9a0a-4055-805a-45f05c16d88f\",\n \"option_name\": \"Development Software\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"1c6a7d8d-3ac2-4349-bf6f-b97959691eb5\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"operating_system_data\": [],\n \"approved_software_data\": null\n}"}],"_postman_id":"b8d3bdcc-90d8-4bbf-9f25-7b4ed989d21e"},{"name":"Update Software Asset Using Field UUID","id":"5a6b9ed8-e107-42fd-95b2-34b03a3e21dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"test software from openapi 1\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/asset-software/:sofware_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Update the details of a software in the CFTR application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/asset-software/:sofware_unique_id/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`title`	String	Optional	Enter the name of the software.
`software_id`	String	Optional	Enter the sofware ID.
`software_type`	List	Optional	Enter the list of software types.
`software_publisher`	String	Optional	Enter the unique ID of the software publisher.
`software_status`	String	Optional	Enter the status of the software. Allowed Values: - active - inactive Default value: \"active\"
`purchase_date`	Integer	Optional	Enter the EPOCH timestamp of the purchase date of the software.
`expiry_date`	Integer	Optional`	Enter the EPOCH format timestamp of the expiry of the software.

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the software component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=asset-software\n\n

Following are some of the sample custom fields for users:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`purpose`	String	Optional

Response Parameters

Response Parameters | Regulatory Fields

Parameter	Type	Description
`unique_id`	String	Unique ID of the software.
`created`	String	Software creation date and time.
`modified`	String	Software last updated date and time.
`title`	String	Name of the software.
`software_id`	String	ID of the software.
`software_type`	List	List of software types.
`title_display`	String	Name of software.
`readable_id`	String	Readable ID of software.
`software_status`	String	Current status of the software.
`purchase_date`	String	Purchase date of the software.
`created_by`	String	`user_id` of the user who created the software.
`created_by_data`	Object	Details of user who added the software.
`labels`	List	List of `unique_id` labels that are added to the software.
`labels_data`	List of Objects	Details of the labels that are added to the software.
`business_units_data`	List of Objects	Details of business units that are impacted by the software
`locations_data`	List of Objects	Details of locations that are impacted by the software.
`software_publisher_data`	Object	Details of the software publisher. Details include: `title` and `unique_id`.
`software_type_data`	Object	Details of the type of the software. Details include: `unique_id`, `is_active`, `order`, and so on.

Response Parameters | Connect The Dots

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities .
`malwares`	Array of UUID Strings	List of `unique_id` of the connected connected malwares.
`malwares_data`	Array of Objects	Details of the connected malwares .
`endpoints`	Array of UUID Strings	List of `unique_id` of the connected connected devices.
`endpoint_data`	Array of Objects	Details of the connected devices.

Response Parameters | Custom Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the software component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=asset-software\n\n

Following are some of the sample custom fields for users:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`purpose`	String	Optional

","urlObject":{"path":["asset-software",":sofware_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the software.

\n","type":"text/plain"},"type":"any","value":"8c670c6d-7cd6-4252-86ec-d40d1dc936cc","key":"sofware_unique_id"}]}},"response":[{"id":"25d0f7e1-8b7a-4046-abfc-465e8f023787","name":"200 OK: Update Asset Software","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"test software from openapi 1\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/asset-software/:sofware_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["asset-software",":sofware_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"sofware_unique_id","value":"8c670c6d-7cd6-4252-86ec-d40d1dc936cc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jun 2022 20:59:18 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"32186","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"company\": null,\n \"number_of_assets\": null,\n \"software_type_custom_tab\": null,\n \"software_version\": null,\n \"purpose\": \"new test purpose\",\n \"software_name\": null,\n \"sware_ss\": \"aa\",\n \"new_single_select\": null,\n \"custom_tab\": null,\n \"approved_software\": \"Yes\",\n \"multi_select_field\": [],\n \"software_type\": [\n \"Development Software\",\n \"System Utility\"\n ],\n \"operating_system\": [\n \"Windows Server 2k12\",\n \"Widows xp\"\n ],\n \"sware_ms\": [\n \"aaa1\"\n ],\n \"test\": [],\n \"unique_id\": \"8c670c6d-7cd6-4252-86ec-d40d1dc936cc\",\n \"created\": \"2020-10-16T11:13:41.709097Z\",\n \"modified\": \"2022-06-27T20:59:16.307646Z\",\n \"title\": \"test software from openapi 1\",\n \"purchase_date\": \"2020-10-29T18:30:00Z\",\n \"expiry_date\": \"2020-10-30T18:30:00Z\",\n \"incidents\": [\n \"25e54f12-ad58-4fcd-96cf-cffb31ecec04\",\n \"94a5b24a-59fb-4709-b336-f78099540506\",\n \"1262dc50-e716-4b00-8fb9-427738c19695\",\n \"f979af7d-9a1d-4835-ad0f-54a32df3bc59\",\n \"f1b56356-3350-4361-ac05-adcb8b479ae0\",\n \"0c1208c5-0fe5-4a40-b62b-83411a84aa5e\",\n \"d31db85e-1e12-4ba8-8d49-abf2fd341a52\",\n \"df0ce907-baca-4d21-96ae-15e63f527191\",\n \"8ef0ad66-99ab-43aa-93ed-da640a387f69\",\n \"871f41aa-2bff-4900-95e3-527dcd707d5f\",\n \"8c42fd2d-166f-44e2-9ffa-1a59e3276c45\",\n \"32f54802-7582-4ec3-a7c0-046c5f05bbbe\",\n \"fb5e55ae-0c66-4c38-8464-49a87d24fa12\",\n \"741377af-b1ab-491a-9bac-c9a2b65a576a\",\n \"66df34a9-123f-4649-b3e8-39aefe351b74\",\n \"b6838487-5093-4d58-bfcd-67d950c7fe28\",\n \"554b5cd7-d410-4db4-b501-fd7e71713050\",\n \"063260f5-dffb-4e77-bc8c-3a74d0ea7b39\",\n \"c92c5894-908f-42d3-9be3-956c1d24f3fd\",\n \"b79a3870-7edd-4cf3-b71a-8768a26b46f7\",\n \"7e81521b-4ce5-4ea1-aa77-754692e9d6e1\",\n \"ee9b1b64-5ad6-406c-b46a-25cdb88dc6b3\",\n \"f2c276d3-6c07-4262-94e9-293dbebe9e6f\",\n \"a5af3372-078a-4ce8-b1d3-f23808df8874\",\n \"7b19bb9c-d500-43fc-bdcd-0abc7e47c0af\",\n \"67275bf7-9f54-451f-adcf-0dc278752249\",\n \"778f032d-f2c9-4f15-aeea-580f0d4f5863\",\n \"93c1c783-d0dd-481c-ad11-58a671b35823\",\n \"376017b8-35f6-40af-b43d-7d50fcb0a2d0\",\n \"d6fd90fd-aeb9-496b-a703-0de272dc32f6\",\n \"a1c4d1b0-1eb7-4a87-b635-51aa416b5fac\",\n \"e1fcdaae-5931-4539-8988-5101126dcec4\",\n \"4bdba0b6-9310-415e-b701-1c9964fd786d\",\n \"7be4ceb1-d309-4709-80eb-8556c41f4c75\",\n \"b46ec5b6-c39f-4138-8d7b-bc17553cdcfa\",\n \"ba3eb6b1-eb99-4935-8e51-3188aff9e2dd\",\n \"7ef7a778-e848-4708-8aac-acc024b8143a\",\n \"b7cfe78e-1cd5-4c58-9a38-463af81c4556\",\n \"5dd92250-ccc4-4c79-b5f5-93f116f96b32\",\n \"fdc76a50-1ccf-4f39-b484-564447b0650b\",\n \"44a2968a-4cf3-4cb8-a8d5-a860e204ea08\"\n ],\n \"incidents_data\": [\n {\n \"unique_id\": \"8ef0ad66-99ab-43aa-93ed-da640a387f69\",\n \"readable_id\": \"MOD105204\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"Tap so\",\n \"status\": \"open\",\n \"created\": \"2021-08-10T06:01:14.782189Z\",\n \"modified\": \"2022-06-22T06:14:32.294924Z\",\n \"title_display\": \"Tap so\",\n \"severity_title\": \"Medium\"\n },\n {\n \"unique_id\": \"66df34a9-123f-4649-b3e8-39aefe351b74\",\n \"readable_id\": \"MOD106388\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 12/10/2021: 10:43\",\n \"status\": \"open\",\n \"created\": \"2021-10-12T05:15:20.122254Z\",\n \"modified\": \"2021-12-20T10:52:06.916573Z\",\n \"title_display\": \"New Incident on 12/10/2021: 10:43\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"0c1208c5-0fe5-4a40-b62b-83411a84aa5e\",\n \"readable_id\": \"MOD166339\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"Network Diagram Fixes Check\",\n \"status\": \"open\",\n \"created\": \"2021-12-06T10:38:47.178367Z\",\n \"modified\": \"2021-12-06T15:31:32.955937Z\",\n \"title_display\": \"Network Diagram Fixes Check\",\n \"severity_title\": \"Critical\"\n },\n {\n \"unique_id\": \"554b5cd7-d410-4db4-b501-fd7e71713050\",\n \"readable_id\": \"MOD104022\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 12/03/2021: 10:31\",\n \"status\": \"open\",\n \"created\": \"2021-03-12T05:03:11.848181Z\",\n \"modified\": \"2021-11-25T09:35:51.823017Z\",\n \"title_display\": \"New Incident on 12/03/2021: 10:31\",\n \"severity_title\": \"Critical\"\n },\n {\n \"unique_id\": \"b6838487-5093-4d58-bfcd-67d950c7fe28\",\n \"readable_id\": \"MOD105198\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident On 09/08/2021:13:14\",\n \"status\": \"open\",\n \"created\": \"2021-08-09T07:45:21.666399Z\",\n \"modified\": \"2021-10-29T21:46:41.760747Z\",\n \"title_display\": \"New Incident On 09/08/2021:13:14\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"1262dc50-e716-4b00-8fb9-427738c19695\",\n \"readable_id\": \"MOD106181\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 21/09/2021: 10:34\",\n \"status\": \"merged\",\n \"created\": \"2021-09-21T05:05:05.907653Z\",\n \"modified\": \"2021-09-21T13:42:50.248089Z\",\n \"title_display\": \"New Incident on 21/09/2021: 10:34\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"376017b8-35f6-40af-b43d-7d50fcb0a2d0\",\n \"readable_id\": \"MOD105523\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 07/09/2021: 10:20\",\n \"status\": \"open\",\n \"created\": \"2021-09-07T04:53:07.499965Z\",\n \"modified\": \"2021-09-21T08:40:09.050649Z\",\n \"title_display\": \"New Incident on 07/09/2021: 10:20\",\n \"severity_title\": \"Critical\"\n },\n {\n \"unique_id\": \"7e81521b-4ce5-4ea1-aa77-754692e9d6e1\",\n \"readable_id\": \"MOD106104\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 20/09/2021: 10:30\",\n \"status\": \"open\",\n \"created\": \"2021-09-20T05:00:28.357434Z\",\n \"modified\": \"2021-09-21T08:29:03.872601Z\",\n \"title_display\": \"New Incident on 20/09/2021: 10:30\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"d6fd90fd-aeb9-496b-a703-0de272dc32f6\",\n \"readable_id\": \"MOD105892\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 17/09/2021: 10:37\",\n \"status\": \"open\",\n \"created\": \"2021-09-17T05:07:31.044490Z\",\n \"modified\": \"2021-09-17T11:06:14.752143Z\",\n \"title_display\": \"New Incident on 17/09/2021: 10:37\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"93c1c783-d0dd-481c-ad11-58a671b35823\",\n \"readable_id\": \"MOD105524\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 08/09/2021: 10:34\",\n \"status\": \"open\",\n \"created\": \"2021-09-08T05:04:09.310955Z\",\n \"modified\": \"2021-09-08T05:12:03.248471Z\",\n \"title_display\": \"New Incident on 08/09/2021: 10:34\",\n \"severity_title\": \"Critical\"\n },\n {\n \"unique_id\": \"4bdba0b6-9310-415e-b701-1c9964fd786d\",\n \"readable_id\": \"MOD105497\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 06/09/2021: 10:52\",\n \"status\": \"open\",\n \"created\": \"2021-09-06T05:22:43.906166Z\",\n \"modified\": \"2021-09-06T06:58:07.486830Z\",\n \"title_display\": \"New Incident on 06/09/2021: 10:52\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"df0ce907-baca-4d21-96ae-15e63f527191\",\n \"readable_id\": \"MOD105361\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 13/08/2021: 10:10\",\n \"status\": \"merged\",\n \"created\": \"2021-08-13T04:23:13.238270Z\",\n \"modified\": \"2021-08-16T22:20:27.378697Z\",\n \"title_display\": \"New Incident on 13/08/2021: 10:10\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"f2c276d3-6c07-4262-94e9-293dbebe9e6f\",\n \"readable_id\": \"MOD105131\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 22/07/2021: 10:47\",\n \"status\": \"merged\",\n \"created\": \"2021-07-22T05:18:33.777197Z\",\n \"modified\": \"2021-08-10T06:07:45.882747Z\",\n \"title_display\": \"New Incident on 22/07/2021: 10:47\",\n \"severity_title\": \"Medium\"\n },\n {\n \"unique_id\": \"b46ec5b6-c39f-4138-8d7b-bc17553cdcfa\",\n \"readable_id\": \"MOD105133\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 23/07/2021: 10:52\",\n \"status\": \"merged\",\n \"created\": \"2021-07-23T05:58:11.904307Z\",\n \"modified\": \"2021-08-10T06:06:34.931021Z\",\n \"title_display\": \"New Incident on 23/07/2021: 10:52\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"778f032d-f2c9-4f15-aeea-580f0d4f5863\",\n \"readable_id\": \"MOD105154\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 30/07/2021: 10:34\",\n \"status\": \"merged\",\n \"created\": \"2021-07-30T05:04:10.625099Z\",\n \"modified\": \"2021-08-10T06:04:26.031591Z\",\n \"title_display\": \"New Incident on 30/07/2021: 10:34\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"25e54f12-ad58-4fcd-96cf-cffb31ecec04\",\n \"readable_id\": \"MOD105149\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 29/07/2021: 10:55\",\n \"status\": \"merged\",\n \"created\": \"2021-07-29T05:26:48.512406Z\",\n \"modified\": \"2021-08-10T06:02:18.637104Z\",\n \"title_display\": \"New Incident on 29/07/2021: 10:55\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"b79a3870-7edd-4cf3-b71a-8768a26b46f7\",\n \"readable_id\": \"MOD105135\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 23/07/2021: 17:22\",\n \"status\": \"open\",\n \"created\": \"2021-07-23T11:54:06.112610Z\",\n \"modified\": \"2021-07-26T14:55:53.488125Z\",\n \"title_display\": \"New Incident on 23/07/2021: 17:22\",\n \"severity_title\": \"Critical\"\n },\n {\n \"unique_id\": \"063260f5-dffb-4e77-bc8c-3a74d0ea7b39\",\n \"readable_id\": \"MOD105123\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 20/07/2021: 11:59\",\n \"status\": \"open\",\n \"created\": \"2021-07-20T06:30:48.237166Z\",\n \"modified\": \"2021-07-24T06:42:19.671055Z\",\n \"title_display\": \"New Incident on 20/07/2021: 11:59\",\n \"severity_title\": \"Medium\"\n },\n {\n \"unique_id\": \"32f54802-7582-4ec3-a7c0-046c5f05bbbe\",\n \"readable_id\": \"MOD103922\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 05//03/2021: 12:36\",\n \"status\": \"open\",\n \"created\": \"2021-03-05T07:30:28.710985Z\",\n \"modified\": \"2021-03-08T11:23:59.409666Z\",\n \"title_display\": \"New Incident on 05//03/2021: 12:36\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"7ef7a778-e848-4708-8aac-acc024b8143a\",\n \"readable_id\": \"MOD103887\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 03/03/2021: 10:40\",\n \"status\": \"open\",\n \"created\": \"2021-03-03T05:12:46.718538Z\",\n \"modified\": \"2021-03-03T05:24:47.816998Z\",\n \"title_display\": \"New Incident on 03/03/2021: 10:40\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"67275bf7-9f54-451f-adcf-0dc278752249\",\n \"readable_id\": \"MOD103423\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 01/03/2021: 11:06\",\n \"status\": \"open\",\n \"created\": \"2021-03-01T05:39:46.781958Z\",\n \"modified\": \"2021-03-01T06:58:35.955450Z\",\n \"title_display\": \"New Incident on 01/03/2021: 11:06\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"ba3eb6b1-eb99-4935-8e51-3188aff9e2dd\",\n \"readable_id\": \"MOD79631\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 16/02/2021: 11:20\",\n \"status\": \"open\",\n \"created\": \"2021-02-16T05:52:14.493740Z\",\n \"modified\": \"2021-02-16T10:20:35.227598Z\",\n \"title_display\": \"New Incident on 16/02/2021: 11:20\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"8c42fd2d-166f-44e2-9ffa-1a59e3276c45\",\n \"readable_id\": \"MOD68399\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"Parent\",\n \"status\": \"open\",\n \"created\": \"2020-11-08T09:25:23.878519Z\",\n \"modified\": \"2021-01-17T08:16:48.374083Z\",\n \"title_display\": \"Parent\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"f1b56356-3350-4361-ac05-adcb8b479ae0\",\n \"readable_id\": \"MOD68382\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"CHILD INCIDENT\",\n \"status\": \"open\",\n \"created\": \"2020-11-04T14:22:32.679884Z\",\n \"modified\": \"2021-01-17T08:16:48.357918Z\",\n \"title_display\": \"CHILD INCIDENT\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"fdc76a50-1ccf-4f39-b484-564447b0650b\",\n \"readable_id\": \"MOD75350\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 15/01/2021: 14:31\",\n \"status\": \"open\",\n \"created\": \"2021-01-15T09:01:38.554603Z\",\n \"modified\": \"2021-01-17T07:24:53.828657Z\",\n \"title_display\": \"New Incident on 15/01/2021: 14:31\",\n \"severity_title\": null\n },\n {\n \"unique_id\": \"b7cfe78e-1cd5-4c58-9a38-463af81c4556\",\n \"readable_id\": \"MOD68374\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"Test New Time\",\n \"status\": \"open\",\n \"created\": \"2020-11-03T11:54:41.361649Z\",\n \"modified\": \"2021-01-05T08:35:32.362249Z\",\n \"title_display\": \"Test New Time\",\n \"severity_title\": \"Medium\"\n },\n {\n \"unique_id\": \"44a2968a-4cf3-4cb8-a8d5-a860e204ea08\",\n \"readable_id\": \"MOD74980\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 04/01/2021: 19:33\",\n \"status\": \"open\",\n \"created\": \"2021-01-04T14:04:21.509461Z\",\n \"modified\": \"2021-01-05T07:16:23.972619Z\",\n \"title_display\": \"New Incident on 04/01/2021: 19:33\",\n \"severity_title\": \"Medium\"\n },\n {\n \"unique_id\": \"741377af-b1ab-491a-9bac-c9a2b65a576a\",\n \"readable_id\": \"MOD72071\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 23/11/2020: 11:26\",\n \"status\": \"open\",\n \"created\": \"2020-11-23T05:57:58.384038Z\",\n \"modified\": \"2020-11-24T06:22:54.254115Z\",\n \"title_display\": \"New Incident on 23/11/2020: 11:26\",\n \"severity_title\": \"Medium\"\n },\n {\n \"unique_id\": \"a1c4d1b0-1eb7-4a87-b635-51aa416b5fac\",\n \"readable_id\": \"MOD68488\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 20/11/2020:10:18\",\n \"status\": \"merged\",\n \"created\": \"2020-11-20T04:50:22.082035Z\",\n \"modified\": \"2020-11-20T06:31:17.968914Z\",\n \"title_display\": \"New Incident on 20/11/2020:10:18\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"ee9b1b64-5ad6-406c-b46a-25cdb88dc6b3\",\n \"readable_id\": \"MOD68456\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 19/11/2020:10:30\",\n \"status\": \"open\",\n \"created\": \"2020-11-19T05:03:53.522615Z\",\n \"modified\": \"2020-11-19T10:02:05.270310Z\",\n \"title_display\": \"New Incident on 19/11/2020:10:30\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"e1fcdaae-5931-4539-8988-5101126dcec4\",\n \"readable_id\": \"MOD68451\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 18/11/2020:10:27\",\n \"status\": \"open\",\n \"created\": \"2020-11-18T04:59:30.155034Z\",\n \"modified\": \"2020-11-18T11:55:08.261784Z\",\n \"title_display\": \"New Incident on 18/11/2020:10:27\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"871f41aa-2bff-4900-95e3-527dcd707d5f\",\n \"readable_id\": \"MOD68448\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 17/11/2020:12:27\",\n \"status\": \"open\",\n \"created\": \"2020-11-17T07:13:43.011160Z\",\n \"modified\": \"2020-11-17T07:33:59.979936Z\",\n \"title_display\": \"New Incident on 17/11/2020:12:27\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"f979af7d-9a1d-4835-ad0f-54a32df3bc59\",\n \"readable_id\": \"MOD68384\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 05/11/2020:16:02\",\n \"status\": \"closed\",\n \"created\": \"2020-11-05T10:34:10.481192Z\",\n \"modified\": \"2020-11-12T06:31:37.269736Z\",\n \"title_display\": \"New Incident on 05/11/2020:16:02\",\n \"severity_title\": \"Critical\"\n },\n {\n \"unique_id\": \"7b19bb9c-d500-43fc-bdcd-0abc7e47c0af\",\n \"readable_id\": \"MOD68381\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"~~~~~~~~~\",\n \"status\": \"merged\",\n \"created\": \"2020-11-04T14:21:16.877774Z\",\n \"modified\": \"2020-11-05T10:41:35.421829Z\",\n \"title_display\": \"~~~~~~~~~\",\n \"severity_title\": \"Low\"\n },\n {\n \"unique_id\": \"fb5e55ae-0c66-4c38-8464-49a87d24fa12\",\n \"readable_id\": \"MOD68331\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"The new incident on 29/10/2020: 13:20\",\n \"status\": \"open\",\n \"created\": \"2020-10-29T07:51:56.809640Z\",\n \"modified\": \"2020-10-30T07:01:38.306742Z\",\n \"title_display\": \"The new incident on 29/10/2020: 13:20\",\n \"severity_title\": \"Crisis\"\n },\n {\n \"unique_id\": \"7be4ceb1-d309-4709-80eb-8556c41f4c75\",\n \"readable_id\": \"CAS68317\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 27/10/2020:10:39\",\n \"status\": \"open\",\n \"created\": \"2020-10-27T05:13:31.128949Z\",\n \"modified\": \"2020-10-27T08:15:18.545576Z\",\n \"title_display\": \"New Incident on 27/10/2020:10:39\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"a5af3372-078a-4ce8-b1d3-f23808df8874\",\n \"readable_id\": \"MOD68285\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 22/10/2020:13:56\",\n \"status\": \"open\",\n \"created\": \"2020-10-22T08:27:31.403988Z\",\n \"modified\": \"2020-10-23T09:44:28.455007Z\",\n \"title_display\": \"New Incident on 22/10/2020:13:56\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"d31db85e-1e12-4ba8-8d49-abf2fd341a52\",\n \"readable_id\": \"MOD68226\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 19/10/2020: 13:39\",\n \"status\": \"open\",\n \"created\": \"2020-10-19T08:10:10.672837Z\",\n \"modified\": \"2020-10-21T08:17:11.926666Z\",\n \"title_display\": \"New Incident on 19/10/2020: 13:39\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"c92c5894-908f-42d3-9be3-956c1d24f3fd\",\n \"readable_id\": \"CAS68240\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 20/10/2020:12:56\",\n \"status\": \"open\",\n \"created\": \"2020-10-20T07:27:28.639157Z\",\n \"modified\": \"2020-10-20T11:17:42.452029Z\",\n \"title_display\": \"New Incident on 20/10/2020:12:56\",\n \"severity_title\": \"High\"\n },\n {\n \"unique_id\": \"94a5b24a-59fb-4709-b336-f78099540506\",\n \"readable_id\": \"MOD68221\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident\",\n \"status\": \"untriaged\",\n \"created\": \"2020-10-16T08:32:49.685223Z\",\n \"modified\": \"2020-10-16T10:47:10.868785Z\",\n \"title_display\": \"New Incident\",\n \"severity_title\": null\n },\n {\n \"unique_id\": \"5dd92250-ccc4-4c79-b5f5-93f116f96b32\",\n \"readable_id\": \"MOD68220\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident\",\n \"status\": \"untriaged\",\n \"created\": \"2020-10-16T08:31:20.037388Z\",\n \"modified\": \"2020-10-16T08:31:20.853870Z\",\n \"title_display\": \"New Incident\",\n \"severity_title\": null\n }\n ],\n \"software_id\": \"12345678ds\",\n \"vulnerabilities\": [\n \"2a128e94-ac20-4a52-a6c6-9e1520fff856\",\n \"e262546b-4060-4561-a4c1-4660c0809fbb\",\n \"436f7f5c-f022-4a4c-b1ad-8e9c2b9efd3c\",\n \"2ad32278-a947-4772-8eab-2a2413e3d15b\",\n \"25eafc92-9cd2-4120-b1e3-a2c8653bfaa7\",\n \"306eb522-3f75-4732-a3a7-0e46572f85f7\"\n ],\n \"vulnerabilities_data\": [\n {\n \"unique_id\": \"2a128e94-ac20-4a52-a6c6-9e1520fff856\",\n \"readable_id\": \"VUL1218\",\n \"title\": \"New Vulnerability on 19/10/2020: 15:28\",\n \"status\": \"open\",\n \"created\": \"2020-10-19T09:59:47.478497Z\",\n \"modified\": \"2020-10-19T10:03:54.077737Z\",\n \"title_display\": \"New Vulnerability on 19/10/2020: 15:28\",\n \"cvss_score\": null,\n \"due_date\": null,\n \"target_remediation_date\": \"2020-10-22T18:30:00Z\",\n \"priority\": \"High\",\n \"risk_data\": {\n \"unique_id\": \"becbfc48-380a-4940-a9de-7bd45a4f0b39\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"588ecd2e-aeb5-4453-b5bc-ffb200f5dd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"High\",\n \"priority_data\": {\n \"unique_id\": \"05798f42-62c4-4f48-afc4-401c2fc1e6cf\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"eaa1900a-1dc2-4b45-bc0b-76dd0e56bb34\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n },\n {\n \"unique_id\": \"e262546b-4060-4561-a4c1-4660c0809fbb\",\n \"readable_id\": \"VUL2311\",\n \"title\": \"New Vulnerability on 22/09/2021: 11:45\",\n \"status\": \"open\",\n \"created\": \"2021-09-22T06:15:48.608206Z\",\n \"modified\": \"2021-09-23T15:17:40.744272Z\",\n \"title_display\": \"New Vulnerability on 22/09/2021: 11:45\",\n \"cvss_score\": null,\n \"due_date\": null,\n \"target_remediation_date\": null,\n \"priority\": \"High\",\n \"risk_data\": {\n \"unique_id\": \"becbfc48-380a-4940-a9de-7bd45a4f0b39\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"588ecd2e-aeb5-4453-b5bc-ffb200f5dd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"High\",\n \"priority_data\": {\n \"unique_id\": \"05798f42-62c4-4f48-afc4-401c2fc1e6cf\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"eaa1900a-1dc2-4b45-bc0b-76dd0e56bb34\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n },\n {\n \"unique_id\": \"436f7f5c-f022-4a4c-b1ad-8e9c2b9efd3c\",\n \"readable_id\": \"VUL1217\",\n \"title\": \"New Vulnerability on 16/10/2020:16:22\",\n \"status\": \"closed\",\n \"created\": \"2020-10-16T10:55:04.104851Z\",\n \"modified\": \"2020-10-16T11:06:13.222457Z\",\n \"title_display\": \"New Vulnerability on 16/10/2020:16:22\",\n \"cvss_score\": null,\n \"due_date\": null,\n \"target_remediation_date\": null,\n \"priority\": \"High\",\n \"risk_data\": {\n \"unique_id\": \"becbfc48-380a-4940-a9de-7bd45a4f0b39\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"588ecd2e-aeb5-4453-b5bc-ffb200f5dd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"High\",\n \"priority_data\": {\n \"unique_id\": \"05798f42-62c4-4f48-afc4-401c2fc1e6cf\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"eaa1900a-1dc2-4b45-bc0b-76dd0e56bb34\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n },\n {\n \"unique_id\": \"2ad32278-a947-4772-8eab-2a2413e3d15b\",\n \"readable_id\": \"VUL219\",\n \"title\": \"New Vulnerability on 14/02/2020:11:30\",\n \"status\": \"open\",\n \"created\": \"2020-02-14T06:01:45.073359Z\",\n \"modified\": \"2020-11-19T04:56:38.943165Z\",\n \"title_display\": \"New Vulnerability on 14/02/2020:11:30\",\n \"cvss_score\": null,\n \"due_date\": null,\n \"target_remediation_date\": null,\n \"priority\": \"High\",\n \"risk_data\": {\n \"unique_id\": \"5cc41427-be13-4749-89c5-558591dff94e\",\n \"option_name\": \"Very Low\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"588ecd2e-aeb5-4453-b5bc-ffb200f5dd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"Very Low\",\n \"priority_data\": {\n \"unique_id\": \"05798f42-62c4-4f48-afc4-401c2fc1e6cf\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"eaa1900a-1dc2-4b45-bc0b-76dd0e56bb34\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n },\n {\n \"unique_id\": \"25eafc92-9cd2-4120-b1e3-a2c8653bfaa7\",\n \"readable_id\": \"VUL2298\",\n \"title\": \"Vul Reg\",\n \"status\": \"closed\",\n \"created\": \"2021-07-22T05:33:21.690478Z\",\n \"modified\": \"2021-07-23T13:01:14.838899Z\",\n \"title_display\": \"Vul Reg\",\n \"cvss_score\": null,\n \"due_date\": null,\n \"target_remediation_date\": null,\n \"priority\": \"High\",\n \"risk_data\": {\n \"unique_id\": \"bb14a5ed-1401-4638-9a52-9d021138eefc\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"588ecd2e-aeb5-4453-b5bc-ffb200f5dd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"Medium\",\n \"priority_data\": {\n \"unique_id\": \"05798f42-62c4-4f48-afc4-401c2fc1e6cf\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"eaa1900a-1dc2-4b45-bc0b-76dd0e56bb34\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n },\n {\n \"unique_id\": \"306eb522-3f75-4732-a3a7-0e46572f85f7\",\n \"readable_id\": \"VUL2299\",\n \"title\": \"Test Vul\",\n \"status\": \"open\",\n \"created\": \"2021-09-13T10:19:02.416733Z\",\n \"modified\": \"2021-09-13T10:52:51.764298Z\",\n \"title_display\": \"Test Vul\",\n \"cvss_score\": null,\n \"due_date\": null,\n \"target_remediation_date\": null,\n \"priority\": \"Medium\",\n \"risk_data\": {\n \"unique_id\": \"becbfc48-380a-4940-a9de-7bd45a4f0b39\",\n \"option_name\": \"High\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"588ecd2e-aeb5-4453-b5bc-ffb200f5dd1d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"risk\": \"High\",\n \"priority_data\": {\n \"unique_id\": \"7da31edd-b13d-4b44-89f0-4760e0fd8d0c\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"eaa1900a-1dc2-4b45-bc0b-76dd0e56bb34\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n }\n ],\n \"readable_id\": \"SFT18029\",\n \"labels\": [\n \"00277fc5-efb9-4929-94b6-e5b9dbee59e0\",\n \"4fa2cb65-1071-4f5e-a8ee-ee467c98a52b\",\n \"9c04a82a-9296-484e-9770-832480dd02ab\",\n \"de5af83f-8afe-411e-9981-f41aff4ce9b5\",\n \"5f5bf123-be20-4c8b-beac-37772caf1a6d\",\n \"1aa72234-ed7d-4bc6-b325-013adcf73dc4\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"00277fc5-efb9-4929-94b6-e5b9dbee59e0\",\n \"title\": \"Sft 3\",\n \"color_code\": \"#3E2723\",\n \"created\": \"2021-01-27T09:36:07.283958Z\",\n \"modified\": \"2021-01-27T09:36:07.283958Z\"\n },\n {\n \"unique_id\": \"4fa2cb65-1071-4f5e-a8ee-ee467c98a52b\",\n \"title\": \"fd\",\n \"color_code\": \"#311B92\",\n \"created\": \"2021-01-27T09:36:42.943902Z\",\n \"modified\": \"2021-01-27T09:36:42.943902Z\"\n },\n {\n \"unique_id\": \"9c04a82a-9296-484e-9770-832480dd02ab\",\n \"title\": \"Software Label\",\n \"color_code\": \"#FA8469\",\n \"created\": \"2019-12-24T09:10:03.452165Z\",\n \"modified\": \"2019-12-24T09:10:03.452691Z\"\n },\n {\n \"unique_id\": \"de5af83f-8afe-411e-9981-f41aff4ce9b5\",\n \"title\": \"huhj\",\n \"color_code\": \"#5E35B1\",\n \"created\": \"2021-01-27T09:36:09.238368Z\",\n \"modified\": \"2021-01-27T09:36:09.238368Z\"\n },\n {\n \"unique_id\": \"5f5bf123-be20-4c8b-beac-37772caf1a6d\",\n \"title\": \"dsf\",\n \"color_code\": \"#673AB7\",\n \"created\": \"2021-01-27T09:36:53.947109Z\",\n \"modified\": \"2021-01-27T09:36:53.947109Z\"\n },\n {\n \"unique_id\": \"1aa72234-ed7d-4bc6-b325-013adcf73dc4\",\n \"title\": \"SFT LBL\",\n \"color_code\": \"#A0120A\",\n \"created\": \"2019-09-17T08:17:57.773656Z\",\n \"modified\": \"2019-09-17T08:17:57.774135Z\"\n }\n ],\n \"threat_actors\": [\n \"1b2a40dc-cae9-4f2b-a201-0ec33498470b\",\n \"8f736587-e249-434c-bcf6-29e5fda7c1fb\",\n \"4f7f4e47-f848-4c44-8673-2d4fa1ac219c\",\n \"6c2c8717-67fa-4704-b92d-6b9203f9eb0b\"\n ],\n \"threat_actors_data\": [\n {\n \"unique_id\": \"1b2a40dc-cae9-4f2b-a201-0ec33498470b\",\n \"readable_id\": \"ATR153\",\n \"title\": \"Threat Actor\",\n \"status\": \"active\",\n \"created\": \"2020-09-02T19:37:49.046011Z\",\n \"modified\": \"2020-09-09T10:45:47.796516Z\",\n \"title_display\": \"Threat Actor\"\n },\n {\n \"unique_id\": \"8f736587-e249-434c-bcf6-29e5fda7c1fb\",\n \"readable_id\": \"ATR344\",\n \"title\": \"New Threat Actor on 21/09/2021: 19:17\",\n \"status\": \"active\",\n \"created\": \"2021-09-21T13:48:38.336973Z\",\n \"modified\": \"2022-02-08T11:16:56.593138Z\",\n \"title_display\": \"New Threat Actor on 21/09/2021: 19:17\"\n },\n {\n \"unique_id\": \"4f7f4e47-f848-4c44-8673-2d4fa1ac219c\",\n \"readable_id\": \"ATR139\",\n \"title\": \"New Threat Actor\",\n \"status\": \"active\",\n \"created\": \"2020-08-04T13:24:34.222589Z\",\n \"modified\": \"2021-02-05T10:26:31.357116Z\",\n \"title_display\": \"New Threat Actor\"\n },\n {\n \"unique_id\": \"6c2c8717-67fa-4704-b92d-6b9203f9eb0b\",\n \"readable_id\": \"ATR336\",\n \"title\": \"Reg Threat Actor\",\n \"status\": \"active\",\n \"created\": \"2021-07-21T03:54:22.591332Z\",\n \"modified\": \"2021-07-21T04:15:30.224407Z\",\n \"title_display\": \"Reg Threat Actor\"\n }\n ],\n \"malwares\": [\n \"206fb536-4e19-43d3-9f63-28daf03f7dfd\",\n \"eea569cd-c1be-420c-aa7b-fa120e1c278f\"\n ],\n \"malwares_data\": [\n {\n \"unique_id\": \"206fb536-4e19-43d3-9f63-28daf03f7dfd\",\n \"readable_id\": \"MLW221\",\n \"title\": \"Malw001\",\n \"status\": \"active\",\n \"created\": \"2020-07-29T20:03:03.491361Z\",\n \"modified\": \"2021-03-05T17:21:01.216738Z\",\n \"title_display\": \"Malw001\",\n \"type_data\": [\n {\n \"unique_id\": \"b2eb3b18-33b2-4863-a029-90688ba1c95f\",\n \"option_name\": \"Botnet\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"type\": [\n \"Botnet\"\n ],\n \"platform_data\": [\n {\n \"unique_id\": \"db8785a4-5dc2-4c1f-8647-d9bf4411ae42\",\n \"option_name\": \"Windows 7\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"platform\": [\n \"Windows 7\"\n ]\n },\n {\n \"unique_id\": \"eea569cd-c1be-420c-aa7b-fa120e1c278f\",\n \"readable_id\": \"MLW241\",\n \"title\": \"New Malware on 17/09/2020:14:42\",\n \"status\": \"active\",\n \"created\": \"2020-09-17T09:15:42.409425Z\",\n \"modified\": \"2020-09-17T09:15:42.409425Z\",\n \"title_display\": \"New Malware on 17/09/2020:14:42\",\n \"type_data\": [\n {\n \"unique_id\": \"abb93a96-37ef-4a76-8937-ff960aef947d\",\n \"option_name\": \"Destructive\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"1ecfc252-6c39-4dba-b1be-eda236dfcba4\",\n \"option_name\": \"Ransomware\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"994db50b-2f4d-4bd7-a756-79f7bdb3db46\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"type\": [\n \"Destructive\",\n \"Ransomware\"\n ],\n \"platform_data\": [\n {\n \"unique_id\": \"32d39572-92e3-42ab-8949-cbe15745cfd5\",\n \"option_name\": \"Windows Server 2k12\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"43e5e63f-9623-4b89-b670-21650dbc8518\",\n \"option_name\": \"Windows XP\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"13be47b8-afa7-49c3-aa89-0ef793c19c5e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"platform\": [\n \"Windows Server 2k12\",\n \"Windows XP\"\n ]\n }\n ],\n \"applications\": [\n \"0fbc0e3a-08f8-4398-8277-5ed86cce3734\",\n \"784f4277-50c3-40bf-a5fe-1dd52a751d9a\",\n \"101cc9c3-2fac-4501-8785-6a6a417fa9ef\"\n ],\n \"applications_data\": [\n {\n \"unique_id\": \"0fbc0e3a-08f8-4398-8277-5ed86cce3734\",\n \"created\": \"2020-10-19T11:45:57.926536Z\",\n \"modified\": \"2020-10-19T11:49:21.680874Z\",\n \"title\": \"New Application on 19/10/2020:17:14\",\n \"production_date\": \"2020-10-30T18:30:00Z\",\n \"readable_id\": \"APL196\",\n \"title_display\": \"New Application on 19/10/2020:17:14\",\n \"status\": \"inactive\"\n },\n {\n \"unique_id\": \"784f4277-50c3-40bf-a5fe-1dd52a751d9a\",\n \"created\": \"2020-10-09T08:20:36.984629Z\",\n \"modified\": \"2020-10-09T08:20:36.984629Z\",\n \"title\": \"APL889-10\",\n \"production_date\": null,\n \"readable_id\": \"APL192\",\n \"title_display\": \"APL889-10\",\n \"status\": \"inactive\"\n },\n {\n \"unique_id\": \"101cc9c3-2fac-4501-8785-6a6a417fa9ef\",\n \"created\": \"2020-10-16T11:10:40.931249Z\",\n \"modified\": \"2020-10-16T11:12:39.526926Z\",\n \"title\": \"New Application on 16/10/2020:16:39\",\n \"production_date\": null,\n \"readable_id\": \"APL195\",\n \"title_display\": \"New Application on 16/10/2020:16:39\",\n \"status\": \"active\"\n }\n ],\n \"briefings\": [\n \"98ec1b2c-cac0-4e87-8b1d-463a71942209\",\n \"03ff0e23-f3fd-4651-96bf-b3fdcad4deae\",\n \"57afe488-6b4e-471d-b612-93d5d8b0abe6\"\n ],\n \"briefings_data\": [\n {\n \"unique_id\": \"98ec1b2c-cac0-4e87-8b1d-463a71942209\",\n \"readable_id\": \"BRF187\",\n \"title\": \"New Threat Briefing on 14/10/2020:20:45\",\n \"created\": \"2020-10-14T15:18:19.401188Z\",\n \"modified\": \"2020-10-14T15:21:01.273295Z\",\n \"title_display\": \"New Threat Briefing on 14/10/2020:20:45\",\n \"status\": \"INACTIVE\"\n },\n {\n \"unique_id\": \"03ff0e23-f3fd-4651-96bf-b3fdcad4deae\",\n \"readable_id\": \"BRF188\",\n \"title\": \"New Threat Briefing on 15/10/2020: 13:16\",\n \"created\": \"2020-10-15T07:46:22.480957Z\",\n \"modified\": \"2020-10-15T07:46:22.480957Z\",\n \"title_display\": \"New Threat Briefing on 15/10/2020: 13:16\",\n \"status\": \"ACTIVE\"\n },\n {\n \"unique_id\": \"57afe488-6b4e-471d-b612-93d5d8b0abe6\",\n \"readable_id\": \"BRF189\",\n \"title\": \"New Threat Briefing on 19/10/2020: 15:04\",\n \"created\": \"2020-10-19T09:34:40.440305Z\",\n \"modified\": \"2020-10-19T09:39:30.270835Z\",\n \"title_display\": \"New Threat Briefing on 19/10/2020: 15:04\",\n \"status\": \"ACTIVE\"\n }\n ],\n \"endpoints\": [\n \"b6dff24f-0883-47a9-ae39-c9f30ec50f7e\",\n \"029a6ce7-89ad-4ecc-9c4d-db9f6f08fdd2\",\n \"ac484f3e-999f-4570-8f56-07d877d163fa\",\n \"19279ff8-f033-4476-983e-f86159eaf974\",\n \"702e20aa-c257-404d-a889-a481e1015187\"\n ],\n \"endpoints_data\": [\n {\n \"unique_id\": \"b6dff24f-0883-47a9-ae39-c9f30ec50f7e\",\n \"created\": \"2021-07-27T06:31:55.065341Z\",\n \"modified\": \"2021-07-29T06:57:55.686240Z\",\n \"hostname\": \"EC2AMAZ-LJ13GB300\",\n \"serial_number\": null,\n \"readable_id\": \"DVC11433\",\n \"title_display\": \"EC2AMAZ-LJ13GB300\",\n \"ip_address\": \"172.31.14.105\",\n \"mac_address\": null,\n \"endpoint_status\": \"suspected\"\n },\n {\n \"unique_id\": \"029a6ce7-89ad-4ecc-9c4d-db9f6f08fdd2\",\n \"created\": \"2021-07-19T18:21:22.719505Z\",\n \"modified\": \"2021-07-23T09:40:24.197263Z\",\n \"hostname\": \"SAM-QubeOS-Alpine.local-19996\",\n \"serial_number\": \"BSD0934K234BSD1K\",\n \"readable_id\": \"DVC11424\",\n \"title_display\": \"SAM-QubeOS-Alpine.local-19996\",\n \"ip_address\": \"172.98.76.45\",\n \"mac_address\": \"DD:61:D8:A0:E9:82\",\n \"endpoint_status\": \"inactive\"\n },\n {\n \"unique_id\": \"ac484f3e-999f-4570-8f56-07d877d163fa\",\n \"created\": \"2020-10-12T07:03:49.433406Z\",\n \"modified\": \"2021-07-02T12:15:04.830089Z\",\n \"hostname\": \"ec2-v2-vm-ed2\",\n \"serial_number\": null,\n \"readable_id\": \"DVC1110\",\n \"title_display\": \"ec2-v2-vm-ed2\",\n \"ip_address\": \"100.10.12.24\",\n \"mac_address\": null,\n \"endpoint_status\": \"inactive\"\n },\n {\n \"unique_id\": \"19279ff8-f033-4476-983e-f86159eaf974\",\n \"created\": \"2021-08-02T16:39:21.372868Z\",\n \"modified\": \"2021-08-03T13:19:06.656061Z\",\n \"hostname\": \"EC2AMAZ-120990496\",\n \"serial_number\": null,\n \"readable_id\": \"DVC11449\",\n \"title_display\": \"EC2AMAZ-120990496\",\n \"ip_address\": \"18.188.68.48\",\n \"mac_address\": \"06:da:c2:da:4d:e6\",\n \"endpoint_status\": \"clean\"\n },\n {\n \"unique_id\": \"702e20aa-c257-404d-a889-a481e1015187\",\n \"created\": \"2020-10-16T08:32:53.792827Z\",\n \"modified\": \"2021-07-02T12:24:15.879018Z\",\n \"hostname\": \"ec2-v2-vm-ed2\",\n \"serial_number\": null,\n \"readable_id\": \"DVC1115\",\n \"title_display\": \"ec2-v2-vm-ed2\",\n \"ip_address\": \"100.10.12.24\",\n \"mac_address\": null,\n \"endpoint_status\": \"inactive\"\n }\n ],\n \"software_publisher_data\": {\n \"title\": \"Manufacturer\",\n \"unique_id\": \"b4dfb79f-f35b-43e9-b743-87c48dba680f\"\n },\n \"created_by\": \"5c4fbd5d-78da-4a4c-93b2-f3a89e269b53\",\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"software_status\": \"active\",\n \"software_type_data\": [\n {\n \"unique_id\": \"852f97cb-1136-4709-a230-e9b17b89ff69\",\n \"option_name\": \"Development Software\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"de61a381-50f8-4289-943e-da81acb7f07a\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"9f04b873-53dd-47de-a41e-bf7caf4c1bb7\",\n \"option_name\": \"System Utility\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"de61a381-50f8-4289-943e-da81acb7f07a\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"operating_system_data\": [\n {\n \"unique_id\": \"7906ddbc-877a-47b0-8e4c-a5ec36e2f484\",\n \"option_name\": \"Windows Server 2k12\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"a02e150c-c78c-4a13-b8df-27d372a06160\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n {\n \"unique_id\": \"3bfcb93e-b1f6-42b0-ad8b-5df2a95f93eb\",\n \"option_name\": \"Widows xp\",\n \"is_active\": true,\n \"order\": 3,\n \"option_field\": \"a02e150c-c78c-4a13-b8df-27d372a06160\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"custom_tab_data\": null,\n \"new_single_select_data\": null,\n \"test_data\": [],\n \"sware_ms_data\": [\n {\n \"unique_id\": \"9ee83619-6d7f-4884-a353-741225e4475d\",\n \"option_name\": \"aaa1\",\n \"is_active\": true,\n \"order\": 10,\n \"option_field\": \"c5d31657-fe3e-4c28-9388-6b98577a7ab9\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"multi_select_field_data\": [],\n \"sware_ss_data\": {\n \"unique_id\": \"2189d4c0-9d4e-4fd0-b077-b3c9181b9187\",\n \"option_name\": \"aa\",\n \"is_active\": true,\n \"order\": 10,\n \"option_field\": \"72144615-2595-4d33-a40a-31e6ac31ecbc\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"approved_software_data\": {\n \"unique_id\": \"a6c72829-8895-46de-ba2b-3e4f92782fc9\",\n \"option_name\": \"Yes\",\n \"is_active\": true,\n \"order\": 5,\n \"option_field\": \"43234cb6-13a6-4d56-a7c0-1b838240394f\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n}"}],"_postman_id":"5a6b9ed8-e107-42fd-95b2-34b03a3e21dd"},{"name":"Update Software Asset Using Field Value","id":"d2a83920-3e5a-4a22-91ae-aecce70efdd7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"software_publisher\": \"Acer\",\n \"labels\": [\"Blue Label Software\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/asset-software/:sofware_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","description":"

Update the details of a software in the CFTR application using the values of labels.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/asset-software/:sofware_unique_id/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`title`	String	Optional	Enter the name of the software.
`software_id`	String	Optional	Enter the sofware ID.
`software_type`	List	Optional	Enter the list of software types.
`software_publisher`	String	Optional	Enter the unique ID of the software publisher.
`software_status`	String	Optional	Enter the status of the software. Allowed Values: - active - inactive Default value: \"active\"
`purchase_date`	Integer	Optional	Enter the EPOCH timestamp of the purchase date of the software.
`expiry_date`	Integer	Optional`	Enter the EPOCH format timestamp of the expiry of the software.
`labels`	List	Optional	Enter the list of names of the labels to be attached to the software asset. You can use the following API endpoint to retrieve the list of Labels: `/openapi/v1/utils/label/`

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the software component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=asset-software\n\n

Following are some of the sample custom fields for users:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`purpose`	String	Optional

Response Parameters

Response Parameters | Regulatory Fields

Parameter	Type	Description
`unique_id`	String	Unique ID of the software.
`created`	String	Software creation date and time.
`modified`	String	Software last updated date and time.
`title`	String	Name of the software.
`software_id`	String	ID of the software.
`software_type`	List	List of software types.
`title_display`	String	Name of software.
`readable_id`	String	Readable ID of software.
`software_status`	String	Current status of the software.
`purchase_date`	String	Purchase date of the software.
`created_by`	String	`user_id` of the user who created the software.
`created_by_data`	Object	Details of user who added the software.
`labels`	List	List of `unique_id` labels that are added to the software.
`labels_data`	List of Objects	Details of the labels that are added to the software.
`business_units_data`	List of Objects	Details of business units that are impacted by the software
`locations_data`	List of Objects	Details of locations that are impacted by the software.
`software_publisher_data`	Object	Details of the software publisher. Details include: title and unique_id.
`software_type_data`	Object	Details of the type of the software. Details include: unique_id, is_active, order, and so on.

Response Parameters | Connect The Dots

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities .
`malwares`	Array of UUID Strings	List of `unique_id` of the connected connected malwares.
`malwares_data`	Array of Objects	Details of the connected malwares .
`endpoints`	Array of UUID Strings	List of `unique_id` of the connected connected devices.
`endpoint_data`	Array of Objects	Details of the connected devices.

Response Parameters | Custom Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the software component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=asset-software\n\n

Following are some of the sample custom fields for users:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`purpose`	String	Optional

Do not change the parameter value\nAllows you to create software asset using the values of labels, manufacturers.

\n","type":"text/plain"},"key":"values","value":"readable_type"}],"variable":[{"description":{"content":"

Enter the unique ID of the software.

\n","type":"text/plain"},"type":"any","value":"cb642e1a-4bdc-4e1c-898c-3705c5592021","key":"sofware_unique_id"}]}},"response":[{"id":"8fe793f8-a005-4d10-99f6-3bce518197fe","name":"200 OK: Update Software Asset Using Field Value","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"software_publisher\": \"Acer\",\n \"labels\": [\"Blue Label Software\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/asset-software/:sofware_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","host":["{{base_url}}v1"],"path":["asset-software",":sofware_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"values","value":"readable_type","description":"**Do not change the parameter value**\nAllows you to create software asset using the values of labels, manufacturers."}],"variable":[{"key":"sofware_unique_id","value":"cb642e1a-4bdc-4e1c-898c-3705c5592021","description":"Enter the unique ID of the software."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Apr 2023 07:09:53 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"software_version\": null,\n \"purpose\": null,\n \"number_of_assets\": null,\n \"approved_software\": null,\n \"software_type\": [\n \"Development Software\"\n ],\n \"operating_system\": [],\n \"unique_id\": \"cb642e1a-4bdc-4e1c-898c-3705c5592021\",\n \"created\": \"2023-04-26T06:56:21.845379Z\",\n \"modified\": \"2023-04-26T07:09:53.089495Z\",\n \"title\": \"Software Created from OpenAPI\",\n \"purchase_date\": null,\n \"expiry_date\": null,\n \"incidents\": [],\n \"incidents_data\": [],\n \"software_id\": \"1dce213dc137634\",\n \"vulnerabilities\": [],\n \"vulnerabilities_data\": [],\n \"readable_id\": \"SFT101\",\n \"labels\": [\n \"991184f0-3380-440c-83a5-c1616cba1aeb\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"991184f0-3380-440c-83a5-c1616cba1aeb\",\n \"title\": \"Blue Label Software\",\n \"color_code\": \"#00695C\",\n \"created\": \"2023-04-26T06:53:20.446108Z\",\n \"modified\": \"2023-04-26T06:53:20.446108Z\"\n }\n ],\n \"threat_actors\": [],\n \"threat_actors_data\": [],\n \"malwares\": [],\n \"malwares_data\": [],\n \"applications\": [],\n \"applications_data\": [],\n \"briefings\": [],\n \"briefings_data\": [],\n \"endpoints\": [],\n \"endpoints_data\": [],\n \"software_publisher_data\": {\n \"title\": \"Acer\",\n \"unique_id\": \"ed05f67c-b2f9-4d8a-a3c9-13d5da545b61\"\n },\n \"created_by\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"created_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"peter.smith@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"software_status\": \"active\",\n \"software_type_data\": [\n {\n \"unique_id\": \"aac42609-9a0a-4055-805a-45f05c16d88f\",\n \"option_name\": \"Development Software\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"1c6a7d8d-3ac2-4349-bf6f-b97959691eb5\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n ],\n \"operating_system_data\": [],\n \"approved_software_data\": null\n}"}],"_postman_id":"d2a83920-3e5a-4a22-91ae-aecce70efdd7"},{"name":"Add Comment in Software","id":"8463b154-cc7b-4ed7-ac3b-b0adcf153530","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"description\": \"

Note For software

\",\n \"mentioned_users_usernames\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/comments/asset-software/:software_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Add notes to a software in the CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`description`	String	Mandatory	Enter the content of the comment.
`mentioned_users_usernames`	List of UUID	Optional	Enter the list of usernames of users to be mentioned in the comment.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the comment.
`description`	Text	Content of the comment.
`created_by`	Object	Details of the user who added the comment.
`modified_by`	Object	Details of the user who last updated the comment.
`is_removed`	Boolean	Displays if the comment is removed or not.
`mentioned_users`	List of UUID	List of `user_id` of users mentioned in the comment.
`mentioned_users_data`	List of Objects	Details of the users mentioned in the comment.
`created`	String	Comment creation date and time.
`modified`	String	Comment last updated date and time.
`comment_type`	String	Type of Comment. Examples: `discussion`: Notes added in any instance.
`content_object`	String	Component in which the comment is added. Example: `software`, `incident`, `action`, `ioc`, and so on.
`content_object_readable_id`	String	`readable_id` of the instance in which comment is added
`content_object_unique_id`	String	`unique_id` of the instance in which comment is added
`description_with_img_src`	Text	Content of the comment with the image URLs (if any image is added in the comment).
`pinned`	Boolean	Displays if the comment is pinned or not.

","urlObject":{"path":["comments","asset-software",":software_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the software.

\n","type":"text/plain"},"type":"any","value":"8c670c6d-7cd6-4252-86ec-d40d1dc936cc","key":"software_unique_id"}]}},"response":[{"id":"fef84170-c605-4957-98a4-fafb34d0993a","name":"Add Comment in Software","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"description\": \"

Note For software

\",\n \"mentioned_users_usernames\": []\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/comments/asset-software/:software_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["comments","asset-software",":software_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"software_unique_id","value":"a416dde7-b196-4a29-b6b8-9ce9959a4f90","description":"Enter the unique ID of the software."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 28 Jan 2024 17:11:55 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"928","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Server","value":"gunicorn/19.10.0","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"unique_id\": \"5c16cd80-77e8-4699-a4e6-1667b8f16cba\",\n \"description\": \"

Note For software

\",\n \"created_by\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"modified_by\": null,\n \"is_removed\": false,\n \"mentioned_users\": [],\n \"mentioned_users_data\": [],\n \"created\": \"2024-01-28T17:11:55.122851Z\",\n \"modified\": \"2024-01-28T17:11:55.135711Z\",\n \"email\": null,\n \"internal\": false,\n \"comment_type\": \"discussion\",\n \"command_params\": {},\n \"command_result\": {},\n \"command_status\": \"na\",\n \"attachments_data\": [],\n \"content_object\": \"asset-software\",\n \"content_object_readable_id\": \"SFT116\",\n \"content_object_unique_id\": \"a416dde7-b196-4a29-b6b8-9ce9959a4f90\",\n \"attachment_label\": null,\n \"description_with_img_src\": \"

Note For software

\",\n \"pinned\": false,\n \"field\": null,\n \"note_tag\": null\n}"}],"_postman_id":"8463b154-cc7b-4ed7-ac3b-b0adcf153530"}],"id":"ac6e569f-7d80-4e7f-a4e3-8194718567c7","description":"

The Software module helps a security team to manage your organization’s software assets. You can evaluate, track, manage software licenses, compliance and optimization by assigning owners individually to all Software that are deployed and utilized in your organization’s environment. This helps a security team in ensuring that the Software asset is secure and configured properly with necessary response actions in order to quickly quarantine threats.

This section describes how to use the API endpoints to manage the software assets.

\n","_postman_id":"ac6e569f-7d80-4e7f-a4e3-8194718567c7"},{"name":"Users","item":[{"name":"List Asset Users","id":"54de161d-852c-466a-8463-c4ae2494259c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/general-user/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the details of a list of asset users in the CFTR Application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/general-user/?

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` key shows the API endpoint to the next page.
`count`	Integer	The total number of users returned as per the entered query parameters.
`results`	List of Objects	Details of the users. Each object provides the details of one user.

Response Parameters | Results Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the user.
`created`	String	Created date and time of the user.
`modified`	String	Last updated date and time of the user.
`employee_name`	String	Name of the user.
`email`	String	Email ID of the user.
`display_name`	String	Name of the user.
`readable_id`	String	Readable ID of the user.
`labels`	List	List of labels that are added to the user.
`labels_data`	List of Objects	Details of labels added to the user. The details include: `title`, `unique_id`, `color_code`, and so on.
`user_status`	String	Status of the user.
`threat_score`	Float	Risk score of the user.

[optional] Enter the page number of the user list. This will retrieve the list of all user from the entered page.\nDefault value: 1

\n","type":"text/plain"},"key":"page","value":"2"},{"disabled":true,"description":{"content":"

[optional] Number of users per page.\nDefault value: 10

\n","type":"text/plain"},"key":"page_size","value":"15"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID of the business unit. This parameter retrieves the user associated with the business unit.\nYou can retrieve the list of available Business Units and their Unique IDs using the following API endpoint:\n/openapi/v1/utils/business-unit/

\n","type":"text/plain"},"key":"business_units","value":"9750d6df-2d7f-4899-b20d-bfbba0a9084d"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the users in EPOCH Time format.\nTime Zone must be as per UTC. All users with creation date later than the entered time will be returned.

\n","type":"text/plain"},"key":"created_date__gte","value":"1643999399"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the users in EPOCH Time format.\nTime Zone must be as per UTC. All users with creation date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"created_date__lte","value":"1643999399"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID of the label. This parameter retrieves the users associated with the label.\nYou can retrieve the list of available Labels and their Unique IDs using the following API endpoint:\n/openapi/v1/utils/label/

\n","type":"text/plain"},"key":"labels","value":"c741bd45-1825-4dba-a30f-66088dcbbf8d"},{"disabled":true,"description":{"content":"

[optional] Enter the last modified time of the user in EPOCH Time format.\nTime Zone must be as per UTC. All devices with modified date later than the entered time will be returned.

\n","type":"text/plain"},"key":"modified_date__gte","value":"1643999399"},{"disabled":true,"description":{"content":"

[optional] Enter the last modified time of the user in EPOCH Time format.\nTime Zone must be as per UTC. All devices with modified date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"modified_date__lte","value":"1643999399"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID of the location. This parameter retrieves the users associated with the location..\nYou can retrieve the list of available Locations and their Unique IDs using the following API endpoint:\n/openapi/v1/utils/location/

\n","type":"text/plain"},"key":"locations","value":"671961e6-0119-460c-8d55-9b697f6e2d6e"},{"disabled":true,"description":{"content":"

[optional] Enter the status of the users to filter response results. \nAllowed values:\nactive, inactive

\n","type":"text/plain"},"key":"user_status","value":"active"}],"variable":[]}},"response":[{"id":"3d9f09e3-e908-41e2-916b-295fb6b601f8","name":"Get Users List","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/general-user/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["general-user",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"page","value":"2","description":"[optional] Enter the page number of the user list. This will retrieve the list of all user from the entered page.\nDefault value: 1","disabled":true},{"key":"page_size","value":"15","description":"[optional] Number of users per page.\nDefault value: 10","disabled":true},{"key":"business_units","value":"9750d6df-2d7f-4899-b20d-bfbba0a9084d","description":"[optional] Enter the unique ID of the business unit. This parameter retrieves the user associated with the business unit.\nYou can retrieve the list of available Business Units and their Unique IDs using the following API endpoint:\n/openapi/v1/utils/business-unit/","disabled":true},{"key":"created_date__gte","value":"1643999399","description":"[optional] Enter the creation time of the users in EPOCH Time format.\nTime Zone must be as per UTC. All users with creation date later than the entered time will be returned.","disabled":true},{"key":"created_date__lte","value":"1643999399","description":"[optional] Enter the creation time of the users in EPOCH Time format.\nTime Zone must be as per UTC. All users with creation date later than the entered time will be returned.","disabled":true},{"key":"labels","value":"c741bd45-1825-4dba-a30f-66088dcbbf8d","description":"[optional] Enter the unique ID of the label. This parameter retrieves the users associated with the label.\nYou can retrieve the list of available Labels and their Unique IDs using the following API endpoint:\n/openapi/v1/utils/label/","disabled":true},{"key":"modified_date__gte","value":"1643999399","description":"[optional] Enter the last modified time of the user in EPOCH Time format.\nTime Zone must be as per UTC. All devices with modified date later than the entered time will be returned.","disabled":true},{"key":"modified_date__lte","value":"1643999399","description":"[optional] Enter the last modified time of the user in EPOCH Time format.\nTime Zone must be as per UTC. All devices with modified date earlier than the entered time will be returned.","disabled":true},{"key":"locations","value":"671961e6-0119-460c-8d55-9b697f6e2d6e","description":"[optional] Enter the unique ID of the location. This parameter retrieves the users associated with the location..\nYou can retrieve the list of available Locations and their Unique IDs using the following API endpoint:\n/openapi/v1/utils/location/","disabled":true},{"key":"user_status","value":"active","description":"[optional] Enter the status of the applications to filter response results. \nAllowed values:\nactive, inactive","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jun 2022 14:00:16 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"6314","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {\n \"next\": \"openapi/v1/general-user/?page=2&page_size=10&AccessID=8b5e5c6e-f9db-4a94-80cd-5faf77b06429&Expires=1656338429&Signature=Z6/ejX+9FzwRweRGz3Z6dPEkxeQ=\"\n },\n \"count\": 292,\n \"results\": [\n {\n \"unique_id\": \"226086de-dff4-44dd-8f48-dbd4e6569eb4\",\n \"created\": \"2022-04-18T05:21:01.279956Z\",\n \"modified\": \"2022-06-27T04:41:55.062985Z\",\n \"employee_name\": \"test\",\n \"email\": \"test@gmail.com\",\n \"display_name\": \"test\",\n \"readable_id\": \"USR392\",\n \"labels\": [\n \"165c1c47-748e-4a0f-b1a5-88c119188824\",\n \"d64e4126-d371-4bc8-8ea0-d3791358c875\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"165c1c47-748e-4a0f-b1a5-88c119188824\",\n \"title\": \"Test\",\n \"color_code\": \"#DD2C00\",\n \"created\": \"2021-02-01T05:31:10.446686Z\",\n \"modified\": \"2021-02-01T05:31:10.446686Z\"\n },\n {\n \"unique_id\": \"d64e4126-d371-4bc8-8ea0-d3791358c875\",\n \"title\": \"tes\",\n \"color_code\": \"#D81B60\",\n \"created\": \"2021-04-05T11:09:13.949536Z\",\n \"modified\": \"2021-04-05T11:09:13.949536Z\"\n }\n ],\n \"user_status\": \"active\",\n \"threat_score\": 8.81\n },\n {\n \"unique_id\": \"8f28cd84-8074-4c7a-8818-ac5c0c67bebd\",\n \"created\": \"2022-02-04T14:45:26.128287Z\",\n \"modified\": \"2022-05-12T05:26:43.953086Z\",\n \"employee_name\": \"Bobby\",\n \"email\": \"cyware@cyware.com\",\n \"display_name\": \"Bobby\",\n \"readable_id\": \"USR390\",\n \"labels\": [\n \"f4be188e-4464-4d1d-9991-3adda500ce2b\",\n \"25a8ceaf-c2ec-4161-94f4-c281603d77a4\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"f4be188e-4464-4d1d-9991-3adda500ce2b\",\n \"title\": \"New QA\",\n \"color_code\": \"#43A047\",\n \"created\": \"2020-03-19T11:05:44.043777Z\",\n \"modified\": \"2020-03-19T11:05:44.044417Z\"\n },\n {\n \"unique_id\": \"25a8ceaf-c2ec-4161-94f4-c281603d77a4\",\n \"title\": \"User Label\",\n \"color_code\": \"#3432F2\",\n \"created\": \"2019-12-24T09:08:55.455957Z\",\n \"modified\": \"2019-12-24T09:08:55.456581Z\"\n }\n ],\n \"user_status\": \"active\",\n \"threat_score\": 9.93\n },\n {\n \"unique_id\": \"be3551cd-240c-4ae5-942f-406ac62f9801\",\n \"created\": \"2021-09-22T07:42:00.889788Z\",\n \"modified\": \"2022-04-20T11:09:29.563300Z\",\n \"employee_name\": \"Jacob Miller\",\n \"email\": \"regressiontest@cyware.com\",\n \"display_name\": \"Jacob Miller\",\n \"readable_id\": \"USR386\",\n \"labels\": [\n \"f4be188e-4464-4d1d-9991-3adda500ce2b\",\n \"25a8ceaf-c2ec-4161-94f4-c281603d77a4\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"f4be188e-4464-4d1d-9991-3adda500ce2b\",\n \"title\": \"New QA\",\n \"color_code\": \"#43A047\",\n \"created\": \"2020-03-19T11:05:44.043777Z\",\n \"modified\": \"2020-03-19T11:05:44.044417Z\"\n },\n {\n \"unique_id\": \"25a8ceaf-c2ec-4161-94f4-c281603d77a4\",\n \"title\": \"User Label\",\n \"color_code\": \"#3432F2\",\n \"created\": \"2019-12-24T09:08:55.455957Z\",\n \"modified\": \"2019-12-24T09:08:55.456581Z\"\n }\n ],\n \"user_status\": \"active\",\n \"threat_score\": 9.96\n },\n {\n \"unique_id\": \"923d1d5f-0a8c-4d19-b584-ca78f743a55d\",\n \"created\": \"2022-04-01T11:46:55.810059Z\",\n \"modified\": \"2022-04-01T11:46:55.893462Z\",\n \"employee_name\": \"Test CTD\",\n \"email\": \"test@gmail.com\",\n \"display_name\": \"Test CTD\",\n \"readable_id\": \"USR391\",\n \"labels\": [],\n \"labels_data\": [],\n \"user_status\": \"active\",\n \"threat_score\": null\n },\n {\n \"unique_id\": \"ed5170db-ad42-400c-80bc-881d25b0504e\",\n \"created\": \"2020-11-24T05:51:41.177269Z\",\n \"modified\": \"2022-03-29T12:46:34.389797Z\",\n \"employee_name\": \"Raymond\",\n \"email\": \"raymond@systemdefault.tld\",\n \"display_name\": \"Raymond\",\n \"readable_id\": \"USR337\",\n \"labels\": [],\n \"labels_data\": [],\n \"user_status\": \"inactive\",\n \"threat_score\": null\n },\n {\n \"unique_id\": \"a707d28c-58a8-4be1-bb54-1b92a7f96982\",\n \"created\": \"2021-09-22T07:43:58.562639Z\",\n \"modified\": \"2022-01-19T09:56:35.540720Z\",\n \"employee_name\": \"Emma Johnson\",\n \"email\": \"regression1@test.com\",\n \"display_name\": \"Emma Johnson\",\n \"readable_id\": \"USR388\",\n \"labels\": [\n \"1f878056-9ae1-4eb7-a003-fb8faeb6ef52\",\n \"fdc4bd01-7a07-481e-ae1b-0c2480eed9d9\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"1f878056-9ae1-4eb7-a003-fb8faeb6ef52\",\n \"title\": \"user-1\",\n \"color_code\": \"#344563\",\n \"created\": \"2021-08-04T11:55:58.695041Z\",\n \"modified\": \"2021-08-04T11:55:58.695041Z\"\n },\n {\n \"unique_id\": \"fdc4bd01-7a07-481e-ae1b-0c2480eed9d9\",\n \"title\": \"USR LBL\",\n \"color_code\": \"#52FE76\",\n \"created\": \"2019-09-17T08:18:17.312335Z\",\n \"modified\": \"2019-09-17T08:18:17.312883Z\"\n }\n ],\n \"user_status\": \"active\",\n \"threat_score\": 9.97\n },\n {\n \"unique_id\": \"6492d189-0abe-4672-bc91-91f08fe0ccd3\",\n \"created\": \"2020-08-07T03:44:40.509958Z\",\n \"modified\": \"2022-01-17T07:34:20.461513Z\",\n \"employee_name\": \"Daniel Brown\",\n \"email\": \"james.007@bond.com\",\n \"display_name\": \"Daniel Brown\",\n \"readable_id\": \"USR298\",\n \"labels\": [\n \"1f878056-9ae1-4eb7-a003-fb8faeb6ef52\",\n \"7bce206d-2689-482a-a3b4-69eb0786d9bb\",\n \"3185ca49-1426-4ca4-9ebd-8e48e05a51f3\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"1f878056-9ae1-4eb7-a003-fb8faeb6ef52\",\n \"title\": \"user-1\",\n \"color_code\": \"#344563\",\n \"created\": \"2021-08-04T11:55:58.695041Z\",\n \"modified\": \"2021-08-04T11:55:58.695041Z\"\n },\n {\n \"unique_id\": \"7bce206d-2689-482a-a3b4-69eb0786d9bb\",\n \"title\": \"user-3\",\n \"color_code\": \"#344563\",\n \"created\": \"2021-08-04T11:55:57.679529Z\",\n \"modified\": \"2021-08-04T11:55:57.679529Z\"\n },\n {\n \"unique_id\": \"3185ca49-1426-4ca4-9ebd-8e48e05a51f3\",\n \"title\": \"user-2\",\n \"color_code\": \"#344563\",\n \"created\": \"2021-08-04T11:55:59.990799Z\",\n \"modified\": \"2021-08-04T11:55:59.990799Z\"\n }\n ],\n \"user_status\": \"active\",\n \"threat_score\": 9.02\n },\n {\n \"unique_id\": \"dff2e2db-6d0b-455c-b442-476aeec60d03\",\n \"created\": \"2021-09-22T07:42:01.138757Z\",\n \"modified\": \"2021-12-02T16:31:42.094917Z\",\n \"employee_name\": \"Robert Smith\",\n \"email\": \"regressiontest@cyware.com\",\n \"display_name\": \"Robert Smith\",\n \"readable_id\": \"USR387\",\n \"labels\": [\n \"fdc4bd01-7a07-481e-ae1b-0c2480eed9d9\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"fdc4bd01-7a07-481e-ae1b-0c2480eed9d9\",\n \"title\": \"USR LBL\",\n \"color_code\": \"#52FE76\",\n \"created\": \"2019-09-17T08:18:17.312335Z\",\n \"modified\": \"2019-09-17T08:18:17.312883Z\"\n }\n ],\n \"user_status\": \"active\",\n \"threat_score\": 9.92\n },\n {\n \"unique_id\": \"605a0556-0d61-4717-9a01-0193958a3ef0\",\n \"created\": \"2021-07-19T14:26:24.721355Z\",\n \"modified\": \"2021-12-02T09:35:08.193940Z\",\n \"employee_name\": \"David Boon\",\n \"email\": \"david.boon@cyware.com\",\n \"display_name\": \"David Boon\",\n \"readable_id\": \"USR377\",\n \"labels\": [\n \"f4be188e-4464-4d1d-9991-3adda500ce2b\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"f4be188e-4464-4d1d-9991-3adda500ce2b\",\n \"title\": \"New QA\",\n \"color_code\": \"#43A047\",\n \"created\": \"2020-03-19T11:05:44.043777Z\",\n \"modified\": \"2020-03-19T11:05:44.044417Z\"\n }\n ],\n \"user_status\": \"active\",\n \"threat_score\": 7.71\n },\n {\n \"unique_id\": \"69bce416-480a-4b02-ac6d-ebb731076f7f\",\n \"created\": \"2021-09-22T07:43:58.822254Z\",\n \"modified\": \"2021-12-02T09:34:15.374499Z\",\n \"employee_name\": \"Tom Dill\",\n \"email\": \"regression2@test.com\",\n \"display_name\": \"Tom Dill\",\n \"readable_id\": \"USR389\",\n \"labels\": [\n \"f4be188e-4464-4d1d-9991-3adda500ce2b\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"f4be188e-4464-4d1d-9991-3adda500ce2b\",\n \"title\": \"New QA\",\n \"color_code\": \"#43A047\",\n \"created\": \"2020-03-19T11:05:44.043777Z\",\n \"modified\": \"2020-03-19T11:05:44.044417Z\"\n }\n ],\n \"user_status\": \"active\",\n \"threat_score\": 9.65\n }\n ]\n}"}],"_postman_id":"54de161d-852c-466a-8463-c4ae2494259c"},{"name":"Get Asset User Details","id":"a463ab03-ffd1-4947-9b03-c0a7f30abfdc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/general-user/:user_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the details of an asset user in the CFTR application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/general-user/:user_unique_id/?

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

Response Parameters | Regulatory Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the user.
`created`	String	User creation date and time.
`modified`	String	User last updated date and time.
`employee_name`	String	Name of the user.
`email`	String	Email ID of the user.
`display_name`	String	Name of the user.
`readable_id`	String	Readable ID of the user.
`user_status`	String	Current Status of the user.
`hire_date`	String	Hiring date of the user.
`created_by`	String	`user_id` of the CFTR user who created the asset user.
`created_by_data`	Object	Details of the CFTR user who created the asset user.
`labels`	List	List of `unique_id` of labels that are added to the user.
`labels_data`	List of Objects	Details of the labels that are added to the user.
`business_units_data`	List of Objects	Details of business units of the user.

Response Parameters | Connect The Dots

Following are the response parameters corresponding to the Connect The Dots section of the user. The parameters ending with _data include the meta information for each connected component. The non _data parameters include an array of unique IDs referencing the connected components.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`owned_applications`	Array of UUID Strings	List of `unique_id` of the applications owned by the user.
`owned_applications_data`	Array of Objects	Details of the applications owned by the user.
`managed_applications`	Array of UUID Strings	List of `unique_id` of the applications managed by the user.
`managed_applications_data`	Array of Objects	Details of the managed applications.
`managed_endpoints`	Array of UUID Strings	List of `unique_id` of the devices managed by the user.
`managed_endpoints_data`	Array of Objects	Details of the managed devices.
`owned_endpoints`	Array of UUID Strings	List of `unique_id` of the devices owned by the user.
`owned_endpoints_data`	Array of Objects	Details of the managed devices.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.

Response Parameters | Custom Fields

In addition to the above-mentioned parameters, the response parameters might vary as per the form configuration defined by your CFTR admin for users. For such parameters, the field_readable_key of each parameter is returned in the response. To retrieve the field_readable_key and additional metadata of a parameter, use the Form Tab Structure API for users.

Example

The following endpoint retrieves the field_readable_key for all custom fields in the user component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=general-user\n\n

Following are some of the sample custom fields for users:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`supervisor_employee_code`	String	Optional

","urlObject":{"path":["general-user",":user_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"type":"any","value":"226086de-dff4-44dd-8f48-dbd4e6569eb4","key":"user_unique_id"}]}},"response":[{"id":"9b227d26-7cf0-41cd-9435-83f79c185220","name":"Get Details of a User","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/general-user/:user_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["general-user",":user_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"user_unique_id","value":"226086de-dff4-44dd-8f48-dbd4e6569eb4"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jun 2022 16:57:21 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"6618","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"phone_number\": null,\n \"test4\": \"w\",\n \"title\": null,\n \"supervisor_employee_code\": null,\n \"hr_employee_code\": null,\n \"Test2\": null,\n \"test3\": null,\n \"test\": null,\n \"grade\": null,\n \"unique_id\": \"226086de-dff4-44dd-8f48-dbd4e6569eb4\",\n \"created\": \"2022-04-18T05:21:01.279956Z\",\n \"modified\": \"2022-06-27T04:41:55.062985Z\",\n \"employee_code\": \"12\",\n \"employee_name\": \"test\",\n \"email\": \"test@gmail.com\",\n \"hire_date\": null,\n \"last_working_date\": null,\n \"incidents\": [\n \"76ef210f-627a-4764-a30b-f66e175be0ba\",\n \"57ef14c9-718e-44b7-870f-db63a417bede\",\n \"6201b5a3-6a92-4bda-874b-b9799c6c77a0\",\n \"d9b792a6-0aae-432d-9664-a84abe25921d\",\n \"5ab2a05f-dcac-465b-8364-aef68ee3e6b4\",\n \"4d3bde86-48ce-47b8-b2f7-5c020a23ae3d\"\n ],\n \"incidents_data\": [\n {\n \"unique_id\": \"76ef210f-627a-4764-a30b-f66e175be0ba\",\n \"readable_id\": \"CAS238058\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"Inc v1.0 play sysgen > 11111\",\n \"status\": \"open\",\n \"created\": \"2022-02-28T23:01:31.079565Z\",\n \"modified\": \"2022-06-15T18:05:22.690316Z\",\n \"title_display\": \"Inc v1.0 play sysgen > 11111\",\n \"severity_title\": \"Critical\"\n },\n {\n \"unique_id\": \"5ab2a05f-dcac-465b-8364-aef68ee3e6b4\",\n \"readable_id\": \"MOD240779\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"ATM Pin Compromised\",\n \"status\": \"untriaged\",\n \"created\": \"2022-04-17T18:37:46.065780Z\",\n \"modified\": \"2022-06-13T13:32:48.043841Z\",\n \"title_display\": \"ATM Pin Compromised\",\n \"severity_title\": null\n },\n {\n \"unique_id\": \"57ef14c9-718e-44b7-870f-db63a417bede\",\n \"readable_id\": \"MOD106475\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"Test RDD\",\n \"status\": \"open\",\n \"created\": \"2021-11-08T07:58:24.730179Z\",\n \"modified\": \"2022-06-06T07:06:01.471420Z\",\n \"title_display\": \"Test RDD\",\n \"severity_title\": \"Critical\"\n },\n {\n \"unique_id\": \"4d3bde86-48ce-47b8-b2f7-5c020a23ae3d\",\n \"readable_id\": \"MOD240813\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 10/05/2022: 10:43\",\n \"status\": \"open\",\n \"created\": \"2022-05-10T05:13:34.669973Z\",\n \"modified\": \"2022-05-10T12:30:01.872739Z\",\n \"title_display\": \"New Incident on 10/05/2022: 10:43\",\n \"severity_title\": null\n }\n ],\n \"display_name\": \"test\",\n \"readable_id\": \"USR392\",\n \"labels\": [\n \"165c1c47-748e-4a0f-b1a5-88c119188824\",\n \"d64e4126-d371-4bc8-8ea0-d3791358c875\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"165c1c47-748e-4a0f-b1a5-88c119188824\",\n \"title\": \"Test\",\n \"color_code\": \"#DD2C00\",\n \"created\": \"2021-02-01T05:31:10.446686Z\",\n \"modified\": \"2021-02-01T05:31:10.446686Z\"\n },\n {\n \"unique_id\": \"d64e4126-d371-4bc8-8ea0-d3791358c875\",\n \"title\": \"tes\",\n \"color_code\": \"#D81B60\",\n \"created\": \"2021-04-05T11:09:13.949536Z\",\n \"modified\": \"2021-04-05T11:09:13.949536Z\"\n }\n ],\n \"briefings\": [\n \"48e62902-cedc-4354-8141-2d1cccebc03b\",\n \"ec82966f-13f5-4002-b6f8-d9079bb1edbe\"\n ],\n \"briefings_data\": [\n {\n \"unique_id\": \"48e62902-cedc-4354-8141-2d1cccebc03b\",\n \"readable_id\": \"BRF246\",\n \"title\": \"test title\",\n \"created\": \"2022-02-28T06:04:11.535282Z\",\n \"modified\": \"2022-05-13T17:21:19.124560Z\",\n \"title_display\": \"test title\",\n \"status\": \"ACTIVE\"\n },\n {\n \"unique_id\": \"ec82966f-13f5-4002-b6f8-d9079bb1edbe\",\n \"readable_id\": \"BRF167\",\n \"title\": \"Regress BRF1261\",\n \"created\": \"2020-07-29T20:20:24.793370Z\",\n \"modified\": \"2022-06-16T09:59:37.311938Z\",\n \"title_display\": \"Regress BRF1261\",\n \"status\": \"ACTIVE\"\n }\n ],\n \"owned_applications\": [],\n \"owned_applications_data\": [],\n \"managed_applications\": [\n \"c234bda4-a134-493b-9445-a535c63358ba\",\n \"5153a63c-b460-4b20-b0c5-d508d847759e\"\n ],\n \"managed_applications_data\": [\n {\n \"unique_id\": \"c234bda4-a134-493b-9445-a535c63358ba\",\n \"created\": \"2022-04-18T05:02:46.475616Z\",\n \"modified\": \"2022-06-13T13:26:21.860741Z\",\n \"title\": \"test\",\n \"production_date\": null,\n \"readable_id\": \"APL256\",\n \"title_display\": \"test\",\n \"status\": \"inactive\"\n },\n {\n \"unique_id\": \"5153a63c-b460-4b20-b0c5-d508d847759e\",\n \"created\": \"2022-03-01T07:39:21.252456Z\",\n \"modified\": \"2022-04-14T10:20:02.889703Z\",\n \"title\": \"app_1\",\n \"production_date\": null,\n \"readable_id\": \"APL255\",\n \"title_display\": \"app_1\",\n \"status\": \"active\"\n }\n ],\n \"owned_endpoints\": [\n \"e73405b9-7a10-42dc-9ad2-ae8190b0d94a\",\n \"d1de692c-d9a7-4a5f-ba5c-d6a62f79830d\",\n \"9f3f1522-6bd6-449a-a1b1-d25241e38da9\",\n \"9c06616f-0af9-481c-a8d1-96cb696f7a9b\",\n \"8b2bd600-3e28-48a5-8e75-a34db36b2dca\",\n \"098f82dc-a44f-420a-9699-e8b90a903b9c\"\n ],\n \"owned_endpoints_data\": [\n {\n \"unique_id\": \"e73405b9-7a10-42dc-9ad2-ae8190b0d94a\",\n \"created\": \"2022-06-07T10:50:42.162926Z\",\n \"modified\": \"2022-06-07T10:50:42.229389Z\",\n \"hostname\": \"DS Test-511\",\n \"serial_number\": null,\n \"readable_id\": \"DVC35661\",\n \"title_display\": \"DS Test-511\",\n \"ip_address\": null,\n \"mac_address\": null,\n \"endpoint_status\": \"clean\"\n },\n {\n \"unique_id\": \"d1de692c-d9a7-4a5f-ba5c-d6a62f79830d\",\n \"created\": \"2022-06-07T10:50:45.822824Z\",\n \"modified\": \"2022-06-16T11:16:19.215524Z\",\n \"hostname\": \"DS Test-529\",\n \"serial_number\": null,\n \"readable_id\": \"DVC35663\",\n \"title_display\": \"DS Test-529\",\n \"ip_address\": null,\n \"mac_address\": null,\n \"endpoint_status\": \"clean\"\n },\n {\n \"unique_id\": \"9f3f1522-6bd6-449a-a1b1-d25241e38da9\",\n \"created\": \"2022-06-07T10:50:47.537691Z\",\n \"modified\": \"2022-06-13T07:10:08.450034Z\",\n \"hostname\": \"DS Test-882\",\n \"serial_number\": \"abcd\",\n \"readable_id\": \"DVC35664\",\n \"title_display\": \"DS Test-882\",\n \"ip_address\": null,\n \"mac_address\": null,\n \"endpoint_status\": \"inactive\"\n },\n {\n \"unique_id\": \"9c06616f-0af9-481c-a8d1-96cb696f7a9b\",\n \"created\": \"2022-06-13T07:11:18.777955Z\",\n \"modified\": \"2022-06-13T07:11:18.828979Z\",\n \"hostname\": \"Regresssion Test-1\",\n \"serial_number\": null,\n \"readable_id\": \"DVC35665\",\n \"title_display\": \"Regresssion Test-1\",\n \"ip_address\": null,\n \"mac_address\": null,\n \"endpoint_status\": \"clean\"\n },\n {\n \"unique_id\": \"8b2bd600-3e28-48a5-8e75-a34db36b2dca\",\n \"created\": \"2022-06-13T07:20:30.987251Z\",\n \"modified\": \"2022-06-27T12:14:27.114365Z\",\n \"hostname\": \"Regression Test 2\",\n \"serial_number\": \"1.2.3.4.52342\",\n \"readable_id\": \"DVC35666\",\n \"title_display\": \"Regression Test 2\",\n \"ip_address\": \"1.2.3.4\",\n \"mac_address\": null,\n \"endpoint_status\": \"clean\"\n },\n {\n \"unique_id\": \"098f82dc-a44f-420a-9699-e8b90a903b9c\",\n \"created\": \"2022-06-16T11:31:01.471648Z\",\n \"modified\": \"2022-06-16T12:30:42.633412Z\",\n \"hostname\": \"test trial\",\n \"serial_number\": null,\n \"readable_id\": \"DVC35667\",\n \"title_display\": \"test trial\",\n \"ip_address\": \"1.4.2.6\",\n \"mac_address\": null,\n \"endpoint_status\": \"clean\"\n }\n ],\n \"managed_endpoints\": [\n \"098f82dc-a44f-420a-9699-e8b90a903b9c\"\n ],\n \"managed_endpoints_data\": [\n {\n \"unique_id\": \"098f82dc-a44f-420a-9699-e8b90a903b9c\",\n \"created\": \"2022-06-16T11:31:01.471648Z\",\n \"modified\": \"2022-06-16T12:30:42.633412Z\",\n \"hostname\": \"test trial\",\n \"serial_number\": null,\n \"readable_id\": \"DVC35667\",\n \"title_display\": \"test trial\",\n \"ip_address\": \"1.4.2.6\",\n \"mac_address\": null,\n \"endpoint_status\": \"clean\"\n }\n ],\n \"business_units_data\": [\n {\n \"title\": \"1-Profitable BU12\",\n \"unique_id\": \"6ad8348e-5d5e-42c5-ac0c-8ae8f8708532\"\n }\n ],\n \"created_by\": \"c9cbb792-148f-43ab-af2b-5ded13c788d2\",\n \"created_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"user_status\": \"active\",\n \"threat_score\": 8.81,\n \"grade_data\": null,\n \"test_data\": null\n}"}],"_postman_id":"a463ab03-ffd1-4947-9b03-c0a7f30abfdc"},{"name":"Create Asset User Using Field UUID","id":"ce05ef9f-0a00-4f4f-a777-ae69d44c0d70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"employee_code\": \"EMP_111\",\n \"employee_name\": \"Test Empployee from openapi\",\n \"email\": \"test@organsation.com\",\n \"test4\": \"sdwd\",\n \"business_units\": [\"990b8401-9a8e-47cb-9b7f-67668dccf9c4\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/general-user/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Add a new asset user in the CFTR application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/general-user/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
employee_code	String	Mandatory	Enter the employee code of the user.
employee_name	String	Mandatory	Enter the name of the user.
`business_units`	List	Mandatory	Enter the list of `unique_id` of Business Units of the user. You can retrieve the list of available Business Units and their Unique IDs using the following API endpoint: `/openapi/v1/utils/business-unit/`
`user_status`	String	Optional	Enter the status of the user. Allowed Values: - active - inactive Default value: \"active\"

Request Parameters | Custom Form Fields

In addition to the above-mentioned parameters, the response parameters might vary as per the form configuration defined by your CFTR admin for users. For such parameters, use the field_readable_key of each parameter. To retrieve the field_readable_key and additional metadata of a parameter, use the Form Tab Structure API for users.

Example

The following endpoint retrieves the field_readable_key for all custom fields in the user component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=general-user\n\n

Following are some of the sample custom fields for devices:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`supervisor_employee_code`	String	Optional

Response Parameters

Response Parameters | Regulatory Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the user.
`created`	String	User creation date and time.
`modified`	String	User last updated date and time.
`employee_name`	String	Name of the user.
`email`	String	Email ID of the user.
`display_name`	String	Name of the user.
`readable_id`	String	Readable ID of the user.
`user_status`	String	Current Status of the user.
`hire_date`	String	Hiring date of the user.
`created_by`	String	`user_id` of the CFTR user who created the asset user.
`created_by_data`	Object	Details of the CFTR user who created the asset user.
`labels`	List	List of `unique_id` of labels that are added to the user.
`labels_data`	List of Objects	Details of the labels that are added to the user.
`business_units_data`	List of Objects	Details of business units of the user.

Response Parameters | Connect The Dots

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`owned_applications`	Array of UUID Strings	List of `unique_id` of the applications owned by the user.
`owned_applications_data`	Array of Objects	Details of the applications owned by the user.
`managed_applications`	Array of UUID Strings	List of `unique_id` of the applications managed by the user.
`managed_applications_data`	Array of Objects	Details of the managed applications.
`managed_endpoints`	Array of UUID Strings	List of `unique_id` of the devices managed by the user.
`managed_endpoints_data`	Array of Objects	Details of the managed devices.
`owned_endpoints`	Array of UUID Strings	List of `unique_id` of the devices owned by the user.
`owned_endpoints_data`	Array of Objects	Details of the managed devices.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.

Response Parameters | Custom Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the user component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=general-user\n\n

Following are some of the sample custom fields for users:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`supervisor_employee_code`	String	Optional

","urlObject":{"path":["general-user",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"9e39fd80-b046-422d-819d-5700f5c5b7bd","name":"201 Created: Create A User","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"employee_code\": \"EMP_111\",\n \"employee_name\": \"Test Empployee from openapi\",\n \"email\": \"test@organsation.com\",\n \"test4\": \"sdwd\",\n \"business_units\": [\"990b8401-9a8e-47cb-9b7f-67668dccf9c4\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/general-user/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["general-user",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jun 2022 17:26:36 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1289","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"phone_number\": null,\n \"test4\": \"sdwd\",\n \"title\": null,\n \"supervisor_employee_code\": null,\n \"hr_employee_code\": null,\n \"Test2\": null,\n \"test3\": null,\n \"test\": null,\n \"grade\": null,\n \"unique_id\": \"0a434598-fe65-447f-be4f-56baa470896a\",\n \"created\": \"2022-06-27T17:26:35.550943Z\",\n \"modified\": \"2022-06-27T17:26:35.620283Z\",\n \"employee_code\": \"EMP_111\",\n \"employee_name\": \"Test Empployee from openapi\",\n \"email\": \"test@organsation.com\",\n \"hire_date\": null,\n \"last_working_date\": null,\n \"incidents\": [],\n \"incidents_data\": [],\n \"display_name\": \"Test Empployee from openapi\",\n \"readable_id\": \"USR393\",\n \"labels\": [],\n \"labels_data\": [],\n \"briefings\": [],\n \"briefings_data\": [],\n \"owned_applications\": [],\n \"owned_applications_data\": [],\n \"managed_applications\": [],\n \"managed_applications_data\": [],\n \"owned_endpoints\": [],\n \"owned_endpoints_data\": [],\n \"managed_endpoints\": [],\n \"managed_endpoints_data\": [],\n \"business_units_data\": [\n {\n \"title\": \"Alpine Starlight\",\n \"unique_id\": \"990b8401-9a8e-47cb-9b7f-67668dccf9c4\"\n }\n ],\n \"created_by\": \"830ae605-1209-47dd-8382-eded47622436\",\n \"created_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"user_status\": \"active\",\n \"threat_score\": null,\n \"grade_data\": null,\n \"test_data\": null\n}"}],"_postman_id":"ce05ef9f-0a00-4f4f-a777-ae69d44c0d70"},{"name":"Create Asset User Using Field Values","id":"4210ac75-2ea2-49ca-8f17-a70141446452","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"employee_code\": \"EMP_111\",\n \"employee_name\": \"Test Employee from openapi\",\n \"email\": \"test@organsation.com\",\n \"test4\": \"sdwd\",\n \"business_units\": [\"Bu 1\"],\n \"labels\": [\"Red Label User\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/general-user/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","description":"

Add a new asset user in the CFTR application using the values of labels and business units.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/general-user/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`employee_code`	String	Mandatory	Enter the employee code of the user.
`employee_name`	String	Mandatory	Enter the name of the user.
`business_units`	List	Mandatory	Enter the list of names of Business Units of the user. You can retrieve the list of available Business Units and their names using the following API endpoint: `/openapi/v1/utils/business-unit/`
`user_status`	String	Optional	Enter the status of the user. Allowed Values: - active - inactive Default value: \"active\"
`labels`	List	Optional	Enter the list of names of the labels to be attached to the asset user. You can use the following API endpoint to retrieve the list of Labels: `/openapi/v1/utils/label/`

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the user component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=general-user\n\n

Following are some of the sample custom fields for devices:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`supervisor_employee_code`	String	Optional

Response Parameters

Response Parameters | Regulatory Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the user.
`created`	String	User creation date and time.
`modified`	String	User last updated date and time.
`employee_name`	String	Name of the user.
`email`	String	Email ID of the user.
`display_name`	String	Name of the user.
`readable_id`	String	Readable ID of the user.
`user_status`	String	Current Status of the user.
`hire_date`	String	Hiring date of the user.
`created_by`	String	`user_id` of the CFTR user who created the asset user.
`created_by_data`	Object	Details of the CFTR user who created the asset user.
`labels`	List	List of `unique_id` of labels that are added to the user.
`labels_data`	List of Objects	Details of the labels that are added to the user.
`business_units_data`	List of Objects	Details of business units of the user.

Response Parameters | Connect The Dots

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`owned_applications`	Array of UUID Strings	List of `unique_id` of the applications owned by the user.
`owned_applications_data`	Array of Objects	Details of the applications owned by the user.
`managed_applications`	Array of UUID Strings	List of `unique_id` of the applications managed by the user.
`managed_applications_data`	Array of Objects	Details of the managed applications.
`managed_endpoints`	Array of UUID Strings	List of `unique_id` of the devices managed by the user.
`managed_endpoints_data`	Array of Objects	Details of the managed devices.
`owned_endpoints`	Array of UUID Strings	List of `unique_id` of the devices owned by the user.
`owned_endpoints_data`	Array of Objects	Details of the managed devices.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.

Response Parameters | Custom Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the user component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=general-user\n\n

Following are some of the sample custom fields for users:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`supervisor_employee_code`	String	Optional

Do not change the parameter value\nAllows you to create asset using the values of labels, business units.

\n","type":"text/plain"},"key":"values","value":"readable_type"}],"variable":[]}},"response":[{"id":"42265833-d7de-4f45-8c37-fefae1e10114","name":"201 Created: Create Asset User Using Field","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"employee_code\": \"EMP_111\",\n \"employee_name\": \"Test Employee from openapi\",\n \"email\": \"test@organsation.com\",\n \"test4\": \"sdwd\",\n \"business_units\": [\"Bu 1\"],\n \"labels\": [\"Red Label User\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/general-user/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","host":["{{base_url}}v1"],"path":["general-user",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"values","value":"readable_type","description":"**Do not change the parameter value**\nAllows you to create asset using the values of labels, business units."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Apr 2023 07:42:20 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1449","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"title\": null,\n \"phone_number\": null,\n \"supervisor_employee_code\": null,\n \"hr_employee_code\": null,\n \"grade\": null,\n \"unique_id\": \"54511aa2-6e20-401f-b274-3a256353b612\",\n \"created\": \"2023-04-26T07:42:18.526714Z\",\n \"modified\": \"2023-04-26T07:42:18.918757Z\",\n \"employee_code\": \"EMP_111\",\n \"employee_name\": \"Test Employee from openapi\",\n \"email\": \"test@organsation.com\",\n \"hire_date\": null,\n \"last_working_date\": null,\n \"incidents\": [],\n \"incidents_data\": [],\n \"display_name\": \"Test Employee from openapi\",\n \"readable_id\": \"USR103\",\n \"labels\": [\n \"e5517df4-4dd7-4d1e-81f2-648b2fb6bcf3\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"e5517df4-4dd7-4d1e-81f2-648b2fb6bcf3\",\n \"title\": \"Red Label User\",\n \"color_code\": \"#2E7D32\",\n \"created\": \"2023-04-26T07:34:18.035225Z\",\n \"modified\": \"2023-04-26T07:34:18.035225Z\"\n }\n ],\n \"briefings\": [],\n \"briefings_data\": [],\n \"owned_applications\": [],\n \"owned_applications_data\": [],\n \"managed_applications\": [],\n \"managed_applications_data\": [],\n \"owned_endpoints\": [],\n \"owned_endpoints_data\": [],\n \"managed_endpoints\": [],\n \"managed_endpoints_data\": [],\n \"business_units_data\": [\n {\n \"title\": \"Bu 1\",\n \"unique_id\": \"f9d39c5a-0fe0-4ee8-bdb6-2e5f8b2fc35c\"\n }\n ],\n \"created_by\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"created_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"peter.smith@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"user_status\": \"active\",\n \"threat_score\": null,\n \"grade_data\": null\n}"}],"_postman_id":"4210ac75-2ea2-49ca-8f17-a70141446452"},{"name":"Update Asset User Using Field UUID","id":"e0a6a511-df92-47f7-a7f0-63efbf630040","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user_status\": \"inactive\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/general-user/:user_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Update the details of an asset user in the CFTR application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/general-user/:user_unique_id/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
employee_code	String	Mandatory	Enter the employee code of the user.
employee_name	String	Mandatory	Enter the name of the user.
`business_units`	List	Mandatory	Enter the list of `unique_id` of Business Units of the user. You can retrieve the list of available Business Units and their Unique IDs using the following API endpoint: `/openapi/v1/utils/business-unit/`
`user_status`	String	Optional	Enter the status of the user. Allowed Values: - active - inactive Default value: \"active\"

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the user component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=general-user\n\n

Following are some of the sample custom fields for devices:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`supervisor_employee_code`	String	Optional

Response Parameters

Response Parameters | Regulatory Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the user.
`created`	String	User creation date and time.
`modified`	String	User last updated date and time.
`employee_name`	String	Name of the user.
`email`	String	Email ID of the user.
`display_name`	String	Name of the user.
`readable_id`	String	Readable ID of the user.
`user_status`	String	Current Status of the user.
`hire_date`	String	Hiring date of the user.
`created_by`	String	`user_id` of the CFTR user who created the asset user.
`created_by_data`	Object	Details of the CFTR user who created the asset user.
`labels`	List	List of `unique_id` of labels that are added to the user.
`labels_data`	List of Objects	Details of the labels that are added to the user.
`business_units_data`	List of Objects	Details of business units of the user.

Response Parameters | Connect The Dots

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`owned_applications`	Array of UUID Strings	List of `unique_id` of the applications owned by the user.
`owned_applications_data`	Array of Objects	Details of the applications owned by the user.
`managed_applications`	Array of UUID Strings	List of `unique_id` of the applications managed by the user.
`managed_applications_data`	Array of Objects	Details of the managed applications.
`managed_endpoints`	Array of UUID Strings	List of `unique_id` of the devices managed by the user.
`managed_endpoints_data`	Array of Objects	Details of the managed devices.
`owned_endpoints`	Array of UUID Strings	List of `unique_id` of the devices owned by the user.
`owned_endpoints_data`	Array of Objects	Details of the managed devices.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.

Response Parameters | Custom Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the user component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=general-user\n\n

Following are some of the sample custom fields for users:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`supervisor_employee_code`	String	Optional

","urlObject":{"path":["general-user",":user_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"type":"any","value":"226086de-dff4-44dd-8f48-dbd4e6569eb4","key":"user_unique_id"}]}},"response":[{"id":"2e2d9694-22cb-4367-92ec-2b868c33881d","name":"200 OK: Update User","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"user_status\": \"inactive\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/general-user/:user_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["general-user",":user_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"user_unique_id","value":"226086de-dff4-44dd-8f48-dbd4e6569eb4"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jun 2022 17:41:09 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"6620","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"phone_number\": null,\n \"test4\": \"w\",\n \"title\": null,\n \"supervisor_employee_code\": null,\n \"hr_employee_code\": null,\n \"Test2\": null,\n \"test3\": null,\n \"test\": null,\n \"grade\": null,\n \"unique_id\": \"226086de-dff4-44dd-8f48-dbd4e6569eb4\",\n \"created\": \"2022-04-18T05:21:01.279956Z\",\n \"modified\": \"2022-06-27T17:41:08.502454Z\",\n \"employee_code\": \"12\",\n \"employee_name\": \"test\",\n \"email\": \"test@gmail.com\",\n \"hire_date\": null,\n \"last_working_date\": null,\n \"incidents\": [\n \"76ef210f-627a-4764-a30b-f66e175be0ba\",\n \"57ef14c9-718e-44b7-870f-db63a417bede\",\n \"6201b5a3-6a92-4bda-874b-b9799c6c77a0\",\n \"d9b792a6-0aae-432d-9664-a84abe25921d\",\n \"5ab2a05f-dcac-465b-8364-aef68ee3e6b4\",\n \"4d3bde86-48ce-47b8-b2f7-5c020a23ae3d\"\n ],\n \"incidents_data\": [\n {\n \"unique_id\": \"76ef210f-627a-4764-a30b-f66e175be0ba\",\n \"readable_id\": \"CAS238058\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"Inc v1.0 play sysgen > 11111\",\n \"status\": \"open\",\n \"created\": \"2022-02-28T23:01:31.079565Z\",\n \"modified\": \"2022-06-15T18:05:22.690316Z\",\n \"title_display\": \"Inc v1.0 play sysgen > 11111\",\n \"severity_title\": \"Critical\"\n },\n {\n \"unique_id\": \"5ab2a05f-dcac-465b-8364-aef68ee3e6b4\",\n \"readable_id\": \"MOD240779\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"ATM Pin Compromised\",\n \"status\": \"untriaged\",\n \"created\": \"2022-04-17T18:37:46.065780Z\",\n \"modified\": \"2022-06-13T13:32:48.043841Z\",\n \"title_display\": \"ATM Pin Compromised\",\n \"severity_title\": null\n },\n {\n \"unique_id\": \"57ef14c9-718e-44b7-870f-db63a417bede\",\n \"readable_id\": \"MOD106475\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"Test RDD\",\n \"status\": \"open\",\n \"created\": \"2021-11-08T07:58:24.730179Z\",\n \"modified\": \"2022-06-06T07:06:01.471420Z\",\n \"title_display\": \"Test RDD\",\n \"severity_title\": \"Critical\"\n },\n {\n \"unique_id\": \"4d3bde86-48ce-47b8-b2f7-5c020a23ae3d\",\n \"readable_id\": \"MOD240813\",\n \"080f2e09-2dfd-47d2-8890-8838329ca2bb\": \"New Incident on 10/05/2022: 10:43\",\n \"status\": \"open\",\n \"created\": \"2022-05-10T05:13:34.669973Z\",\n \"modified\": \"2022-05-10T12:30:01.872739Z\",\n \"title_display\": \"New Incident on 10/05/2022: 10:43\",\n \"severity_title\": null\n }\n ],\n \"display_name\": \"test\",\n \"readable_id\": \"USR392\",\n \"labels\": [\n \"165c1c47-748e-4a0f-b1a5-88c119188824\",\n \"d64e4126-d371-4bc8-8ea0-d3791358c875\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"165c1c47-748e-4a0f-b1a5-88c119188824\",\n \"title\": \"Test\",\n \"color_code\": \"#DD2C00\",\n \"created\": \"2021-02-01T05:31:10.446686Z\",\n \"modified\": \"2021-02-01T05:31:10.446686Z\"\n },\n {\n \"unique_id\": \"d64e4126-d371-4bc8-8ea0-d3791358c875\",\n \"title\": \"tes\",\n \"color_code\": \"#D81B60\",\n \"created\": \"2021-04-05T11:09:13.949536Z\",\n \"modified\": \"2021-04-05T11:09:13.949536Z\"\n }\n ],\n \"briefings\": [\n \"48e62902-cedc-4354-8141-2d1cccebc03b\",\n \"ec82966f-13f5-4002-b6f8-d9079bb1edbe\"\n ],\n \"briefings_data\": [\n {\n \"unique_id\": \"48e62902-cedc-4354-8141-2d1cccebc03b\",\n \"readable_id\": \"BRF246\",\n \"title\": \"test title\",\n \"created\": \"2022-02-28T06:04:11.535282Z\",\n \"modified\": \"2022-05-13T17:21:19.124560Z\",\n \"title_display\": \"test title\",\n \"status\": \"ACTIVE\"\n },\n {\n \"unique_id\": \"ec82966f-13f5-4002-b6f8-d9079bb1edbe\",\n \"readable_id\": \"BRF167\",\n \"title\": \"Regress BRF1261\",\n \"created\": \"2020-07-29T20:20:24.793370Z\",\n \"modified\": \"2022-06-16T09:59:37.311938Z\",\n \"title_display\": \"Regress BRF1261\",\n \"status\": \"ACTIVE\"\n }\n ],\n \"owned_applications\": [],\n \"owned_applications_data\": [],\n \"managed_applications\": [\n \"c234bda4-a134-493b-9445-a535c63358ba\",\n \"5153a63c-b460-4b20-b0c5-d508d847759e\"\n ],\n \"managed_applications_data\": [\n {\n \"unique_id\": \"c234bda4-a134-493b-9445-a535c63358ba\",\n \"created\": \"2022-04-18T05:02:46.475616Z\",\n \"modified\": \"2022-06-13T13:26:21.860741Z\",\n \"title\": \"test\",\n \"production_date\": null,\n \"readable_id\": \"APL256\",\n \"title_display\": \"test\",\n \"status\": \"inactive\"\n },\n {\n \"unique_id\": \"5153a63c-b460-4b20-b0c5-d508d847759e\",\n \"created\": \"2022-03-01T07:39:21.252456Z\",\n \"modified\": \"2022-04-14T10:20:02.889703Z\",\n \"title\": \"app_1\",\n \"production_date\": null,\n \"readable_id\": \"APL255\",\n \"title_display\": \"app_1\",\n \"status\": \"active\"\n }\n ],\n \"owned_endpoints\": [\n \"e73405b9-7a10-42dc-9ad2-ae8190b0d94a\",\n \"d1de692c-d9a7-4a5f-ba5c-d6a62f79830d\",\n \"9f3f1522-6bd6-449a-a1b1-d25241e38da9\",\n \"9c06616f-0af9-481c-a8d1-96cb696f7a9b\",\n \"8b2bd600-3e28-48a5-8e75-a34db36b2dca\",\n \"098f82dc-a44f-420a-9699-e8b90a903b9c\"\n ],\n \"owned_endpoints_data\": [\n {\n \"unique_id\": \"e73405b9-7a10-42dc-9ad2-ae8190b0d94a\",\n \"created\": \"2022-06-07T10:50:42.162926Z\",\n \"modified\": \"2022-06-07T10:50:42.229389Z\",\n \"hostname\": \"DS Test-511\",\n \"serial_number\": null,\n \"readable_id\": \"DVC35661\",\n \"title_display\": \"DS Test-511\",\n \"ip_address\": null,\n \"mac_address\": null,\n \"endpoint_status\": \"clean\"\n },\n {\n \"unique_id\": \"d1de692c-d9a7-4a5f-ba5c-d6a62f79830d\",\n \"created\": \"2022-06-07T10:50:45.822824Z\",\n \"modified\": \"2022-06-16T11:16:19.215524Z\",\n \"hostname\": \"DS Test-529\",\n \"serial_number\": null,\n \"readable_id\": \"DVC35663\",\n \"title_display\": \"DS Test-529\",\n \"ip_address\": null,\n \"mac_address\": null,\n \"endpoint_status\": \"clean\"\n },\n {\n \"unique_id\": \"9f3f1522-6bd6-449a-a1b1-d25241e38da9\",\n \"created\": \"2022-06-07T10:50:47.537691Z\",\n \"modified\": \"2022-06-13T07:10:08.450034Z\",\n \"hostname\": \"DS Test-882\",\n \"serial_number\": \"abcd\",\n \"readable_id\": \"DVC35664\",\n \"title_display\": \"DS Test-882\",\n \"ip_address\": null,\n \"mac_address\": null,\n \"endpoint_status\": \"inactive\"\n },\n {\n \"unique_id\": \"9c06616f-0af9-481c-a8d1-96cb696f7a9b\",\n \"created\": \"2022-06-13T07:11:18.777955Z\",\n \"modified\": \"2022-06-13T07:11:18.828979Z\",\n \"hostname\": \"Regresssion Test-1\",\n \"serial_number\": null,\n \"readable_id\": \"DVC35665\",\n \"title_display\": \"Regresssion Test-1\",\n \"ip_address\": null,\n \"mac_address\": null,\n \"endpoint_status\": \"clean\"\n },\n {\n \"unique_id\": \"8b2bd600-3e28-48a5-8e75-a34db36b2dca\",\n \"created\": \"2022-06-13T07:20:30.987251Z\",\n \"modified\": \"2022-06-27T12:14:27.114365Z\",\n \"hostname\": \"Regression Test 2\",\n \"serial_number\": \"1.2.3.4.52342\",\n \"readable_id\": \"DVC35666\",\n \"title_display\": \"Regression Test 2\",\n \"ip_address\": \"1.2.3.4\",\n \"mac_address\": null,\n \"endpoint_status\": \"clean\"\n },\n {\n \"unique_id\": \"098f82dc-a44f-420a-9699-e8b90a903b9c\",\n \"created\": \"2022-06-16T11:31:01.471648Z\",\n \"modified\": \"2022-06-16T12:30:42.633412Z\",\n \"hostname\": \"test trial\",\n \"serial_number\": null,\n \"readable_id\": \"DVC35667\",\n \"title_display\": \"test trial\",\n \"ip_address\": \"1.4.2.6\",\n \"mac_address\": null,\n \"endpoint_status\": \"clean\"\n }\n ],\n \"managed_endpoints\": [\n \"098f82dc-a44f-420a-9699-e8b90a903b9c\"\n ],\n \"managed_endpoints_data\": [\n {\n \"unique_id\": \"098f82dc-a44f-420a-9699-e8b90a903b9c\",\n \"created\": \"2022-06-16T11:31:01.471648Z\",\n \"modified\": \"2022-06-16T12:30:42.633412Z\",\n \"hostname\": \"test trial\",\n \"serial_number\": null,\n \"readable_id\": \"DVC35667\",\n \"title_display\": \"test trial\",\n \"ip_address\": \"1.4.2.6\",\n \"mac_address\": null,\n \"endpoint_status\": \"clean\"\n }\n ],\n \"business_units_data\": [\n {\n \"title\": \"1-Profitable BU12\",\n \"unique_id\": \"6ad8348e-5d5e-42c5-ac0c-8ae8f8708532\"\n }\n ],\n \"created_by\": \"c9cbb792-148f-43ab-af2b-5ded13c788d2\",\n \"created_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"user_status\": \"inactive\",\n \"threat_score\": 8.81,\n \"grade_data\": null,\n \"test_data\": null\n}"}],"_postman_id":"e0a6a511-df92-47f7-a7f0-63efbf630040"},{"name":"Update Asset User Using Field Values","id":"bd72c52c-669d-4398-88de-d7156212c436","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"business_units\": [\"System\", \"Bu 1\"],\n \"labels\": [\"Red Label User\", \"Blue Label User\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/general-user/:user_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","description":"

Update the details of an asset user in the CFTR application using the values of labels and business units.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/general-user/:user_unique_id/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`employee_code`	String	Mandatory	Enter the employee code of the user.
`employee_name`	String	Mandatory	Enter the name of the user.
`business_units`	List	Mandatory	Enter the list of names of Business Units of the user. You can retrieve the list of available Business Units and their names using the following API endpoint: `/openapi/v1/utils/business-unit/`
`user_status`	String	Optional	Enter the status of the user. Allowed Values: - active - inactive Default value: \"active\"
`labels`	List	Optional	Enter the list of names of the labels to be attached to the asset user. You can use the following API endpoint to retrieve the list of Labels: `/openapi/v1/utils/label/`

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the user component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=general-user\n\n

Following are some of the sample custom fields for devices:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`supervisor_employee_code`	String	Optional

Response Parameters

Response Parameters | Regulatory Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the user.
`created`	String	User creation date and time.
`modified`	String	User last updated date and time.
`employee_name`	String	Name of the user.
`email`	String	Email ID of the user.
`display_name`	String	Name of the user.
`readable_id`	String	Readable ID of the user.
`user_status`	String	Current Status of the user.
`hire_date`	String	Hiring date of the user.
`created_by`	String	`user_id` of the CFTR user who created the asset user.
`created_by_data`	Object	Details of the CFTR user who created the asset user.
`labels`	List	List of `unique_id` of labels that are added to the user.
`labels_data`	List of Objects	Details of the labels that are added to the user.
`business_units_data`	List of Objects	Details of business units of the user.

Response Parameters | Connect The Dots

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`owned_applications`	Array of UUID Strings	List of `unique_id` of the applications owned by the user.
`owned_applications_data`	Array of Objects	Details of the applications owned by the user.
`managed_applications`	Array of UUID Strings	List of `unique_id` of the applications managed by the user.
`managed_applications_data`	Array of Objects	Details of the managed applications.
`managed_endpoints`	Array of UUID Strings	List of `unique_id` of the devices managed by the user.
`managed_endpoints_data`	Array of Objects	Details of the managed devices.
`owned_endpoints`	Array of UUID Strings	List of `unique_id` of the devices owned by the user.
`owned_endpoints_data`	Array of Objects	Details of the managed devices.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.

Response Parameters | Custom Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the user component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=general-user\n\n

Following are some of the sample custom fields for users:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`supervisor_employee_code`	String	Optional

Do not change the parameter value\nAllows you to create asset using the values of labels, business units.

\n","type":"text/plain"},"key":"values","value":"readable_type"}],"variable":[{"type":"any","value":"54511aa2-6e20-401f-b274-3a256353b612","key":"user_unique_id"}]}},"response":[{"id":"f3d294bf-e55a-4f97-8cbc-4710754a8412","name":"200 OK: Update Asset User Using Field Values","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"business_units\": [\"System\", \"Bu 1\"],\n \"labels\": [\"Red Label User\", \"Blue Label User\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/general-user/:user_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","host":["{{base_url}}v1"],"path":["general-user",":user_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"values","value":"readable_type","description":"**Do not change the parameter value**\nAllows you to create asset using the values of labels, business units."}],"variable":[{"key":"user_unique_id","value":"54511aa2-6e20-401f-b274-3a256353b612"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Apr 2023 07:46:45 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"title\": null,\n \"phone_number\": null,\n \"supervisor_employee_code\": null,\n \"hr_employee_code\": null,\n \"grade\": null,\n \"unique_id\": \"54511aa2-6e20-401f-b274-3a256353b612\",\n \"created\": \"2023-04-26T07:42:18.526714Z\",\n \"modified\": \"2023-04-26T07:46:44.397521Z\",\n \"employee_code\": \"EMP_111\",\n \"employee_name\": \"Test Employee from openapi\",\n \"email\": \"test@organsation.com\",\n \"hire_date\": null,\n \"last_working_date\": null,\n \"incidents\": [],\n \"incidents_data\": [],\n \"display_name\": \"Test Employee from openapi\",\n \"readable_id\": \"USR103\",\n \"labels\": [\n \"e5517df4-4dd7-4d1e-81f2-648b2fb6bcf3\",\n \"b20c3442-531e-4237-9d4e-70e626f83831\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"e5517df4-4dd7-4d1e-81f2-648b2fb6bcf3\",\n \"title\": \"Red Label User\",\n \"color_code\": \"#2E7D32\",\n \"created\": \"2023-04-26T07:34:18.035225Z\",\n \"modified\": \"2023-04-26T07:34:18.035225Z\"\n },\n {\n \"unique_id\": \"b20c3442-531e-4237-9d4e-70e626f83831\",\n \"title\": \"Blue Label User\",\n \"color_code\": \"#D81B60\",\n \"created\": \"2023-04-26T07:34:35.548042Z\",\n \"modified\": \"2023-04-26T07:34:35.548042Z\"\n }\n ],\n \"briefings\": [],\n \"briefings_data\": [],\n \"owned_applications\": [],\n \"owned_applications_data\": [],\n \"managed_applications\": [],\n \"managed_applications_data\": [],\n \"owned_endpoints\": [],\n \"owned_endpoints_data\": [],\n \"managed_endpoints\": [],\n \"managed_endpoints_data\": [],\n \"business_units_data\": [\n {\n \"title\": \"System\",\n \"unique_id\": \"514f171a-0189-4aa5-bd71-564f7478b4b4\"\n },\n {\n \"title\": \"Bu 1\",\n \"unique_id\": \"f9d39c5a-0fe0-4ee8-bdb6-2e5f8b2fc35c\"\n }\n ],\n \"created_by\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"created_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"peter.smith@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"user_status\": \"active\",\n \"threat_score\": null,\n \"grade_data\": null\n}"}],"_postman_id":"bd72c52c-669d-4398-88de-d7156212c436"},{"name":"Add Comment in an Asset User","id":"3a0f3884-2fab-43d1-b828-ec3aa295f851","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"description\": \"

Note For User

\",\n \"mentioned_users_usernames\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/comments/general-user/:user_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Add notes in an asset user in the CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`description`	String	Mandatory	Enter the content of the comment.
`mentioned_users_usernames`	List of UUID	Optional	Enter the list of usernames of users mentioned in the comment.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the comment.
`description`	Text	Content of the comment.
`created_by`	Object	Details of the user who added the comment.
`modified_by`	Object	Details of the user who last updated the comment.
`mentioned_users`	List of UUID	List of `user_id` of users mentioned in the comment.
`mentioned_users_data`	List of Objects	Details of the users mentioned in the comment.
`created`	String	Comment creation date and time.
`modified`	String	Comment last updated date and time.
`comment_type`	String	Type of Comment. Examples: `discussion`: Notes added in any instance.
`content_object`	String	Module in which the comment is added. Example: `application`, `incident`, `action`, `ioc`, and so on.
`content_object_readable_id`	String	`readable_id` of the instance in which the comment is added
`content_object_unique_id`	String	`unique_id` of the instance in which the comment is added
`description_with_img_src`	Text	Content of the comment with the image URLs (if any image is added in the comment).

","urlObject":{"path":["comments","general-user",":user_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"type":"any","value":"226086de-dff4-44dd-8f48-dbd4e6569eb4","key":"user_unique_id"}]}},"response":[{"id":"249d1d4e-2d85-4218-b80b-797bc62ec1ef","name":"Add Comment to User","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"description\": \"

Note For User

\",\n \"mentioned_users_usernames\": []\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/comments/general-user/:user_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["comments","general-user",":user_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"user_unique_id","value":"226086de-dff4-44dd-8f48-dbd4e6569eb4"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 27 Jun 2022 17:47:55 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"849","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"unique_id\": \"e098f49c-7bb6-47a4-a1cd-18652b9df3f8\",\n \"description\": \"

Note For User

\",\n \"created_by\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"modified_by\": null,\n \"is_removed\": false,\n \"mentioned_users\": [],\n \"mentioned_users_data\": [],\n \"created\": \"2022-06-27T17:47:55.154074Z\",\n \"modified\": \"2022-06-27T17:47:55.171948Z\",\n \"email\": null,\n \"internal\": false,\n \"comment_type\": \"discussion\",\n \"command_params\": {},\n \"command_result\": {},\n \"command_status\": \"na\",\n \"attachments_data\": [],\n \"content_object\": \"general-user\",\n \"content_object_readable_id\": \"USR392\",\n \"content_object_unique_id\": \"226086de-dff4-44dd-8f48-dbd4e6569eb4\",\n \"attachment_label\": null,\n \"description_with_img_src\": \"

Note For User

\"\n}"}],"_postman_id":"3a0f3884-2fab-43d1-b828-ec3aa295f851"}],"id":"093a455e-20ae-461a-b598-1a24ed2daaae","description":"

An employee in an organization has access to knowledge and much other valuable data. Some of the threats primarily focus on the data that employees carry with them and the assets to which they have access. An employee leaving the organization can also pose risk to the company assets, ranging from unintentional lapses like backing up data on personal, unsecured devices to malicious behavior such as accessing payroll to claim funds that belong to another employee.

This section describes how to use the API endpoints to manage the users.

\n","_postman_id":"093a455e-20ae-461a-b598-1a24ed2daaae"},{"name":"PIRs","item":[{"name":"List PIRs","id":"516f83a9-bf10-4564-9e3c-749fd0024c75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/pir/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the details of a list of PIRs from the CFTR application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/pir/?

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` key shows the API endpoint to the next page.
`count`	Integer	The total number of PIRs returned as per the entered query parameters.
`results`	List of Objects	Details of the PIRs. Each object provides the details of one PIR.

Response Parameters | Results Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the PIR in UUID-4 format.
`readable_id`	String	Readable ID of the PIR.
`title`	String	Title of the PIR.
`status`	String	Current status of the PIR. Allowed values: - `open` - `closed`
`created`	String	Created date and time of the PIR.
`modified`	String	Last updated date and time of the PIR.
`title_display`	String	Title of the PIR.
`is_bookmarked`	Boolean	Shows whether the PIR is bookmarked or not.
`labels`	List	List of `unique_id` of the attached labels.
`labels_data`	List of Objects	Details of the attached labels.
`priority_data`	Object	Details of the priority of the PIR.
`priority`	String	Priority level of the PIR. Allowed values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`assigned_to`	List of Strings	List of unique IDs of the assigned users in UUID-4 format.
`assigned_to_data`	List of Objects	Details on the list of assigned users of the PIR. Details include: `username`, `email`, `first_name`, `last_name`, and so on.
`assigned_group`	String	Unique ID of the assigned user group in UUID-4 format.
`assigned_group_data`	Object	Details of the assigned user group. Details include: `group name` and `group ID`

[optional] Enter the page number of the PIRs list. This will retrieve the list of all PIRs from the entered page.

Default value: 1

\n","type":"text/plain"},"key":"page","value":"2"},{"disabled":true,"description":{"content":"

[optional] Enter the number of PIRs per page.\nDefault value: 10

\n","type":"text/plain"},"key":"page_size","value":"2"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the PIRs in EPOCH Time format.\nTime Zone must be as per UTC. All PIRs with creation date later than the entered time will be returned.

\n","type":"text/plain"},"key":"created_date__gte","value":"1644345000"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the PIRs in EPOCH Time format.\nTime Zone must be as per UTC. All PIRs with creation date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"created_date__lte","value":"1644345000"},{"disabled":true,"description":{"content":"

[optional] Enter the last modified time of the PIRs in EPOCH Time format.\nTime Zone must be as per UTC. All PIRs with modified date later than the entered time will be returned.

\n","type":"text/plain"},"key":"modified_date__gte","value":"1644345000"},{"disabled":true,"description":{"content":"

[optional] Enter the last modified time of the PIRs in EPOCH Time format.\nTime Zone must be as per UTC. All PIRs with modified date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"modified_date__lte","value":"1644345000"},{"disabled":true,"description":{"content":"

[optional] Enter the status of the PIRs to filter response results.\nAllowed values:

open
closed

\n","type":"text/plain"},"key":"status","value":"open"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID of the label. This parameter retrieves the PIRs associated with the label.

You can retrieve the list of available Labels and their Unique IDs using the following API endpoint:\n/openapi/v1/utils/label/

\n","type":"text/plain"},"key":"labels","value":"c741bd45-1825-4dba-a30f-66088dcbbf8d"},{"disabled":true,"description":{"content":"

Enter the unique ID of a priority of the PIRs. This parameter retrieves the PIRs by the priority.

\n","type":"text/plain"},"key":"priority","value":"a741e2ce-123d-a3ba-aadf-65467dcbb6da"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID of the incidents. This parameter retrieves the PIRs linked to the incident.

\n","type":"text/plain"},"key":"incidents","value":"73d63aa2-3676-41f1-a03f-233c1334d90e"}],"variable":[]}},"response":[{"id":"3247b9a0-b5a1-4f3d-b4cb-c23fa88455f5","name":"200 OK: Get List of PIRs","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/pir/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["pir",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"page","value":"2","description":"[optional] Enter the page number of the pirs list. This will retrieve the list of all pirs from the entered page.\n\nDefault value: 1","disabled":true},{"key":"page_size","value":"5","description":"[optional] Enter the number of pirs per page.\nDefault value: 10","disabled":true},{"key":"created_date__gte","value":"1644345000","description":"[optional] Enter the creation time of the pirs in EPOCH Time format.\nTime Zone must be as per UTC. All pirs with creation date later than the entered time will be returned.","disabled":true},{"key":"created_date__lte","value":"1644345000","description":"[optional] Enter the creation time of the pirs in EPOCH Time format.\nTime Zone must be as per UTC. All pirs with creation date earlier than the entered time will be returned.","disabled":true},{"key":"modified_date__gte","value":"1644345000","description":"[optional] Enter the last modified time of the pirs in EPOCH Time format.\nTime Zone must be as per UTC. All pirs with modified date later than the entered time will be returned.","disabled":true},{"key":"modified_date__lte","value":"1644345000","description":"[optional] Enter the last modified time of the pirs in EPOCH Time format.\nTime Zone must be as per UTC. All pirs with modified date earlier than the entered time will be returned.","disabled":true},{"key":"status","value":"open","description":"[optional] Enter the status of the pirs to filter response results.\nAllowed values:\n- open\n- closed","disabled":true},{"key":"labels","value":"c741bd45-1825-4dba-a30f-66088dcbbf8d","description":"[optional] Enter the unique ID of the label. This parameter retrieves the pirs associated with the label.\n\nYou can retrieve the list of available Labels and their Unique IDs using the following API endpoint:\n`/openapi/v1/utils/label/`","disabled":true},{"key":"priority","value":"a741e2ce-123d-a3ba-aadf-65467dcbb6da","description":"Enter the unique ID of a priority of the pirs. This parameter retrieves the pirs by the priority.","disabled":true},{"key":"incidents","value":"73d63aa2-3676-41f1-a03f-233c1334d90e","description":"[optional] Enter the unique ID of the incidents. This parameter retrieves the pirs linked to it.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 28 Jun 2022 09:43:53 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1955","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 2,\n \"results\": [\n {\n \"created\": \"2022-06-28T09:42:25.774773Z\",\n \"modified\": \"2022-06-28T09:42:25.847873Z\",\n \"title\": \"New PIR\",\n \"is_bookmarked\": false,\n \"unique_id\": \"42505945-ea78-4c69-8d34-92cdd20026d8\",\n \"readable_id\": \"PIR102\",\n \"assigned_to_data\": [],\n \"assigned_group\": \"3219ad24-bf04-4cd3-93f5-01d189b43775\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"3219ad24-bf04-4cd3-93f5-01d189b43775\",\n \"group_name\": \"CFTR Admin\"\n },\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"status\": \"open\",\n \"title_display\": \"New PIR\",\n \"priority_data\": {\n \"unique_id\": \"c4567008-48e7-4a0a-b9e4-5670bb2f8eeb\",\n \"option_name\": \"Very Low\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"73d63239-5676-41f1-a03f-233c1490990e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"Very Low\"\n },\n {\n \"created\": \"2022-06-28T06:05:22.047795Z\",\n \"modified\": \"2022-06-28T09:21:03.513439Z\",\n \"title\": \"PIR for System Updation v1.2.10\",\n \"is_bookmarked\": false,\n \"unique_id\": \"ba1098e4-43d0-4b53-8952-6e55e7f85f04\",\n \"readable_id\": \"PIR101\",\n \"assigned_to_data\": [],\n \"assigned_group\": \"3219ad24-bf04-4cd3-93f5-01d189b43775\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"3219ad24-bf04-4cd3-93f5-01d189b43775\",\n \"group_name\": \"CFTR Admin\"\n },\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"status\": \"closed\",\n \"title_display\": \"PIR for System Updation v1.2.10\",\n \"priority_data\": {\n \"unique_id\": \"0d125414-34fe-4b2a-b77b-d71730f60715\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"73d63239-5676-41f1-a03f-233c1490990e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"Medium\"\n }\n ]\n}"},{"id":"f0f5e1a7-e1b7-4f49-99f9-39269a4ffbef","name":"200 OK: Get List of PIRs from page 2 upto 2 records","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/pir/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&page=2&page_size=2","host":["{{base_url}}v1"],"path":["pir",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"page","value":"2","description":"[optional] Enter the page number of the pirs list. This will retrieve the list of all pirs from the entered page.\n\nDefault value: 1"},{"key":"page_size","value":"2","description":"[optional] Enter the number of pirs per page.\nDefault value: 10"},{"key":"created_date__gte","value":"1644345000","description":"[optional] Enter the creation time of the pirs in EPOCH Time format.\nTime Zone must be as per UTC. All pirs with creation date later than the entered time will be returned.","disabled":true},{"key":"created_date__lte","value":"1644345000","description":"[optional] Enter the creation time of the pirs in EPOCH Time format.\nTime Zone must be as per UTC. All pirs with creation date earlier than the entered time will be returned.","disabled":true},{"key":"modified_date__gte","value":"1644345000","description":"[optional] Enter the last modified time of the pirs in EPOCH Time format.\nTime Zone must be as per UTC. All pirs with modified date later than the entered time will be returned.","disabled":true},{"key":"modified_date__lte","value":"1644345000","description":"[optional] Enter the last modified time of the pirs in EPOCH Time format.\nTime Zone must be as per UTC. All pirs with modified date earlier than the entered time will be returned.","disabled":true},{"key":"status","value":"open","description":"[optional] Enter the status of the pirs to filter response results.\nAllowed values:\n- open\n- closed","disabled":true},{"key":"labels","value":"c741bd45-1825-4dba-a30f-66088dcbbf8d","description":"[optional] Enter the unique ID of the label. This parameter retrieves the pirs associated with the label.\n\nYou can retrieve the list of available Labels and their Unique IDs using the following API endpoint:\n`/openapi/v1/utils/label/`","disabled":true},{"key":"priority","value":"a741e2ce-123d-a3ba-aadf-65467dcbb6da","description":"Enter the unique ID of a priority of the pirs. This parameter retrieves the pirs by the priority.","disabled":true},{"key":"incidents","value":"73d63aa2-3676-41f1-a03f-233c1334d90e","description":"[optional] Enter the unique ID of the incidents. This parameter retrieves the pirs linked to it.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 28 Jun 2022 09:47:58 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1168","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {\n \"previous\": \"openapi/v1/pir/?page=1&page_size=2&AccessID=a7a71aff-8383-4cb0-8e1d-4c1f835aea7c&Expires=1656409688&Signature=aXbp6ZljKOlmoZ2RP8Z8h/hnvOE=\"\n },\n \"count\": 3,\n \"results\": [\n {\n \"created\": \"2022-06-28T06:05:22.047795Z\",\n \"modified\": \"2022-06-28T09:21:03.513439Z\",\n \"title\": \"PIR for System Updation v1.2.10\",\n \"is_bookmarked\": false,\n \"unique_id\": \"ba1098e4-43d0-4b53-8952-6e55e7f85f04\",\n \"readable_id\": \"PIR101\",\n \"assigned_to_data\": [],\n \"assigned_group\": \"3219ad24-bf04-4cd3-93f5-01d189b43775\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"3219ad24-bf04-4cd3-93f5-01d189b43775\",\n \"group_name\": \"CFTR Admin\"\n },\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"status\": \"closed\",\n \"title_display\": \"PIR for System Updation v1.2.10\",\n \"priority_data\": {\n \"unique_id\": \"0d125414-34fe-4b2a-b77b-d71730f60715\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"73d63239-5676-41f1-a03f-233c1490990e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"Medium\"\n }\n ]\n}"}],"_postman_id":"516f83a9-bf10-4564-9e3c-749fd0024c75"},{"name":"Get PIR Details","id":"9482f8ef-c917-4fcd-a30a-341f58a2835e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/pir/:pir_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the details of a PIR.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/pir/:pir_unique_id/?

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

Response Parameters | Regulatory Fields

Parameter	Type	Description
`title`	String	Title of the PIR.
`unique_id`	String	Unique ID of the PIR in UUID-4 format.
`readable_id`	String	Readable ID of the PIR.
`description`	Text	Description of the PIR.
`created`	String	Creation date and time of the PIR in ISO format.
`modified`	String	Last updated date and time of the PIR in ISO format.
`status`	String	Current status of the PIR. Allowed values: `open` `closed`
`created_by_data`	Object	Details of user who created the PIR.
`closed_by`	String	`user_id` of the user who closed the PIR.
`closed_by_data`	Object	Details of user who closed the PIR.
`closed_on`	String	Closing date and time of the PIR in ISO format.
`is_bookmarked`	Boolean	Shows whether the PIR is bookmarked or not.
`labels`	List of String	List of `unique_id` of the attached labels.
`labels_data`	List of Objects	Details of the attached labels.
`priority`	String	Priority level of the PIR. Allowed values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`priority_data`	Object	Details of the priority of the PIR.
`assigned_to`	List of Stings	List of Unique IDs of the assigned users in UUID-4 format.
`assigned_to_data`	List of Objects	Details on the list of assigned users of the PIR. Details include: `username`, `email`, `first_name`, `last_name`, and so on.
`assigned_group`	String	Unique ID of the assigned user group in UUID-4 format.
`assigned_group_data`	Object	Details of the assigned user group. Details include: `group name` and `group ID`

Response Parameters | Connect The Dots

Following are the response parameters corresponding the Connect The Dots section of PIR. The parameters ending with _data contain the meta information for each connected component. The non _data parameters include an array of unique IDs of the connected components.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.

Response Parameters | Custom Form Fields

As CFTR form structure is dynamic and configurable, the response parameters might vary. The following table describes some examples of the custom fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

","urlObject":{"path":["pir",":pir_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the PIR in UUID format.

\n","type":"text/plain"},"type":"any","value":"ce9991f6-bf09-44d5-b61f-2e3d74324785","key":"pir_unique_id"}]}},"response":[{"id":"601ca0d3-e511-464c-b67a-5c8ce58a7e47","name":"200 OK: Get Details of a PIR","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{auth_key}}","disabled":true}],"url":{"raw":"{{base_url}}v1/pir/:pir_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["pir",":pir_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"pir_unique_id","value":"ce9991f6-bf09-44d5-b61f-2e3d74324785","description":"Enter the unique ID of the pir in UUID format."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 28 Jun 2022 09:58:01 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1390","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"priority\": \"Medium\",\n \"created\": \"2022-06-28T09:47:19.823915Z\",\n \"modified\": \"2022-06-28T09:47:19.879261Z\",\n \"title\": \"Unexpected Server Shutdown on A-302, Floor 3, JTM\",\n \"description\": \"\",\n \"is_bookmarked\": false,\n \"unique_id\": \"ce9991f6-bf09-44d5-b61f-2e3d74324785\",\n \"readable_id\": \"PIR103\",\n \"can_update_instance\": true,\n \"can_update_full\": true,\n \"assigned_to\": [],\n \"assigned_to_data\": [],\n \"assigned_group\": \"a4456691-4129-42ff-9621-97d7b1fafe74\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"a4456691-4129-42ff-9621-97d7b1fafe74\",\n \"group_name\": \"Incident Responder\"\n },\n \"incidents_data\": [],\n \"campaigns_data\": [],\n \"malwares_data\": [],\n \"threat_actors_data\": [],\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"status\": \"open\",\n \"attachments_data\": [],\n \"yet_to_reply_count\": 0,\n \"replied_count\": 0,\n \"closed_on\": null,\n \"closed_by_data\": null,\n \"reply_allowed\": true,\n \"title_display\": \"Unexpected Server Shutdown on A-302, Floor 3, JTM\",\n \"labels\": [],\n \"labels_data\": [],\n \"vulnerabilities_data\": [],\n \"briefings_data\": [],\n \"priority_data\": {\n \"unique_id\": \"0d125414-34fe-4b2a-b77b-d71730f60715\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"73d63239-5676-41f1-a03f-233c1490990e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n}"}],"_postman_id":"9482f8ef-c917-4fcd-a30a-341f58a2835e"},{"name":"Create PIR Using Field UUID","id":"4559993f-bb9e-4f7b-9b28-d98a9647b90c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Test PIR\",\n \"priority\": \"Very High\",\n \"assigned_group\": \"a4456691-4129-42ff-9621-97d7b1fafe74\",\n \"description\": \"

Test PIR description

\",\n \"status\": \"open\",\n \"assigned_to\": [\"65c8ade3-3f52-4331-806f-7fb53d12cea0\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/pir/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Create a new PIR in the CFTR application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/pir/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`title`	String	Mandatory	Enter a title for the PIR.
`description`	Text	Optional	Enter a description for the PIR.
`status`	String	Optional	Enter the current status of the PIR. Allowed values: `open` `closed`Default value: `open`
`is_bookmarked`	Boolean	Optional	Mention whether the PIR is bookmarked or not.
`labels`	List of String	Optional	Enter the list of `unique_id` of the attached labels.
`priority`	String	Mandatory	Enter the priority level of the PIR. Allowed values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`assigned_to`	List of Strings	Optional	Enter the list of unique IDs of the assigned users in UUID-4 format.
`assigned_group`	String	Mandatory	Enter the unique ID of the assigned user group in UUID-4 format.

Request Parameters | Custom Form Fields

In addition to the above-mentioned parameters, the request parameters might vary as per the form configuration defined by your CFTR admin for PIRs. For such parameters, use the field_readable_key of each parameter. To retrieve the field_readable_key and additional metadata of a parameter, use the Form Tab Structure API for PIRs.

Example

The following endpoint retrieves the field_readable_key for all custom fields in the PIR component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=pir\n\n

Following are some of the sample custom fields for PIRs:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters

Response Parameters | Regulatory Fields

Parameter	Type	Description
`title`	String	Title of the PIR.
`unique_id`	String	Unique ID of the PIR in UUID-4 format.
`readable_id`	String	Readable ID of the PIR.
`description`	Text	Description of the PIR.
`created`	String	Creation date and time of the PIR in ISO format.
`modified`	String	Last updated date and time of the PIR in ISO format.
`status`	String	Current status of the PIR. Allowed values: `open` `closed`
`created_by_data`	Object	Details of user who created the PIR.
`closed_by`	String	`user_id` of the user who closed the PIR.
`closed_by_data`	Object	Details of user who closed the PIR.
`closed_on`	String	Closing date and time of the PIR in ISO format.
`is_bookmarked`	Boolean	Shows whether the PIR is bookmarked or not.
`labels`	List of String	List of `unique_id` of the attached labels.
`labels_data`	List of Objects	Details of the attached labels.
`priority`	String	Priority level of the PIR. Allowed values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`priority_data`	Object	Details of the priority of the PIR.
`assigned_to`	List of Stings	List of Unique IDs of the assigned users in UUID-4 format.
`assigned_to_data`	List of Objects	Details on the list of assigned users of the PIR. Details include: `username`, `email`, `first_name`, `last_name`, and so on.
`assigned_group`	String	Unique ID of the assigned user group in UUID-4 format.
`assigned_group_data`	Object	Details of the assigned user group. Details include: `group name` and `group ID`

Response Parameters | Connect The Dots

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.

Response Parameters | Custom Form Fields

As CFTR form structure is dynamic and configurable, the response parameters might vary. The following table describes some examples of the custom fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

","urlObject":{"path":["pir",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[]}},"response":[{"id":"b04f8544-28b5-42fb-be28-b6d4c2cbbfee","name":"201 OK: Create PIR","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Test PIR\",\n \"priority\": \"Very High\",\n \"assigned_group\": \"a4456691-4129-42ff-9621-97d7b1fafe74\",\n \"description\": \"

Test PIR description

\",\n \"status\": \"open\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/pir/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["pir",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 28 Jun 2022 10:03:50 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1355","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"priority\": \"Very High\",\n \"created\": \"2022-06-28T10:03:48.691813Z\",\n \"modified\": \"2022-06-28T10:03:48.767364Z\",\n \"title\": \"Test PIR\",\n \"description\": \"

Test PIR description

\",\n \"is_bookmarked\": false,\n \"unique_id\": \"b3af9646-9aef-467c-b9dc-4f68d651ad36\",\n \"readable_id\": \"PIR104\",\n \"can_update_instance\": true,\n \"can_update_full\": true,\n \"assigned_to\": [],\n \"assigned_to_data\": [],\n \"assigned_group\": \"a4456691-4129-42ff-9621-97d7b1fafe74\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"a4456691-4129-42ff-9621-97d7b1fafe74\",\n \"group_name\": \"Incident Responder\"\n },\n \"incidents_data\": [],\n \"campaigns_data\": [],\n \"malwares_data\": [],\n \"threat_actors_data\": [],\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"status\": \"open\",\n \"attachments_data\": [],\n \"yet_to_reply_count\": 0,\n \"replied_count\": 0,\n \"closed_on\": null,\n \"closed_by_data\": null,\n \"reply_allowed\": true,\n \"title_display\": \"Test PIR\",\n \"labels\": [],\n \"labels_data\": [],\n \"vulnerabilities_data\": [],\n \"briefings_data\": [],\n \"priority_data\": {\n \"unique_id\": \"75ac4db7-155c-451a-9f63-ac391cca2afa\",\n \"option_name\": \"Very High\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"73d63239-5676-41f1-a03f-233c1490990e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n}"},{"id":"2230b4cd-7c52-4c87-8bd4-59a9b2ca79e0","name":"400 Bad Request: Assigned group is required","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Test PIR\",\n \"priority\": \"Very High\",\n \"description\": \"

Test PIR description

\",\n \"status\": \"open\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/pir/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["pir",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 28 Jun 2022 10:01:43 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"43","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"assigned_group\": \"This field is required\"\n}"},{"id":"1a5aab5a-af8c-4f12-a59c-96a0a6cd77fa","name":"400 Bad Request: Invalid choice for status","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Test PIR\",\n \"priority\": \"Very High\",\n \"assigned_group\": \"a4456691-4129-42ff-9621-97d7b1fafe74\",\n \"description\": \"

Test PIR description

\",\n \"status\": \"opened\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/pir/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["pir",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 28 Jun 2022 10:03:02 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"48","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": [\n \"\\\"opened\\\" is not a valid choice.\"\n ]\n}"}],"_postman_id":"4559993f-bb9e-4f7b-9b28-d98a9647b90c"},{"name":"Create PIR Using Field Values","id":"a3bbcd67-6ebb-488c-a348-3b044cc5f98b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Test PIR for OpenAPI\",\n \"priority\": \"Very High\",\n \"assigned_group\": \"CFTR Admin\",\n \"description\": \"

Test PIR description

Create a new PIR in the CFTR application using the values of assigned groups, labels, and the email ID of assigned users.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/pir/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`title`	String	Mandatory	Enter a title for the PIR.
`description`	Text	Optional	Enter a description for the PIR.
`status`	String	Optional	Enter the current status of the PIR. Allowed values: `open` `closed`Default value: `open`
`is_bookmarked`	Boolean	Optional	Mention whether the PIR is bookmarked or not.
`labels`	List	Optional	Enter the list of names of the labels to be attached to the PIR. You can use the following API endpoint to retrieve the list of Labels: `/openapi/v1/utils/label/`
`priority`	String	Mandatory	Enter the priority level of the PIR. Allowed values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`assigned_to`	List	Optional	Enter the list of email IDs of the users to assign the PIR. You can use the following API endpoint to retrieve the list of User:`/openapi/v1/rest-auth/user/`
`assigned_group`	String	Mandatory	Enter the name of the user group to assign the PIR. You can use the following API endpoint to retrieve the list of User Groups: `/openapi/v1/restauth/permission/group/`

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the PIR component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=pir\n\n

Following are some of the sample custom fields for PIRs:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters

Response Parameters | Regulatory Fields

Parameter	Type	Description
`title`	String	Title of the PIR.
`unique_id`	String	Unique ID of the PIR in UUID-4 format.
`readable_id`	String	Readable ID of the PIR.
`description`	Text	Description of the PIR.
`created`	String	Creation date and time of the PIR in ISO format.
`modified`	String	Last updated date and time of the PIR in ISO format.
`status`	String	Current status of the PIR. Allowed values: `open` `closed`
`created_by_data`	Object	Details of user who created the PIR.
`closed_by`	String	`user_id` of the user who closed the PIR.
`closed_by_data`	Object	Details of user who closed the PIR.
`closed_on`	String	Closing date and time of the PIR in ISO format.
`is_bookmarked`	Boolean	Shows whether the PIR is bookmarked or not.
`labels`	List of String	List of `unique_id` of the attached labels.
`labels_data`	List of Objects	Details of the attached labels.
`priority`	String	Priority level of the PIR. Allowed values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`priority_data`	Object	Details of the priority of the PIR.
`assigned_to`	List of Stings	List of Unique IDs of the assigned users in UUID-4 format.
`assigned_to_data`	List of Objects	Details on the list of assigned users of the PIR. Details include: `username`, `email`, `first_name`, `last_name`, and so on.
`assigned_group`	String	Unique ID of the assigned user group in UUID-4 format.
`assigned_group_data`	Object	Details of the assigned user group. Details include: `group name` and `group ID`

Response Parameters | Connect The Dots

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.

Response Parameters | Custom Form Fields

As CFTR form structure is dynamic and configurable, the response parameters might vary. The following table describes some examples of the custom fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Do not change the parameter value\nAllows you to create pir using the values of assigned groups, labels and the email IDs of assigned users.

\n","type":"text/plain"},"key":"values","value":"readable_type"}],"variable":[]}},"response":[{"id":"b492e4c7-96a2-4fd8-a2b1-2b49bf671ab2","name":"201 Created: Create PIR Using Field Values","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Test PIR for OpenAPI\",\n \"priority\": \"Very High\",\n \"assigned_group\": \"CFTR Admin\",\n \"description\": \"

Test PIR description

\",\n \"status\": \"open\",\n \"assigned_to\": [\"peter.smith@example.com\"],\n \"labels\": [\"Red Label PIR\"]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/pir/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","host":["{{base_url}}v1"],"path":["pir",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"values","value":"readable_type","description":"**Do not change the parameter value**\nAllows you to create pir using the values of assigned groups, labels and the email IDs of assigned users."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Apr 2023 08:42:22 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1980","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"priority\": \"Very High\",\n \"created\": \"2023-04-26T08:42:21.382990Z\",\n \"modified\": \"2023-04-26T08:42:21.506247Z\",\n \"title\": \"Test PIR for OpenAPI\",\n \"description\": \"

Test PIR description

\",\n \"is_bookmarked\": false,\n \"unique_id\": \"06863326-10f4-472a-9d8e-f45f4cd2dbcd\",\n \"readable_id\": \"PIR101\",\n \"can_update_instance\": true,\n \"can_update_full\": true,\n \"assigned_to\": [\n \"15900fff-73fb-4a14-89bf-bf3a5e70297a\"\n ],\n \"assigned_to_data\": [\n {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"peter.smith@example.com\",\n \"full_name\": \"Peter Smith\"\n }\n ],\n \"assigned_group\": \"b0a6a9a6-f29b-4ea6-97d3-824da65b52f9\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"b0a6a9a6-f29b-4ea6-97d3-824da65b52f9\",\n \"group_name\": \"CFTR Admin\"\n },\n \"incidents\": [],\n \"incidents_data\": [],\n \"campaigns\": [],\n \"campaigns_data\": [],\n \"malwares\": [],\n \"malwares_data\": [],\n \"threat_actors\": [],\n \"threat_actors_data\": [],\n \"created_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"peter.smith@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"status\": \"open\",\n \"attachments_data\": [],\n \"yet_to_reply_count\": 1,\n \"replied_count\": 0,\n \"closed_on\": null,\n \"closed_by_data\": null,\n \"reply_allowed\": true,\n \"title_display\": \"Test PIR for OpenAPI\",\n \"labels\": [\n \"b57360ca-d964-4996-9af5-3e0e6dd64e05\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"b57360ca-d964-4996-9af5-3e0e6dd64e05\",\n \"title\": \"Red Label PIR\",\n \"color_code\": \"#9E9D24\",\n \"created\": \"2023-04-26T08:41:33.065335Z\",\n \"modified\": \"2023-04-26T08:41:33.065335Z\"\n }\n ],\n \"vulnerabilities\": [],\n \"vulnerabilities_data\": [],\n \"briefings_data\": [],\n \"briefings\": [],\n \"handoff_note\": null,\n \"priority_data\": {\n \"unique_id\": \"dfc83a2e-7c2f-45ad-9d47-55a58484a9ab\",\n \"option_name\": \"Very High\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"4dee38ed-b540-4e1c-94bb-22e521269683\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n}"}],"_postman_id":"a3bbcd67-6ebb-488c-a348-3b044cc5f98b"},{"name":"Update PIR Using Field UUID","id":"1924d93e-4e48-4bf3-8311-6176e5322e62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": \"closed\"\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/pir/:pir_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Update the details of a PIR in the CFTR application.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/pir/:pir_unique_id/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`title`	String	Mandatory	Enter a title for the PIR.
`description`	Text	Optional	Enter a description for the PIR.
`status`	String	Optional	Enter the current status of the PIR. Allowed values: `open` `closed`Default value: `open`
`is_bookmarked`	Boolean	Optional	Mention whether the PIR is bookmarked or not.
`labels`	List of String	Optional	Enter the list of `unique_id` of the attached labels.
`priority`	String	Mandatory	Enter the priority level of the PIR. Allowed values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`assigned_to`	List of Strings	Optional	Enter the list of unique IDs of the assigned users in UUID-4 format.
`assigned_group`	String	Mandatory	Enter the unique ID of the assigned user group in UUID-4 format.

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the PIR component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=pir\n\n

Following are some of the sample custom fields for PIRs:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters

Response Parameters | Regulatory Fields

Parameter	Type	Description
`title`	String	Title of the PIR.
`unique_id`	String	Unique ID of the PIR in UUID-4 format.
`readable_id`	String	Readable ID of the PIR.
`description`	Text	Description of the PIR.
`created`	String	Creation date and time of the PIR in ISO format.
`modified`	String	Last updated date and time of the PIR in ISO format.
`status`	String	Current status of the PIR. Allowed values: `open` `closed`
`created_by_data`	Object	Details of user who created the PIR.
`closed_by`	String	`user_id` of the user who closed the PIR.
`closed_by_data`	Object	Details of user who closed the PIR.
`closed_on`	String	Closing date and time of the PIR in ISO format.
`is_bookmarked`	Boolean	Shows whether the PIR is bookmarked or not.
`labels`	List of String	List of `unique_id` of the attached labels.
`labels_data`	List of Objects	Details of the attached labels.
`priority`	String	Priority level of the PIR. Allowed values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`priority_data`	Object	Details of the priority of the PIR.
`assigned_to`	List of Stings	List of Unique IDs of the assigned users in UUID-4 format.
`assigned_to_data`	List of Objects	Details on the list of assigned users of the PIR. Details include: `username`, `email`, `first_name`, `last_name`, and so on.
`assigned_group`	String	Unique ID of the assigned user group in UUID-4 format.
`assigned_group_data`	Object	Details of the assigned user group. Details include: `group name` and `group ID`

Response Parameters | Connect The Dots

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.

Response Parameters | Custom Form Fields

As CFTR form structure is dynamic and configurable, the response parameters might vary. The following table describes some examples of the custom fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Enter the unique ID of the PIR in UUID format.

\n","type":"text/plain"},"type":"any","value":"ce9991f6-bf09-44d5-b61f-2e3d74324785","key":"pir_unique_id"}]}},"response":[{"id":"0fbd66cb-b320-470d-b537-89304894f1c2","name":"200 OK: Update a PIR status to closed","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": \"closed\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/pir/:pir_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["pir",":pir_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"pir_unique_id","value":"ce9991f6-bf09-44d5-b61f-2e3d74324785","description":"Enter the unique ID of the pir in UUID format."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 28 Jun 2022 10:10:22 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1647","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"priority\": \"Medium\",\n \"created\": \"2022-06-28T09:47:19.823915Z\",\n \"modified\": \"2022-06-28T10:10:21.370452Z\",\n \"title\": \"Unexpected Server Shutdown on A-302, Floor 3, JTM\",\n \"description\": \"\",\n \"is_bookmarked\": false,\n \"unique_id\": \"ce9991f6-bf09-44d5-b61f-2e3d74324785\",\n \"readable_id\": \"PIR103\",\n \"can_update_instance\": true,\n \"can_update_full\": true,\n \"assigned_to\": [],\n \"assigned_to_data\": [],\n \"assigned_group\": \"a4456691-4129-42ff-9621-97d7b1fafe74\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"a4456691-4129-42ff-9621-97d7b1fafe74\",\n \"group_name\": \"Incident Responder\"\n },\n \"incidents_data\": [],\n \"campaigns_data\": [],\n \"malwares_data\": [],\n \"threat_actors_data\": [],\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"status\": \"closed\",\n \"attachments_data\": [],\n \"yet_to_reply_count\": 0,\n \"replied_count\": 0,\n \"closed_on\": \"2022-06-28T10:10:21.369697Z\",\n \"closed_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"reply_allowed\": true,\n \"title_display\": \"Unexpected Server Shutdown on A-302, Floor 3, JTM\",\n \"labels\": [],\n \"labels_data\": [],\n \"vulnerabilities_data\": [],\n \"briefings_data\": [],\n \"priority_data\": {\n \"unique_id\": \"0d125414-34fe-4b2a-b77b-d71730f60715\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"73d63239-5676-41f1-a03f-233c1490990e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n}"},{"id":"ba31d9a4-d0e3-4018-bff5-1c7ea9830d84","name":"400 Bad Request: Invalid status choice","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": \"close\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/pir/:pir_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["pir",":pir_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"pir_unique_id","value":"ce9991f6-bf09-44d5-b61f-2e3d74324785","description":"Enter the unique ID of the pir in UUID format."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 28 Jun 2022 10:11:06 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"47","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": [\n \"\\\"close\\\" is not a valid choice.\"\n ]\n}"}],"_postman_id":"1924d93e-4e48-4bf3-8311-6176e5322e62"},{"name":"Update PIR Using Field Values","id":"454646b2-cfca-48c0-b7a7-9a4227fb9069","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"assigned_group\": \"Soc Analyst\",\n \"labels\": [\n \"Blue Label PIR\"\n ],\n \"handoff_note\": {\n \"description\": \"Assigning to Soc Analyst\",\n \"comment_type\": \"handoff\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/pir/:pir_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","description":"

Update the details of a PIR in the CFTR application using the values of assigned groups, labels, and the email IDs of assigned users.

Note: Starting from Respond v3.4.8 onwards, the following v2 endpoint is introduced to optimize performance:

v2/pir/:pir_unique_id/?

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`title`	String	Mandatory	Enter a title for the PIR.
`description`	Text	Optional	Enter a description for the PIR.
`status`	String	Optional	Enter the current status of the PIR. Allowed values: `open` `closed`Default value: `open`
`is_bookmarked`	Boolean	Optional	Mention whether the PIR is bookmarked or not.
`labels`	List of String	Optional	Enter the list of names of the labels to be attached to the PIR. You can use the following API endpoint to retrieve the list of Labels: `/openapi/v1/utils/label/`
`priority`	String	Mandatory	Enter the priority level of the PIR. Allowed values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`assigned_to`	List of Strings	Optional	Enter the list of email IDs of the users to assign the PIR. You can use the following API endpoint to retrieve the list of User:`/openapi/v1/rest-auth/user/`
`assigned_group`	String	Mandatory	Enter the name of the user group to assign the PIR. You can use the following API endpoint to retrieve the list of User Groups: `/openapi/v1/restauth/permission/group/`

Request Parameters | Custom Form Fields

Example

The following endpoint retrieves the field_readable_key for all custom fields in the PIR component:

{{base_url}}/cftrapi/openapi/v1/forms/fields/?object_identifier=pir\n\n

Following are some of the sample custom fields for PIRs:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Response Parameters

Response Parameters | Regulatory Fields

Parameter	Type	Description
`title`	String	Title of the PIR.
`unique_id`	String	Unique ID of the PIR in UUID-4 format.
`readable_id`	String	Readable ID of the PIR.
`description`	Text	Description of the PIR.
`created`	String	Creation date and time of the PIR in ISO format.
`modified`	String	Last updated date and time of the PIR in ISO format.
`status`	String	Current status of the PIR. Allowed values: `open` `closed`
`created_by_data`	Object	Details of user who created the PIR.
`closed_by`	String	`user_id` of the user who closed the PIR.
`closed_by_data`	Object	Details of user who closed the PIR.
`closed_on`	String	Closing date and time of the PIR in ISO format.
`is_bookmarked`	Boolean	Shows whether the PIR is bookmarked or not.
`labels`	List of String	List of `unique_id` of the attached labels.
`labels_data`	List of Objects	Details of the attached labels.
`priority`	String	Priority level of the PIR. Allowed values: - `Very Low` - `Low` - `Medium` - `High` - `Very High`
`priority_data`	Object	Details of the priority of the PIR.
`assigned_to`	List of Stings	List of Unique IDs of the assigned users in UUID-4 format.
`assigned_to_data`	List of Objects	Details on the list of assigned users of the PIR. Details include: `username`, `email`, `first_name`, `last_name`, and so on.
`assigned_group`	String	Unique ID of the assigned user group in UUID-4 format.
`assigned_group_data`	Object	Details of the assigned user group. Details include: `group name` and `group ID`

Response Parameters | Connect The Dots

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`briefings`	Array of UUID Strings	List of `unique_id` of the connected threat briefings.
`briefings_data`	Array of Objects	Details of the connected threat briefings.
`campaigns`	Array of UUID Strings	List of `unique_id` of the connected campaigns.
`campaigns_data`	Array of Objects	Details of the connected campaigns.
`malwares`	Array of UUID Strings	List of `unique_id` of the connected malware.
`malwares_data`	Array of Objects	Details of the connected malware.
`threat_actors`	Array of UUID Strings	List of `unique_id` of the connected threat actors.
`threat_actors_data`	Array of Objects	Details of the connected threat actors.
`incidents`	Array of UUID Strings	List of `unique_id` of the connected incidents.
`incidents_data`	Array of Objects	Details of the connected incidents.
`vulnerabilities`	Array of UUID Strings	List of `unique_id` of the connected vulnerabilities.
`vulnerabilities_data`	Array of Objects	Details of the connected vulnerabilities.

Response Parameters | Custom Form Fields

As CFTR form structure is dynamic and configurable, the response parameters might vary. The following table describes some examples of the custom fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required
`privileges_required`	String	Optional
`additional_comments`	Text	Optional

Do not change the parameter value\nAllows you to create pir using the values of assigned groups, labels and the email IDs of assigned users.

\n","type":"text/plain"},"key":"values","value":"readable_type"}],"variable":[{"description":{"content":"

Enter the unique ID of the PIR in UUID format.

\n","type":"text/plain"},"type":"any","value":"06863326-10f4-472a-9d8e-f45f4cd2dbcd","key":"pir_unique_id"}]}},"response":[{"id":"117a0634-81fb-4d46-abbf-39793af9c9f3","name":"200 OK: Update PIR Using Field Values","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"assigned_group\": \"Soc Analyst\",\n \"labels\": [\n \"Blue Label PIR\"\n ],\n \"handoff_note\": {\n \"description\": \"Assigning to Soc Analyst\",\n \"comment_type\": \"handoff\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/pir/:pir_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&values=readable_type","host":["{{base_url}}v1"],"path":["pir",":pir_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"values","value":"readable_type","description":"**Do not change the parameter value**\nAllows you to create pir using the values of assigned groups, labels and the email IDs of assigned users."}],"variable":[{"key":"pir_unique_id","value":"06863326-10f4-472a-9d8e-f45f4cd2dbcd","description":"Enter the unique ID of the PIR in UUID format."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Apr 2023 08:57:47 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"priority\": \"Very High\",\n \"created\": \"2023-04-26T08:42:21.382990Z\",\n \"modified\": \"2023-04-26T08:57:47.236835Z\",\n \"title\": \"Test PIR for OpenAPI\",\n \"description\": \"

Test PIR description

\",\n \"is_bookmarked\": false,\n \"unique_id\": \"06863326-10f4-472a-9d8e-f45f4cd2dbcd\",\n \"readable_id\": \"PIR101\",\n \"can_update_instance\": true,\n \"can_update_full\": true,\n \"assigned_to\": [],\n \"assigned_to_data\": [],\n \"assigned_group\": \"5558daf9-25fe-4f58-b351-a9c6ec01036e\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"5558daf9-25fe-4f58-b351-a9c6ec01036e\",\n \"group_name\": \"Soc Analyst\"\n },\n \"incidents\": [],\n \"incidents_data\": [],\n \"campaigns\": [],\n \"campaigns_data\": [],\n \"malwares\": [],\n \"malwares_data\": [],\n \"threat_actors\": [],\n \"threat_actors_data\": [],\n \"created_by_data\": {\n \"username\": \"peter\",\n \"first_name\": \"Peter\",\n \"last_name\": \"Smith\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"peter.smith@example.com\",\n \"full_name\": \"Peter Smith\"\n },\n \"status\": \"open\",\n \"attachments_data\": [],\n \"yet_to_reply_count\": 0,\n \"replied_count\": 0,\n \"closed_on\": null,\n \"closed_by_data\": null,\n \"reply_allowed\": true,\n \"title_display\": \"Test PIR for OpenAPI\",\n \"labels\": [\n \"2fa16dc4-ad04-404d-a776-fa9aa78f3eb5\"\n ],\n \"labels_data\": [\n {\n \"unique_id\": \"2fa16dc4-ad04-404d-a776-fa9aa78f3eb5\",\n \"title\": \"Blue Label PIR\",\n \"color_code\": \"#0091EA\",\n \"created\": \"2023-04-26T08:41:51.685324Z\",\n \"modified\": \"2023-04-26T08:41:51.685324Z\"\n }\n ],\n \"vulnerabilities\": [],\n \"vulnerabilities_data\": [],\n \"briefings_data\": [],\n \"briefings\": [],\n \"handoff_note\": null,\n \"priority_data\": {\n \"unique_id\": \"dfc83a2e-7c2f-45ad-9d47-55a58484a9ab\",\n \"option_name\": \"Very High\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"4dee38ed-b540-4e1c-94bb-22e521269683\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n}"}],"_postman_id":"454646b2-cfca-48c0-b7a7-9a4227fb9069"},{"name":"Add Comment in PIR","id":"9fabdc34-3fae-43d6-b4a8-5ff7e9cf4e3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"description\": \"

Please reopen this PIR

\",\n \"mentioned_users_usernames\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/comments/pir/:pir_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Add notes in a PIR in the CFTR application.

Request Parameters

Note: The default value of all the optional parameters is None, if the default value is not mentioned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`description`	String	Mandatory	Enter the content of the comment.
`mentioned_users_usernames`	List of UUID	Optional	Enter the list of usernames of the users to be mentioned in the comment.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`unique_id`	String	Unique ID of the comment.
`description`	Text	Content of the comment.
`created_by`	Object	Details of the user who added the comment.
`modified_by`	Object	Details of the user who last updated the comment.
`mentioned_users`	List of UUID	List of `user_id` of users mentioned in the comment.
`mentioned_users_data`	List of Objects	Details of the users mentioned in the comment.
`created`	String	Comment creation date and time.
`modified`	String	Comment last updated date and time.
`comment_type`	String	Type of Comment. Examples: `discussion`: Notes added in an instance.
`content_object`	String	Component in which the comment is added. Example: `pir`, `incident`, `action`, `ioc`, `vulnerability`, and so on.
`content_object_readable_id`	String	`readable_id` of the component instance in which the comment is added.
`content_object_unique_id`	String	`unique_id` of the component instance in which the comment is added.
`description_with_img_src`	Text	Description with the image URLs (if image is added in the comment).

","urlObject":{"path":["comments","pir",":pir_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the PIR in UUID format.

\n","type":"text/plain"},"type":"any","value":"ce9991f6-bf09-44d5-b61f-2e3d74324785","key":"pir_unique_id"}]}},"response":[{"id":"85c8a98b-d0b7-4793-818c-f3358875465a","name":"200 OK: Add Comment in PIR","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"description\": \"

Please reopen this PIR

\",\n \"mentioned_users_usernames\": []\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/comments/pir/:pir_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["comments","pir",":pir_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"pir_unique_id","value":"ce9991f6-bf09-44d5-b61f-2e3d74324785","description":"Enter the unique ID of the pir in UUID format."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 28 Jun 2022 10:13:22 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"883","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"unique_id\": \"18fc9d12-e707-493b-8570-60cdee6e25c3\",\n \"description\": \"

Please reopen this PIR

\",\n \"created_by\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"modified_by\": null,\n \"is_removed\": false,\n \"mentioned_users\": [],\n \"mentioned_users_data\": [],\n \"created\": \"2022-06-28T10:13:21.730396Z\",\n \"modified\": \"2022-06-28T10:13:21.773620Z\",\n \"email\": null,\n \"internal\": false,\n \"comment_type\": \"discussion\",\n \"command_params\": {},\n \"command_result\": {},\n \"command_status\": \"na\",\n \"attachments_data\": [],\n \"content_object\": \"pir\",\n \"content_object_readable_id\": \"PIR103\",\n \"content_object_unique_id\": \"ce9991f6-bf09-44d5-b61f-2e3d74324785\",\n \"attachment_label\": null,\n \"description_with_img_src\": \"

Please reopen this PIR

\"\n}"}],"_postman_id":"9fabdc34-3fae-43d6-b4a8-5ff7e9cf4e3a"},{"name":"Upload Attachment","id":"1e0f1aa0-2368-4e9f-9263-db6e438103e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"key":"uploaded_file","type":"file","src":"/Users/ericjohn/Downloads/Attachment.png"},{"key":"file_type","value":"artifact","type":"text"}]},"url":"{{base_url}}v1/utils/file/pir/:pir_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Upload any type of file to a PIR as attachment.

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
uploaded_file	File	Mandatory	Enter the file to be uploaded.
file_type	String	Optional	Enter the type of file. Allowed value: `artifact`

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
title	Text	Name of the file.
uploaded_file	URL	URL of the file from where it can be downloaded.
unique_id	String	Unique ID for the file.
created_by_data	Object	Details of the user who uploaded the file.
created	Datetime	File upload date and time.
modified	Datetime	File modified date and time.
readable_id	String	Unique readable ID of the file.
file_hash	String	Hash of the file.
file_type	String	Type of the file. I Allowed value: `artifact`
file_size	Integer	Size of the file.
parent_readable_id	String	`readable_id` of the component instance in which file is uploaded.
parent_component	String	Module name in which file is uploaded. Example: `pir`, `action`, and so on.
parent_unique_id	String	`unique_id` of the module in which file is uploaded

","urlObject":{"path":["utils","file","pir",":pir_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the unique ID of the PIR in UUID format.

\n","type":"text/plain"},"type":"any","value":"ce9991f6-bf09-44d5-b61f-2e3d74324785","key":"pir_unique_id"}]}},"response":[{"id":"a9bcc331-809d-4c0a-bbe9-8544f5abc04d","name":"201 Created: Upload an Attachment","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"key":"uploaded_file","type":"file","src":"/Users/ericjohn/Downloads/Attachment.png"},{"key":"file_type","value":"artifact","type":"text"}]},"url":{"raw":"{{base_url}}v1/utils/file/pir/:pir_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["utils","file","pir",":pir_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"pir_unique_id","value":"ce9991f6-bf09-44d5-b61f-2e3d74324785","description":"Enter the unique ID of the pir in UUID format."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 28 Jun 2022 10:32:27 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1087","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"Attachment.png\",\n \"description\": null,\n \"uploaded_file\": \"http://host.docker.internal:51620/cftrbucket/ciims-data/b4558881-Attachment.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minio%2F20220628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20220628T103227Z&X-Amz-Expires=120&X-Amz-SignedHeaders=host&X-Amz-Signature=1cb547bd2a9771434764e7a893998be9fe39f04356849933e568ce1b77492e77\",\n \"unique_id\": \"3584b51a-9968-4bea-8add-6288ad334d35\",\n \"created_by_data\": {\n \"username\": \"jane\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"15900fff-73fb-4a14-89bf-bf3a5e70297a\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n },\n \"created\": \"2022-06-28T10:32:26.376771Z\",\n \"modified\": \"2022-06-28T10:32:26.852764Z\",\n \"readable_id\": \"ART103\",\n \"is_removed\": false,\n \"readable_id_counter\": 103,\n \"file_hash\": \"a0107e9ccf145f65f245e436cf6e5fef\",\n \"file_type\": \"artifact\",\n \"file_size\": 2819678,\n \"can_delete\": true,\n \"parent_readable_id\": \"PIR103\",\n \"parent_component\": \"pir\",\n \"parent_unique_id\": \"ce9991f6-bf09-44d5-b61f-2e3d74324785\"\n}"}],"_postman_id":"1e0f1aa0-2368-4e9f-9263-db6e438103e9"}],"id":"2e833bda-ce6e-4cce-aeae-bc5b1693cc67","description":"

The Priority Intel Requirement (PIR) is prepared to evaluate the incident response effectiveness. PIRs are initiated as part of the Incident Response process and can help an incident manager in identifying and correcting weaknesses within the organization's security posture. This can also help you to identify whether all the corrective Actions and Enhancements are in place for preventing future attacks.

This section describes how to use the API endpoints to manage the PIRs.

\n","_postman_id":"2e833bda-ce6e-4cce-aeae-bc5b1693cc67"},{"name":"Dashboard","item":[{"name":"Get List of Widgets","event":[{"listen":"prerequest","script":{"id":"1e757935-f9c2-4eaa-94ed-9a1a5c03498c","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"87714230-a059-4d79-97fb-81f00a61cf3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/analytics/widget/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}§ion=dashboard","description":"

Retrieve a list of widgets available in the CFTR application.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key shows the API endpoint to the previous page. `next` shows the API endpoint to the next page.
`count`	Integer	Total number of widgets available in the CFTR application.
`results`	List of Objects	Details of the widgets. Each object provides details of one widget.

Response Parameters | Results Object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	Title of the widget.
`unique_id`	String	Unique identifier string of the widget in UUID-4 format.
`data_source`	String	Endpoint of the widget.
`is_removed`	Boolean	Shows whether the widget is in a deleted state or not.
`chart_type`	String	Chart type of the widget.
`component_identifier`	String	Unique ID of the associated component.

","urlObject":{"path":["analytics","widget",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"section","value":"dashboard"},{"disabled":true,"description":{"content":"

[String] [Optional] Enter the query string to filter the response based on the Widget title that contains the query string. Default value: None

\n","type":"text/plain"},"key":"q","value":"incident"},{"disabled":true,"description":{"content":"

[integer] [Optional] Enter the page number. All the widgets of this page will be returned. Default value: 1

\n","type":"text/plain"},"key":"page","value":"2"},{"disabled":true,"description":{"content":"

[integer] [Optional] Enter the number of records to be retrieved per page. Default value: 10

\n","type":"text/plain"},"key":"page_size","value":"30"}],"variable":[]}},"response":[{"id":"4a175769-832e-4a5a-8516-c2b0ec273582","name":"Get List of Widgets","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/analytics/widget/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}§ion=dashboard","host":["{{base_url}}v1"],"path":["analytics","widget",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"section","value":"dashboard"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 19 Jan 2023 10:26:51 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {\n \"next\": \"openapi/v1/analytics/widget/?page=2&page_size=10&AccessID=6493f749-f8ae-4399-9b37-cf4bc3e589fe&Expires=1674124027&Signature=+kppo/OrZlBU410brudiQPMjT98=§ion=dashboard\"\n },\n \"count\": 191,\n \"results\": [\n {\n \"title\": \"No. of Incidents by Location\",\n \"unique_id\": \"fb811340-836c-4452-bdc5-f08655fd647b\",\n \"data_source\": \"analytics/data-source/?categorize_by=incidents_count_by_location\",\n \"is_removed\": false,\n \"icon\": \"icon icon-level\",\n \"chart_type\": \"GOOGLEMAPCLUSTER\",\n \"description\": \"No. of Incidents by Location\",\n \"categorize_by\": null,\n \"component_identifier\": \"incident\",\n \"compatible_chart_types\": [\n {\n \"display_name\": \"Map\",\n \"title\": \"google-map\",\n \"compatibilty_type\": \"google_map\",\n \"chart_type\": \"GOOGLEMAPCLUSTER\"\n }\n ],\n \"config\": {},\n \"display_icon_title\": \"google-map\",\n \"xAxisLabel\": \"Label\",\n \"yAxisLabel\": \"Value\",\n \"created_by\": \"b00daba3-44fe-4c61-8a22-085ad03206fc\",\n \"created_by_data\": {\n \"username\": \"jane.doe\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"b00daba3-44fe-4c61-8a22-085ad03206fc\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n }\n },\n {\n \"title\": \"Enhancement: Count of Closed Enhancements Per Type & Group\",\n \"unique_id\": \"d77b8ca6-5bef-4ae9-b756-c5daf7302720\",\n \"data_source\": \"analytics/data-source/?categorize_by=enhancement_closed_count_per_type_and_group&status=closed\",\n \"is_removed\": false,\n \"icon\": \"icon icon-level\",\n \"chart_type\": \"HEATMAP\",\n \"description\": \"Enhancement: Count of Closed Enhancements Per Type & Group\",\n \"categorize_by\": null,\n \"component_identifier\": \"enhancement\",\n \"compatible_chart_types\": [\n {\n \"display_name\": \"Heatmap\",\n \"title\": \"heatmap-chart\",\n \"compatibilty_type\": \"3d\",\n \"chart_type\": \"HEATMAP\"\n }\n ],\n \"config\": {},\n \"display_icon_title\": \"heatmap-chart\",\n \"xAxisLabel\": \"Group\",\n \"yAxisLabel\": \"Type\",\n \"created_by\": \"b00daba3-44fe-4c61-8a22-085ad03206fc\",\n \"created_by_data\": {\n \"username\": \"jane.doe\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"b00daba3-44fe-4c61-8a22-085ad03206fc\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n }\n },\n {\n \"title\": \"Enhancement: Count of Open Enhancements Per Type & Group\",\n \"unique_id\": \"2b567636-9389-4d01-bc3c-b4981438e902\",\n \"data_source\": \"analytics/data-source/?categorize_by=enhancement_open_count_per_type_and_group&status=open\",\n \"is_removed\": false,\n \"icon\": \"icon icon-level\",\n \"chart_type\": \"HEATMAP\",\n \"description\": \"Enhancement: Count of Open Enhancements Per Type & Group\",\n \"categorize_by\": null,\n \"component_identifier\": \"enhancement\",\n \"compatible_chart_types\": [\n {\n \"display_name\": \"Heatmap\",\n \"title\": \"heatmap-chart\",\n \"compatibilty_type\": \"3d\",\n \"chart_type\": \"HEATMAP\"\n }\n ],\n \"config\": {},\n \"display_icon_title\": \"heatmap-chart\",\n \"xAxisLabel\": \"Group\",\n \"yAxisLabel\": \"Type\",\n \"created_by\": \"b00daba3-44fe-4c61-8a22-085ad03206fc\",\n \"created_by_data\": {\n \"username\": \"jane.doe\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"b00daba3-44fe-4c61-8a22-085ad03206fc\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n }\n },\n {\n \"title\": \"Enhancement: Count of Enhancements Per Type & Group\",\n \"unique_id\": \"23ceb675-bdde-413b-a4fd-b54d6551d03c\",\n \"data_source\": \"analytics/data-source/?categorize_by=enhancement_count_per_type_and_group\",\n \"is_removed\": false,\n \"icon\": \"icon icon-level\",\n \"chart_type\": \"HEATMAP\",\n \"description\": \"Enhancement: Count of Enhancements Per Type & Group\",\n \"categorize_by\": null,\n \"component_identifier\": \"enhancement\",\n \"compatible_chart_types\": [\n {\n \"display_name\": \"Heatmap\",\n \"title\": \"heatmap-chart\",\n \"compatibilty_type\": \"3d\",\n \"chart_type\": \"HEATMAP\"\n }\n ],\n \"config\": {},\n \"display_icon_title\": \"heatmap-chart\",\n \"xAxisLabel\": \"Group\",\n \"yAxisLabel\": \"Type\",\n \"created_by\": \"b00daba3-44fe-4c61-8a22-085ad03206fc\",\n \"created_by_data\": {\n \"username\": \"jane.doe\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"b00daba3-44fe-4c61-8a22-085ad03206fc\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n }\n },\n {\n \"title\": \"Enhancement: Count of Closed Enhancements Per Type & Analyst\",\n \"unique_id\": \"ea1a5b60-1169-466d-a4af-d7c01ea3fc30\",\n \"data_source\": \"analytics/data-source/?categorize_by=enhancement_closed_count_per_type_and_analyst&status=closed\",\n \"is_removed\": false,\n \"icon\": \"icon icon-level\",\n \"chart_type\": \"HEATMAP\",\n \"description\": \"Enhancement: Count of Closed Enhancements Per Type & Analyst\",\n \"categorize_by\": null,\n \"component_identifier\": \"enhancement\",\n \"compatible_chart_types\": [\n {\n \"display_name\": \"Heatmap\",\n \"title\": \"heatmap-chart\",\n \"compatibilty_type\": \"3d\",\n \"chart_type\": \"HEATMAP\"\n }\n ],\n \"config\": {},\n \"display_icon_title\": \"heatmap-chart\",\n \"xAxisLabel\": \"Analyst\",\n \"yAxisLabel\": \"Type\",\n \"created_by\": \"b00daba3-44fe-4c61-8a22-085ad03206fc\",\n \"created_by_data\": {\n \"username\": \"jane.doe\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"b00daba3-44fe-4c61-8a22-085ad03206fc\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n }\n },\n {\n \"title\": \"Enhancement: Count of Open Enhancements Per Type & Analyst\",\n \"unique_id\": \"708b7c48-6abe-4e43-9784-67e546c8deeb\",\n \"data_source\": \"analytics/data-source/?categorize_by=enhancement_open_count_per_type_and_analyst&status=open\",\n \"is_removed\": false,\n \"icon\": \"icon icon-level\",\n \"chart_type\": \"HEATMAP\",\n \"description\": \"Enhancement: Count of Open Enhancements Per Type & Analyst\",\n \"categorize_by\": null,\n \"component_identifier\": \"enhancement\",\n \"compatible_chart_types\": [\n {\n \"display_name\": \"Heatmap\",\n \"title\": \"heatmap-chart\",\n \"compatibilty_type\": \"3d\",\n \"chart_type\": \"HEATMAP\"\n }\n ],\n \"config\": {},\n \"display_icon_title\": \"heatmap-chart\",\n \"xAxisLabel\": \"Analyst\",\n \"yAxisLabel\": \"Type\",\n \"created_by\": \"b00daba3-44fe-4c61-8a22-085ad03206fc\",\n \"created_by_data\": {\n \"username\": \"jane.doe\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"b00daba3-44fe-4c61-8a22-085ad03206fc\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n }\n },\n {\n \"title\": \"Enhancement: Count of Enhancements Per Type & Analyst\",\n \"unique_id\": \"50728995-e7ef-445b-9df7-bfe2394f9449\",\n \"data_source\": \"analytics/data-source/?categorize_by=enhancement_count_per_type_and_analyst\",\n \"is_removed\": false,\n \"icon\": \"icon icon-level\",\n \"chart_type\": \"HEATMAP\",\n \"description\": \"Enhancement: Count of Enhancements Per Type & Analyst\",\n \"categorize_by\": null,\n \"component_identifier\": \"enhancement\",\n \"compatible_chart_types\": [\n {\n \"display_name\": \"Heatmap\",\n \"title\": \"heatmap-chart\",\n \"compatibilty_type\": \"3d\",\n \"chart_type\": \"HEATMAP\"\n }\n ],\n \"config\": {},\n \"display_icon_title\": \"heatmap-chart\",\n \"xAxisLabel\": \"Analyst\",\n \"yAxisLabel\": \"Type\",\n \"created_by\": \"b00daba3-44fe-4c61-8a22-085ad03206fc\",\n \"created_by_data\": {\n \"username\": \"jane.doe\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"b00daba3-44fe-4c61-8a22-085ad03206fc\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n }\n },\n {\n \"title\": \"Action by Status per Assigned Group\",\n \"unique_id\": \"a44f2ead-1676-47d7-ba74-4011398d1a77\",\n \"data_source\": \"analytics/data-source/?categorize_by=action_status_per_group&sort_by=label\",\n \"is_removed\": false,\n \"icon\": \"icon icon-level\",\n \"chart_type\": \"STACKED-COLUMN\",\n \"description\": \"Count of actions per status per assigned group\",\n \"categorize_by\": null,\n \"component_identifier\": \"action\",\n \"compatible_chart_types\": [\n {\n \"display_name\": \"Multi Line Area\",\n \"title\": \"multi-line-area-chart\",\n \"compatibilty_type\": \"multiple_2d\",\n \"chart_type\": \"MULTI-AREA\"\n },\n {\n \"display_name\": \"Multi Line\",\n \"title\": \"multiline-chart\",\n \"compatibilty_type\": \"multiple_2d\",\n \"chart_type\": \"MULTI-LINE\"\n },\n {\n \"display_name\": \"Stacked Bar\",\n \"title\": \"stack-bar-chart\",\n \"compatibilty_type\": \"multiple_2d\",\n \"chart_type\": \"STACKED-BAR\"\n },\n {\n \"display_name\": \"Stacked Column\",\n \"title\": \"stacked_column\",\n \"compatibilty_type\": \"multiple_2d\",\n \"chart_type\": \"STACKED-COLUMN\"\n },\n {\n \"display_name\": \"Grouped Column\",\n \"title\": \"grouped_column\",\n \"compatibilty_type\": \"multiple_2d\",\n \"chart_type\": \"GROUPED-COLUMN\"\n }\n ],\n \"config\": {},\n \"display_icon_title\": \"stacked_column\",\n \"xAxisLabel\": \"Group\",\n \"yAxisLabel\": \"Action Count\",\n \"created_by\": \"b00daba3-44fe-4c61-8a22-085ad03206fc\",\n \"created_by_data\": {\n \"username\": \"jane.doe\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"b00daba3-44fe-4c61-8a22-085ad03206fc\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n }\n },\n {\n \"title\": \"Action: Count of Closed Actions Per Type & Analyst\",\n \"unique_id\": \"a4eee7f3-74ae-40d0-9976-ac9e4ec33e25\",\n \"data_source\": \"analytics/data-source/?categorize_by=analyst_closed_action_type_count&status=closed\",\n \"is_removed\": false,\n \"icon\": \"icon icon-level\",\n \"chart_type\": \"HEATMAP\",\n \"description\": \"Action: Count of Closed Actions Per Type & Analyst\",\n \"categorize_by\": null,\n \"component_identifier\": \"action\",\n \"compatible_chart_types\": [\n {\n \"display_name\": \"Heatmap\",\n \"title\": \"heatmap-chart\",\n \"compatibilty_type\": \"3d\",\n \"chart_type\": \"HEATMAP\"\n }\n ],\n \"config\": {},\n \"display_icon_title\": \"heatmap-chart\",\n \"xAxisLabel\": \"Analyst\",\n \"yAxisLabel\": \"Action Type\",\n \"created_by\": \"b00daba3-44fe-4c61-8a22-085ad03206fc\",\n \"created_by_data\": {\n \"username\": \"jane.doe\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"b00daba3-44fe-4c61-8a22-085ad03206fc\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n }\n },\n {\n \"title\": \"Action: Count of Open Actions Per Type & Analyst\",\n \"unique_id\": \"bed2ecbe-bba8-49e4-8766-5a779db6b775\",\n \"data_source\": \"analytics/data-source/?categorize_by=analyst_open_action_type_count&status=open\",\n \"is_removed\": false,\n \"icon\": \"icon icon-level\",\n \"chart_type\": \"HEATMAP\",\n \"description\": \"Action: Count of Open Actions Per Type & Analyst\",\n \"categorize_by\": null,\n \"component_identifier\": \"action\",\n \"compatible_chart_types\": [\n {\n \"display_name\": \"Heatmap\",\n \"title\": \"heatmap-chart\",\n \"compatibilty_type\": \"3d\",\n \"chart_type\": \"HEATMAP\"\n }\n ],\n \"config\": {},\n \"display_icon_title\": \"heatmap-chart\",\n \"xAxisLabel\": \"Analyst\",\n \"yAxisLabel\": \"Action Type\",\n \"created_by\": \"b00daba3-44fe-4c61-8a22-085ad03206fc\",\n \"created_by_data\": {\n \"username\": \"jane.doe\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"b00daba3-44fe-4c61-8a22-085ad03206fc\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n }\n }\n ],\n \"mapping\": {\n \"dropdown_display_name\": \"readable_id\"\n }\n}"}],"_postman_id":"87714230-a059-4d79-97fb-81f00a61cf3c"},{"name":"Get Widget Details","event":[{"listen":"prerequest","script":{"id":"1e757935-f9c2-4eaa-94ed-9a1a5c03498c","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"7ef9daab-1cc5-4de8-93b4-5879ada51038","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/analytics/widget/:widget_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the configuration details of a widget from the CFTR application.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`title`	String	Title of the widget.
`unique_id`	String	Unique identifier string of the widget in UUID-4 format.
`data_source`	String	Endpoint of the widget.
`is_removed`	Boolean	Shows whether the widget is in a deleted state or not.
`chart_type`	String	Chart type of the widget.
`component_identifier`	String	Unique ID of the associated component.
`compatible_chart_types`	List	List of chart types applicable for the widget.
`created_by`	String	For a custom widget, it displays the `user_id` of the user who created the widget.
`created_by_data`	Object	Details of the user who created the widget.

","urlObject":{"path":["analytics","widget",":widget_unique_id",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"description":{"content":"

Enter the Unique ID of the widget.

\n","type":"text/plain"},"type":"any","value":"0f44d826-1fab-4f41-9d7b-c3eb9f3f459b","key":"widget_unique_id"}]}},"response":[{"id":"93697d05-4f97-4375-908b-e901f02bc73e","name":"Get Widget Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/analytics/widget/:widget_unique_id/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["analytics","widget",":widget_unique_id",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}],"variable":[{"key":"widget_unique_id","value":"0f44d826-1fab-4f41-9d7b-c3eb9f3f459b","description":"Enter the Unique ID of the widget"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 19 Jan 2023 11:15:19 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"title\": \"Incident: Business Units Impacted\",\n \"unique_id\": \"0f44d826-1fab-4f41-9d7b-c3eb9f3f459b\",\n \"data_source\": \"analytics/incident/stats/?categorize_by=business_units_impacted\",\n \"is_removed\": false,\n \"icon\": \"icon icon-level\",\n \"chart_type\": \"COLUMN\",\n \"description\": \"Incidents categorized by Business Units Impacted\",\n \"categorize_by\": null,\n \"component_identifier\": \"incident\",\n \"compatible_chart_types\": [\n {\n \"display_name\": \"Bar\",\n \"title\": \"bar-chart\",\n \"compatibilty_type\": \"2d\",\n \"chart_type\": \"BAR\"\n },\n {\n \"display_name\": \"Pie\",\n \"title\": \"pie-chart\",\n \"compatibilty_type\": \"2d\",\n \"chart_type\": \"PIE\"\n },\n {\n \"display_name\": \"Area\",\n \"title\": \"single-line-area-chart\",\n \"compatibilty_type\": \"2d\",\n \"chart_type\": \"AREA\"\n },\n {\n \"display_name\": \"Line\",\n \"title\": \"line-chart\",\n \"compatibilty_type\": \"2d\",\n \"chart_type\": \"LINE\"\n },\n {\n \"display_name\": \"Radial Pie\",\n \"title\": \"radial_pie\",\n \"compatibilty_type\": \"2d\",\n \"chart_type\": \"RADIUS-PIE\"\n },\n {\n \"display_name\": \"Column\",\n \"title\": \"column\",\n \"compatibilty_type\": \"2d\",\n \"chart_type\": \"COLUMN\"\n },\n {\n \"display_name\": \"Bubble\",\n \"title\": \"bubble\",\n \"compatibilty_type\": \"2d\",\n \"chart_type\": \"BUBBLE\"\n }\n ],\n \"config\": {},\n \"display_icon_title\": \"column\",\n \"xAxisLabel\": \"Business Units Impacted\",\n \"yAxisLabel\": \"Incident Count\",\n \"created_by\": \"b00daba3-44fe-4c61-8a22-085ad03206fc\",\n \"created_by_data\": {\n \"username\": \"jane.doe\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"b00daba3-44fe-4c61-8a22-085ad03206fc\",\n \"is_active\": true,\n \"email\": \"jane.doe@example.com\",\n \"full_name\": \"Jane Doe\"\n }\n}"}],"_postman_id":"7ef9daab-1cc5-4de8-93b4-5879ada51038"},{"name":"Get Widget Data","event":[{"listen":"prerequest","script":{"id":"1e757935-f9c2-4eaa-94ed-9a1a5c03498c","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"ed896a5b-06c3-4567-a431-30025d28b4a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/&AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve the data displayed by a widget as per the applied filters.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`label`	String	Returns the label name of the widget data.
`value`	String	Returns the value of the widget data.

","urlObject":{"path":["&AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}"],"host":["{{base_url}}v1"],"query":[{"disabled":true,"description":{"content":"

[optional] Enter the unique ID of a location. This parameter retrieves the widget data associated with the location.

You can retrieve the list of available Locations and their Unique IDs using the following API endpoint:

/openapi/v1/utils/location/

\n","type":"text/plain"},"key":"locations","value":"c762af64-62ca-49d6-be93-d1ab55ef8a05"},{"disabled":true,"description":{"content":"

[optional] [integer] Enter a timestamp in EPOCH format to retrieve the widget data created before this time.

\n","type":"text/plain"},"key":"created_date__lte","value":"1674132589"},{"disabled":true,"description":{"content":"

[optional] [float] Enter a timestamp in EPOCH format to retrieve the widget data created after this time.

\n","type":"text/plain"},"key":"created_date__gte","value":"1666180189"},{"disabled":true,"description":{"content":"

[optional] Enter the unique ID of a business unit. This parameter retrieves the widget data associated with the business unit.

You can retrieve the list of available Business Units and their Unique IDs using the following API endpoint:

/openapi/v1/utils/business-unit/

\n","type":"text/plain"},"key":"business_units","value":"1f0d6475-bb3c-48d7-865f-2f75a5f16089"}],"variable":[]}},"response":[{"id":"c2e879dc-9c36-4ec1-83c6-b8e606fb060d","name":"Get Widget Data","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/analytics/incident/stats/?categorize_by=business_units_impacted&AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["analytics","incident","stats",""],"query":[{"key":"categorize_by","value":"business_units_impacted"},{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 19 Jan 2023 11:37:14 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data:;","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"[\n {\n \"label\": \"System\",\n \"value\": 48,\n \"filters\": {\n \"business_units\": \"a17640aa-ae1b-42c9-b8a8-875dd3bfad7f\"\n },\n \"color_code\": null\n },\n {\n \"label\": \"ADP Airport\",\n \"value\": 31,\n \"filters\": {\n \"business_units\": \"1f0d6475-bb3c-48d7-865f-2f75a5f16089\"\n },\n \"color_code\": null\n },\n {\n \"label\": \"AeroMexico\",\n \"value\": 2,\n \"filters\": {\n \"business_units\": \"a9e47ee3-198d-4ef6-9c2a-52b950168e69\"\n },\n \"color_code\": null\n },\n {\n \"label\": \"Airbus\",\n \"value\": 1,\n \"filters\": {\n \"business_units\": \"f9e88579-2888-421c-972d-d698f5985126\"\n },\n \"color_code\": null\n },\n {\n \"label\": \"Air Canada\",\n \"value\": 1,\n \"filters\": {\n \"business_units\": \"23c1fc2d-3813-4bb7-93c7-356d171b8933\"\n },\n \"color_code\": null\n },\n {\n \"label\": \"Air New Zealand\",\n \"value\": 1,\n \"filters\": {\n \"business_units\": \"af02462e-60c2-4a84-9a13-9860c2976d25\"\n },\n \"color_code\": null\n },\n {\n \"label\": \"Airports Council International\",\n \"value\": 1,\n \"filters\": {\n \"business_units\": \"49030079-f8a1-44c6-aa5c-3fc3b369187d\"\n },\n \"color_code\": null\n }\n]"}],"_postman_id":"ed896a5b-06c3-4567-a431-30025d28b4a3"}],"id":"63f538c5-2597-4c21-87b8-464fd6381f90","description":"

Dashboards show streamlined, actionable data and display data at a glance by collecting data from the Incidents, thereby reducing the time needed for analyzing and responding to high-risk threats and stopping them early in the attack kill chain.

This section describes how to use the API endpoints to retrieve the dashboard widget data.

\n","_postman_id":"63f538c5-2597-4c21-87b8-464fd6381f90"},{"name":"Knowledge Base","item":[{"name":"Knowledge Base Articles","id":"752bcfdf-f258-428d-8d7c-4f5ed097c77b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/knowledge-base/document/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&page_size=30&page=1&status=active&format=Framework","description":"

Retrieves the list of Knowledge Base articles from the Respond (CFTR) application.

Note: This API endpoint is available in Respond v3.4.3.3 onwards

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key displays the API endpoint to the previous page. `next` key displays the API endpoint to the next page.
`count`	Integer	Total number of Knowledge Base articles returned as per the entered query parameters.
`results`	Array of Objects	Details of the Knowledge Base article. Each object provides the details of one Knowledge Base article.

Response Parameters | Results Object

Parameter	Type	Description
`format`	String	Type of the Knowledge Base article. For example, Framework. Allowed values: Framework Guidelines Playbook Policy Report SOP Workflow
`tlp`	String	TLP of the Knowledge Base article. For example, Red. Allowed values: Red Amber Green White
`title`	String	Title of the Knowledge Base article.
`description`	String	Description of the Knowledge Base article.
`unique_id`	String	Unique ID of the Knowledge Base article in the UUID-4 format.
`readable_id`	String	Unique readable ID of the Knowledge Base article. It starts with KNB followed by a unique number. Example: KNB101
`created`	String	Created time of the Knowledge Base article in ISO format.
`modified`	String	Last modified time of the Knowledge Base article.
`business_units`	List of UUIDs	List of business units associated with the Knowledge Base article.
`locations`	List of UUIDs	List of locations associated with the Knowledge Base article.
`business_units_data`	List of Objects	Details of the business units associated with the Knowledge Base article. Details include: title, description, unique_id, created, and more.
`locations_data`	List of Objects	Details of the locations associated with the Knowledge Base article. Details include: title, unique_id, is_active, and more.
`created_by`	String	User ID of the user who created the Knowledge Base article.
`created_by_data`	Object	Details of the user who created the Knowledge Base article. Details include: user_id, first_name, email, username, and more.
`is_bookmarked`	Boolean	Displays if the incident is bookmarked or not.
`status`	String	Status of the Knowledge Base article. Allowed values: active inactive
`attachments_data`	Object	Details of the attachments associated to the Knowledge Base article.
`labels`	List	List of the labels that are added to the Knowledge Base article.
`labels_data`	List of Objects	Details of the labels that are added to the Knowledge Base article.
`incident_data`	Object	Details of the incident associated with the Knowledge Base article. Details include: unique_id, readable_id, created, modified, and more.
`action_data`	List of Objects	Details of the action associated with Knowledge Base article.
`format_data`	Object	Details of the Knowledge Base article type. Details include: unique_id, option_name, is_active, and more.
`tlp_data`	Object	Details of the tlp associated with the Knowledge Base article. Details include: unique_id, order, option_name, and more.

","urlObject":{"path":["knowledge-base","document",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"page_size","value":"30"},{"key":"page","value":"1"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the Knowledge Base article in EPOCH Time format. Time Zone must be as per UTC. All Knowledge Base articles with creation date later than the entered time will be returned.

\n","type":"text/plain"},"key":"created_date__gte","value":"1643283426"},{"disabled":true,"description":{"content":"

[optional] Enter the creation time of the Knowledge Base article in EPOCH Time format. Time Zone must be as per UTC. All Knowledge Base articles with creation date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"created_date__lte","value":"1643283426"},{"description":{"content":"

Status of the Knowledge Base article.\nAllowed values:\nactive\ninactive

\n","type":"text/plain"},"key":"status","value":"active"},{"disabled":true,"description":{"content":"

[optional] Enter the last modified time of the Knowledge Base article in EPOCH Time format. Time Zone must be as per UTC. All Knowledge Base article with modified date later than the entered time will be returned.

\n","type":"text/plain"},"key":"modified_date__gte","value":"1643283427"},{"disabled":true,"description":{"content":"

[optional] Enter the last modified time of the Knowledge Base article in EPOCH Time format. Time Zone must be as per UTC. All Knowledge Base artciel with modified date earlier than the entered time will be returned.

\n","type":"text/plain"},"key":"modified_date__lte","value":"1643283427"},{"description":{"content":"

[optional]Type of the Knowledge Base article.\nAllowed values:\nFramework \nGuidelines \nPlaybook
Policy
Report
SOP
Workflow

\n","type":"text/plain"},"key":"format","value":"Framework"}],"variable":[]}},"response":[{"id":"7a0e46ec-17ac-4001-b92d-2859b909f441","name":"Knowledge Base Articles","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/knowledge-base/document/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&page_size=30&page=1&created_date__gte=1643283426&created_date__lte=1643283426&status=active&modified_date__gte=1643283427&modified_date__lte=1643283427","host":["{{base_url}}v1"],"path":["knowledge-base","document",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"page_size","value":"30"},{"key":"page","value":"1"},{"key":"created_date__gte","value":"1643283426","description":"[optional] Enter the creation time of the Knowledge Base article in EPOCH Time format. Time Zone must be as per UTC. All Knowledge Base articles with creation date later than the entered time will be returned."},{"key":"created_date__lte","value":"1643283426","description":"[optional] Enter the creation time of the Knowledge Base article in EPOCH Time format. Time Zone must be as per UTC. All Knowledge Base articles with creation date earlier than the entered time will be returned."},{"key":"status","value":"active","description":"Status of the Knowledge Base article.\nAllowed values:\nactive\ninactive"},{"key":"modified_date__gte","value":"1643283427","description":"[optional] Enter the last modified time of the Knowledge Base article in EPOCH Time format. Time Zone must be as per UTC. All Knowledge Base article with modified date later than the entered time will be returned."},{"key":"modified_date__lte","value":"1643283427","description":"[optional] Enter the last modified time of the Knowledge Base article in EPOCH Time format. Time Zone must be as per UTC. All Knowledge Base artciel with modified date earlier than the entered time will be returned."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 10 Oct 2024 10:45:15 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"origin, Cookie","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: http: data: blob:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 1,\n \"results\": [\n {\n \"format\": \"Framework\",\n \"tlp\": \"Red\",\n \"title\": \"Block IP addresses\",\n \"description\": \"Steps to block ip addresses\",\n \"unique_id\": \"e0d48497-2ebe-4d3e-b1da-9bbcc24d3079\",\n \"readable_id\": \"KNB101\",\n \"created\": \"2024-10-01T11:19:36.478633Z\",\n \"modified\": \"2024-10-10T10:39:52.139391Z\",\n \"entity\": null,\n \"business_units\": [\n \"5da17287-41fa-421e-9aa0-d14ed14805ce\"\n ],\n \"locations\": [\n \"1c96d6a3-56be-4243-8d38-8014c18eb0bc\"\n ],\n \"business_units_data\": [\n {\n \"title\": \"finance\",\n \"description\": \"finance security tasks\",\n \"unique_id\": \"5da17287-41fa-421e-9aa0-d14ed14805ce\",\n \"created\": \"2024-10-01T09:24:29.530355Z\",\n \"modified\": \"2024-10-01T09:24:29.530355Z\",\n \"readable_id\": \"BU102\",\n \"email_list\": \"finance@org.com\"\n }\n ],\n \"locations_data\": [\n {\n \"title\": \"Tokyo\",\n \"unique_id\": \"1c96d6a3-56be-4243-8d38-8014c18eb0bc\",\n \"is_active\": true\n }\n ],\n \"entity_data\": null,\n \"created_by\": \"846a5b34-f6dc-4355-bf55-adbd6952c3d4\",\n \"created_by_data\": {\n \"user_id\": \"846a5b34-f6dc-4355-bf55-adbd6952c3d4\",\n \"first_name\": \"john\",\n \"last_name\": \"doe\",\n \"email\": \"john.doe@org.com\",\n \"display_pic\": null,\n \"username\": \"john\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"john doe\"\n },\n \"is_bookmarked\": false,\n \"status\": \"active\",\n \"attachments_data\": [],\n \"labels\": [],\n \"labels_data\": [],\n \"incident_data\": [\n {\n \"unique_id\": \"137c0385-d455-47a1-8cbc-a290aba36c0f\",\n \"readable_id\": \"INC112\",\n \"fab0b78d-9c9b-4415-a0ae-00261b541db6\": \"Api_automation 2024-10-01 16:45:16.291251\",\n \"226bad73-af54-4f1d-aa99-66bffc550754\": \"cca35989-7446-4d67-80b5-6c3af75d2d07\",\n \"created\": \"2024-10-01T11:18:24.576650Z\",\n \"modified\": \"2024-10-01T11:26:32.788826Z\",\n \"title_display\": \"Phishing email found\",\n \"487d1b42-8250-4b7f-aeb6-a57d77f43e63_data\": {\n \"username\": \"john\",\n \"first_name\": \"john\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"06962c3b-300b-47a9-b117-8288235812e6\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"john.doe@org.tld\",\n \"full_name\": \"John Doe\"\n },\n \"is_bookmarked\": false,\n \"f52faff5-dee6-44be-b5ac-debde96bf3d1\": null,\n \"created_by_data\": {\n \"username\": \"john\",\n \"first_name\": \"john\",\n \"last_name\": \"doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"846a5b34-f6dc-4355-bf55-adbd6952c3d4\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"john.doe@org.com\",\n \"full_name\": \"john doe\"\n },\n \"closed_on\": null,\n \"b048d7f3-f3fd-4a8e-afbe-1daab12fdbd0_data\": {\n \"group_comm_id\": \"b9797946-1f78-49be-96b8-d0b16033126d\",\n \"group_name\": \"CFTR Admin\"\n },\n \"severity_title\": null,\n \"can_update_instance\": true,\n \"1ec0b398-d100-4ad7-a59e-6b119dd917a6_data\": {\n \"unique_id\": \"5fccc884-4b87-4978-83bb-8476790a6a66\",\n \"option_name\": \"Detection Analysis\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"1ec0b398-d100-4ad7-a59e-6b119dd917a6\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"1ec0b398-d100-4ad7-a59e-6b119dd917a6\": \"5fccc884-4b87-4978-83bb-8476790a6a66\",\n \"226bad73-af54-4f1d-aa99-66bffc550754_data\": {\n \"unique_id\": \"cca35989-7446-4d67-80b5-6c3af75d2d07\",\n \"option_name\": \"Open\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"226bad73-af54-4f1d-aa99-66bffc550754\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": \"#E53535\"\n }\n }\n ],\n \"actions_data\": [],\n \"format_data\": {\n \"unique_id\": \"786927bf-d0ed-4bf4-8f3c-22f242fb11c1\",\n \"option_name\": \"Framework\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"0554f3e3-c9f3-424d-a072-4ced2648dc51\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"tlp_data\": {\n \"unique_id\": \"904f95d5-5cc0-4c4c-99d0-6e330dfd8440\",\n \"option_name\": \"Red\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"5f6ea04a-f0af-4fb0-a88b-637175065a6d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n }"}],"_postman_id":"752bcfdf-f258-428d-8d7c-4f5ed097c77b"},{"name":"Knowledge Base Articles (Advanced)","event":[{"listen":"prerequest","script":{"exec":["var accessid = pm.environment.get(\"open_api_access_id\");","var secret_key = pm.environment.get(\"open_api_secret_key\");","/*"," -generating epochtime"," -epochtime is being send in expires parameter of params"," -sign is generated and then passed for generating signature","*/","pm.environment.set(\"unixtimestamp\",Math.round(Date.now()/1000));","var expires = pm.environment.get(\"unixtimestamp\")+15;","pm.environment.set('UTC Timezone', new Date().toISOString());","pm.environment.set(\"expires\", expires);","var to_sign = accessid+\"\\n\"+expires;","/*","Generate Signature for Authentication"," -Key based hashing is done using HMAC-SHA1 Algorithm"," -This is then converted into base64"," -Finally the generated signature is URL Encoded so as to make all the special characters URL Safe","*/","var hash = CryptoJS.HmacSHA1(to_sign, secret_key);","var hashInBase64 = encodeURIComponent(CryptoJS.enc.Base64.stringify(hash));","pm.environment.set(\"signature\",hashInBase64);"],"type":"text/javascript","packages":{},"requests":{},"id":"fff7782b-f174-4aac-b961-7b65e35756df"}}],"id":"d3c415ac-2a67-4def-aec7-39c44bf92dcc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{base_url}}v1/knowledge-base/document/qb/extended/?AccessID={{open_api_access_id}}&Signature={{signature}}&Expires={{expires}}","description":"

Retrieves knowledge base articles with details, including IDs, timestamps, and status.

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key displays the API endpoint to the previous page. `next` key displays the API endpoint to the next page.
`count`	Integer	Total number of Knowledge Base articles returned as per the entered query parameters.
`results`	Array of Objects	Details of the Knowledge Base article. Each object provides the details of one Knowledge Base article.

Response Parameters | Results Object

Parameter	Type	Description
`format`	String	Type of the Knowledge Base article. For example, Framework. Allowed values: Framework Guidelines Playbook Policy Report SOP Workflow
`tlp`	String	TLP of the Knowledge Base article. For example, Red. Allowed values: Red Amber Green White
`title`	String	Title of the Knowledge Base article.
`description`	String	Description of the Knowledge Base article.
`unique_id`	String	Unique ID of the Knowledge Base article in the UUID-4 format.
`readable_id`	String	Unique readable ID of the Knowledge Base article. It starts with KNB followed by a unique number. Example: KNB101
`created`	String	Created time of the Knowledge Base article in ISO format.
`modified`	String	Last modified time of the Knowledge Base article.
`business_units`	List of UUIDs	List of business units associated with the Knowledge Base article.
`locations`	List of UUIDs	List of locations associated with the Knowledge Base article.
`business_units_data`	List of Objects	Details of the business units associated with the Knowledge Base article. Details include: title, description, unique_id, created, and more.
`locations_data`	List of Objects	Details of the locations associated with the Knowledge Base article. Details include: title, unique_id, is_active, and more.
`created_by`	String	User ID of the user who created the Knowledge Base article.
`created_by_data`	Object	Details of the user who created the Knowledge Base article. Details include: user_id, first_name, email, username, and more.
`is_bookmarked`	Boolean	Displays if the incident is bookmarked or not.
`status`	String	Status of the Knowledge Base article. Allowed values: active inactive
`attachments_data`	Object	Details of the attachments associated to the Knowledge Base article.
`labels`	List	List of the labels that are added to the Knowledge Base article.
`labels_data`	List of Objects	Details of the labels that are added to the Knowledge Base article.
`incident_data`	Object	Details of the incident associated with the Knowledge Base article. Details include: unique_id, readable_id, created, modified, and more.
`action_data`	List of Objects	Details of the action associated with Knowledge Base article.
`format_data`	Object	Details of the Knowledge Base article type. Details include: unique_id, option_name, is_active, and more.
`tlp_data`	Object	Details of the tlp associated with the Knowledge Base article. Details include: unique_id, order, option_name, and more.

","urlObject":{"path":["knowledge-base","document","qb","extended",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Signature","value":"{{signature}}"},{"key":"Expires","value":"{{expires}}"}],"variable":[]}},"response":[{"id":"1772ad40-11c5-4d8a-876d-77a9d03a220f","name":"Knowledge Base Articles","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/knowledge-base/document/qb/extended/?AccessID={{open_api_access_id}}&Signature={{signature}}&Expires={{expires}}","host":["{{base_url}}v1"],"path":["knowledge-base","document","qb","extended",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Signature","value":"{{signature}}"},{"key":"Expires","value":"{{expires}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Tue, 17 Feb 2026 15:09:01 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET"},{"key":"Vary","value":"origin, Cookie"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;"},{"key":"Content-Security-Policy","value":"img-src https: http: data: blob:;"},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 2,\n \"results\": [\n {\n \"title\": \"Root Cause Analysis\",\n \"unique_id\": \"00d07888-c706-4dc0-a0bd-98bb84e49f5c\",\n \"readable_id\": \"KNB102\",\n \"created\": \"2026-02-16T05:41:25.806952Z\",\n \"modified\": \"2026-02-16T05:41:32.140726Z\",\n \"status\": \"inactive\"\n }\n ],\n \"mapping\": {\n \"title\": \"5e2e9169-b1d5-420e-96b6-bfc4aef8e453\",\n \"format\": \"061551d7-489a-4b64-9204-c8622801ab97\",\n \"location\": \"34089dd7-bc6c-4b8e-9b29-6f0b20d35f41\",\n \"business-unit\": \"72785627-c44b-4db7-8f86-d79b293318b0\",\n \"tlp\": \"1b409710-38a5-484f-88ca-d7f0ed0594bc\",\n \"label\": \"66d18e11-d9b6-4aae-b9ad-13683269d374\",\n \"description\": \"5b72db5d-0e1b-4ce5-b0dd-09fd90fe0aa8\",\n \"incident\": \"21339aed-9629-419f-a534-83bce3b3cbbd\",\n \"action\": \"b3700be4-fbf0-44fd-8afd-12547e5081e8\",\n \"dropdown_display_name\": \"readable_id\"\n }\n}"}],"_postman_id":"d3c415ac-2a67-4def-aec7-39c44bf92dcc"},{"name":"Create Knowledge Base Article","id":"b8080945-2a85-4483-9e25-0f320d956f77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"block ip address\",\n \"format\": \"framework\",\n \"business_units\": [\n \"System\"\n ],\n \"locations\": [\n \"System\"\n ],\n \"tlp\": \"red\",\n \"labels\": [\n \"high priority\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/knowledge-base/document/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Create Knowledge Base article in Respond.

Note: This API endpoint is available in Respond v3.4.3.3 onwards

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required/Optional	Description
`title`	String	Mandatory	Enter the title for the Knowledge Base article.
`description`	String	Optional	Enter a description for the Knowledge Base article.
`format`	String	Mandatory	Enter the type of the Knowledge Base article. Allowed values: Framework Guideline Playbook Policy Report SOP Workflow
`business_units`	List	Mandatory	Enter the unique IDs of the business units who can access the Knowledge Base article.
`locations`	List	Mandatory	Enter the unique IDs of the locations who can access the Knowledge Base article.
`tlp`	String	Mandatory	Enter a TLP for the Knowledge Base article. Allowed values: Red Green Amber White
`labels`	List of UUIDs	Optional	Enter the labels for the Knowledge Base article.
`incidents`	List of UUIDs	Optional	Enter the UUIDs of the incidents to link with the Knowledge Base article.
`actions`	List of UUIDs	Optional	Enter the UUIDs of the actions to link with the Knowledge Base article.

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key displays the API endpoint to the previous page. `next` key displays the API endpoint to the next page.
`count`	Integer	Total number of Knowledge Base articles returned as per the entered query parameters.
`results`	Array of Objects	Details of the Knowledge Base article. Each object provides the details of one Knowledge Base article.

Response Parameters | Results Object

Parameter	Type	Description
`format`	String	Type of the Knowledge Base article. For example, framework.
`tlp`	String	TLP of the Knowledge Base article. For example, Red.
`title`	String	Title of the Knowledge Base article.
`description`	String	Description of the Knowledge Base article.
`unique_id`	String	Unique ID of the Knowledge Base article in UUID-4 format.
`readable_id`	String	Unique readable ID of the Knowledge Base article. It starts with KNB followed by a unique number. Example: KNB101
`created`	String	Created time of the Knowledge Base article in ISO format.
`modified`	String	Last modified time of the Knowledge Base article.
`business_units`	List of UUIDs	List of business units associated with the Knowledge Base article.
`locations`	List of UUIDs	List of locations associated with the Knowledge Base article.
`business_units_data`	Lists of Objects	Details of the business units associated with the Knowledge Base article. Details include: title, description, unique_id, created, and more.
`locations_data`	List of Objects	Details of the locations associated with the Knowledge Base article. Details include: title, unique_id, is_active, and more.
`created_by`	String	User ID of the user who created the Knowledge Base article.
`created_by_data`	Object	Details of the user who created the Knowledge Base article. Details include: user_id, first_name, email, username, and more.
`is_bookmarked`	Boolean	Shows if the incident is bookmarked or not.
`status`	String	Status of the Knowledge Base article. Allowed values: active inactive
`attachments_data`	Object	Details of the attachments attached to the Knowledge Base article.
`labels`	List	List of the labels that are added to the Knowledge Base article.
`labels_data`	List of Objects	Details of the labels that are added to the Knowledge Base article.
`incident_data`	Object	Details of the incident associated with the Knowledge Base article. Details include: unique_id, readable_id, created, modified, and more.
`action_data`	List of Objects	Details of the action associated with Knowledge Base article.
`format_data`	Object	Details of the Knowledge Base article type. Details include: unique_id, option_name, is_active, and more.
`tlp_data`	Object	Details of the tlp associated with the Knowledge Base article. Details include: unique_id, order, option_name, and more.
`format`	String	Type of the Knowledge Base article. Allowed values: Framework Guidelines Playbook Policy Report SOP Workflow
`tlp`	String	TLP of the Knowledge Base article. Allowed values: Red Amber Green White

Allows you to create Knowledge Base article using the values of locations, business units, sources, assigned groups, labels and the email IDs of assigned users.

\n","type":"text/plain"},"key":"values","value":"readable_type"},{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"309e777a-4260-4f80-bdb9-57460b041f47","name":"Create Knowledge Base Articles","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\":\"testing\",\n \"format\": \"framework\",\n \"business_units\": [\"System\"],\n \"locations\": [\"System\"],\n \"tlp\": \"red\"\n \"labels\": \"analyst-doc\"\n}\n","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/knowledge-base/document/?AccessID=174d8c90-14c2-4d11-be9d-003335b4d00c&Expires=&Signature=&values=readable_type","host":["{{base_url}}v1"],"path":["knowledge-base","document",""],"query":[{"key":"AccessID","value":"174d8c90-14c2-4d11-be9d-003335b4d00c"},{"key":"Expires","value":""},{"key":"Signature","value":""},{"key":"values","value":"readable_type","description":"Allows you to create Knowledge Base article using the values of locations, business units, sources, assigned groups, labels and the email IDs of assigned users."},{"key":"","value":null,"disabled":true}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 10 Oct 2024 10:17:52 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Content-Length","value":"1661","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"origin, Cookie","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: http: data: blob:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"format\": \"Framework\",\n \"tlp\": \"Red\",\n \"title\": \"Block IP Address\",\n \"description\": null,\n \"unique_id\": \"f3c312c1-a0a2-4e49-bde3-5866a5076e5b\",\n \"readable_id\": \"KNB114\",\n \"created\": \"2024-10-10T10:17:52.660486Z\",\n \"modified\": \"2024-10-10T10:17:52.695957Z\",\n \"entity\": null,\n \"business_units\": [\n \"5da17287-41fa-421e-9aa0-d14ed14805ce\"\n ],\n \"locations\": [\n \"1c96d6a3-56be-4243-8d38-8014c18eb0bc\"\n ],\n \"business_units_data\": [\n {\n \"title\": \"finance\",\n \"description\": \"finance security team\",\n \"unique_id\": \"5da17287-41fa-421e-9aa0-d14ed14805ce\",\n \"created\": \"2024-10-01T09:24:29.530355Z\",\n \"modified\": \"2024-10-01T09:24:29.530355Z\",\n \"readable_id\": \"BU102\",\n \"email_list\": null\n }\n ],\n \"locations_data\": [\n {\n \"title\": \"System\",\n \"unique_id\": \"1c96d6a3-56be-4243-8d38-8014c18eb0bc\",\n \"is_active\": true\n }\n ],\n \"entity_data\": null,\n \"created_by\": \"06962c3b-300b-47a9-b117-8288235812e6\",\n \"created_by_data\": {\n \"user_id\": \"06962c3b-300b-47a9-b117-8288235812e6\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@org.com\",\n \"display_pic\": null,\n \"username\": \"john.doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"John Doe\"\n },\n \"is_bookmarked\": false,\n \"status\": \"active\",\n \"attachments_data\": [],\n \"labels\": [],\n \"labels_data\": [],\n \"incident_data\": [],\n \"actions_data\": [],\n \"format_data\": {\n \"unique_id\": \"786927bf-d0ed-4bf4-8f3c-22f242fb11c1\",\n \"option_name\": \"Framework\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"0554f3e3-c9f3-424d-a072-4ced2648dc51\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"tlp_data\": {\n \"unique_id\": \"904f95d5-5cc0-4c4c-99d0-6e330dfd8440\",\n \"option_name\": \"Red\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"5f6ea04a-f0af-4fb0-a88b-637175065a6d\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n}"}],"_postman_id":"b8080945-2a85-4483-9e25-0f320d956f77"},{"name":"Knowledge Base Article Details","id":"c21bc357-3bc2-4566-8fe7-58da5ae963cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}v1/knowledge-base/document/:unique_id_kb/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","description":"

Retrieve details of the Knowledge Base article.

Note: This API endpoint is available in Respond v3.4.3.3 onwards

Request Parameters

This API endpoint does not require any input parameter.

Response Parameters

Parameter	Type	Description
`format`	String	Type of the Knowledge Base article. For example, framework.
`tlp`	String	TLP of the Knowledge Base article. For example, Red.
`title`	String	Title of the Knowledge Base article.
`description`	String	Description of the Knowledge Base article.
`unique_id`	String	Unique ID of the Knowledge Base article in UUID-4 format.
`readable_id`	String	Unique readable ID of the Knowledge Base article. It starts with KNB followed by a unique number. Example: KNB101
`created`	String	Created time of the Knowledge Base article in ISO format.
`modified`	String	Last modified time of the Knowledge Base article.
`business_units`	List of UUIDs	List of business units associated with the Knowledge Base article.
`locations`	List of UUIDs	List of locations associated with the Knowledge Base article.
`business_units_data`	Lists of Objects	Details of the business units associated with the Knowledge Base article. Details include: title, description, unique_id, created, and more.
`locations_data`	List of Objects	Details of the locations associated with the Knowledge Base article. Details include: title, unique_id, is_active, and more.
`created_by`	String	User ID of the user who created the Knowledge Base article.
`created_by_data`	Object	Details of the user who created the Knowledge Base article. Details include: user_id, first_name, email, username, and more.
`is_bookmarked`	Boolean	Shows if the incident is bookmarked or not.
`status`	String	Status of the Knowledge Base article. Allowed values: active inactive
`attachments_data`	Object	Details of the attachments attached to the Knowledge Base article.
`labels`	List	List of the labels that are added to the Knowledge Base article.
`labels_data`	List of Objects	Details of the labels that are added to the Knowledge Base article.
`incident_data`	Object	Details of the incident associated with the Knowledge Base article. Details include: unique_id, readable_id, created, modified, and more.
`action_data`	List of Objects	Details of the action associated with Knowledge Base article.
`format_data`	Object	Details of the Knowledge Base article type. Details include: unique_id, option_name, is_active, and more.
`tlp_data`	Object	Details of the tlp associated with the Knowledge Base article. Details include: unique_id, order, option_name, and more.
`format`	String	Type of the Knowledge Base article. Allowed values: Framework Guidelines Playbook Policy Report SOP Workflow
`tlp`	String	TLP of the Knowledge Base article. Allowed values: Red Amber Green White

","urlObject":{"path":["knowledge-base","document",":unique_id_kb",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"disabled":true,"key":"","value":""},{"disabled":true,"key":"","value":""}],"variable":[{"description":{"content":"

Enter the ID of the Knowledge Base article to retrieve the details.

\n","type":"text/plain"},"type":"any","value":"e0d48497-2ebe-4d3e-b1da-9bbcc24d3079","key":"unique_id_kb"}]}},"response":[{"id":"a7c361f2-9c49-4a86-95d4-cc5efc62cd6e","name":"Knowledge Base Article Details","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}v1/knowledge-base/document/:unique_id_kb/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["knowledge-base","document",":unique_id_kb",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"","value":"","disabled":true},{"key":"","value":"","disabled":true}],"variable":[{"key":"unique_id_kb","value":"0a2262bd-1419-472d-a01d-e61df1db1c81","description":"Enter the ID of the Knowledge Base article to retrieve the details."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 22 Oct 2024 10:31:37 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin, Cookie","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: http: data: blob:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"format\": \"Report\",\n \"tlp\": \"Red\",\n \"title\": \"Block IP Address\",\n \"description\": \"Block Malicious IP Addresses\",\n \"unique_id\": \"0a2262bd-1419-472d-a01d-e61df1db1c81\",\n \"readable_id\": \"KNB101\",\n \"created\": \"2024-10-10T06:12:12.301827Z\",\n \"modified\": \"2024-10-17T06:23:26.280176Z\",\n \"entity\": null,\n \"business_units\": [\n \"689b97ed-3d98-4666-af5c-c7a43ded045d\"\n ],\n \"locations\": [\n \"463ea1b5-4267-4f20-8117-5b8a582d8976\"\n ],\n \"business_units_data\": [\n {\n \"title\": \"Finance\",\n \"description\": finance cyber security,\n \"unique_id\": \"689b97ed-3d98-4666-af5c-c7a43ded045d\",\n \"created\": \"2024-10-08T06:09:41.528044Z\",\n \"modified\": \"2024-10-08T06:09:41.528044Z\",\n \"readable_id\": \"BU102\",\n \"email_list\": [finance@org.com]\n }\n ],\n \"locations_data\": [\n {\n \"title\": \"New York\",\n \"unique_id\": \"463ea1b5-4267-4f20-8117-5b8a582d8976\",\n \"is_active\": true\n }\n ],\n \"entity_data\": null,\n \"created_by\": \"a6c2f1fb-d0fd-42ba-a86e-f491618cfa6e\",\n \"created_by_data\": {\n \"user_id\": \"a6c2f1fb-d0fd-42ba-a86e-f491618cfa6e\",\n \"first_name\": \"jane\",\n \"last_name\": \"doe\",\n \"email\": \"jane.doe@org.tld\",\n \"display_pic\": null,\n \"username\": \"jane.doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"Jane Doe\"\n },\n \"is_bookmarked\": false,\n \"status\": \"active\",\n \"attachments_data\": [],\n \"labels\": [],\n \"labels_data\": [],\n \"incident_data\": [\n {\n \"unique_id\": \"881152a4-4378-4ee7-bd04-664c6932d903\",\n \"readable_id\": \"INC106\",\n \"c2ba1a25-5760-40ff-a777-ff6cfea0ccf0\": \"Api_automation 2024-10-10 11:38:00.813652\",\n \"5b051845-a329-474b-a190-5fd0aec06e55\": \"a8a5bde6-a54d-4d1c-a9de-b3ed07c1c59b\",\n \"created\": \"2024-10-10T06:11:02.833659Z\",\n \"modified\": \"2024-10-14T11:20:36.810968Z\",\n \"title_display\": \"Api_automation 2024-10-10 11:38:00.813652\",\n \"4942a741-3ef0-4b45-810a-fd8f8b93d260_data\": {\n \"username\": \"system.default\",\n \"first_name\": \"System\",\n \"last_name\": \"Default\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"a6c2f1fb-d0fd-42ba-a86e-f491618cfa6e\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"system@default.tld\",\n \"full_name\": \"System Default\"\n },\n \"is_bookmarked\": false,\n \"80cc2df5-fd73-4b94-8f23-2eea4bc3ac29\": null,\n \"created_by_data\": {\n \"username\": \"johh.doe\",\n \"first_name\": \"john\",\n \"last_name\": \"doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"a6c2f1fb-d0fd-42ba-a86e-f491618cfa6e\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"john.doe@myorg.com\",\n \"full_name\": \"John Doe\"\n },\n \"closed_on\": null,\n \"ee24319e-1c0b-4c73-9d42-fa62653b847d_data\": {\n \"group_comm_id\": \"d11b29ee-964d-4a07-a71d-7a095dbc3b5b\",\n \"group_name\": \"CFTR Admin\"\n },\n \"severity_title\": High,\n \"can_update_instance\": true,\n \"ed5d9afc-e0a6-42c3-93c0-956dc67b02d1_data\": {\n \"unique_id\": \"43df6940-b755-4efd-bb6a-7e00c6287ba0\",\n \"option_name\": \"Detection analysis\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"ed5d9afc-e0a6-42c3-93c0-956dc67b02d1\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"ed5d9afc-e0a6-42c3-93c0-956dc67b02d1\": \"43df6940-b755-4efd-bb6a-7e00c6287ba0\",\n \"5b051845-a329-474b-a190-5fd0aec06e55_data\": {\n \"unique_id\": \"a8a5bde6-a54d-4d1c-a9de-b3ed07c1c59b\",\n \"option_name\": \"Open\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"5b051845-a329-474b-a190-5fd0aec06e55\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": \"#E53535\"\n }\n }\n ],\n \"actions_data\": [],\n \"format_data\": {\n \"unique_id\": \"514a87fe-c006-46cb-8eb7-cd8274d06e4b\",\n \"option_name\": \"Report\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"221c7b4f-9443-47db-b83c-743db0188c8e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"tlp_data\": {\n \"unique_id\": \"ee4b7dda-5ce5-4ad5-97d3-0704322f1869\",\n \"option_name\": \"Red\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"2623c86e-efaa-479f-83e8-641bd2c954eb\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n}"}],"_postman_id":"c21bc357-3bc2-4566-8fe7-58da5ae963cb"},{"name":"Update Knowledge Base Article","id":"ee54ec10-6bad-44a0-947a-acbf1c774922","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/knowledge-base/document/:unique_id_kb/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&only_parent=True","description":"

Update the details of a Knowledge Base article in the Respond application.

Note: This API endpoint is available in Respond v3.4.3.3 onwards

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required/Optional	Description
`title`	String	Optional	Enter the title for the Knowledge Base article.
`format`	String	Optional	Enter the type of the Knowledge Base article. Allowed values: Framework Guideline Playbook Policy Report SOP Workflow
`business_units`	List	Optional	Enter the unique IDs of the business units who can access the Knowledge Base article.
`locations`	List	Optional	Enter the unique IDs of the locations who can access the Knowledge Base article.
`tlp`	String	Optional	Enter a TLP for the Knowledge Base article. Allowed values: Red Green Amber White

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Description
`link`	Object	This parameter has two keys: `previous` and `next`. `previous` key displays the API endpoint to the previous page. `next` key displays the API endpoint to the next page.
`count`	Integer	Total number of Knowledge Base articles returned as per the entered query parameters.
`results`	Array of Objects	Details of the Knowledge Base article. Each object provides the details of one Knowledge Base article.

Response Parameters | Results Object

Parameter	Type	Description
`format`	String	Type of the Knowledge Base article. For example, framework.
`tlp`	String	TLP of the Knowledge Base article. For example, Red.
`title`	String	Title of the Knowledge Base article.
`description`	String	Description of the Knowledge Base article.
`unique_id`	String	Unique ID of the Knowledge Base article in UUID-4 format.
`readable_id`	String	Unique readable ID of the Knowledge Base article. It starts with KNB followed by a unique number. Example: KNB101
`created`	String	Created time of the Knowledge Base article in ISO format.
`modified`	String	Last modified time of the Knowledge Base article.
`business_units`	List of UUIDs	List of business units associated with the Knowledge Base article.
`locations`	List of UUIDs	List of locations associated with the Knowledge Base article.
`business_units_data`	Lists of Objects	Details of the business units associated with the Knowledge Base article. Details include: title, description, unique_id, created, and more.
`locations_data`	List of Objects	Details of the locations associated with the Knowledge Base article. Details include: title, unique_id, is_active, and more.
`created_by`	String	User ID of the user who created the Knowledge Base article.
`created_by_data`	Object	Details of the user who created the Knowledge Base article. Details include: user_id, first_name, email, username, and more.
`is_bookmarked`	Boolean	Shows if the incident is bookmarked or not.
`status`	String	Status of the Knowledge Base article. Allowed values: active inactive
`attachments_data`	Object	Details of the attachments attached to the Knowledge Base article.
`labels`	List	List of the labels that are added to the Knowledge Base article.
`labels_data`	List of Objects	Details of the labels that are added to the Knowledge Base article.
`incident_data`	Object	Details of the incident associated with the Knowledge Base article. Details include: unique_id, readable_id, created, modified, and more.
`action_data`	List of Objects	Details of the action associated with Knowledge Base article.
`format_data`	Object	Details of the Knowledge Base article type. Details include: unique_id, option_name, is_active, and more.
`tlp_data`	Object	Details of the tlp associated with the Knowledge Base article. Details include: unique_id, order, option_name, and more.
`format`	String	Type of the Knowledge Base article. Allowed values: Framework Guidelines Playbook Policy Report SOP Workflow
`tlp`	String	TLP of the Knowledge Base article. Allowed values: Red Amber Green White

","urlObject":{"path":["knowledge-base","document",":unique_id_kb",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"only_parent","value":"True"}],"variable":[{"description":{"content":"

Enter the ID of the Knowledge Base article to update in the UUID format.

\n","type":"text/plain"},"type":"any","value":"e0d48497-2ebe-4d3e-b1da-9bbcc24d3079","key":"unique_id_kb"}]}},"response":[{"id":"0b869d8a-9bbd-4880-b1a6-204216122671","name":"Update Knowledge Base Article","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"title\":\"contain malicious devices\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/knowledge-base/document/:unique_id_kb/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&only_parent=True","host":["{{base_url}}v1"],"path":["knowledge-base","document",":unique_id_kb",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"only_parent","value":"True"}],"variable":[{"key":"unique_id_kb","value":"0a2262bd-1419-472d-a01d-e61df1db1c81","description":"Enter the ID of the Knowledge Base article to update in the UUID format."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 22 Oct 2024 10:33:44 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"GET, POST, PUT, DELETE, HEAD, OPTIONS","enabled":true},{"key":"Vary","value":"Origin, Cookie","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: http: data: blob:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"format\": \"Report\",\n \"tlp\": \"Red\",\n \"title\": \"Contain malicious devices\",\n \"description\": \"Article on how to identify and contain malicious activity\",\n \"unique_id\": \"0a2262bd-1419-472d-a01d-e61df1db1c81\",\n \"readable_id\": \"KNB101\",\n \"created\": \"2024-10-10T06:12:12.301827Z\",\n \"modified\": \"2024-10-22T10:33:43.644393Z\",\n \"entity\": null,\n \"business_units\": [\n \"689b97ed-3d98-4666-af5c-c7a43ded045d\"\n ],\n \"locations\": [\n \"463ea1b5-4267-4f20-8117-5b8a582d8976\"\n ],\n \"business_units_data\": [\n {\n \"title\": \"Finance\",\n \"description\": null,\n \"unique_id\": \"689b97ed-3d98-4666-af5c-c7a43ded045d\",\n \"created\": \"2024-10-08T06:09:41.528044Z\",\n \"modified\": \"2024-10-08T06:09:41.528044Z\",\n \"readable_id\": \"BU102\",\n \"email_list\": null\n }\n ],\n \"locations_data\": [\n {\n \"title\": \"New York\",\n \"unique_id\": \"463ea1b5-4267-4f20-8117-5b8a582d8976\",\n \"is_active\": true\n }\n ],\n \"entity_data\": null,\n \"created_by\": \"a6c2f1fb-d0fd-42ba-a86e-f491618cfa6e\",\n \"created_by_data\": {\n \"user_id\": \"a6c2f1fb-d0fd-42ba-a86e-f491618cfa6e\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@myorg.com\",\n \"display_pic\": null,\n \"username\": \"john doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"is_active\": true,\n \"full_name\": \"John Doe\"\n },\n \"is_bookmarked\": false,\n \"status\": \"active\",\n \"attachments_data\": [],\n \"labels\": [],\n \"labels_data\": [],\n \"incident_data\": [\n {\n \"unique_id\": \"881152a4-4378-4ee7-bd04-664c6932d903\",\n \"readable_id\": \"INC106\",\n \"c2ba1a25-5760-40ff-a777-ff6cfea0ccf0\": \"Api_automation 2024-10-10 11:38:00.813652\",\n \"5b051845-a329-474b-a190-5fd0aec06e55\": \"a8a5bde6-a54d-4d1c-a9de-b3ed07c1c59b\",\n \"created\": \"2024-10-10T06:11:02.833659Z\",\n \"modified\": \"2024-10-14T11:20:36.810968Z\",\n \"title_display\": \"Api_automation 2024-10-10 11:38:00.813652\",\n \"4942a741-3ef0-4b45-810a-fd8f8b93d260_data\": {\n \"username\": \"john doe\",\n \"first_name\": \"john\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"a6c2f1fb-d0fd-42ba-a86e-f491618cfa6e\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"john.doe@myorg.com\",\n \"full_name\": \"John Doe\"\n },\n \"is_bookmarked\": false,\n \"80cc2df5-fd73-4b94-8f23-2eea4bc3ac29\": null,\n \"created_by_data\": {\n \"username\": \"john doe\",\n \"first_name\": \"john\",\n \"last_name\": \"doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"a6c2f1fb-d0fd-42ba-a86e-f491618cfa6e\",\n \"display_pic\": null,\n \"is_active\": true,\n \"email\": \"john.doe@myorg.com\",\n \"full_name\": \"John Doe\"\n },\n \"closed_on\": null,\n \"ee24319e-1c0b-4c73-9d42-fa62653b847d_data\": {\n \"group_comm_id\": \"d11b29ee-964d-4a07-a71d-7a095dbc3b5b\",\n \"group_name\": \"CFTR Admin\"\n },\n \"severity_title\": null,\n \"can_update_instance\": true,\n \"ed5d9afc-e0a6-42c3-93c0-956dc67b02d1_data\": {\n \"unique_id\": \"43df6940-b755-4efd-bb6a-7e00c6287ba0\",\n \"option_name\": \"Detection analysis\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"ed5d9afc-e0a6-42c3-93c0-956dc67b02d1\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"ed5d9afc-e0a6-42c3-93c0-956dc67b02d1\": \"43df6940-b755-4efd-bb6a-7e00c6287ba0\",\n \"5b051845-a329-474b-a190-5fd0aec06e55_data\": {\n \"unique_id\": \"a8a5bde6-a54d-4d1c-a9de-b3ed07c1c59b\",\n \"option_name\": \"Open\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"5b051845-a329-474b-a190-5fd0aec06e55\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": \"#E53535\"\n }\n }\n ],\n \"actions_data\": [],\n \"format_data\": {\n \"unique_id\": \"514a87fe-c006-46cb-8eb7-cd8274d06e4b\",\n \"option_name\": \"Report\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"221c7b4f-9443-47db-b83c-743db0188c8e\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"tlp_data\": {\n \"unique_id\": \"ee4b7dda-5ce5-4ad5-97d3-0704322f1869\",\n \"option_name\": \"Red\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"2623c86e-efaa-479f-83e8-641bd2c954eb\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n }\n}"}],"_postman_id":"ee54ec10-6bad-44a0-947a-acbf1c774922"}],"id":"3605f6ef-3488-4b54-819c-67e934cf2d4d","description":"

Knowledge Base includes component-specific troubleshooting articles or documentation. The articles in the Knowledge Base describe how to detect, analyze, and resolve commonly encountered security issues. You can create and manage documentation relevant to your organizational security incident response process in the Knowledge Base component

\n","_postman_id":"3605f6ef-3488-4b54-819c-67e934cf2d4d"},{"name":"Advanced Search","item":[{"name":"Advanced Search for Modules","id":"3cafe77e-d56a-4306-9962-1e3a5a3be121","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"advanced_search_payload\": {\n \"assigned_group\": \"3bf12078-4f1d-4fb7-b2ba-3239137ea9e1\",\n \"ip_reputation\": \"Malicious\",\n \"operator\": \"AND\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}v1/utils/advanced-search-per-key/:component_identifier/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&=","description":"

Retrieves a list of entries of a module based on the query parameters and the parameters provided in the payload.

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Type	Required	Description
`advanced_search_payload`	JSON	Mandatory	Pass the readable key of parameters and the respective values in key-value pairs to search entries.
`advanced_search_payload: operator`	String	Optional	Pass the logical operator to apply to the passed parameters. Allowed values: - `AND`: Returns the entries that match all the parameter values passed. - `OR`: Returns the entries that match at least one of the parameter values passed. Default: `AND`

Response Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
link	Object	This parameter includes two keys: `previous` and `next`. `previous` key returns the API endpoint to the previous page. `next` key returns the API endpoint to the next page.
count	Integer	Returns the total number of module entries in the application base on the parameters passed in the query and payload.
results	List of Objects	Returns a list of module entries with details.

","urlObject":{"path":["utils","advanced-search-per-key",":component_identifier",""],"host":["{{base_url}}v1"],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"","value":""}],"variable":[{"type":"any","value":"incident","key":"component_identifier"}]}},"response":[{"id":"f60039b6-42d4-41cc-adff-6ed833bf0024","name":"Incident search with OR operator","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"advanced_search_payload\": {\n \"assigned_group\": \"3bf12078-4f1d-4fb7-b2ba-3239137ea9e1\",\n \"ip_reputation\": \"Malicious\",\n \"operator\": \"OR\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/utils/advanced-search-per-key/:component_identifier/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&status=open","host":["{{base_url}}v1"],"path":["utils","advanced-search-per-key",":component_identifier",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"status","value":"open","description":"[optional] Enter the status of the incidents.\nAllowed values:\n•open\n•closed\n•untriaged\n•merged\nExample: “open”\n\nNOTE: Advanced search supports filtering based on query params that are supported by the component identifier. \n\nThe supported query params of each component identifier can be found at the respective component identifier's module Listing API Documentation."}],"variable":[{"key":"component_identifier","value":"incident","description":"Enter the component identifier slug for which advanced search needs to be run.\nSupports the values:\nincident\naction\nvulnerability\nthreat-actor\ncampaign\nthreat-briefing\nmalware\nenhancement\npir\ngeneral-user\ndevice\napplication\nasset-software"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Sep 2023 10:02:25 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"POST","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data: blob:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 2,\n \"results\": [\n {\n \"unique_id\": \"2341c2e8-5139-4f1a-b2ed-77aba8bc2a0d\",\n \"readable_id\": \"INC1199\",\n \"created\": \"2023-09-04T10:02:16.087013Z\",\n \"description\": null,\n \"modified\": \"2023-09-04T10:02:20.223182Z\",\n \"title\": \"Malicious Login 23/01/2023 06:23\",\n \"machine_generated\": false,\n \"status\": \"Open\",\n \"closed_on\": null,\n \"title_display\": \"Malicious Login 23/01/2023 06:23\",\n \"is_protected\": false,\n \"level\": \"Critical\",\n \"phase\": \"Detection Analysis\",\n \"is_paused\": false,\n \"opened_on\": \"2023-09-04T10:02:16.085089Z\",\n \"assignment_sla\": null,\n \"resolution_sla\": {\n \"data\": {\n \"sla_duration\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 15\n }\n },\n \"elapsed_time\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 0\n },\n \"color\": 0\n },\n \"is_ctix_generated\": false,\n \"is_bookmarked\": false,\n \"resolution_due_date\": \"2023-09-04T10:17:16.085089Z\",\n \"opened_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"parent_data\": null,\n \"modified_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"assigned_group_data\": {\n \"group_comm_id\": \"3bf12078-4f1d-4fb7-b2ba-3239137ea9e1\",\n \"group_name\": \"Soc Analyst\"\n },\n \"created_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"assigned_to_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#A0887E\",\n \"user_id\": \"c71efa3a-7231-4473-9f7c-5119ac225b2b\",\n \"display_pic\": \"https://rgrsmssp.cftr.spotio.cywaredev.com/cftrbucket/profile-pics/john.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minio%2F20230904%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20230904T100225Z&X-Amz-Expires=120&X-Amz-SignedHeaders=host&X-Amz-Signature=7e115bc0bc6bb820a18eb03a8a379cbb915214488079d61d19c15c7a30dcfd33\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"labels_data\": [],\n \"business_units_impacted_data\": {\n \"title\": \"System\",\n \"unique_id\": \"37b2e957-dfb6-4794-96ec-0c9fe50c5980\",\n \"email_list\": \"johndoe@example.com,janedoe@example.com\"\n },\n \"locations_impacted_data\": [\n {\n \"title\": \"System\",\n \"unique_id\": \"6bf038a5-e3f4-4985-84b4-4dc973f8a5a4\",\n \"is_active\": true\n }\n ],\n \"phase_data\": {\n \"unique_id\": \"174ad867-cc1e-4c5e-8ffd-9807aba80ea8\",\n \"option_name\": \"Detection Analysis\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"6decbcd7-693d-4543-97ac-c42544d0b8d5\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"incident_identified_data\": [],\n \"incident_identified\": [],\n \"status_data\": {\n \"unique_id\": \"5ac56c00-f975-4928-b492-19c440cca37b\",\n \"option_name\": \"Open\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"54c33b76-a91b-45a2-b0a4-d1d6cb17cf57\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": \"#E53535\"\n },\n \"ie_regulatory_notifications_required_data\": null,\n \"ie_regulatory_notifications_required\": null,\n \"attack_vector_data\": null,\n \"attack_vector\": null,\n \"kill_chain_phase_data\": null,\n \"kill_chain_phase\": null,\n \"new_biiiiiiiiiig_name_for_testing_workflowmappingand_test_data\": null,\n \"new_biiiiiiiiiig_name_for_testing_workflowmappingand_test\": null,\n \"ie_root_cause_data\": null,\n \"ie_root_cause\": null,\n \"ie_incident_type_data\": {\n \"unique_id\": \"59744356-02db-488d-8d29-e71439c41e2f\",\n \"option_name\": \"APT\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"c19184ab-8eb6-4d7f-8329-aeeb8a1e8595\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"ie_incident_type\": \"APT\",\n \"level_data\": {\n \"unique_id\": \"f4f937b7-a730-48e7-8d1d-42c9428f1162\",\n \"option_name\": \"Critical\",\n \"is_active\": true,\n \"order\": 4,\n \"option_field\": \"42cdb492-03b1-4e7f-956e-f9a1c4aaea31\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"false_positive_data\": null,\n \"false_positive\": null,\n \"ie_customer_notification_required_data\": null,\n \"ie_customer_notification_required\": null,\n \"business_impact_data\": [],\n \"business_impact\": [],\n \"single_select_data\": null,\n \"single_select\": null,\n \"limit_data\": null,\n \"limit\": null,\n \"action_task_data\": null,\n \"action_task\": null,\n \"applicable_compliance_data\": [],\n \"applicable_compliance\": [],\n \"ie_motives_data\": [],\n \"ie_motives\": [],\n \"ie_regulatory_reporting_data\": [],\n \"ie_regulatory_reporting\": []\n },\n {\n \"unique_id\": \"2ae5949b-3fcb-4578-9c74-c6f0c18f2aef\",\n \"readable_id\": \"INC1197\",\n \"created\": \"2023-09-04T09:36:03.003555Z\",\n \"description\": \"\",\n \"modified\": \"2023-09-04T09:37:02.993577Z\",\n \"title\": \"Insider threat on 23/01/2023 05:34\",\n \"machine_generated\": false,\n \"status\": \"Open\",\n \"closed_on\": null,\n \"title_display\": \"Insider threat on 23/01/2023 05:34\",\n \"is_protected\": false,\n \"level\": \"Medium\",\n \"phase\": \"Detection Analysis\",\n \"is_paused\": false,\n \"opened_on\": \"2023-09-04T09:36:03.001570Z\",\n \"assignment_sla\": null,\n \"resolution_sla\": {\n \"data\": {\n \"sla_duration\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 15\n }\n },\n \"elapsed_time\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 26\n },\n \"color\": 2\n },\n \"is_ctix_generated\": false,\n \"is_bookmarked\": false,\n \"resolution_due_date\": \"2023-09-04T09:51:03.001570Z\",\n \"opened_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"parent_data\": null,\n \"modified_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"assigned_group_data\": {\n \"group_comm_id\": \"3bf12078-4f1d-4fb7-b2ba-3239137ea9e1\",\n \"group_name\": \"Soc Analyst\"\n },\n \"created_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"assigned_to_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#A0887E\",\n \"user_id\": \"c71efa3a-7231-4473-9f7c-5119ac225b2b\",\n \"display_pic\": \"https://rgrsmssp.cftr.spotio.cywaredev.com/cftrbucket/profile-pics/john.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minio%2F20230904%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20230904T100225Z&X-Amz-Expires=120&X-Amz-SignedHeaders=host&X-Amz-Signature=7e115bc0bc6bb820a18eb03a8a379cbb915214488079d61d19c15c7a30dcfd33\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"labels_data\": [],\n \"business_units_impacted_data\": {\n \"title\": \"System\",\n \"unique_id\": \"37b2e957-dfb6-4794-96ec-0c9fe50c5980\",\n \"email_list\": \"johndoe@example.com,janedoe@example.com\"\n },\n \"locations_impacted_data\": [\n {\n \"title\": \"System\",\n \"unique_id\": \"6bf038a5-e3f4-4985-84b4-4dc973f8a5a4\",\n \"is_active\": true\n }\n ],\n \"phase_data\": {\n \"unique_id\": \"174ad867-cc1e-4c5e-8ffd-9807aba80ea8\",\n \"option_name\": \"Detection Analysis\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"6decbcd7-693d-4543-97ac-c42544d0b8d5\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"incident_identified_data\": [],\n \"incident_identified\": [],\n \"status_data\": {\n \"unique_id\": \"5ac56c00-f975-4928-b492-19c440cca37b\",\n \"option_name\": \"Open\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"54c33b76-a91b-45a2-b0a4-d1d6cb17cf57\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": \"#E53535\"\n },\n \"ie_regulatory_notifications_required_data\": null,\n \"ie_regulatory_notifications_required\": null,\n \"attack_vector_data\": null,\n \"attack_vector\": null,\n \"kill_chain_phase_data\": null,\n \"kill_chain_phase\": null,\n \"new_biiiiiiiiiig_name_for_testing_workflowmappingand_test_data\": null,\n \"new_biiiiiiiiiig_name_for_testing_workflowmappingand_test\": null,\n \"ie_root_cause_data\": null,\n \"ie_root_cause\": null,\n \"ie_incident_type_data\": {\n \"unique_id\": \"59744356-02db-488d-8d29-e71439c41e2f\",\n \"option_name\": \"APT\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"c19184ab-8eb6-4d7f-8329-aeeb8a1e8595\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"ie_incident_type\": \"APT\",\n \"level_data\": {\n \"unique_id\": \"f397c64e-fbfc-49b4-a84d-889342519ff4\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"42cdb492-03b1-4e7f-956e-f9a1c4aaea31\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"false_positive_data\": null,\n \"false_positive\": null,\n \"ie_customer_notification_required_data\": null,\n \"ie_customer_notification_required\": null,\n \"business_impact_data\": [],\n \"business_impact\": [],\n \"single_select_data\": null,\n \"single_select\": null,\n \"limit_data\": null,\n \"limit\": null,\n \"action_task_data\": null,\n \"action_task\": null,\n \"applicable_compliance_data\": [],\n \"applicable_compliance\": [],\n \"ie_motives_data\": [],\n \"ie_motives\": [],\n \"ie_regulatory_reporting_data\": [],\n \"ie_regulatory_reporting\": []\n }\n ]\n}"},{"id":"7712e668-6e9a-4f85-8f9d-56db24b17dd6","name":"Incident search with AND operator","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"advanced_search_payload\": {\n \"assigned_group\": \"3bf12078-4f1d-4fb7-b2ba-3239137ea9e1\",\n \"ip_reputation\": \"Safe\",\n \"operator\": \"AND\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/utils/advanced-search-per-key/:component_identifier/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}","host":["{{base_url}}v1"],"path":["utils","advanced-search-per-key",":component_identifier",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"status","value":"open","description":"[optional] Enter the status of the incidents.\nAllowed values:\n•open\n•closed\n•untriaged\n•merged\nExample: “open”\n\nNOTE: Advanced search supports filtering based on query params that are supported by the component identifier. \n\nThe supported query params of each component identifier can be found at the respective component identifier's module Listing API Documentation.","disabled":true}],"variable":[{"key":"component_identifier","value":"incident","description":"Enter the component identifier slug for which advanced search needs to be run.\nSupports the values:\nincident\naction\nvulnerability\nthreat-actor\ncampaign\nthreat-briefing\nmalware\nenhancement\npir\ngeneral-user\ndevice\napplication\nasset-software"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Sep 2023 10:32:27 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"POST","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data: blob:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 1,\n \"results\": [\n {\n \"unique_id\": \"2ae5949b-3fcb-4578-9c74-c6f0c18f2aef\",\n \"readable_id\": \"INC1197\",\n \"created\": \"2023-09-04T09:36:03.003555Z\",\n \"description\": \"\",\n \"modified\": \"2023-09-04T09:37:02.993577Z\",\n \"title\": \"Insider threat on 23/01/2023 05:34\",\n \"machine_generated\": false,\n \"status\": \"Open\",\n \"closed_on\": null,\n \"title_display\": \"Insider threat on 23/01/2023 05:34\",\n \"is_protected\": false,\n \"level\": \"Medium\",\n \"phase\": \"Detection Analysis\",\n \"is_paused\": false,\n \"opened_on\": \"2023-09-04T09:36:03.001570Z\",\n \"assignment_sla\": null,\n \"resolution_sla\": {\n \"data\": {\n \"sla_duration\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 15\n }\n },\n \"elapsed_time\": {\n \"days\": 0,\n \"hours\": 0,\n \"minutes\": 56\n },\n \"color\": 2\n },\n \"is_ctix_generated\": false,\n \"is_bookmarked\": false,\n \"resolution_due_date\": \"2023-09-04T09:51:03.001570Z\",\n \"opened_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"parent_data\": null,\n \"modified_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"assigned_group_data\": {\n \"group_comm_id\": \"3bf12078-4f1d-4fb7-b2ba-3239137ea9e1\",\n \"group_name\": \"Soc Analyst\"\n },\n \"created_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"assigned_to_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#A0887E\",\n \"user_id\": \"c71efa3a-7231-4473-9f7c-5119ac225b2b\",\n \"display_pic\": \"https://rgrsmssp.cftr.spotio.cywaredev.com/cftrbucket/profile-pics/john.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=minio%2F20230904%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20230904T103227Z&X-Amz-Expires=120&X-Amz-SignedHeaders=host&X-Amz-Signature=834790a111c61fe5cb97252f346e1dd5b08bfbb0de93df35a593e6e687942896\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"labels_data\": [],\n \"business_units_impacted_data\": {\n \"title\": \"System\",\n \"unique_id\": \"37b2e957-dfb6-4794-96ec-0c9fe50c5980\",\n \"email_list\": \"johndoe@example.com,janedoe@example.com\"\n },\n \"locations_impacted_data\": [\n {\n \"title\": \"System\",\n \"unique_id\": \"6bf038a5-e3f4-4985-84b4-4dc973f8a5a4\",\n \"is_active\": true\n }\n ],\n \"phase_data\": {\n \"unique_id\": \"174ad867-cc1e-4c5e-8ffd-9807aba80ea8\",\n \"option_name\": \"Detection Analysis\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"6decbcd7-693d-4543-97ac-c42544d0b8d5\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"incident_identified_data\": [],\n \"incident_identified\": [],\n \"status_data\": {\n \"unique_id\": \"5ac56c00-f975-4928-b492-19c440cca37b\",\n \"option_name\": \"Open\",\n \"is_active\": true,\n \"order\": 1,\n \"option_field\": \"54c33b76-a91b-45a2-b0a4-d1d6cb17cf57\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": \"#E53535\"\n },\n \"ie_regulatory_notifications_required_data\": null,\n \"ie_regulatory_notifications_required\": null,\n \"attack_vector_data\": null,\n \"attack_vector\": null,\n \"kill_chain_phase_data\": null,\n \"kill_chain_phase\": null,\n \"new_biiiiiiiiiig_name_for_testing_workflowmappingand_test_data\": null,\n \"new_biiiiiiiiiig_name_for_testing_workflowmappingand_test\": null,\n \"ie_root_cause_data\": null,\n \"ie_root_cause\": null,\n \"ie_incident_type_data\": {\n \"unique_id\": \"59744356-02db-488d-8d29-e71439c41e2f\",\n \"option_name\": \"APT\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"c19184ab-8eb6-4d7f-8329-aeeb8a1e8595\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"ie_incident_type\": \"APT\",\n \"level_data\": {\n \"unique_id\": \"f397c64e-fbfc-49b4-a84d-889342519ff4\",\n \"option_name\": \"Medium\",\n \"is_active\": true,\n \"order\": 2,\n \"option_field\": \"42cdb492-03b1-4e7f-956e-f9a1c4aaea31\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"false_positive_data\": null,\n \"false_positive\": null,\n \"ie_customer_notification_required_data\": null,\n \"ie_customer_notification_required\": null,\n \"business_impact_data\": [],\n \"business_impact\": [],\n \"single_select_data\": null,\n \"single_select\": null,\n \"limit_data\": null,\n \"limit\": null,\n \"action_task_data\": null,\n \"action_task\": null,\n \"applicable_compliance_data\": [],\n \"applicable_compliance\": [],\n \"ie_motives_data\": [],\n \"ie_motives\": [],\n \"ie_regulatory_reporting_data\": [],\n \"ie_regulatory_reporting\": []\n }\n ]\n}"},{"id":"fcaf2519-3955-4081-9b98-faba47ed51e3","name":"Actions search with AND operator","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"advanced_search_payload\": {\n \"exception_details\": \"INC1199\",\n \"priority\": \"Very Low\",\n \"operator\": \"AND\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{base_url}}v1/utils/advanced-search-per-key/:component_identifier/?AccessID={{open_api_access_id}}&Expires={{expires}}&Signature={{signature}}&status=active&modified_date__gte=1680711788","host":["{{base_url}}v1"],"path":["utils","advanced-search-per-key",":component_identifier",""],"query":[{"key":"AccessID","value":"{{open_api_access_id}}"},{"key":"Expires","value":"{{expires}}"},{"key":"Signature","value":"{{signature}}"},{"key":"status","value":"active"},{"key":"modified_date__gte","value":"1680711788"}],"variable":[{"key":"component_identifier","value":"action","description":"Enter the component identifier slug for which advanced search needs to be run.\nSupports the values:\nincident\naction\nvulnerability\nthreat-actor\ncampaign\nthreat-briefing\nmalware\nenhancement\npir\ngeneral-user\ndevice\napplication\nasset-software"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Sep 2023 10:47:42 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Allow","value":"POST","enabled":true},{"key":"Vary","value":"Origin","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Frame-Options","value":"DENY","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Referrer-Policy","value":"same-origin","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains;","enabled":true},{"key":"Content-Security-Policy","value":"img-src https: data: blob:;","enabled":true},{"key":"Permissions-Policy","value":"geolocation=(self), fullscreen=(self)","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"link\": {},\n \"count\": 1,\n \"results\": [\n {\n \"title\": \"Block Malicious IP\",\n \"assigned_to\": null,\n \"assigned_group\": \"2fc54807-8fd9-47c3-b9b7-e8d692a43bf8\",\n \"assigned_group_data\": {\n \"group_comm_id\": \"2fc54807-8fd9-47c3-b9b7-e8d692a43bf8\",\n \"group_name\": \"CFTR Admin\"\n },\n \"unique_id\": \"b5d7e3ba-afa5-406f-b741-b21b29d6685d\",\n \"assigned_to_data\": {},\n \"created_by_data\": {\n \"username\": \"johndoe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"profile_background_color\": \"#dcdcdc\",\n \"user_id\": \"5b48de08-f95f-4dca-987e-0494d9dddb63\",\n \"is_active\": true,\n \"email\": \"johndoe@example.com\",\n \"full_name\": \"John Doe\"\n },\n \"readable_id\": \"ACT1185\",\n \"status\": \"in_progress\",\n \"created\": \"2023-09-03T23:38:24.736990Z\",\n \"modified\": \"2023-09-04T10:43:08.659085Z\",\n \"is_bookmarked\": false,\n \"labels\": [],\n \"labels_data\": [],\n \"created_from_template\": false,\n \"priority_data\": {\n \"unique_id\": \"97db4255-f90b-413b-9b5d-4a3a7a2e7c37\",\n \"option_name\": \"Very Low\",\n \"is_active\": true,\n \"order\": 0,\n \"option_field\": \"e6d2b601-b4b8-4660-9deb-4551c6968bc0\",\n \"is_removed\": false,\n \"is_editable\": true,\n \"is_prepopulator\": false,\n \"color_code\": null\n },\n \"priority\": \"Very Low\",\n \"type_data\": null,\n \"type\": null\n }\n ]\n}"}],"_postman_id":"3cafe77e-d56a-4306-9962-1e3a5a3be121"}],"id":"9ef88383-95e2-4da2-b629-dfe518f66994","_postman_id":"9ef88383-95e2-4da2-b629-dfe518f66994","description":""}],"event":[{"listen":"prerequest","script":{"id":"193c595e-b42e-4095-a7f7-11d55ab75358","type":"text/javascript","exec":["var accessid = pm.environment.get(\"open_api_access_id\");","var secret_key = pm.environment.get(\"open_api_secret_key\");","/*"," -generating epochtime"," -epochtime is being send in expires parameter of params"," -sign is generated and then passed for generating signature","*/","pm.environment.set(\"unixtimestamp\",Math.round(Date.now()/1000));","var expires = pm.environment.get(\"unixtimestamp\")+15;","pm.environment.set('UTC Timezone', new Date().toISOString());","pm.environment.set(\"expires\", expires);","var to_sign = accessid+\"\\n\"+expires;","/*","Generate Signature for Authentication"," -Key based hashing is done using HMAC-SHA1 Algorithm"," -This is then converted into base64"," -Finally the generated signature is URL Encoded so as to make all the special characters URL Safe","*/","var hash = CryptoJS.HmacSHA1(to_sign, secret_key);","var hashInBase64 = encodeURIComponent(CryptoJS.enc.Base64.stringify(hash));","pm.environment.set(\"signature\",hashInBase64);",""]}},{"listen":"test","script":{"id":"51421789-c497-469f-82cf-19ab01ba011f","type":"text/javascript","exec":[""]}}]}